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.
71 // std::string used as a return value in functions below are
72 // workaround to defer messages to be displayed in UI. If message()
73 // is used directly, message string is immediately overwritten
74 // by the next multiple messages on the top of the processed dispatch
77 /// Unlock and commit changes. Returns log.
78 std::string checkIn();
79 /// Does the current VC supports this operation?
80 bool checkInEnabled() const;
82 /// Lock/update and prepare to edit document. Returns log.
83 std::string checkOut();
84 /// Does the current VC supports this operation?
85 bool checkOutEnabled() const;
87 /// Synchronize the whole archive with repository
88 std::string repoUpdate();
89 /// Does the current VC supports this operation?
90 bool repoUpdateEnabled() const;
93 * Toggle locking property of the edited file,
94 * i.e. whether the file uses locking mechanism.
96 std::string lockingToggle();
97 /// Does the current VC support this operation?
98 bool lockingToggleEnabled() const;
100 /// Revert to last version
103 /// Undo last check-in.
105 /// Does the current VC supports this operation?
106 bool undoLastEnabled() const;
109 * Generate a log file and return the filename.
110 * It is the caller's responsibility to remove the
113 const std::string getLogFile() const;
116 * We do not support this generally. In RCS/SVN file read-only flag
117 * is often connected with locking state and one has to be careful to
118 * keep things in synchro once we would allow user to toggle
121 void toggleReadOnly();
123 /// Is the document under administration by VCS?
126 /// FIXME resurrect version once we add version info
127 /// into SVN. RCS parser is already prepared.
128 /// Returns the version number.
129 //std::string const & version() const;
130 /// Returns the version number.
131 std::string const versionString() const;
134 * Returns the userid of the person who has locked the doc.
135 * FIXME This property is descendant from the original VCS
136 * and used in RCS for user id or "unlocked" strings.
137 * It would be problem to use this under SVN since getting
138 * the locker would need connection to server any time we
139 * load document. SVN currently (mis)uses this as a signal
140 * for locking state, as we do not have API for vcstatus().
141 * The RCS code for user id parsing is working but we don't display
142 * it anywhere. One possibility is to provide proper vcstatus()
143 * interface and kill the whole locker thing.
145 std::string const & locker() const;
152 boost::scoped_ptr<VCS> vcs;