]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.C
* src/CutAndPaste.C:
[lyx.git] / src / buffer.C
index 818a18341cba8ed0b5ff08af67a7aafb37282008..155b8b6047309c4e9cc2afa890a1dad524614e8d 100644 (file)
@@ -36,7 +36,6 @@
 #include "lyxtext.h"
 #include "lyxrc.h"
 #include "lyxvc.h"
-#include "lyx_main.h"
 #include "messages.h"
 #include "output.h"
 #include "output_docbook.h"
@@ -101,8 +100,8 @@ using support::changeExtension;
 using support::cmd_ret;
 using support::createBufferTmpDir;
 using support::destroyDir;
+using support::FileName;
 using support::getFormatFromContents;
-using support::isDirWriteable;
 using support::libFileSearch;
 using support::latex_path;
 using support::ltrim;
@@ -129,7 +128,6 @@ using std::endl;
 using std::for_each;
 using std::make_pair;
 
-using std::ifstream;
 using std::ios;
 using std::map;
 using std::ostream;
@@ -143,7 +141,7 @@ using std::string;
 
 namespace {
 
-int const LYX_FORMAT = 255;
+int const LYX_FORMAT = 256;
 
 } // namespace anon
 
@@ -153,7 +151,7 @@ typedef std::map<string, bool> DepClean;
 class Buffer::Impl
 {
 public:
-       Impl(Buffer & parent, string const & file, bool readonly);
+       Impl(Buffer & parent, FileName const & file, bool readonly);
 
        limited_stack<Undo> undostack;
        limited_stack<Undo> redostack;
@@ -178,9 +176,9 @@ public:
        bool read_only;
 
        /// name of the file the buffer is associated with.
-       string filename;
+       FileName filename;
 
-       boost::scoped_ptr<Messages> messages;
+       Messages * messages;
 
        /** Set to true only when the file is fully loaded.
         *  Used to prevent the premature generation of previews
@@ -199,15 +197,15 @@ public:
 };
 
 
-Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
+Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
        : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
-         filename(file), file_fully_loaded(false), inset(params),
+         filename(file), messages(0), file_fully_loaded(false), inset(params),
          toc_backend(&parent)
 {
        inset.setAutoBreakRows(true);
        lyxvc.buffer(&parent);
        temppath = createBufferTmpDir();
-       params.filepath = onlyPath(file);
+       params.filepath = onlyPath(file.absFilename());
        // FIXME: And now do something if temppath == string(), because we
        // assume from now on that temppath points to a valid temp dir.
        // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
@@ -215,7 +213,7 @@ Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
 
 
 Buffer::Buffer(string const & file, bool readonly)
-       : pimpl_(new Impl(*this, file, readonly))
+       : pimpl_(new Impl(*this, FileName(file), readonly))
 {
        lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
 }
@@ -229,7 +227,7 @@ Buffer::~Buffer()
 
        closing();
 
-       if (!temppath().empty() && !destroyDir(temppath())) {
+       if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
                Alert::warning(_("Could not remove temporary directory"),
                        bformat(_("Could not remove the temporary directory %1$s"),
                        from_utf8(temppath())));
@@ -358,23 +356,24 @@ pair<Buffer::LogType, string> const Buffer::getLogName() const
 
        string const path = temppath();
 
-       string const fname = addName(path,
+       FileName const fname(addName(temppath(),
                                     onlyFilename(changeExtension(filename,
-                                                                 ".log")));
-       string const bname =
+                                                                 ".log"))));
+       FileName const bname(
                addName(path, onlyFilename(
                        changeExtension(filename,
-                                       formats.extension("literate") + ".out")));
+                                       formats.extension("literate") + ".out"))));
 
        // If no Latex log or Build log is newer, show Build log
 
-       if (fs::exists(bname) &&
-           (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
+       if (fs::exists(bname.toFilesystemEncoding()) &&
+           (!fs::exists(fname.toFilesystemEncoding()) ||
+            fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
                lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
-               return make_pair(Buffer::buildlog, bname);
+               return make_pair(Buffer::buildlog, bname.absFilename());
        }
        lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
-       return make_pair(Buffer::latexlog, fname);
+       return make_pair(Buffer::latexlog, fname.absFilename());
 }
 
 
@@ -390,8 +389,8 @@ void Buffer::setReadonly(bool const flag)
 void Buffer::setFileName(string const & newfile)
 {
        pimpl_->filename = makeAbsPath(newfile);
-       params().filepath = onlyPath(pimpl_->filename);
-       setReadonly(fs::is_readonly(pimpl_->filename));
+       params().filepath = onlyPath(pimpl_->filename.absFilename());
+       setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
        updateTitles();
 }
 
@@ -500,7 +499,7 @@ bool Buffer::readDocument(LyXLex & lex)
                string theclass = params().getLyXTextClass().name();
                Alert::error(_("Can't load document class"), bformat(
                        _("Using the default document class, because the "
-                                    " class %1$s could not be loaded."), from_utf8(theclass)));
+                                    "class %1$s could not be loaded."), from_utf8(theclass)));
                params().textclass = 0;
        }
 
@@ -508,7 +507,6 @@ bool Buffer::readDocument(LyXLex & lex)
        for_each(text().paragraphs().begin(),
                 text().paragraphs().end(),
                 bind(&Paragraph::setInsetOwner, _1, &inset()));
-       updateBibfilesCache();
 
        return res;
 }
@@ -568,7 +566,40 @@ void Buffer::insertStringAsLines(ParagraphList & pars,
 }
 
 
-bool Buffer::readFile(string const & filename)
+bool Buffer::readString(std::string const & s)
+{
+       params().compressed = false;
+
+       // remove dummy empty par
+       paragraphs().clear();
+       LyXLex lex(0, 0);
+       std::istringstream is(s);
+       lex.setStream(is);
+       FileName const name(tempName());
+       switch (readFile(lex, name)) {
+       case failure:
+               return false;
+       case wrongversion: {
+               // We need to call lyx2lyx, so write the input to a file
+               std::ofstream os(name.toFilesystemEncoding().c_str());
+               os << s;
+               os.close();
+               return readFile(name) == success;
+       }
+       case success:
+               break;
+       }
+
+       // After we have read a file, we must ensure that the buffer
+       // language is set and used in the gui.
+       // If you know of a better place to put this, please tell me. (Lgb)
+       updateDocLang(params().language);
+
+       return true;
+}
+
+
+bool Buffer::readFile(FileName const & filename)
 {
        // Check if the file is compressed.
        string const format = getFormatFromContents(filename);
@@ -580,7 +611,7 @@ bool Buffer::readFile(string const & filename)
        paragraphs().clear();
        LyXLex lex(0, 0);
        lex.setFile(filename);
-       if (!readFile(lex, filename))
+       if (readFile(lex, filename) != success)
                return false;
 
        // After we have read a file, we must ensure that the buffer
@@ -604,14 +635,15 @@ void Buffer::fully_loaded(bool const value)
 }
 
 
-bool Buffer::readFile(LyXLex & lex, string const & filename)
+Buffer::ReadStatus Buffer::readFile(LyXLex & lex, FileName const & filename,
+               bool fromstring)
 {
        BOOST_ASSERT(!filename.empty());
 
        if (!lex.isOK()) {
                Alert::error(_("Document could not be read"),
-                            bformat(_("%1$s could not be read."), from_utf8(filename)));
-               return false;
+                            bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
+               return failure;
        }
 
        lex.next();
@@ -619,8 +651,8 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
 
        if (!lex.isOK()) {
                Alert::error(_("Document could not be read"),
-                            bformat(_("%1$s could not be read."), from_utf8(filename)));
-               return false;
+                            bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
+               return failure;
        }
 
        // the first token _must_ be...
@@ -629,8 +661,8 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
 
                Alert::error(_("Document format failure"),
                             bformat(_("%1$s is not a LyX document."),
-                                      from_utf8(filename)));
-               return false;
+                                      from_utf8(filename.absFilename())));
+               return failure;
        }
 
        lex.next();
@@ -645,31 +677,37 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
        //lyxerr << "format: " << file_format << endl;
 
        if (file_format != LYX_FORMAT) {
-               string const tmpfile = tempName();
+
+               if (fromstring)
+                       // lyx2lyx would fail
+                       return wrongversion;
+
+               FileName const tmpfile(tempName());
                if (tmpfile.empty()) {
                        Alert::error(_("Conversion failed"),
                                     bformat(_("%1$s is from an earlier"
                                              " version of LyX, but a temporary"
                                              " file for converting it could"
                                                            " not be created."),
-                                             from_utf8(filename)));
-                       return false;
+                                             from_utf8(filename.absFilename())));
+                       return failure;
                }
-               string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
+               FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
                if (lyx2lyx.empty()) {
                        Alert::error(_("Conversion script not found"),
                                     bformat(_("%1$s is from an earlier"
                                               " version of LyX, but the"
                                               " conversion script lyx2lyx"
                                                            " could not be found."),
-                                              from_utf8(filename)));
-                       return false;
+                                              from_utf8(filename.absFilename())));
+                       return failure;
                }
                ostringstream command;
-               command << os::python() << ' ' << quoteName(lyx2lyx)
-                       << " -t " << convert<string>(LYX_FORMAT)
-                       << " -o " << quoteName(tmpfile) << ' '
-                       << quoteName(filename);
+               command << os::python()
+                       << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
+                       << " -t " << convert<string>(LYX_FORMAT)
+                       << " -o " << quoteName(tmpfile.toFilesystemEncoding())
+                       << ' ' << quoteName(filename.toFilesystemEncoding());
                string const command_str = command.str();
 
                lyxerr[Debug::INFO] << "Running '"
@@ -682,12 +720,12 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
                                     bformat(_("%1$s is from an earlier version"
                                              " of LyX, but the lyx2lyx script"
                                                            " failed to convert it."),
-                                             from_utf8(filename)));
-                       return false;
+                                             from_utf8(filename.absFilename())));
+                       return failure;
                } else {
                        bool const ret = readFile(tmpfile);
                        // Do stuff with tmpfile name and buffer name here.
-                       return ret;
+                       return ret ? success : failure;
                }
 
        }
@@ -696,7 +734,7 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
                Alert::error(_("Document format failure"),
                             bformat(_("%1$s ended unexpectedly, which means"
                                                    " that it is probably corrupted."),
-                                      from_utf8(filename)));
+                                      from_utf8(filename.absFilename())));
        }
 
        //lyxerr << "removing " << MacroTable::localMacros().size()
@@ -704,7 +742,7 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
        //MacroTable::localMacros().clear();
 
        pimpl_->file_fully_loaded = true;
-       return true;
+       return success;
 }
 
 
@@ -714,70 +752,69 @@ bool Buffer::save() const
        // We don't need autosaves in the immediate future. (Asger)
        resetAutosaveTimers();
 
-       // make a backup
-       string s;
-       if (lyxrc.make_backup) {
-               s = fileName() + '~';
+       string const encodedFilename = pimpl_->filename.toFilesystemEncoding();
+
+       FileName backupName;
+       bool madeBackup = false;
+
+       // make a backup if the file already exists
+       if (lyxrc.make_backup && fs::exists(encodedFilename)) {
+               backupName = FileName(fileName() + '~');
                if (!lyxrc.backupdir_path.empty())
-                       s = addName(lyxrc.backupdir_path,
-                                   subst(os::internal_path(s),'/','!'));
+                       backupName = FileName(addName(lyxrc.backupdir_path,
+                                             subst(os::internal_path(backupName.absFilename()), '/', '!')));
 
-               // It might very well be that this variant is just
-               // good enough. (Lgb)
-               // But to use this we need fs::copy_file to actually do a copy,
-               // even when the target file exists. (Lgb)
                try {
-                   fs::copy_file(fileName(), s, false);
-               }
-               catch (fs::filesystem_error const & fe) {
+                       fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
+                       madeBackup = true;
+               catch (fs::filesystem_error const & fe) {
                        Alert::error(_("Backup failure"),
-                                    bformat(_("LyX was not able to make a backup copy in %1$s.\n"
-                                                           "Please check if the directory exists and is writeable."),
-                                         from_utf8(fs::path(s).branch_path().native_directory_string())));
-                       lyxerr[Debug::DEBUG] << "Fs error: "
-                                            << fe.what() << endl;
+                                    bformat(_("Cannot create backup file %1$s.\n"
+                                              "Please check whether the directory exists and is writeable."),
+                                            from_utf8(backupName.absFilename())));
+                       lyxerr[Debug::DEBUG] << "Fs error: " << fe.what() << endl;
                }
        }
 
-       if (writeFile(fileName())) {
+       if (writeFile(pimpl_->filename)) {
                markClean();
                removeAutosaveFile(fileName());
+               return true;
        } else {
                // Saving failed, so backup is not backup
-               if (lyxrc.make_backup)
-                       rename(s, fileName());
+               if (madeBackup)
+                       rename(backupName, pimpl_->filename);
                return false;
        }
-       return true;
 }
 
 
-bool Buffer::writeFile(string const & fname) const
+bool Buffer::writeFile(FileName const & fname) const
 {
-       if (pimpl_->read_only && fname == fileName())
+       if (pimpl_->read_only && fname == pimpl_->filename)
                return false;
 
        bool retval = false;
 
        if (params().compressed) {
-               io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
+               io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname.toFilesystemEncoding()));
                if (!ofs)
                        return false;
 
-               retval = do_writeFile(ofs);
+               retval = write(ofs);
        } else {
-               ofstream ofs(fname.c_str(), ios::out|ios::trunc);
+               ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
                if (!ofs)
                        return false;
 
-               retval = do_writeFile(ofs);
+               retval = write(ofs);
        }
 
        return retval;
 }
 
 
-bool Buffer::do_writeFile(ostream & ofs) const
+bool Buffer::write(ostream & ofs) const
 {
 #ifdef HAVE_LOCALE
        // Use the standard "C" locale for file output.
@@ -826,25 +863,12 @@ bool Buffer::do_writeFile(ostream & ofs) const
 }
 
 
-bool Buffer::makeLaTeXFile(string const & fname,
+bool Buffer::makeLaTeXFile(FileName const & fname,
                           string const & original_path,
                           OutputParams const & runparams,
                           bool output_preamble, bool output_body)
 {
-       string encoding;
-       if (params().inputenc == "auto")
-               encoding = params().language->encoding()->iconvName();
-       else {
-               Encoding const * enc = encodings.getFromLaTeXName(params().inputenc);
-               if (enc)
-                       encoding = enc->iconvName();
-               else {
-                       lyxerr << "Unknown inputenc value `"
-                              << params().inputenc
-                              << "'. Using `auto' instead." << endl;
-                       encoding = params().language->encoding()->iconvName();
-               }
-       }
+       string const encoding = params().encoding().iconvName();
        lyxerr[Debug::LATEX] << "makeLaTeXFile encoding: "
                << encoding << "..." << endl;
 
@@ -1022,7 +1046,7 @@ bool Buffer::isDocBook() const
 }
 
 
-void Buffer::makeDocBookFile(string const & fname,
+void Buffer::makeDocBookFile(FileName const & fname,
                              OutputParams const & runparams,
                              bool const body_only)
 {
@@ -1033,7 +1057,7 @@ void Buffer::makeDocBookFile(string const & fname,
        if (!openFileWrite(ofs, fname))
                return;
 
-       writeDocBookSource(ofs, fname, runparams, body_only);
+       writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
 
        ofs.close();
        if (ofs.fail())
@@ -1077,7 +1101,7 @@ void Buffer::writeDocBookSource(odocstream & os, string const & fname,
                        preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
                }
 
-               string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
+               string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
                         : fname;
                preamble += features.getIncludedFiles(name);
                preamble += features.getLyXSGMLEntities();
@@ -1121,7 +1145,7 @@ int Buffer::runChktex()
        busy(true);
 
        // get LaTeX-Filename
-       string const name = getLatexName();
+       string const name = getLatexName(false);
        string const path = temppath();
        string const org_path = filePath();
 
@@ -1132,10 +1156,10 @@ int Buffer::runChktex()
        OutputParams runparams;
        runparams.flavor = OutputParams::LATEX;
        runparams.nice = false;
-       makeLaTeXFile(name, org_path, runparams);
+       makeLaTeXFile(FileName(name), org_path, runparams);
 
        TeXErrors terr;
-       Chktex chktex(lyxrc.chktex_command, name, filePath());
+       Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
        int const res = chktex.run(terr); // run chktex
 
        if (res == -1) {
@@ -1221,7 +1245,7 @@ void Buffer::getLabelList(vector<docstring> & list) const
 
 
 // This is also a buffer property (ale)
-void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
+void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
        const
 {
        /// if this is a child document and the parent is already loaded
@@ -1245,11 +1269,12 @@ void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
                } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
                        InsetBibitem const & inset =
                                dynamic_cast<InsetBibitem const &>(*it);
-                       string const key = inset.getContents();
-                       string const opt = inset.getOptions();
-                       string const ref; // = pit->asString(this, false);
-                       string const info = opt + "TheBibliographyRef" + ref;
-                       keys.push_back(pair<string, string>(key, info));
+                       // FIXME UNICODE
+                       string const key = to_utf8(inset.getParam("key"));
+                       docstring const label = inset.getParam("label");
+                       docstring const ref; // = pit->asString(this, false);
+                       docstring const info = label + "TheBibliographyRef" + ref;
+                       keys.push_back(pair<string, docstring>(key, info));
                }
        }
 }
@@ -1271,7 +1296,7 @@ void Buffer::updateBibfilesCache()
                if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
                        InsetBibtex const & inset =
                                dynamic_cast<InsetBibtex const &>(*it);
-                       vector<string> const bibfiles = inset.getFiles(*this);
+                       vector<FileName> const bibfiles = inset.getFiles(*this);
                        bibfilesCache_.insert(bibfilesCache_.end(),
                                bibfiles.begin(),
                                bibfiles.end());
@@ -1279,7 +1304,7 @@ void Buffer::updateBibfilesCache()
                        InsetInclude & inset =
                                dynamic_cast<InsetInclude &>(*it);
                        inset.updateBibfilesCache(*this);
-                       vector<string> const & bibfiles =
+                       vector<FileName> const & bibfiles =
                                        inset.getBibfilesCache(*this);
                        bibfilesCache_.insert(bibfilesCache_.end(),
                                bibfiles.begin(),
@@ -1289,7 +1314,7 @@ void Buffer::updateBibfilesCache()
 }
 
 
-vector<string> const & Buffer::getBibfilesCache() const
+vector<FileName> const & Buffer::getBibfilesCache() const
 {
        // if this is a child document and the parent is already loaded
        // use the parent's cache instead
@@ -1298,6 +1323,10 @@ vector<string> const & Buffer::getBibfilesCache() const
        if (tmp != this)
                return tmp->getBibfilesCache();
 
+       // We update the cache when first used instead of at loading time.
+       if (bibfilesCache_.empty())
+               const_cast<Buffer *>(this)->updateBibfilesCache();
+
        return bibfilesCache_;
 }
 
@@ -1363,9 +1392,7 @@ void Buffer::updateDocLang(Language const * nlang)
 {
        BOOST_ASSERT(nlang);
 
-       pimpl_->messages.reset(new Messages(nlang->code()));
-
-       updateLabels(*this);
+       pimpl_->messages = &getMessages(nlang->code());
 }
 
 
@@ -1438,7 +1465,7 @@ Language const * Buffer::getLanguage() const
 
 docstring const Buffer::B_(string const & l10n) const
 {
-       if (pimpl_->messages.get()
+       if (pimpl_->messages) 
                return pimpl_->messages->get(l10n);
 
        return _(l10n);
@@ -1518,9 +1545,9 @@ void Buffer::markDirty()
 }
 
 
-string const Buffer::fileName() const
+string const Buffer::fileName() const
 {
-       return pimpl_->filename;
+       return pimpl_->filename.absFilename();
 }
 
 
@@ -1628,10 +1655,10 @@ void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
        vector<docstring> labels;
 
        if (code == InsetBase::CITE_CODE) {
-               vector<pair<string, string> > keys;
+               vector<pair<string, docstring> > keys;
                fillWithBibKeys(keys);
-               vector<pair<string, string> >::const_iterator bit  = keys.begin();
-               vector<pair<string, string> >::const_iterator bend = keys.end();
+               vector<pair<string, docstring> >::const_iterator bit  = keys.begin();
+               vector<pair<string, docstring> >::const_iterator bend = keys.end();
 
                for (; bit != bend; ++bit)
                        // FIXME UNICODE
@@ -1661,7 +1688,6 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
        // No side effect of file copying and image conversion
        runparams.dryrun = true;
 
-        /* Support for docbook temprarily commented out. */
        if (full_source) {
                os << "% Preview source code\n\n";
                if (isLatex())
@@ -1692,7 +1718,7 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
 ErrorList const & Buffer::errorList(string const & type) const
 {
        static ErrorList const emptyErrorList;
-       std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
+       std::map<string, ErrorList>::const_iterator I = errorLists_.find(type);
        if (I == errorLists_.end())
                return emptyErrorList;