]> git.lyx.org Git - lyx.git/blobdiff - src/VCBackend.h
Allow autoconf 2.69 and automake 1.12
[lyx.git] / src / VCBackend.h
index 50cec8c770abb6f66addccdc3fd19a7c242ea434..abffaec044a0a7a0c0449b4908e7779c2de39fd9 100644 (file)
@@ -5,6 +5,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Lars Gullik Bjønnes
+ * \author Pavel Sanda
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -41,6 +42,8 @@ public:
        virtual std::string checkIn(std::string const & msg) = 0;
        // can be this operation processed in the current RCS?
        virtual bool checkInEnabled() = 0;
+       // should a log message provided for next checkin?
+       virtual bool isCheckInWithConfirmation() = 0;
        /// check out for editing, returns log
        virtual std::string checkOut() = 0;
        // can be this operation processed in the current RCS?
@@ -54,7 +57,9 @@ public:
        // can be this operation processed in the current RCS?
        virtual bool lockingToggleEnabled() = 0;
        /// revert current edits
-       virtual void revert() = 0;
+       virtual bool revert() = 0;
+       // should a confirmation before revert requested?
+       virtual bool isRevertWithConfirmation() = 0;
        /// FIXME
        virtual void undoLast() = 0;
        // can be this operation processed in the current RCS?
@@ -66,10 +71,6 @@ public:
        virtual void getLog(support::FileName const &) = 0;
        /// return the current version description
        virtual std::string const versionString() const = 0;
-       /// return the current version
-       std::string const & version() const { return version_; }
-       /// return the user who has locked the file
-       std::string const & locker() const { return locker_; }
        /// set the owning buffer
        void owner(Buffer * b) { owner_ = b; }
        /// return the owning buffer
@@ -81,12 +82,25 @@ public:
        virtual bool toggleReadOnlyEnabled() = 0;
        /// Return revision info specified by the argument.
        virtual std::string revisionInfo(LyXVC::RevisionInfo const info) = 0;
+
+       virtual bool prepareFileRevision(std::string const & rev, std::string & f) = 0;
+
+       virtual bool prepareFileRevisionEnabled() = 0;
+
+       /// Check the directory of file and all parent directories
+       // for the existence of the given pathname
+       static bool checkparentdirs(support::FileName const & file, std::string const & pathname);
+       
 protected:
        /// parse information from the version file
        virtual void scanMaster() = 0;
 
+       /// Prepare a version identifier suitable for RCS and CVS.
+       /// If needed converts last or relative number to the absolute revision.
+       bool makeRCSRevision(std::string const &version, std::string &revis) const;
+       
        // GUI container for doVCCommandCall
-       int doVCCommand(std::string const & cmd, support::FileName const & path);
+       int doVCCommand(std::string const & cmd, support::FileName const & path, bool reportError = true);
        /**
         * doVCCommandCall - call out to the version control utility
         * @param cmd the command to execute
@@ -104,14 +118,6 @@ protected:
        /// The status of the VC controlled file.
        VCStatus vcstatus;
 
-       /**
-        * The version of the VC file. I am not sure if this can be a
-        * string or if it must be a float/int.
-        */
-       std::string version_;
-
-       /// The user currently keeping the lock on the VC file.
-       std::string locker_;
        /// The buffer using this VC
        Buffer * owner_;
 };
@@ -135,6 +141,8 @@ public:
 
        virtual bool checkInEnabled();
 
+       virtual bool isCheckInWithConfirmation();
+
        virtual std::string checkOut();
 
        virtual bool checkOutEnabled();
@@ -147,7 +155,9 @@ public:
 
        virtual bool lockingToggleEnabled();
 
-       virtual void revert();
+       virtual bool revert();
+
+       virtual bool isRevertWithConfirmation();
 
        virtual void undoLast();
 
@@ -163,8 +173,27 @@ public:
 
        virtual std::string revisionInfo(LyXVC::RevisionInfo const info);
 
+       virtual bool prepareFileRevision(std::string const & rev, std::string & f);
+
+       virtual bool prepareFileRevisionEnabled();
+
 protected:
        virtual void scanMaster();
+private:
+       bool getRevisionInfo();
+       /**
+        * The version of the VC file. I am not sure if this can be a
+        * string or if it must be a float/int.
+        */
+       std::string version_;
+       /// The user currently keeping the lock on the VC file (or "Unlocked").
+       std::string locker_;
+       /// Cache for revision info.
+       std::string rev_date_cache_;
+       ///
+       std::string rev_time_cache_;
+       ///
+       std::string rev_author_cache_;
 };
 
 
@@ -184,6 +213,8 @@ public:
 
        virtual bool checkInEnabled();
 
