diff options
Diffstat (limited to 'framework/inc/classes/wildcard.hxx')
| -rw-r--r-- | framework/inc/classes/wildcard.hxx | 187 |
1 files changed, 187 insertions, 0 deletions
diff --git a/framework/inc/classes/wildcard.hxx b/framework/inc/classes/wildcard.hxx new file mode 100644 index 000000000000..4783d825b258 --- /dev/null +++ b/framework/inc/classes/wildcard.hxx @@ -0,0 +1,187 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: wildcard.hxx,v $ + * $Revision: 1.5 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __FRAMEWORK_CLASSES_WILDCARD_HXX_ +#define __FRAMEWORK_CLASSES_WILDCARD_HXX_ + +//_________________________________________________________________________________________________________________ +// my own includes +//_________________________________________________________________________________________________________________ + +#include <macros/debug.hxx> + +//_________________________________________________________________________________________________________________ +// interface includes +//_________________________________________________________________________________________________________________ + +//_________________________________________________________________________________________________________________ +// other includes +//_________________________________________________________________________________________________________________ +#include <rtl/ustring.hxx> + +//_________________________________________________________________________________________________________________ +// 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_ |