- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

gstrings.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2001-2013 Graeme Walker <graeme_walker@users.sourceforge.net>
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16 // ===
20
21 #ifndef G_STRINGS_H
22 #define G_STRINGS_H
23
24 #include "gdef.h"
25 #include <string>
26 #include <list>
27 #include <vector>
28 #include <map>
29 #include <stdexcept>
30
32 namespace G
33 {
34
39 typedef std::list<std::string> Strings ;
40
44 typedef std::vector<std::string> StringArray ;
45
49 typedef std::map<std::string,std::string> StringMap ;
50
51 }
52
54 namespace G
55 {
56 class StringMapReader ;
57 }
58
62 class G::StringMapReader
63 {
64 public:
65 StringMapReader( const StringMap & map_ ) ;
67
68 const std::string & at( const std::string & key ) const ;
70
71 const std::string & at( const std::string & key , const std::string & default_ ) const ;
73
74 Strings keys( unsigned int limit = 0U , const char * elipsis = NULL ) const ;
76
77 private:
78 const StringMap & m_map ;
79 } ;
80
81 #endif
G::StringMapReader::StringMapReader
StringMapReader(const StringMap &map_)
Implicit constructor.
Definition: gstrings.cpp:29
G::StringMapReader
An adaptor for reading a const StringMap with at().
Definition: gstrings.h:62
G::Strings
std::list< std::string > Strings
A std::list of std::strings.
Definition: gstrings.h:39
G::StringArray
std::vector< std::string > StringArray
A std::vector of std::strings.
Definition: gstrings.h:44
G::StringMapReader::keys
Strings keys(unsigned int limit=0U, const char *elipsis=NULL) const
Returns a list of keys (optionally up to some limit).
Definition: gstrings.cpp:48
G::StringMapReader::at
const std::string & at(const std::string &key) const
Returns the value, or throws.
Definition: gstrings.cpp:34
G
Low-level classes.
G::StringMap
std::map< std::string, std::string > StringMap
A std::map of std::strings.
Definition: gstrings.h:49