hwpfilter/source/mzstring.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: mzstring.h,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _MZSTRING_H_
  32 #define _MZSTRING_H_
  33
  34 #ifdef __GNUG__
  35 #  pragma interface
  36 #endif
  37
  38 #ifdef HAVE_CONFIG_H
  39 #  include "config.h"
  40 #endif
  41
  42 /** @name MzString class
  43
  44   It was supposed to be used instead of std::string.
  45
  46   Notes for usage:
  47
  48   When you declare an MzString, it is initially empty. There is no need to
  49   do things like #MzString a = "";#, especially not in constructors.
  50
  51   If you want to use a default empty MzString as a parameter, use
  52
  53 #void foo(MzString par = MzString());   // Correct#
  54
  55 rather than
  56
  57 #void foo(MzString par = "");   // WRONG!#
  58 #void foo(MzString par = 0);    // WRONG!#
  59
  60 (The last one is only wrong because some compilers can't handle it.)
  61
  62 Methods that take an index as parameter all follow this rule: Valid indexes
  63 go from 0 to length()-1.
  64 \begin{tabular}{rl}
  65 Correct: & #foo.substr(0, length()-1);# \\
  66 Wrong:   & #bar.substr(0, length());#
  67 \end{tabular}
  68
  69 It is important that you declare MzStrings as const if possible, because
  70 some methods are much more efficient in const versions.
  71
  72 If you want to check whether a string is empty, do
  73
  74 #if (foo.empty()) something right#
  75
  76 rather than something along the lines of
  77
  78 #if (!foo) completely wrong#
  79
  80 When you use the #.copy()# method, MzString calls "#new []#", so you have to
  81 release the memory with #delete[]#. Don't preallocate memory.
  82
  83 When you want to copy an MzString, just do
  84
  85 #MzString a, b = "String";#
  86 #a = b; // That's it!#
  87
  88 not something like
  89
  90 #MzString a, b = "String";#
  91 #a = b.copy();#
  92
  93 The class automatically handles deep copying when required.
  94 */
  95
  96 class MzString
  97 {
  98     public:
  99         MzString();                               // Create an empty string
 100 // if len = 0, len becomes s.length)
 101         MzString(MzString const &s, int len = 0);
 102         ~MzString();
 103
 104         int       length() const;
 105         const char*   c_str() const;
 106         operator  char*()         { return (char *)c_str(); }
 107
 108 // If it is not posible to use the constructor with an initial
 109 // allocation size, use the following member to set the size.
 110         bool      resize(int len);
 111
 112 // Assignment
 113         void      operator = (MzString &s);
 114         void      operator = (const char *s);
 115
 116 // Appending
 117         MzString  &operator += (char);
 118         MzString  &operator += (const char *);
 119         MzString  &operator += (MzString const &);
 120
 121         MzString  &operator << (const char *);
 122         MzString  &operator << (char);
 123         MzString  &operator << (unsigned char c)  { return *this<<(char)c; }
 124         MzString  &operator << (int);
 125         MzString  &operator << (long);
 126         MzString  &operator << (short i)      { return *this<<(int)i; }
 127         MzString  &operator << (MzString const &);
 128 /* MzString     &operator << (MzString *s)      { return *this<<*s; }
 129
 130   // Removing
 131   char          operator >> (char &c);
 132 */
 133 // Access to specific characters
 134 //char          &operator [] (int n);
 135         char      operator [] (int n);
 136         char      last();
 137
 138 // Comparison
 139 //  Return:
 140 //       0 : 'this' is equal to 's'.
 141 //      -1 : 'this' is less than 's'.
 142 //       1 : 'this' is greater than 's'.
 143         int       compare(const char *s);
 144
 145 // Searching for parts
 146         int       find    (char c);
 147         int       find    (char c, int pos);
 148         int       find    (char *);
 149         int       find    (char *, int pos);
 150         int       rfind   (char c);
 151         int       rfind   (char c, int pos);
 152
 153 // Manipulation
 154         void      replace(int, char c);
 155
 156         void      append  (MzString const &s);
 157         void      append  (const char *s);
 158         void      append  (const char *s, int n);
 159
 160     private:
 161         int       Length;                         // Current Length
 162         int       Allocated;                      // Total space allocated
 163         char      *Data;                          // The actual contents
 164
 165 // Allocate some space for the data.
 166 // Delete Data if it has been allocated.
 167         bool      allocate(int len);
 168 };
 169
 170 inline int MzString::length() const
 171 {
 172     return Length;
 173 }
 174
 175
 176 inline const char* MzString::c_str() const
 177 {
 178     if (Data)
 179     {
 180         Data[Length] = '\0';                      // We always leave room for this.
 181         return (const char *)Data;
 182     } else
 183     return "";
 184 }
 185
 186
 187 //
 188 // Non friend, non member operators
 189 //
 190 #endif                                            /* _MZSTRING_H_ */