X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FVCBackend.h;h=636cd9d4708c905745119289198a5b030f694c9f;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=6f81208be1a34cb2c45364f53a3ade2038dc4934;hpb=56e3d2153fed6bd73dcc36ac2fe1d7d81e07ac70;p=lyx.git diff --git a/src/VCBackend.h b/src/VCBackend.h index 6f81208be1..636cd9d470 100644 --- a/src/VCBackend.h +++ b/src/VCBackend.h @@ -16,6 +16,7 @@ #include "support/FileName.h" #include +#include #include "LyXVC.h" @@ -31,39 +32,55 @@ public: enum VCStatus { UNLOCKED, LOCKED, - NOLOCKING + NOLOCKING, }; - VCS(Buffer * b) : owner_(b) {} + VCS(Buffer * b) : vcstatus(NOLOCKING), owner_(b) {} virtual ~VCS() {} + /// the name of the vc backend + virtual std::string vcname() const = 0; /// register a file for version control virtual void registrer(std::string const & msg) = 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? + /// can this operation be processed in the current VCS? + virtual bool renameEnabled() = 0; + /// rename a file. Return non-empty log on success, empty log on failure. + virtual std::string rename(support::FileName const &, std::string const &) = 0; + /// can this operation be processed in the current VCS? + virtual bool copyEnabled() = 0; + /// copy a file. Return non-empty log on success, empty log on failure. + virtual std::string copy(support::FileName const &, std::string const &) = 0; + /// check in the current revision. + /// \p log is non-empty on success and may be empty on failure. + virtual LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log) = 0; + /// can this operation be processed in the current VCS? virtual bool checkInEnabled() = 0; - // should a log message provided for next checkin? + /// 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? + /// can this operation be processed in the current VCS? virtual bool checkOutEnabled() = 0; /// synchronize with repository, returns log virtual std::string repoUpdate() = 0; - // can be this operation processed in the current RCS? + /// can this operation be processed in the current VCS? virtual bool repoUpdateEnabled() = 0; - // toggle locking property of the file + /// toggle locking property of the file virtual std::string lockingToggle() = 0; - // can be this operation processed in the current RCS? + /// can this operation be processed in the current VCS? virtual bool lockingToggleEnabled() = 0; /// revert current edits virtual bool revert() = 0; - // should a confirmation before revert requested? + /// should a confirmation before revert requested? virtual bool isRevertWithConfirmation() = 0; - /// FIXME + /** + * Merge the current with the previous version + * in a reverse patch kind of way, so that the + * result is to revert the last changes. + */ virtual void undoLast() = 0; - // can be this operation processed in the current RCS? + /// can this operation be processed in the current VCS? virtual bool undoLastEnabled() = 0; /** * getLog - read the revision log into the given file @@ -81,14 +98,14 @@ public: virtual bool toggleReadOnlyEnabled() = 0; /// Return revision info specified by the argument. virtual std::string revisionInfo(LyXVC::RevisionInfo const info) = 0; - + /// can this operation be processed in the current VCS? virtual bool prepareFileRevision(std::string const & rev, std::string & f) = 0; - + /// can this operation be processed in the current VCS? 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); + /// for the existence of repository-info like .git or .svn + static bool checkparentdirs(support::FileName const & file, std::string const & vcsdir); protected: /// parse information from the version file @@ -98,7 +115,7 @@ protected: /// 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 + /// GUI container for doVCCommandCall int doVCCommand(std::string const & cmd, support::FileName const & path, bool reportError = true); /** * doVCCommandCall - call out to the version control utility @@ -132,11 +149,23 @@ public: /// return the revision file for the given file, if found static support::FileName const findFile(support::FileName const & file); - static void retrieve(support::FileName const & file); + /// get file from repo, the caller must ensure that it does not exist locally + static bool retrieve(support::FileName const & file); + + virtual std::string vcname() const { return "RCS"; }; virtual void registrer(std::string const & msg); - virtual std::string checkIn(std::string const & msg); + virtual bool renameEnabled(); + + virtual std::string rename(support::FileName const &, std::string const &); + + virtual bool copyEnabled(); + + virtual std::string copy(support::FileName const &, std::string const &); + + virtual LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log); virtual bool checkInEnabled(); @@ -206,9 +235,23 @@ public: /// return the revision file for the given file, if found static support::FileName const findFile(support::FileName const & file); + /// get file from repo, the caller must ensure that it does not exist locally + static bool retrieve(support::FileName const & file); + + virtual std::string vcname() const { return "CVS"; }; + virtual void registrer(std::string const & msg); - virtual std::string checkIn(std::string const & msg); + virtual bool renameEnabled(); + + virtual std::string rename(support::FileName const &, std::string const &); + + virtual bool copyEnabled(); + + virtual std::string copy(support::FileName const &, std::string const &); + + virtual LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log); virtual bool checkInEnabled(); @@ -333,9 +376,23 @@ public: /// return the revision file for the given file, if found static support::FileName const findFile(support::FileName const & file); + /// get file from repo, the caller must ensure that it does not exist locally + static bool retrieve(support::FileName const & file); + + virtual std::string vcname() const { return "SVN"; }; + virtual void registrer(std::string const & msg); - virtual std::string checkIn(std::string const & msg); + virtual bool renameEnabled(); + + virtual std::string rename(support::FileName const &, std::string const &); + + virtual bool copyEnabled(); + + virtual std::string copy(support::FileName const &, std::string const &); + + virtual LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log); virtual bool checkInEnabled(); @@ -384,7 +441,10 @@ protected: /// 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); + bool fileLock(bool lock, support::FileName const & tmpf, std::string & status); + /// Check in files \p f with log \p msg + LyXVC::CommandResult checkIn(std::vector const & f, + std::string const & msg, std::string & log); private: /// is the loaded file under locking policy? @@ -410,6 +470,108 @@ private: std::string rev_tree_cache_; }; + +/** + * Very basic git support: + * Remote repos are completely ignored, only the local tree is considered. + * How push and pull could be integrated with the LyX VCS interface needs + * to be discussed. + */ +class GIT : public VCS { +public: + /// + explicit + GIT(support::FileName const & m, Buffer * b); + + /// return the revision file for the given file, if found + static support::FileName const findFile(support::FileName const & file); + + /// get file from repo, the caller must ensure that it does not exist locally + static bool retrieve(support::FileName const & file); + + virtual std::string vcname() const { return "GIT"; }; + + virtual void registrer(std::string const & msg); + + virtual bool renameEnabled(); + + virtual std::string rename(support::FileName const &, std::string const &); + + virtual bool copyEnabled(); + + virtual std::string copy(support::FileName const &, std::string const &); + + virtual LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log); + + 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 bool revert(); + + virtual bool isRevertWithConfirmation(); + + virtual void undoLast(); + + virtual bool undoLastEnabled(); + + virtual void getLog(support::FileName const &); + + virtual std::string const versionString() const { + return "GIT: ?"; + } + + 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); + /// Check in files \p f with log \p msg + LyXVC::CommandResult checkIn(std::vector const & f, + std::string const & msg, std::string & log); + +private: + /** + * 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 #endif // VCBACKEND_H