StringPimpl.h

#ifndef REBECCA_STRINGPIMPL_H
#define REBECCA_STRINGPIMPL_H

/*
 * RebeccaAIML, Artificial Intelligence Markup Language 
 * C++ api and engine.
 *
 * Copyright (C) 2005,2006,2007 Frank Hassanabad
 *
 * This file is part of RebeccaAIML.
 *
 * RebeccaAIML is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * RebeccaAIML 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


//To get the REBECA_EXPORT macro
#include <rebecca/exports.h>
#include <rebecca/Exceptions.h>

//To get the size_t for the deletions
#include <cstddef>

/* Disable Windows VC 7.x warning about 
 * it ignoring the throw specification
 */
#ifdef _WIN32
#    pragma warning ( push )
#    pragma warning( disable : 4290 )
#endif


//See AimlFacade for the explanation of this namespace
namespace rebecca
{
//See AimlFacade for the explanation of this namespace
namespace impl
{



/*
 * The private string which I do not expose.
 * 
 * This forward decleration is so that the code will 
 * compile but the true string is kept private within
 * this class.
 */ 
class StringPrivate;

class REBECCA_EXPORT StringPimpl
{
    public:

        StringPimpl() 
            throw(Exception &);

        StringPimpl(const char * const stringPimpl) 
            throw(Exception &);
        
        const char *c_str() const 
            throw(Exception &);

        bool empty() const 
            throw(Exception &);

        StringPimpl(const StringPimpl& stringPimpl);

        StringPimpl &operator=(const StringPimpl &stringPimpl);

        virtual ~StringPimpl();
        
        void operator delete(void* p);

        void *operator new(size_t size);


        StringPimpl& operator+=(const StringPimpl &s);

        StringPimpl& operator+=(const char *s);

        bool operator!=(const char *s) const;

        StringPimpl operator+(const char *s) const;

        bool operator==(const StringPimpl &s) const;
        
        bool operator==(const char *s) const;

        bool startsWith(const StringPimpl &right) const;

        int getInteger() const
            throw(NumberFormatException &);

        bool existsAsAFile() const
            throw();

        bool existsAsADirectory() const
            throw();
        
        void transformIntoAbsoluteFilePath() const
            throw();

        StringPimpl operator+(const StringPimpl &s) const;

        StringPimpl &operator=(const char *c);

        StringPimpl &operator=(const char c);

        unsigned int size() const;

        unsigned int length() const;

        char at(const unsigned int i) const;

        bool operator<(const StringPimpl& s) const;

        bool operator!=(const StringPimpl &s) const;

        void push_back(char c);

        void clear();
    
        StringPimpl &transformToUpperCase()
            throw();

        StringPimpl &transformToLowerCase()
            throw();

        StringPimpl &transformByTrimmingWhiteSpace()
            throw();

        StringPimpl &transformFirstCharacterUpperCase()
            throw();

        StringPimpl &transformByTrimmingLeft()
            throw();

        StringPimpl &transformByTrimmingRight()
            throw();

        StringPimpl &transformByTrimmingExcessSpaces()
            throw();

        void removePunctuation(const StringPimpl &sentenceSplitters)
            throw();
    
        static StringPimpl getString(int number)
            throw(NumberFormatException &);

    private:

        void init(const char * const stringPimpl);
        
        StringPrivate *m_pimpl;
};

} //end namespace impl

//expose StringPimpl to Rebecca namespace 
using rebecca::impl::StringPimpl;

REBECCA_EXPORT bool operator==(const char *c, const StringPimpl &s);

REBECCA_EXPORT StringPimpl operator+(const char *c, const StringPimpl &s);

} //end namespace rebecca

#ifdef _WIN32
#    pragma warning ( pop )
#endif





#endif

---