source: trunk/lib/Node.h @ 447

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

refs #185

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 5.9 KB
Line 
1#ifndef _theplu_svndigest_node_
2#define _theplu_svndigest_node_
3
4// $Id: Node.h 447 2007-08-16 16:22:07Z 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/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 "SVNlog.h"
31#include "utility.h"
32
33#include <map>
34#include <ostream>
35#include <stdexcept>
36#include <string>
37
38namespace theplu{
39namespace svndigest{
40
41  class Alias;
42
43  ///
44  /// If something goes wrong in the use of the Node or its derived
45  /// classes, a NodeException is thrown.
46  ///
47  struct NodeException : public std::runtime_error
48  { inline NodeException(const std::string& msg) : runtime_error(msg) {} };
49
50  ///
51  /// Abstract Base Class for files.
52  ///
53  class Node
54  {
55  public:
56
57    ///
58    /// @brief Constructor
59    ///
60    Node(const u_int, const std::string&, const std::string&);
61
62    ///
63    /// @brief Destructor
64    ///
65    virtual inline ~Node(void) {};
66
67    ///
68    /// @brief Get the author of the latest commit.
69    ///
70    inline const std::string& author(void) const
71    { return svninfo_.last_changed_author(); }
72
73    /**
74       @brief Check whether node is binary.
75
76       @return True if node is binary.
77    */
78    inline bool binary(void) const { return binary_; }
79
80    ///
81    /// @return true if directory
82    ///
83    virtual bool dir(void) const;
84
85    ///
86    /// @return href to this node
87    ///
88    virtual std::string href(void) const=0;
89
90    void html_tablerow(std::ostream&, const std::string&, 
91                       const std::string& user) const;
92
93    /**
94       @brief Check whether node should be ignored in statistics.
95
96       If a node is to be ignored the statistics implementer should
97       respect this state. Currently binary files and items with
98       property svndigest:ignore are to be ignored by svndigest. If
99       the node is a directory then the direcotry and its siblings
100       should be ignored by statistics.
101
102       @return True of node should be ignored by statistics.
103
104       @see SVNproperty::svndigest_ingorable
105    */
106    inline bool ignore(void) const 
107    { return binary_ || svndigest_ignore_ || link_; }
108
109    ///
110    /// @brief Get the revision number of the latest commit.
111    ///
112    inline svn_revnum_t last_changed_rev(void) const
113    { return svninfo_.last_changed_rev(); }
114
115    /**
116       @return log of this node in a recursive manner.
117    */
118    virtual SVNlog log(void) const=0;
119
120    /**
121       @return The explicit string identifying the underlying derived
122       class.
123    */
124    virtual std::string node_type(void) const=0;
125
126    ///
127    /// @return
128    ///
129    inline const std::string& local_path(void) const { return local_path_; }
130
131    ///
132    /// Function returning everything after the last '/'
133    ///
134    /// @return name of node (not full path)
135    ///
136    inline std::string name(void) const { return file_name(path_); }
137
138    /**
139       Note that returned string always end with '/' with the
140       exception when an empty string is returned.
141
142       @return output dir for example 'lib' for this file
143     */
144    std::string output_dir(void) const;
145
146    /**
147       @return output path for example 'lib/Node.h.html' for this file
148     */
149    virtual std::string output_path(void) const=0;
150
151    ///
152    /// @brief parsing file using svn blame.
153    ///
154    virtual const Stats& parse(const bool verbose=false)=0;
155
156    ///
157    /// @todo doc
158    ///
159    inline const std::string& path(void) const { return path_; }
160
161    ///
162    /// Function printing HTML in current working directory
163    ///
164    void print(const bool verbose=false) const;
165
166    void print_author_summary(std::ostream&, std::string, const SVNlog&) const; 
167
168    virtual void print_copyright(std::map<std::string,Alias>&, bool) const=0;
169
170    /**
171       @brief Check if item used to create this object has been
172       assigned property svndigest:ignore.
173
174       Currently files with property svndigest:ignore are to be
175       ignored by svndigest. It is the responsibility of the
176       statistics implementer to obey the ignore state.
177
178       @return True if item property svndigest:ignore was set.
179    */
180    inline bool svndigest_ignore(void) const { return svndigest_ignore_; }
181
182    /**
183       \see SVNinfo::url(void)
184    */
185    std::string url(void) const;
186   
187  protected:
188
189    ///
190    /// print path in html format (with anchors) to @a os
191    ///
192    void path_anchor(std::ostream& os) const; 
193
194    u_int level_;
195    std::string local_path_; // path from root
196    std::string output_dir_;
197    std::string path_; // absolute path
198    static std::string project_;
199    Stats stats_;
200
201  private:
202    ///
203    /// @brief Copy Constructor, not implemented
204    ///
205    Node(const Node&);
206
207    virtual void print_core(bool verbose=false) const=0;
208
209    ///
210    /// print page for specific user (or all) and specific line_style
211    /// (or total).
212    ///
213    virtual void print_core(const std::string& user, 
214                            const std::string& line_type,
215                            const SVNlog&) const=0; 
216
217    bool binary_;
218    bool link_;
219    bool svndigest_ignore_;
220    SVNinfo svninfo_;
221  };
222
223  /**
224     \brief Functor class to compare pointers of Nodes
225  */
226  struct NodePtrLess
227  {
228    /**
229       @return true if first and second are of same type (Directory or
230       File) and name of first is (alphabetically) less than name of
231       second; or if first is a Directory and second is a File.
232     */
233    inline bool operator()(const Node* first, const Node* second) const
234    {   
235      if (first->dir()==second->dir())
236        return first->name()<second->name();
237      return first->dir();
238    }
239  };
240
241}} // end of namespace svndigest and namespace theplu
242
243#endif
Note: See TracBrowser for help on using the repository browser.