CEGUITextUtils.h

/***********************************************************************
        filename:       CEGUITextUtils.h
        created:        30/5/2004
        author:         Paul D Turner
        
        purpose:        Interface to a static class containing some utility
                                functions for text / string operations
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUITextUtils_h_
#define _CEGUITextUtils_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT TextUtils
{
public:
        /*************************************************************************
                Constants
        *************************************************************************/
        static const String     DefaultWhitespace;              
        static const String     DefaultAlphanumerical;  
        static const String     DefaultWrapDelimiters;  


        /*************************************************************************
                Methods
        *************************************************************************/
        static  String  getNextWord(const String& str, String::size_type start_idx = 0, const String& delimiters = DefaultWhitespace);


        static  String::size_type       getWordStartIdx(const String& str, String::size_type idx);


        static  String::size_type       getNextWordStartIdx(const String& str, String::size_type idx);


        static  void    trimLeadingChars(String& str, const String& chars);


        static  void    trimTrailingChars(String& str, const String& chars);


private:
        /*************************************************************************
                Data
        *************************************************************************/
        static  String          d_delimiters;                   
        static  String          d_whitespace;                   


        /*************************************************************************
                Construction / Destruction
        *************************************************************************/
        TextUtils(void);
        ~TextUtils(void);
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUITextUtils_h_