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;
41 Counter::Counter(docstring const & mc, docstring const & ls,
42 docstring const & lsa)
43 : master_(mc), labelstring_(ls), labelstringappendix_(lsa)
49 bool Counter::read(Lexer & lex)
54 CT_LABELSTRING_APPENDIX,
59 LexerKeyword counterTags[] = {
61 { "labelstring", CT_LABELSTRING },
62 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
63 { "prettyformat", CT_PRETTYFORMAT },
64 { "within", CT_WITHIN }
67 lex.pushTable(counterTags);
70 while (!getout && lex.isOK()) {
73 case Lexer::LEX_UNDEF:
74 lex.printError("Unknown counter tag `$$Token'");
82 master_ = lex.getDocString();
83 if (master_ == "none")
88 prettyformat_ = lex.getDocString();
92 labelstring_ = lex.getDocString();
93 labelstringappendix_ = labelstring_;
95 case CT_LABELSTRING_APPENDIX:
97 labelstringappendix_ = lex.getDocString();
105 // Here if have a full counter if getout == true
107 LYXERR0("No End tag found for counter!");
112 void Counter::set(int v)
118 void Counter::addto(int v)
124 int Counter::value() const
136 void Counter::reset()
142 docstring const & Counter::master() const
148 docstring const & Counter::labelString(bool in_appendix) const
150 return in_appendix ? labelstringappendix_ : labelstring_;
154 Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
156 return in_appendix ? flatlabelstringappendix_ : flatlabelstring_;
160 Counters::Counters() : appendix_(false), subfloat_(false)
162 layout_stack_.push_back(0);
163 counter_stack_.push_back(from_ascii(""));
167 void Counters::newCounter(docstring const & newc,
168 docstring const & masterc,
169 docstring const & ls,
170 docstring const & lsa)
172 if (!masterc.empty() && !hasCounter(masterc)) {
173 lyxerr << "Master counter does not exist: "
178 counterList_[newc] = Counter(masterc, ls, lsa);
182 bool Counters::hasCounter(docstring const & c) const
184 return counterList_.find(c) != counterList_.end();
188 bool Counters::read(Lexer & lex, docstring const & name, bool makenew)
190 if (hasCounter(name)) {
191 LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
192 return counterList_[name].read(lex);
195 LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
197 bool success = cnt.read(lex);
198 // if makenew is false, we will just discard what we read
199 if (success && makenew)
200 counterList_[name] = cnt;
202 LYXERR0("Error reading counter `" << name << "'!");
207 void Counters::set(docstring const & ctr, int const val)
209 CounterList::iterator const it = counterList_.find(ctr);
210 if (it == counterList_.end()) {
211 lyxerr << "set: Counter does not exist: "
212 << to_utf8(ctr) << endl;
219 void Counters::addto(docstring const & ctr, int const val)
221 CounterList::iterator const it = counterList_.find(ctr);
222 if (it == counterList_.end()) {
223 lyxerr << "addto: Counter does not exist: "
224 << to_utf8(ctr) << endl;
227 it->second.addto(val);
231 int Counters::value(docstring const & ctr) const
233 CounterList::const_iterator const cit = counterList_.find(ctr);
234 if (cit == counterList_.end()) {
235 lyxerr << "value: Counter does not exist: "
236 << to_utf8(ctr) << endl;
239 return cit->second.value();
243 void Counters::step(docstring const & ctr, UpdateType utype)
245 CounterList::iterator it = counterList_.find(ctr);
246 if (it == counterList_.end()) {
247 lyxerr << "step: Counter does not exist: "
248 << to_utf8(ctr) << endl;
253 if (utype == OutputUpdate) {
254 LASSERT(!counter_stack_.empty(), /* */);
255 counter_stack_.pop_back();
256 counter_stack_.push_back(ctr);
258 it = counterList_.begin();
259 CounterList::iterator const end = counterList_.end();
260 for (; it != end; ++it) {
261 if (it->second.master() == ctr) {
268 void Counters::reset()
272 current_float_.erase();
273 CounterList::iterator it = counterList_.begin();
274 CounterList::iterator const end = counterList_.end();
275 for (; it != end; ++it)
277 counter_stack_.clear();
278 counter_stack_.push_back(from_ascii(""));
279 layout_stack_.clear();
280 layout_stack_.push_back(0);
284 void Counters::reset(docstring const & match)
286 LASSERT(!match.empty(), /**/);
288 CounterList::iterator it = counterList_.begin();
289 CounterList::iterator end = counterList_.end();
290 for (; it != end; ++it) {
291 if (it->first.find(match) != string::npos)
297 void Counters::copy(Counters & from, Counters & to, docstring const & match)
299 CounterList::iterator it = counterList_.begin();
300 CounterList::iterator end = counterList_.end();
301 for (; it != end; ++it) {
302 if (it->first.find(match) != string::npos || match == "") {
303 to.set(it->first, from.value(it->first));
311 char loweralphaCounter(int const n)
319 char alphaCounter(int const n)
327 char hebrewCounter(int const n)
329 static const char hebrew[22] = {
330 '\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
331 '\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
332 '\xf7', '\xf8', '\xf9', '\xfa'
337 return hebrew[n - 1];
342 // On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
343 // and for a list of roman numerals up to and including 3999, see
344 // http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
346 docstring const romanCounter(int const n)
348 static char const * const ones[9] = {
349 "I", "II", "III", "IV", "V",
350 "VI", "VII", "VIII", "IX"
353 static char const * const tens[9] = {
354 "X", "XX", "XXX", "XL", "L",
355 "LX", "LXX", "LXXX", "XC"
358 static char const * const hunds[9] = {
359 "C", "CC", "CCC", "CD", "D",
360 "DC", "DCC", "DCCC", "CM"
363 if (n > 1000 || n < 1)
364 return from_ascii("??");
378 int hundreds = val / 100;
379 roman = hunds[hundreds - 1];
386 roman = roman + "XC";
390 int tensnum = val / 10;
391 roman = roman + tens[tensnum - 1];
396 roman = roman + ones[val -1];
398 return from_ascii(roman);
402 docstring const lowerromanCounter(int const n)
404 return lowercase(romanCounter(n));
410 docstring Counters::labelItem(docstring const & ctr,
411 docstring const & numbertype) const
413 CounterList::const_iterator const cit = counterList_.find(ctr);
414 if (cit == counterList_.end()) {
417 << " does not exist." << endl;
421 int val = cit->second.value();
423 if (numbertype == "hebrew")
424 return docstring(1, hebrewCounter(val));
426 if (numbertype == "alph")
427 return docstring(1, loweralphaCounter(val));
429 if (numbertype == "Alph")
430 return docstring(1, alphaCounter(val));
432 if (numbertype == "roman")
433 return lowerromanCounter(val);
435 if (numbertype == "Roman")
436 return romanCounter(val);
438 return convert<docstring>(val);
442 docstring Counters::theCounter(docstring const & counter,
443 string const & lang) const
445 CounterList::const_iterator it = counterList_.find(counter);
446 if (it == counterList_.end())
447 return from_ascii("#");
448 Counter const & ctr = it->second;
449 Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
450 Counter::StringMap::iterator smit = sm.find(lang);
451 if (smit != sm.end())
452 return counterLabel(smit->second, lang);
454 deque<docstring> callers;
455 docstring const & fls = flattenLabelString(counter, appendix(),
458 return counterLabel(fls, lang);
462 docstring Counters::flattenLabelString(docstring const & counter,
465 deque<docstring> & callers) const
469 if (find(callers.begin(), callers.end(), counter) != callers.end()) {
470 // recursion detected
471 lyxerr << "Warning: Recursion in label for counter `"
472 << counter << "' detected"
474 return from_ascii("??");
477 CounterList::const_iterator it = counterList_.find(counter);
478 if (it == counterList_.end())
479 return from_ascii("#");
480 Counter const & c = it->second;
482 docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
484 callers.push_back(counter);
486 if (!c.master().empty())
487 ls = flattenLabelString(c.master(), in_appendix, lang, callers)
490 return ls + from_ascii("\\arabic{") + counter + "}";
494 //lyxerr << "ls=" << to_utf8(ls) << endl;
495 size_t const i = ls.find(from_ascii("\\the"), 0);
496 if (i == docstring::npos)
498 size_t const j = i + 4;
500 while (k < ls.size() && lowercase(ls[k]) >= 'a'
501 && lowercase(ls[k]) <= 'z')
503 docstring const newc = ls.substr(j, k - j);
504 docstring const repl = flattenLabelString(newc, in_appendix,
506 ls.replace(i, k - j + 4, repl);
514 docstring Counters::counterLabel(docstring const & format,
515 string const & lang) const
517 docstring label = format;
519 // FIXME: Using regexps would be better, but we compile boost without
520 // wide regexps currently.
521 docstring const the = from_ascii("\\the");
523 //lyxerr << "label=" << label << endl;
524 size_t const i = label.find(the, 0);
525 if (i == docstring::npos)
527 size_t const j = i + 4;
529 while (k < label.size() && lowercase(label[k]) >= 'a'
530 && lowercase(label[k]) <= 'z')
532 docstring const newc(label, j, k - j);
533 label.replace(i, k - i, theCounter(newc, lang));
536 //lyxerr << "label=" << label << endl;
538 size_t const i = label.find('\\', 0);
539 if (i == docstring::npos)
541 size_t const j = label.find('{', i + 1);
542 if (j == docstring::npos)
544 size_t const k = label.find('}', j + 1);
545 if (k == docstring::npos)
547 docstring const numbertype(label, i + 1, j - i - 1);
548 docstring const counter(label, j + 1, k - j - 1);
549 label.replace(i, k + 1 - i, labelItem(counter, numbertype));
551 //lyxerr << "DONE! label=" << label << endl;
556 docstring Counters::prettyCounter(docstring const & name,
557 string const & lang) const
559 CounterList::const_iterator it = counterList_.find(name);
560 if (it == counterList_.end())
561 return from_ascii("#");
562 Counter const & ctr = it->second;
564 docstring const value = theCounter(name, lang);
565 docstring const & format = ctr.prettyFormat();
568 return subst(format, from_ascii("##"), value);
572 docstring Counters::currentCounter() const
574 LASSERT(!counter_stack_.empty(), /* */);
575 return counter_stack_.back();
579 void Counters::setActiveLayout(Layout const & lay)
581 LASSERT(!layout_stack_.empty(), return);
582 Layout const * const lastlay = layout_stack_.back();
583 // we want to check whether the layout has changed and, if so,
584 // whether we are coming out of or going into an environment.
586 layout_stack_.pop_back();
587 layout_stack_.push_back(&lay);
588 if (lay.isEnvironment())
590 } else if (lastlay->name() != lay.name()) {
591 layout_stack_.pop_back();
592 layout_stack_.push_back(&lay);
593 if (lastlay->isEnvironment()) {
594 // we are coming out of an environment
595 // LYXERR0("Out: " << lastlay->name());
598 if (lay.isEnvironment()) {
599 // we are going into a new environment
600 // LYXERR0("In: " << lay.name());
607 void Counters::beginEnvironment()
609 counter_stack_.push_back(counter_stack_.back());
613 void Counters::endEnvironment()
615 LASSERT(!counter_stack_.empty(), return);
616 counter_stack_.pop_back();