* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Stefan Schimanski
*
* Full author contact details are available in file CREDITS.
#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 "InsetIterator.h"
#include "InsetList.h"
#include "Language.h"
#include "ParagraphParameters.h"
#include "ParIterator.h"
#include "PDFOptions.h"
+#include "SpellChecker.h"
#include "sgml.h"
#include "TexRow.h"
#include "TexStream.h"
#include "Undo.h"
#include "VCBackend.h"
#include "version.h"
+#include "WordLangTuple.h"
#include "WordList.h"
#include "insets/InsetBibitem.h"
#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"
#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 <fstream>
#include <iomanip>
#include <map>
+#include <set>
#include <sstream>
#include <stack>
#include <vector>
// Do not remove the comment below, so we get merge conflict in
// independent branches. Instead add your own.
-int const LYX_FORMAT = 344; // ps: backref
+int const LYX_FORMAT = 351; // uwestoehr: support for page background color
typedef map<string, bool> DepClean;
typedef map<docstring, pair<InsetLabel const *, Buffer::References> > 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<Buffer const *> {};
+
class Buffer::Impl
{
public:
LyXVC lyxvc;
FileName temppath;
mutable TexRow texrow;
- Buffer const * parent_buffer;
/// need to regenerate .tex?
DepClean dep_clean;
/// 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;
};
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);
// 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<Buffer *>(it->first));
+ for (; it != end; ++it) {
+ Buffer * child = const_cast<Buffer *>(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();
}
+TexRow & Buffer::texrow()
+{
+ return d->texrow;
+}
+
+
TexRow const & Buffer::texrow() const
{
return d->texrow;
// 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"];
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."));
}
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.");
+ }
}
}
{
FileName fname(filename);
+ params().compressed = fname.isZippedFile();
+
// remove dummy empty par
paragraphs().clear();
Lexer lex;
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;
}
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;
}
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 {
return false;
}
- removeAutosaveFile(d->filename.absFilename());
+ removeAutosaveFile();
saveCheckSum(d->filename);
message(str + _(" done."));
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;
// 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
// 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;
{
LYXERR(Debug::LATEX, "makeDocBookFile...");
- odocfstream ofs;
+ ofdocstream ofs;
if (!openFileWrite(ofs, fname))
return;
void Buffer::getLabelList(vector<docstring> & 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;
}
}
-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;
}
static_cast<InsetInclude &>(*it);
inset.updateBibfilesCache();
support::FileNameList const & bibfiles =
- inset.getBibfilesCache(*this);
+ inset.getBibfilesCache();
d->bibfilesCache_.insert(d->bibfilesCache_.end(),
bibfiles.begin(),
bibfiles.end());
}
-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<Buffer *>(this)->updateBibfilesCache();
+ const_cast<Buffer *>(this)->updateBibfilesCache(scope);
return d->bibfilesCache_;
}
}
-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_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;
+ 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_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)
+ if (!branch) {
LYXERR0("Branch " << branchName << " does not exist.");
- else
+ 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);
- if (result)
- *result = true;
+ dr.setError(false);
+ 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;
}
- return dispatched;
+ dr.dispatched(dispatched);
}
DocIterator Buffer::getParFromID(int const id) const
{
+ Buffer * buf = const_cast<Buffer *>(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);
}
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));
}
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
+{
+ 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<Buffer *>(it->first));
+}
+
+
+std::vector<Buffer const *> Buffer::allRelatives() const
{
- return d->parent_buffer;
+ BufferSet bufs;
+ collectRelatives(bufs);
+ BufferSet::iterator it = bufs.begin();
+ std::vector<Buffer const *> 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();
}
}
+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 *> Buffer::getChildren() const
+{
+ std::vector<Buffer *> 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<Buffer *>(it->first);
+ clist.push_back(child);
+ // there might be grandchildren
+ std::vector<Buffer *> glist = child->getChildren();
+ for (vector<Buffer *>::const_iterator git = glist.begin();
+ git != glist.end(); ++git)
+ clist.push_back(*git);
+ }
+ return clist;
+}
+
+
template<typename M>
typename M::iterator greatest_below(M & m, typename M::key_type const & x)
{
// 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?
// 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;
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)
// 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
// is it an external file?
if (iit->inset->lyxCode() == INCLUDE_CODE) {
// get buffer of external file
- InsetCommand const & inset
- = static_cast<InsetCommand const &>(*iit->inset);
- InsetCommandParams const & ip = inset.params();
+ InsetInclude const & inset =
+ static_cast<InsetInclude const &>(*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);
continue;
// get macro data
- MathMacroTemplate & macroTemplate
- = static_cast<MathMacroTemplate &>(*iit->inset);
+ MathMacroTemplate & macroTemplate =
+ static_cast<MathMacroTemplate &>(*iit->inset);
MacroContext mc(*this, it);
macroTemplate.updateToContext(mc);
{
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();
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;
}
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();
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);
Buffer::References & Buffer::references(docstring const & label)
{
- if (d->parent_buffer)
+ if (d->parent())
return const_cast<Buffer *>(masterBuffer())->references(label);
RefCache::iterator it = d->ref_cache_.find(label);
void Buffer::clearReferenceCache() const
{
- if (!d->parent_buffer)
+ if (!d->parent())
d->ref_cache_.clear();
}
{
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;
}
+bool Buffer::hasGuiDelegate() const
+{
+ return gui_;
+}
+
+
void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
{
gui_ = gui;
} // namespace anon
+FileName Buffer::getAutosaveFilename() const
+{
+ string const fpath = isUnnamed() ? lyxrc.document_path : filePath();
+ string const fname = "#" + d->filename.onlyFileName() + "#";
+ return makeAbsPath(fname, fpath);
+}
+
+
+void Buffer::removeAutosaveFile() const
+{
+ FileName const f = getAutosaveFilename();
+ if (f.exists())
+ f.removeFile();
+}
+
+
// Perfect target for a thread...
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();
return "docbook";
if (isLiterate())
return "literate";
+ if (params().useXetex)
+ return "xetex";
if (params().encoding().package() == Encoding::japanese)
return "platex";
return "latex";
}
+string Buffer::getDefaultOutputFormat() const
+{
+ if (!params().defaultOutputFormat.empty()
+ && params().defaultOutputFormat != "default")
+ return params().defaultOutputFormat;
+ typedef vector<Format const *> 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
{
makeDocBookFile(FileName(filename), runparams);
}
// LaTeX backend
- else if (!put_in_tempdir) {
+ else if (backend_format == format) {
runparams.nice = true;
if (!makeLaTeXFile(FileName(filename), string(), runparams))
return false;
}
+void Buffer::setBuffersForInsets() const
+{
+ inset().setBuffer(const_cast<Buffer &>(*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<Buffer const *> 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<Buffer &>(*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) {
+ if (par.params().labelWidthString().empty())
+ par.params().labelWidthString(par.translateIfPossible(layout.labelstring(), 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: {
+ // FIXME: Yes I know this is a really, really! bad solution
+ // (Lgb)
+ docstring enumcounter = from_ascii("enum");
+
+ 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 format;
+
+ switch (par.itemdepth) {
+ case 0:
+ format = N_("\\arabic{enumi}.");
+ break;
+ case 1:
+ format = N_("(\\alph{enumii})");
+ break;
+ case 2:
+ format = N_("\\roman{enumiii}.");
+ break;
+ case 3:
+ format = N_("\\Alph{enumiv}.");
+ break;
+ default:
+ // not a valid enumdepth...
+ break;
+ }
+
+ par.params().labelString(counters.counterLabel(
+ par.translateIfPossible(from_ascii(format), bp)));
+
+ 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))) {
+ counters.step(from_utf8(type));
+ full_label = bformat(from_ascii("%1$s %2$s:"),
+ name,
+ counters.theCounter(from_utf8(type)));
+ } 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.translateIfPossible(layout.labelstring(), 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);
+ }
+ }
+}
+
+
+bool Buffer::nextWord(DocIterator & from, DocIterator & to,
+ docstring & word) const
+{
+ bool inword = false;
+ bool ignoreword = false;
+ string lang_code;
+ // Go backward a bit if needed in order to return the word currently
+ // pointed by 'from'.
+ while (from && from.pos() && isLetter(from))
+ from.backwardPos();
+ // OK, we start from here.
+ to = from;
+ while (to.depth()) {
+ if (isLetter(to)) {
+ if (!inword) {
+ inword = true;
+ ignoreword = false;
+ from = to;
+ word.clear();
+ lang_code = to.paragraph().getFontSettings(params(),
+ to.pos()).language()->code();
+ }
+ // Insets like optional hyphens and ligature
+ // break are part of a word.
+ if (!to.paragraph().isInset(to.pos())) {
+ char_type const c = to.paragraph().getChar(to.pos());
+ word += c;
+ if (isDigit(c))
+ ignoreword = true;
+ }
+ } else { // !isLetter(cur)
+ if (inword && !word.empty() && !ignoreword)
+ return true;
+ inword = false;
+ }
+ to.forwardPos();
+ }
+ from = to;
+ word.clear();
+ return false;
+}
+
+
+int Buffer::spellCheck(DocIterator & from, DocIterator & to,
+ WordLangTuple & word_lang, docstring_list & suggestions) const
+{
+ int progress = 0;
+ SpellChecker::Result res = SpellChecker::OK;
+ SpellChecker * speller = theSpellChecker();
+ suggestions.clear();
+ docstring word;
+ while (nextWord(from, to, word)) {
+ ++progress;
+ string lang_code = lyxrc.spellchecker_use_alt_lang
+ ? lyxrc.spellchecker_alt_lang
+ : from.paragraph().getFontSettings(params(), from.pos()).language()->code();
+ WordLangTuple wl(word, lang_code);
+ res = speller->check(wl);
+ // ... just bail out if the spellchecker reports an error.
+ if (!speller->error().empty()) {
+ throw ExceptionMessage(WarningException,
+ _("The spellchecker has failed."), speller->error());
+ }
+ if (res != SpellChecker::OK && res != SpellChecker::IGNORED_WORD) {
+ word_lang = wl;
+ break;
+ }
+ from = to;
+ }
+ while (!(word = speller->nextMiss()).empty())
+ suggestions.push_back(word);
+ return progress;
+}
+
} // namespace lyx