source: trunk/lib/File.h @ 1267

Last change on this file since 1267 was 1267, checked in by Peter Johansson, 11 years ago

updating copyright statements

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.6 KB
Line 
1#ifndef _theplu_svndigest_file_
2#define _theplu_svndigest_file_
3
4// $Id: File.h 1267 2010-11-02 03:56:19Z peter $
5
6/*
7  Copyright (C) 2005, 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
8  Copyright (C) 2009, 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 "Node.h"
27
28#include <map>
29#include <string>
30
31namespace theplu{
32namespace svndigest{
33
34  class NodeVisitor;
35
36  class File : public Node
37  {
38  public:
39    ///
40    /// @brief Default Constructor
41    ///
42    File(const unsigned int level, const std::string& path, 
43         const std::string& output=""); 
44
45    /**
46       For example 'File.h.html'
47
48       @return href to this file
49    */
50    std::string href(void) const;
51
52    /**
53       \brief Get the revision number of the latest commit.
54    */
55    svn_revnum_t last_changed_rev(void) const;
56
57    /**
58       @return The explicit string "file", nothing else.
59    */
60    std::string node_type(void) const;
61
62    /**
63       @return output path for example 'lib/File.h.html' for this file
64     */
65    std::string output_path(void) const;
66
67    ///
68    /// @brief Parsing out information from svn repository
69    ///
70    /// @return Stats object of the file
71    ///
72    const StatsCollection& parse(bool verbose, bool ignore);
73
74    /**
75       Let the visitor perform its mission via visitor(*this)
76     */
77    void traverse(NodeVisitor& visitor);
78
79  private:
80    std::string blame_output_file_name(void) const;
81
82    /**
83       do nothing
84    */
85    void log_core(SVNlog&) const;
86
87    ///
88    /// @brief Copy Constructor, not implemented
89    ///
90    File(const File&);
91
92    ///
93    /// @brief Parsing svn blame output
94    ///
95    /// @return true if parsing is succesful
96    ///
97    bool blame(void) const;
98
99    /**
100       @brief Print blame output
101    */
102    void print_blame(std::ofstream& os) const;
103
104    void print_core(bool verbose=false) const;
105
106    ///
107    /// print page for specific user (or all) and specific line_style
108    /// (or total).
109    ///
110    void print_core(const std::string& stats_type, const std::string& user, 
111                    const std::string& line_type, const SVNlog&) const; 
112
113  };
114
115}} // end of namespace svndigest and namespace theplu
116
117#endif
118
119
Note: See TracBrowser for help on using the repository browser.