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 <sstream>
  37 #include <string>
  38 #include <vector>
  39
  40 template<class> class Hash;
  41 template<>
  42 class Hash<std::string> {
  43 public:
  44   unsigned operator()(const std::string &s) {
  45       std::string::const_iterator i = s.begin();
  46       std::string::const_iterator end = s.end();
  47       unsigned hash = 5381;
  48
  49       while (i < end)
  50           hash = ((hash << 5) + hash) + *i++;
  51
  52       return hash;
  53   }
  54 };
  55
  56 inline void
  57 eat_lead_white(std::string &s)
  58 {
  59     std::string::size_type off = s.find_first_not_of(' ');
  60     if (off != std::string::npos) {
  61         std::string::iterator begin = s.begin();
  62         s.erase(begin, begin + off);
  63     }
  64 }
  65
  66 inline void
  67 eat_end_white(std::string &s)
  68 {
  69     std::string::size_type off = s.find_last_not_of(' ');
  70     if (off != std::string::npos)
  71         s.erase(s.begin() + off + 1, s.end());
  72 }
  73
  74 inline void
  75 eat_white(std::string &s)
  76 {
  77     eat_lead_white(s);
  78     eat_end_white(s);
  79 }
  80
  81 inline std::string
  82 to_lower(const std::string &s)
  83 {
  84     std::string lower;
  85     int len = s.size();
  86
  87     lower.reserve(len);
  88
  89     for (int i = 0; i < len; ++i)
  90         lower.push_back(tolower(s[i]));
  91
  92     return lower;
  93 }
  94
  95 // Split the string s into lhs and rhs on the first occurence of the
  96 // character c.
  97 bool
  98 split_first(const std::string &s, std::string &lhs, std::string &rhs, char c);
  99
 100 // Split the string s into lhs and rhs on the last occurence of the
 101 // character c.
 102 bool
 103 split_last(const std::string &s, std::string &lhs, std::string &rhs, char c);
 104
 105 // Tokenize the string <s> splitting on the character <token>, and
 106 // place the result in the string vector <vector>.  If <ign> is true,
 107 // then empty result strings (due to trailing tokens, or consecutive
 108 // tokens) are skipped.
 109 void
 110 tokenize(std::vector<std::string> &vector, const std::string &s,
 111          char token, bool ign = true);
 112
 113 template <class T> bool
 114 to_number(const std::string &value, T &retval);
 115
 116 template <class T>
 117 inline std::string
 118 to_string(const T &value)
 119 {
 120     std::stringstream str;
 121     str << value;
 122     return str.str();
 123 }
 124
 125 // Put quotes around string arg if it contains spaces.
 126 inline std::string
 127 quote(const std::string &s)
 128 {
 129     std::string ret;
 130     bool quote = s.find(' ') != std::string::npos;
 131
 132     if (quote)
 133         ret = '"';
 134
 135     ret += s;
 136
 137     if (quote)
 138         ret += '"';
 139
 140     return ret;
 141 }
 142
 143 #endif //__STR_HH__