source: trunk/lib/Node.h @ 1236

#ifndef _theplu_svndigest_node_
#define _theplu_svndigest_node_

// $Id: Node.h 1236 2010-10-23 21:30:17Z peter $

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

  This file is part of svndigest, http://dev.thep.lu.se/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 3 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 svndigest. If not, see <http://www.gnu.org/licenses/>.
*/

#include "html_utility.h"
#include "LineTypeParser.h"
#include "StatsCollection.h"
#include "SVNinfo.h"
#include "SVNlog.h"
#include "TinyStats.h"
#include "utility.h"

#include <map>
#include <ostream>
#include <stdexcept>
#include <string>

namespace theplu{
namespace svndigest{

  class Alias;
  class NodeVisitor;

  ///
  /// If something goes wrong in the use of the Node or its derived
  /// classes, a NodeException is thrown.
  ///
  struct NodeException : public std::runtime_error
  { inline NodeException(const std::string& msg) : runtime_error(msg) {} };

  ///
  /// Abstract Base Class for files.
  ///
  class Node
  {
  public:

    /// 
    /// @brief Constructor 
    /// 
    Node(const unsigned int, const std::string&, const std::string&);

    ///
    /// @brief Destructor
    ///
    virtual ~Node(void);

    ///
    /// @brief Get the author of the latest commit.
    ///
    std::string author(void) const;


    /**
       @brief Check whether node is binary.

       @return True if node is binary.
    */
    inline bool binary(void) const { return binary_; }

    ///
    /// @return true if directory
    ///
    virtual bool dir(void) const;

    ///
    /// @return href to this node
    ///
    virtual std::string href(void) const=0;

    void html_tablerow(std::ostream&, const std::string&, 
                       const std::string& css, 
                       const std::string& user) const;

    /**
       @brief Check whether node should be ignored in statistics.

       If a node is to be ignored the statistics implementer should
       respect this state. Currently binary files and items with
       property svndigest:ignore are to be ignored by svndigest. If
       the node is a directory then the direcotry and its siblings
       should be ignored by statistics.

       @return True of node should be ignored by statistics.

       @see SVNproperty::svndigest_ingorable
    */
    inline bool ignore(void) const 
    { return binary_ || svndigest_ignore_ || link_; }

    /**
       Create the TinyStats based on the stored CollectionStats
     */
    void init_tiny_stats(void);

    ///
    /// @brief Get the revision number of the latest commit.
    ///
    virtual svn_revnum_t last_changed_rev(void) const=0;

    /**
       @return log of this node in a recursive manner.
    */
    const SVNlog& log(void) const;

    /**
       @return The explicit string identifying the underlying derived
       class.
    */
    virtual std::string node_type(void) const=0;

    ///
    /// @return 
    ///
    inline const std::string& local_path(void) const { return local_path_; }

    ///
    /// Function returning everything after the last '/'
    ///
    /// @return name of node (not full path)
    ///
    std::string name(void) const;

    /**
       Note that returned string always end with '/' with the
       exception when an empty string is returned.

       @return output dir for example 'lib/' for this file
     */
    std::string output_dir(void) const;

    /**
       @return output path for example 'lib/Node.h.html' for this file
     */
    virtual std::string output_path(void) const=0;

    ///
    /// @todo doc
    /// 
    inline const std::string& path(void) const { return path_; }

    ///
    /// Function printing HTML in current working directory
    ///
    void print(const bool verbose=false) const;

    void print_author_summary(std::ostream&, 
                              const Stats& stats, 
                              const std::string& line_type, 
                              const SVNlog&) const; 

    /**
       creates a map from year to last rev for that year and call
       virtual function.
     */
    void print_copyright(std::map<std::string,Alias>&, bool) const;

    /**
       typically called from function above 
     */
    virtual void print_copyright(std::map<std::string,Alias>&, bool,
                                 const std::map<int,svn_revnum_t>&) const=0;

    /**
       \return true if svncopyright::ignore property was set
     */
    bool svncopyright_ignore(void) const;

    /**
       @brief Check if item used to create this object has been
       assigned property svndigest:ignore.

       Currently files with property svndigest:ignore are to be
       ignored by svndigest. It is the responsibility of the
       statistics implementer to obey the ignore state.

       @return True if item property svndigest:ignore was set.
    */
    inline bool svndigest_ignore(void) const { return svndigest_ignore_; }

    /**
     */
    const StatsCollection& stats(void) const;

    StatsCollection& stats(void);

    /**
       Access point for a NodeVisitor to start traversing Node and its
       daughter nodes.
     */
    virtual void traverse(NodeVisitor& visitor)=0;

    /**
       \see SVNinfo::url(void)
    */
    std::string url(void) const;
    
  protected:
    ///
    /// print path in html format (with anchors) to @a os
    ///
    void path_anchor(std::ostream& os) const; 

    inline const SVNinfo& svn_info(void) const { return svninfo_; }

    unsigned int level_;
    std::string output_dir_;
    std::string path_; // absolute path
    static std::string project_;
    StatsCollection stats_;
    TinyStats tiny_stats_;

  private:
    ///
    /// @brief Copy Constructor, not implemented
    ///
    Node(const Node&);

    void html_tabletd(std::ostream&, const std::string& stats_type, 
                      const std::string& user, 
                      LineTypeParser::line_type lt) const;

    virtual void log_core(SVNlog&) const=0;

    virtual void print_core(bool verbose=false) const=0;

    ///
    /// print page for specific user (or all) and specific line_style
    /// (or total).
    ///
    virtual void print_core(const std::string& stats_type,
                            const std::string& user, 
                            const std::string& line_type,
                            const SVNlog&) const=0; 

    bool binary_;
    bool link_;
    std::string local_path_; // path from root
    mutable SVNlog* log_;
    bool svndigest_ignore_;
    bool svncopyright_ignore_;
    SVNinfo svninfo_;
  };

  /**
     \brief Functor class to compare pointers of Nodes
  */
  struct NodePtrLess
  {
    /**
       @return true if first and second are of same type (Directory or
       File) and name of first is (alphabetically) less than name of
       second; or if first is a Directory and second is a File.
     */
    inline bool operator()(const Node* first, const Node* second) const
    {   
      if (first->dir()==second->dir())
        return first->name()<second->name();
      return first->dir();
    }
  };

}} // end of namespace svndigest and namespace theplu

#endif