source: trunk/lib/File.h @ 330

Last change on this file since 330 was 330, checked in by Peter Johansson, 14 years ago

Using internal SVNinfo in tree rather than creating a new object.
Also added some docs.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.2 KB
Line 
1#ifndef _theplu_svndigest_file_
2#define _theplu_svndigest_file_
3
4// $Id: File.h 330 2007-05-18 15:16:02Z peter $
5
6/*
7  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
8  Copyright (C) 2007 Peter Johansson
9
10  This file is part of svndigest, http://lev.thep.lu.se/trac/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 2 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 this program; if not, write to the Free Software
24  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25  02111-1307, USA.
26*/
27
28#include "Node.h"
29
30#include <map>
31#include <string>
32
33namespace theplu{
34namespace svndigest{
35
36  class File : public Node
37  {
38  public:
39    ///
40    /// @brief Default Constructor
41    ///
42    File(const u_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    /// @return file
54    ///
55    const std::string node_type(void) const;
56
57    ///
58    /// @brief Parsing out information from svn repository
59    ///
60    /// @return Stats object of the file
61    ///
62    const Stats& parse(const bool verbose=false);
63
64    ///
65    /// print blame output
66    ///
67    void print_blame(std::ofstream&, const std::string line_type) const;
68
69    void print_copyright(std::map<std::string, Alias>&) const;
70
71  private:
72
73    ///
74    /// @brief Parsing svn blame output
75    ///
76    /// @return true if parsing is succesful
77    ///
78    bool blame(void) const;
79
80    ///
81    /// @brief Copy Constructor, not implemented
82    ///
83    File(const File&);
84
85    void print_core(bool verbose=false) const;
86
87    ///
88    /// print page for specific user (or all) and specific line_style
89    /// (or total).
90    ///
91    void print_core(const std::string& user, const std::string& line_type,
92                    const SVNlog&) const; 
93
94  };
95
96}} // end of namespace svndigest and namespace theplu
97
98#endif
99
100
Note: See TracBrowser for help on using the repository browser.