3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Martin Vermeer
9 * \author Richard Heck (roman numerals)
11 * Full author contact details are available in file CREDITS.
20 #include "support/convert.h"
21 #include "support/debug.h"
22 #include "support/gettext.h"
23 #include "support/lassert.h"
24 #include "support/lstrings.h"
30 using namespace lyx::support;
42 Counter::Counter(docstring const & mc, docstring const & ls,
43 docstring const & lsa)
44 : initial_value_(0), master_(mc), labelstring_(ls), labelstringappendix_(lsa)
50 bool Counter::read(Lexer & lex)
55 CT_LABELSTRING_APPENDIX,
61 LexerKeyword counterTags[] = {
63 { "initialvalue", CT_INITIALVALUE},
64 { "labelstring", CT_LABELSTRING },
65 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
66 { "prettyformat", CT_PRETTYFORMAT },
67 { "within", CT_WITHIN }
70 lex.pushTable(counterTags);
73 while (!getout && lex.isOK()) {
76 case Lexer::LEX_UNDEF:
77 lex.printError("Unknown counter tag `$$Token'");
85 master_ = lex.getDocString();
86 if (master_ == "none")
91 initial_value_ = lex.getInteger();
92 // getInteger() returns -1 on error, and larger
93 // negative values do not make much sense.
94 // In the other case, we subtract one, since the
95 // counter will be incremented before its first use.
96 if (initial_value_ <= -1)
101 case CT_PRETTYFORMAT:
103 prettyformat_ = lex.getDocString();
107 labelstring_ = lex.getDocString();
108 labelstringappendix_ = labelstring_;
110 case CT_LABELSTRING_APPENDIX:
112 labelstringappendix_ = lex.getDocString();
120 // Here if have a full counter if getout == true
122 LYXERR0("No End tag found for counter!");
128 void Counter::set(int v)
134 void Counter::addto(int v)
140 int Counter::value() const
152 void Counter::reset()
154 value_ = initial_value_;
158 docstring const & Counter::master() const
164 bool Counter::checkAndRemoveMaster(docstring const & cnt)
168 master_ = docstring();
173 docstring const & Counter::labelString(bool in_appendix) const
175 return in_appendix ? labelstringappendix_ : labelstring_;
179 Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
181 return in_appendix ? flatlabelstringappendix_ : flatlabelstring_;
185 Counters::Counters() : appendix_(false), subfloat_(false), longtable_(false)
187 layout_stack_.push_back(nullptr);
188 counter_stack_.push_back(from_ascii(""));
192 void Counters::newCounter(docstring const & newc,
193 docstring const & masterc,
194 docstring const & ls,
195 docstring const & lsa)
197 if (!masterc.empty() && !hasCounter(masterc)) {
198 lyxerr << "Master counter does not exist: "
203 counterList_[newc] = Counter(masterc, ls, lsa);
207 bool Counters::hasCounter(docstring const & c) const
209 return counterList_.find(c) != counterList_.end();
213 bool Counters::read(Lexer & lex, docstring const & name, bool makenew)
215 if (hasCounter(name)) {
216 LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
217 return counterList_[name].read(lex);
220 LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
222 bool success = cnt.read(lex);
223 // if makenew is false, we will just discard what we read
224 if (success && makenew)
225 counterList_[name] = cnt;
227 LYXERR0("Error reading counter `" << name << "'!");
232 void Counters::set(docstring const & ctr, int const val)
234 CounterList::iterator const it = counterList_.find(ctr);
235 if (it == counterList_.end()) {
236 lyxerr << "set: Counter does not exist: "
237 << to_utf8(ctr) << endl;
244 void Counters::addto(docstring const & ctr, int const val)
246 CounterList::iterator const it = counterList_.find(ctr);
247 if (it == counterList_.end()) {
248 lyxerr << "addto: Counter does not exist: "
249 << to_utf8(ctr) << endl;
252 it->second.addto(val);
256 int Counters::value(docstring const & ctr) const
258 CounterList::const_iterator const cit = counterList_.find(ctr);
259 if (cit == counterList_.end()) {
260 lyxerr << "value: Counter does not exist: "
261 << to_utf8(ctr) << endl;
264 return cit->second.value();
268 void Counters::resetSlaves(docstring const & count)
270 for (auto & ctr : counterList_) {
271 if (ctr.second.master() == count) {
273 resetSlaves(ctr.first);
279 void Counters::stepMaster(docstring const & ctr, UpdateType utype)
281 CounterList::iterator it = counterList_.find(ctr);
282 if (it == counterList_.end()) {
283 lyxerr << "step: Counter does not exist: "
284 << to_utf8(ctr) << endl;
287 step(it->second.master(), utype);
291 void Counters::step(docstring const & ctr, UpdateType utype)
293 CounterList::iterator it = counterList_.find(ctr);
294 if (it == counterList_.end()) {
295 lyxerr << "step: Counter does not exist: "
296 << to_utf8(ctr) << endl;
301 if (utype == OutputUpdate) {
302 LBUFERR(!counter_stack_.empty());
303 counter_stack_.pop_back();
304 counter_stack_.push_back(ctr);
311 void Counters::reset()
315 current_float_.erase();
316 for (auto & ctr : counterList_)
318 counter_stack_.clear();
319 counter_stack_.push_back(from_ascii(""));
320 layout_stack_.clear();
321 layout_stack_.push_back(nullptr);
325 void Counters::reset(docstring const & match)
327 LASSERT(!match.empty(), return);
329 for (auto & ctr : counterList_) {
330 if (ctr.first.find(match) != string::npos)
336 bool Counters::remove(docstring const & cnt)
338 bool retval = counterList_.erase(cnt);
341 for (auto & ctr : counterList_) {
342 if (ctr.second.checkAndRemoveMaster(cnt))
343 LYXERR(Debug::TCLASS, "Removed master counter `" +
344 to_utf8(cnt) + "' from counter: " + to_utf8(ctr.first));
350 void Counters::copy(Counters & from, Counters & to, docstring const & match)
352 for (auto const & ctr : counterList_) {
353 if (ctr.first.find(match) != string::npos || match == "") {
354 to.set(ctr.first, from.value(ctr.first));
362 char loweralphaCounter(int const n)
370 char alphaCounter(int const n)
378 char hebrewCounter(int const n)
380 static const char hebrew[22] = {
381 '\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
382 '\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
383 '\xf7', '\xf8', '\xf9', '\xfa'
388 return hebrew[n - 1];
392 // On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
393 // and for a list of roman numerals up to and including 3999, see
394 // http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
396 docstring const romanCounter(int const n)
398 static char const * const ones[9] = {
399 "I", "II", "III", "IV", "V",
400 "VI", "VII", "VIII", "IX"
403 static char const * const tens[9] = {
404 "X", "XX", "XXX", "XL", "L",
405 "LX", "LXX", "LXXX", "XC"
408 static char const * const hunds[9] = {
409 "C", "CC", "CCC", "CD", "D",
410 "DC", "DCC", "DCCC", "CM"
413 if (n >= 1000 || n < 1)
414 return from_ascii("??");
428 int hundreds = val / 100;
429 roman = hunds[hundreds - 1];
436 roman = roman + "XC";
440 int tensnum = val / 10;
441 roman = roman + tens[tensnum - 1];
446 roman = roman + ones[val -1];
448 return from_ascii(roman);
452 docstring const lowerromanCounter(int const n)
454 return lowercase(romanCounter(n));
458 docstring const fnsymbolCounter(int const n)
461 case 1: return docstring(1, 0x002a); //*
462 case 2: return docstring(1, 0x2020); // dagger
463 case 3: return docstring(1, 0x2021); // double dagger
464 case 4: return docstring(1, 0x00A7); // section sign
465 case 5: return docstring(1, 0x00B6); // pilcrow sign
466 case 6: return docstring(1, 0x2016); // vertical bar
467 case 7: return docstring(2, 0x002a); // two *
468 case 8: return docstring(2, 0x2020); // two daggers
469 case 9: return docstring(2, 0x2021); // two double daggers
471 return from_ascii("?");
478 docstring Counters::labelItem(docstring const & ctr,
479 docstring const & numbertype) const
481 CounterList::const_iterator const cit = counterList_.find(ctr);
482 if (cit == counterList_.end()) {
485 << " does not exist." << endl;
489 int val = cit->second.value();
491 if (numbertype == "hebrew")
492 return docstring(1, hebrewCounter(val));
494 if (numbertype == "alph")
495 return docstring(1, loweralphaCounter(val));
497 if (numbertype == "Alph")
498 return docstring(1, alphaCounter(val));
500 if (numbertype == "roman")
501 return lowerromanCounter(val);
503 if (numbertype == "Roman")
504 return romanCounter(val);
506 if (numbertype == "fnsymbol")
507 return fnsymbolCounter(val);
509 return convert<docstring>(val);
513 docstring Counters::theCounter(docstring const & counter,
514 string const & lang) const
516 CounterList::const_iterator it = counterList_.find(counter);
517 if (it == counterList_.end())
518 return from_ascii("#");
519 Counter const & ctr = it->second;
520 Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
521 Counter::StringMap::iterator smit = sm.find(lang);
522 if (smit != sm.end())
523 return counterLabel(smit->second, lang);
525 vector<docstring> callers;
526 docstring const & fls = flattenLabelString(counter, appendix(),
529 return counterLabel(fls, lang);
533 docstring Counters::flattenLabelString(docstring const & counter,
536 vector<docstring> & callers) const
538 if (find(callers.begin(), callers.end(), counter) != callers.end()) {
539 // recursion detected
540 lyxerr << "Warning: Recursion in label for counter `"
541 << counter << "' detected"
543 return from_ascii("??");
546 CounterList::const_iterator it = counterList_.find(counter);
547 if (it == counterList_.end())
548 return from_ascii("#");
549 Counter const & c = it->second;
551 docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
553 callers.push_back(counter);
555 if (!c.master().empty())
556 ls = flattenLabelString(c.master(), in_appendix, lang, callers)
559 return ls + from_ascii("\\arabic{") + counter + "}";
563 //lyxerr << "ls=" << to_utf8(ls) << endl;
564 size_t const i = ls.find(from_ascii("\\the"), 0);
565 if (i == docstring::npos)
567 size_t const j = i + 4;
569 while (k < ls.size() && lowercase(ls[k]) >= 'a'
570 && lowercase(ls[k]) <= 'z')
572 docstring const newc = ls.substr(j, k - j);
573 docstring const repl = flattenLabelString(newc, in_appendix,
575 ls.replace(i, k - j + 4, repl);
583 docstring Counters::counterLabel(docstring const & format,
584 string const & lang) const
586 docstring label = format;
588 // FIXME: Using regexps would be better, but we compile boost without
589 // wide regexps currently.
590 docstring const the = from_ascii("\\the");
592 //lyxerr << "label=" << label << endl;
593 size_t const i = label.find(the, 0);
594 if (i == docstring::npos)
596 size_t const j = i + 4;
598 while (k < label.size() && lowercase(label[k]) >= 'a'
599 && lowercase(label[k]) <= 'z')
601 docstring const newc(label, j, k - j);
602 label.replace(i, k - i, theCounter(newc, lang));
605 //lyxerr << "label=" << label << endl;
607 size_t const i = label.find('\\', 0);
608 if (i == docstring::npos)
610 size_t const j = label.find('{', i + 1);
611 if (j == docstring::npos)
613 size_t const k = label.find('}', j + 1);
614 if (k == docstring::npos)
616 docstring const numbertype(label, i + 1, j - i - 1);
617 docstring const counter(label, j + 1, k - j - 1);
618 label.replace(i, k + 1 - i, labelItem(counter, numbertype));
620 //lyxerr << "DONE! label=" << label << endl;
625 docstring Counters::prettyCounter(docstring const & name,
626 string const & lang) const
628 CounterList::const_iterator it = counterList_.find(name);
629 if (it == counterList_.end())
630 return from_ascii("#");
631 Counter const & ctr = it->second;
633 docstring const value = theCounter(name, lang);
634 docstring const & format =
635 translateIfPossible(ctr.prettyFormat(), lang);
638 return subst(format, from_ascii("##"), value);
642 docstring Counters::currentCounter() const
644 LBUFERR(!counter_stack_.empty());
645 return counter_stack_.back();
649 void Counters::setActiveLayout(Layout const & lay)
651 LASSERT(!layout_stack_.empty(), return);
652 Layout const * const lastlay = layout_stack_.back();
653 // we want to check whether the layout has changed and, if so,
654 // whether we are coming out of or going into an environment.
656 layout_stack_.pop_back();
657 layout_stack_.push_back(&lay);
658 if (lay.isEnvironment())
660 } else if (lastlay->name() != lay.name()) {
661 layout_stack_.pop_back();
662 layout_stack_.push_back(&lay);
663 if (lastlay->isEnvironment()) {
664 // we are coming out of an environment
665 // LYXERR0("Out: " << lastlay->name());
668 if (lay.isEnvironment()) {
669 // we are going into a new environment
670 // LYXERR0("In: " << lay.name());
677 void Counters::beginEnvironment()
679 counter_stack_.push_back(counter_stack_.back());
683 void Counters::endEnvironment()
685 LASSERT(!counter_stack_.empty(), return);
686 counter_stack_.pop_back();