]> git.lyx.org Git - lyx.git/blobdiff - src/Counters.cpp
Rename a couple routines in preparation for more.
[lyx.git] / src / Counters.cpp
index ad13330cd78365f2b95831ce95fc493531b69215..3921cf2890db3742cad8d6a6bbfd51dc6c0911d9 100644 (file)
@@ -3,9 +3,9 @@
  * 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 Martin Vermeer
- * \author André Pönitz
+ * \author André Pönitz
  * \author Richard Heck (roman numerals)
  *
  * Full author contact details are available in file CREDITS.
 #include <config.h>
 
 #include "Counters.h"
+#include "Lexer.h"
 
 #include "support/convert.h"
 #include "support/debug.h"
+#include "support/lassert.h"
 #include "support/lstrings.h"
 
-#include <boost/assert.hpp>
-
+#include <algorithm>
 #include <sstream>
 
 using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::lowercase;
 
 Counter::Counter()
 {
@@ -43,6 +44,63 @@ Counter::Counter(docstring const & mc, docstring const & ls,
 }
 
 
+bool Counter::read(Lexer & lex)
+{
+       enum {
+               CT_WITHIN = 1,
+               CT_LABELSTRING,
+               CT_LABELSTRING_APPENDIX,
+               CT_END
+       };
+
+       LexerKeyword counterTags[] = {
+               { "end", CT_END },
+               { "labelstring", CT_LABELSTRING },
+               { "labelstringappendix", CT_LABELSTRING_APPENDIX },
+               { "within", CT_WITHIN }
+       };
+
+       lex.pushTable(counterTags);
+
+       bool getout = false;
+       while (!getout && lex.isOK()) {
+               int le = lex.lex();
+               switch (le) {
+                       case Lexer::LEX_UNDEF:
+                               lex.printError("Unknown counter tag `$$Token'");
+                               continue;
+                       default: 
+                               break;
+               }
+               switch (le) {
+                       case CT_WITHIN:
+                               lex.next();
+                               master_ = lex.getDocString();
+                               if (master_ == "none")
+                                       master_.erase();
+                               break;
+                       case CT_LABELSTRING:
+                               lex.next();
+                               labelstring_ = lex.getDocString();
+                               labelstringappendix_ = labelstring_;
+                               break;
+                       case CT_LABELSTRING_APPENDIX:
+                               lex.next();
+                               labelstringappendix_ = lex.getDocString();
+                               break;
+                       case CT_END:
+                               getout = true;
+                               break;
+               }
+       }
+
+       // Here if have a full counter if getout == true
+       if (!getout)
+               LYXERR0("No End tag found for counter!");
+       lex.popTable();
+       return getout;
+}
+
 void Counter::set(int v)
 {
        value_ = v;
@@ -79,15 +137,22 @@ docstring const & Counter::master() const
 }
 
 
-docstring const & Counter::labelString() const
+docstring const & Counter::labelString(bool in_appendix) const
 {
-       return labelstring_;
+       return in_appendix ? labelstringappendix_ : labelstring_;
 }
 
 
-docstring const & Counter::labelStringAppendix() const
+docstring const & Counter::flatLabelString(bool in_appendix) const
 {
-       return labelstringappendix_;
+       return in_appendix ? flatlabelstringappendix_ : flatlabelstring_;
+}
+
+
+void Counter::setFlatLabelStrings(docstring const & fls, docstring const & flsa)
+{
+       flatlabelstring_ = fls;
+       flatlabelstringappendix_ = flsa;
 }
 
 
@@ -102,20 +167,37 @@ void Counters::newCounter(docstring const & newc,
                       << endl;
                return;
        }
-       counterList[newc] = Counter(masterc, ls, lsa);
+       counterList_[newc] = Counter(masterc, ls, lsa);
 }
 
 
 bool Counters::hasCounter(docstring const & c) const
 {
-       return counterList.find(c) != counterList.end();
+       return counterList_.find(c) != counterList_.end();
+}
+
+
+bool Counters::read(Lexer & lex, docstring const & name)
+{
+       if (hasCounter(name)) {
+               LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
+               return counterList_[name].read(lex);
+       }
+       LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
+       Counter cnt;
+       bool success = cnt.read(lex);
+       if (success)
+               counterList_[name] = cnt;
+       else
+               LYXERR0("Error reading counter `" << name << "'!");
+       return success;
 }
 
 
 void Counters::set(docstring const & ctr, int const val)
 {
-       CounterList::iterator const it = counterList.find(ctr);
-       if (it == counterList.end()) {
+       CounterList::iterator const it = counterList_.find(ctr);
+       if (it == counterList_.end()) {
                lyxerr << "set: Counter does not exist: "
                       << to_utf8(ctr) << endl;
                return;
@@ -126,8 +208,8 @@ void Counters::set(docstring const & ctr, int const val)
 
 void Counters::addto(docstring const & ctr, int const val)
 {
-       CounterList::iterator const it = counterList.find(ctr);
-       if (it == counterList.end()) {
+       CounterList::iterator const it = counterList_.find(ctr);
+       if (it == counterList_.end()) {
                lyxerr << "addto: Counter does not exist: "
                       << to_utf8(ctr) << endl;
                return;
@@ -138,8 +220,8 @@ void Counters::addto(docstring const & ctr, int const val)
 
 int Counters::value(docstring const & ctr) const
 {
-       CounterList::const_iterator const cit = counterList.find(ctr);
-       if (cit == counterList.end()) {
+       CounterList::const_iterator const cit = counterList_.find(ctr);
+       if (cit == counterList_.end()) {
                lyxerr << "value: Counter does not exist: "
                       << to_utf8(ctr) << endl;
                return 0;
@@ -150,16 +232,16 @@ int Counters::value(docstring const & ctr) const
 
 void Counters::step(docstring const & ctr)
 {
-       CounterList::iterator it = counterList.find(ctr);
-       if (it == counterList.end()) {
+       CounterList::iterator it = counterList_.find(ctr);
+       if (it == counterList_.end()) {
                lyxerr << "step: Counter does not exist: "
                       << to_utf8(ctr) << endl;
                return;
        }
 
        it->second.step();
-       it = counterList.begin();
-       CounterList::iterator const end = counterList.end();
+       it = counterList_.begin();
+       CounterList::iterator const end = counterList_.end();
        for (; it != end; ++it) {
                if (it->second.master() == ctr) {
                        it->second.reset();
@@ -171,21 +253,31 @@ void Counters::step(docstring const & ctr)
 void Counters::reset()
 {
        appendix_ = false;
+       subfloat_ = false;
        current_float_.erase();
-       CounterList::iterator it = counterList.begin();
-       CounterList::iterator const end = counterList.end();
+       CounterList::iterator it = counterList_.begin();
+       CounterList::iterator const end = counterList_.end();
+       std::vector<docstring> callers;
        for (; it != end; ++it) {
                it->second.reset();
+               // Compute the explicit counter labels without any
+               // \thexxx strings, in order to avoid recursion.  
+               // It only needs to be done when the textclass is
+               // updated, but in practice the extra work is probably
+               // not noticeable (JMarc)
+               docstring const fls = flattenLabelString(it->first, false, callers);
+               docstring const flsa = flattenLabelString(it->first, true, callers);
+               it->second.setFlatLabelStrings(fls, flsa);
        }
 }
 
 
 void Counters::reset(docstring const & match)
 {
-       BOOST_ASSERT(!match.empty());
+       LASSERT(!match.empty(), /**/);
 
-       CounterList::iterator it = counterList.begin();
-       CounterList::iterator end = counterList.end();
+       CounterList::iterator it = counterList_.begin();
+       CounterList::iterator end = counterList_.end();
        for (; it != end; ++it) {
                if (it->first.find(match) != string::npos)
                        it->second.reset();
@@ -195,8 +287,8 @@ void Counters::reset(docstring const & match)
 
 void Counters::copy(Counters & from, Counters & to, docstring const & match)
 {
-       CounterList::iterator it = counterList.begin();
-       CounterList::iterator end = counterList.end();
+       CounterList::iterator it = counterList_.begin();
+       CounterList::iterator end = counterList_.end();
        for (; it != end; ++it) {
                if (it->first.find(match) != string::npos || match == "") {
                        to.set(it->first, from.value(it->first));
@@ -238,10 +330,10 @@ char hebrewCounter(int const n)
 
 
 
-//On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
-//and for a list of roman numerals up to and including 3999, see 
-//http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
-//for this info.)
+// On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
+// and for a list of roman numerals up to and including 3999, see 
+// http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
+// for this info.)
 docstring const romanCounter(int const n)
 {
        static char const * const ones[9] = {
@@ -300,17 +392,17 @@ docstring const romanCounter(int const n)
 
 docstring const lowerromanCounter(int const n)
 {
-       return support::lowercase(romanCounter(n));
+       return lowercase(romanCounter(n));
 }
 
 } // namespace anon
 
 
 docstring Counters::labelItem(docstring const & ctr,
-                             docstring const & numbertype)
+                             docstring const & numbertype) const
 {
-       CounterList::const_iterator const cit = counterList.find(ctr);
-       if (cit == counterList.end()) {
+       CounterList::const_iterator const cit = counterList_.find(ctr);
+       if (cit == counterList_.end()) {
                lyxerr << "Counter "
                       << to_utf8(ctr)
                       << " does not exist." << endl;
@@ -338,45 +430,86 @@ docstring Counters::labelItem(docstring const & ctr,
 }
 
 
-docstring Counters::theCounter(docstring const & counter)
+docstring Counters::theCounter(docstring const & counter) const
 {
-       if (!hasCounter(counter))
+       CounterList::const_iterator it = counterList_.find(counter); 
+       if (it == counterList_.end())
                return from_ascii("??");
+       // FIXME: this should get translated.
+       return counterLabel(it->second.flatLabelString(appendix()));
+}
+
 
-       Counter const & c = counterList[counter];
-       docstring ls = appendix() ? c.labelStringAppendix() : c.labelString();
+docstring Counters::flattenLabelString(docstring const & counter, 
+                                      bool in_appendix, 
+                                      vector<docstring> & callers) const
+{
+       docstring label;
+
+       if (find(callers.begin(), callers.end(), counter) != callers.end()) {
+               // recursion detected
+               lyxerr << "Warning: Recursion in label for counter `"
+                      << counter << "' detected"
+                      << endl;
+               return from_ascii("??");
+       }
+               
+       CounterList::const_iterator it = counterList_.find(counter); 
+       if (it == counterList_.end())
+               return from_ascii("??");
+       Counter const & c = it->second;
 
+       docstring ls = c.labelString(in_appendix);
+
+       callers.push_back(counter);
        if (ls.empty()) {
                if (!c.master().empty())
-                       ls = from_ascii("\\the") + c.master() + from_ascii(".");
-               ls += from_ascii("\\arabic{") + counter + "}";
+                       ls = flattenLabelString(c.master(), in_appendix, callers) 
+                               + from_ascii(".");
+               callers.pop_back();
+               return ls + from_ascii("\\arabic{") + counter + "}";
        }
-       return counterLabel(ls);
+
+       while (true) {
+               //lyxerr << "ls=" << to_utf8(ls) << endl;
+               size_t const i = ls.find(from_ascii("\\the"), 0);
+               if (i == docstring::npos)
+                       break;
+               size_t const j = i + 4;
+               size_t k = j;
+               while (k < ls.size() && lowercase(ls[k]) >= 'a' 
+                      && lowercase(ls[k]) <= 'z')
+                       ++k;
+               docstring const newc = ls.substr(j, k - j);
+               docstring const repl = flattenLabelString(newc, in_appendix, callers);
+               ls.replace(i, k - j + 4, repl);
+       }
+       callers.pop_back();
+
+       return ls;
 }
 
 
-docstring Counters::counterLabel(docstring const & format)
+docstring Counters::counterLabel(docstring const & format) const
 {
        docstring label = format;
 
        // FIXME: Using regexps would be better, but we compile boost without
        // wide regexps currently.
-
        while (true) {
                //lyxerr << "label=" << to_utf8(label) << endl;
                size_t const i = label.find(from_ascii("\\the"), 0);
                if (i == docstring::npos)
                        break;
-               size_t j = i + 4;
+               size_t const j = i + 4;
                size_t k = j;
                while (k < label.size() && lowercase(label[k]) >= 'a' 
                       && lowercase(label[k]) <= 'z')
                        ++k;
-               docstring counter = label.substr(j, k - j);
-               docstring repl = theCounter(counter);
+               docstring const newc = label.substr(j, k - j);
+               docstring const repl = theCounter(newc);
                label.replace(i, k - j + 4, repl);
        }
-       
        while (true) {
                //lyxerr << "label=" << to_utf8(label) << endl;