Update my email and status.

[lyx.git] / src / LyXVC.h

diff --git a/src/LyXVC.h b/src/LyXVC.h
index 0d9c826d5a66e8b96de209fc44fead55d369b631..a860bda8ec289d7e9e27845a80cea914e2948b12 100644 (file)
--- a/src/LyXVC.h
+++ b/src/LyXVC.h
@@ -25,7 +25,7 @@ class VCS;
 class Buffer;
 
 /** Version Control for LyX.
-    This is the class giving the verison control features to LyX. It is
+    This is the class giving the version control features to LyX. It is
     intended to support different kinds of version control.
     The support in LyX is based loosely upon the version control in GNU Emacs,
     but is not as extensive as that one. See Extended Manual for a simple
@@ -43,16 +43,19 @@ public:
        LyXVC();
        ///
        ~LyXVC();
+       /// Is \p fn under version control?
+       static bool fileInVC(support::FileName const & fn);
        /** Not a good name perhaps. This function should be called whenever
          LyX loads a file. This function then checks for a master VC file (for
          RCS this is *,v or RCS/ *,v ; for CVS this is CVS/Entries and .svn/entries
          for SVN) if this file or entry is found, the loaded file is assumed to be
-         under controll by VC, and the appropiate actions is taken.
+         under control by VC, and the appropiate actions is taken.
          Returns true if the file is under control by a VCS.
          */
        bool file_found_hook(support::FileName const & fn);
 
-       /** This function should be run when a file is requested for loading,
+       /** Is \p fn under version control?
+         This function should be run when a file is requested for loading,
          but it does not exist. This function will then check for a VC master
          file with the same name (see above function). If this exists the
          user should be asked if he/her wants to checkout a version for
@@ -64,7 +67,7 @@ public:
        ///
        void setBuffer(Buffer *);
 
-       /// Register the document as an VC file.
+       /// Register the document as a VC file.
        bool registrer();
 
 
@@ -98,7 +101,7 @@ public:
        bool lockingToggleEnabled() const;
 
        /// Revert to last version
-       void revert();
+       bool revert();
 
        /// Undo last check-in.
        void undoLast();
@@ -110,8 +113,12 @@ public:
         * Parameter rev can be either revision number or negative number
         * which is interpreted as how many revision back from the current
         * one do we want. rev=0 is reserved for the last (committed) revision.
+        * We need rev to be string, since in various VCS revision is not integer.
+        * If RCS addressed by a single number, it is automatically used
+        * as the last number in the whole revision specification (it applies
+        * for retrieving normal revisions (rev>0) or backtracking (rev<0).
         */
-       bool prepareFileRevision(int rev, std::string & f);
+       bool prepareFileRevision(std::string const & rev, std::string & f);
        /// Does the current VC supports this operation?
        bool prepareFileRevisionEnabled();
 
@@ -143,6 +150,7 @@ public:
 
        // type of the revision information
        enum RevisionInfo {
+               Unknown = 0,
                File = 1,
                Tree = 2,
                Author = 3,
@@ -155,7 +163,7 @@ public:
         * Its safe to call it regardless VCS is in usage or this
         * info is (un)available. Returns empty string in such a case.
         */
-       std::string revisionInfo(RevisionInfo const info);
+       std::string revisionInfo(RevisionInfo const info) const;
 
 private:
        ///