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; }
68 /// do we need special handling for read-only toggling?
69 /// (also used for check-out operation)
70 virtual bool toggleReadOnlyEnabled() = 0;
72 /// parse information from the version file
73 virtual void scanMaster() = 0;
76 * doVCCommand - call out to the version control utility
77 * @param cmd the command to execute
78 * @param path the path from which to execute
81 static int doVCCommand(std::string const & cmd, support::FileName const & path);
84 * The master VC file. For RCS this is *,v or RCS/ *,v. master should
87 support::FileName master_;
89 /// The status of the VC controlled file.
93 * The version of the VC file. I am not sure if this can be a
94 * string or if it must be a float/int.
98 /// The user currently keeping the lock on the VC file.
100 /// The buffer using this VC
106 class RCS : public VCS {
110 RCS(support::FileName const & m);
112 /// return the revision file for the given file, if found
113 static support::FileName const findFile(support::FileName const & file);
115 static void retrieve(support::FileName const & file);
117 virtual void registrer(std::string const & msg);
119 virtual void checkIn(std::string const & msg);
121 virtual bool checkInEnabled();
123 virtual void checkOut();
125 virtual bool checkOutEnabled();
127 virtual void revert();
129 virtual void undoLast();
131 virtual bool undoLastEnabled();
133 virtual void getLog(support::FileName const &);
135 virtual std::string const versionString() const {
136 return "RCS: " + version_;
139 virtual bool toggleReadOnlyEnabled();
142 virtual void scanMaster();
147 class CVS : public VCS {
151 CVS(support::FileName const & m, support::FileName const & f);
153 /// return the revision file for the given file, if found
154 static support::FileName const findFile(support::FileName const & file);
156 virtual void registrer(std::string const & msg);
158 virtual void checkIn(std::string const & msg);
160 virtual bool checkInEnabled();
162 virtual void checkOut();
164 virtual bool checkOutEnabled();
166 virtual void revert();
168 virtual void undoLast();
170 virtual bool undoLastEnabled();
172 virtual void getLog(support::FileName const &);
174 virtual std::string const versionString() const {
175 return "CVS: " + version_;
178 virtual bool toggleReadOnlyEnabled();
181 virtual void scanMaster();
184 support::FileName file_;
189 class SVN : public VCS {
193 SVN(support::FileName const & m, support::FileName const & f);
195 /// return the revision file for the given file, if found
196 static support::FileName const findFile(support::FileName const & file);
198 virtual void registrer(std::string const & msg);
200 virtual void checkIn(std::string const & msg);
202 virtual bool checkInEnabled();
204 virtual void checkOut();
206 virtual bool checkOutEnabled();
208 virtual void revert();
210 virtual void undoLast();
212 virtual bool undoLastEnabled();
214 virtual void getLog(support::FileName const &);
216 virtual std::string const versionString() const {
217 return "SVN: " + version_;
220 virtual bool toggleReadOnlyEnabled();
223 virtual void scanMaster();
226 support::FileName file_;
231 #endif // VCBACKEND_H