source: trunk/lib/Configuration.cc @ 815

Last change on this file since 815 was 815, checked in by Peter Johansson, 12 years ago

adding function author_str_color. refs #161

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 14.5 KB
Line 
1// $Id: Configuration.cc 815 2009-08-08 18:23:22Z peter $
2
3/*
4  Copyright (C) 2007, 2008 Peter Johansson
5  Copyright (C) 2008 Jari Häkkinen
6
7  This file is part of svndigest, http://dev.thep.lu.se/svndigest
8
9  svndigest is free software; you can redistribute it and/or modify it
10  under the terms of the GNU General Public License as published by
11  the Free Software Foundation; either version 3 of the License, or
12  (at your option) any later version.
13
14  svndigest is distributed in the hope that it will be useful, but
15  WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with svndigest. If not, see <http://www.gnu.org/licenses/>.
21*/
22
23#include "Configuration.h"
24
25#include "Functor.h"
26
27#include <cassert>
28#include <fstream>
29#include <map>
30#include <string>
31#include <sstream>
32#include <stdexcept>
33#include <utility>
34
35namespace theplu{
36namespace svndigest{
37
38  Configuration* Configuration::instance_=NULL;
39
40
41  Configuration::Configuration(void)
42  {
43  }
44
45
46  void Configuration::add_codon(std::string key, std::string start, 
47                                std::string end)
48  {
49    std::pair<std::string, std::string> p(start,end);
50    String2Codons::iterator iter = string2codons_.end();
51    for (String2Codons::iterator i=string2codons_.begin();
52         i!=string2codons_.end(); ++i)
53      if (i->first == key)
54        iter = i;
55   
56    if (iter==string2codons_.end())
57      string2codons_.push_back(std::make_pair(key, VectorPair(1,p)));
58    else
59      iter->second.push_back(p);
60  }
61
62
63  std::string Configuration::author_str_color(const std::string& author) const
64  {
65    std::string res;
66    std::map<std::string, std::string>::const_iterator iterator;
67    if ( (iterator=author_color_.find(author)) != author_color_.end())
68      res = iterator->second;
69    return res;
70  }
71
72
73  const std::vector<std::pair<std::string, std::string> >* 
74  Configuration::codon(std::string file_name) const 
75  {
76    if (const std::pair<std::string,std::string>* dict=dictionary(file_name))
77      file_name = translate(file_name, *dict);
78    for (String2Codons::const_iterator i(string2codons_.begin());
79         i!=string2codons_.end(); ++i) {
80      if (svndigest::equal(file_name.begin(), file_name.end(), 
81                           i->first.begin(), i->first.end()) ) {
82        return &i->second;
83      }
84    }
85    return NULL;
86  }
87
88
89  const std::map<std::string,Alias>& Configuration::copyright_alias(void) const
90  {
91    return copyright_alias_;
92  }
93
94
95  const std::pair<std::string,std::string>* 
96  Configuration::dictionary(std::string lhs) const
97  {
98    for (size_t i=0; i<dictionary_.size(); ++i)
99      if (svndigest::equal(lhs.begin(), lhs.end(), 
100                           dictionary_[i].first.begin(),
101                           dictionary_[i].first.end()))
102        return &dictionary_[i];
103    return NULL;
104  }
105
106
107  bool Configuration::equal_false(const std::string& str) const
108  {
109    return str=="false" || str=="False" || str=="FALSE" ||
110      str=="no" || str=="No" || str=="NO";
111  }
112
113
114  bool Configuration::equal_true(const std::string& str) const
115  {
116    return str=="true" || str=="True" || str=="TRUE" ||
117      str=="yes" || str=="Yes" || str=="YES";
118  }
119
120
121  void Configuration::load(void)
122  {
123    set_default();
124    validate_dictionary();
125  }
126
127
128  void Configuration::load(std::istream& is)
129  {
130    assert(is.good());
131    set_default();
132
133    bool parsing_found=false;
134    bool dictionary_found=false;
135    std::string line;
136    std::string section;
137    std::string tmp;
138    while (getline(is, line)) {
139      line = ltrim(line);
140      if (line.empty() || line[0]=='#')
141        continue;
142      std::stringstream ss(line);
143      if (line[0] == '[') {
144        getline(ss, tmp, '[');
145        getline(ss, section, ']');
146        continue;
147      }
148      std::string lhs;
149      getline(ss, lhs, '=');
150      lhs = trim(lhs);
151      std::string rhs;
152      getline(ss, rhs);
153      rhs = trim(rhs);
154      if (rhs.empty()){
155        throw Config_error(line, "expected format: <lhs> = <rhs>");
156      }
157      if (section == "copyright-alias"){
158        std::map<std::string,Alias>::iterator iter = 
159          copyright_alias_.lower_bound(lhs);
160        if (iter!=copyright_alias_.end() && iter->first==lhs){
161          std::stringstream mess;
162          mess << "in copright-alias section " << lhs << " defined twice.";
163          throw Config_error(line, mess.str());
164        }
165       
166        // insert alias
167        copyright_alias_.insert(iter,std::make_pair(lhs, Alias(rhs,copyright_alias_.size())));
168      }
169      else if (section == "trac"){
170        if (lhs=="trac-root")
171          trac_root_=rhs;
172        else {
173          std::stringstream mess;
174          mess << "in trac section" << lhs + " is invalid option.";
175          throw Config_error(line, mess.str());
176        }
177      }
178      else if (section == "copyright") {
179        if (lhs=="missing-copyright-warning") {
180          if (equal_false(rhs))
181            missing_copyright_warning_ = false;
182          else if (equal_true(rhs))
183            missing_copyright_warning_ = true;
184          else {
185            throw Config_error(line, "");
186          }
187        }
188      }
189      else if (section == "parsing-codons") {
190        if (!parsing_found) {
191          parsing_found=true;
192          // clearing the default setting
193          string2codons_.clear();
194        }
195       
196        if (codon(lhs)) {
197          std::stringstream mess;
198          mess << "clashes with previous given file name pattern: ";
199          // find previous file-name-pattern
200          for (String2Codons::const_iterator i(string2codons_.begin());
201               i!=string2codons_.end(); ++i) {
202            if (svndigest::equal(lhs.begin(), lhs.end(), 
203                                 i->first.begin(), i->first.end()) ) {
204              mess << "`" << i->first << "'";
205              break;
206            }
207          }
208          throw Config_error(line, mess.str());
209        }
210        std::stringstream ss(rhs);
211        std::string start;
212        while (getline(ss, start, ':')) {
213          start = trim(start);
214          std::string end;
215          getline(ss, end, ';');
216          end = trim(end);
217          if (start.empty() && end.empty())
218            continue;
219          try {
220            if (start.empty() || start=="\"\"") {
221              throw std::runtime_error("start-code is empty");
222            }
223            else if (start.size()<3) {
224              std::stringstream mess;
225              mess << "start-code `" << start << "' is invalid";
226              throw std::runtime_error(mess.str());
227            }
228            start = trim(start, '"');
229            if (end.empty() || end=="\"\"") {
230              throw std::runtime_error("end-code is empty");
231            }
232            else if (end.size()<3) {
233              std::stringstream mess;
234              mess << "end-code `" << end << "' is invalid";
235              throw std::runtime_error(mess.str());
236            }
237            end = trim(end, '"');
238          }
239          catch (std::runtime_error& e){
240            throw Config_error(line, e.what());
241          }
242          replace(start, "\\n", "\n");
243          replace(end, "\\n", "\n");
244          add_codon(lhs, start, end);
245        }
246      } 
247      else if (section == "file-name-dictionary") {
248        if (!dictionary_found) {
249          dictionary_found=true;
250          // clearing the default setting
251          dictionary_.clear();
252        }
253       
254        if (const std::pair<std::string, std::string>* entry=dictionary(lhs)) {
255          std::stringstream mess;
256          mess << "clashes with previous given file name pattern: "
257               << "`" << entry->first << "'";
258          throw Config_error(line, mess.str());
259        }
260        lhs = trim(lhs);
261        rhs = trim(rhs);
262        if (!lhs.empty() && !rhs.empty()) 
263          dictionary_.push_back(std::make_pair(lhs, rhs));
264        else if (!lhs.empty() || !rhs.empty()) {
265          throw Config_error(line, "");
266        }
267      } 
268    }
269    validate_dictionary();
270  }
271
272
273  Configuration& Configuration::instance(void)
274  {
275    if (!instance_){
276      instance_ = new Configuration;
277      instance_->load();
278    }
279    return *instance_;
280  }
281
282
283  bool Configuration::missing_copyright_warning(void) const
284  {
285    return missing_copyright_warning_;
286  }
287
288
289  std::string
290  Configuration::translate(const std::string& str,
291                           const std::pair<std::string, std::string>& dic) const
292  {
293    assert(svndigest::equal(str.begin(), str.end(),
294                            dic.first.begin(), dic.first.end()));
295    std::string res;
296    std::vector<std::string> vec;
297    regexp(str.begin(), str.end(), dic.first.begin(), dic.first.end(), vec);
298    for (std::string::const_iterator i(dic.second.begin()); 
299         i!=dic.second.end(); ++i) {
300      if (*i == '$') {
301        std::stringstream ss(std::string(i+1, dic.second.end()));
302        size_t n = 0;
303        ss >> n;
304        if (n>vec.size() || n==0){
305          std::stringstream mess;
306          mess << "svndigest: invalid config file: "
307               << "expression " << dic.second << " is invalid";
308          if (n)
309            mess << "because " << n << " is a too large.";
310          throw std::runtime_error("");       
311        }
312        res += vec[n-1];
313        ++i;
314        if (n>9){
315          ++i;
316          if (n>99)
317            ++i;
318
319        }
320      }
321      else
322        res += *i;
323    }
324
325    return res;
326  }
327
328
329  std::string trans_end_code(std::string str)
330  {
331    if (str.size()>0 && str[str.size()-1]=='\n')
332      return str.substr(0, str.size()-1) + std::string("\\n");
333    return str;
334  }
335
336
337  std::string trans_beg_code(std::string str)
338  {
339    if (str.size()>0 && str[0]=='\n')
340      return std::string("\\n") + str.substr(1); 
341    return str;
342  }
343
344
345  std::string trim(std::string str, char c)
346  {
347    if (str.size()<2 || str[0]!=c || str[str.size()-1]!=c){
348      std::stringstream mess;
349      mess << "expected `" << str << "' to be surrounded by `" << c << "'";
350      throw std::runtime_error(mess.str());
351    }
352    return str.substr(1, str.size()-2);
353  }
354
355
356  void Configuration::set_default(void)
357  {
358    copyright_alias_.clear();
359    missing_copyright_warning_=false;
360    trac_root_ = "";
361
362    add_codon("*.ac", "#", "\n");
363    add_codon("*.ac", "dnl", "\n");
364    add_codon("*.am", "#", "\n");
365    add_codon("*.m4", "#", "\n");
366    add_codon("*.m4", "dnl", "\n");
367    add_codon("*.c", "//", "\n");
368    add_codon("*.c", "/*", "*/");
369    add_codon("*.cc", "//", "\n");
370    add_codon("*.cc", "/*", "*/");
371    add_codon("*.cpp", "//", "\n");
372    add_codon("*.cpp", "/*", "*/");
373    add_codon("*.cxx", "//", "\n");
374    add_codon("*.cxx", "/*", "*/");
375    add_codon("*.h", "//", "\n");
376    add_codon("*.h", "/*", "*/");
377    add_codon("*.hh", "//", "\n");
378    add_codon("*.hh", "/*", "*/");
379    add_codon("*.hpp", "//", "\n");
380    add_codon("*.hpp", "/*", "*/");
381    add_codon("*.java", "//", "\n");
382    add_codon("*.java", "/*", "*/");
383    add_codon("*.pl", "#", "\n");
384    add_codon("*.pm", "#", "\n");
385    add_codon("*.sh", "#", "\n");
386    add_codon("*config", "#", "\n");
387    add_codon("bootstrap", "#", "\n");
388    add_codon("Makefile", "#", "\n");
389    add_codon("*.tex", "%", "\n");
390    add_codon("*.m", "%", "\n");
391    add_codon("*.jsp", "<!--", "-->");
392    add_codon("*.html", "<%--", "--%>");
393    add_codon("*.xml", "<!--", "-->");
394    add_codon("*.xsl", "<!--", "-->");
395    add_codon("*.xsd", "<!--", "-->");
396    add_codon("*.xhtml", "<!--", "-->");
397    add_codon("*.shtml", "<!--", "-->");
398    add_codon("*.xml", "<!--", "-->");
399    add_codon("*.css", "<!--", "-->");
400    add_codon("*.rss", "<!--", "-->");
401    add_codon("*.sgml", "<!--", "-->");
402    add_codon("*.bat", "\nREM", "\n");
403    add_codon("*.bat", "\nrem", "\n");
404
405    dictionary_ = VectorPair(1, std::make_pair("*.in", "$1"));
406  }
407
408
409  std::string Configuration::trac_root(void) const
410  {
411    return trac_root_;
412  }
413
414
415  void Configuration::validate_dictionary(void) const
416  {
417    VectorPair::const_iterator end(dictionary_.end());
418    for (VectorPair::const_iterator iter(dictionary_.begin());iter!=end;++iter){
419      std::string word(iter->first);
420      replace(word, "*", "");
421      replace(word, "?", "");
422      // throws if dictionary is invalid
423      translate(word, *iter);
424    }
425  }
426
427
428  std::ostream& operator<<(std::ostream& os, const Configuration& conf)
429  {
430    os << "### This file configures various behaviors for svndigest\n"
431       << "### The commented-out below are intended to demonstrate how to use\n"
432       << "### this file.\n"
433       << "\n"
434       << "### Section for setting behaviour of copyright update\n"
435       << "[copyright]\n"
436       << "# if true svndigest will warn if file has no copyright statement.\n"
437       << "missing-copyright-warning = ";
438   
439    if (conf.missing_copyright_warning())
440      os << "yes\n";
441    else
442      os << "no\n";
443
444    os << "\n"
445       << "### Section for setting aliases used in copyright update\n"
446       << "[copyright-alias]\n"
447       << "# jdoe = John Doe\n";
448
449    typedef std::vector<std::pair<std::string, Alias> > vector;
450    vector vec;
451    std::back_insert_iterator<vector> back_insert_iterator(vec);
452    vec.reserve(conf.copyright_alias().size());
453    std::copy(conf.copyright_alias().begin(), conf.copyright_alias().end(),
454              back_insert_iterator);
455    // sort with respect to Alias.id
456    IdCompare id;
457    PairSecondCompare<const std::string, Alias, IdCompare> comp(id);
458    std::sort(vec.begin(),vec.end(), comp);
459             
460
461    for (vector::const_iterator i(vec.begin()); i!=vec.end(); ++i) {
462      os << i->first << " = " << i->second.name() << " \n";
463    }
464
465    os << "\n"
466       << "### Section for setting trac environment\n"
467       << "[trac]\n"
468       << "# If trac-root is set, svndigest will create anchors to "
469       << "the Trac page.\n"
470       << "# trac-root = http://dev.thep.lu.se/svndigest/\n";
471    if (!conf.trac_root().empty())
472      os << "trac-root = " << conf.trac_root() << "\n";
473
474    if (!conf.dictionary_.empty()) {
475      os << "\n"
476         << "### Section for setting dictionary for file names.\n"
477         << "### Prior looking for file name pattern in section " 
478         << "[parsing-codons],\n"
479         << "### the file name may be translated according to the rules \n"
480         << "### in this section. In default setting there is, for example,\n"
481         << "### a rule to translate `<FILENAME>.in' to `<FILENAME>'.\n"
482         << "### The format of the entries is:\n"
483         << "###    file-name-pattern = new-name\n"
484         << "### Left hand side may contain wildcards (such as '*' and '?').\n"
485         << "### Right hand side may contain \"$i\", which will be replaced \n"
486         << "### with the ith wild card in lhs string.\n"
487         << "[file-name-dictionary]\n";
488      for (size_t i=0; i<conf.dictionary_.size(); ++i)
489        os << conf.dictionary_[i].first << " = " 
490           << conf.dictionary_[i].second << "\n"; 
491    }
492    if (!conf.string2codons_.empty()) {
493      os << "\n"
494         << "### Section for setting parsing modes\n"
495         << "### The format of the entries is:\n"
496         << "###   file-name-pattern = \"start-code\" : \"end-code\"\n"
497         << "### The file-name-pattern may contain wildcards (such as '*' "
498         << "and '?').\n"
499         << "### String \"\\n\" can be used for codons containing newline"
500         << "\n### character.\n"
501         << "[parsing-codons]\n";
502      for (size_t i=0; i<conf.string2codons_.size(); ++i) {
503        os << conf.string2codons_[i].first << " = "; 
504        for (size_t j=0; j<conf.string2codons_[i].second.size(); ++j) {
505          if (j)
506            os << "  ;  ";
507          os << "\"" << trans_beg_code(conf.string2codons_[i].second[j].first) 
508             << "\":\"" 
509             << trans_end_code(conf.string2codons_[i].second[j].second) 
510             << "\""; 
511        }
512        os << "\n";
513      }
514    }
515    return os;
516  }
517
518 
519  Config_error::Config_error(const std::string& line,const std::string& message)
520    : std::runtime_error(std::string("line: `") + line + 
521                         std::string("' is invalid.\n") + message)
522  {}
523
524}} // end of namespace svndigest and namespace theplu
Note: See TracBrowser for help on using the repository browser.