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 <boost/scoped_ptr.hpp>
22 namespace support
{ class FileName
; }
27 /** Version Control for LyX.
28 This is the class giving the verison control features to LyX. It is
29 intended to support different kinds of version control.
30 The support in LyX is based loosely upon the version control in GNU Emacs,
31 but is not as extensive as that one. See Extended Manual for a simple
32 tutorial and manual for the use of the version control system in LyX.
34 LyXVC use this algorithm when it searches for VC files:
35 for RCS it searches for <filename>,v and RCS/<filename>,v similarly
36 CVS/Entries for cvs and .svn/entries. By doing this there doesn't need to be any
37 special support for VC in the lyx format, and this is especially good
38 when the lyx format will be a subset of LaTeX.
46 /** Not a good name perhaps. This function should be called whenever
47 LyX loads a file. This function then checks for a master VC file (for
48 RCS this is *,v or RCS/ *,v ; for CVS this is CVS/Entries and .svn/entries
49 for SVN) if this file or entry is found, the loaded file is assumed to be
50 under controll by VC, and the appropiate actions is taken.
51 Returns true if the file is under control by a VCS.
53 bool file_found_hook(support::FileName
const & fn
);
55 /** This function should be run when a file is requested for loading,
56 but it does not exist. This function will then check for a VC master
57 file with the same name (see above function). If this exists the
58 user should be asked if he/her wants to checkout a version for
59 viewing/editing. Returns true if the file is under control by a VCS
60 and the user wants to view/edit it.
62 static bool file_not_found_hook(support::FileName
const & fn
);
65 void setBuffer(Buffer
*);
67 /// Register the document as an VC file.
70 /// Unlock and commit changes.
72 /// Does the current VC supports this operation?
73 bool checkInEnabled();
75 /// Lock and prepare to edit document.
77 /// Does the current VC supports this operation?
78 bool checkOutEnabled();
80 /// Revert to last version
83 /// Undo last check-in.
85 /// Does the current VC supports this operation?
86 bool undoLastEnabled();
89 * Generate a log file and return the filename.
90 * It is the caller's responsibility to remove the
93 const std::string
getLogFile() const;
96 void toggleReadOnly();
98 /// Is the document under administration by VCS?
101 /// Returns the version number.
102 //std::string const & version() const;
103 /// Returns the version number.
104 std::string
const versionString() const;
106 /// Returns the userid of the person who has locked the doc.
107 std::string
const & locker() const;
114 boost::scoped_ptr
<VCS
> vcs
;