+       virtual bool isCheckInWithConfirmation();
+
        virtual std::string checkOut();
 
        virtual bool checkOutEnabled();
@@ -196,7 +227,9 @@ public:
 
        virtual bool lockingToggleEnabled();
 
-       virtual void revert();
+       virtual bool isRevertWithConfirmation();
+
+       virtual bool revert();
 
        virtual void undoLast();
 
@@ -204,6 +237,10 @@ public:
 
        virtual void getLog(support::FileName const &);
 
+       /// Check for messages in cvs output. 
+       /// Returns conflict line.
+       std::string scanLogFile(support::FileName const & f, std::string & status);
+
        virtual std::string const versionString() const {
                return "CVS: " + version_;
        }
@@ -212,11 +249,79 @@ public:
 
        virtual std::string revisionInfo(LyXVC::RevisionInfo const info);
 
+       virtual bool prepareFileRevision(std::string const & rev, std::string & f);
+
+       virtual bool prepareFileRevisionEnabled();
+
 protected:
        virtual void scanMaster();
+       /// the mode of operation for some VC commands
+       enum OperationMode {
+               Directory = 0,
+               File = 1
+       };
+       /// possible status values of file
+       enum CvsStatus {
+               UpToDate = 0,
+               LocallyModified = 1,
+               LocallyAdded = 2,
+               NeedsMerge = 3,
+               NeedsCheckout = 4,
+               NoCvsFile = 5,
+               StatusError = 6
+       };
 
 private:
        support::FileName file_;
+       // revision number from scanMaster
+       std::string version_;
+
+       /**
+        * doVCCommandWithOutput
+        * - call out to the version control utility
+        * - it is able to collect output in a file
+        * @param cmd the command to execute
+        * @param path the path from which to execute
+        * @param output the path where to store output
+        * @param reportError display of low level error message dialog
+        * @return exit status
+        */
+       int doVCCommandWithOutput(std::string const & cmd,
+                       support::FileName const & path,
+                       support::FileName const & output,
+                       bool reportError = true);
+       static int doVCCommandCallWithOutput(std::string const & cmd,
+                       support::FileName const & path,
+                       support::FileName const & output);
+                                               
+       /// return the quoted pathname if Directory or filename if File
+       virtual std::string const getTarget(OperationMode opmode) const;
+       /// collect the diff of file or directory against repository
+       /// result is placed in temporary file
+       void getDiff(OperationMode opmode, support::FileName const & tmpf);
+       /// make the file ready for editing:
+       /// save a copy in CVS/Base and change file permissions to rw if needed
+       virtual int edit();
+       /// revert the edit operation
+       virtual int unedit();
+       /// retrieve repository changes into working copy
+       virtual int update(OperationMode opmode, support::FileName const & tmpf);
+       /// check readonly state for file
+       /// assume true when file is writable
+       virtual bool isLocked() const;
+       /// query and parse the cvs status of file
+       virtual CvsStatus getStatus();
+       /// convert enum to string
+       virtual docstring toString(CvsStatus status) const;
+
+       /// cache the info values of current file revision
+       /// author, date and time of commit
+       std::string rev_author_cache_;
+       std::string rev_date_cache_;
+       std::string rev_time_cache_;
+       /// fills the cache values, returns true if successfull.
+       void getRevisionInfo();
+       bool have_rev_info_;
 };
 
 
@@ -236,6 +341,8 @@ public:
 
        virtual bool checkInEnabled();
 
+       virtual bool isCheckInWithConfirmation();
+
        virtual std::string checkOut();
 
        virtual bool checkOutEnabled();
@@ -248,7 +355,9 @@ public:
 
        virtual bool lockingToggleEnabled();
 
-       virtual void revert();
+       virtual bool revert();
+
+       virtual bool isRevertWithConfirmation();
 
        virtual void undoLast();
 
@@ -257,13 +366,17 @@ public:
        virtual void getLog(support::FileName const &);
 
        virtual std::string const versionString() const {
-               return "SVN: " + version_;
+               return "SVN: " + rev_file_cache_;
        }
 
        virtual bool toggleReadOnlyEnabled();
 
        virtual std::string revisionInfo(LyXVC::RevisionInfo const info);
 
+       virtual bool prepareFileRevision(std::string const & rev, std::string & f);
+
+       virtual bool prepareFileRevisionEnabled();
+
 protected:
        virtual void scanMaster();
        /// Check for messages in svn output. Returns error.
@@ -286,7 +399,7 @@ private:
         * was already unsuccessful.
         */
        bool getFileRevisionInfo();
-       /// cache for file revision number, "?" if already unsuccessful
+       /// cache for file revision number, "?" if already unsuccessful, isNumber==true
        std::string rev_file_cache_;
        /// cache for author of last commit
        std::string rev_author_cache_;