flower/include/string.hh

   1 /*
   2
   3   FILE   : string.hh -- declare String
   4
   5   Rehacked by HWN 3/nov/95
   6   removed String & 's
   7   introduced Class String_handle
   8  */
   9
  10 #ifndef STRING_HH
  11 #define STRING_HH
  12
  13
  14 #include <string.h>
  15 #include <iostream.h>
  16 #include <Rational.h>
  17
  18 #include "string-handle.hh"
  19
  20 /**
  21
  22   Intuitive string class. provides
  23 \begin{itemize}
  24 \item
  25   ref counting through #String_handle#
  26 \item
  27   conversion from bool, int, double, char* , char.
  28 \item
  29   to be moved to String_convert:
  30   conversion to int, upcase, downcase
  31
  32 \item
  33   printable.
  34
  35 \item
  36   indexing (index_i, index_any_i, last_index_i)
  37
  38 \item
  39   cutting (left_str, right_str, mid_str)
  40
  41 \item
  42   concat (+=, +)
  43
  44 \item
  45   signed comparison (<, >, ==, etc)
  46
  47 \item
  48   No operator[] is provided, since this would be enormously  slow. If needed,
  49   convert to char const* .
  50 \end{itemize}
  51
  52 */
  53 class String
  54 {
  55 protected:
  56     String_handle strh_;
  57
  58     bool null_terminated();
  59
  60 public:
  61
  62     /** init to empty string. This is needed because other
  63       constructors are provided.*/
  64     String() {  }
  65     String (Rational);
  66
  67     /// String s = "abc";
  68     String (char const* source);
  69     String (Byte const* byte_C, int length_i);
  70
  71     /// "ccccc"
  72     String (char c, int n = 1);
  73
  74     String (int i , char const *fmt=0);
  75     String ( double f , char const* fmt =0);
  76     /// 'true' or 'false'
  77     String (bool);
  78
  79     ///  return a "new"-ed copy of contents
  80     Byte* copy_byte_p() const; //  return a "new"-ed copy of contents
  81
  82     char const* ch_C() const;
  83     Byte const* byte_C() const;
  84     char* ch_l();
  85     Byte* byte_l();
  86
  87     /// deprecated; use ch_C()
  88     operator char const*() const { return ch_C(); }
  89
  90     String &operator =( String const & source);
  91
  92     /// concatenate s
  93     void operator += (char const* s) { strh_ += s; }
  94     void operator += (String s);
  95
  96     void append (String);
  97     void prepend (String);
  98
  99     char operator []( int n) const { return strh_[n]; }
 100
 101     /// return n leftmost chars
 102     String left_str (int n) const;
 103
 104     /// return n rightmost chars
 105     String right_str (int n) const;
 106
 107     /// return uppercase of *this
 108     String upper_str() const;
 109
 110     /// return lowercase of *this
 111     String lower_str() const;
 112
 113     /// return the "esrever" of *this
 114     String reversed_str() const;
 115
 116
 117     /// return a piece starting at index_i (first char = index_i 0), length n
 118     String mid_str (int index_i, int n) const;
 119
 120     /// cut out a middle piece, return remainder
 121     String nomid_str (int index_i, int n) const;
 122
 123     /// signed comparison,  analogous to memcmp;
 124     static int compare_i (String const & s1,const  String& s2);
 125
 126     /// index of rightmost c
 127     int index_last_i (char c) const;
 128
 129     /// index of rightmost element of string
 130     int index_last_i (char const* string) const;
 131
 132     int index_i (char c) const;
 133     int index_i (String) const;
 134     int index_any_i (String) const;
 135
 136     void to_upper();
 137     void to_lower();
 138     /// provide Stream output
 139     void print_on (ostream& os) const;
 140
 141     /// the length of the string
 142     int length_i() const;
 143
 144     // ***** depreciated
 145     int len() const {
 146         return length_i();
 147     }
 148
 149     /// convert to an integer
 150     int value_i() const;
 151
 152     /// convert to a double
 153     double value_f() const;
 154 };
 155
 156 #include "compare.hh"
 157
 158 INSTANTIATE_COMPARE(String const &, String::compare_i);
 159
 160 // because char const* also has an operator ==, this is for safety:
 161 inline bool operator==(String s1, char const* s2){
 162     return s1 == String (s2);
 163 }
 164 inline bool operator==(char const* s1, String s2)
 165 {
 166     return String (s1)==s2;
 167 }
 168 inline bool operator!=(String s1, char const* s2 ) {
 169     return s1!=String (s2);
 170 }
 171 inline bool operator!=(char const* s1,String s2) {
 172     return String (s2) !=s1;
 173 }
 174
 175
 176 inline String
 177 operator  + (String s1, String  s2)
 178 {
 179     s1 += s2;
 180     return s1;
 181 }
 182
 183 inline ostream &
 184 operator << ( ostream& os, String d)
 185 {
 186     d.print_on (os);
 187     return os;
 188 }
 189
 190 #endif