#include "Buffer.h"
#include "Author.h"
+#include "LayoutFile.h"
#include "BiblioInfo.h"
#include "BranchList.h"
#include "buffer_funcs.h"
#include "Converter.h"
#include "Counters.h"
#include "DocIterator.h"
-#include "EmbeddedFiles.h"
#include "Encoding.h"
#include "ErrorList.h"
#include "Exporter.h"
#include "ParagraphParameters.h"
#include "ParIterator.h"
#include "PDFOptions.h"
-#include "Session.h"
#include "sgml.h"
#include "TexRow.h"
#include "TexStream.h"
-#include "TextClassList.h"
#include "Text.h"
+#include "TextClass.h"
#include "TocBackend.h"
#include "Undo.h"
#include "VCBackend.h"
#include "version.h"
+#include "WordList.h"
#include "insets/InsetBibitem.h"
#include "insets/InsetBibtex.h"
#include "graphics/Previews.h"
+#include "support/assert.h"
#include "support/convert.h"
#include "support/debug.h"
-#include "support/FileFilterList.h"
+#include "support/ExceptionMessage.h"
+#include "support/FileName.h"
#include "support/FileNameList.h"
#include "support/filetools.h"
#include "support/ForkedCalls.h"
#include "support/gzstream.h"
#include "support/lstrings.h"
#include "support/lyxalgo.h"
-#include "support/lyxlib.h"
#include "support/os.h"
+#include "support/Package.h"
#include "support/Path.h"
#include "support/textutils.h"
#include "support/types.h"
#include "support/FileZipListDir.h"
-#if !defined (HAVE_FORK)
-# define fork() -1
-#endif
-
#include <boost/bind.hpp>
#include <boost/shared_ptr.hpp>
#include <algorithm>
+#include <fstream>
#include <iomanip>
-#include <stack>
+#include <map>
#include <sstream>
-#include <fstream>
+#include <stack>
+#include <vector>
using namespace std;
using namespace lyx::support;
namespace {
-int const LYX_FORMAT = 308; // Uwe: Serbian-Latin
-
-} // namespace anon
-
+int const LYX_FORMAT = 328;
typedef map<string, bool> DepClean;
+typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
+
+} // namespace anon
class Buffer::Impl
{
BufferParams params;
LyXVC lyxvc;
- string temppath;
+ FileName temppath;
mutable TexRow texrow;
Buffer const * parent_buffer;
*/
bool file_fully_loaded;
- /// our Text that should be wrapped in an InsetText
- InsetText inset;
-
///
mutable TocBackend toc_backend;
- /// macro table
- typedef map<unsigned int, MacroData, greater<int> > PositionToMacroMap;
- typedef map<docstring, PositionToMacroMap> NameToPositionMacroMap;
- NameToPositionMacroMap macros;
+ /// macro tables
+ typedef pair<DocIterator, MacroData> ScopeMacro;
+ typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
+ typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
+ /// map from the macro name to the position map,
+ /// which maps the macro definition position to the scope and the MacroData.
+ NamePositionScopeMacroMap macros;
+ bool macro_lock;
+
+ /// positions of child buffers in the buffer
+ typedef map<Buffer const * const, DocIterator> BufferPositionMap;
+ typedef pair<DocIterator, Buffer const *> ScopeBuffer;
+ typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
+ /// position of children buffers in this buffer
+ BufferPositionMap children_positions;
+ /// map from children inclusion positions to their scope and their buffer
+ PositionScopeBufferMap position_to_children;
/// Container for all sort of Buffer dependant errors.
map<string, ErrorList> errorLists;
- /// all embedded files of this buffer
- EmbeddedFiles embedded_files;
-
/// timestamp and checksum used to test if the file has been externally
/// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
time_t timestamp_;
/// A cache for the bibfiles (including bibfiles of loaded child
/// documents), needed for appropriate update of natbib labels.
- mutable FileNameList bibfilesCache_;
+ mutable support::FileNameList bibfilesCache_;
+
+ mutable RefCache ref_cache_;
+
+ /// our Text that should be wrapped in an InsetText
+ InsetText inset;
};
+/// Creates the per buffer temporary directory
+static FileName createBufferTmpDir()
+{
+ static int count;
+ // We are in our own directory. Why bother to mangle name?
+ // In fact I wrote this code to circumvent a problematic behaviour
+ // (bug?) of EMX mkstemp().
+ FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
+ convert<string>(count++));
+
+ if (!tmpfl.createDirectory(0777)) {
+ throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
+ _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
+ from_utf8(tmpfl.absFilename())));
+ }
+ return tmpfl;
+}
+
+
Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
: parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
read_only(readonly_), filename(file), file_fully_loaded(false),
- inset(params), toc_backend(&parent), embedded_files(&parent),
+ toc_backend(&parent), macro_lock(false),
timestamp_(0), checksum_(0), wa_(0), undo_(parent)
{
- inset.setAutoBreakRows(true);
- lyxvc.setBuffer(&parent);
temppath = createBufferTmpDir();
-
- // FIXME: And now do something if temppath == string(), because we
- // assume from now on that temppath points to a valid temp dir.
- // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
-
+ lyxvc.setBuffer(&parent);
if (use_gui)
wa_ = new frontend::WorkAreaManager;
}
: d(new Impl(*this, FileName(file), readonly)), gui_(0)
{
LYXERR(Debug::INFO, "Buffer::Buffer()");
+
+ d->inset.setBuffer(*this);
+ d->inset.initParagraphs(*this);
+ d->inset.setAutoBreakRows(true);
+ d->inset.getText(0)->setMacrocontextPosition(par_iterator_begin());
}
// GuiView already destroyed
gui_ = 0;
- Buffer const * master = masterBuffer();
- if (master != this && use_gui)
- // We are closing buf which was a child document so we
- // must update the labels and section numbering of its master
- // Buffer.
- updateLabels(*master);
+ // clear references to children in macro tables
+ d->children_positions.clear();
+ d->position_to_children.clear();
- resetChildDocuments(false);
-
- if (!temppath().empty() && !FileName(temppath()).destroyDirectory()) {
+ if (!d->temppath.destroyDirectory()) {
Alert::warning(_("Could not remove temporary directory"),
bformat(_("Could not remove the temporary directory %1$s"),
- from_utf8(temppath())));
+ from_utf8(d->temppath.absFilename())));
}
// Remove any previewed LaTeX snippets associated with this buffer.
frontend::WorkAreaManager & Buffer::workAreaManager() const
{
- BOOST_ASSERT(d->wa_);
+ LASSERT(d->wa_, /**/);
return *d->wa_;
}
}
-string const & Buffer::temppath() const
+string const Buffer::temppath() const
{
- return d->temppath;
+ return d->temppath.absFilename();
}
}
-EmbeddedFiles & Buffer::embeddedFiles()
-{
- return d->embedded_files;
-}
-
-
-EmbeddedFiles const & Buffer::embeddedFiles() const
-{
- return d->embedded_files;
-}
-
-
Undo & Buffer::undo()
{
return d->undo_;
params().headheight.erase();
params().headsep.erase();
params().footskip.erase();
+ params().columnsep.erase();
params().listings_params.clear();
params().clearLayoutModules();
params().pdfoptions().clear();
ErrorList & errorList = d->errorLists["Parse"];
while (lex.isOK()) {
- lex.next();
- string const token = lex.getString();
+ string token;
+ lex >> token;
if (token.empty())
continue;
errorList.push_back(ErrorItem(_("Document header error"),
s, -1, 0, 0));
}
+
+ params().makeDocumentClass();
return unknown_tokens;
}
ErrorList & errorList = d->errorLists["Parse"];
errorList.clear();
- lex.next();
- string const token = lex.getString();
- if (token != "\\begin_document") {
+ if (!lex.checkFor("\\begin_document")) {
docstring const s = _("\\begin_document is missing");
errorList.push_back(ErrorItem(_("Document header error"),
s, -1, 0, 0));
}
// we are reading in a brand new document
- BOOST_ASSERT(paragraphs().empty());
+ LASSERT(paragraphs().empty(), /**/);
readHeader(lex);
- TextClass const & baseClass = textclasslist[params().getBaseClass()];
- if (!baseClass.load(filePath())) {
- string theclass = baseClass.name();
- Alert::error(_("Can't load document class"), bformat(
- _("Using the default document class, because the "
- "class %1$s could not be loaded."), from_utf8(theclass)));
- params().setBaseClass(defaultTextclass());
- }
if (params().outputChanges) {
bool dvipost = LaTeXFeatures::isAvailable("dvipost");
}
// read main text
- bool const res = text().read(*this, lex, errorList);
- for_each(text().paragraphs().begin(),
- text().paragraphs().end(),
- bind(&Paragraph::setInsetOwner, _1, &inset()));
+ bool const res = text().read(*this, lex, errorList, &(d->inset));
+ updateMacros();
+ updateMacroInstances();
return res;
}
if (*cit == '\n') {
if (autobreakrows && (!par.empty() || par.allowEmpty())) {
breakParagraph(params(), pars, pit, pos,
- par.layout()->isEnvironment());
+ par.layout().isEnvironment());
++pit;
pos = 0;
space_inserted = true;
// remove dummy empty par
paragraphs().clear();
- Lexer lex(0, 0);
+ Lexer lex;
istringstream is(s);
lex.setStream(is);
- FileName const name(tempName());
+ FileName const name = FileName::tempName();
switch (readFile(lex, name, true)) {
case failure:
return false;
// decompress to a temp directory
LYXERR(Debug::FILES, filename << " is in zip format. Unzip to " << temppath());
::unzipToDir(filename.toFilesystemEncoding(), temppath());
- //
- FileName lyxfile(addName(temppath(), "content.lyx"));
- // if both manifest.txt and file.lyx exist, this is am embedded file
- if (lyxfile.exists()) {
- params().embedded = true;
- fname = lyxfile;
- }
}
- // The embedded lyx file can also be compressed, for backward compatibility
- format = fname.guessFormatFromContents();
- if (format == "gzip" || format == "zip" || format == "compress")
- params().compressed = true;
// remove dummy empty par
paragraphs().clear();
- Lexer lex(0, 0);
+ Lexer lex;
lex.setFile(fname);
if (readFile(lex, fname) != success)
return false;
Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
bool fromstring)
{
- BOOST_ASSERT(!filename.empty());
-
- if (!lex.isOK()) {
- Alert::error(_("Document could not be read"),
- bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
- return failure;
- }
-
- lex.next();
- string const token = lex.getString();
-
- if (!lex) {
- Alert::error(_("Document could not be read"),
- bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
- return failure;
- }
-
- // the first token _must_ be...
- if (token != "\\lyxformat") {
- lyxerr << "Token: " << token << endl;
+ LASSERT(!filename.empty(), /**/);
+ // the first (non-comment) token _must_ be...
+ if (!lex.checkFor("\\lyxformat")) {
Alert::error(_("Document format failure"),
- bformat(_("%1$s is not a LyX document."),
+ bformat(_("%1$s is not a readable LyX document."),
from_utf8(filename.absFilename())));
return failure;
}
- lex.next();
- string tmp_format = lex.getString();
+ string tmp_format;
+ lex >> tmp_format;
//lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
// if present remove ".," from string.
- string::size_type dot = tmp_format.find_first_of(".,");
+ size_t dot = tmp_format.find_first_of(".,");
//lyxerr << " dot found at " << dot << endl;
if (dot != string::npos)
tmp_format.erase(dot, 1);
// lyx2lyx would fail
return wrongversion;
- FileName const tmpfile(tempName());
+ FileName const tmpfile = FileName::tempName();
if (tmpfile.empty()) {
Alert::error(_("Conversion failed"),
bformat(_("%1$s is from a different"
backupName = FileName(addName(lyxrc.backupdir_path,
mangledName));
}
- if (fileName().copyTo(backupName, true)) {
+ if (fileName().copyTo(backupName)) {
madeBackup = true;
} else {
Alert::error(_("Backup failure"),
} else {
// Saving failed, so backup is not backup
if (madeBackup)
- backupName.renameTo(d->filename);
+ backupName.moveTo(d->filename);
return false;
}
}
bool retval = false;
- FileName content;
- if (params().embedded)
- // first write the .lyx file to the temporary directory
- content = FileName(addName(temppath(), "content.lyx"));
- else
- content = fname;
-
docstring const str = bformat(_("Saving document %1$s..."),
- makeDisplayPath(content.absFilename()));
+ makeDisplayPath(fname.absFilename()));
message(str);
if (params().compressed) {
- gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
+ gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
retval = ofs && write(ofs);
} else {
- ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
+ ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
retval = ofs && write(ofs);
}
if (!retval) {
- message(str + _(" could not write file!."));
+ message(str + _(" could not write file!"));
return false;
}
removeAutosaveFile(d->filename.absFilename());
+
saveCheckSum(d->filename);
message(str + _(" done."));
- if (!params().embedded)
- return true;
-
- message(str + _(" writing embedded files!."));
- // if embedding is enabled, write file.lyx and all the embedded files
- // to the zip file fname.
- if (!d->embedded_files.writeFile(fname)) {
- message(str + _(" could not write embedded files!."));
- return false;
- }
- message(str + _(" error while writing embedded files."));
return true;
}
<< "\\lyxformat " << LYX_FORMAT << "\n"
<< "\\begin_document\n";
-
/// For each author, set 'used' to true if there is a change
/// by this author in the document; otherwise set it to 'false'.
AuthorList::Authors::const_iterator a_it = params().authors().begin();
for (; a_it != a_end; ++a_it)
a_it->second.setUsed(false);
- ParIterator const end = par_iterator_end();
- ParIterator it = par_iterator_begin();
+ ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
+ ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
for ( ; it != end; ++it)
it->checkAuthors(params().authors());
return false;
//TexStream ts(ofs.rdbuf(), &texrow());
-
+ ErrorList & errorList = d->errorLists["Export"];
+ errorList.clear();
bool failed_export = false;
try {
d->texrow.reset();
writeLaTeXSource(ofs, original_path,
runparams, output_preamble, output_body);
}
+ catch (EncodingException & e) {
+ odocstringstream ods;
+ ods.put(e.failed_char);
+ ostringstream oss;
+ oss << "0x" << hex << e.failed_char << dec;
+ docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
+ " (code point %2$s)"),
+ ods.str(), from_utf8(oss.str()));
+ errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
+ "representable in the chosen encoding.\n"
+ "Changing the document encoding to utf8 could help."),
+ e.par_id, e.pos, e.pos + 1));
+ failed_export = true;
+ }
catch (iconv_codecvt_facet_exception & e) {
- lyxerr << "Caught iconv exception: " << e.what() << endl;
+ errorList.push_back(ErrorItem(_("iconv conversion failed"),
+ _(e.what()), -1, 0, 0));
failed_export = true;
}
catch (exception const & e) {
- lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
+ errorList.push_back(ErrorItem(_("conversion failed"),
+ _(e.what()), -1, 0, 0));
failed_export = true;
}
catch (...) {
lyxerr << "Caught some really weird exception..." << endl;
- LyX::cref().emergencyCleanup();
- lyx::support::abort();
+ LyX::cref().exit(1);
}
ofs.close();
lyxerr << "File '" << fname << "' was not closed properly." << endl;
}
- if (failed_export) {
- Alert::error(_("Encoding error"),
- _("Some characters of your document are probably not "
- "representable in the chosen encoding.\n"
- "Changing the document encoding to utf8 could help."));
- return false;
- }
- return true;
+ errors("Export");
+ return !failed_export;
}
OutputParams const & runparams_in,
bool const output_preamble, bool const output_body) const
{
+ // The child documents, if any, shall be already loaded at this point.
+
OutputParams runparams = runparams_in;
// validate the buffer.
d->texrow.newline();
}
LYXERR(Debug::INFO, "lyx document header finished");
+
+ // Don't move this behind the parent_buffer=0 code below,
+ // because then the macros will not get the right "redefinition"
+ // flag as they don't see the parent macros which are output before.
+ updateMacros();
+
+ // fold macros if possible, still with parent buffer as the
+ // macros will be put in the prefix anyway.
+ updateMacroInstances();
+
// There are a few differences between nice LaTeX and usual files:
// usual is \batchmode and has a
// special input@path to allow the including of figures
d->texrow.newline();
}
+ // get parent macros (if this buffer has a parent) which will be
+ // written at the document begin further down.
+ MacroSet parentMacros;
+ listParentMacros(parentMacros, features);
+
// Write the preamble
runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
// make the body.
os << "\\begin{document}\n";
d->texrow.newline();
+
+ // output the parent macros
+ MacroSet::iterator it = parentMacros.begin();
+ MacroSet::iterator end = parentMacros.end();
+ for (; it != end; ++it)
+ (*it)->write(os, true);
} // output_preamble
d->texrow.start(paragraphs().begin()->id(), 0);
d->parent_buffer = 0;
}
- loadChildDocuments();
-
// the real stuff
- latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
+ latexParagraphs(*this, text(), os, d->texrow, runparams);
// Restore the parenthood if needed
if (output_preamble)
bool Buffer::isLatex() const
{
- return params().getTextClass().outputType() == LATEX;
+ return params().documentClass().outputType() == LATEX;
}
bool Buffer::isLiterate() const
{
- return params().getTextClass().outputType() == LITERATE;
+ return params().documentClass().outputType() == LITERATE;
}
bool Buffer::isDocBook() const
{
- return params().getTextClass().outputType() == DOCBOOK;
+ return params().documentClass().outputType() == DOCBOOK;
}
{
LYXERR(Debug::LATEX, "makeDocBookFile...");
- //ofstream ofs;
odocfstream ofs;
if (!openFileWrite(ofs, fname))
return;
d->texrow.reset();
- TextClass const & tclass = params().getTextClass();
+ DocumentClass const & tclass = params().documentClass();
string const top_element = tclass.latexname();
if (!only_body) {
<< " file was created by LyX " << lyx_version
<< "\n See http://www.lyx.org/ for more information -->\n";
- params().getTextClass().counters().reset();
+ params().documentClass().counters().reset();
- loadChildDocuments();
+ updateMacros();
sgml::openTag(os, top);
os << '\n';
{
params().validate(features);
- loadChildDocuments();
+ updateMacros();
for_each(paragraphs().begin(), paragraphs().end(),
boost::bind(&Paragraph::validate, _1, boost::ref(features)));
void Buffer::getLabelList(vector<docstring> & list) const
{
- /// if this is a child document and the parent is already loaded
- /// Use the parent's list instead [ale990407]
- Buffer const * tmp = masterBuffer();
- if (!tmp) {
- lyxerr << "masterBuffer() failed!" << endl;
- BOOST_ASSERT(tmp);
- }
- if (tmp != this) {
- tmp->getLabelList(list);
+ // If this is a child document, use the parent's list instead.
+ if (d->parent_buffer) {
+ d->parent_buffer->getLabelList(list);
return;
}
- loadChildDocuments();
-
- for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
- it.nextInset()->getLabelList(*this, list);
+ list.clear();
+ Toc & toc = d->toc_backend.toc("label");
+ TocIterator toc_it = toc.begin();
+ TocIterator end = toc.end();
+ for (; toc_it != end; ++toc_it) {
+ if (toc_it->depth() == 0)
+ list.push_back(toc_it->str());
+ }
}
void Buffer::updateBibfilesCache() const
{
- // if this is a child document and the parent is already loaded
- // update the parent's cache instead
- Buffer const * tmp = masterBuffer();
- BOOST_ASSERT(tmp);
- if (tmp != this) {
- tmp->updateBibfilesCache();
+ // If this is a child document, use the parent's cache instead.
+ if (d->parent_buffer) {
+ d->parent_buffer->updateBibfilesCache();
return;
}
if (it->lyxCode() == BIBTEX_CODE) {
InsetBibtex const & inset =
static_cast<InsetBibtex const &>(*it);
- FileNameList const bibfiles = inset.getFiles(*this);
+ support::FileNameList const bibfiles = inset.getBibFiles();
d->bibfilesCache_.insert(d->bibfilesCache_.end(),
bibfiles.begin(),
bibfiles.end());
} else if (it->lyxCode() == INCLUDE_CODE) {
InsetInclude & inset =
static_cast<InsetInclude &>(*it);
- inset.updateBibfilesCache(*this);
- FileNameList const & bibfiles =
+ inset.updateBibfilesCache();
+ support::FileNameList const & bibfiles =
inset.getBibfilesCache(*this);
d->bibfilesCache_.insert(d->bibfilesCache_.end(),
bibfiles.begin(),
}
-FileNameList const & Buffer::getBibfilesCache() const
+support::FileNameList const & Buffer::getBibfilesCache() const
{
- // if this is a child document and the parent is already loaded
- // use the parent's cache instead
- Buffer const * tmp = masterBuffer();
- BOOST_ASSERT(tmp);
- if (tmp != this)
- return tmp->getBibfilesCache();
+ // If this is a child document, use the parent's cache instead.
+ if (d->parent_buffer)
+ return d->parent_buffer->getBibfilesCache();
// We update the cache when first used instead of at loading time.
if (d->bibfilesCache_.empty())
void Buffer::changeLanguage(Language const * from, Language const * to)
{
- BOOST_ASSERT(from);
- BOOST_ASSERT(to);
+ LASSERT(from, /**/);
+ LASSERT(to, /**/);
for_each(par_iterator_begin(),
par_iterator_end(),
}
-ParIterator Buffer::getParFromID(int const id) const
+DocIterator Buffer::getParFromID(int const id) const
{
- ParConstIterator it = par_iterator_begin();
- ParConstIterator const end = par_iterator_end();
-
if (id < 0) {
// John says this is called with id == -1 from undo
lyxerr << "getParFromID(), id: " << id << endl;
- return end;
+ return doc_iterator_end(inset());
}
- for (; it != end; ++it)
- if (it->id() == id)
+ for (DocIterator it = doc_iterator_begin(inset()); !it.atEnd(); it.forwardPar())
+ if (it.paragraph().id() == id)
return it;
- return end;
+ return doc_iterator_end(inset());
}
bool Buffer::hasParWithID(int const id) const
{
- ParConstIterator const it = getParFromID(id);
- return it != par_iterator_end();
+ return !getParFromID(id).atEnd();
}
ParIterator Buffer::par_iterator_begin()
{
- return lyx::par_iterator_begin(inset());
+ return ParIterator(doc_iterator_begin(inset()));
}
ParIterator Buffer::par_iterator_end()
{
- return lyx::par_iterator_end(inset());
+ return ParIterator(doc_iterator_end(inset()));
}
bool Buffer::isExternallyModified(CheckMethod method) const
{
- BOOST_ASSERT(d->filename.exists());
+ LASSERT(d->filename.exists(), /**/);
// if method == timestamp, check timestamp before checksum
return (method == checksum_method
|| d->timestamp_ != d->filename.lastModified())
string Buffer::filePath() const
{
- return d->filename.onlyPath().absFilename();
+ return d->filename.onlyPath().absFilename() + "/";
}
{
// Avoids recursive include.
d->parent_buffer = buffer == this ? 0 : buffer;
+ updateMacros();
}
}
-bool Buffer::hasMacro(docstring const & name, Paragraph const & par) const
+template<typename M>
+typename M::iterator greatest_below(M & m, typename M::key_type const & x)
{
- Impl::PositionToMacroMap::iterator it;
- it = d->macros[name].upper_bound(par.macrocontextPosition());
- if (it != d->macros[name].end())
- return true;
+ if (m.empty())
+ return m.end();
- // If there is a master buffer, query that
- Buffer const * master = masterBuffer();
- if (master && master != this)
- return master->hasMacro(name);
+ typename M::iterator it = m.lower_bound(x);
+ if (it == m.begin())
+ return m.end();
- return MacroTable::globalMacros().has(name);
+ it--;
+ return it;
}
-bool Buffer::hasMacro(docstring const & name) const
+MacroData const * Buffer::getBufferMacro(docstring const & name,
+ DocIterator const & pos) const
{
- if( !d->macros[name].empty() )
- return true;
+ LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
- // If there is a master buffer, query that
- Buffer const * master = masterBuffer();
- if (master && master != this)
- return master->hasMacro(name);
+ // if paragraphs have no macro context set, pos will be empty
+ if (pos.empty())
+ return 0;
- return MacroTable::globalMacros().has(name);
+ // we haven't found anything yet
+ DocIterator bestPos = par_iterator_begin();
+ MacroData const * bestData = 0;
+
+ // find macro definitions for name
+ Impl::NamePositionScopeMacroMap::iterator nameIt
+ = 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);
+ if (it != nameIt->second.end()) {
+ while (true) {
+ // scope ends behind pos?
+ if (pos < it->second.first) {
+ // Looks good, remember this. If there
+ // is no external macro behind this,
+ // we found the right one already.
+ bestPos = it->first;
+ bestData = &it->second.second;
+ break;
+ }
+
+ // try previous macro if there is one
+ if (it == nameIt->second.begin())
+ break;
+ it--;
+ }
+ }
+ }
+
+ // find macros in included files
+ Impl::PositionScopeBufferMap::const_iterator it
+ = greatest_below(d->position_to_children, pos);
+ if (it == d->position_to_children.end())
+ // no children before
+ return bestData;
+
+ while (true) {
+ // do we know something better (i.e. later) already?
+ if (it->first < bestPos )
+ break;
+
+ // scope ends behind pos?
+ if (pos < it->second.first) {
+ // look for macro in external file
+ d->macro_lock = true;
+ MacroData const * data
+ = it->second.second->getMacro(name, false);
+ d->macro_lock = false;
+ if (data) {
+ bestPos = it->first;
+ bestData = data;
+ break;
+ }
+ }
+
+ // try previous file if there is one
+ if (it == d->position_to_children.begin())
+ break;
+ --it;
+ }
+
+ // return the best macro we have found
+ return bestData;
}
-MacroData const & Buffer::getMacro(docstring const & name,
- Paragraph const & par) const
+MacroData const * Buffer::getMacro(docstring const & name,
+ DocIterator const & pos, bool global) const
{
- Impl::PositionToMacroMap::iterator it;
- it = d->macros[name].upper_bound(par.macrocontextPosition());
- if( it != d->macros[name].end() )
- return it->second;
+ if (d->macro_lock)
+ return 0;
+
+ // query buffer macros
+ MacroData const * data = getBufferMacro(name, pos);
+ if (data != 0)
+ return data;
// If there is a master buffer, query that
- Buffer const * master = masterBuffer();
- if (master && master != this)
- return master->getMacro(name);
+ if (d->parent_buffer) {
+ d->macro_lock = true;
+ MacroData const * macro = d->parent_buffer->getMacro(
+ name, *this, false);
+ d->macro_lock = false;
+ if (macro)
+ return macro;
+ }
+
+ if (global) {
+ data = MacroTable::globalMacros().get(name);
+ if (data != 0)
+ return data;
+ }
- return MacroTable::globalMacros().get(name);
+ return 0;
}
-MacroData const & Buffer::getMacro(docstring const & name) const
+MacroData const * Buffer::getMacro(docstring const & name, bool global) const
{
- Impl::PositionToMacroMap::iterator it;
- it = d->macros[name].begin();
- if( it != d->macros[name].end() )
- return it->second;
+ // set scope end behind the last paragraph
+ DocIterator scope = par_iterator_begin();
+ scope.pit() = scope.lastpit() + 1;
+
+ return getMacro(name, scope, global);
+}
- // If there is a master buffer, query that
- Buffer const * master = masterBuffer();
- if (master && master != this)
- return master->getMacro(name);
- return MacroTable::globalMacros().get(name);
+MacroData const * Buffer::getMacro(docstring const & name,
+ Buffer const & child, bool global) const
+{
+ // look where the child buffer is included first
+ Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
+ if (it == d->children_positions.end())
+ return 0;
+
+ // check for macros at the inclusion position
+ return getMacro(name, it->second, global);
}
-void Buffer::updateMacros()
+void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
{
- // start with empty table
- d->macros = Impl::NameToPositionMacroMap();
-
- // Iterate over buffer
- ParagraphList & pars = text().paragraphs();
- for (size_t i = 0, n = pars.size(); i != n; ++i) {
- // set position again
- pars[i].setMacrocontextPosition(i);
-
- //lyxerr << "searching main par " << i
- // << " for macro definitions" << endl;
- InsetList const & insets = pars[i].insetList();
- InsetList::const_iterator it = insets.begin();
+ pit_type lastpit = it.lastpit();
+
+ // look for macros in each paragraph
+ while (it.pit() <= lastpit) {
+ Paragraph & par = it.paragraph();
+
+ // iterate over the insets of the current paragraph
+ InsetList const & insets = par.insetList();
+ InsetList::const_iterator iit = insets.begin();
InsetList::const_iterator end = insets.end();
- for ( ; it != end; ++it) {
- if (it->inset->lyxCode() != MATHMACRO_CODE)
+ for (; iit != end; ++iit) {
+ it.pos() = iit->pos;
+
+ // is it a nested text inset?
+ if (iit->inset->asInsetText()) {
+ // Inset needs its own scope?
+ InsetText const * itext
+ = iit->inset->asInsetText();
+ bool newScope = itext->isMacroScope();
+
+ // scope which ends just behind the inset
+ DocIterator insetScope = it;
+ ++insetScope.pos();
+
+ // collect macros in inset
+ it.push_back(CursorSlice(*iit->inset));
+ updateMacros(it, newScope ? insetScope : scope);
+ it.pop_back();
+ continue;
+ }
+
+ // 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();
+ d->macro_lock = true;
+ Buffer * child = loadIfNeeded(*this, ip);
+ 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;
+
+ // register child with its scope
+ d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
+ continue;
+ }
+
+ if (iit->inset->lyxCode() != MATHMACRO_CODE)
continue;
// get macro data
- MathMacroTemplate const & macroTemplate
- = static_cast<MathMacroTemplate const &>(*it->inset);
+ MathMacroTemplate & macroTemplate
+ = static_cast<MathMacroTemplate &>(*iit->inset);
+ MacroContext mc(*this, it);
+ macroTemplate.updateToContext(mc);
// valid?
- if (macroTemplate.validMacro()) {
- MacroData macro = macroTemplate.asMacroData();
+ bool valid = macroTemplate.validMacro();
+ // FIXME: Should be fixNameAndCheckIfValid() in fact,
+ // then the BufferView's cursor will be invalid in
+ // some cases which leads to crashes.
+ if (!valid)
+ continue;
- // redefinition?
- // call hasMacro here instead of directly querying mc to
- // also take the master document into consideration
- macro.setRedefinition(hasMacro(macroTemplate.name()));
+ // register macro
+ d->macros[macroTemplate.name()][it] =
+ Impl::ScopeMacro(scope, MacroData(*this, it));
+ }
- // register macro (possibly overwrite the previous one of this paragraph)
- d->macros[macroTemplate.name()][i] = macro;
- }
+ // next paragraph
+ it.pit()++;
+ it.pos() = 0;
+ }
+}
+
+
+void Buffer::updateMacros() const
+{
+ if (d->macro_lock)
+ return;
+
+ LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
+
+ // start with empty table
+ d->macros.clear();
+ d->children_positions.clear();
+ d->position_to_children.clear();
+
+ // Iterate over buffer, starting with first paragraph
+ // The scope must be bigger than any lookup DocIterator
+ // later. For the global lookup, lastpit+1 is used, hence
+ // we use lastpit+2 here.
+ DocIterator it = par_iterator_begin();
+ DocIterator outerScope = it;
+ outerScope.pit() = outerScope.lastpit() + 2;
+ updateMacros(it, outerScope);
+}
+
+
+void Buffer::updateMacroInstances() const
+{
+ LYXERR(Debug::MACROS, "updateMacroInstances for "
+ << d->filename.onlyFileName());
+ DocIterator it = doc_iterator_begin(inset());
+ DocIterator end = doc_iterator_end(inset());
+ for (; it != end; it.forwardPos()) {
+ // look for MathData cells in InsetMathNest insets
+ Inset * inset = it.nextInset();
+ if (!inset)
+ continue;
+
+ InsetMath * minset = inset->asInsetMath();
+ if (!minset)
+ continue;
+
+ // update macro in all cells of the InsetMathNest
+ DocIterator::idx_type n = minset->nargs();
+ MacroContext mc = MacroContext(*this, it);
+ for (DocIterator::idx_type i = 0; i < n; ++i) {
+ MathData & data = minset->cell(i);
+ data.updateMacros(0, mc);
}
}
}
+void Buffer::listMacroNames(MacroNameSet & macros) const
+{
+ if (d->macro_lock)
+ return;
+
+ d->macro_lock = true;
+
+ // loop over macro names
+ Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
+ Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
+ for (; nameIt != nameEnd; ++nameIt)
+ macros.insert(nameIt->first);
+
+ // loop over children
+ Impl::BufferPositionMap::iterator it = d->children_positions.begin();
+ Impl::BufferPositionMap::iterator end = d->children_positions.end();
+ for (; it != end; ++it)
+ it->first->listMacroNames(macros);
+
+ // call parent
+ if (d->parent_buffer)
+ d->parent_buffer->listMacroNames(macros);
+
+ d->macro_lock = false;
+}
+
+
+void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
+{
+ if (!d->parent_buffer)
+ return;
+
+ MacroNameSet names;
+ d->parent_buffer->listMacroNames(names);
+
+ // resolve macros
+ MacroNameSet::iterator it = names.begin();
+ MacroNameSet::iterator end = names.end();
+ for (; it != end; ++it) {
+ // defined?
+ MacroData const * data =
+ d->parent_buffer->getMacro(*it, *this, false);
+ if (data) {
+ macros.insert(data);
+
+ // we cannot access the original MathMacroTemplate anymore
+ // here to calls validate method. So we do its work here manually.
+ // FIXME: somehow make the template accessible here.
+ if (data->optionals() > 0)
+ features.require("xargs");
+ }
+ }
+}
+
+
+Buffer::References & Buffer::references(docstring const & label)
+{
+ if (d->parent_buffer)
+ return const_cast<Buffer *>(masterBuffer())->references(label);
+
+ RefCache::iterator it = d->ref_cache_.find(label);
+ if (it != d->ref_cache_.end())
+ return it->second.second;
+
+ static InsetLabel const * dummy_il = 0;
+ static References const dummy_refs;
+ it = d->ref_cache_.insert(
+ make_pair(label, make_pair(dummy_il, dummy_refs))).first;
+ return it->second.second;
+}
+
+
+Buffer::References const & Buffer::references(docstring const & label) const
+{
+ return const_cast<Buffer *>(this)->references(label);
+}
+
+
+void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
+{
+ masterBuffer()->d->ref_cache_[label].first = il;
+}
+
+
+InsetLabel const * Buffer::insetLabel(docstring const & label) const
+{
+ return masterBuffer()->d->ref_cache_[label].first;
+}
+
+
+void Buffer::clearReferenceCache() const
+{
+ if (!d->parent_buffer)
+ d->ref_cache_.clear();
+}
+
+
void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
InsetCode code)
{
//FIXME: This does not work for child documents yet.
- BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
+ LASSERT(code == CITE_CODE, /**/);
// Check if the label 'from' appears more than once
vector<docstring> labels;
-
string paramName;
- if (code == CITE_CODE) {
- BiblioInfo keys;
- keys.fillWithBibKeys(this);
- BiblioInfo::const_iterator bit = keys.begin();
- BiblioInfo::const_iterator bend = keys.end();
+ BiblioInfo keys;
+ keys.fillWithBibKeys(this);
+ BiblioInfo::const_iterator bit = keys.begin();
+ BiblioInfo::const_iterator bend = keys.end();
- for (; bit != bend; ++bit)
- // FIXME UNICODE
- labels.push_back(bit->first);
- paramName = "key";
- } else {
- getLabelList(labels);
- paramName = "reference";
- }
+ for (; bit != bend; ++bit)
+ // FIXME UNICODE
+ labels.push_back(bit->first);
+ paramName = "key";
if (count(labels.begin(), labels.end(), from) > 1)
return;
d->texrow.newline();
if (isLatex())
writeLaTeXSource(os, filePath(), runparams, true, true);
- else {
+ else
writeDocBookSource(os, absFileName(), runparams, false);
- }
} else {
runparams.par_begin = par_begin;
runparams.par_end = par_end;
- if (par_begin + 1 == par_end)
+ if (par_begin + 1 == par_end) {
os << "% "
<< bformat(_("Preview source code for paragraph %1$d"), par_begin)
<< "\n\n";
- else
+ } else {
os << "% "
<< bformat(_("Preview source code from paragraph %1$s to %2$s"),
convert<docstring>(par_begin),
convert<docstring>(par_end - 1))
<< "\n\n";
+ }
d->texrow.newline();
d->texrow.newline();
// output paragraphs
- if (isLatex()) {
- latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
- } else {
+ if (isLatex())
+ latexParagraphs(*this, text(), os, d->texrow, runparams);
+ else
// DocBook
docbookParagraphs(paragraphs(), *this, os, runparams);
- }
}
}
};
-#if !defined (HAVE_FORK)
-# define fork() -1
-#endif
-
int AutoSaveBuffer::generateChild()
{
// tmp_ret will be located (usually) in /tmp
// will that be a problem?
+ // Note that this calls ForkedCalls::fork(), so it's
+ // ok cross-platform.
pid_t const pid = fork();
// If you want to debug the autosave
// you should set pid to -1, and comment out the fork.
- if (pid == 0 || pid == -1) {
- // pid = -1 signifies that lyx was unable
- // to fork. But we will do the save
- // anyway.
- bool failed = false;
-
- FileName const tmp_ret(tempName(FileName(), "lyxauto"));
- if (!tmp_ret.empty()) {
- buffer_.writeFile(tmp_ret);
- // assume successful write of tmp_ret
- if (!tmp_ret.renameTo(fname_)) {
- failed = true;
- // most likely couldn't move between
- // filesystems unless write of tmp_ret
- // failed so remove tmp file (if it
- // exists)
- tmp_ret.removeFile();
- }
- } else {
+ if (pid != 0 && pid != -1)
+ return pid;
+
+ // pid = -1 signifies that lyx was unable
+ // to fork. But we will do the save
+ // anyway.
+ bool failed = false;
+ FileName const tmp_ret = FileName::tempName("lyxauto");
+ if (!tmp_ret.empty()) {
+ buffer_.writeFile(tmp_ret);
+ // assume successful write of tmp_ret
+ if (!tmp_ret.moveTo(fname_))
failed = true;
- }
-
- if (failed) {
- // failed to write/rename tmp_ret so try writing direct
- if (!buffer_.writeFile(fname_)) {
- // It is dangerous to do this in the child,
- // but safe in the parent, so...
- if (pid == -1) // emit message signal.
- buffer_.message(_("Autosave failed!"));
- }
- }
- if (pid == 0) { // we are the child so...
- _exit(0);
+ } else
+ failed = true;
+
+ if (failed) {
+ // failed to write/rename tmp_ret so try writing direct
+ if (!buffer_.writeFile(fname_)) {
+ // It is dangerous to do this in the child,
+ // but safe in the parent, so...
+ if (pid == -1) // emit message signal.
+ buffer_.message(_("Autosave failed!"));
}
}
+
+ if (pid == 0) // we are the child so...
+ _exit(0);
+
return pid;
}
}
-void Buffer::resetChildDocuments(bool close_them) const
-{
- for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
- if (it->lyxCode() != INCLUDE_CODE)
- continue;
- InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
- InsetCommandParams const & ip = inset.params();
-
- resetParentBuffer(this, ip, close_them);
- }
-
- if (use_gui && masterBuffer() == this)
- updateLabels(*this);
-}
-
-
-void Buffer::loadChildDocuments() const
-{
- bool parse_error = false;
-
- for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
- if (it->lyxCode() != INCLUDE_CODE)
- continue;
- InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
- InsetCommandParams const & ip = inset.params();
- Buffer * child = loadIfNeeded(*this, ip);
- if (!child)
- continue;
- parse_error |= !child->errorList("Parse").empty();
- child->loadChildDocuments();
- }
-
- if (use_gui && masterBuffer() == this)
- updateLabels(*this);
-}
-
-
string Buffer::bufferFormat() const
{
if (isDocBook())
filename = changeExtension(filename,
formats.extension(backend_format));
+ // fix macros
+ updateMacroInstances();
+
// Plain text backend
if (backend_format == "text")
writePlaintextFile(*this, FileName(filename), runparams);
if (!success)
return false;
- if (put_in_tempdir)
+ if (put_in_tempdir) {
result_file = tmp_result_file.absFilename();
- else {
- result_file = changeExtension(absFileName(), ext);
- // We need to copy referenced files (e. g. included graphics
- // if format == "dvi") to the result dir.
- vector<ExportedFile> const files =
- runparams.exportdata->externalFiles(format);
- string const dest = onlyPath(result_file);
- CopyStatus status = SUCCESS;
- for (vector<ExportedFile>::const_iterator it = files.begin();
- it != files.end() && status != CANCEL; ++it) {
- string const fmt =
- formats.getFormatFromFile(it->sourceName);
- status = copyFile(fmt, it->sourceName,
- makeAbsPath(it->exportName, dest),
- it->exportName, status == FORCE);
- }
- if (status == CANCEL) {
- message(_("Document export cancelled."));
- } else if (tmp_result_file.exists()) {
- // Finally copy the main file
- 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)));
- } else {
- // This must be a dummy converter like fax (bug 1888)
- message(bformat(_("Document exported as %1$s"),
- formats.prettyName(format)));
- }
+ return true;
+ }
+
+ result_file = changeExtension(absFileName(), ext);
+ // We need to copy referenced files (e. g. included graphics
+ // if format == "dvi") to the result dir.
+ vector<ExportedFile> const files =
+ runparams.exportdata->externalFiles(format);
+ string const dest = onlyPath(result_file);
+ CopyStatus status = SUCCESS;
+ for (vector<ExportedFile>::const_iterator it = files.begin();
+ it != files.end() && status != CANCEL; ++it) {
+ string const fmt = formats.getFormatFromFile(it->sourceName);
+ status = copyFile(fmt, it->sourceName,
+ makeAbsPath(it->exportName, dest),
+ it->exportName, status == FORCE);
+ }
+ if (status == CANCEL) {
+ message(_("Document export cancelled."));
+ } else if (tmp_result_file.exists()) {
+ // Finally copy the main file
+ 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)));
+ } else {
+ // This must be a dummy converter like fax (bug 1888)
+ message(bformat(_("Document exported as %1$s"),
+ formats.prettyName(format)));
}
return true;
vector<string> Buffer::backends() const
{
vector<string> v;
- if (params().getTextClass().isTeXClassAvailable()) {
+ if (params().baseClass()->isTeXClassAvailable()) {
v.push_back(bufferFormat());
// FIXME: Don't hardcode format names here, but use a flag
if (v.back() == "latex")
}
}
+
} // namespace lyx