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