source: trunk/lib/File.h @ 654

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

Hopefully fixes #328 - need to be tested though

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.5 KB
Line 
1#ifndef _theplu_svndigest_file_
2#define _theplu_svndigest_file_
3
4// $Id: File.h 654 2008-06-08 04:58:38Z peter $
5
6/*
7  Copyright (C) 2005, 2006, 2007 Jari Häkkinen, Peter Johansson
8
9  This file is part of svndigest, http://trac.thep.lu.se/svndigest
10
11  svndigest is free software; you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation; either version 2 of the License, or
14  (at your option) any later version.
15
16  svndigest is distributed in the hope that it will be useful, but
17  WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24  02111-1307, USA.
25*/
26
27#include "Node.h"
28
29#include <map>
30#include <string>
31
32namespace theplu{
33namespace svndigest{
34
35  class File : public Node
36  {
37  public:
38    ///
39    /// @brief Default Constructor
40    ///
41    File(const unsigned int level, const std::string& path, 
42         const std::string& output=""); 
43
44    /**
45       For example 'File.h.html'
46
47       @return href to this file
48    */
49    std::string href(void) const;
50
51    /**
52       @return The explicit string "file", nothing else.
53    */
54    std::string node_type(void) const;
55
56    /**
57       @return output path for example 'lib/File.h.html' for this file
58     */
59    std::string output_path(void) const;
60
61    ///
62    /// @brief Parsing out information from svn repository
63    ///
64    /// @return Stats object of the file
65    ///
66    const StatsCollection& parse(bool verbose, bool ignore);
67
68    using Node::print_copyright;
69    /**
70       @throw std::runtime_error when a file error is encountered
71       updating the copyrights.
72    */
73    void print_copyright(std::map<std::string, Alias>&, bool verbose,
74                         const std::map<int, svn_revnum_t>&) const;
75
76  private:
77    /**
78       @return log of this File.
79    */
80    SVNlog log_core(void) const;
81
82    ///
83    /// @brief Copy Constructor, not implemented
84    ///
85    File(const File&);
86
87    ///
88    /// @brief Parsing svn blame output
89    ///
90    /// @return true if parsing is succesful
91    ///
92    bool blame(void) const;
93
94    /**
95       \return copyright block
96     */
97    std::string copyright_block(const std::map<int, std::set<Alias> >& map,
98                                const std::string& prefix) const;
99
100    /**
101       Create a map from year to set of authors.
102     */
103    std::map<int, std::set<Alias> > 
104    copyright_map(std::map<std::string, Alias>& alias,
105                  const std::map<int, svn_revnum_t>&) const;
106
107    /**
108       Create a map from year to set of authors.
109
110       \return true if Copyright block is found
111     */
112    bool detect_copyright(std::string& block, size_t& start_at_line,
113                          size_t& end_at_line, std::string& prefix) const;
114
115    /**
116       @brief Print blame output
117    */
118    void print_blame(std::ofstream& os) const;
119
120    void print_core(bool verbose=false) const;
121
122    ///
123    /// print page for specific user (or all) and specific line_style
124    /// (or total).
125    ///
126    void print_core(const std::string& stats_type, const std::string& user, 
127                    const std::string& line_type, const SVNlog&) const; 
128
129    /**
130       Doing the actual print of copyright statement
131
132       \param block new copyright block
133       \param start_at_line line number of first line in old block
134       \param end_at_line line number of first line after old block
135     */
136    void update_copyright(const std::string& block,
137                          size_t start_at_line, size_t end_at_line) const;
138  };
139
140}} // end of namespace svndigest and namespace theplu
141
142#endif
143
144
Note: See TracBrowser for help on using the repository browser.