#ifndef LYX_VC_H
#define LYX_VC_H
-#include <boost/scoped_ptr.hpp>
+#include "support/docstring.h"
+#include "support/unique_ptr.h"
#include <string>
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
*/
class LyXVC {
public:
+ /// Return status of a command
+ enum CommandResult {
+ Cancelled, ///< command was cancelled
+ ErrorBefore, ///< error before executing command
+ ErrorCommand, ///< error while executing command
+ VCSuccess ///< command was executed successfully
+ };
///
LyXVC();
- ///
- ~LyXVC();
+ /// Status of the underlying VCS
+ docstring vcstatus() const;
+ /// 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
///
void setBuffer(Buffer *);
- /// Register the document as an VC file.
+ /// Register the document as a VC file.
bool registrer();
// by the next multiple messages on the top of the processed dispatch
// machinery.
- /// Unlock and commit changes. Returns log.
- std::string checkIn();
- /// Does the current VC supports this operation?
+ ///
+ std::string rename(support::FileName const &);
+ /// Does the current VC support this operation?
+ bool renameEnabled() const;
+ ///
+ std::string copy(support::FileName const &);
+ /// Does the current VC support this operation?
+ bool copyEnabled() const;
+
+ /// Unlock and commit changes.
+ /// \p log is non-empty on success and may be empty on failure.
+ CommandResult checkIn(std::string & log);
+ /// Does the current VC support this operation?
bool checkInEnabled() const;
+ /// Should a log message be provided for next checkin?
+ bool isCheckInWithConfirmation() const;
/// Lock/update and prepare to edit document. Returns log.
std::string checkOut();
- /// Does the current VC supports this operation?
+ /// Does the current VC support this operation?
bool checkOutEnabled() const;
/// Synchronize the whole archive with repository
std::string repoUpdate();
- /// Does the current VC supports this operation?
+ /// Does the current VC support this operation?
bool repoUpdateEnabled() const;
/**
bool lockingToggleEnabled() const;
/// Revert to last version
- void revert();
+ bool revert();
/// Undo last check-in.
void undoLast();
- /// Does the current VC supports this operation?
+ /// Does the current VC support this operation?
bool undoLastEnabled() const;
+ /**
+ * Prepare revision rev of the file into newly created temporary file
+ * and save the filename into parameter f.
+ * 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(std::string const & rev, std::string & f);
+ /// Does the current VC support this operation?
+ bool prepareFileRevisionEnabled();
/**
* Generate a log file and return the filename.
* keep things in synchro once we would allow user to toggle
* read-only flags.
*/
- void toggleReadOnly();
+ std::string toggleReadOnly();
/// Is the document under administration by VCS?
+ /// returns false for unregistered documents in a path managed by VCS
bool inUse() const;
- /// FIXME Either rename or kill, we have revisionInfo now.
- /// Returns the version number.
- //std::string const & version() const;
- /// Returns the version number.
+ /// Returns the RCS + version number for messages
std::string const versionString() const;
/**
- * Returns the userid of the person who has locked the doc.
- * FIXME This property is descendant from the original VCS
- * and used in RCS for user id or "unlocked" strings.
- * It would be problem to use this under SVN since getting
- * the locker would need connection to server any time we
- * load document. SVN currently (mis)uses this as a signal
- * for locking state, as we do not have API for vcstatus().
- * The RCS code for user id parsing is working but we don't display
- * it anywhere. One possibility is to provide proper vcstatus()
- * interface and kill the whole locker thing.
+ * Returns whether we use locking for the given file.
*/
- std::string const & locker() const;
+ bool locking() const;
// type of the revision information
enum RevisionInfo {
+ Unknown = 0,
File = 1,
Tree = 2,
Author = 3,
* 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:
///
Buffer * owner_;
///
- boost::scoped_ptr<VCS> vcs;
+ unique_ptr<VCS> vcs;
};
projects / lyx.git / blobdiff