src/SquidString.h

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG: section 67    String
   5  * AUTHOR: Duane Wessels
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from
  11  *  the Internet community; see the CONTRIBUTORS file for full
  12  *  details.   Many organizations have provided support for Squid's
  13  *  development; see the SPONSORS file for full details.  Squid is
  14  *  Copyrighted (C) 2001 by the Regents of the University of
  15  *  California; see the COPYRIGHT file for full details.  Squid
  16  *  incorporates software developed and/or copyrighted by other
  17  *  sources; see the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  */
  34
  35 #ifndef SQUID_STRING_H
  36 #define SQUID_STRING_H
  37
  38 #include "config.h"
  39
  40 /** todo checks to wrap this include properly */
  41 #include <ostream>
  42
  43
  44 #define DEBUGSTRINGS 0
  45 #if DEBUGSTRINGS
  46 #include "splay.h"
  47
  48 class String;
  49
  50 class StringRegistry
  51 {
  52
  53 public:
  54     static StringRegistry &Instance();
  55
  56     void add
  57     (String const *);
  58
  59     StringRegistry();
  60
  61     void remove
  62     (String const *);
  63
  64 private:
  65     static OBJH Stat;
  66
  67     static StringRegistry Instance_;
  68
  69     static SplayNode<String const *>::SPLAYWALKEE Stater;
  70
  71     Splay<String const *> entries;
  72
  73     bool registered;
  74
  75 };
  76
  77 class StoreEntry;
  78 #endif
  79
  80 class String
  81 {
  82
  83 public:
  84     _SQUID_INLINE_ String();
  85     String (char const *);
  86     String (String const &);
  87     ~String();
  88
  89     String &operator =(char const *);
  90     String &operator =(String const &);
  91     bool operator ==(String const &) const;
  92     bool operator !=(String const &) const;
  93
  94     /**
  95      * Retrieve a single character in the string.
  96      \param pos Position of character to retrieve.
  97      */
  98     _SQUID_INLINE_ char &operator [](unsigned int pos);
  99
 100     _SQUID_INLINE_ int size() const;
 101     _SQUID_INLINE_ char const * buf() const;
 102     void limitInit(const char *str, int len); // TODO: rename to assign()
 103     void clean();
 104     void reset(char const *str);
 105     void append(char const *buf, int len);
 106     void append(char const *buf);
 107     void append(char const);
 108     void append (String const &);
 109     void absorb(String &old);
 110     _SQUID_INLINE_ const char * pos(char const *) const;
 111     _SQUID_INLINE_ const char * pos(char const ch) const;
 112     _SQUID_INLINE_ const char * rpos(char const ch) const;
 113     _SQUID_INLINE_ int cmp (char const *) const;
 114     _SQUID_INLINE_ int cmp (char const *, size_t count) const;
 115     _SQUID_INLINE_ int cmp (String const &) const;
 116     _SQUID_INLINE_ int caseCmp (char const *) const;
 117     _SQUID_INLINE_ int caseCmp (char const *, size_t count) const;
 118
 119     /** \deprecated Use assignment to [] position instead.
 120      *              ie   str[0] = 'h';
 121      */
 122     _SQUID_INLINE_ void set(char const *loc, char const ch);
 123
 124     /** \deprecated Use assignment to [] position instead.
 125      *              ie   str[newLength] = '\0';
 126      */
 127     _SQUID_INLINE_ void cut(size_t newLength);
 128
 129     /** \deprecated Use assignment to [] position instead.
 130      *              ie   str[newLength] = '\0';
 131      */
 132     _SQUID_INLINE_ void cutPointer(char const *loc);
 133
 134 #if DEBUGSTRINGS
 135
 136     void stat (StoreEntry *) const;
 137
 138 #endif
 139
 140
 141
 142 private:
 143     void allocAndFill(const char *str, int len);
 144     void allocBuffer(size_t sz);
 145     void setBuffer(char *buf, size_t sz);
 146
 147     /* never reference these directly! */
 148     unsigned short int size_; /* buffer size; 64K limit */
 149
 150     unsigned short int len_;  /* current length  */
 151
 152     char *buf_;
 153 };
 154
 155 _SQUID_INLINE_ std::ostream & operator<<(std::ostream& os, String const &aString);
 156
 157 #ifdef _USE_INLINE_
 158 #include "String.cci"
 159 #endif
 160
 161 #endif /* SQUID_STRING_H */