src/VCBackend.h

   1 // -*- C++ -*-
   2 /**
   3  * \file VCBackend.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef VC_BACKEND_H
  13 #define VC_BACKEND_H
  14
  15 #include "support/FileName.h"
  16
  17 #include <string>
  18
  19
  20 namespace lyx {
  21
  22 class Buffer;
  23
  24 /// A simple version control system interface
  25 class VCS {
  26 public:
  27         /// the status of the managed file
  28         enum VCStatus {
  29                 UNLOCKED,
  30                 LOCKED
  31         };
  32
  33         virtual ~VCS() {}
  34
  35         /// register a file for version control
  36         virtual void registrer(std::string const & msg) = 0;
  37         /// check in the current revision
  38         virtual void checkIn(std::string const & msg) = 0;
  39         // can be this operation processed in the current RCS?
  40         virtual bool checkInEnabled() = 0;
  41         /// check out for editing
  42         virtual void checkOut() = 0;
  43         // can be this operation processed in the current RCS?
  44         virtual bool checkOutEnabled() = 0;
  45         /// revert current edits
  46         virtual void revert() = 0;
  47         /// FIXME
  48         virtual void undoLast() = 0;
  49         // can be this operation processed in the current RCS?
  50         virtual bool undoLastEnabled() = 0;
  51         /**
  52          * getLog - read the revision log into the given file
  53          * @param fname file name to read into
  54          */
  55         virtual void getLog(support::FileName const &) = 0;
  56         /// return the current version description
  57         virtual std::string const versionString() const = 0;
  58         /// return the current version
  59         std::string const & version() const { return version_; }
  60         /// return the user who has locked the file
  61         std::string const & locker() const { return locker_; }
  62         /// set the owning buffer
  63         void owner(Buffer * b) { owner_ = b; }
  64         /// return the owning buffer
  65         Buffer * owner() const { return owner_; }
  66         /// return the lock status of this file
  67         VCStatus status() const { return vcstatus; }
  68 protected:
  69         /// parse information from the version file
  70         virtual void scanMaster() = 0;
  71
  72         /**
  73          * doVCCommand - call out to the version control utility
  74          * @param cmd the command to execute
  75          * @param path the path from which to execute
  76          * @return exit status
  77          */
  78         static int doVCCommand(std::string const & cmd, support::FileName const & path);
  79
  80         /**
  81          * The master VC file. For RCS this is *,v or RCS/ *,v. master should
  82          * have full path.
  83          */
  84         support::FileName master_;
  85
  86         /// The status of the VC controlled file.
  87         VCStatus vcstatus;
  88
  89         /**
  90          * The version of the VC file. I am not sure if this can be a
  91          * string or if it must be a float/int.
  92          */
  93         std::string version_;
  94
  95         /// The user currently keeping the lock on the VC file.
  96         std::string locker_;
  97         /// The buffer using this VC
  98         Buffer * owner_;
  99 };
 100
 101
 102 ///
 103 class RCS : public VCS {
 104 public:
 105
 106         explicit
 107         RCS(support::FileName const & m);
 108
 109         /// return the revision file for the given file, if found
 110         static support::FileName const findFile(support::FileName const & file);
 111
 112         static void retrieve(support::FileName const & file);
 113
 114         virtual void registrer(std::string const & msg);
 115
 116         virtual void checkIn(std::string const & msg);
 117
 118         virtual bool checkInEnabled();
 119
 120         virtual void checkOut();
 121
 122         virtual bool checkOutEnabled();
 123
 124         virtual void revert();
 125
 126         virtual void undoLast();
 127
 128         virtual bool undoLastEnabled();
 129
 130         virtual void getLog(support::FileName const &);
 131
 132         virtual std::string const versionString() const {
 133                 return "RCS: " + version_;
 134         }
 135
 136 protected:
 137         virtual void scanMaster();
 138 };
 139
 140
 141 ///
 142 class CVS : public VCS {
 143 public:
 144         ///
 145         explicit
 146         CVS(support::FileName const & m, support::FileName const & f);
 147
 148         /// return the revision file for the given file, if found
 149         static support::FileName const findFile(support::FileName const & file);
 150
 151         virtual void registrer(std::string const & msg);
 152
 153         virtual void checkIn(std::string const & msg);
 154
 155         virtual bool checkInEnabled();
 156
 157         virtual void checkOut();
 158
 159         virtual bool checkOutEnabled();
 160
 161         virtual void revert();
 162
 163         virtual void undoLast();
 164
 165         virtual bool undoLastEnabled();
 166
 167         virtual void getLog(support::FileName const &);
 168
 169         virtual std::string const versionString() const {
 170                 return "CVS: " + version_;
 171         }
 172
 173 protected:
 174         virtual void scanMaster();
 175
 176 private:
 177         support::FileName file_;
 178 };
 179
 180 } // namespace lyx
 181
 182 #endif // VCBACKEND_H