client.hpp

Go to the documentation of this file.

/*
 * ====================================================================
 * Copyright (c) 2002-2006 The RapidSvn Group.  All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library (in the file LGPL.txt); if not, 
 * write to the Free Software Foundation, Inc., 51 Franklin St, 
 * Fifth Floor, Boston, MA  02110-1301  USA
 *
 * This software consists of voluntary contributions made by many
 * individuals.  For exact contribution history, see the revision
 * history and logs, available at http://rapidsvn.tigris.org/.
 * ====================================================================
 */

#ifndef _SVNCPP_CLIENT_H_
#define _SVNCPP_CLIENT_H_

// Ignore MSVC 6 compiler warning: debug symbol truncated
#if defined (_MSC_VER) && _MSC_VER <= 1200
#pragma warning (disable: 4786)
#endif

// Ignore MSVC 7 compiler warning: C++ exception specification
#if defined (_MSC_VER) && _MSC_VER > 1200 && _MSC_VER <= 1310
#pragma warning (disable: 4290)
#endif


// stl
#include <vector>
#include <utility>
#include <map>

// svncpp
#include "svncpp/check.hpp"
#include "svncpp/context.hpp"
#include "svncpp/exception.hpp"
#include "svncpp/path.hpp"
#include "svncpp/entry.hpp"
#include "svncpp/revision.hpp"
#include "svncpp/log_entry.hpp"
#include "svncpp/annotate_line.hpp"


namespace svn
{
  // forward declarations
  class Context;
  class Status;
  class Targets;
  class DirEntry;

  typedef std::vector<LogEntry> LogEntries;
  typedef std::vector<Status> StatusEntries;
  typedef std::vector<DirEntry> DirEntries;
  typedef std::vector<AnnotateLine> AnnotatedFile;

  // map of property names to values
  typedef std::map<std::string,std::string> PropertiesMap;
  // pair of path, PropertiesMap
  typedef std::pair<std::string, PropertiesMap> PathPropertiesMapEntry;
  // vector of path, Properties pairs
  typedef std::vector<PathPropertiesMapEntry> PathPropertiesMapList;

  class Client
  {
  public:
    Client (Context * context = 0);

    virtual ~Client ();

    const Context * 
    getContext () const;

    void 
    setContext (Context * context = NULL);

    StatusEntries 
    status (const char * path,
            const bool descend = false,
            const bool get_all = true,
            const bool update = false,
            const bool no_ignore = false,
            const bool ignore_externals = false) throw (ClientException);

    Status 
    singleStatus (const char * path) throw (ClientException);

    svn_revnum_t
    checkout (const char * moduleName,
              const Path & destPath, 
              const Revision & revision, 
              bool recurse,
              bool ignore_externals = false,
              const Revision & peg_revision = Revision ()) throw (ClientException);
  
    void 
    relocate (const Path & path, const char *from_url,
              const char *to_url, bool recurse) throw (ClientException);

    void 
    remove (const Path & path, bool force) throw (ClientException);

    void 
    remove (const Targets & targets, 
            bool force) throw (ClientException);

    void 
    lock (const Targets & targets, bool force,
          const char * comment) throw (ClientException);

    void 
    unlock (const Targets & targets, bool force) throw (ClientException);

    void
    revert (const Targets & targets, bool recurse) throw (ClientException);

    void 
    add (const Path & path, bool recurse) throw (ClientException);

    svn_revnum_t 
    update (const Path & path, const Revision & revision, 
            bool recurse) throw (ClientException);

    void
    update2 (const Targets & targets,
             const Revision & revision, 
             bool recurse,
             bool ignore_externals) throw (ClientException);

    std::string
    cat (const Path & path, 
         const Revision & revision,
         const Revision & peg_revision = Revision ()) throw (ClientException);


    void
    get (Path & dstPath, 
         const Path & path,
         const Revision & revision, 
         const Revision & peg_revision = Revision ()) throw (ClientException);


