office-gobmx/framework/inc/classes/wildcard.hxx
Rüdiger Timm 3cc320c38d INTEGRATION: CWS ooo19126 (1.3.586); FILE MERGED
2005/09/05 13:04:34 rt 1.3.586.1: #i54170# Change license header: remove SISSL
2005-09-08 23:10:21 +00:00

197 lines
8.5 KiB
C++

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: wildcard.hxx,v $
*
* $Revision: 1.4 $
*
* last change: $Author: rt $ $Date: 2005-09-09 00:10:21 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef __FRAMEWORK_CLASSES_WILDCARD_HXX_
#define __FRAMEWORK_CLASSES_WILDCARD_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
#include <macros/debug.hxx>
#endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#ifndef _RTL_USTRING_
#include <rtl/ustring.hxx>
#endif
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short implement wildcard-mechanism for unicode
@descr This class can be used to get information about the matching of a pattern to a given text.
It's suitable for 8-Bit- AND 16-Bit-strings!
@implements -
@base -
@ATTENTION This class is'nt threadsafe!
@devstatus deprecated
*//*-*************************************************************************************************************/
class Wildcard
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short standard ctor
@descr We do nothing here.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
Wildcard();
/*-****************************************************************************************************//**
@short standard dtor
@descr We do nothing here.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual ~Wildcard();
//---------------------------------------------------------------------------------------------------------
// interface
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short try to find an agreement between given text and searchpattern
@descr You can use wildcards in pattern only!
@seealso -
@param "sText" is the text, in which we search given pattern.
@param "sPattern" is the searched pattern with includes wildcards.
@return sal_True , if pattern was found.
@return sal_False, if pattern don't match the text.
@onerror -
*//*-*****************************************************************************************************/
static sal_Bool match( const ::rtl::OUString& sText ,
const ::rtl::OUString& sPattern );
//---------------------------------------------------------------------------------------------------------
// debug and test methods
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short debug-methods to check incoming parameter of some other mehods of this class
@descr The follow methods are used to check parameters for other methods
of this class. The return value is used directly for an ASSERT(...).
This mechanism is active in debug version only!
@seealso FRAMEWORK_ASSERT in implementation!
@param references to checking variables
@return sal_False on invalid parameter
@return sal_True otherwise
@onerror -
*//*-*****************************************************************************************************/
#ifdef ENABLE_ASSERTIONS
static sal_Bool impldbg_checkParameter_match( const ::rtl::OUString& sText ,
const ::rtl::OUString& sPattern );
#endif // #ifdef ENABLE_ASSERTIONS
/*-****************************************************************************************************//**
@short test implementation of match() with different examples
@descr If TESTMODE activated, you cann call these method to start and log some special examples.
Do this if you have changed the implementation of method match() to test it.
@seealso -
@param -
@return -
@onerror Error-conditions are written to file or show in a messagebox.
Thhat depends from current setting of ASSERT_OUTPUTTYPE. (see debug.hxx for further informations.)
*//*-*****************************************************************************************************/
#ifdef ENABLE_CLASSDEBUG
void impldbg_testWildcard();
#endif // #ifdef ENABLE_CLASSDEBUG
}; // class Wildcard
} // namespace framework
#endif // #ifndef __FRAMEWORK_CLASSES_WILDCARD_HXX_