4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "support/FileName.h"
24 /// A simple version control system interface
27 /// the status of the managed file
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;
48 virtual void undoLast() = 0;
49 // can be this operation processed in the current RCS?
50 virtual bool undoLastEnabled() = 0;
52 * getLog - read the revision log into the given file
53 * @param fname file name to read into
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; }
69 /// parse information from the version file
70 virtual void scanMaster() = 0;
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
78 static int doVCCommand(std::string const & cmd, support::FileName const & path);
81 * The master VC file. For RCS this is *,v or RCS/ *,v. master should
84 support::FileName master_;
86 /// The status of the VC controlled file.
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.
95 /// The user currently keeping the lock on the VC file.
97 /// The buffer using this VC
103 class RCS : public VCS {
107 RCS(support::FileName const & m);
109 /// return the revision file for the given file, if found
110 static support::FileName const findFile(support::FileName const & file);
112 static void retrieve(support::FileName const & file);
114 virtual void registrer(std::string const & msg);
116 virtual void checkIn(std::string const & msg);
118 virtual bool checkInEnabled();
120 virtual void checkOut();
122 virtual bool checkOutEnabled();
124 virtual void revert();
126 virtual void undoLast();
128 virtual bool undoLastEnabled();
130 virtual void getLog(support::FileName const &);
132 virtual std::string const versionString() const {
133 return "RCS: " + version_;
137 virtual void scanMaster();
142 class CVS : public VCS {
146 CVS(support::FileName const & m, support::FileName const & f);
148 /// return the revision file for the given file, if found
149 static support::FileName const findFile(support::FileName const & file);
151 virtual void registrer(std::string const & msg);
153 virtual void checkIn(std::string const & msg);
155 virtual bool checkInEnabled();
157 virtual void checkOut();
159 virtual bool checkOutEnabled();
161 virtual void revert();
163 virtual void undoLast();
165 virtual bool undoLastEnabled();
167 virtual void getLog(support::FileName const &);
169 virtual std::string const versionString() const {
170 return "CVS: " + version_;
174 virtual void scanMaster();
177 support::FileName file_;
182 #endif // VCBACKEND_H