]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Buffer: Rename function names:
[lyx.git] / src / Buffer.cpp
index 48183518de492a18ec87e83b5a95c081d1ba8e48..ad14807e10f4bc30a11d27b554f94eab00274dd4 100644 (file)
@@ -835,22 +835,24 @@ bool Buffer::readString(string const & s)
        Lexer lex;
        istringstream is(s);
        lex.setStream(is);
-       FileName const name = FileName::tempName("Buffer_readString");
-       switch (readFile(lex, name, true)) {
-       case ReadFailure:
-               return false;
+       FileName const fn = FileName::tempName("Buffer_readString");
 
-       case ReadWrongVersion: {
+       int file_format;
+       ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
+       if (ret_plf != ReadSuccess)
+               return ret_plf;
+
+       if (file_format != LYX_FORMAT) {
                // We need to call lyx2lyx, so write the input to a file
-               ofstream os(name.toFilesystemEncoding().c_str());
+               ofstream os(fn.toFilesystemEncoding().c_str());
                os << s;
                os.close();
-               return readFile(name);
-       }
-       default:
-               break;
+               // lyxvc in readFile
+               return readFile(fn) == ReadSuccess;
        }
 
+       if (readDocument(lex))
+               return false;
        return true;
 }
 
@@ -861,10 +863,28 @@ Buffer::ReadStatus Buffer::readFile(FileName const & fn)
        Lexer lex;
        lex.setFile(fname);
 
-       ReadStatus const ret_rf = readFile(lex, fname);
-       if (ret_rf != ReadSuccess)
-               return ret_rf;
+       int file_format;
+       ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
+       if (ret_plf != ReadSuccess)
+               return ret_plf;
+
+       if (file_format != LYX_FORMAT) {
+               FileName tmpFile;
+               ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
+               if (ret_clf != ReadSuccess)
+                       return ret_clf;
+               return readFile(tmpFile);
+       }
 
+       if (readDocument(lex)) {
+               Alert::error(_("Document format failure"),
+                       bformat(_("%1$s ended unexpectedly, which means"
+                               " that it is probably corrupted."),
+                                       from_utf8(fn.absFileName())));
+               return ReadDocumentFailure;
+       }
+
+       d->file_fully_loaded = true;
        // InsetInfo needs to know if file is under VCS
        lyxvc().file_found_hook(fn);
        d->read_only = !fname.isWritable();
@@ -910,80 +930,61 @@ Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
 }
 
 
-Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & fn,
-               bool fromstring)
+Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn, 
+       FileName & tmpfile, int from_format)
 {
-       int file_format;
-       ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
-       if (ret_plf != ReadSuccess)
-               return ret_plf;
-
-       if (file_format != LYX_FORMAT) {
-               if (fromstring)
-                       // lyx2lyx would fail
-                       return ReadWrongVersion;
-
-               FileName const tmpfile = FileName::tempName("Buffer_readFile");
-               if (tmpfile.empty()) {
-                       Alert::error(_("Conversion failed"),
-                                    bformat(_("%1$s is from a different"
-                                             " version of LyX, but a temporary"
-                                             " file for converting it could"
-                                             " not be created."),
-                                             from_utf8(fn.absFileName())));
-                       return ReadFailure;
-               }
-               FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
-               if (lyx2lyx.empty()) {
-                       Alert::error(_("Conversion script not found"),
-                                    bformat(_("%1$s is from a different"
-                                              " version of LyX, but the"
-                                              " conversion script lyx2lyx"
-                                              " could not be found."),
-                                              from_utf8(fn.absFileName())));
-                       return ReadFailure;
-               }
-               ostringstream command;
-               command << os::python()
-                       << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
-                       << " -t " << convert<string>(LYX_FORMAT)
-                       << " -o " << quoteName(tmpfile.toFilesystemEncoding())
-                       << ' ' << quoteName(fn.toSafeFilesystemEncoding());
-               string const command_str = command.str();
-
-               LYXERR(Debug::INFO, "Running '" << command_str << '\'');
-
-               cmd_ret const ret = runCommand(command_str);
-               if (ret.first != 0) {
-                       if (file_format < LYX_FORMAT)
-                               Alert::error(_("Conversion script failed"),
-                                    bformat(_("%1$s is from an older version"
-                                             " of LyX, but the lyx2lyx script"
-                                             " failed to convert it."),
-                                             from_utf8(fn.absFileName())));
-                       else
-                               Alert::error(_("Conversion script failed"),
-                                    bformat(_("%1$s is from a newer version"
-                                             " of LyX and cannot be converted by the"
-                                                               " lyx2lyx script."),
-                                             from_utf8(fn.absFileName())));
-                       return ReadFailure;
-               } else {
-                       // Do stuff with tmpfile name and buffer name here.
-                       return readFile(tmpfile);
-               }
-
+       tmpfile = FileName::tempName("Buffer_convertLyXFormat");
+       if(tmpfile.empty()) {
+               Alert::error(_("Conversion failed"),
+                       bformat(_("%1$s is from a different"
+                               " version of LyX, but a temporary"
+                               " file for converting it could"
+                               " not be created."),
+                               from_utf8(fn.absFileName())));
+               return LyX2LyXNoTempFile;
        }
 
-       if (readDocument(lex)) {
-               Alert::error(_("Document format failure"),
-                            bformat(_("%1$s ended unexpectedly, which means"
-                                                   " that it is probably corrupted."),
-                                      from_utf8(fn.absFileName())));
-               return ReadFailure;
+       FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
+       if (lyx2lyx.empty()) {
+               Alert::error(_("Conversion script not found"),
+                    bformat(_("%1$s is from a different"
+                              " version of LyX, but the"
+                              " conversion script lyx2lyx"
+                              " could not be found."),
+                              from_utf8(fn.absFileName())));
+               return LyX2LyXNotFound;
        }
 
-       d->file_fully_loaded = true;
+       // Run lyx2lyx:
+       //   $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
+       ostringstream command;
+       command << os::python()
+               << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
+               << " -t " << convert<string>(LYX_FORMAT)
+               << " -o " << quoteName(tmpfile.toFilesystemEncoding())
+               << ' ' << quoteName(fn.toSafeFilesystemEncoding());
+       string const command_str = command.str();
+
+       LYXERR(Debug::INFO, "Running '" << command_str << '\'');
+
+       cmd_ret const ret = runCommand(command_str);
+       if (ret.first != 0) {
+               if (from_format < LYX_FORMAT) {
+                       Alert::error(_("Conversion script failed"),
+                               bformat(_("%1$s is from an older version"
+                                       " of LyX, but the lyx2lyx script"
+                                       " failed to convert it."),
+                                       from_utf8(fn.absFileName())));
+                       return LyX2LyXOlderFormat;
+               } else {
+                       Alert::error(_("Conversion script failed"),
+                               bformat(_("%1$s is from an newer version"
+                                       " of LyX, but the lyx2lyx script"
+                                       " failed to convert it."),
+                                       from_utf8(fn.absFileName())));
+                       return LyX2LyXNewerFormat;
+               }
+       }
        return ReadSuccess;
 }
 
@@ -3603,7 +3604,7 @@ vector<string> Buffer::backends() const
 }
 
 
-Buffer::ReadStatus Buffer::readFromVC(FileName const & fn)
+Buffer::ReadStatus Buffer::extractFromVC(FileName const & fn)
 {
        bool const found = LyXVC::file_not_found_hook(fn);
        if (!found)
@@ -3614,7 +3615,7 @@ Buffer::ReadStatus Buffer::readFromVC(FileName const & fn)
 }
 
 
-Buffer::ReadStatus Buffer::readEmergency(FileName const & fn)
+Buffer::ReadStatus Buffer::loadEmergency(FileName const & fn)
 {
        FileName const emergencyFile = getEmergencyFileNameFor(fn);
        if (!emergencyFile.exists() 
@@ -3624,40 +3625,45 @@ Buffer::ReadStatus Buffer::readEmergency(FileName const & fn)
        docstring const file = makeDisplayPath(fn.absFileName(), 20);
        docstring const text = bformat(_("An emergency save of the document "
                "%1$s exists.\n\nRecover emergency save?"), file);
-       int const ret = Alert::prompt(_("Load emergency save?"), text,
+       
+       int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
                0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
 
-       switch (ret)
+       switch (load_emerg)
        {
        case 0: {
-               // the file is not saved if we load the emergency file.
-               markDirty();
                docstring str;
-               bool res;
-               ReadStatus const ret_rf = readFile(emergencyFile);
-               if (res = (ret_rf == ReadSuccess)) {
+               ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
+               bool const success = (ret_llf == ReadSuccess);
+               if (success) {
                        saveCheckSum(fn);
+                       markDirty();
                        str = _("Document was successfully recovered.");
                } else
                        str = _("Document was NOT successfully recovered.");
                str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
                                        makeDisplayPath(emergencyFile.absFileName()));
 
-               if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
-                               _("&Remove"), _("&Keep"))) {
+               int const del_emerg = 
+                       Alert::prompt(_("Delete emergency file?"), str, 1, 1,
+                               _("&Remove"), _("&Keep"));
+               if (del_emerg == 0) {
                        emergencyFile.removeFile();
-                       if (res)
+                       if (success)
                                Alert::warning(_("Emergency file deleted"),
                                        _("Do not forget to save your file now!"), true);
                        }
-               return res ? ReadSuccess : ReadEmergencyFailure;
+               return success ? ReadSuccess : ReadEmergencyFailure;
        }
-       case 1:
-               if (!Alert::prompt(_("Delete emergency file?"),
+       case 1: {
+               int const del_emerg =
+                       Alert::prompt(_("Delete emergency file?"),
                                _("Remove emergency file now?"), 1, 1,
-                               _("&Remove"), _("&Keep")))
+                               _("&Remove"), _("&Keep"));
+               if (del_emerg == 0)
                        emergencyFile.removeFile();
                return ReadOriginal;
+       }
 
        default:
                break;
@@ -3666,7 +3672,7 @@ Buffer::ReadStatus Buffer::readEmergency(FileName const & fn)
 }
 
 
-Buffer::ReadStatus Buffer::readAutosave(FileName const & fn)
+Buffer::ReadStatus Buffer::loadAutosave(FileName const & fn)
 {
        // Now check if autosave file is newer.
        FileName const autosaveFile = getAutosaveFileNameFor(fn);
@@ -3683,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;
@@ -3706,19 +3712,25 @@ Buffer::ReadStatus Buffer::readAutosave(FileName const & fn)
 Buffer::ReadStatus Buffer::loadLyXFile(FileName const & fn)
 {
        if (!fn.isReadableFile()) {
-               ReadStatus const ret_rvc = readFromVC(fn);
+               ReadStatus const ret_rvc = extractFromVC(fn);
                if (ret_rvc != ReadSuccess)
                        return ret_rvc;
        }
 
-       ReadStatus const ret_re = readEmergency(fn);
+       ReadStatus const ret_re = loadEmergency(fn);
        if (ret_re == ReadSuccess || ret_re == ReadCancel)
                return ret_re;
        
-       ReadStatus const ret_ra = readAutosave(fn);
+       ReadStatus const ret_ra = loadAutosave(fn);
        if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
                return ret_ra;
 
+       return loadThisLyXFile(fn);
+}
+
+
+Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
+{
        return readFile(fn);
 }