CeylanStringUtils.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the Ceylan library.
 *
 * The Ceylan library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The Ceylan 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 and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and the GNU General Public License along with the Ceylan library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef CEYLAN_STRING_UTILS_H_
#define CEYLAN_STRING_UTILS_H_


#include "CeylanTypes.h"          // for Ceylan::Uint16
#include "CeylanException.h"      // for Ceylan::Exception


#include <sstream>                // for istringstream
#include <string>                 // for string, string::size_type
#include <list>                   // for list
#include <map>                    // for map


// Deserialization can fail easily, better check it systematically:
#define CEYLAN_DEBUG_STRING_TO_OBJECT 1



namespace Ceylan
{
    
    
    class CEYLAN_DLL StringUtilsException: public Exception
    {
    
        public:
        
            StringUtilsException( const std::string & message ) : 
                Exception( message )
            {       
            
            }
            
            virtual ~StringUtilsException() throw()
            {
            
            }   
        
    } ; 



    typedef Ceylan::Uint8 Latin1Char ;
    
    
    
    typedef std::string::size_type StringSize ;



    extern CEYLAN_DLL const std::string BatchTestOption ;


    
    
    // Container formatting section.

    
    CEYLAN_DLL std::string formatStringList( 
        const std::list<std::string> & stringList,
        bool surroundByTicks = false, Ceylan::Uint8 indentationLevel = 1 ) ;
    
    
    
    CEYLAN_DLL std::string formatStringList( 
        const std::list<std::string> & stringList,
        TextDisplayable::TextOutputFormat targetFormat,
        bool surroundByTicks = false, Ceylan::Uint8 indentationLevel = 1 ) ;
    
    
    
    CEYLAN_DLL std::string formatStringMap( 
        const std::map<std::string, std::string> & stringMap,
        bool surroundByTicks = false ) ;
    
    
    
    // Miscellaneous.
    
    
    CEYLAN_DLL void display( const std::string & message ) ;



    CEYLAN_DLL void displayError( const std::string & errorMessage ) ;



    CEYLAN_DLL StringSize countChars( const std::string & aString, 
        char targetChar ) ;



    CEYLAN_DLL std::string reverse( const std::string & source ) ;



     CEYLAN_DLL char * getNonConstCharFrom( const std::string & source ) ;
     
     
     
    CEYLAN_DLL StringSize substituteInString( 
        std::string & targetString, 
        const std::string & toBeReplaced, 
        const std::string & replacement ) ;
        
        
        
    CEYLAN_DLL std::string substituteIn( 
        const std::string & sourceString, 
        const std::string & toBeReplaced, 
        const std::string & replacement ) ;
        


    CEYLAN_DLL bool isLetter( char targetChar ) ;



    CEYLAN_DLL bool isFigure( char targetChar ) ;



    CEYLAN_DLL bool isAlphanumeric( char targetChar ) ;



    CEYLAN_DLL bool isPunctuation( char targetChar ) ;



    CEYLAN_DLL bool isWhitespace( char targetChar ) ;



    CEYLAN_DLL std::string toUppercase( const std::string & text ) ;
        
        
        
    CEYLAN_DLL std::string encodeToHTML( const std::string & message ) ;
    
    
    
    CEYLAN_DLL std::string encodeToPhonetic( const std::string & message ) ;
        
        
        
    CEYLAN_DLL std::string encodeToROT13( const std::string & message ) ;
        
        
        
    CEYLAN_DLL std::string demangleSymbol( const std::string & symbol ) ;
                
        
        
    CEYLAN_DLL std::list<std::string> split( const std::string & stringToSplit, 
        char splittingChar ) ;



    /*
    std::list<std::string> split( const std::string & stringToSplit, 
         std::string splittingString ) ;
    */



    CEYLAN_DLL std::string join( const std::list<std::string> & toJoin, 
        const std::string & joiningString ) ;
    


    CEYLAN_DLL std::list<std::string> splitIntoWords( 
        const std::string & sentenceToSplit ) ;



    CEYLAN_DLL std::list<std::string> splitIntoParagraphs( 
        const std::string & textToSplit )  ;
    

    
    template <typename T>
    std::string toString( const std::list<T> & targetList )
    {
    
        std::list<std::string> res ;
        
        for ( typename std::list<T>::const_iterator it = targetList.begin() ;
                it != targetList.end(); it++ )
            res.push_back( Ceylan::toString( *it ) ) ;  
        
        return "[ " + join( res, ", " ) + " ]" ;
        
    }


    
    template <typename T>
    void stringToObject( const std::string & source, T & object )
    {
    
        std::istringstream iss( source ) ;
        iss >> object ;

#if CEYLAN_DEBUG_STRING_TO_OBJECT

        if ( iss.fail() )
        {
            throw Ceylan::Exception( 
                "Conversion error in Ceylan string utilities "
                "while using template stringToObject." ) ;
        }
    
#endif // CEYLAN_DEBUG_STRING_TO_OBJECT

    }
    
    

}


#endif // CEYLAN_STRING_UTILS_H_

---