X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.cpp;h=979b37ed5f27d220bfce3cec9f8954e5a8a4fc5c;hb=86fab2cefa122a5b0c0ee4ade472e41d9a3ff1cf;hp=fe9524d24ce40b7d34abf54d25fe6528415d8b01;hpb=4209cbc631e92edd02f4558e75d085eeea210d17;p=lyx.git diff --git a/src/Buffer.cpp b/src/Buffer.cpp index fe9524d24c..979b37ed5f 100644 --- a/src/Buffer.cpp +++ b/src/Buffer.cpp @@ -24,12 +24,15 @@ #include "Chktex.h" #include "Converter.h" #include "Counters.h" +#include "DispatchResult.h" #include "DocIterator.h" #include "Encoding.h" #include "ErrorList.h" #include "Exporter.h" #include "Format.h" #include "FuncRequest.h" +#include "FuncStatus.h" +#include "IndicesList.h" #include "InsetIterator.h" #include "InsetList.h" #include "Language.h" @@ -44,12 +47,14 @@ #include "output_docbook.h" #include "output.h" #include "output_latex.h" +#include "output_xhtml.h" #include "output_plaintext.h" #include "paragraph_funcs.h" #include "Paragraph.h" #include "ParagraphParameters.h" #include "ParIterator.h" #include "PDFOptions.h" +#include "SpellChecker.h" #include "sgml.h" #include "TexRow.h" #include "TexStream.h" @@ -59,10 +64,12 @@ #include "Undo.h" #include "VCBackend.h" #include "version.h" +#include "WordLangTuple.h" #include "WordList.h" #include "insets/InsetBibitem.h" #include "insets/InsetBibtex.h" +#include "insets/InsetBranch.h" #include "insets/InsetInclude.h" #include "insets/InsetText.h" @@ -79,6 +86,7 @@ #include "support/lassert.h" #include "support/convert.h" #include "support/debug.h" +#include "support/docstring_list.h" #include "support/ExceptionMessage.h" #include "support/FileName.h" #include "support/FileNameList.h" @@ -91,22 +99,23 @@ #include "support/os.h" #include "support/Package.h" #include "support/Path.h" +#include "support/Systemcall.h" #include "support/textutils.h" #include "support/types.h" #include +#include -#include #include #include #include #include +#include #include #include #include using namespace std; -using namespace std::tr1; using namespace lyx::support; namespace lyx { @@ -118,13 +127,23 @@ namespace { // Do not remove the comment below, so we get merge conflict in // independent branches. Instead add your own. -int const LYX_FORMAT = 345; // jamatos: xml elements +int const LYX_FORMAT = 364; // spitz: branch suffixes for filenames typedef map DepClean; typedef map > RefCache; +void showPrintError(string const & name) +{ + docstring str = bformat(_("Could not print the document %1$s.\n" + "Check that your printer is set up correctly."), + makeDisplayPath(name, 50)); + Alert::error(_("Print document failed"), str); +} + } // namespace anon +class BufferSet : public std::set {}; + class Buffer::Impl { public: @@ -143,7 +162,6 @@ public: LyXVC lyxvc; FileName temppath; mutable TexRow texrow; - Buffer const * parent_buffer; /// need to regenerate .tex? DepClean dep_clean; @@ -223,6 +241,22 @@ public: /// our Text that should be wrapped in an InsetText InsetText * inset; + + /// This is here to force the test to be done whenever parent_buffer + /// is accessed. + Buffer const * parent() const { + // if parent_buffer is not loaded, then it has been unloaded, + // which means that parent_buffer is an invalid pointer. So we + // set it to null in that case. + if (!theBufferList().isLoaded(parent_buffer)) + parent_buffer = 0; + return parent_buffer; + } + /// + void setParent(Buffer const * pb) { parent_buffer = pb; } +private: + /// So we can force access via the accessors. + mutable Buffer const * parent_buffer; }; @@ -246,10 +280,11 @@ static FileName createBufferTmpDir() Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_) - : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false), + : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_), filename(file), file_fully_loaded(false), toc_backend(&parent), macro_lock(false), timestamp_(0), - checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false) + checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false), + parent_buffer(0) { temppath = createBufferTmpDir(); lyxvc.setBuffer(&parent); @@ -287,8 +322,12 @@ Buffer::~Buffer() // loop over children Impl::BufferPositionMap::iterator it = d->children_positions.begin(); Impl::BufferPositionMap::iterator end = d->children_positions.end(); - for (; it != end; ++it) - theBufferList().releaseChild(this, const_cast(it->first)); + for (; it != end; ++it) { + Buffer * child = const_cast(it->first); + // The child buffer might have been closed already. + if (theBufferList().isLoaded(child)) + theBufferList().releaseChild(this, child); + } // clear references to children in macro tables d->children_positions.clear(); @@ -401,12 +440,29 @@ Undo & Buffer::undo() string Buffer::latexName(bool const no_path) const { - FileName latex_name = makeLatexName(d->filename); + FileName latex_name = + makeLatexName(exportFileName()); return no_path ? latex_name.onlyFileName() : latex_name.absFilename(); } +FileName Buffer::exportFileName() const +{ + docstring const branch_suffix = + params().branchlist().getFilenameSuffix(); + if (branch_suffix.empty()) + return fileName(); + + string const name = fileName().onlyFileNameWithoutExt() + + to_utf8(branch_suffix); + FileName res(fileName().onlyPath().absFilename() + "/" + name); + res.changeExtension(fileName().extension()); + + return res; +} + + string Buffer::logName(LogType * type) const { string const filename = latexName(false); @@ -422,19 +478,38 @@ string Buffer::logName(LogType * type) const FileName const fname(addName(temppath(), onlyFilename(changeExtension(filename, ".log")))); + + // FIXME: how do we know this is the name of the build log? FileName const bname( addName(path, onlyFilename( changeExtension(filename, - formats.extension("literate") + ".out")))); + formats.extension(bufferFormat()) + ".out")))); - // If no Latex log or Build log is newer, show Build log + // Also consider the master buffer log file + FileName masterfname = fname; + LogType mtype; + if (masterBuffer() != this) { + string const mlogfile = masterBuffer()->logName(&mtype); + masterfname = FileName(mlogfile); + } + // If no Latex log or Build log is newer, show Build log if (bname.exists() && - (!fname.exists() || fname.lastModified() < bname.lastModified())) { + ((!fname.exists() && !masterfname.exists()) + || (fname.lastModified() < bname.lastModified() + && masterfname.lastModified() < bname.lastModified()))) { LYXERR(Debug::FILES, "Log name calculated as: " << bname); if (type) *type = buildlog; return bname.absFilename(); + // If we have a newer master file log or only a master log, show this + } else if (fname != masterfname + && (!fname.exists() && (masterfname.exists() + || fname.lastModified() < masterfname.lastModified()))) { + LYXERR(Debug::FILES, "Log name calculated as: " << masterfname); + if (type) + *type = mtype; + return masterfname.absFilename(); } LYXERR(Debug::FILES, "Log name calculated as: " << fname); if (type) @@ -487,6 +562,8 @@ int Buffer::readHeader(Lexer & lex) params().clearLayoutModules(); params().clearRemovedModules(); params().pdfoptions().clear(); + params().indiceslist().clear(); + params().backgroundcolor = lyx::rgbFromHexName("#ffffff"); for (int i = 0; i < 4; ++i) { params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i]; @@ -545,7 +622,7 @@ int Buffer::readHeader(Lexer & lex) // Uwe C. Schroeder // changed to be public and have one parameter -// Returns false if "\end_document" is not read (Asger) +// Returns true if "\end_document" is not read (Asger) bool Buffer::readDocument(Lexer & lex) { ErrorList & errorList = d->errorLists["Parse"]; @@ -564,19 +641,19 @@ bool Buffer::readDocument(Lexer & lex) if (params().outputChanges) { bool dvipost = LaTeXFeatures::isAvailable("dvipost"); - bool xcolorsoul = LaTeXFeatures::isAvailable("soul") && + bool xcolorulem = LaTeXFeatures::isAvailable("ulem") && LaTeXFeatures::isAvailable("xcolor"); - if (!dvipost && !xcolorsoul) { + if (!dvipost && !xcolorulem) { Alert::warning(_("Changes not shown in LaTeX output"), _("Changes will not be highlighted in LaTeX output, " - "because neither dvipost nor xcolor/soul are installed.\n" + "because neither dvipost nor xcolor/ulem are installed.\n" "Please install these packages or redefine " "\\lyxadded and \\lyxdeleted in the LaTeX preamble.")); - } else if (!xcolorsoul) { + } else if (!xcolorulem) { Alert::warning(_("Changes not shown in LaTeX output"), _("Changes will not be highlighted in LaTeX output " - "when using pdflatex, because xcolor and soul are not installed.\n" + "when using pdflatex, because xcolor and ulem are not installed.\n" "Please install both packages or redefine " "\\lyxadded and \\lyxdeleted in the LaTeX preamble.")); } @@ -586,8 +663,29 @@ bool Buffer::readDocument(Lexer & lex) FileName const master_file = makeAbsPath(params().master, onlyPath(absFileName())); if (isLyXFilename(master_file.absFilename())) { - Buffer * master = checkAndLoadLyXFile(master_file); - d->parent_buffer = master; + Buffer * master = + checkAndLoadLyXFile(master_file, true); + if (master) { + // necessary e.g. after a reload + // to re-register the child (bug 5873) + // FIXME: clean up updateMacros (here, only + // child registering is needed). + master->updateMacros(); + // set master as master buffer, but only + // if we are a real child + if (master->isChild(this)) + setParent(master); + // if the master is not fully loaded + // it is probably just loading this + // child. No warning needed then. + else if (master->isFullyLoaded()) + LYXERR0("The master '" + << params().master + << "' assigned to this document (" + << absFileName() + << ") does not include " + "this document. Ignoring the master assignment."); + } } } @@ -683,6 +781,8 @@ bool Buffer::readFile(FileName const & filename) { FileName fname(filename); + params().compressed = fname.isZippedFile(); + // remove dummy empty par paragraphs().clear(); Lexer lex; @@ -755,7 +855,7 @@ Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename, bformat(_("%1$s is from a different" " version of LyX, but a temporary" " file for converting it could" - " not be created."), + " not be created."), from_utf8(filename.absFilename()))); return failure; } @@ -765,7 +865,7 @@ Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename, bformat(_("%1$s is from a different" " version of LyX, but the" " conversion script lyx2lyx" - " could not be found."), + " could not be found."), from_utf8(filename.absFilename()))); return failure; } @@ -784,7 +884,7 @@ Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename, Alert::error(_("Conversion script failed"), bformat(_("%1$s is from a different version" " of LyX, but the lyx2lyx script" - " failed to convert it."), + " failed to convert it."), from_utf8(filename.absFilename()))); return failure; } else { @@ -885,7 +985,7 @@ bool Buffer::writeFile(FileName const & fname) const return false; } - removeAutosaveFile(d->filename.absFilename()); + removeAutosaveFile(); saveCheckSum(d->filename); message(str + _(" done.")); @@ -957,13 +1057,17 @@ bool Buffer::write(ostream & ofs) const bool Buffer::makeLaTeXFile(FileName const & fname, string const & original_path, - OutputParams const & runparams, + OutputParams const & runparams_in, bool output_preamble, bool output_body) const { + OutputParams runparams = runparams_in; + if (params().useXetex) + runparams.flavor = OutputParams::XETEX; + string const encoding = runparams.encoding->iconvName(); LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "..."); - odocfstream ofs; + ofdocstream ofs; try { ofs.reset(encoding); } catch (iconv_codecvt_facet_exception & e) { lyxerr << "Caught iconv exception: " << e.what() << endl; @@ -1126,8 +1230,8 @@ void Buffer::writeLaTeXSource(odocstream & os, // This happens for example if only a child document is printed. Buffer const * save_parent = 0; if (output_preamble) { - save_parent = d->parent_buffer; - d->parent_buffer = 0; + save_parent = d->parent(); + d->setParent(0); } // the real stuff @@ -1135,7 +1239,7 @@ void Buffer::writeLaTeXSource(odocstream & os, // Restore the parenthood if needed if (output_preamble) - d->parent_buffer = save_parent; + d->setParent(save_parent); // add this just in case after all the paragraphs os << endl; @@ -1182,7 +1286,7 @@ void Buffer::makeDocBookFile(FileName const & fname, { LYXERR(Debug::LATEX, "makeDocBookFile..."); - odocfstream ofs; + ofdocstream ofs; if (!openFileWrite(ofs, fname)) return; @@ -1269,6 +1373,65 @@ void Buffer::writeDocBookSource(odocstream & os, string const & fname, } +void Buffer::makeLyXHTMLFile(FileName const & fname, + OutputParams const & runparams, + bool const body_only) const +{ + LYXERR(Debug::LATEX, "makeLYXHTMLFile..."); + + ofdocstream ofs; + if (!openFileWrite(ofs, fname)) + return; + + writeLyXHTMLSource(ofs, runparams, body_only); + + ofs.close(); + if (ofs.fail()) + lyxerr << "File '" << fname << "' was not closed properly." << endl; +} + + +void Buffer::writeLyXHTMLSource(odocstream & os, + OutputParams const & runparams, + bool const only_body) const +{ + LaTeXFeatures features(*this, params(), runparams); + validate(features); + + d->texrow.reset(); + + if (!only_body) { + os << "\n"; + // FIXME Language should be set properly. + os << "\n"; + // FIXME Header + os << "\n"; + // FIXME Presumably need to set this right + os << "\n"; + // FIXME Get this during validation? What about other meta-data? + os << "TBA\n"; + + os << features.getTClassHTMLPreamble(); + + os << '\n'; + + docstring const styleinfo = features.getTClassHTMLStyles(); + if (!styleinfo.empty()) { + os << "\n"; + } + os << "\n\n"; + } + + params().documentClass().counters().reset(); + xhtmlParagraphs(paragraphs(), *this, os, runparams); + if (!only_body) + os << "\n\n"; +} + + // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?) // Other flags: -wall -v0 -x int Buffer::runChktex() @@ -1328,8 +1491,9 @@ void Buffer::validate(LaTeXFeatures & features) const void Buffer::getLabelList(vector & list) const { // If this is a child document, use the parent's list instead. - if (d->parent_buffer) { - d->parent_buffer->getLabelList(list); + Buffer const * const pbuf = d->parent(); + if (pbuf) { + pbuf->getLabelList(list); return; } @@ -1344,11 +1508,12 @@ void Buffer::getLabelList(vector & list) const } -void Buffer::updateBibfilesCache() const +void Buffer::updateBibfilesCache(UpdateScope scope) const { // If this is a child document, use the parent's cache instead. - if (d->parent_buffer) { - d->parent_buffer->updateBibfilesCache(); + Buffer const * const pbuf = d->parent(); + if (pbuf && scope != UpdateChildOnly) { + pbuf->updateBibfilesCache(); return; } @@ -1366,7 +1531,7 @@ void Buffer::updateBibfilesCache() const static_cast(*it); inset.updateBibfilesCache(); support::FileNameList const & bibfiles = - inset.getBibfilesCache(*this); + inset.getBibfilesCache(); d->bibfilesCache_.insert(d->bibfilesCache_.end(), bibfiles.begin(), bibfiles.end()); @@ -1383,15 +1548,16 @@ void Buffer::invalidateBibinfoCache() } -support::FileNameList const & Buffer::getBibfilesCache() const +support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const { // If this is a child document, use the parent's cache instead. - if (d->parent_buffer) - return d->parent_buffer->getBibfilesCache(); + Buffer const * const pbuf = d->parent(); + if (pbuf && scope != UpdateChildOnly) + return pbuf->getBibfilesCache(); // We update the cache when first used instead of at loading time. if (d->bibfilesCache_.empty()) - const_cast(this)->updateBibfilesCache(); + const_cast(this)->updateBibfilesCache(scope); return d->bibfilesCache_; } @@ -1451,41 +1617,266 @@ void Buffer::markDepClean(string const & name) } -bool Buffer::dispatch(string const & command, bool * result) +bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) +{ + switch (cmd.action) { + case LFUN_BUFFER_EXPORT: { + docstring const arg = cmd.argument(); + bool enable = arg == "custom" || isExportable(to_utf8(arg)); + if (!enable) + flag.message(bformat( + _("Don't know how to export to format: %1$s"), arg)); + flag.setEnabled(enable); + break; + } + + case LFUN_BRANCH_ACTIVATE: + case LFUN_BRANCH_DEACTIVATE: { + BranchList const & branchList = params().branchlist(); + docstring const branchName = cmd.argument(); + flag.setEnabled(!branchName.empty() + && branchList.find(branchName)); + break; + } + + case LFUN_BRANCH_ADD: + case LFUN_BRANCHES_RENAME: + case LFUN_BUFFER_PRINT: + // if no Buffer is present, then of course we won't be called! + flag.setEnabled(true); + break; + + default: + return false; + } + return true; +} + + +void Buffer::dispatch(string const & command, DispatchResult & result) { return dispatch(lyxaction.lookupFunc(command), result); } -bool Buffer::dispatch(FuncRequest const & func, bool * result) +// NOTE We can end up here even if we have no GUI, because we are called +// by LyX::exec to handled command-line requests. So we may need to check +// whether we have a GUI or not. The boolean use_gui holds this information. +void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr) { + // We'll set this back to false if need be. bool dispatched = true; switch (func.action) { - case LFUN_BUFFER_EXPORT: { - bool const tmp = doExport(to_utf8(func.argument()), false); - if (result) - *result = tmp; + case LFUN_BUFFER_EXPORT: { + bool success = doExport(to_utf8(func.argument()), false); + dr.setError(success); + if (!success) + dr.setMessage(bformat(_("Error exporting to format: %1$s."), + func.argument())); + break; + } + + case LFUN_BRANCH_ADD: { + BranchList & branchList = params().branchlist(); + docstring const branchName = func.argument(); + if (branchName.empty()) { + dispatched = false; break; } - - case LFUN_BRANCH_ACTIVATE: - case LFUN_BRANCH_DEACTIVATE: { - BranchList & branchList = params().branchlist(); - docstring const branchName = func.argument(); - Branch * branch = branchList.find(branchName); - if (!branch) - LYXERR0("Branch " << branchName << " does not exist."); - else - branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE); - if (result) - *result = true; + Branch * branch = branchList.find(branchName); + if (branch) { + LYXERR0("Branch " << branchName << " does already exist."); + dr.setError(true); + docstring const msg = + bformat(_("Branch \"%1$s\" does already exist."), branchName); + dr.setMessage(msg); + } else { + branchList.add(branchName); + dr.setError(false); + dr.update(Update::Force); } + break; + } - default: + case LFUN_BRANCH_ACTIVATE: + case LFUN_BRANCH_DEACTIVATE: { + BranchList & branchList = params().branchlist(); + docstring const branchName = func.argument(); + // the case without a branch name is handled elsewhere + if (branchName.empty()) { dispatched = false; + break; + } + Branch * branch = branchList.find(branchName); + if (!branch) { + LYXERR0("Branch " << branchName << " does not exist."); + dr.setError(true); + docstring const msg = + bformat(_("Branch \"%1$s\" does not exist."), branchName); + dr.setMessage(msg); + } else { + branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE); + dr.setError(false); + dr.update(Update::Force); + } + break; } - return dispatched; + + case LFUN_BRANCHES_RENAME: { + if (func.argument().empty()) + break; + + docstring const oldname = from_utf8(func.getArg(0)); + docstring const newname = from_utf8(func.getArg(1)); + InsetIterator it = inset_iterator_begin(inset()); + InsetIterator const end = inset_iterator_end(inset()); + bool success = false; + for (; it != end; ++it) { + if (it->lyxCode() == BRANCH_CODE) { + InsetBranch & ins = static_cast(*it); + if (ins.branch() == oldname) { + undo().recordUndo(it); + ins.rename(newname); + success = true; + continue; + } + } + if (it->lyxCode() == INCLUDE_CODE) { + // get buffer of external file + InsetInclude const & ins = + static_cast(*it); + Buffer * child = ins.getChildBuffer(); + if (!child) + continue; + child->dispatch(func, dr); + } + } + + if (success) + dr.update(Update::Force); + break; + } + + case LFUN_BUFFER_PRINT: { + // we'll assume there's a problem until we succeed + dr.setError(true); + string target = func.getArg(0); + string target_name = func.getArg(1); + string command = func.getArg(2); + + if (target.empty() + || target_name.empty() + || command.empty()) { + LYXERR0("Unable to parse " << func.argument()); + docstring const msg = + bformat(_("Unable to parse \"%1$s\""), func.argument()); + dr.setMessage(msg); + break; + } + if (target != "printer" && target != "file") { + LYXERR0("Unrecognized target \"" << target << '"'); + docstring const msg = + bformat(_("Unrecognized target \"%1$s\""), from_utf8(target)); + dr.setMessage(msg); + break; + } + + if (!doExport("dvi", true)) { + showPrintError(absFileName()); + dr.setMessage(_("Error exporting to DVI.")); + break; + } + + // Push directory path. + string const path = temppath(); + // Prevent the compiler from optimizing away p + FileName pp(path); + PathChanger p(pp); + + // there are three cases here: + // 1. we print to a file + // 2. we print directly to a printer + // 3. we print using a spool command (print to file first) + Systemcall one; + int res = 0; + string const dviname = changeExtension(latexName(true), "dvi"); + + if (target == "printer") { + if (!lyxrc.print_spool_command.empty()) { + // case 3: print using a spool + string const psname = changeExtension(dviname,".ps"); + command += ' ' + lyxrc.print_to_file + + quoteName(psname) + + ' ' + + quoteName(dviname); + + string command2 = lyxrc.print_spool_command + ' '; + if (target_name != "default") { + command2 += lyxrc.print_spool_printerprefix + + target_name + + ' '; + } + command2 += quoteName(psname); + // First run dvips. + // If successful, then spool command + res = one.startscript(Systemcall::Wait, command); + + if (res == 0) { + // If there's no GUI, we have to wait on this command. Otherwise, + // LyX deletes the temporary directory, and with it the spooled + // file, before it can be printed!! + Systemcall::Starttype stype = use_gui ? + Systemcall::DontWait : Systemcall::Wait; + res = one.startscript(stype, command2); + } + } else { + // case 2: print directly to a printer + if (target_name != "default") + command += ' ' + lyxrc.print_to_printer + target_name + ' '; + // as above.... + Systemcall::Starttype stype = use_gui ? + Systemcall::DontWait : Systemcall::Wait; + res = one.startscript(stype, command + quoteName(dviname)); + } + + } else { + // case 1: print to a file + FileName const filename(makeAbsPath(target_name, filePath())); + FileName const dvifile(makeAbsPath(dviname, path)); + if (filename.exists()) { + docstring text = bformat( + _("The file %1$s already exists.\n\n" + "Do you want to overwrite that file?"), + makeDisplayPath(filename.absFilename())); + if (Alert::prompt(_("Overwrite file?"), + text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0) + break; + } + command += ' ' + lyxrc.print_to_file + + quoteName(filename.toFilesystemEncoding()) + + ' ' + + quoteName(dvifile.toFilesystemEncoding()); + // as above.... + Systemcall::Starttype stype = use_gui ? + Systemcall::DontWait : Systemcall::Wait; + res = one.startscript(stype, command); + } + + if (res == 0) + dr.setError(false); + else { + dr.setMessage(_("Error running external commands.")); + showPrintError(absFileName()); + } + break; + } + + default: + dispatched = false; + break; + } + dr.dispatched(dispatched); } @@ -1513,17 +1904,18 @@ bool Buffer::isMultiLingual() const DocIterator Buffer::getParFromID(int const id) const { + Buffer * buf = const_cast(this); if (id < 0) { // John says this is called with id == -1 from undo lyxerr << "getParFromID(), id: " << id << endl; - return doc_iterator_end(inset()); + return doc_iterator_end(buf); } - for (DocIterator it = doc_iterator_begin(inset()); !it.atEnd(); it.forwardPar()) + for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar()) if (it.paragraph().id() == id) return it; - return doc_iterator_end(inset()); + return doc_iterator_end(buf); } @@ -1535,25 +1927,25 @@ bool Buffer::hasParWithID(int const id) const ParIterator Buffer::par_iterator_begin() { - return ParIterator(doc_iterator_begin(inset())); + return ParIterator(doc_iterator_begin(this)); } ParIterator Buffer::par_iterator_end() { - return ParIterator(doc_iterator_end(inset())); + return ParIterator(doc_iterator_end(this)); } ParConstIterator Buffer::par_iterator_begin() const { - return lyx::par_const_iterator_begin(inset()); + return ParConstIterator(doc_iterator_begin(this)); } ParConstIterator Buffer::par_iterator_end() const { - return lyx::par_const_iterator_end(inset()); + return ParConstIterator(doc_iterator_end(this)); } @@ -1678,23 +2070,50 @@ bool Buffer::isReadonly() const void Buffer::setParent(Buffer const * buffer) { // Avoids recursive include. - d->parent_buffer = buffer == this ? 0 : buffer; + d->setParent(buffer == this ? 0 : buffer); updateMacros(); } -Buffer const * Buffer::parent() +Buffer const * Buffer::parent() const +{ + return d->parent(); +} + + +void Buffer::collectRelatives(BufferSet & bufs) const { - return d->parent_buffer; + bufs.insert(this); + if (parent()) + parent()->collectRelatives(bufs); + + // loop over children + Impl::BufferPositionMap::iterator it = d->children_positions.begin(); + Impl::BufferPositionMap::iterator end = d->children_positions.end(); + for (; it != end; ++it) + bufs.insert(const_cast(it->first)); +} + + +std::vector Buffer::allRelatives() const +{ + BufferSet bufs; + collectRelatives(bufs); + BufferSet::iterator it = bufs.begin(); + std::vector ret; + for (; it != bufs.end(); ++it) + ret.push_back(*it); + return ret; } Buffer const * Buffer::masterBuffer() const { - if (!d->parent_buffer) + Buffer const * const pbuf = d->parent(); + if (!pbuf) return this; - return d->parent_buffer->masterBuffer(); + return pbuf->masterBuffer(); } @@ -1704,6 +2123,35 @@ bool Buffer::isChild(Buffer * child) const } +DocIterator Buffer::firstChildPosition(Buffer const * child) +{ + Impl::BufferPositionMap::iterator it; + it = d->children_positions.find(child); + if (it == d->children_positions.end()) + return DocIterator(this); + return it->second; +} + + +std::vector Buffer::getChildren() const +{ + std::vector clist; + // loop over children + Impl::BufferPositionMap::iterator it = d->children_positions.begin(); + Impl::BufferPositionMap::iterator end = d->children_positions.end(); + for (; it != end; ++it) { + Buffer * child = const_cast(it->first); + clist.push_back(child); + // there might be grandchildren + std::vector glist = child->getChildren(); + for (vector::const_iterator git = glist.begin(); + git != glist.end(); ++git) + clist.push_back(*git); + } + return clist; +} + + template typename M::iterator greatest_below(M & m, typename M::key_type const & x) { @@ -1734,11 +2182,11 @@ MacroData const * Buffer::getBufferMacro(docstring const & name, // find macro definitions for name Impl::NamePositionScopeMacroMap::iterator nameIt - = d->macros.find(name); + = d->macros.find(name); if (nameIt != d->macros.end()) { // find last definition in front of pos or at pos itself Impl::PositionScopeMacroMap::const_iterator it - = greatest_below(nameIt->second, pos); + = greatest_below(nameIt->second, pos); if (it != nameIt->second.end()) { while (true) { // scope ends behind pos? @@ -1761,7 +2209,7 @@ MacroData const * Buffer::getBufferMacro(docstring const & name, // find macros in included files Impl::PositionScopeBufferMap::const_iterator it - = greatest_below(d->position_to_children, pos); + = greatest_below(d->position_to_children, pos); if (it == d->position_to_children.end()) // no children before return bestData; @@ -1808,9 +2256,10 @@ MacroData const * Buffer::getMacro(docstring const & name, return data; // If there is a master buffer, query that - if (d->parent_buffer) { + Buffer const * const pbuf = d->parent(); + if (pbuf) { d->macro_lock = true; - MacroData const * macro = d->parent_buffer->getMacro( + MacroData const * macro = pbuf->getMacro( name, *this, false); d->macro_lock = false; if (macro) @@ -1868,8 +2317,7 @@ void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const // is it a nested text inset? if (iit->inset->asInsetText()) { // Inset needs its own scope? - InsetText const * itext - = iit->inset->asInsetText(); + InsetText const * itext = iit->inset->asInsetText(); bool newScope = itext->isMacroScope(); // scope which ends just behind the inset @@ -1886,20 +2334,19 @@ void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const // is it an external file? if (iit->inset->lyxCode() == INCLUDE_CODE) { // get buffer of external file - InsetCommand const & inset - = static_cast(*iit->inset); - InsetCommandParams const & ip = inset.params(); + InsetInclude const & inset = + static_cast(*iit->inset); d->macro_lock = true; - Buffer * child = loadIfNeeded(*this, ip); + Buffer * child = inset.getChildBuffer(); d->macro_lock = false; if (!child) continue; // register its position, but only when it is // included first in the buffer - if (d->children_positions.find(child) - == d->children_positions.end()) - d->children_positions[child] = it; + if (d->children_positions.find(child) == + d->children_positions.end()) + d->children_positions[child] = it; // register child with its scope d->position_to_children[it] = Impl::ScopeBuffer(scope, child); @@ -1910,8 +2357,8 @@ void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const continue; // get macro data - MathMacroTemplate & macroTemplate - = static_cast(*iit->inset); + MathMacroTemplate & macroTemplate = + static_cast(*iit->inset); MacroContext mc(*this, it); macroTemplate.updateToContext(mc); @@ -1958,12 +2405,41 @@ void Buffer::updateMacros() const } +void Buffer::getUsedBranches(std::list & result, bool const from_master) const +{ + InsetIterator it = inset_iterator_begin(inset()); + InsetIterator const end = inset_iterator_end(inset()); + for (; it != end; ++it) { + if (it->lyxCode() == BRANCH_CODE) { + InsetBranch & br = static_cast(*it); + docstring const name = br.branch(); + if (!from_master && !params().branchlist().find(name)) + result.push_back(name); + else if (from_master && !masterBuffer()->params().branchlist().find(name)) + result.push_back(name); + continue; + } + if (it->lyxCode() == INCLUDE_CODE) { + // get buffer of external file + InsetInclude const & ins = + static_cast(*it); + Buffer * child = ins.getChildBuffer(); + if (!child) + continue; + child->getUsedBranches(result, true); + } + } + // remove duplicates + result.unique(); +} + + void Buffer::updateMacroInstances() const { LYXERR(Debug::MACROS, "updateMacroInstances for " << d->filename.onlyFileName()); - DocIterator it = doc_iterator_begin(inset()); - DocIterator end = doc_iterator_end(inset()); + DocIterator it = doc_iterator_begin(this); + DocIterator end = doc_iterator_end(this); for (; it != end; it.forwardPos()) { // look for MathData cells in InsetMathNest insets Inset * inset = it.nextInset(); @@ -2005,8 +2481,9 @@ void Buffer::listMacroNames(MacroNameSet & macros) const it->first->listMacroNames(macros); // call parent - if (d->parent_buffer) - d->parent_buffer->listMacroNames(macros); + Buffer const * const pbuf = d->parent(); + if (pbuf) + pbuf->listMacroNames(macros); d->macro_lock = false; } @@ -2014,11 +2491,12 @@ void Buffer::listMacroNames(MacroNameSet & macros) const void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const { - if (!d->parent_buffer) + Buffer const * const pbuf = d->parent(); + if (!pbuf) return; MacroNameSet names; - d->parent_buffer->listMacroNames(names); + pbuf->listMacroNames(names); // resolve macros MacroNameSet::iterator it = names.begin(); @@ -2026,7 +2504,7 @@ void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const for (; it != end; ++it) { // defined? MacroData const * data = - d->parent_buffer->getMacro(*it, *this, false); + pbuf->getMacro(*it, *this, false); if (data) { macros.insert(data); @@ -2042,7 +2520,7 @@ void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const Buffer::References & Buffer::references(docstring const & label) { - if (d->parent_buffer) + if (d->parent()) return const_cast(masterBuffer())->references(label); RefCache::iterator it = d->ref_cache_.find(label); @@ -2077,7 +2555,7 @@ InsetLabel const * Buffer::insetLabel(docstring const & label) const void Buffer::clearReferenceCache() const { - if (!d->parent_buffer) + if (!d->parent()) d->ref_cache_.clear(); } @@ -2118,14 +2596,15 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin, { OutputParams runparams(¶ms().encoding()); runparams.nice = true; - runparams.flavor = OutputParams::LATEX; + runparams.flavor = params().useXetex ? + OutputParams::XETEX : OutputParams::LATEX; runparams.linelen = lyxrc.plaintext_linelen; // No side effect of file copying and image conversion runparams.dryrun = true; - d->texrow.reset(); if (full_source) { os << "% " << _("Preview source code") << "\n\n"; + d->texrow.reset(); d->texrow.newline(); d->texrow.newline(); if (isDocBook()) @@ -2147,14 +2626,16 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin, convert(par_end - 1)) << "\n\n"; } - d->texrow.newline(); - d->texrow.newline(); + TexRow texrow; + texrow.reset(); + texrow.newline(); + texrow.newline(); // output paragraphs if (isDocBook()) docbookParagraphs(paragraphs(), *this, os, runparams); else // latex or literate - latexParagraphs(*this, text(), os, d->texrow, runparams); + latexParagraphs(*this, text(), os, texrow, runparams); } } @@ -2185,10 +2666,10 @@ void Buffer::structureChanged() const } -void Buffer::errors(string const & err) const +void Buffer::errors(string const & err, bool from_master) const { if (gui_) - gui_->errors(err); + gui_->errors(err, from_master); } @@ -2227,6 +2708,12 @@ void Buffer::resetAutosaveTimers() const } +bool Buffer::hasGuiDelegate() const +{ + return gui_; +} + + void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui) { gui_ = gui; @@ -2236,8 +2723,7 @@ void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui) namespace { -class AutoSaveBuffer : public ForkedProcess -{ +class AutoSaveBuffer : public ForkedProcess { public: /// AutoSaveBuffer(Buffer const & buffer, FileName const & fname) @@ -2307,6 +2793,39 @@ int AutoSaveBuffer::generateChild() } // namespace anon +FileName Buffer::getAutosaveFilename() const +{ + // if the document is unnamed try to save in the backup dir, else + // in the default document path, and as a last try in the filePath, + // which will most often be the temporary directory + string fpath; + if (isUnnamed()) + fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path + : lyxrc.backupdir_path; + if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists()) + fpath = filePath(); + + string const fname = "#" + d->filename.onlyFileName() + "#"; + return makeAbsPath(fname, fpath); +} + + +void Buffer::removeAutosaveFile() const +{ + FileName const f = getAutosaveFilename(); + if (f.exists()) + f.removeFile(); +} + + +void Buffer::moveAutosaveFile(support::FileName const & oldauto) const +{ + FileName const newauto = getAutosaveFilename(); + if (!(oldauto == newauto || oldauto.moveTo(newauto))) + LYXERR0("Unable to remove autosave file `" << oldauto << "'!"); +} + + // Perfect target for a thread... void Buffer::autoSave() const { @@ -2318,14 +2837,7 @@ void Buffer::autoSave() const // emit message signal. message(_("Autosaving current document...")); - - // create autosave filename - string fname = filePath(); - fname += '#'; - fname += d->filename.onlyFileName(); - fname += '#'; - - AutoSaveBuffer autosave(*this, FileName(fname)); + AutoSaveBuffer autosave(*this, getAutosaveFilename()); autosave.start(); markBakClean(); @@ -2335,16 +2847,38 @@ void Buffer::autoSave() const string Buffer::bufferFormat() const { - if (isDocBook()) - return "docbook"; - if (isLiterate()) - return "literate"; - if (params().encoding().package() == Encoding::japanese) - return "platex"; - return "latex"; + string format = params().documentClass().outputFormat(); + if (format == "latex") { + if (params().useXetex) + return "xetex"; + if (params().encoding().package() == Encoding::japanese) + return "platex"; + } + return format; +} + + +string Buffer::getDefaultOutputFormat() const +{ + if (!params().defaultOutputFormat.empty() + && params().defaultOutputFormat != "default") + return params().defaultOutputFormat; + typedef vector Formats; + Formats formats = exportableFormats(true); + if (isDocBook() + || isLiterate() + || params().useXetex + || params().encoding().package() == Encoding::japanese) { + if (formats.empty()) + return string(); + // return the first we find + return formats.front()->name(); + } + return lyxrc.default_view_format; } + bool Buffer::doExport(string const & format, bool put_in_tempdir, string & result_file) const { @@ -2391,6 +2925,8 @@ bool Buffer::doExport(string const & format, bool put_in_tempdir, if (backend_format == "text") writePlaintextFile(*this, FileName(filename), runparams); // no backend + else if (backend_format == "xhtml") + makeLyXHTMLFile(FileName(filename), runparams); else if (backend_format == "lyx") writeFile(FileName(filename)); // Docbook backend @@ -2423,8 +2959,14 @@ bool Buffer::doExport(string const & format, bool put_in_tempdir, tmp_result_file, FileName(absFileName()), backend_format, format, error_list); // Emit the signal to show the error list. - if (format != backend_format) + if (format != backend_format) { errors(error_type); + // also to the children, in case of master-buffer-view + std::vector clist = getChildren(); + for (vector::const_iterator cit = clist.begin(); + cit != clist.end(); ++cit) + (*cit)->errors(error_type, true); + } if (!success) return false; @@ -2433,7 +2975,7 @@ bool Buffer::doExport(string const & format, bool put_in_tempdir, return true; } - result_file = changeExtension(absFileName(), ext); + result_file = changeExtension(exportFileName().absFilename(), ext); // We need to copy referenced files (e. g. included graphics // if format == "dvi") to the result dir. vector const files = @@ -2520,6 +3062,7 @@ vector Buffer::backends() const v.push_back("pdflatex"); } v.push_back("text"); + v.push_back("xhtml"); v.push_back("lyx"); return v; } @@ -2645,4 +3188,318 @@ void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const } +void Buffer::setBuffersForInsets() const +{ + inset().setBuffer(const_cast(*this)); +} + + +void Buffer::updateLabels(UpdateScope scope) const +{ + // Use the master text class also for child documents + Buffer const * const master = masterBuffer(); + DocumentClass const & textclass = master->params().documentClass(); + + // keep the buffers to be children in this set. If the call from the + // master comes back we can see which of them were actually seen (i.e. + // via an InsetInclude). The remaining ones in the set need still be updated. + static std::set bufToUpdate; + if (scope == UpdateMaster) { + // If this is a child document start with the master + if (master != this) { + bufToUpdate.insert(this); + master->updateLabels(); + // Do this here in case the master has no gui associated with it. Then, + // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699). + if (!master->gui_) + structureChanged(); + + // was buf referenced from the master (i.e. not in bufToUpdate anymore)? + if (bufToUpdate.find(this) == bufToUpdate.end()) + return; + } + + // start over the counters in the master + textclass.counters().reset(); + } + + // update will be done below for this buffer + bufToUpdate.erase(this); + + // update all caches + clearReferenceCache(); + updateMacros(); + + Buffer & cbuf = const_cast(*this); + + LASSERT(!text().paragraphs().empty(), /**/); + + // do the real work + ParIterator parit = cbuf.par_iterator_begin(); + updateLabels(parit); + + if (master != this) + // TocBackend update will be done later. + return; + + cbuf.tocBackend().update(); + if (scope == UpdateMaster) + cbuf.structureChanged(); +} + + +static depth_type getDepth(DocIterator const & it) +{ + depth_type depth = 0; + for (size_t i = 0 ; i < it.depth() ; ++i) + if (!it[i].inset().inMathed()) + depth += it[i].paragraph().getDepth() + 1; + // remove 1 since the outer inset does not count + return depth - 1; +} + +static depth_type getItemDepth(ParIterator const & it) +{ + Paragraph const & par = *it; + LabelType const labeltype = par.layout().labeltype; + + if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE) + return 0; + + // this will hold the lowest depth encountered up to now. + depth_type min_depth = getDepth(it); + ParIterator prev_it = it; + while (true) { + if (prev_it.pit()) + --prev_it.top().pit(); + else { + // start of nested inset: go to outer par + prev_it.pop_back(); + if (prev_it.empty()) { + // start of document: nothing to do + return 0; + } + } + + // We search for the first paragraph with same label + // that is not more deeply nested. + Paragraph & prev_par = *prev_it; + depth_type const prev_depth = getDepth(prev_it); + if (labeltype == prev_par.layout().labeltype) { + if (prev_depth < min_depth) + return prev_par.itemdepth + 1; + if (prev_depth == min_depth) + return prev_par.itemdepth; + } + min_depth = min(min_depth, prev_depth); + // small optimization: if we are at depth 0, we won't + // find anything else + if (prev_depth == 0) + return 0; + } +} + + +static bool needEnumCounterReset(ParIterator const & it) +{ + Paragraph const & par = *it; + LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/); + depth_type const cur_depth = par.getDepth(); + ParIterator prev_it = it; + while (prev_it.pit()) { + --prev_it.top().pit(); + Paragraph const & prev_par = *prev_it; + if (prev_par.getDepth() <= cur_depth) + return prev_par.layout().labeltype != LABEL_ENUMERATE; + } + // start of nested inset: reset + return true; +} + + +// set the label of a paragraph. This includes the counters. +static void setLabel(Buffer const & buf, ParIterator & it) +{ + BufferParams const & bp = buf.masterBuffer()->params(); + DocumentClass const & textclass = bp.documentClass(); + Paragraph & par = it.paragraph(); + Layout const & layout = par.layout(); + Counters & counters = textclass.counters(); + + if (par.params().startOfAppendix()) { + // FIXME: only the counter corresponding to toplevel + // sectionning should be reset + counters.reset(); + counters.appendix(true); + } + par.params().appendix(counters.appendix()); + + // Compute the item depth of the paragraph + par.itemdepth = getItemDepth(it); + + if (layout.margintype == MARGIN_MANUAL + || layout.latextype == LATEX_BIB_ENVIRONMENT) { + if (par.params().labelWidthString().empty()) + par.params().labelWidthString(par.expandLabel(layout, bp)); + } else { + par.params().labelWidthString(docstring()); + } + + switch(layout.labeltype) { + case LABEL_COUNTER: + if (layout.toclevel <= bp.secnumdepth + && (layout.latextype != LATEX_ENVIRONMENT + || isFirstInSequence(it.pit(), it.plist()))) { + counters.step(layout.counter); + par.params().labelString( + par.expandLabel(layout, bp)); + } else + par.params().labelString(docstring()); + break; + + case LABEL_ITEMIZE: { + // At some point of time we should do something more + // clever here, like: + // par.params().labelString( + // bp.user_defined_bullet(par.itemdepth).getText()); + // for now, use a simple hardcoded label + docstring itemlabel; + switch (par.itemdepth) { + case 0: + itemlabel = char_type(0x2022); + break; + case 1: + itemlabel = char_type(0x2013); + break; + case 2: + itemlabel = char_type(0x2217); + break; + case 3: + itemlabel = char_type(0x2219); // or 0x00b7 + break; + } + par.params().labelString(itemlabel); + break; + } + + case LABEL_ENUMERATE: { + docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter; + + switch (par.itemdepth) { + case 2: + enumcounter += 'i'; + case 1: + enumcounter += 'i'; + case 0: + enumcounter += 'i'; + break; + case 3: + enumcounter += "iv"; + break; + default: + // not a valid enumdepth... + break; + } + + // Maybe we have to reset the enumeration counter. + if (needEnumCounterReset(it)) + counters.reset(enumcounter); + counters.step(enumcounter); + + string const & lang = par.getParLanguage(bp)->code(); + par.params().labelString(counters.theCounter(enumcounter, lang)); + + break; + } + + case LABEL_SENSITIVE: { + string const & type = counters.current_float(); + docstring full_label; + if (type.empty()) + full_label = buf.B_("Senseless!!! "); + else { + docstring name = buf.B_(textclass.floats().getType(type).name()); + if (counters.hasCounter(from_utf8(type))) { + string const & lang = par.getParLanguage(bp)->code(); + counters.step(from_utf8(type)); + full_label = bformat(from_ascii("%1$s %2$s:"), + name, + counters.theCounter(from_utf8(type), lang)); + } else + full_label = bformat(from_ascii("%1$s #:"), name); + } + par.params().labelString(full_label); + break; + } + + case LABEL_NO_LABEL: + par.params().labelString(docstring()); + break; + + case LABEL_MANUAL: + case LABEL_TOP_ENVIRONMENT: + case LABEL_CENTERED_TOP_ENVIRONMENT: + case LABEL_STATIC: + case LABEL_BIBLIO: + par.params().labelString(par.expandLabel(layout, bp)); + break; + } +} + + +void Buffer::updateLabels(ParIterator & parit) const +{ + LASSERT(parit.pit() == 0, /**/); + + // set the position of the text in the buffer to be able + // to resolve macros in it. This has nothing to do with + // labels, but by putting it here we avoid implementing + // a whole bunch of traversal routines just for this call. + parit.text()->setMacrocontextPosition(parit); + + depth_type maxdepth = 0; + pit_type const lastpit = parit.lastpit(); + for ( ; parit.pit() <= lastpit ; ++parit.pit()) { + // reduce depth if necessary + parit->params().depth(min(parit->params().depth(), maxdepth)); + maxdepth = parit->getMaxDepthAfter(); + + // set the counter for this paragraph + setLabel(*this, parit); + + // Now the insets + InsetList::const_iterator iit = parit->insetList().begin(); + InsetList::const_iterator end = parit->insetList().end(); + for (; iit != end; ++iit) { + parit.pos() = iit->pos; + iit->inset->updateLabels(parit); + } + } +} + + +int Buffer::spellCheck(DocIterator & from, DocIterator & to, + WordLangTuple & word_lang, docstring_list & suggestions) const +{ + int progress = 0; + WordLangTuple wl; + suggestions.clear(); + word_lang = WordLangTuple(); + // OK, we start from here. + DocIterator const end = doc_iterator_end(this); + for (; from != end; from.forwardPos()) { + // We are only interested in text so remove the math CursorSlice. + while (from.inMathed()) + from.forwardInset(); + to = from; + if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) { + word_lang = wl; + break; + } + from = to; + ++progress; + } + return progress; +} + } // namespace lyx