]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Minor cleanup.
[lyx.git] / src / Buffer.cpp
index 33b79b274a3aa1f9ff70e35991280d3fb89bf86a..aa6d936aec8e6fa00b4c92a4e71c386280e21078 100644 (file)
@@ -356,6 +356,7 @@ Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
        bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
        bibfile_status_ = cloned_buffer_->d->bibfile_status_;
        cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
+       unnamed = cloned_buffer_->d->unnamed;
 }
 
 
@@ -399,7 +400,7 @@ Buffer::~Buffer()
        Impl::BufferPositionMap::iterator end = d->children_positions.end();
        for (; it != end; ++it) {
                Buffer * child = const_cast<Buffer *>(it->first);
-               if (d->cloned_buffer_)
+               if (isClone())
                        delete child;
                // The child buffer might have been closed already.
                else if (theBufferList().isLoaded(child))
@@ -952,7 +953,7 @@ void Buffer::setFullyLoaded(bool value)
 
 PreviewLoader * Buffer::loader() const
 {
-       if (lyxrc.preview == LyXRC::PREVIEW_OFF)
+       if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
                return 0;
        if (!d->preview_loader_)
                d->preview_loader_ = new PreviewLoader(*this);
@@ -1300,7 +1301,7 @@ bool Buffer::write(ostream & ofs) const
 bool Buffer::makeLaTeXFile(FileName const & fname,
                           string const & original_path,
                           OutputParams const & runparams_in,
-                          bool output_preamble, bool output_body) const
+                          OutputWhat output) const
 {
        OutputParams runparams = runparams_in;
 
@@ -1339,8 +1340,7 @@ bool Buffer::makeLaTeXFile(FileName const & fname,
 
        try {
                os.texrow().reset();
-               writeLaTeXSource(os, original_path,
-                     runparams, output_preamble, output_body);
+               writeLaTeXSource(os, original_path, runparams, output);
        }
        catch (EncodingException & e) {
                odocstringstream ods;
@@ -1385,7 +1385,7 @@ bool Buffer::makeLaTeXFile(FileName const & fname,
 void Buffer::writeLaTeXSource(otexstream & os,
                           string const & original_path,
                           OutputParams const & runparams_in,
-                          bool const output_preamble, bool const output_body) const
+         OutputWhat output) const
 {
        // The child documents, if any, shall be already loaded at this point.
 
@@ -1400,6 +1400,11 @@ void Buffer::writeLaTeXSource(otexstream & os,
        validate(features);
        LYXERR(Debug::LATEX, "  Buffer validation done.");
 
+       bool const output_preamble =
+               output == FullSource || output == OnlyPreamble;
+       bool const output_body =
+         output == FullSource || output == OnlyBody;
+
        // The starting paragraph of the coming rows is the
        // first paragraph of the document. (Asger)
        if (output_preamble && runparams.nice) {
@@ -1561,7 +1566,7 @@ void Buffer::writeLaTeXSource(otexstream & os,
 
 void Buffer::makeDocBookFile(FileName const & fname,
                              OutputParams const & runparams,
-                             bool const body_only) const
+                             OutputWhat output) const
 {
        LYXERR(Debug::LATEX, "makeDocBookFile...");
 
@@ -1574,7 +1579,7 @@ void Buffer::makeDocBookFile(FileName const & fname,
        updateBuffer();
        updateMacroInstances(OutputUpdate);
 
-       writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
+       writeDocBookSource(ofs, fname.absFileName(), runparams, output);
 
        ofs.close();
        if (ofs.fail())
@@ -1584,7 +1589,7 @@ void Buffer::makeDocBookFile(FileName const & fname,
 
 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
                             OutputParams const & runparams,
-                            bool const only_body) const
+                            OutputWhat output) const
 {
        LaTeXFeatures features(*this, params(), runparams);
        validate(features);
@@ -1594,7 +1599,12 @@ void Buffer::writeDocBookSource(odocstream & os, string const & fname,
        DocumentClass const & tclass = params().documentClass();
        string const top_element = tclass.latexname();
 
-       if (!only_body) {
+       bool const output_preamble =
+               output == FullSource || output == OnlyPreamble;
+       bool const output_body =
+         output == FullSource || output == OnlyBody;
+
+       if (output_preamble) {
                if (runparams.flavor == OutputParams::XML)
                        os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
 
@@ -1629,29 +1639,31 @@ void Buffer::writeDocBookSource(odocstream & os, string const & fname,
                os << ">\n\n";
        }
 
-       string top = top_element;
-       top += " lang=\"";
-       if (runparams.flavor == OutputParams::XML)
-               top += params().language->code();
-       else
-               top += params().language->code().substr(0, 2);
-       top += '"';
-
-       if (!params().options.empty()) {
-               top += ' ';
-               top += params().options;
+       if (output_body) {
+               string top = top_element;
+               top += " lang=\"";
+               if (runparams.flavor == OutputParams::XML)
+                       top += params().language->code();
+               else
+                       top += params().language->code().substr(0, 2);
+               top += '"';
+       
+               if (!params().options.empty()) {
+                       top += ' ';
+                       top += params().options;
+               }
+       
+               os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
+                               << " file was created by LyX " << lyx_version
+                               << "\n  See http://www.lyx.org/ for more information -->\n";
+       
+               params().documentClass().counters().reset();
+       
+               sgml::openTag(os, top);
+               os << '\n';
+               docbookParagraphs(text(), *this, os, runparams);
+               sgml::closeTag(os, top_element);
        }
-
-       os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
-           << " file was created by LyX " << lyx_version
-           << "\n  See http://www.lyx.org/ for more information -->\n";
-
-       params().documentClass().counters().reset();
-
-       sgml::openTag(os, top);
-       os << '\n';
-       docbookParagraphs(text(), *this, os, runparams);
-       sgml::closeTag(os, top_element);
 }
 
 
@@ -1669,7 +1681,7 @@ void Buffer::makeLyXHTMLFile(FileName const & fname,
        updateBuffer(UpdateMaster, OutputUpdate);
        updateMacroInstances(OutputUpdate);
 
-       writeLyXHTMLSource(ofs, runparams);
+       writeLyXHTMLSource(ofs, runparams, FullSource);
 
        ofs.close();
        if (ofs.fail())
@@ -1679,13 +1691,18 @@ void Buffer::makeLyXHTMLFile(FileName const & fname,
 
 void Buffer::writeLyXHTMLSource(odocstream & os,
                             OutputParams const & runparams,
-                            bool const only_body) const
+                            OutputWhat output) const
 {
        LaTeXFeatures features(*this, params(), runparams);
        validate(features);
        d->bibinfo_.makeCitationLabels(*this);
 
-       if (!only_body) {
+       bool const output_preamble =
+               output == FullSource || output == OnlyPreamble;
+       bool const output_body =
+         output == FullSource || output == OnlyBody;
+
+       if (output_preamble) {
                os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
                   << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd\">\n"
                   // FIXME Language should be set properly.
@@ -1697,7 +1714,9 @@ void Buffer::writeLyXHTMLSource(odocstream & os,
 
                docstring const & doctitle = features.htmlTitle();
                os << "<title>"
-                  << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
+                  << (doctitle.empty() ? 
+                        from_ascii("LyX Document") : 
+                        html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
                   << "</title>\n";
 
                os << "\n<!-- Text Class Preamble -->\n"
@@ -1727,14 +1746,19 @@ void Buffer::writeLyXHTMLSource(odocstream & os,
                                            << ";\n";
                                os << "}\n</style>\n";
                }
-               os << "</head>\n<body>\n";
+               os << "</head>\n";
+       }
+
+       if (output_body) {
+               os << "<body>\n";
+               XHTMLStream xs(os);
+               params().documentClass().counters().reset();
+               xhtmlParagraphs(text(), *this, xs, runparams);
+               os << "</body>\n";
        }
 
-       XHTMLStream xs(os);
-       params().documentClass().counters().reset();
-       xhtmlParagraphs(text(), *this, xs, runparams);
-       if (!only_body)
-               os << "</body>\n</html>\n";
+       if (output_preamble)
+               os << "</html>\n";
 }
 
 
@@ -2094,16 +2118,16 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
                break;
 
        case LFUN_BUFFER_EXPORT: {
-               bool success = doExport(argument, false, false);
-               dr.setError(!success);
-               if (!success)
+               ExportStatus const status = doExport(argument, false);
+               dr.setError(status != ExportSuccess);
+               if (status != ExportSuccess)
                        dr.setMessage(bformat(_("Error exporting to format: %1$s."), 
                                              func.argument()));
                break;
        }
 
        case LFUN_BUILD_PROGRAM:
-               doExport("program", true, false);
+               doExport("program", true);
                break;
 
        case LFUN_BUFFER_CHKTEX:
@@ -2135,7 +2159,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
                                break;
 
                } else {
-                       doExport(format_name, true, false, filename);
+                       doExport(format_name, true, filename);
                }
 
                // Substitute $$FName for filename
@@ -2282,10 +2306,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
                        break;
                }
 
-               bool const update_unincluded =
-                               params().maintain_unincluded_children
-                               && !params().getIncludedChildren().empty();
-               if (!doExport("dvi", true, update_unincluded)) {
+               if (!doExport("dvi", true)) {
                        showPrintError(absFileName());
                        dr.setMessage(_("Error exporting to DVI."));
                        break;
@@ -3167,7 +3188,7 @@ void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
 
 void Buffer::getSourceCode(odocstream & os, string const format,
                           pit_type par_begin, pit_type par_end,
-                          bool full_source) const
+                          OutputWhat output) const
 {
        OutputParams runparams(&params().encoding());
        runparams.nice = true;
@@ -3176,21 +3197,7 @@ void Buffer::getSourceCode(odocstream & os, string const format,
        // No side effect of file copying and image conversion
        runparams.dryrun = true;
 
-       if (full_source) {
-               os << "% " << _("Preview source code") << "\n\n";
-               d->texrow.reset();
-               d->texrow.newline();
-               d->texrow.newline();
-               if (params().isDocBook())
-                       writeDocBookSource(os, absFileName(), runparams, false);
-               else if (runparams.flavor == OutputParams::HTML)
-                       writeLyXHTMLSource(os, runparams, false);
-               else {
-                       // latex or literate
-                       otexstream ots(os, d->texrow);
-                       writeLaTeXSource(ots, string(), runparams, true, true);
-               }
-       } else {
+       if (output == CurrentParagraph) {
                runparams.par_begin = par_begin;
                runparams.par_end = par_end;
                if (par_begin + 1 == par_end) {
@@ -3219,6 +3226,27 @@ void Buffer::getSourceCode(odocstream & os, string const format,
                        otexstream ots(os, texrow);
                        latexParagraphs(*this, text(), ots, runparams);
                }
+       } else {
+               os << "% ";
+               if (output == FullSource) 
+                       os << _("Preview source code");
+               else if (output == OnlyPreamble)
+                       os << _("Preview preamble");
+               else if (output == OnlyBody)
+                       os << _("Preview body");
+               os << "\n\n";
+               d->texrow.reset();
+               d->texrow.newline();
+               d->texrow.newline();
+               if (params().isDocBook())
+                       writeDocBookSource(os, absFileName(), runparams, output);
+               else if (runparams.flavor == OutputParams::HTML)
+                       writeLyXHTMLSource(os, runparams, output);
+               else {
+                       // latex or literate
+                       otexstream ots(os, d->texrow);
+                       writeLaTeXSource(ots, string(), runparams, output);
+               }
        }
 }
 
@@ -3449,23 +3477,22 @@ bool Buffer::autoSave() const
 }
 
 
-namespace {
-       // helper class, to guarantee this gets reset properly
-       class MarkAsExporting   {
-       public:
-               MarkAsExporting(Buffer const * buf) : buf_(buf) 
-               {
-                       LASSERT(buf_, /* */);
-                       buf_->setExportStatus(true);
-               }
-               ~MarkAsExporting() 
-               {
-                       buf_->setExportStatus(false);
-               }
-       private:
-               Buffer const * const buf_;
-       };
-}
+// helper class, to guarantee this gets reset properly
+class Buffer::MarkAsExporting {
+public:
+       MarkAsExporting(Buffer const * buf) : buf_(buf)
+       {
+               LASSERT(buf_, /* */);
+               buf_->setExportStatus(true);
+       }
+       ~MarkAsExporting()
+       {
+               buf_->setExportStatus(false);
+       }
+private:
+       Buffer const * const buf_;
+};
+
 
 
 void Buffer::setExportStatus(bool e) const
@@ -3485,10 +3512,36 @@ bool Buffer::isExporting() const
 }
 
 
-bool Buffer::doExport(string const & target, bool put_in_tempdir,
+Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
+       const
+{
+       string result_file;
+       return doExport(target, put_in_tempdir, result_file);
+}
+
+Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
+       string & result_file) const
+{
+       bool const update_unincluded =
+                       params().maintain_unincluded_children
+                       && !params().getIncludedChildren().empty();
+
+       // (1) export with all included children (omit \includeonly)
+       if (update_unincluded) { 
+               ExportStatus const status = 
+                       doExport(target, put_in_tempdir, true, result_file);
+               if (status != ExportSuccess)
+                       return status;
+       }
+       // (2) export with included children only
+       return doExport(target, put_in_tempdir, false, result_file);
+}
+
+
+Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
        bool includeall, string & result_file) const
 {
-       LYXERR(Debug::FILES, "target=" << target << ", result_file=" << result_file);
+       LYXERR(Debug::FILES, "target=" << target);
        OutputParams runparams(&params().encoding());
        string format = target;
        string dest_filename;
@@ -3527,7 +3580,7 @@ bool Buffer::doExport(string const & target, bool put_in_tempdir,
                                        _("No information for exporting the format %1$s."),
                                        formats.prettyName(format)));
                        }
-                       return false;
+                       return ExportNoPathToFormat;
                }
                runparams.flavor = converters.getFlavor(path);
 
@@ -3589,13 +3642,13 @@ bool Buffer::doExport(string const & target, bool put_in_tempdir,
                                d->cloned_buffer_->d->errorLists["Export"] =
                                        d->errorLists["Export"];
                        }
-                       return false;
+                       return ExportError;
                }
        } else if (!lyxrc.tex_allows_spaces
                   && contains(filePath(), ' ')) {
                Alert::error(_("File name error"),
                           _("The directory path to the document cannot contain spaces."));
-               return false;
+               return ExportTexPathHasSpaces;
        } else {
                runparams.nice = false;
                if (!makeLaTeXFile(FileName(filename), filePath(), runparams)) {
@@ -3603,7 +3656,7 @@ bool Buffer::doExport(string const & target, bool put_in_tempdir,
                                d->cloned_buffer_->d->errorLists["Export"] =
                                        d->errorLists["Export"];
                        }
-                       return false;
+                       return ExportError;
                }
        }
 
@@ -3652,11 +3705,11 @@ bool Buffer::doExport(string const & target, bool put_in_tempdir,
        }
 
        if (!success)
-               return false;
+               return ExportConverterError;
 
        if (put_in_tempdir) {
                result_file = tmp_result_file.absFileName();
-               return true;
+               return ExportSuccess;
        }
 
        if (dest_filename.empty())
@@ -3694,7 +3747,10 @@ bool Buffer::doExport(string const & target, bool put_in_tempdir,
 
        if (status == CANCEL) {
                message(_("Document export cancelled."));
-       } else if (tmp_result_file.exists()) {
+               return ExportCancel;
+       } 
+       
+       if (tmp_result_file.exists()) {
                // Finally copy the main file
                use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
                                    : force_overwrite != NO_FILES;
@@ -3703,43 +3759,50 @@ bool Buffer::doExport(string const & target, bool put_in_tempdir,
                status = copyFile(format, tmp_result_file,
                        FileName(result_file), result_file,
                        status == FORCE);
-               message(bformat(_("Document exported as %1$s "
-                       "to file `%2$s'"),
-                       formats.prettyName(format),
-                       makeDisplayPath(result_file)));
+               if (status == CANCEL) {
+                       message(_("Document export cancelled."));
+                       return ExportCancel;
+               } else {
+                       message(bformat(_("Document exported as %1$s "
+                               "to file `%2$s'"),
+                               formats.prettyName(format),
+                               makeDisplayPath(result_file)));
+               }
        } else {
                // This must be a dummy converter like fax (bug 1888)
                message(bformat(_("Document exported as %1$s"),
                        formats.prettyName(format)));
        }
 
-       return true;
+       return ExportSuccess;
 }
 
 
-bool Buffer::doExport(string const & target, bool put_in_tempdir,
-       bool includeall) const
+Buffer::ExportStatus Buffer::preview(string const & format) const
 {
-       string result_file;
-       // (1) export with all included children (omit \includeonly)
-       if (includeall && !doExport(target, put_in_tempdir, true, result_file))
-               return false;
-       // (2) export with included children only
-       return doExport(target, put_in_tempdir, false, result_file);
+       bool const update_unincluded =
+                       params().maintain_unincluded_children
+                       && !params().getIncludedChildren().empty();
+       return preview(format, update_unincluded);
 }
 
-
-bool Buffer::preview(string const & format, bool includeall) const
+Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
 {
        MarkAsExporting exporting(this);
        string result_file;
        // (1) export with all included children (omit \includeonly)
-       if (includeall && !doExport(format, true, true))
-               return false;
+       if (includeall) { 
+               ExportStatus const status = doExport(format, true, true, result_file);
+               if (status != ExportSuccess)
+                       return status;
+       }
        // (2) export with included children only
-       if (!doExport(format, true, false, result_file))
-               return false;
-       return formats.view(*this, FileName(result_file), format);
+       ExportStatus const status = doExport(format, true, false, result_file);
+       if (status != ExportSuccess)
+               return status;
+       if (!formats.view(*this, FileName(result_file), format))
+               return PreviewError;
+       return PreviewSuccess;
 }