source: branches/visitor/lib/Directory.h @ 1224

Last change on this file since 1224 was 1224, checked in by Peter Johansson, 12 years ago

refs #476. Functions in Node structure that interacts with visitors.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.2 KB
Line 
1#ifndef _theplu_svndigest_directory_
2#define _theplu_svndigest_directory_
3
4// $Id: Directory.h 1224 2010-10-17 16:23:14Z peter $
5
6/*
7  Copyright (C) 2005, 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
8  Copyright (C) 2009 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#include <vector>
31
32namespace theplu{
33namespace svndigest{
34
35  class NodeVisitor;
36
37  ///
38  /// Class taking care of directories.
39  ///
40  class Directory : public Node
41  {
42  public:
43
44    ///
45    /// @brief Constructor
46    ///
47    /// Recursively create a directory tree starting from \a path. All
48    /// entries except explicit directories are treated as File nodes,
49    /// i.e. symbolic links to directories are treated as File
50    /// nodes. This will ensure that the directory structure is a tree
51    /// and double counting of branches is avoided.
52    ///
53    /// @note Nodes named '.', '..', and '.svn' are ignored and not
54    /// traversed.
55    ///
56    Directory(const unsigned int level, const std::string& path, 
57              const std::string& output="");
58
59    ///
60    /// @brief Destructor
61    ///
62    ~Directory(void);
63
64    ///
65    /// @return true
66    ///
67    bool dir(void) const;
68
69    ///
70    /// @return directory-name/index.html
71    ///
72    std::string href(void) const;
73
74    /**
75       \brief Get the revision number of the latest commit.
76
77       Does not only check this directory but also daughter nodes.
78    */
79    svn_revnum_t last_changed_rev(void) const;
80
81    /**
82       @return The explicit string "directory", nothing else.
83    */
84    std::string node_type(void) const;
85
86    /**
87       @return output path for example 'lib/File.h.html' for this file
88     */
89    std::string output_path(void) const;
90
91    const StatsCollection& parse(bool verbose, bool ignore);
92
93    using Node::print_copyright;
94    /**
95       virtual function typically called from Node::print_copyright
96    */
97    void print_copyright(std::map<std::string, Alias>&, bool verbose,
98                         const std::map<int, svn_revnum_t>&) const;
99
100    /**
101       Calls visitor.enter(*this), traverses daughter nodes, and calls
102       visitor.leave(*this).
103     */
104    void traverse(NodeVisitor& visitor);
105
106  private:
107    /**
108       add union of logs from daughter nodes.
109    */
110    void log_core(SVNlog&) const;
111
112    ///
113    /// @brief Copy Constructor, not implemented
114    ///
115    Directory(const Directory&);
116
117    void print_core(bool verbose=false) const;
118
119    void print_core(const std::string& stats_type, const std::string& user, 
120                    const std::string& line_type, const SVNlog&) const;
121
122
123    typedef std::vector<Node*> NodeContainer;
124    typedef NodeContainer::iterator NodeIterator;
125    typedef NodeContainer::const_iterator NodeConstIterator;
126    NodeContainer daughters_;
127  };
128
129}} // end of namespace svndigest and namespace theplu
130
131#endif
Note: See TracBrowser for help on using the repository browser.