source: trunk/lib/Configuration.cc @ 1003

Last change on this file since 1003 was 1003, checked in by Peter Johansson, 13 years ago

merging release 0.7.2. Delta 0.7.2 - 0.7.1

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