src/core/string.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This library is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU Library General Public           *
   7  *   License as published by the Free Software Foundation and appearing    *
   8  *   in the file LICENSE.LGPL included in the packaging of this file.      *
   9  *                                                                         *
  10  *   This library is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   Library General Public License for more details.                      *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _tairon_core_string_h
  18 #define _tairon_core_string_h
  19
  20 #include <string>
  21 #include <stdint.h>
  22
  23 namespace Tairon
  24 {
  25
  26 namespace Core
  27 {
  28
  29 /** \brief Just wrapper class around std::string.
  30  *
  31  * It is here because of preparation to later optimization with implicitly
  32  * shared data.
  33  */
  34 class String : public std::string
  35 {
  36         public:
  37                 String() : std::string() {} ;
  38
  39                 String(const std::string &str) : std::string(str) {};
  40
  41                 String(const String &str, size_t pos, size_t count = npos) : std::string(str, pos, count) {};
  42
  43                 String(const char *str, size_t size) : std::string(str, size) {};
  44
  45                 String(const char *str) : std::string(str) {};
  46
  47                 bool canReadLine() {
  48                         return contains('\n');
  49                 };
  50
  51                 /** Returns true if the string contains given one.
  52                  */
  53                 bool contains(const String &what) const {
  54                         return find(what) != npos;
  55                 }
  56
  57                 /** Returns true if the string contains given character.
  58                  */
  59                 bool contains(char what) const {
  60                         return find(what) != npos;
  61                 }
  62
  63                 /** Removes all leading whitespaces. Returns reference to *this.
  64                  */
  65                 String &lstrip();
  66
  67                 /** Converts given number into a string.
  68                  */
  69                 static String number(int32_t num);
  70
  71                 /** Converts given number into a string.
  72                  */
  73                 static String number(uint32_t num);
  74
  75                 /** Converts given number into a string.
  76                  */
  77                 static String number(int64_t num);
  78
  79                 /** Converts given number into a string.
  80                  */
  81                 static String number(uint64_t num);
  82
  83                 /** Cast operator.
  84                  */
  85                 operator const char *() const {
  86                         return c_str();
  87                 }
  88
  89                 /** Returns string containing characters up to first newline character.
  90                  * The beginning of this string with newline character is removed. If
  91                  * there is no newline character then this method returns empty string.
  92                  */
  93                 String readLine();
  94
  95                 /** Removes all trailing whitespaces from the end of the string.
  96                  * Returns reference to *this.
  97                  */
  98                 String &rstrip();
  99
 100                 /** Removes all whitespaces from the beginning and end of the string.
 101                  * Returns reference to *this.
 102                  */
 103                 String &strip();
 104
 105         public:
 106                 static String null;
 107 };
 108
 109 }; // namespace Core
 110
 111 }; // namespace Tairon
 112
 113 #endif
 114
 115 // vim: ai sw=4 ts=4 noet fdm=marker