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