]> git.lyx.org Git - lyx.git/blobdiff - src/Counters.cpp
Revert part of 47973dc2b, which was causing bug #11873.
[lyx.git] / src / Counters.cpp
index d6865d107d99dd6954b1e4a3d697c7449a2f8acd..15cede1a0faab721c0aa61142b2f009a2f77d787 100644 (file)
@@ -18,6 +18,7 @@
 #include "Lexer.h"
 
 #include "support/convert.h"
+#include "support/counter_reps.h"
 #include "support/debug.h"
 #include "support/gettext.h"
 #include "support/lassert.h"
@@ -33,14 +34,16 @@ namespace lyx {
 
 
 Counter::Counter()
+       : initial_value_(0)
 {
        reset();
 }
 
 
-Counter::Counter(docstring const & mc, docstring const & ls,  
-                docstring const & lsa)
-       : master_(mc), labelstring_(ls), labelstringappendix_(lsa)
+Counter::Counter(docstring const & mc, docstring const & ls,
+               docstring const & lsa, docstring const & guiname)
+       : initial_value_(0), master_(mc), labelstring_(ls),
+         labelstringappendix_(lsa), guiname_(guiname)
 {
        reset();
 }
@@ -53,11 +56,15 @@ bool Counter::read(Lexer & lex)
                CT_LABELSTRING,
                CT_LABELSTRING_APPENDIX,
                CT_PRETTYFORMAT,
+               CT_INITIALVALUE,
+               CT_GUINAME,
                CT_END
        };
 
        LexerKeyword counterTags[] = {
                { "end", CT_END },
+               { "guiname", CT_GUINAME },
+               { "initialvalue", CT_INITIALVALUE},
                { "labelstring", CT_LABELSTRING },
                { "labelstringappendix", CT_LABELSTRING_APPENDIX },
                { "prettyformat", CT_PRETTYFORMAT },
@@ -73,7 +80,7 @@ bool Counter::read(Lexer & lex)
                        case Lexer::LEX_UNDEF:
                                lex.printError("Unknown counter tag `$$Token'");
                                continue;
-                       default: 
+                       default:
                                break;
                }
                switch (le) {
@@ -83,6 +90,18 @@ bool Counter::read(Lexer & lex)
                                if (master_ == "none")
                                        master_.erase();
                                break;
+                       case CT_INITIALVALUE:
+                               lex.next();
+                               initial_value_ = lex.getInteger();
+                               // getInteger() returns -1 on error, and larger
+                               // negative values do not make much sense.
+                               // In the other case, we subtract one, since the
+                               // counter will be incremented before its first use.
+                               if (initial_value_ <= -1)
+                                       initial_value_ = 0;
+                               else
+                                       initial_value_ -= 1;
+                               break;
                        case CT_PRETTYFORMAT:
                                lex.next();
                                prettyformat_ = lex.getDocString();
@@ -96,6 +115,10 @@ bool Counter::read(Lexer & lex)
                                lex.next();
                                labelstringappendix_ = lex.getDocString();
                                break;
+                       case CT_GUINAME:
+                               lex.next();
+                               guiname_ = lex.getDocString();
+                               break;
                        case CT_END:
                                getout = true;
                                break;
@@ -109,6 +132,7 @@ bool Counter::read(Lexer & lex)
        return getout;
 }
 
+
 void Counter::set(int v)
 {
        value_ = v;
@@ -127,6 +151,18 @@ int Counter::value() const
 }
 
 
+void Counter::saveValue()
+{
+       saved_value_ = value_;
+}
+
+
+void Counter::restoreValue()
+{
+       value_ = saved_value_;
+}
+
+
 void Counter::step()
 {
        ++value_;
@@ -135,7 +171,7 @@ void Counter::step()
 
 void Counter::reset()
 {
-       value_ = 0;
+       value_ = initial_value_;
 }
 
 
@@ -145,6 +181,15 @@ docstring const & Counter::master() const
 }
 
 
+bool Counter::checkAndRemoveMaster(docstring const & cnt)
+{
+       if (master_ != cnt)
+               return false;
+       master_ = docstring();
+       return true;
+}
+
+
 docstring const & Counter::labelString(bool in_appendix) const
 {
        return in_appendix ? labelstringappendix_ : labelstring_;
@@ -157,10 +202,18 @@ Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
 }
 
 
