source: branches/0.8-stable/lib/Directory.h @ 1199

Last change on this file since 1199 was 978, checked in by Peter Johansson, 11 years ago

refs #429. Convert copyright statements to UTF-8

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