* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
+ * \author Pavel Sanda
*
* Full author contact details are available in file CREDITS.
*/
#ifndef VC_BACKEND_H
#define VC_BACKEND_H
-#include "support/filename.h"
+#include "support/FileName.h"
#include <string>
+#include "LyXVC.h"
+
namespace lyx {
/// the status of the managed file
enum VCStatus {
UNLOCKED,
- LOCKED
+ LOCKED,
+ NOLOCKING
};
virtual ~VCS() {}
/// register a file for version control
virtual void registrer(std::string const & msg) = 0;
- /// check in the current revision
- virtual void checkIn(std::string const & msg) = 0;
- /// check out for editing
- virtual void checkOut() = 0;
+ /// check in the current revision, returns log
+ 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?
+ virtual bool checkOutEnabled() = 0;
+ /// synchronize with repository, returns log
+ virtual std::string repoUpdate() = 0;
+ // can be this operation processed in the current RCS?
+ virtual bool repoUpdateEnabled() = 0;
+ // toggle locking property of the file
+ virtual std::string lockingToggle() = 0;
+ // can be this operation processed in the current RCS?
+ virtual bool lockingToggleEnabled() = 0;
/// revert current edits
virtual void 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?
+ virtual bool undoLastEnabled() = 0;
/**
* getLog - read the revision log into the given file
* @param fname file name to read into
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
Buffer * owner() const { return owner_; }
/// return the lock status of this file
VCStatus status() const { return vcstatus; }
+ /// do we need special handling for read-only toggling?
+ /// (also used for check-out operation)
+ 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;
+
protected:
/// parse information from the version file
virtual void scanMaster() = 0;
+ // GUI container for doVCCommandCall
+ int doVCCommand(std::string const & cmd, support::FileName const & path, bool reportError = true);
/**
- * doVCCommand - call out to the version control utility
+ * doVCCommandCall - call out to the version control utility
* @param cmd the command to execute
* @param path the path from which to execute
* @return exit status
*/
- static int doVCCommand(std::string const & cmd, support::FileName const & path);
+ static int doVCCommandCall(std::string const & cmd, support::FileName const & path);
/**
* The master VC file. For RCS this is *,v or RCS/ *,v. master should
/// 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_;
};
RCS(support::FileName const & m);
/// return the revision file for the given file, if found
- static support::FileName const find_file(support::FileName const & file);
+ static support::FileName const findFile(support::FileName const & file);
static void retrieve(support::FileName const & file);
virtual void registrer(std::string const & msg);
- virtual void checkIn(std::string const & msg);
+ virtual std::string checkIn(std::string const & msg);
- virtual void checkOut();
+ virtual bool checkInEnabled();
+
+ virtual bool isCheckInWithConfirmation();
+
+ virtual std::string checkOut();
+
+ virtual bool checkOutEnabled();
+
+ virtual std::string repoUpdate();
+
+ virtual bool repoUpdateEnabled();
+
+ virtual std::string lockingToggle();
+
+ virtual bool lockingToggleEnabled();
virtual void revert();
+ virtual bool isRevertWithConfirmation();
+
virtual void undoLast();
+ virtual bool undoLastEnabled();
+
virtual void getLog(support::FileName const &);
virtual std::string const versionString() const {
return "RCS: " + version_;
}
+ 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();
+private:
+ /**
+ * 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_;
};
CVS(support::FileName const & m, support::FileName const & f);
/// return the revision file for the given file, if found
- static support::FileName const find_file(support::FileName const & file);
+ static support::FileName const findFile(support::FileName const & file);
virtual void registrer(std::string const & msg);
- virtual void checkIn(std::string const & msg);
+ virtual std::string checkIn(std::string const & msg);
+
+ virtual bool checkInEnabled();
+
+ virtual bool isCheckInWithConfirmation();
+
+ virtual std::string checkOut();
+
+ virtual bool checkOutEnabled();
- virtual void checkOut();
+ virtual std::string repoUpdate();
+
+ virtual bool repoUpdateEnabled();
+
+ virtual std::string lockingToggle();
+
+ virtual bool lockingToggleEnabled();
+
+ virtual bool isRevertWithConfirmation();
virtual void revert();
virtual void undoLast();
+ virtual bool undoLastEnabled();
+
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_;
}
+ 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();
+ /// 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_;
+
+ /// 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;
+};
+
+
+///
+class SVN : public VCS {
+public:
+ ///
+ explicit
+ SVN(support::FileName const & m, support::FileName const & f);
+
+ /// return the revision file for the given file, if found
+ static support::FileName const findFile(support::FileName const & file);
+
+ virtual void registrer(std::string const & msg);
+
+ virtual std::string checkIn(std::string const & msg);
+
+ virtual bool checkInEnabled();
+
+ virtual bool isCheckInWithConfirmation();
+
+ virtual std::string checkOut();
+
+ virtual bool checkOutEnabled();
+
+ virtual std::string repoUpdate();
+
+ virtual bool repoUpdateEnabled();
+
+ virtual std::string lockingToggle();
+
+ virtual bool lockingToggleEnabled();
+
+ virtual void revert();
+
+ virtual bool isRevertWithConfirmation();
+
+ virtual void undoLast();
+
+ virtual bool undoLastEnabled();
+
+ virtual void getLog(support::FileName const &);
+
+ virtual std::string const versionString() const {
+ 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.
+ std::string scanLogFile(support::FileName const & f, std::string & status);
+ /// checks locking policy and setup locked_mode_
+ bool checkLockMode();
+ /// is the loaded file locked?
+ bool isLocked() const;
+ /// acquire/release write lock for the current file
+ void fileLock(bool lock, support::FileName const & tmpf, std::string & status);
private:
support::FileName file_;
+ /// is the loaded file under locking policy?
+ bool locked_mode_;
+ /**
+ * Real code for obtaining file revision info. Fills all file-related caches
+ * and returns true if successfull.
+ * "?" is stored in rev_file_cache_ as a signal if request for obtaining info
+ * was already unsuccessful.
+ */
+ bool getFileRevisionInfo();
+ /// 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_;
+ /// cache for date of last commit
+ std::string rev_date_cache_;
+ /// cache for time of last commit
+ std::string rev_time_cache_;
+ /// fills rev_tree_cache_, returns true if successfull.
+ bool getTreeRevisionInfo();
+ /// cache for tree revision number, "?" if already unsuccessful
+ std::string rev_tree_cache_;
};
} // namespace lyx