+Counters::Counters() : appendix_(false), subfloat_(false), longtable_(false)
+{
+       layout_stack_.push_back(nullptr);
+       counter_stack_.push_back(from_ascii(""));
+}
+
+
 void Counters::newCounter(docstring const & newc,
-                         docstring const & masterc, 
+                         docstring const & masterc,
                          docstring const & ls,
-                         docstring const & lsa)
+                         docstring const & lsa,
+                         docstring const & guiname)
 {
        if (!masterc.empty() && !hasCounter(masterc)) {
                lyxerr << "Master counter does not exist: "
@@ -168,7 +221,7 @@ void Counters::newCounter(docstring const & newc,
                       << endl;
                return;
        }
-       counterList_[newc] = Counter(masterc, ls, lsa);
+       counterList_[newc] = Counter(masterc, ls, lsa, guiname);
 }
 
 
@@ -233,6 +286,57 @@ int Counters::value(docstring const & ctr) const
 }
 
 
+void Counters::saveValue(docstring const & ctr) const
+{
+       CounterList::const_iterator const cit = counterList_.find(ctr);
+       if (cit == counterList_.end()) {
+               lyxerr << "value: Counter does not exist: "
+                      << to_utf8(ctr) << endl;
+               return;
+       }
+       Counter const & cnt = cit->second;
+       Counter & ccnt = const_cast<Counter &>(cnt);
+       ccnt.saveValue();
+}
+
+
+void Counters::restoreValue(docstring const & ctr) const
+{
+       CounterList::const_iterator const cit = counterList_.find(ctr);
+       if (cit == counterList_.end()) {
+               lyxerr << "value: Counter does not exist: "
+                      << to_utf8(ctr) << endl;
+               return;
+       }
+       Counter const & cnt = cit->second;
+       Counter & ccnt = const_cast<Counter &>(cnt);
+       ccnt.restoreValue();
+}
+
+
+void Counters::resetSlaves(docstring const & count)
+{
+       for (auto & ctr : counterList_) {
+               if (ctr.second.master() == count) {
+                       ctr.second.reset();
+                       resetSlaves(ctr.first);
+               }
+       }
+}
+
+
+void Counters::stepMaster(docstring const & ctr, UpdateType utype)
+{
+       CounterList::iterator it = counterList_.find(ctr);
+       if (it == counterList_.end()) {
+               lyxerr << "step: Counter does not exist: "
+                      << to_utf8(ctr) << endl;
+               return;
+       }
+       step(it->second.master(), utype);
+}
+
+
 void Counters::step(docstring const & ctr, UpdateType utype)
 {
        CounterList::iterator it = counterList_.find(ctr);
@@ -244,17 +348,28 @@ void Counters::step(docstring const & ctr, UpdateType utype)
 
        it->second.step();
        if (utype == OutputUpdate) {
-               LASSERT(!counter_stack_.empty(), /* */);
+               LBUFERR(!counter_stack_.empty());
                counter_stack_.pop_back();
                counter_stack_.push_back(ctr);
        }
-       it = counterList_.begin();
-       CounterList::iterator const end = counterList_.end();
-       for (; it != end; ++it) {
-               if (it->second.master() == ctr) {
-                       it->second.reset();
-               }
+
+       resetSlaves(ctr);
+}
+
+
+docstring const & Counters::guiName(docstring const & cntr) const
+{
+       CounterList::const_iterator it = counterList_.find(cntr);
+       if (it == counterList_.end()) {
+               lyxerr << "step: Counter does not exist: "
+                          << to_utf8(cntr) << endl;
+               return empty_docstring();
        }
+
+       docstring const & guiname = it->second.guiName();
+       if (guiname.empty())
+               return cntr;
+       return guiname;
 }
 
 
@@ -263,142 +378,50 @@ void Counters::reset()
        appendix_ = false;
        subfloat_ = false;
        current_float_.erase();
-       CounterList::iterator it = counterList_.begin();
-       CounterList::iterator const end = counterList_.end();
-       for (; it != end; ++it)
-               it->second.reset();
+       for (auto & ctr : counterList_)
+               ctr.second.reset();
        counter_stack_.clear();
        counter_stack_.push_back(from_ascii(""));
-       layout_stack_.push_back(0);
+       layout_stack_.clear();
+       layout_stack_.push_back(nullptr);
 }
 
 
 void Counters::reset(docstring const & match)
 {
-       LASSERT(!match.empty(), /**/);
+       LASSERT(!match.empty(), return);
 
-       CounterList::iterator it = counterList_.begin();
-       CounterList::iterator end = counterList_.end();
-       for (; it != end; ++it) {
-               if (it->first.find(match) != string::npos)
-                       it->second.reset();
+       for (auto & ctr : counterList_) {
+               if (ctr.first.find(match) != string::npos)
+                       ctr.second.reset();
        }
 }
 
 
-void Counters::copy(Counters & from, Counters & to, docstring const & match)
+bool Counters::remove(docstring const & cnt)
 {
-       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));
-               }
+       bool retval = counterList_.erase(cnt);
+       if (!retval)
+               return false;
+       for (auto & ctr : counterList_) {
+               if (ctr.second.checkAndRemoveMaster(cnt))
+                       LYXERR(Debug::TCLASS, "Removed master counter `" +
+                                       to_utf8(cnt) + "' from counter: " + to_utf8(ctr.first));
        }
