src/base/str.hh

   1 /*
   2  * Copyright (c) 2001-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  *          Steve Reinhardt
  30  */
  31
  32 #ifndef __STR_HH__
  33 #define __STR_HH__
  34
  35 #include <cctype>
  36 #include <cstring>
  37 #include <sstream>
  38 #include <string>
  39 #include <vector>
  40
  41 template<class> class Hash;
  42 template<>
  43 class Hash<std::string> {
  44 public:
  45   unsigned operator()(const std::string &s) {
  46       std::string::const_iterator i = s.begin();
  47       std::string::const_iterator end = s.end();
  48       unsigned hash = 5381;
  49
  50       while (i < end)
  51           hash = ((hash << 5) + hash) + *i++;
  52
  53       return hash;
  54   }
  55 };
  56
  57 inline void
  58 eat_lead_white(std::string &s)
  59 {
  60     std::string::size_type off = s.find_first_not_of(' ');
  61     if (off != std::string::npos) {
  62         std::string::iterator begin = s.begin();
  63         s.erase(begin, begin + off);
  64     }
  65 }
  66
  67 inline void
  68 eat_end_white(std::string &s)
  69 {
  70     std::string::size_type off = s.find_last_not_of(' ');
  71     if (off != std::string::npos)
  72         s.erase(s.begin() + off + 1, s.end());
  73 }
  74
  75 inline void
  76 eat_white(std::string &s)
  77 {
  78     eat_lead_white(s);
  79     eat_end_white(s);
  80 }
  81
  82 inline std::string
  83 to_lower(const std::string &s)
  84 {
  85     std::string lower;
  86     int len = s.size();
  87
  88     lower.reserve(len);
  89
  90     for (int i = 0; i < len; ++i)
  91         lower.push_back(tolower(s[i]));
  92
  93     return lower;
  94 }
  95
  96 // Split the string s into lhs and rhs on the first occurence of the
  97 // character c.
  98 bool
  99 split_first(const std::string &s, std::string &lhs, std::string &rhs, char c);
 100
 101 // Split the string s into lhs and rhs on the last occurence of the
 102 // character c.
 103 bool
 104 split_last(const std::string &s, std::string &lhs, std::string &rhs, char c);
 105
 106 // Tokenize the string <s> splitting on the character <token>, and
 107 // place the result in the string vector <vector>.  If <ign> is true,
 108 // then empty result strings (due to trailing tokens, or consecutive
 109 // tokens) are skipped.
 110 void
 111 tokenize(std::vector<std::string> &vector, const std::string &s,
 112          char token, bool ign = true);
 113
 114 template <class T> bool
 115 to_number(const std::string &value, T &retval);
 116
 117 template <class T>
 118 inline std::string
 119 to_string(const T &value)
 120 {
 121     std::stringstream str;
 122     str << value;
 123     return str.str();
 124 }
 125
 126 // Put quotes around string arg if it contains spaces.
 127 inline std::string
 128 quote(const std::string &s)
 129 {
 130     std::string ret;
 131     bool quote = s.find(' ') != std::string::npos;
 132
 133     if (quote)
 134         ret = '"';
 135
 136     ret += s;
 137
 138     if (quote)
 139         ret += '"';
 140
 141     return ret;
 142 }
 143
 144
 145 /**
 146  * Return true if 's' starts with the prefix string 'prefix'.
 147  */
 148 inline bool
 149 startswith(const char *s, const char *prefix)
 150 {
 151     return (strncmp(s, prefix, strlen(prefix)) == 0);
 152 }
 153
 154
 155 /**
 156  * Return true if 's' starts with the prefix string 'prefix'.
 157  */
 158 inline bool
 159 startswith(const std::string &s, const char *prefix)
 160 {
 161     return (s.compare(0, strlen(prefix), prefix) == 0);
 162 }
 163
 164
 165 /**
 166  * Return true if 's' starts with the prefix string 'prefix'.
 167  */
 168 inline bool
 169 startswith(const std::string &s, const std::string &prefix)
 170 {
 171     return (s.compare(0, prefix.size(), prefix) == 0);
 172 }
 173
 174
 175 #endif //__STR_HH__