source: trunk/lib/Node.h @ 213

Last change on this file since 213 was 213, checked in by Peter Johansson, 15 years ago

fixes #41 and refs #87 added output for individual developers. Links should be added from the main page.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.7 KB
Line 
1#ifndef _theplu_svndigest_node_
2#define _theplu_svndigest_node_
3
4// $Id: Node.h 213 2006-09-15 15:05:45Z peter $
5
6/*
7  Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
8
9  This file is part of svndigest, http://lev.thep.lu.se/trac/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 "html_utility.h"
28#include "Stats.h"
29#include "SVNinfo.h"
30#include "utility.h"
31
32#include <ostream>
33#include <stdexcept>
34#include <string>
35
36namespace theplu{
37namespace svndigest{
38
39  ///
40  /// If something goes wrong in the use of the Node or its derived
41  /// classes, a NodeException is thrown.
42  ///
43  struct NodeException : public std::runtime_error
44  { inline NodeException(const std::string& msg) : runtime_error(msg) {} };
45
46  ///
47  /// Abstract Base Class for files.
48  ///
49  class Node
50  {
51  public:
52
53    ///
54    /// @brief Constructor
55    ///
56    Node(const u_int, const std::string&, const std::string&);
57
58    ///
59    /// @brief Destructor
60    ///
61    virtual inline ~Node(void) {};
62
63    ///
64    /// @brief Get the author of the latest commit.
65    ///
66    inline const std::string& author(void) const
67    { return svninfo_.last_changed_author(); }
68
69    /**
70       @brief Check whether node is binary.
71
72       @return True if node is binary.
73    */
74    inline bool binary(void) const { return binary_; }
75
76    ///
77    /// @return true if directory
78    ///
79    virtual bool dir(void) const;
80
81    ///
82    /// @return href to this node
83    ///
84    virtual std::string href(void) const=0;
85
86    void html_tablerow(std::ostream&, const std::string&, 
87                       const std::string& user) const;
88
89    /**
90       @brief Check whether node should be ignored in statistics.
91
92       If a node is to be ignored the statistics implementer should
93       respect this state. Currently binary files and items with
94       property svndigest:ignore are to be ignored by svndigest. If
95       the node is a directory then the direcotry and its siblings
96       should be ignored by statistics.
97
98       @return True of node should be ignored by statistics.
99
100       @see SVNproperty::svndigest_ingorable
101    */
102    inline bool ignore(void) const { return binary_ || svndigest_ignore_; }
103
104    ///
105    /// @brief Get the revision number of the latest commit.
106    ///
107    inline svn_revnum_t last_changed_rev(void) const
108    { return svninfo_.last_changed_rev(); }
109
110    ///
111    /// @return file or directory
112    ///
113    virtual const std::string node_type(void) const=0;
114
115    ///
116    /// @return
117    ///
118    inline const std::string& local_path(void) const { return local_path_; }
119
120    ///
121    /// Function returning everything after the last '/'
122    ///
123    /// @return name of node (not full path)
124    ///
125    inline std::string name(void) const { return file_name(path_); }
126
127    ///
128    /// @brief parsing file using svn blame.
129    ///
130    virtual const Stats& parse(const bool verbose=false)=0;
131
132    ///
133    /// @todo doc
134    ///
135    inline const std::string& path(void) const { return path_; }
136
137    ///
138    /// Function printing HTML in current working directory
139    ///
140    virtual void print(const bool verbose=false) const=0;
141
142    virtual void print_copyright(const std::vector<std::string>& dates) const=0;
143
144    /**
145       @brief Check if item used to create this object has been
146       assigned property svndigest:ignore.
147
148       Currently files with property svndigest:ignore are to be
149       ignored by svndigest. It is the responsibility of the
150       statistics implementer to obey the ignore state.
151
152       @return True if item property svndigest:ignore was set.
153    */
154    inline bool svndigest_ignore(void) const { return svndigest_ignore_; }
155
156  protected:
157
158    ///
159    /// print path in html format (with anchors) to @a os
160    ///
161    void path_anchor(std::ostream& os) const; 
162
163    u_int level_;
164    std::string local_path_; // path from root
165    std::string path_; // absolute path
166    static std::string project_;
167    Stats stats_;
168
169  private:
170    ///
171    /// @brief Copy Constructor, not implemented
172    ///
173    Node(const Node&);
174
175    bool binary_;
176    bool svndigest_ignore_;
177    SVNinfo svninfo_;
178  };
179
180  struct NodePtrLess
181  {
182    inline bool operator()(const Node* first, const Node* second) const
183    {   
184      if (first->dir()==second->dir())
185        return first->name()<second->name();
186      return first->dir();
187    }
188  };
189
190}} // end of namespace svndigest and namespace theplu
191
192#endif
Note: See TracBrowser for help on using the repository browser.