include/stringclass.h

   1 /*@
   2  * Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
   3  *
   4  * Copyright (C) 1989 - 1992, 2002 Free Software Foundation, Inc.
   5  *      Written by James Clark (jjc@jclark.com)
   6  *
   7  * This is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; either version 2, or (at your option) any later
  10  * version.
  11  *
  12  * This is distributed in the hope that it will be useful, but WITHOUT ANY
  13  * WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with groff; see the file COPYING.  If not, write to the Free Software
  19  * Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21 #ifndef _STRINGCLASS_H
  22 #define _STRINGCLASS_H
  23
  24 #include "config.h"
  25
  26 #include <assert.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29
  30 // Ensure that the first declaration of functions that are later
  31 // declared as inline declares them as inline.
  32
  33 class string;
  34
  35 inline string operator+(const string &, const string &);
  36 inline string operator+(const string &, const char *);
  37 inline string operator+(const char *, const string &);
  38 inline string operator+(const string &, char);
  39 inline string operator+(char, const string &);
  40 inline int operator==(const string &, const string &);
  41 inline int operator!=(const string &, const string &);
  42
  43 class string
  44 {
  45   char *ptr;
  46   int len;
  47   int sz;
  48
  49   string(const char *, int, const char *, int); // for use by operator+
  50   void grow1();
  51
  52 public:
  53   string();
  54   string(const string &);
  55   string(const char *);
  56   string(const char *, int);
  57   string(char);
  58
  59   ~string();
  60
  61   string &operator=(const string &);
  62   string &operator=(const char *);
  63   string &operator=(char);
  64
  65   string &operator+=(const string &);
  66   string &operator+=(const char *);
  67   string &operator+=(char);
  68   void append(const char *, int);
  69
  70   int length() const;
  71   int empty() const;
  72   int operator*() const;
  73
  74   string substring(int i, int n) const;
  75
  76   char &operator[](int);
  77   char operator[](int) const;
  78
  79   void set_length(int i);
  80   const char *contents() const;
  81   int search(char) const;
  82   char *extract() const;
  83   void remove_spaces();
  84   void clear();
  85   void move(string &);
  86
  87   friend string operator+(const string &, const string &);
  88   friend string operator+(const string &, const char *);
  89   friend string operator+(const char *, const string &);
  90   friend string operator+(const string &, char);
  91   friend string operator+(char, const string &);
  92
  93   friend int operator==(const string &, const string &);
  94   friend int operator!=(const string &, const string &);
  95   friend int operator<=(const string &, const string &);
  96   friend int operator<(const string &, const string &);
  97   friend int operator>=(const string &, const string &);
  98   friend int operator>(const string &, const string &);
  99 };
 100
 101 inline char &string::operator[](int i)
 102 {
 103   assert(i >= 0 && i < len);
 104   return ptr[i];
 105 }
 106
 107 inline char string::operator[](int i) const
 108 {
 109   assert(i >= 0 && i < len);
 110   return ptr[i];
 111 }
 112
 113 inline int string::length() const
 114 {
 115   return len;
 116 }
 117
 118 inline int string::empty() const
 119 {
 120   return len == 0;
 121 }
 122
 123 inline int string::operator*() const
 124 {
 125   return len;
 126 }
 127
 128 inline const char *string::contents() const
 129 {
 130   return ptr;
 131 }
 132
 133 inline string operator+(const string &s1, const string &s2)
 134 {
 135   return string(s1.ptr, s1.len, s2.ptr, s2.len);
 136 }
 137
 138 inline string operator+(const string &s1, const char *s2)
 139 {
 140   return (s2 == NULL) ? s1 : string(s1.ptr, s1.len, s2, strlen(s2));
 141 }
 142
 143 inline string operator+(const char *s1, const string &s2)
 144 {
 145   return (s1 == NULL) ? s2 : string(s1, strlen(s1), s2.ptr, s2.len);
 146 }
 147
 148 inline string operator+(const string &s, char c)
 149 {
 150   return string(s.ptr, s.len, &c, 1);
 151 }
 152
 153 inline string operator+(char c, const string &s)
 154 {
 155   return string(&c, 1, s.ptr, s.len);
 156 }
 157
 158 inline int operator==(const string &s1, const string &s2)
 159 {
 160   return (s1.len == s2.len
 161           && (s1.len == 0 || memcmp(s1.ptr, s2.ptr, s1.len) == 0));
 162 }
 163
 164 inline int operator!=(const string &s1, const string &s2)
 165 {
 166   return (s1.len != s2.len
 167           || (s1.len != 0 && memcmp(s1.ptr, s2.ptr, s1.len) != 0));
 168 }
 169
 170 inline string string::substring(int i, int n) const
 171 {
 172   assert(i >= 0 && i + n <= len);
 173   return string(ptr + i, n);
 174 }
 175
 176 inline string &string::operator+=(char c)
 177 {
 178   if (len >= sz)
 179     grow1();
 180   ptr[len++] = c;
 181   return *this;
 182 }
 183
 184 void put_string(const string &, FILE *);
 185
 186 string as_string(int);
 187
 188 #endif // _STRINGCLASS_H
 189 // s-it2-mode