    AnnotatedFile *
    annotate (const Path & path, 
              const Revision & revisionStart, 
              const Revision & revisionEnd) throw (ClientException);

    svn_revnum_t
    commit (const Targets & targets,
            const char * message, 
            bool recurse,
            bool keep_locks = false) throw (ClientException);

    void 
    copy (const Path & srcPath, 
          const Revision & srcRevision,
          const Path & destPath) throw (ClientException);

    void 
    move (const Path & srcPath, 
          const Revision & srcRevision, 
          const Path & destPath, 
          bool force) throw (ClientException);

    void 
    mkdir (const Path & path, 
           const char * message = "") throw (ClientException);
    void 
    mkdir (const Targets & targets, 
           const char * message = "") throw (ClientException);

    void 
    cleanup (const Path & path) throw (ClientException);

    void 
    resolved (const Path & path, bool recurse) throw (ClientException);

    svn_revnum_t
    doExport (const Path & srcPath, 
              const Path & destPath, 
              const Revision & revision, 
              bool force = false) throw (ClientException);

    void
    doExport2 (const Path & from_path,
               const Path & to_path,
               const Revision & revision,
               bool overwrite = false,
               const Revision & peg_revision = Revision (),
               bool ignore_externals = false,
               bool recurse = true,
               const char * native_eol = NULL) throw (ClientException);

    svn_revnum_t
    doSwitch (const Path & path, const char * url, 
              const Revision & revision, 
              bool recurse) throw (ClientException);

    void 
    import (const Path & path,
            const char * url,
            const char * message, 
            bool recurse) throw (ClientException);


    void 
    merge (const Path & path1, const Revision & revision1, 
           const Path & path2, const Revision & revision2,
           const Path & localPath, bool force, 
           bool recurse,
           bool notice_ancestry = false,
           bool dry_run = false) throw (ClientException);

    Entry
    info (const char * path);

    const LogEntries *
    log (const char * path,
         const Revision & revisionStart, 
         const Revision & revisionEnd,
         bool discoverChangedPaths = false, 
         bool strictNodeHistory = true) throw (ClientException);

    std::string
    diff (const Path & tmpPath, const Path & path,
          const Revision & revision1, const Revision & revision2,
          const bool recurse, const bool ignoreAncestry,
          const bool noDiffDeleted) throw (ClientException);

    DirEntries
    ls (const char * pathOrUrl,
        svn_opt_revision_t * revision,
        bool recurse) throw (ClientException);

    DirEntries
    list (const char * pathOrUrl,
          svn_opt_revision_t * revision,
          bool recurse) throw (ClientException);

    PathPropertiesMapList
    proplist (const Path &path,
              const Revision &revision,
              bool recurse = false);

    PathPropertiesMapList
    propget (const char * propName,
             const Path & path,
             const Revision & revision,
             bool recurse = false);

    void
    propset (const char * propName,
             const char * propValue,
             const Path & path,
             const Revision & revision,
             bool recurse = false,
             bool skip_checks = true);

    void
    propdel (const char * propName,
             const Path & path,
             const Revision & revision,
             bool recurse = false);


    std::pair<svn_revnum_t,PropertiesMap>
    revproplist (const Path & path,
                 const Revision & revision);

    std::pair<svn_revnum_t,std::string>
    revpropget (const char * propName,
                const Path & path,
                const Revision & revision);

    svn_revnum_t
    revpropset (const char * propName,
                const char * propValue,
                const Path & path,
                const Revision & revision,
                bool force = false);

    svn_revnum_t
    revpropdel (const char * propName,
                const Path & path,
                const Revision & revision,
                bool force = false);


  private:
    Context * m_context;

    Client & operator= (const Client &);

    Client (const Client &);
  };
}

#endif
/* -----------------------------------------------------------------
 * local variables:
 * eval: (load-file "../../rapidsvn-dev.el")
 * end:
 */

---