source: trunk/lib/Stats.h @ 487

#ifndef _theplu_svndigest_stats_
#define _theplu_svndigest_stats_

// $Id: Stats.h 487 2007-10-13 22:20:17Z peter $

/*
  Copyright (C) 2005 Peter Johansson
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson
  Copyright (C) 2007 Peter Johansson

  This file is part of svndigest, http://trac.thep.lu.se/trac/svndigest

  svndigest is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  svndigest is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "Parser.h"

#include <subversion-1/svn_types.h>

#include <map>
#include <istream>
#include <set>
#include <string>
#include <vector>

namespace theplu{
namespace svndigest{

  ///
  /// Class taking care of statistics from svn.
  ///
  class Stats
  {
  public:
    /// 
    /// @brief Default Constructor 
    ///
    explicit Stats(const std::string& path);

    /**
       \brief Destructor
    */
    virtual ~Stats(void);

    ///
    /// @return set of authors
    ///
    const std::set<std::string>& authors(void) const;

    ///
    /// 
    ///
    u_int code(const std::string& user="all") const; 


    ///
    /// 
    ///
    u_int comments(const std::string& user="all") const; 

    ///
    /// 
    ///
    u_int empty(const std::string& user="all") const; 

    ///
    ///
    ///
    svn_revnum_t last_changed_rev(void) const;

    ///
    /// 
    ///
    u_int lines(const std::string& user="all") const; 

    /**
       Load object from a stream.
       
       \return true if successful
     */
    bool load_cache(std::istream&);

    /**
       Do the parsing
    */
    void parse(const std::string&);

    ///
    /// Create statistics graph.
    ///
    std::string plot(const std::string&, const std::string&) const;

    ///
    /// Plotting code, comment, other, and total in same plot (for
    /// 'all' not individual authors).
    ///
    void plot_summary(const std::string& output) const;

    /**
       Send Stats to a stream.
     */
    void print(std::ostream&) const;

    ///
    /// @brief Clear all statistics
    ///
    void reset(void); 

    ///
    /// \return latest revision for whole project
    ///
    svn_revnum_t revision(void) const { return revision_; }

  protected:
    inline std::string code_cache(void) const {return "CACHE CODE";} 
    inline std::string comments_cache(void) const {return "CACHE COMMENTS";} 
    inline std::string empty_cache(void) const {return "CACHE EMPTY";} 
    inline std::string total_cache(void) const {return "CACHE TOTAL";} 

    typedef std::map<std::string, std::vector<u_int> > v_map;

    void add_author(std::string);
    void add_authors(std::set<std::string>::const_iterator, 
                     std::set<std::string>::const_iterator);

    /**
       Function to be called from children's operator+=
     */
    void base_add(const Stats&);

    /**
       add range [\a first, \a last) to \a map
     */
    void base_add(v_map::const_iterator first, v_map::const_iterator last,
                  v_map& map);

    ///
    /// Init statistics graph.
    ///
    void plot_init(const std::string& output) const;
    inline bool valid(void) const {return valid_;}
  private:
    virtual bool do_load_cache(std::istream&)=0;
    virtual void do_parse(const std::string&)=0;
    virtual std::string do_plot(const std::string&, const std::string&) const=0;
    virtual void do_print(std::ostream& ) const=0;
    virtual void do_reset(void)=0;
    
    const std::vector<u_int>& get_vector(const v_map&, std::string user) const;
    virtual std::vector<u_int> vector(std::string type, 
                                      std::string user) const=0;
    void update_stats(void);

    v_map total_;
    v_map code_;
    v_map comments_;
    v_map other_;
    bool valid_;
    svn_revnum_t revision_; // Should be the latest revision for whole project
    svn_revnum_t last_changed_rev_; // Should be the latest revision for file

    std::set<std::string> authors_;
  };
}} // end of namespace svndigest end of namespace theplu

#endif