X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxvc.h;h=6ce52cbb23dd7d8c04b0041f5c74d6c703c23d3f;hb=b9aa557b359463dfb0a2132b665570c8d1e5d605;hp=75bc7871cd89c7b8e00ac4dea02a63287a2ce2ec;hpb=35058c638ea817a58d1c72119dba1879d79c6302;p=lyx.git diff --git a/src/lyxvc.h b/src/lyxvc.h index 75bc7871cd..6ce52cbb23 100644 --- a/src/lyxvc.h +++ b/src/lyxvc.h @@ -1,13 +1,25 @@ // -*- C++ -*- +/** + * \file lyxvc.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. + * + * \author Lars Gullik Bjønnes + * + * Full author contact details are available in file CREDITS. + */ #ifndef LYX_VC_H #define LYX_VC_H -#ifdef __GNUG__ -#pragma interface -#endif +#include + +#include + -#include "LString.h" +namespace lyx { + +namespace support { class FileName; } class VCS; class Buffer; @@ -19,7 +31,7 @@ class Buffer; The support in LyX is based loosely upon the version control in GNU Emacs, but is not as extensive as that one. See examples/VC.lyx for a simple tutorial and manual for the use of the version control system in LyX. - + LyXVC use this algorithm when it searches for VC files: for RCS it searches for ,v and RCS/,v similar should be done for CVS. By doing this there doesn't need to be any @@ -39,8 +51,8 @@ public: the appropiate actions is taken. Returns true if the file is under control by a VCS. */ - bool file_found_hook(string const & fn); - + bool file_found_hook(support::FileName const & fn); + /** 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 @@ -48,7 +60,7 @@ public: viewing/editing. Returns true if the file is under control by a VCS and the user wants to view/edit it. */ - static bool file_not_found_hook(string const & fn); + static bool file_not_found_hook(support::FileName const & fn); /// void buffer(Buffer *); @@ -73,28 +85,31 @@ public: * It is the caller's responsibility to unlink the * file after use. */ - const string getLogFile() const; + const std::string getLogFile() const; - /// + /// void toggleReadOnly(); - + /// Is the document under administration by RCS? bool inUse(); /// Returns the version number. - //string const & version() const; + //std::string const & version() const; /// Returns the version number. - string const versionString() const; + std::string const versionString() const; /// Returns the userid of the person who has locked the doc. - string const & locker() const; + std::string const & locker() const; private: /// Buffer * owner_; - + /// - VCS * vcs; + boost::scoped_ptr vcs; }; + +} // namespace lyx + #endif