String.h

Go to the documentation of this file.

/*
 * String.h
 *
 * Smalltalk like class library for C++
 * Abstract textual string. Header.
 *
 * Copyright (c) 2003,2004 Milan Cermak
 */
/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This 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 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __STRING_H
#define __STRING_H

#include <stlib/SequenceableCollection.h>
#include <stdarg.h>

namespace Core {

class Array;
class ByteArray;
class Character;
class Number;
class StringImpl;
class Stream;
class Visitor;

class String : public SequenceableCollection
{
  protected:
    StringImpl *implementor;

  public:
    String(long size = 0);

    String(const char *str);

    String(const ByteArray *byteArray);

    virtual ~String(void);

    static String* format(const String* format, ...);

    static String* format(const char* format, ...);

    /* Copying protocol */
    String(const String &origin);

    /* Class-accessing protocol */
    virtual String *className(void) const;

    /* Class-instance creation protocol */
    static String *with(Character *object);
    static String *with(Character *obj1, Character *obj2);
    static String *with(Character *obj1, Character *obj2, Character *obj3);
    static String *with(Character *obj1, Character *obj2, Character *obj3, Character *obj4);

    static String *withAll(Collection *coll);

    /* Accessing protocol */
    virtual Object *at(int index) const;
    virtual void put(int index, Object *obj);
    virtual void put(int index, char obj);
    virtual long size(void) const;
    virtual long indexOf(Object *obj) const
      { return SequenceableCollection::indexOf(obj); }
    virtual long indexOf(const char obj) const;
    virtual long lastIndexOf(Object *obj) const
      { return SequenceableCollection::lastIndexOf(obj); }
    virtual long lastIndexOf(const char obj) const;
    virtual long nextIndexOf(Object *element, long startIndex, long stopIndex) const
      { return SequenceableCollection::nextIndexOf(element, startIndex, stopIndex); }
    virtual long nextIndexOf(const char element, long startIndex, long stopIndex) const;
    virtual long prevIndexOf(Object *element, long startIndex, long stopIndex) const
      { return SequenceableCollection::prevIndexOf(element, startIndex, stopIndex); }
    virtual long prevIndexOf(const char element, long startIndex, long stopIndex) const;

    /* Adding protocol */
    virtual void add(Object *obj);
    virtual void changeSize(long newSize);

    /* Comparing protocol */
    virtual long hash(void) const;
    virtual bool isEqual(const Object *object) const;
    virtual bool isEqual(const Object &object) const
      { return SequenceableCollection::isEqual(object); }
    virtual bool isEqual(const char *string) const;

    virtual bool match(String *string);
    virtual bool match(const char *string);
    virtual bool match(String *string, bool ignoreCase);
    virtual bool match(const char *string, bool ignoreCase);
    virtual bool matchesPattern(String *string, bool ignoreCase);

    /* Converting protocol */
    virtual char *asCString(void) const;
    virtual operator char*(void) const;

    virtual Array *asArrayOfSubstrings(void);

    virtual Array *asArrayOfSubstringsSeparatedBy(Character *ch);
    virtual Array *asArrayOfSubstringsSeparatedBy(const char ch);
    virtual ByteArray *asByteArray(void) const;
    virtual ByteArray *asByteArrayEncoding(String *encoding) const;
    virtual ByteArray *asByteArrayEncoding(const char *encoding) const;
    virtual String *asLowercase(void);
    virtual Number *asNumber(void);
    virtual Number *asNumberRadix(int radix);
    virtual String *asUppercase(void);
    virtual String *asUppercaseFirst(void);
    virtual String *asString(void);

    /* Copying protocol */
    virtual Object *copy(void);
    virtual Object *copy(long from, long to)
      { return SequenceableCollection::copy(from, to); }

    virtual Object *copyEmpty(long size);
    virtual SequenceableCollection &operator+(SequenceableCollection &collection);
    virtual String &operator+(const char *string);
    virtual String *concatenateWith(String *string);
    virtual String *concatenateWith(const char *string);

    /* Printing protocol */
    virtual void printOn(Stream *stream) const;

    /* Testing protocol */
    virtual bool includes(Object *object)
      { return SequenceableCollection::includes(object); }
    virtual bool includes(const char element);
    virtual bool includesSubcollection(SequenceableCollection *coll) const
      { return SequenceableCollection::includesSubcollection(coll); }
    virtual bool includesSubcollection(const char *coll) const
      { return SequenceableCollection::includesSubcollection(new String(coll)); }
    virtual bool isString(void) const;
    virtual bool isByteString(void) const;
    virtual bool isTwoByteString(void) const;
    virtual bool isCharacterArray(void) const;

    virtual bool isDigitString(void);

    virtual bool startsWith(SequenceableCollection *coll) const
      { return SequenceableCollection::startsWith(coll); }
    virtual bool startsWith(const char *str) const;
    virtual bool endsWith(SequenceableCollection *coll) const
      { return SequenceableCollection::endsWith(coll); }
    virtual bool endsWith(const char *str) const;

    /* Utilities protocol */
    virtual String *trimBlanks(void);
    virtual String *demangleMethodName(void);

    /* Visiting protocol */
    virtual void visitBy(Visitor *visitor);

  protected:
    /* Private protocol */
    static String *formatArgumentsIntoString(const char *format, va_list args);
    virtual void changeWideToFit(int width);
};

};

#endif /* __STRING_H */

---