anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2025-01-22 16:37:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Buffer: Make Buffer::readFile() private.

Browse Source 
It's strange to have a public interface which has a function loadLyXFile and a function readFile. A user of this class will be confused about the difference.

Therefore, loadThisLyXFile will be next to loadLyXFile to stress that loadThisLyXFile will not load another file ;). I don't know whether all of you like that this function just calls readFile, but it feels good this way. All public paths for loading a file will now go through loadThisLyXFile (i.e. the paths that come from loadLyXFile), while readFile is a pure private function. If this doesn't make sense, just shout.

I think this improves the readability of the class.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@35852 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Vincent van Ravesteijn 2010-10-26 13:17:10 +00:00
parent 9063402fca
commit f311377671
2 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/Buffer.cpp
View File

@ -3633,8 +3633,8 @@ Buffer::ReadStatus Buffer::readEmergency(FileName const & fn)
{
case 0: {
docstring str;
ReadStatus const ret_rf = readFile(emergencyFile);
bool const success = (ret_rf == ReadSuccess);
ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
bool const success = (ret_llf == ReadSuccess);
if (success) {
saveCheckSum(fn);
markDirty();
@ -3689,9 +3689,9 @@ Buffer::ReadStatus Buffer::readAutosave(FileName const & fn)
switch (ret)
{
case 0: {
ReadStatus const ret_rf = readFile(autosaveFile);
ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
// the file is not saved if we load the autosave file.
if (ret_rf == ReadSuccess) {
if (ret_llf == ReadSuccess) {
markDirty();
saveCheckSum(fn);
return ReadSuccess;
@ -3725,6 +3725,12 @@ Buffer::ReadStatus Buffer::loadLyXFile(FileName const & fn)
if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
return ret_ra;
return loadThisLyXFile(fn);
}
Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
{
return readFile(fn);
}

12
src/Buffer.h
View File

@ -189,19 +189,25 @@ public:
/// tries to extract the file from version control if it
/// cannot be found. If it can be found, it will try to
/// read an emergency save file or an autosave file.
/// \sa loadThisLyXFile
ReadStatus loadLyXFile(support::FileName const & fn);
/// Loads a LyX file \c fn into the buffer. If you want
/// to check for files in a version control container,
/// emergency or autosave files, one should use \c loadLyXFile.
/// /sa loadLyXFile
ReadStatus loadThisLyXFile(support::FileName const & fn);
/// read a new document from a string
bool readString(std::string const &);
/// Reloads the LyX file
bool reload();
//FIXME: The following two functions should be private
//FIXME: The following function should be private
//private:
/// read a new file
ReadStatus readFile(support::FileName const & fn);
/// read the header, returns number of unknown tokens
int readHeader(Lexer & lex);
private:
/// read a new file
ReadStatus readFile(support::FileName const & fn);
/// Reads a file without header.
/// \param par if != 0 insert the file.
/// \return \c true if file is not completely read.