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(0);
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::step(docstring const & ctr, UpdateType utype)
270 CounterList::iterator it = counterList_.find(ctr);
271 if (it == counterList_.end()) {
272 lyxerr << "step: Counter does not exist: "
273 << to_utf8(ctr) << endl;
278 if (utype == OutputUpdate) {
279 LBUFERR(!counter_stack_.empty());
280 counter_stack_.pop_back();
281 counter_stack_.push_back(ctr);
283 it = counterList_.begin();
284 CounterList::iterator const end = counterList_.end();
285 for (; it != end; ++it) {
286 if (it->second.master() == ctr) {
293 void Counters::reset()
297 current_float_.erase();
298 CounterList::iterator it = counterList_.begin();
299 CounterList::iterator const end = counterList_.end();
300 for (; it != end; ++it)
302 counter_stack_.clear();
303 counter_stack_.push_back(from_ascii(""));
304 layout_stack_.clear();
305 layout_stack_.push_back(0);
309 void Counters::reset(docstring const & match)
311 LASSERT(!match.empty(), return);
313 CounterList::iterator it = counterList_.begin();
314 CounterList::iterator end = counterList_.end();
315 for (; it != end; ++it) {
316 if (it->first.find(match) != string::npos)
322 bool Counters::remove(docstring const & cnt)
324 bool retval = counterList_.erase(cnt);
327 CounterList::iterator it = counterList_.begin();
328 CounterList::iterator end = counterList_.end();
329 for (; it != end; ++it) {
330 if (it->second.checkAndRemoveMaster(cnt))
331 LYXERR(Debug::TCLASS, "Removed master counter `" +
332 to_utf8(cnt) + "' from counter: " + to_utf8(it->first));
338 void Counters::copy(Counters & from, Counters & to, docstring const & match)
340 CounterList::iterator it = counterList_.begin();
341 CounterList::iterator end = counterList_.end();
342 for (; it != end; ++it) {
343 if (it->first.find(match) != string::npos || match == "") {
344 to.set(it->first, from.value(it->first));
352 char loweralphaCounter(int const n)
360 char alphaCounter(int const n)
368 char hebrewCounter(int const n)
370 static const char hebrew[22] = {
371 '\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
372 '\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
373 '\xf7', '\xf8', '\xf9', '\xfa'
378 return hebrew[n - 1];
382 // On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
383 // and for a list of roman numerals up to and including 3999, see
384 // http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
386 docstring const romanCounter(int const n)
388 static char const * const ones[9] = {
389 "I", "II", "III", "IV", "V",
390 "VI", "VII", "VIII", "IX"
393 static char const * const tens[9] = {
394 "X", "XX", "XXX", "XL", "L",
395 "LX", "LXX", "LXXX", "XC"
398 static char const * const hunds[9] = {
399 "C", "CC", "CCC", "CD", "D",
400 "DC", "DCC", "DCCC", "CM"
403 if (n > 1000 || n < 1)
404 return from_ascii("??");
418 int hundreds = val / 100;
419 roman = hunds[hundreds - 1];
426 roman = roman + "XC";
430 int tensnum = val / 10;
431 roman = roman + tens[tensnum - 1];
436 roman = roman + ones[val -1];
438 return from_ascii(roman);
442 docstring const lowerromanCounter(int const n)
444 return lowercase(romanCounter(n));
448 docstring const fnsymbolCounter(int const n)
451 case 1: return docstring(1, 0x002a); //*
452 case 2: return docstring(1, 0x2020); // dagger
453 case 3: return docstring(1, 0x2021); // double dagger
454 case 4: return docstring(1, 0x00A7); // section sign
455 case 5: return docstring(1, 0x00B6); // pilcrow sign
456 case 6: return docstring(1, 0x2016); // vertical bar
457 case 7: return docstring(2, 0x002a); // two *
458 case 8: return docstring(2, 0x2020); // two daggers
459 case 9: return docstring(2, 0x2021); // two double daggers
461 return from_ascii("?");
468 docstring Counters::labelItem(docstring const & ctr,
469 docstring const & numbertype) const
471 CounterList::const_iterator const cit = counterList_.find(ctr);
472 if (cit == counterList_.end()) {
475 << " does not exist." << endl;
479 int val = cit->second.value();
481 if (numbertype == "hebrew")
482 return docstring(1, hebrewCounter(val));
484 if (numbertype == "alph")
485 return docstring(1, loweralphaCounter(val));
487 if (numbertype == "Alph")
488 return docstring(1, alphaCounter(val));
490 if (numbertype == "roman")
491 return lowerromanCounter(val);
493 if (numbertype == "Roman")
494 return romanCounter(val);
496 if (numbertype == "fnsymbol")
497 return fnsymbolCounter(val);
499 return convert<docstring>(val);
503 docstring Counters::theCounter(docstring const & counter,
504 string const & lang) const
506 CounterList::const_iterator it = counterList_.find(counter);
507 if (it == counterList_.end())
508 return from_ascii("#");
509 Counter const & ctr = it->second;
510 Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
511 Counter::StringMap::iterator smit = sm.find(lang);
512 if (smit != sm.end())
513 return counterLabel(smit->second, lang);
515 vector<docstring> callers;
516 docstring const & fls = flattenLabelString(counter, appendix(),
519 return counterLabel(fls, lang);
523 docstring Counters::flattenLabelString(docstring const & counter,
526 vector<docstring> & callers) const
530 if (find(callers.begin(), callers.end(), counter) != callers.end()) {
531 // recursion detected
532 lyxerr << "Warning: Recursion in label for counter `"
533 << counter << "' detected"
535 return from_ascii("??");
538 CounterList::const_iterator it = counterList_.find(counter);
539 if (it == counterList_.end())
540 return from_ascii("#");
541 Counter const & c = it->second;
543 docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
545 callers.push_back(counter);
547 if (!c.master().empty())
548 ls = flattenLabelString(c.master(), in_appendix, lang, callers)
551 return ls + from_ascii("\\arabic{") + counter + "}";
555 //lyxerr << "ls=" << to_utf8(ls) << endl;
556 size_t const i = ls.find(from_ascii("\\the"), 0);
557 if (i == docstring::npos)
559 size_t const j = i + 4;
561 while (k < ls.size() && lowercase(ls[k]) >= 'a'
562 && lowercase(ls[k]) <= 'z')
564 docstring const newc = ls.substr(j, k - j);
565 docstring const repl = flattenLabelString(newc, in_appendix,
567 ls.replace(i, k - j + 4, repl);
575 docstring Counters::counterLabel(docstring const & format,
576 string const & lang) const
578 docstring label = format;
580 // FIXME: Using regexps would be better, but we compile boost without
581 // wide regexps currently.
582 docstring const the = from_ascii("\\the");
584 //lyxerr << "label=" << label << endl;
585 size_t const i = label.find(the, 0);
586 if (i == docstring::npos)
588 size_t const j = i + 4;
590 while (k < label.size() && lowercase(label[k]) >= 'a'
591 && lowercase(label[k]) <= 'z')
593 docstring const newc(label, j, k - j);
594 label.replace(i, k - i, theCounter(newc, lang));
597 //lyxerr << "label=" << label << endl;
599 size_t const i = label.find('\\', 0);
600 if (i == docstring::npos)
602 size_t const j = label.find('{', i + 1);
603 if (j == docstring::npos)
605 size_t const k = label.find('}', j + 1);
606 if (k == docstring::npos)
608 docstring const numbertype(label, i + 1, j - i - 1);
609 docstring const counter(label, j + 1, k - j - 1);
610 label.replace(i, k + 1 - i, labelItem(counter, numbertype));
612 //lyxerr << "DONE! label=" << label << endl;
617 docstring Counters::prettyCounter(docstring const & name,
618 string const & lang) const
620 CounterList::const_iterator it = counterList_.find(name);
621 if (it == counterList_.end())
622 return from_ascii("#");
623 Counter const & ctr = it->second;
625 docstring const value = theCounter(name, lang);
626 docstring const & format =
627 translateIfPossible(ctr.prettyFormat(), lang);
630 return subst(format, from_ascii("##"), value);
634 docstring Counters::currentCounter() const
636 LBUFERR(!counter_stack_.empty());
637 return counter_stack_.back();
641 void Counters::setActiveLayout(Layout const & lay)
643 LASSERT(!layout_stack_.empty(), return);
644 Layout const * const lastlay = layout_stack_.back();
645 // we want to check whether the layout has changed and, if so,
646 // whether we are coming out of or going into an environment.
648 layout_stack_.pop_back();
649 layout_stack_.push_back(&lay);
650 if (lay.isEnvironment())
652 } else if (lastlay->name() != lay.name()) {
653 layout_stack_.pop_back();
654 layout_stack_.push_back(&lay);
655 if (lastlay->isEnvironment()) {
656 // we are coming out of an environment
657 // LYXERR0("Out: " << lastlay->name());
660 if (lay.isEnvironment()) {
661 // we are going into a new environment
662 // LYXERR0("In: " << lay.name());
669 void Counters::beginEnvironment()
671 counter_stack_.push_back(counter_stack_.back());
675 void Counters::endEnvironment()
677 LASSERT(!counter_stack_.empty(), return);
678 counter_stack_.pop_back();