+       return retval;
 }
 
 
-namespace {
-
-char loweralphaCounter(int const n)
-{
-       if (n < 1 || n > 26)
-               return '?';
-       return 'a' + n - 1;
-}
-
-
-char alphaCounter(int const n)
-{
-       if (n < 1 || n > 26)
-               return '?';
-       return 'A' + n - 1;
-}
-
-
-char hebrewCounter(int const n)
-{
-       static const char hebrew[22] = {
-               '\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
-               '\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
-               '\xf7', '\xf8', '\xf9', '\xfa'
-       };
-
-       if (n < 1 || n > 22)
-               return '?';
-       return hebrew[n - 1];
-}
-
-
-
-// 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)
+void Counters::copy(Counters & from, Counters & to, docstring const & match)
 {
-       static char const * const ones[9] = {
-               "I",   "II",  "III", "IV", "V",
-               "VI",  "VII", "VIII", "IX"
-       };
-       
-       static char const * const tens[9] = {
-               "X", "XX", "XXX", "XL", "L",
-               "LX", "LXX", "LXXX", "XC"
-       };
-       
-       static char const * const hunds[9] = {
-               "C", "CC", "CCC", "CD", "D",
-               "DC", "DCC", "DCCC", "CM"
-       };
-       
-       if (n > 1000 || n < 1) 
-               return from_ascii("??");
-       
-       int val = n;
-       string roman;
-       switch (n) {
-       //special cases
-       case 900: 
-               roman = "CM";
-               break;
-       case 400:
-               roman = "CD";
-               break;
-       default:
-               if (val >= 100) {
-                       int hundreds = val / 100;
-                       roman = hunds[hundreds - 1];
-                       val = val % 100;
+       for (auto const & ctr : counterList_) {
+               if (ctr.first.find(match) != string::npos || match == "") {
+                       to.set(ctr.first, from.value(ctr.first));
                }
-               if (val >= 10) {
-                       switch (val) {
-                       //special case
-                       case 90:
-                               roman = roman + "XC";
-                               val = 0; //skip next
-                               break;
-                       default:
-                               int tensnum = val / 10;
-                               roman = roman + tens[tensnum - 1];
-                               val = val % 10;
-                       } // end switch
-               } // end tens
-               if (val > 0)
-                       roman = roman + ones[val -1];
        }
-       return from_ascii(roman);
 }
 
 
-docstring const lowerromanCounter(int const n)
-{
-       return lowercase(romanCounter(n));
-}
-
-} // namespace anon
-
-
 docstring Counters::labelItem(docstring const & ctr,
                              docstring const & numbertype) const
 {
@@ -427,6 +450,9 @@ docstring Counters::labelItem(docstring const & ctr,
        if (numbertype == "Roman")
                return romanCounter(val);
 
+       if (numbertype == "fnsymbol")
+               return fnsymbolCounter(val);
+
        return convert<docstring>(val);
 }
 
@@ -434,9 +460,9 @@ docstring Counters::labelItem(docstring const & ctr,
 docstring Counters::theCounter(docstring const & counter,
                               string const & lang) const
 {
-       CounterList::const_iterator it = counterList_.find(counter); 
+       CounterList::const_iterator it = counterList_.find(counter);
        if (it == counterList_.end())
-               return from_ascii("??");
+               return from_ascii("#");
        Counter const & ctr = it->second;
        Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
        Counter::StringMap::iterator smit = sm.find(lang);
@@ -451,13 +477,11 @@ docstring Counters::theCounter(docstring const & counter,
 }
 
 
-docstring Counters::flattenLabelString(docstring const & counter, 
+docstring Counters::flattenLabelString(docstring const & counter,
                                       bool in_appendix,
                                       string const & lang,
                                       vector<docstring> & callers) const
 {
-       docstring label;
-
        if (find(callers.begin(), callers.end(), counter) != callers.end()) {
                // recursion detected
                lyxerr << "Warning: Recursion in label for counter `"
@@ -465,10 +489,10 @@ docstring Counters::flattenLabelString(docstring const & counter,
                       << endl;
                return from_ascii("??");
        }
-               
-       CounterList::const_iterator it = counterList_.find(counter); 
+
+       CounterList::const_iterator it = counterList_.find(counter);
        if (it == counterList_.end())
-               return from_ascii("??");
+               return from_ascii("#");
        Counter const & c = it->second;
 
        docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
@@ -476,7 +500,7 @@ docstring Counters::flattenLabelString(docstring const & counter,
        callers.push_back(counter);
        if (ls.empty()) {
                if (!c.master().empty())
-                       ls = flattenLabelString(c.master(), in_appendix, lang, callers) 
+                       ls = flattenLabelString(c.master(), in_appendix, lang, callers)
                                + from_ascii(".");
                callers.pop_back();
                return ls + from_ascii("\\arabic{") + counter + "}";
@@ -489,7 +513,7 @@ docstring Counters::flattenLabelString(docstring const & counter,
                        break;
                size_t const j = i + 4;
                size_t k = j;
-               while (k < ls.size() && lowercase(ls[k]) >= 'a' 
+               while (k < ls.size() && lowercase(ls[k]) >= 'a'
                       && lowercase(ls[k]) <= 'z')
                        ++k;
                docstring const newc = ls.substr(j, k - j);
@@ -518,7 +542,7 @@ docstring Counters::counterLabel(docstring const & format,
                        break;
                size_t const j = i + 4;
                size_t k = j;
-               while (k < label.size() && lowercase(label[k]) >= 'a' 
+               while (k < label.size() && lowercase(label[k]) >= 'a'
                       && lowercase(label[k]) <= 'z')
                        ++k;
                docstring const newc(label, j, k - j);
@@ -548,13 +572,14 @@ docstring Counters::counterLabel(docstring const & format,
 docstring Counters::prettyCounter(docstring const & name,
                               string const & lang) const
 {
-       CounterList::const_iterator it = counterList_.find(name); 
+       CounterList::const_iterator it = counterList_.find(name);
        if (it == counterList_.end())
-               return from_ascii("??");
+               return from_ascii("#");
        Counter const & ctr = it->second;
 
        docstring const value = theCounter(name, lang);
-       docstring const & format = ctr.prettyFormat();
+       docstring const & format =
+           translateIfPossible(ctr.prettyFormat(), lang);
        if (format.empty())
                return value;
        return subst(format, from_ascii("##"), value);
@@ -562,9 +587,9 @@ docstring Counters::prettyCounter(docstring const & name,
 
 
 docstring Counters::currentCounter() const
-{ 
-       LASSERT(!counter_stack_.empty(), /* */);
-       return counter_stack_.back(); 
+{
+       LBUFERR(!counter_stack_.empty());
+       return counter_stack_.back();
 }
 
 
@@ -574,7 +599,7 @@ void Counters::setActiveLayout(Layout const & lay)
        Layout const * const lastlay = layout_stack_.back();
        // we want to check whether the layout has changed and, if so,
        // whether we are coming out of or going into an environment.
-       if (!lastlay) { 
+       if (!lastlay) {
                layout_stack_.pop_back();
                layout_stack_.push_back(&lay);
                if (lay.isEnvironment())
@@ -592,20 +617,13 @@ void Counters::setActiveLayout(Layout const & lay)
                        // LYXERR0("In: " << lay.name());
                        beginEnvironment();
                }
-       } 
+       }
 }
 
 
 void Counters::beginEnvironment()
 {
-       docstring cnt = counter_stack_.back();
-       counter_stack_.push_back(cnt);
-       deque<docstring>::const_iterator it = counter_stack_.begin();
-       deque<docstring>::const_iterator en = counter_stack_.end();
-//     docstring d;
-//     for (; it != en; ++it)
-//             d += " --> " + *it;
-//     LYXERR0(counter_stack_.size() << ": " << d);
+       counter_stack_.push_back(counter_stack_.back());
 }
 
 
@@ -613,12 +631,14 @@ void Counters::endEnvironment()
 {
        LASSERT(!counter_stack_.empty(), return);
        counter_stack_.pop_back();
-       deque<docstring>::const_iterator it = counter_stack_.begin();
-       deque<docstring>::const_iterator en = counter_stack_.end();
-//     docstring d;
-//     for (; it != en; ++it)
-//             d += " --> " + *it;
-//     LYXERR0(counter_stack_.size() << ": " << d);
+}
+
+
+vector<docstring> Counters::listOfCounters() const {
+       vector<docstring> ret;
+       for(auto const & k : counterList_)
+               ret.emplace_back(k.first);
+       return ret;
 }