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
RevLine 
[165]1#ifndef _theplu_svndigest_node_
2#define _theplu_svndigest_node_
3
[7]4// $Id: Node.h 447 2007-08-16 16:22:07Z peter $
[4]5
[84]6/*
[380]7  Copyright (C) 2005, 2006, 2007 Jari Häkkinen, Peter Johansson
[84]8
[439]9  This file is part of svndigest, http://trac.thep.lu.se/trac/svndigest
[84]10
[149]11  svndigest is free software; you can redistribute it and/or modify it
[84]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
[149]16  svndigest is distributed in the hope that it will be useful, but
[84]17  WITHOUT ANY WARRANTY; without even the implied warranty of
[149]18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
[84]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
[177]27#include "html_utility.h"
[14]28#include "Stats.h"
[129]29#include "SVNinfo.h"
[285]30#include "SVNlog.h"
[100]31#include "utility.h"
[14]32
[226]33#include <map>
[29]34#include <ostream>
[91]35#include <stdexcept>
[4]36#include <string>
37
38namespace theplu{
[149]39namespace svndigest{
[4]40
[303]41  class Alias;
42
[91]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
[4]50  ///
51  /// Abstract Base Class for files.
52  ///
53  class Node
54  {
55  public:
[91]56
[4]57    ///
58    /// @brief Constructor
59    ///
[112]60    Node(const u_int, const std::string&, const std::string&);
[91]61
[9]62    ///
63    /// @brief Destructor
64    ///
65    virtual inline ~Node(void) {};
[4]66
[74]67    ///
[129]68    /// @brief Get the author of the latest commit.
[112]69    ///
[142]70    inline const std::string& author(void) const
71    { return svninfo_.last_changed_author(); }
[112]72
[185]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
[112]80    ///
[101]81    /// @return true if directory
82    ///
83    virtual bool dir(void) const;
84
85    ///
[175]86    /// @return href to this node
[74]87    ///
[175]88    virtual std::string href(void) const=0;
[74]89
[213]90    void html_tablerow(std::ostream&, const std::string&, 
91                       const std::string& user) const;
[74]92
[185]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    */
[361]106    inline bool ignore(void) const 
107    { return binary_ || svndigest_ignore_ || link_; }
[185]108
[100]109    ///
[129]110    /// @brief Get the revision number of the latest commit.
[112]111    ///
[142]112    inline svn_revnum_t last_changed_rev(void) const
[129]113    { return svninfo_.last_changed_rev(); }
[112]114
[380]115    /**
[447]116       @return log of this node in a recursive manner.
117    */
118    virtual SVNlog log(void) const=0;
119
120    /**
[380]121       @return The explicit string identifying the underlying derived
122       class.
123    */
[343]124    virtual std::string node_type(void) const=0;
[182]125
126    ///
[100]127    /// @return
128    ///
[201]129    inline const std::string& local_path(void) const { return local_path_; }
[60]130
[129]131    ///
[201]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
[343]138    /**
[356]139       Note that returned string always end with '/' with the
140       exception when an empty string is returned.
141
[343]142       @return output dir for example 'lib' for this file
143     */
144    std::string output_dir(void) const;
145
146    /**
[356]147       @return output path for example 'lib/Node.h.html' for this file
[343]148     */
149    virtual std::string output_path(void) const=0;
150
[201]151    ///
[129]152    /// @brief parsing file using svn blame.
153    ///
154    virtual const Stats& parse(const bool verbose=false)=0;
[4]155
[176]156    ///
157    /// @todo doc
158    ///
[91]159    inline const std::string& path(void) const { return path_; }
160
[10]161    ///
[58]162    /// Function printing HTML in current working directory
[10]163    ///
[258]164    void print(const bool verbose=false) const;
[4]165
[258]166    void print_author_summary(std::ostream&, std::string, const SVNlog&) const; 
[234]167
[425]168    virtual void print_copyright(std::map<std::string,Alias>&, bool) const=0;
[198]169
[185]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
[203]178       @return True if item property svndigest:ignore was set.
[185]179    */
180    inline bool svndigest_ignore(void) const { return svndigest_ignore_; }
181
[330]182    /**
183       \see SVNinfo::url(void)
184    */
185    std::string url(void) const;
186   
[129]187  protected:
[112]188
[23]189    ///
[199]190    /// print path in html format (with anchors) to @a os
191    ///
192    void path_anchor(std::ostream& os) const; 
193
[112]194    u_int level_;
[201]195    std::string local_path_; // path from root
[343]196    std::string output_dir_;
[203]197    std::string path_; // absolute path
[207]198    static std::string project_;
[129]199    Stats stats_;
[4]200
[9]201  private:
202    ///
203    /// @brief Copy Constructor, not implemented
204    ///
205    Node(const Node&);
[29]206
[258]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
[185]217    bool binary_;
[361]218    bool link_;
[185]219    bool svndigest_ignore_;
[129]220    SVNinfo svninfo_;
[9]221  };
[4]222
[330]223  /**
224     \brief Functor class to compare pointers of Nodes
225  */
[101]226  struct NodePtrLess
227  {
[330]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     */
[101]233    inline bool operator()(const Node* first, const Node* second) const
234    {   
235      if (first->dir()==second->dir())
[201]236        return first->name()<second->name();
[101]237      return first->dir();
238    }
239  };
240
[149]241}} // end of namespace svndigest and namespace theplu
[4]242
[7]243#endif
Note: See TracBrowser for help on using the repository browser.