1 | #ifndef _theplu_svndigest_configuration_ |
---|
2 | #define _theplu_svndigest_configuration_ |
---|
3 | |
---|
4 | // $Id: Configuration.h 1023 2010-01-10 23:15:47Z peter $ |
---|
5 | |
---|
6 | /* |
---|
7 | Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson |
---|
8 | Copyright (C) 2010 Peter Johansson |
---|
9 | |
---|
10 | This file is part of svndigest, http://dev.thep.lu.se/svndigest |
---|
11 | |
---|
12 | svndigest is free software; you can redistribute it and/or modify it |
---|
13 | under the terms of the GNU General Public License as published by |
---|
14 | the Free Software Foundation; either version 3 of the License, or |
---|
15 | (at your option) any later version. |
---|
16 | |
---|
17 | svndigest is distributed in the hope that it will be useful, but |
---|
18 | WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
---|
20 | General Public License for more details. |
---|
21 | |
---|
22 | You should have received a copy of the GNU General Public License |
---|
23 | along with svndigest. If not, see <http://www.gnu.org/licenses/>. |
---|
24 | */ |
---|
25 | |
---|
26 | #include "Alias.h" |
---|
27 | |
---|
28 | #include <iostream> |
---|
29 | #include <map> |
---|
30 | #include <stdexcept> |
---|
31 | #include <string> |
---|
32 | #include <utility> |
---|
33 | #include <vector> |
---|
34 | |
---|
35 | namespace theplu{ |
---|
36 | namespace svndigest{ |
---|
37 | |
---|
38 | /// |
---|
39 | /// Configuration class takes care of all setting defined in the |
---|
40 | /// configuration file. |
---|
41 | /// |
---|
42 | class Configuration |
---|
43 | { |
---|
44 | public: |
---|
45 | static Configuration& instance(void); |
---|
46 | |
---|
47 | /** |
---|
48 | \return Hexadecimal color code (e.g. 5aee4a) that is used in |
---|
49 | blame output and as line colors in plots. If no color is |
---|
50 | configured for \a author, an empty string is returned. |
---|
51 | */ |
---|
52 | std::string author_str_color(const std::string& author) const; |
---|
53 | |
---|
54 | /** |
---|
55 | The map to lookup the author-color mapping set in the |
---|
56 | configuration file. The color code is a six digit hexadecimal |
---|
57 | number rrggbb. |
---|
58 | |
---|
59 | \return The author-color map |
---|
60 | */ |
---|
61 | const std::map<std::string, std::string>& author_colors(void) const; |
---|
62 | |
---|
63 | /** |
---|
64 | \return vector of parse codons for the given \a file_name |
---|
65 | */ |
---|
66 | const std::vector<std::pair<std::string, std::string> >* |
---|
67 | codon(std::string file_name) const; |
---|
68 | |
---|
69 | /// |
---|
70 | /// @brief Aliases for Copyright |
---|
71 | /// |
---|
72 | const std::map<std::string, Alias>& copyright_alias(void) const; |
---|
73 | |
---|
74 | /** |
---|
75 | \return pdf, png, none, or svg |
---|
76 | */ |
---|
77 | const std::string& image_anchor_format(void) const; |
---|
78 | |
---|
79 | /** |
---|
80 | \brief set image_anchor_format |
---|
81 | */ |
---|
82 | void image_anchor_format(const std::string&); |
---|
83 | |
---|
84 | /** |
---|
85 | \return png, none, svg, or svgz |
---|
86 | */ |
---|
87 | const std::string& image_format(void) const; |
---|
88 | |
---|
89 | /** |
---|
90 | \brief set image_format |
---|
91 | */ |
---|
92 | void image_format(const std::string&); |
---|
93 | |
---|
94 | /// |
---|
95 | /// throw if stream is not a valid config |
---|
96 | /// |
---|
97 | /// @brief load configuration from stream |
---|
98 | /// |
---|
99 | void load(std::istream&); |
---|
100 | |
---|
101 | /// |
---|
102 | /// @return true if we should warn about missing copyright statement |
---|
103 | /// |
---|
104 | bool missing_copyright_warning(void) const; |
---|
105 | |
---|
106 | /// |
---|
107 | /// @return root for the trac envrionment, e.g., |
---|
108 | /// http://dev.thep.lu.se/svndigest/ |
---|
109 | /// |
---|
110 | std::string trac_root(void) const; |
---|
111 | |
---|
112 | private: |
---|
113 | /// |
---|
114 | /// Creates a Config object with default settings. |
---|
115 | /// |
---|
116 | /// @brief Default Constructor |
---|
117 | /// |
---|
118 | Configuration(void); |
---|
119 | // Copy Constructor not implemented |
---|
120 | Configuration(const Configuration&); |
---|
121 | // assignment not implemented because assignment is always self-assignment |
---|
122 | Configuration& operator=(const Configuration&); |
---|
123 | // destructor not implemented |
---|
124 | ~Configuration(void); |
---|
125 | |
---|
126 | friend std::ostream& operator<<(std::ostream&, const Configuration&); |
---|
127 | |
---|
128 | void add_codon(std::string, std::string, std::string); |
---|
129 | |
---|
130 | void clear(void); |
---|
131 | const std::pair<std::string,std::string>* dictionary(std::string lhs) const; |
---|
132 | bool equal_false(const std::string&) const; |
---|
133 | bool equal_true(const std::string&) const; |
---|
134 | /// |
---|
135 | /// @brief load deafult configuration |
---|
136 | /// |
---|
137 | void load(void); |
---|
138 | |
---|
139 | void set_default(void); |
---|
140 | /** |
---|
141 | Translate string \a str using dictionary \a dict |
---|
142 | |
---|
143 | \note \a str must be equal to d.first (see function equal), |
---|
144 | or behavior is unspecified. |
---|
145 | |
---|
146 | \throw if a '$' character is not followed by a positive integer |
---|
147 | that is not larger than number of wildcards in dictionary \a d. |
---|
148 | */ |
---|
149 | std::string translate(const std::string& str, |
---|
150 | const std::pair<std::string, std::string>& d) const; |
---|
151 | |
---|
152 | void validate_dictionary(void) const; |
---|
153 | |
---|
154 | static Configuration* instance_; |
---|
155 | |
---|
156 | std::map<std::string, std::string> author_color_; |
---|
157 | std::map<std::string, Alias> copyright_alias_; |
---|
158 | |
---|
159 | bool missing_copyright_warning_; |
---|
160 | |
---|
161 | typedef std::vector<std::pair<std::string, std::string> > VectorPair; |
---|
162 | typedef std::vector<std::pair<std::string, VectorPair> > String2Codons; |
---|
163 | String2Codons string2codons_; |
---|
164 | |
---|
165 | VectorPair dictionary_; |
---|
166 | std::string image_anchor_format_; |
---|
167 | std::string image_format_; |
---|
168 | std::string trac_root_; |
---|
169 | }; |
---|
170 | |
---|
171 | /// |
---|
172 | /// @brief Output operator |
---|
173 | /// |
---|
174 | std::ostream& operator<<(std::ostream&, const Configuration&); |
---|
175 | |
---|
176 | /** |
---|
177 | If first character is '\n' replace it with "<NEWLINE>" |
---|
178 | */ |
---|
179 | std::string trans_end_code(std::string); |
---|
180 | |
---|
181 | /** |
---|
182 | If last character is '\n' replace it with "<NEWLINE>" |
---|
183 | */ |
---|
184 | std::string trans_beg_code(std::string); |
---|
185 | |
---|
186 | /** |
---|
187 | Trim \a c from beginning and end of string \a str; |
---|
188 | |
---|
189 | \return resulting string |
---|
190 | |
---|
191 | \throw if first or last character of \a str is NOT character \a c |
---|
192 | */ |
---|
193 | std::string trim(std::string str, char c); |
---|
194 | |
---|
195 | /** |
---|
196 | \brief Class for errors when reading config file. |
---|
197 | */ |
---|
198 | class Config_error : public std::runtime_error |
---|
199 | { |
---|
200 | public: |
---|
201 | Config_error(const std::string& line, const std::string& message); |
---|
202 | }; |
---|
203 | |
---|
204 | }} // end of namespace svndigest and namespace theplu |
---|
205 | |
---|
206 | #endif |
---|
207 | |
---|
208 | |
---|