string.h

Go to the documentation of this file.

// Copyright (C) 1999-2005 Open Source Telecom Corporation.
// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.
//
// This program 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 2 of the License, or
// (at your option) any later version.
//
// This program 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, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// Common C++.  If you copy code from other releases into a copy of GNU
// Common C++, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU Common C++, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef CCXX_STRING_H_
#define CCXX_STRING_H_

#ifndef CCXX_MISSING_H_
#include <cc++/missing.h>
#endif

#ifndef CCXX_STRCHAR_H_
#include <cc++/strchar.h>
#endif

#ifdef  CCXX_NAMESPACES
namespace ost {
#endif

class MemPager;

class __EXPORT String
{
protected:
    static const unsigned minsize;
    static const unsigned slotsize;
    static const unsigned pagesize;
    static const unsigned slotlimit;
    static const unsigned slotcount;

    friend class StringObject;

private:
    friend class MemPager;

    static MemPager *pager;
    static char **idx;

#ifdef  CCXX_PACKED
#pragma pack(1)
#endif

    union {
        struct {
            char *text;
            size_t size;
            size_t length;
        }   bigstring;
        struct {
            char text[(sizeof(char *) + (sizeof(size_t) * 2) + 1)];
            char length : 6;
            bool big : 1;
        }   ministring;
    }   content;

#ifdef  CCXX_PACKED
#pragma pack()
#endif

protected:
    inline bool isBig(void) const
        {return content.ministring.big;};

    const char *set(const char *str, size_t len = 0);

    void set(const String &str);

#ifdef  HAVE_SNPRINTF

    const char *set(size_t size, const char *format, ...);
#endif

    void copy(const String &str);

    void init(void);

    static char *getSpace(size_t size);

    size_t setSize(size_t size);

    void setLength(size_t len);

    virtual int compare(const char *text, size_t len = 0, size_t index = 0) const;

    size_t search(const char *text, size_t clen = 0, size_t offset = 0) const;

public:
    static const size_t npos;

    typedef size_t size_type;

    String();

    String(const String &original);

    String(const char *str);

    String(std::string string);

    String(const String &str, size_t offset, size_t len = npos);

#ifdef  HAVE_SNPRINTF

    String(size_t size, const char *format, ...);
#else

    String(size_t count, const char *str);
#endif

    String(size_t count, const char fill = ' ');

    virtual ~String();

    const char *getIndex(size_t index) const;

    char *getText(void) const;

    long getValue(long defvalue = 0l) const;

    bool getBool(bool defbool = false) const;

    const size_t getLength(void) const;

    const size_t getSize(void) const;

    bool isEmpty(void) const;

    void resize(size_t size);

    void clear(void);

    char at(ssize_t offset) const;

    unsigned count(const String &s, size_t offset = 0) const;

    unsigned count(const char *s, size_t offset = 0, size_t len = 0) const;

    String token(const char *delim = " \t\n\r", size_t offset = 0);

    size_t find(const String &s, size_t offset = 0, unsigned instance = 1) const;

    size_t rfind(const String &s, size_t offset = 0) const;

    size_t find(const char *s, size_t offset = 0, size_t len = 0, unsigned count = 1) const;

    size_t rfind(const char *s, size_t offset = 0, size_t len = 0) const;

    inline void trim(const char *cs)
        {setLength(strtrim(cs, getText(), getLength()));};

    inline void chop(const char *cs)
        {setLength(strchop(cs, getText(), getLength()));};

    void strip(const char *cs);

    inline void chop(size_t chars)
        {erase(0, chars);};

    void trim(size_t count);

    void erase(size_t start, size_t len = npos);

    void insert(size_t start, const char *text, size_t len = 0);

    void insert(size_t start, const String &str);

    void replace(size_t start, size_t len, const char *text, size_t count = 0);

    void replace(size_t start, size_t len, const String &string);

    inline size_t find(unsigned instance, const char *text, size_t offset = 0, size_t len = 0) const
        {return find(text, offset, len, instance);};

    inline size_t find(unsigned instance, const String &string, size_t offset = 0) const
        {return find(string, offset, instance);};

    inline String substr(size_t start, size_t len) const
        {return String(*this, start, len);};

    inline const char *(index)(size_t ind) const
        {return getIndex(ind);};

    inline void compact(void)
        {resize(getLength() + 1);};

