]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
* src/buffer_funcs.{cpp,h}:
[lyx.git] / src / Buffer.cpp
index 7358872b0b45b26b7ab5a893d8cc0768cf89204d..5be6679dca5479e1ea9c3d989919eba9eb629ee9 100644 (file)
@@ -3,7 +3,7 @@
  * 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 <fstream>
 #include <iomanip>
 #include <map>
+#include <set>
 #include <sstream>
 #include <stack>
 #include <vector>
@@ -117,13 +118,15 @@ namespace {
 
 // 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 = 346;  // jspitzm: Swiss German
 
 typedef map<string, bool> DepClean;
 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
 
 } // namespace anon
 
+class BufferSet : public std::set<Buffer const *> {};
+
 class Buffer::Impl
 {
 public:
@@ -374,6 +377,12 @@ string const Buffer::temppath() const
 }
 
 
+TexRow & Buffer::texrow()
+{
+       return d->texrow;
+}
+
+
 TexRow const & Buffer::texrow() const
 {
        return d->texrow;
@@ -579,7 +588,7 @@ bool Buffer::readDocument(Lexer & lex)
                FileName const master_file = makeAbsPath(params().master,
                           onlyPath(absFileName()));
                if (isLyXFilename(master_file.absFilename())) {
-                       Buffer * master = checkAndLoadLyXFile(master_file);
+                       Buffer * master = checkAndLoadLyXFile(master_file, true);
                        d->parent_buffer = master;
                }
        }
@@ -676,6 +685,8 @@ bool Buffer::readFile(FileName const & filename)
 {
        FileName fname(filename);
 
+       params().compressed = fname.isZippedFile();
+
        // remove dummy empty par
        paragraphs().clear();
        Lexer lex;
@@ -956,7 +967,7 @@ bool Buffer::makeLaTeXFile(FileName const & fname,
        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;
@@ -1175,7 +1186,7 @@ void Buffer::makeDocBookFile(FileName const & fname,
 {
        LYXERR(Debug::LATEX, "makeDocBookFile...");
 
-       odocfstream ofs;
+       ofdocstream ofs;
        if (!openFileWrite(ofs, fname))
                return;
 
@@ -1506,17 +1517,18 @@ bool Buffer::isMultiLingual() const
 
 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);
 }
 
 
@@ -1528,25 +1540,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));
 }
 
 
@@ -1676,12 +1688,38 @@ void Buffer::setParent(Buffer const * buffer)
 }
 
 
-Buffer const * Buffer::parent()
+Buffer const * Buffer::parent() const
 {
        return d->parent_buffer;
 }
 
 
+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
+{
+       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)
@@ -1697,6 +1735,16 @@ 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;
+}
+
+
 template<typename M>
 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
 {
@@ -1727,11 +1775,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?
@@ -1754,7 +1802,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;
@@ -1879,11 +1927,10 @@ 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<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.loadIfNeeded(*this);
                                d->macro_lock = false;
                                if (!child)
                                        continue;
@@ -1955,8 +2002,8 @@ 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();
@@ -2121,10 +2168,11 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
                os << "% " << _("Preview source code") << "\n\n";
                d->texrow.newline();
                d->texrow.newline();
-               if (isLatex())
-                       writeLaTeXSource(os, filePath(), runparams, true, true);
-               else
+               if (isDocBook())
                        writeDocBookSource(os, absFileName(), runparams, false);
+               else
+                       // latex or literate
+                       writeLaTeXSource(os, string(), runparams, true, true);
        } else {
                runparams.par_begin = par_begin;
                runparams.par_end = par_end;
@@ -2142,11 +2190,11 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
                d->texrow.newline();
                d->texrow.newline();
                // output paragraphs
-               if (isLatex())
-                       latexParagraphs(*this, text(), os, d->texrow, runparams);
-               else
-                       // DocBook
+               if (isDocBook())
                        docbookParagraphs(paragraphs(), *this, os, runparams);
+               else 
+                       // latex or literate
+                       latexParagraphs(*this, text(), os, d->texrow, runparams);
        }
 }
 
@@ -2636,4 +2684,306 @@ void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
 }
 
 
+void Buffer::updateLabels(bool childonly) 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 (!childonly) {
+               // If this is a child document start with the master
+               if (master != this) {
+                       bufToUpdate.insert(this);
+                       master->updateLabels(false);
+
+                       // 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();
+       inset().setBuffer(const_cast<Buffer &>(*this));
+       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 (!childonly)
+               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);
+               }
+       }
+}
+
 } // namespace lyx