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
10 * Full author contact details are available in file CREDITS.
16 #include "support/FileName.h"
27 /// A simple version control system interface
30 /// the status of the managed file
39 /// register a file for version control
40 virtual void registrer(std::string const & msg) = 0;
41 /// check in the current revision, returns log
42 virtual std::string checkIn(std::string const & msg) = 0;
43 // can be this operation processed in the current RCS?
44 virtual bool checkInEnabled() = 0;
45 // should a log message provided for next checkin?
46 virtual bool isCheckInWithConfirmation() = 0;
47 /// check out for editing, returns log
48 virtual std::string checkOut() = 0;
49 // can be this operation processed in the current RCS?
50 virtual bool checkOutEnabled() = 0;
51 /// synchronize with repository, returns log
52 virtual std::string repoUpdate() = 0;
53 // can be this operation processed in the current RCS?
54 virtual bool repoUpdateEnabled() = 0;
55 // toggle locking property of the file
56 virtual std::string lockingToggle() = 0;
57 // can be this operation processed in the current RCS?
58 virtual bool lockingToggleEnabled() = 0;
59 /// revert current edits
60 virtual void revert() = 0;
61 // should a confirmation before revert requested?
62 virtual bool isRevertWithConfirmation() = 0;
64 virtual void undoLast() = 0;
65 // can be this operation processed in the current RCS?
66 virtual bool undoLastEnabled() = 0;
68 * getLog - read the revision log into the given file
69 * @param fname file name to read into
71 virtual void getLog(support::FileName const &) = 0;
72 /// return the current version description
73 virtual std::string const versionString() const = 0;
74 /// set the owning buffer
75 void owner(Buffer * b) { owner_ = b; }
76 /// return the owning buffer
77 Buffer * owner() const { return owner_; }
78 /// return the lock status of this file
79 VCStatus status() const { return vcstatus; }
80 /// do we need special handling for read-only toggling?
81 /// (also used for check-out operation)
82 virtual bool toggleReadOnlyEnabled() = 0;
83 /// Return revision info specified by the argument.
84 virtual std::string revisionInfo(LyXVC::RevisionInfo const info) = 0;
86 virtual bool prepareFileRevision(std::string const & rev, std::string & f) = 0;
88 virtual bool prepareFileRevisionEnabled() = 0;
91 /// parse information from the version file
92 virtual void scanMaster() = 0;
94 // GUI container for doVCCommandCall
95 int doVCCommand(std::string const & cmd, support::FileName const & path, bool reportError = true);
97 * doVCCommandCall - call out to the version control utility
98 * @param cmd the command to execute
99 * @param path the path from which to execute
100 * @return exit status
102 static int doVCCommandCall(std::string const & cmd, support::FileName const & path);
105 * The master VC file. For RCS this is *,v or RCS/ *,v. master should
108 support::FileName master_;
110 /// The status of the VC controlled file.
113 /// The buffer using this VC
119 class RCS : public VCS {
123 RCS(support::FileName const & m);
125 /// return the revision file for the given file, if found
126 static support::FileName const findFile(support::FileName const & file);
128 static void retrieve(support::FileName const & file);
130 virtual void registrer(std::string const & msg);
132 virtual std::string checkIn(std::string const & msg);
134 virtual bool checkInEnabled();
136 virtual bool isCheckInWithConfirmation();
138 virtual std::string checkOut();
140 virtual bool checkOutEnabled();
142 virtual std::string repoUpdate();
144 virtual bool repoUpdateEnabled();
146 virtual std::string lockingToggle();
148 virtual bool lockingToggleEnabled();
150 virtual void revert();
152 virtual bool isRevertWithConfirmation();
154 virtual void undoLast();
156 virtual bool undoLastEnabled();
158 virtual void getLog(support::FileName const &);
160 virtual std::string const versionString() const {
161 return "RCS: " + version_;
164 virtual bool toggleReadOnlyEnabled();
166 virtual std::string revisionInfo(LyXVC::RevisionInfo const info);
168 virtual bool prepareFileRevision(std::string const & rev, std::string & f);
170 virtual bool prepareFileRevisionEnabled();
173 virtual void scanMaster();
176 * The version of the VC file. I am not sure if this can be a
177 * string or if it must be a float/int.
179 std::string version_;
180 /// The user currently keeping the lock on the VC file (or "Unlocked").
186 class CVS : public VCS {
190 CVS(support::FileName const & m, support::FileName const & f);
192 /// return the revision file for the given file, if found
193 static support::FileName const findFile(support::FileName const & file);
195 virtual void registrer(std::string const & msg);
197 virtual std::string checkIn(std::string const & msg);
199 virtual bool checkInEnabled();
201 virtual bool isCheckInWithConfirmation();
203 virtual std::string checkOut();
205 virtual bool checkOutEnabled();
207 virtual std::string repoUpdate();
209 virtual bool repoUpdateEnabled();
211 virtual std::string lockingToggle();
213 virtual bool lockingToggleEnabled();
215 virtual bool isRevertWithConfirmation();
217 virtual void revert();
219 virtual void undoLast();
221 virtual bool undoLastEnabled();
223 virtual void getLog(support::FileName const &);
225 /// Check for messages in cvs output.
226 /// Returns conflict line.
227 std::string scanLogFile(support::FileName const & f, std::string & status);
229 virtual std::string const versionString() const {
230 return "CVS: " + version_;
233 virtual bool toggleReadOnlyEnabled();
235 virtual std::string revisionInfo(LyXVC::RevisionInfo const info);
237 virtual bool prepareFileRevision(std::string const & rev, std::string & f);
239 virtual bool prepareFileRevisionEnabled();
242 virtual void scanMaster();
243 /// the mode of operation for some VC commands
248 /// possible status values of file
260 support::FileName file_;
261 // revision number from scanMaster
262 std::string version_;
264 /// return the quoted pathname if Directory or filename if File
265 virtual std::string const getTarget(OperationMode opmode) const;
266 /// collect the diff of file or directory against repository
267 /// result is placed in temporary file
268 void getDiff(OperationMode opmode, support::FileName const & tmpf);
269 /// make the file ready for editing:
270 /// save a copy in CVS/Base and change file permissions to rw if needed
272 /// revert the edit operation
273 virtual int unedit();
274 /// retrieve repository changes into working copy
275 virtual int update(OperationMode opmode, support::FileName const & tmpf);
276 /// check readonly state for file
277 /// assume true when file is writable
278 virtual bool isLocked() const;
279 /// query and parse the cvs status of file
280 virtual CvsStatus getStatus();
281 /// convert enum to string
282 virtual docstring toString(CvsStatus status) const;
287 class SVN : public VCS {
291 SVN(support::FileName const & m, support::FileName const & f);
293 /// return the revision file for the given file, if found
294 static support::FileName const findFile(support::FileName const & file);
296 virtual void registrer(std::string const & msg);
298 virtual std::string checkIn(std::string const & msg);
300 virtual bool checkInEnabled();
302 virtual bool isCheckInWithConfirmation();
304 virtual std::string checkOut();
306 virtual bool checkOutEnabled();
308 virtual std::string repoUpdate();
310 virtual bool repoUpdateEnabled();
312 virtual std::string lockingToggle();
314 virtual bool lockingToggleEnabled();
316 virtual void revert();
318 virtual bool isRevertWithConfirmation();
320 virtual void undoLast();
322 virtual bool undoLastEnabled();
324 virtual void getLog(support::FileName const &);
326 virtual std::string const versionString() const {
327 return "SVN: " + rev_file_cache_;
330 virtual bool toggleReadOnlyEnabled();
332 virtual std::string revisionInfo(LyXVC::RevisionInfo const info);
334 virtual bool prepareFileRevision(std::string const & rev, std::string & f);
336 virtual bool prepareFileRevisionEnabled();
339 virtual void scanMaster();
340 /// Check for messages in svn output. Returns error.
341 std::string scanLogFile(support::FileName const & f, std::string & status);
342 /// checks locking policy and setup locked_mode_
343 bool checkLockMode();
344 /// is the loaded file locked?
345 bool isLocked() const;
346 /// acquire/release write lock for the current file
347 void fileLock(bool lock, support::FileName const & tmpf, std::string & status);
350 support::FileName file_;
351 /// is the loaded file under locking policy?
354 * Real code for obtaining file revision info. Fills all file-related caches
355 * and returns true if successfull.
356 * "?" is stored in rev_file_cache_ as a signal if request for obtaining info
357 * was already unsuccessful.
359 bool getFileRevisionInfo();
360 /// cache for file revision number, "?" if already unsuccessful, isNumber==true
361 std::string rev_file_cache_;
362 /// cache for author of last commit
363 std::string rev_author_cache_;
364 /// cache for date of last commit
365 std::string rev_date_cache_;
366 /// cache for time of last commit
367 std::string rev_time_cache_;
368 /// fills rev_tree_cache_, returns true if successfull.
369 bool getTreeRevisionInfo();
370 /// cache for tree revision number, "?" if already unsuccessful
371 std::string rev_tree_cache_;
376 #endif // VCBACKEND_H