String.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBSTD_STRING_H
#define __LIBSTD_STRING_H
 
#include "Types.h"
#include "Macros.h"
#include "Assert.h"
#include "Sequence.h"
#include "List.h"
 
#define STRING_DEFAULT_SIZE 64
 
class String : public Sequence<char>
{
  using Sequence<char>::compareTo;
  using Sequence<char>::equals;
 
  public:
 
    String();
 
    String(const String & str);
 
    String(char *s, const bool copy = true);
 
    String(const char *s, const bool copy = false);
 
    String(const int number);
 
    virtual ~String();
 
    virtual Size size() const;
 
    virtual Size count() const;
 
    Size length() const;
 
    static Size length(char *str);
 
    static Size length(const char *str);
 
    virtual bool resize(const Size size);
 
    virtual bool reserve(const Size count);
 
    virtual const char * get(const Size position) const;
 
    virtual const char & at(const Size position) const;
 
    virtual const char value(const Size position) const;
 
    virtual bool contains(const char character) const;
 
    bool startsWith(const String & prefix) const;
 
    bool startsWith(const char * prefix) const;
 
    bool endsWith(const String & suffix) const;
 
    bool endsWith(const char * suffix) const;
 
    virtual int compareTo(const String & str) const;
 
    virtual int compareTo(const String & str,
                          const bool caseSensitive = true) const;
 
    virtual int compareTo(const char *str,
                          const bool caseSensitive = true,
                          const Size count = 0) const;
 
    virtual bool equals(const String &str) const;
 
    bool match(const char *mask) const;
 
    String substring(const Size index, const Size size = 0) const;
 
    List<String> split(const char delimiter) const;
 
    List<String> split(const String & delimiter) const;
 
    long toLong(const Number::Base base = Number::Dec) const;
 
    String & pad(const Size length);
 
    String & trim();
 
    String & lower();
 
    String & upper();
 
    Size set(const long number,
             const Number::Base base = Number::Dec,
             char *string = ZERO);
 
    Size setUnsigned(const ulong number,
                     const Number::Base base = Number::Dec,
                     char *string = ZERO,
                     const bool sign = false);
 
    void operator = (const char *str);
 
    void operator = (const String & str);
 
    bool operator == (const String & str) const;
 
    bool operator != (const String & str) const;
 
    const char * operator * () const;
 
    char * operator * ();
 
    String & operator << (const char *str);
 
    String & operator << (const String & str);
 
    String & operator << (const int number);
 
    String & operator << (const unsigned int number);
 
    String & operator << (const void *pointer);
 
    String & operator << (const Number::Base format);
 
  private:
 
    char *m_string;
 
    Size m_size;
 
    Size m_count;
 
    bool m_allocated;
 
    Number::Base m_base;
};
 
#endif /* __LIBSTD_STRING_H */