source: trunk/lib/SVN.h @ 91

// $Id: SVN.h 91 2006-03-23 22:56:17Z jari $

/*
  Copyright (C) 2006 Jari Häkkinen

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

  svnstat 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.

  svnstat 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.
*/

#ifndef _theplu_svnstat_svn_
#define _theplu_svnstat_svn_

#include <stdexcept>

#include <apr_allocator.h>
#include <svn_client.h>
#include <svn_wc.h>

namespace theplu {
namespace svnstat {

  class Directory;

  ///
  /// If something goes wrong in the use of the SVN class, a
  /// SVNException is thrown.
  ///
  struct SVNException : public std::runtime_error
  { inline SVNException(const std::string& msg) : runtime_error(msg) {} };

  ///
  /// The SVN class is a front end to the subversion API.
  ///
  /// SVN provides one single global access point to the underlying
  /// subversion API and makes sure that there is only one point of
  /// access to the binary.
  ///
  /// @see Design Patterns (the singleton pattern). Subversion API
  /// documents.
  ///
  class SVN {
  public:

    enum vc_status {
      unversioned=0,
      uptodate,
      unresolved
    };

    ///
    /// @brief The destructor.
    ///
    ~SVN(void);

    ///
    /// @brief Get an instance of SVN.
    ///
    /// @throw Throws a SVNException if one is received from the
    /// underlying constructor call.
    ///
    /// @todo Make sure that the underlying constructor performs
    /// proper cleanup before throwing an exception.
    ///
    static SVN* instance(void)
    { if (!instance_) instance_=new SVN; return instance_; }

    ///
    /// @throws SCNException if access setup fails.
    ///
    void setup_wc_adm_access(const std::string& path);

    ///
    /// @brief Check if entry \a path is under version control
    ///
    /// @return True if \a path is under version control, false
    /// otherwise.
    ///
    vc_status version_controlled(const std::string& path);

  private:
    ///
    /// @brief Constructor
    ///
    /// The only way to create a object of SVN type is by calling
    /// SVN::instance.
    ///
    /// @todo Make sure that proper cleanup is performed before
    /// throwing an exception.
    ///
    SVN(void);

    ///
    /// @brief Copy Constructor, not implemented.
    ///
    SVN(const SVN&);

    static SVN* instance_;

    // subversion API stuff
    svn_wc_adm_access_t* adm_access_;
    apr_allocator_t* allocator_;
    svn_client_ctx_t* context_;
    apr_pool_t* pool_;
  };

}} // end of namespace svnstat and namespace theplu

#endif