source: trunk/lib/Stats.h @ 701

Last change on this file since 701 was 701, checked in by Peter Johansson, 13 years ago

Some docs

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 6.5 KB
Line 
1#ifndef _theplu_svndigest_stats_
2#define _theplu_svndigest_stats_
3
4// $Id: Stats.h 701 2008-11-23 21:40:57Z peter $
5
6/*
7  Copyright (C) 2005 Peter Johansson
8  Copyright (C) 2006 Jari Häkkinen, Peter Johansson
9  Copyright (C) 2007 Peter Johansson
10
11  This file is part of svndigest, http://dev.thep.lu.se/svndigest
12
13  svndigest is free software; you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation; either version 3 of the License, or
16  (at your option) any later version.
17
18  svndigest is distributed in the hope that it will be useful, but
19  WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  General Public License for more details.
22
23  You should have received a copy of the GNU General Public License
24  along with svndigest. If not, see <http://www.gnu.org/licenses/>.
25*/
26
27#include "LineTypeParser.h"
28
29#include <subversion-1/svn_types.h>
30
31#include <map>
32#include <istream>
33#include <set>
34#include <string>
35#include <vector>
36
37namespace theplu{
38namespace svndigest{
39
40  ///
41  /// Class taking care of statistics from svn.
42  ///
43  class Stats
44  {
45  public:
46    ///
47    /// @brief Default Constructor
48    ///
49    explicit Stats(const std::string& path);
50
51    /**
52       \brief Destructor
53    */
54    virtual ~Stats(void);
55
56    ///
57    /// @brief adding \a n line(s) to \a user from \a revision to the stats
58    ///
59    void add(const std::string& user, const unsigned int& revision,
60             const LineTypeParser::line_type&, unsigned int n=1); 
61
62    ///
63    /// @return set of authors
64    ///
65    const std::set<std::string>& authors(void) const;
66
67    ///
68    /// \return number of code lines for \a user for latest revision.
69    ///
70    unsigned int code(const std::string& user="all") const; 
71
72
73    ///
74    /// \return number of comments lines for \a user for latest revision.
75    ///
76    unsigned int comments(const std::string& user="all") const; 
77
78    ///
79    /// \return number of empty lines for \a user for latest revision.
80    ///
81    unsigned int empty(const std::string& user="all") const; 
82
83    ///
84    /// \return revison node was modified
85    ///
86    svn_revnum_t last_changed_rev(void) const;
87
88    ///
89    /// \return number of lines for \a user for latest revision
90    ///
91    unsigned int lines(const std::string& user="all") const; 
92
93    /**
94       Load object from a stream.
95       
96       \return revision the cache represents - 0 if failed
97     */
98    svn_revnum_t load_cache(std::istream&);
99
100    /**
101       Do the parsing for \a path. The function will only parse out
102       stats for revisions larger than \a rev.
103    */
104    void parse(const std::string& path, svn_revnum_t rev=0);
105
106    ///
107    /// Create statistics graph.
108    ///
109    std::string plot(const std::string&, const std::string&) const;
110
111    ///
112    /// Plotting code, comment, other, and total in same plot (for
113    /// 'all' not individual authors).
114    ///
115    void plot_summary(const std::string& output) const;
116
117    /**
118       Send Stats to a stream.
119     */
120    void print(std::ostream&) const;
121
122    ///
123    /// @brief Clear all statistics
124    ///
125    void reset(void); 
126
127    ///
128    /// \return latest revision for whole project
129    ///
130    svn_revnum_t revision(void) const { return revision_; }
131
132    /**
133       \return resulting Stats
134    */
135    Stats& operator+=(const Stats&);
136
137    /**
138       \return number of lines for \a author and \a linetype from
139       revision \a rev.
140
141       \throw if \a author does not exist
142     */
143    size_t operator()(int linetype, std::string author, svn_revnum_t rev) const;
144
145  protected:
146    typedef std::map<std::string, std::vector<unsigned int> > Author2Vector;
147    typedef Author2Vector::iterator A2VIter;
148    typedef Author2Vector::const_iterator A2VConstIter;
149
150    void accumulate_stats(svn_revnum_t rev=0);
151    void add_author(std::string);
152    void add_authors(std::set<std::string>::const_iterator, 
153                     std::set<std::string>::const_iterator);
154
155    // references to data
156    inline Author2Vector& code_stats(void) 
157    { return stats_[LineTypeParser::code]; }
158    inline Author2Vector& comment_stats(void) 
159    { return stats_[LineTypeParser::comment]; }
160    inline Author2Vector& copyright_stats(void) 
161    { return stats_[LineTypeParser::copyright]; }
162    inline Author2Vector& other_stats(void) 
163    { return stats_[LineTypeParser::other]; }
164    inline Author2Vector& comment_or_copy_stats(void) 
165    { return stats_[LineTypeParser::comment_or_copy]; }
166    inline Author2Vector& total_stats(void) 
167    { return stats_[LineTypeParser::total]; }
168
169    // const references to data
170    inline const Author2Vector& code_stats(void) const
171    { return stats_[LineTypeParser::code]; }
172    inline const Author2Vector& comment_stats(void) const
173    { return stats_[LineTypeParser::comment]; }
174    inline const Author2Vector& copyright_stats(void) const
175    { return stats_[LineTypeParser::copyright]; }
176    inline const Author2Vector& other_stats(void) const
177    { return stats_[LineTypeParser::other]; }
178    inline const Author2Vector& comment_or_copy_stats(void) const
179    { return stats_[LineTypeParser::comment_or_copy]; }
180    inline const Author2Vector& total_stats(void) const
181    { return stats_[LineTypeParser::total]; }
182
183    /**
184       add range [\a first, \a last) to \a map
185     */
186    void map_add(Author2Vector::const_iterator first, 
187                 Author2Vector::const_iterator last,
188                 Author2Vector& map);
189
190    ///
191    /// Init statistics graph.
192    ///
193    void plot_init(const std::string& output) const;
194
195    std::set<std::string> authors_;
196
197    const std::vector<unsigned int>& get_vector(const Author2Vector&, 
198                                         std::string user) const;
199  private:
200    void accumulate(std::vector<unsigned int>& vec,
201                    svn_revnum_t rev=0) const;
202    void add(std::vector<unsigned int>& vec, unsigned int rev, bool x,
203             unsigned int n);
204
205    virtual void do_parse(const std::string&, svn_revnum_t)=0;
206   
207    // Change this string if cache format is changed in such a way
208    // that all old cache files are obsolete.
209    inline std::string cache_check_str(void) const 
210    {return "CACHE FILE VERSION 6";} 
211
212    void calc_all(void);
213    void calc_comment_or_copy(void);
214    void calc_total(void);
215    unsigned int get_back(const Author2Vector&, std::string user) const;
216    void load(std::istream& is, Author2Vector& m);
217    void print(std::ostream& os, const Author2Vector& m) const;
218
219    svn_revnum_t revision_; // Should be the latest revision for whole project
220    svn_revnum_t last_changed_rev_; // Should be the latest revision for file
221
222    std::vector<Author2Vector> stats_; // from linetype to a2v
223
224    // using compiler generated copy constructor
225    //Stats(const Stats&);
226    // no assignment
227    Stats& operator=(const Stats&);
228
229  };
230}} // end of namespace svndigest end of namespace theplu
231
232#endif
Note: See TracBrowser for help on using the repository browser.