X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FVCBackend.h;h=e0f6266513f0a60553761d07481a93c90f89ad5e;hb=4ed0312c51704780af1c452d3a82a84171b3725a;hp=3b48f206e313a86b0d927a868e7b04325e84104f;hpb=b07383b026e9c9d5bd17b53877ba5986d932b29b;p=lyx.git diff --git a/src/VCBackend.h b/src/VCBackend.h index 3b48f206e3..e0f6266513 100644 --- a/src/VCBackend.h +++ b/src/VCBackend.h @@ -16,6 +16,7 @@ #include "support/FileName.h" #include +#include #include "LyXVC.h" @@ -31,16 +32,28 @@ 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 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? @@ -79,7 +92,7 @@ public: /// return the owning buffer Buffer * owner() const { return owner_; } /// return the lock status of this file - VCStatus status() const { return vcstatus; } + VCStatus status() const { return vcstatus_; } /// do we need special handling for read-only toggling? /// (also used for check-out operation) virtual bool toggleReadOnlyEnabled() = 0; @@ -90,10 +103,16 @@ public: /// 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); - + /// Check the directory given in start and all parent directories + /// for the existence of some other file + /// \param start : where we start looking (we will strip the filename if given + /// and just use the directory + /// \param file : the directory or file for which to look + /// Note that this can be e.g. ".git/index", so we will look for the .git + /// directory and also for an index file in it. + /// Returns a FileName object for the found file or else an empty FileName + static support::FileName checkParentDirs(support::FileName const & start, std::string const & file); + protected: /// parse information from the version file virtual void scanMaster() = 0; @@ -101,7 +120,7 @@ protected: /// 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, bool reportError = true); /** @@ -110,16 +129,11 @@ protected: * @param path the path from which to execute * @return exit status */ - 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 - * have full path. - */ - support::FileName master_; + static int doVCCommandCall(std::string const & cmd, + support::FileName const & path = support::FileName()); /// The status of the VC controlled file. - VCStatus vcstatus; + VCStatus vcstatus_; /// The buffer using this VC Buffer * const owner_; @@ -133,57 +147,76 @@ public: explicit RCS(support::FileName const & m, Buffer * b); - /// return the revision file for the given file, if found + /// Determine whether the file is under RCS control + /// \return the file containing the meta-data (FILE,v) if so, else empty 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); + + std::string vcname() const override { return "RCS"; } + + void registrer(std::string const & msg) override; + + bool renameEnabled() override; + + std::string rename(support::FileName const &, std::string const &) override; - virtual void registrer(std::string const & msg); + bool copyEnabled() override; - virtual std::string checkIn(std::string const & msg); + std::string copy(support::FileName const &, std::string const &) override; - virtual bool checkInEnabled(); + LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log) override; - virtual bool isCheckInWithConfirmation(); + bool checkInEnabled() override; - virtual std::string checkOut(); + bool isCheckInWithConfirmation() override; - virtual bool checkOutEnabled(); + std::string checkOut() override; - virtual std::string repoUpdate(); + bool checkOutEnabled() override; - virtual bool repoUpdateEnabled(); + std::string repoUpdate() override; - virtual std::string lockingToggle(); + bool repoUpdateEnabled() override; - virtual bool lockingToggleEnabled(); + std::string lockingToggle() override; - virtual bool revert(); + bool lockingToggleEnabled() override; - virtual bool isRevertWithConfirmation(); + bool revert() override; - virtual void undoLast(); + bool isRevertWithConfirmation() override; - virtual bool undoLastEnabled(); + void undoLast() override; - virtual void getLog(support::FileName const &); + bool undoLastEnabled() override; - virtual std::string const versionString() const { + void getLog(support::FileName const &) override; + + std::string const versionString() const override { return "RCS: " + version_; } - virtual bool toggleReadOnlyEnabled(); + bool toggleReadOnlyEnabled() override; - virtual std::string revisionInfo(LyXVC::RevisionInfo const info); + std::string revisionInfo(LyXVC::RevisionInfo const info) override; - virtual bool prepareFileRevision(std::string const & rev, std::string & f); + bool prepareFileRevision(std::string const & rev, std::string & f) override; - virtual bool prepareFileRevisionEnabled(); + bool prepareFileRevisionEnabled() override; protected: - virtual void scanMaster(); + void scanMaster() override; private: bool getRevisionInfo(); + /** + * The master VC file. For RCS this is *,v or RCS/ *,v. + * master should have full path. + */ + support::FileName master_; + /** * The version of the VC file. I am not sure if this can be a * string or if it must be a float/int. @@ -207,57 +240,72 @@ public: explicit CVS(support::FileName const & m, Buffer * b); - /// return the revision file for the given file, if found + /// Determine whether the file is under CVS control + /// \return the file containing the meta-data (CVS/entries) if so, else empty static support::FileName const findFile(support::FileName const & file); - virtual void registrer(std::string const & msg); + /// get file from repo, the caller must ensure that it does not exist locally + static bool retrieve(support::FileName const & file); + + std::string vcname() const override { return "CVS"; } - virtual std::string checkIn(std::string const & msg); + void registrer(std::string const & msg) override; - virtual bool checkInEnabled(); + bool renameEnabled() override; - virtual bool isCheckInWithConfirmation(); + std::string rename(support::FileName const &, std::string const &) override; - virtual std::string checkOut(); + bool copyEnabled() override; - virtual bool checkOutEnabled(); + std::string copy(support::FileName const &, std::string const &) override; - virtual std::string repoUpdate(); + LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log) override; - virtual bool repoUpdateEnabled(); + bool checkInEnabled() override; - virtual std::string lockingToggle(); + bool isCheckInWithConfirmation() override; - virtual bool lockingToggleEnabled(); + std::string checkOut() override; - virtual bool isRevertWithConfirmation(); + bool checkOutEnabled() override; - virtual bool revert(); + std::string repoUpdate() override; - virtual void undoLast(); + bool repoUpdateEnabled() override; - virtual bool undoLastEnabled(); + std::string lockingToggle() override; - virtual void getLog(support::FileName const &); + bool lockingToggleEnabled() override; - /// Check for messages in cvs output. + bool isRevertWithConfirmation() override; + + bool revert() override; + + void undoLast() override; + + bool undoLastEnabled() override; + + void getLog(support::FileName const &) override; + + /// 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 { + std::string const versionString() const override { return "CVS: " + version_; } - virtual bool toggleReadOnlyEnabled(); + bool toggleReadOnlyEnabled() override; - virtual std::string revisionInfo(LyXVC::RevisionInfo const info); + std::string revisionInfo(LyXVC::RevisionInfo const info) override; - virtual bool prepareFileRevision(std::string const & rev, std::string & f); + bool prepareFileRevision(std::string const & rev, std::string & f) override; - virtual bool prepareFileRevisionEnabled(); + bool prepareFileRevisionEnabled() override; protected: - virtual void scanMaster(); + void scanMaster() override; /// the mode of operation for some VC commands enum OperationMode { Directory = 0, @@ -275,6 +323,11 @@ protected: }; private: + /** + * The master VC file. For CVS this is CVS/Entries + * master should have full path. + */ + support::FileName master_; // revision number from scanMaster std::string version_; @@ -295,26 +348,26 @@ private: 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; + 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(); + int edit(); /// revert the edit operation - virtual int unedit(); + int unedit(); /// retrieve repository changes into working copy - virtual int update(OperationMode opmode, support::FileName const & tmpf); + int update(OperationMode opmode, support::FileName const & tmpf); /// check readonly state for file /// assume true when file is writable - virtual bool isLocked() const; + bool isLocked() const; /// query and parse the cvs status of file - virtual CvsStatus getStatus(); + CvsStatus getStatus(); /// convert enum to string - virtual docstring toString(CvsStatus status) const; + docstring toString(CvsStatus status) const; /// cache the info values of current file revision /// author, date and time of commit @@ -332,55 +385,69 @@ class SVN : public VCS { public: /// explicit - SVN(support::FileName const & m, Buffer * b); + SVN(Buffer * b); - /// return the revision file for the given file, if found - static support::FileName const findFile(support::FileName const & file); + /// Determine whether the file is under SVN control + static bool 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 void registrer(std::string const & msg); + std::string vcname() const override { return "SVN"; } - virtual std::string checkIn(std::string const & msg); + void registrer(std::string const & msg) override; - virtual bool checkInEnabled(); + bool renameEnabled() override; - virtual bool isCheckInWithConfirmation(); + std::string rename(support::FileName const &, std::string const &) override; - virtual std::string checkOut(); + bool copyEnabled() override; - virtual bool checkOutEnabled(); + std::string copy(support::FileName const &, std::string const &) override; - virtual std::string repoUpdate(); + LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log) override; - virtual bool repoUpdateEnabled(); + bool checkInEnabled() override; - virtual std::string lockingToggle(); + bool isCheckInWithConfirmation() override; - virtual bool lockingToggleEnabled(); + std::string checkOut() override; - virtual bool revert(); + bool checkOutEnabled() override; - virtual bool isRevertWithConfirmation(); + std::string repoUpdate() override; - virtual void undoLast(); + bool repoUpdateEnabled() override; - virtual bool undoLastEnabled(); + std::string lockingToggle() override; - virtual void getLog(support::FileName const &); + bool lockingToggleEnabled() override; - virtual std::string const versionString() const { + bool revert() override; + + bool isRevertWithConfirmation() override; + + void undoLast() override; + + bool undoLastEnabled() override; + + void getLog(support::FileName const &) override; + + std::string const versionString() const override { return "SVN: " + rev_file_cache_; } - virtual bool toggleReadOnlyEnabled(); + bool toggleReadOnlyEnabled() override; - virtual std::string revisionInfo(LyXVC::RevisionInfo const info); + std::string revisionInfo(LyXVC::RevisionInfo const info) override; - virtual bool prepareFileRevision(std::string const & rev, std::string & f); + bool prepareFileRevision(std::string const & rev, std::string & f) override; - virtual bool prepareFileRevisionEnabled(); + bool prepareFileRevisionEnabled() override; protected: - virtual void scanMaster(); + void scanMaster() override; /// 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_ @@ -388,7 +455,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? @@ -414,6 +484,111 @@ 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(Buffer * b); + + /// Determine whether the file is under GIT control + /// \return the file itself if so, else empty + static bool 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); + + std::string vcname() const override { return "GIT"; } + + void registrer(std::string const & msg) override; + + bool renameEnabled() override; + + std::string rename(support::FileName const &, std::string const &) override; + + bool copyEnabled() override; + + std::string copy(support::FileName const &, std::string const &) override; + + LyXVC::CommandResult + checkIn(std::string const & msg, std::string & log) override; + + bool checkInEnabled() override; + + bool isCheckInWithConfirmation() override; + + std::string checkOut() override; + + bool checkOutEnabled() override; + + std::string repoUpdate() override; + + bool repoUpdateEnabled() override; + + std::string lockingToggle() override; + + bool lockingToggleEnabled() override; + + bool revert() override; + + bool isRevertWithConfirmation() override; + + void undoLast() override; + + bool undoLastEnabled() override; + + void getLog(support::FileName const &) override; + + std::string const versionString() const override { + return "GIT: ?"; + } + + bool toggleReadOnlyEnabled() override; + + std::string revisionInfo(LyXVC::RevisionInfo const info) override; + + bool prepareFileRevision(std::string const & rev, std::string & f) override; + + bool prepareFileRevisionEnabled() override; + +protected: + void scanMaster() override; + /// 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 abbreviated file revision number, "?" if already unsuccessful, isNumber==true + std::string rev_file_abbrev_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