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   operator bool ()
  97   {
  98     return length_i ();
  99   }
 100   void append (String);
 101   void prepend (String);
 102
 103   char operator []( int n) const { return strh_[n]; }
 104
 105   /// return n leftmost chars
 106   String left_str (int n) const;
 107
 108   /// return n rightmost chars
 109   String right_str (int n) const;
 110
 111   /// return uppercase of *this
 112   String upper_str() const;
 113
 114   /// return lowercase of *this
 115   String lower_str() const;
 116
 117   /// return the "esrever" of *this
 118   String reversed_str() const;
 119
 120
 121   /// return a piece starting at index_i (first char = index_i 0), length n
 122   String mid_str (int index_i, int n) const;
 123
 124   /// cut out a middle piece, return remainder
 125   String nomid_str (int index_i, int n) const;
 126
 127   /// signed comparison,  analogous to memcmp;
 128   static int compare_i (String const & s1,const  String& s2);
 129
 130   /// index of rightmost c
 131   int index_last_i (char c) const;
 132
 133   /// index of rightmost element of string
 134   int index_last_i (char const* string) const;
 135
 136   int index_i (char c) const;
 137   int index_i (String) const;
 138   int index_any_i (String) const;
 139
 140   void to_upper();
 141   void to_lower();
 142   /// provide Stream output
 143   void print_on (ostream& os) const;
 144
 145   /// the length of the string
 146   int length_i() const;
 147
 148   // ***** depreciated
 149   int len() const {
 150     return length_i();
 151   }
 152
 153   /// convert to an integer
 154   int value_i() const;
 155
 156   /// convert to a double
 157   double value_f() const;
 158 };
 159
 160 #include "compare.hh"
 161
 162 INSTANTIATE_COMPARE(String const &, String::compare_i);
 163
 164 // because char const* also has an operator ==, this is for safety:
 165 inline bool operator==(String s1, char const* s2){
 166   return s1 == String (s2);
 167 }
 168 inline bool operator==(char const* s1, String s2)
 169 {
 170   return String (s1)==s2;
 171 }
 172 inline bool operator!=(String s1, char const* s2 ) {
 173   return s1!=String (s2);
 174 }
 175 inline bool operator!=(char const* s1,String s2) {
 176   return String (s2) !=s1;
 177 }
 178
 179
 180 inline String
 181 operator  + (String s1, String  s2)
 182 {
 183   s1 += s2;
 184   return s1;
 185 }
 186
 187 inline ostream &
 188 operator << ( ostream& os, String d)
 189 {
 190   d.print_on (os);
 191   return os;
 192 }
 193
 194 #endif