    inline char *c_str(void) const
        {return getText();};

    inline operator char *() const
        {return getText();};

    inline bool operator!(void) const
        {return isEmpty();};

    inline char *text(void) const
        {return getText();};

    inline char *data(void) const
        {return getText();};

    inline size_t length(void) const
        {return strlen(getText());};

    inline size_t size(void) const
        {return getLength();};

    inline size_t capacity(void) const
        {return getSize();};

    bool empty(void) const
        {return isEmpty();};

    void append(const char *str, size_t count = 0);

#ifdef  HAVE_SNPRINTF

    void append(size_t size, const char *format, ...);
#endif

    void append(const char *str, size_t offset, size_t count);

    void add(char c);

    void append(const String &str);

    inline const char operator[](unsigned ind) const
        {return at(ind);};

    inline const char *operator =(const char *str)
        {return set(str);};

    friend __EXPORT String operator+(const String &s1, const String &s2);

    friend __EXPORT String operator+(const String &s1, const char *s2);

    friend __EXPORT String operator+(const char *s1, const String &s2);

    friend __EXPORT String operator+(const String &s1, const char c2);

    friend __EXPORT String operator+(const char c1, const String &s2);

    inline String &operator+=(const String &str)
        {append(str); return *this;};

    inline String &operator+=(char c)
        {add(c); return *this;};

    inline String &operator+=(const char *str)
        {append(str); return *this;};

    inline String &operator+=(const std::string &str)
        {append(str.c_str()); return *this;};

    friend __EXPORT std::istream &getline(std::istream &is, String &str, char delim = '\n', size_t size = 0);

    friend __EXPORT std::ostream &operator<<(std::ostream &os, const String &str);

    inline friend std::istream &operator>>(std::istream &is, String &str)
        {return getline(is, str);};

#ifdef  HAVE_SNPRINTF

    friend __EXPORT int strprintf(String &str, size_t size, const char *format, ...);
#endif

    bool operator<(const String &str) const;
    bool operator<(const char *str) const;
    bool operator>(const String &str) const;
    bool operator>(const char *str) const;
    bool operator<=(const String &str) const;
    bool operator<=(const char *str) const;
    bool operator>=(const String &str) const;
    bool operator>=(const char *str) const;
    bool operator==(const String &str) const;
    bool operator==(const char *str) const;
    bool operator!=(const String &str) const;
    bool operator!=(const char *str) const;

#ifdef  HAVE_SNPRINTF

    inline String &operator+=(int i)
        {append(16, "%d", i); return *this;};

    inline String &operator+=(unsigned int i)
        {append(16, "%u", i); return *this;};

    inline String &operator+=(long l)
        {append(16, "%l", l); return *this;};

    inline String &operator+=(unsigned long l)
        {append(16, "%ul", l); return *this;};

    inline String &operator+=(float f)
        {append(32, "%f", f); return *this;};

    inline String &operator+=(double d)
        {append(32, "%f", d); return *this;};

    inline String &operator+=(short s)
        {append(8, "%hd", s); return *this;};

    inline String &operator+=(unsigned short s)
        {append(8, "%hu", s); return *this;};


    inline String &operator=(int i)
        {set(16, "%d", i); return *this;};

    inline String &operator=(unsigned int i)
        {set(16, "%u", i); return *this;};

    inline String &operator=(long l)
        {set(16, "%l", l); return *this;};

    inline String &operator=(unsigned long l)
        {set(16, "%ul", l); return *this;};

    inline String &operator=(float f)
        {set(32, "%f", f); return *this;};

    inline String &operator=(double d)
        {set(32, "%f", d); return *this;};

    inline String &operator=(short s)
        {set(8, "%hd", s); return *this;};

    inline String &operator=(unsigned short s)
        {set(8, "%hu", s); return *this;};
#endif

    inline String &operator=(const String &original)
        {copy(original); return *this;};

    bool operator*=(const String &str) const;

    bool operator*=(const char *str) const;
};

class __EXPORT SString : public String, protected std::streambuf, public std::ostream
{
protected:
    int overflow(int c);

public:
    SString();

    SString(const SString &from);

    ~SString();
};

class __EXPORT StringObject
{
public:
    void *operator new(size_t size) NEW_THROWS;

    void operator delete(void *obj);
};

#ifdef  CCXX_NAMESPACES
}
#endif

#endif