src/Counters.cpp

   1 /**
   2  * \file Counters.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Martin Vermeer
   8  * \author André Pönitz
   9  * \author Richard Heck (roman numerals)
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "Counters.h"
  17 #include "Layout.h"
  18 #include "Lexer.h"
  19
  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"
  25
  26 #include <algorithm>
  27 #include <sstream>
  28
  29 using namespace std;
  30 using namespace lyx::support;
  31
  32 namespace lyx {
  33
  34
  35 Counter::Counter()
  36         : initial_value_(0)
  37 {
  38         reset();
  39 }
  40
  41
  42 Counter::Counter(docstring const & mc, docstring const & ls,
  43                 docstring const & lsa)
  44         : initial_value_(0), master_(mc), labelstring_(ls), labelstringappendix_(lsa)
  45 {
  46         reset();
  47 }
  48
  49
  50 bool Counter::read(Lexer & lex)
  51 {
  52         enum {
  53                 CT_WITHIN = 1,
  54                 CT_LABELSTRING,
  55                 CT_LABELSTRING_APPENDIX,
  56                 CT_PRETTYFORMAT,
  57                 CT_INITIALVALUE,
  58                 CT_END
  59         };
  60
  61         LexerKeyword counterTags[] = {
  62                 { "end", CT_END },
  63           { "initialvalue", CT_INITIALVALUE},
  64                 { "labelstring", CT_LABELSTRING },
  65                 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
  66                 { "prettyformat", CT_PRETTYFORMAT },
  67                 { "within", CT_WITHIN }
  68         };
  69
  70         lex.pushTable(counterTags);
  71
  72         bool getout = false;
  73         while (!getout && lex.isOK()) {
  74                 int le = lex.lex();
  75                 switch (le) {
  76                         case Lexer::LEX_UNDEF:
  77                                 lex.printError("Unknown counter tag `$$Token'");
  78                                 continue;
  79                         default:
  80                                 break;
  81                 }
  82                 switch (le) {
  83                         case CT_WITHIN:
  84                                 lex.next();
  85                                 master_ = lex.getDocString();
  86                                 if (master_ == "none")
  87                                         master_.erase();
  88                                 break;
  89                         case CT_INITIALVALUE:
  90                                 lex.next();
  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)
  97                                         initial_value_ = 0;
  98                                 else
  99                                         initial_value_ -= 1;
 100                                 break;
 101                         case CT_PRETTYFORMAT:
 102                                 lex.next();
 103                                 prettyformat_ = lex.getDocString();
 104                                 break;
 105                         case CT_LABELSTRING:
 106                                 lex.next();
 107                                 labelstring_ = lex.getDocString();
 108                                 labelstringappendix_ = labelstring_;
 109                                 break;
 110                         case CT_LABELSTRING_APPENDIX:
 111                                 lex.next();
 112                                 labelstringappendix_ = lex.getDocString();
 113                                 break;
 114                         case CT_END:
 115                                 getout = true;
 116                                 break;
 117                 }
 118         }
 119
 120         // Here if have a full counter if getout == true
 121         if (!getout)
 122                 LYXERR0("No End tag found for counter!");
 123         lex.popTable();
 124         return getout;
 125 }
 126
 127
 128 void Counter::set(int v)
 129 {
 130         value_ = v;
 131 }
 132
 133
 134 void Counter::addto(int v)
 135 {
 136         value_ += v;
 137 }
 138
 139
 140 int Counter::value() const
 141 {
 142         return value_;
 143 }
 144
 145
 146 void Counter::step()
 147 {
 148         ++value_;
 149 }
 150
 151
 152 void Counter::reset()
 153 {
 154         value_ = initial_value_;
 155 }
 156
 157
 158 docstring const & Counter::master() const
 159 {
 160         return master_;
 161 }
 162
 163
 164 bool Counter::checkAndRemoveMaster(docstring const & cnt)
 165 {
 166         if (master_ != cnt)
 167                 return false;
 168         master_ = docstring();
 169         return true;
 170 }
 171
 172
 173 docstring const & Counter::labelString(bool in_appendix) const
 174 {
 175         return in_appendix ? labelstringappendix_ : labelstring_;
 176 }
 177
 178
 179 Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
 180 {
 181         return in_appendix ? flatlabelstringappendix_ : flatlabelstring_;
 182 }
 183
 184
 185 Counters::Counters() : appendix_(false), subfloat_(false), longtable_(false)
 186 {
 187         layout_stack_.push_back(0);
 188         counter_stack_.push_back(from_ascii(""));
 189 }
 190
 191
 192 void Counters::newCounter(docstring const & newc,
 193                           docstring const & masterc,
 194                           docstring const & ls,
 195                           docstring const & lsa)
 196 {
 197         if (!masterc.empty() && !hasCounter(masterc)) {
 198                 lyxerr << "Master counter does not exist: "
 199                        << to_utf8(masterc)
 200                        << endl;
 201                 return;
 202         }
 203         counterList_[newc] = Counter(masterc, ls, lsa);
 204 }
 205
 206
 207 bool Counters::hasCounter(docstring const & c) const
 208 {
 209         return counterList_.find(c) != counterList_.end();
 210 }
 211
 212
 213 bool Counters::read(Lexer & lex, docstring const & name, bool makenew)
 214 {
 215         if (hasCounter(name)) {
 216                 LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
 217                 return counterList_[name].read(lex);
 218         }
 219
 220         LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
 221         Counter cnt;
 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;
 226         else if (!success)
 227                 LYXERR0("Error reading counter `" << name << "'!");
 228         return success;
 229 }
 230
 231
 232 void Counters::set(docstring const & ctr, int const val)
 233 {
 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;
 238                 return;
 239         }
 240         it->second.set(val);
 241 }
 242
 243
 244 void Counters::addto(docstring const & ctr, int const val)
 245 {
 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;
 250                 return;
 251         }
 252         it->second.addto(val);
 253 }
 254
 255
 256 int Counters::value(docstring const & ctr) const
 257 {
 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;
 262                 return 0;
 263         }
 264         return cit->second.value();
 265 }
 266
 267
 268 void Counters::resetSlaves(docstring const & ctr)
 269 {
 270         CounterList::iterator it = counterList_.begin();
 271         CounterList::iterator const end = counterList_.end();
 272         for (; it != end; ++it) {
 273                 if (it->second.master() == ctr) {
 274                         it->second.reset();
 275                         resetSlaves(it->first);
 276                 }
 277         }
 278 }
 279
 280
 281 void Counters::step(docstring const & ctr, UpdateType utype)
 282 {
 283         CounterList::iterator it = counterList_.find(ctr);
 284         if (it == counterList_.end()) {
 285                 lyxerr << "step: Counter does not exist: "
 286                        << to_utf8(ctr) << endl;
 287                 return;
 288         }
 289
 290         it->second.step();
 291         if (utype == OutputUpdate) {
 292                 LBUFERR(!counter_stack_.empty());
 293                 counter_stack_.pop_back();
 294                 counter_stack_.push_back(ctr);
 295         }
 296
 297         resetSlaves(ctr);
 298 }
 299
 300
 301 void Counters::reset()
 302 {
 303         appendix_ = false;
 304         subfloat_ = false;
 305         current_float_.erase();
 306         CounterList::iterator it = counterList_.begin();
 307         CounterList::iterator const end = counterList_.end();
 308         for (; it != end; ++it)
 309                 it->second.reset();
 310         counter_stack_.clear();
 311         counter_stack_.push_back(from_ascii(""));
 312         layout_stack_.clear();
 313         layout_stack_.push_back(0);
 314 }
 315
 316
 317 void Counters::reset(docstring const & match)
 318 {
 319         LASSERT(!match.empty(), return);
 320
 321         CounterList::iterator it = counterList_.begin();
 322         CounterList::iterator end = counterList_.end();
 323         for (; it != end; ++it) {
 324                 if (it->first.find(match) != string::npos)
 325                         it->second.reset();
 326         }
 327 }
 328
 329
 330 bool Counters::remove(docstring const & cnt)
 331 {
 332         bool retval = counterList_.erase(cnt);
 333         if (!retval)
 334                 return false;
 335         CounterList::iterator it = counterList_.begin();
 336         CounterList::iterator end = counterList_.end();
 337         for (; it != end; ++it) {
 338                 if (it->second.checkAndRemoveMaster(cnt))
 339                         LYXERR(Debug::TCLASS, "Removed master counter `" +
 340                                         to_utf8(cnt) + "' from counter: " + to_utf8(it->first));
 341         }
 342         return retval;
 343 }
 344
 345
 346 void Counters::copy(Counters & from, Counters & to, docstring const & match)
 347 {
 348         CounterList::iterator it = counterList_.begin();
 349         CounterList::iterator end = counterList_.end();
 350         for (; it != end; ++it) {
 351                 if (it->first.find(match) != string::npos || match == "") {
 352                         to.set(it->first, from.value(it->first));
 353                 }
 354         }
 355 }
 356
 357
 358 namespace {
 359
 360 char loweralphaCounter(int const n)
 361 {
 362         if (n < 1 || n > 26)
 363                 return '?';
 364         return 'a' + n - 1;
 365 }
 366
 367
 368 char alphaCounter(int const n)
 369 {
 370         if (n < 1 || n > 26)
 371                 return '?';
 372         return 'A' + n - 1;
 373 }
 374
 375
 376 char hebrewCounter(int const n)
 377 {
 378         static const char hebrew[22] = {
 379                 '\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
 380                 '\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
 381                 '\xf7', '\xf8', '\xf9', '\xfa'
 382         };
 383
 384         if (n < 1 || n > 22)
 385                 return '?';
 386         return hebrew[n - 1];
 387 }
 388
 389
 390 // On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
 391 // and for a list of roman numerals up to and including 3999, see
 392 // http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
 393 // for this info.)
 394 docstring const romanCounter(int const n)
 395 {
 396         static char const * const ones[9] = {
 397                 "I",   "II",  "III", "IV", "V",
 398                 "VI",  "VII", "VIII", "IX"
 399         };
 400
 401         static char const * const tens[9] = {
 402                 "X", "XX", "XXX", "XL", "L",
 403                 "LX", "LXX", "LXXX", "XC"
 404         };
 405
 406         static char const * const hunds[9] = {
 407                 "C", "CC", "CCC", "CD", "D",
 408                 "DC", "DCC", "DCCC", "CM"
 409         };
 410
 411         if (n >= 1000 || n < 1)
 412                 return from_ascii("??");
 413
 414         int val = n;
 415         string roman;
 416         switch (n) {
 417         //special cases
 418         case 900:
 419                 roman = "CM";
 420                 break;
 421         case 400:
 422                 roman = "CD";
 423                 break;
 424         default:
 425                 if (val >= 100) {
 426                         int hundreds = val / 100;
 427                         roman = hunds[hundreds - 1];
 428                         val = val % 100;
 429                 }
 430                 if (val >= 10) {
 431                         switch (val) {
 432                         //special case
 433                         case 90:
 434                                 roman = roman + "XC";
 435                                 val = 0; //skip next
 436                                 break;
 437                         default:
 438                                 int tensnum = val / 10;
 439                                 roman = roman + tens[tensnum - 1];
 440                                 val = val % 10;
 441                         } // end switch
 442                 } // end tens
 443                 if (val > 0)
 444                         roman = roman + ones[val -1];
 445         }
 446         return from_ascii(roman);
 447 }
 448
 449
 450 docstring const lowerromanCounter(int const n)
 451 {
 452         return lowercase(romanCounter(n));
 453 }
 454
 455
 456 docstring const fnsymbolCounter(int const n)
 457 {
 458         switch(n) {
 459         case 1: return docstring(1, 0x002a); //*
 460         case 2: return docstring(1, 0x2020); // dagger
 461         case 3: return docstring(1, 0x2021); // double dagger
 462         case 4: return docstring(1, 0x00A7); // section sign
 463         case 5: return docstring(1, 0x00B6); // pilcrow sign
 464         case 6: return docstring(1, 0x2016); // vertical bar
 465         case 7: return docstring(2, 0x002a); // two *
 466         case 8: return docstring(2, 0x2020); // two daggers
 467         case 9: return docstring(2, 0x2021); // two double daggers
 468         default:
 469                 return from_ascii("?");
 470         };
 471 }
 472
 473 } // namespace anon
 474
 475
 476 docstring Counters::labelItem(docstring const & ctr,
 477                               docstring const & numbertype) const
 478 {
 479         CounterList::const_iterator const cit = counterList_.find(ctr);
 480         if (cit == counterList_.end()) {
 481                 lyxerr << "Counter "
 482                        << to_utf8(ctr)
 483                        << " does not exist." << endl;
 484                 return docstring();
 485         }
 486
 487         int val = cit->second.value();
 488
 489         if (numbertype == "hebrew")
 490                 return docstring(1, hebrewCounter(val));
 491
 492         if (numbertype == "alph")
 493                 return docstring(1, loweralphaCounter(val));
 494
 495         if (numbertype == "Alph")
 496                 return docstring(1, alphaCounter(val));
 497
 498         if (numbertype == "roman")
 499                 return lowerromanCounter(val);
 500
 501         if (numbertype == "Roman")
 502                 return romanCounter(val);
 503
 504         if (numbertype == "fnsymbol")
 505                 return fnsymbolCounter(val);
 506
 507         return convert<docstring>(val);
 508 }
 509
 510
 511 docstring Counters::theCounter(docstring const & counter,
 512                                string const & lang) const
 513 {
 514         CounterList::const_iterator it = counterList_.find(counter);
 515         if (it == counterList_.end())
 516                 return from_ascii("#");
 517         Counter const & ctr = it->second;
 518         Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
 519         Counter::StringMap::iterator smit = sm.find(lang);
 520         if (smit != sm.end())
 521                 return counterLabel(smit->second, lang);
 522
 523         vector<docstring> callers;
 524         docstring const & fls = flattenLabelString(counter, appendix(),
 525                                                    lang, callers);
 526         sm[lang] = fls;
 527         return counterLabel(fls, lang);
 528 }
 529
 530
 531 docstring Counters::flattenLabelString(docstring const & counter,
 532                                        bool in_appendix,
 533                                        string const & lang,
 534                                        vector<docstring> & callers) const
 535 {
 536         if (find(callers.begin(), callers.end(), counter) != callers.end()) {
 537                 // recursion detected
 538                 lyxerr << "Warning: Recursion in label for counter `"
 539                        << counter << "' detected"
 540                        << endl;
 541                 return from_ascii("??");
 542         }
 543
 544         CounterList::const_iterator it = counterList_.find(counter);
 545         if (it == counterList_.end())
 546                 return from_ascii("#");
 547         Counter const & c = it->second;
 548
 549         docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
 550
 551         callers.push_back(counter);
 552         if (ls.empty()) {
 553                 if (!c.master().empty())
 554                         ls = flattenLabelString(c.master(), in_appendix, lang, callers)
 555                                 + from_ascii(".");
 556                 callers.pop_back();
 557                 return ls + from_ascii("\\arabic{") + counter + "}";
 558         }
 559
 560         while (true) {
 561                 //lyxerr << "ls=" << to_utf8(ls) << endl;
 562                 size_t const i = ls.find(from_ascii("\\the"), 0);
 563                 if (i == docstring::npos)
 564                         break;
 565                 size_t const j = i + 4;
 566                 size_t k = j;
 567                 while (k < ls.size() && lowercase(ls[k]) >= 'a'
 568                        && lowercase(ls[k]) <= 'z')
 569                         ++k;
 570                 docstring const newc = ls.substr(j, k - j);
 571                 docstring const repl = flattenLabelString(newc, in_appendix,
 572                                                           lang, callers);
 573                 ls.replace(i, k - j + 4, repl);
 574         }
 575         callers.pop_back();
 576
 577         return ls;
 578 }
 579
 580
 581 docstring Counters::counterLabel(docstring const & format,
 582                                  string const & lang) const
 583 {
 584         docstring label = format;
 585
 586         // FIXME: Using regexps would be better, but we compile boost without
 587         // wide regexps currently.
 588         docstring const the = from_ascii("\\the");
 589         while (true) {
 590                 //lyxerr << "label=" << label << endl;
 591                 size_t const i = label.find(the, 0);
 592                 if (i == docstring::npos)
 593                         break;
 594                 size_t const j = i + 4;
 595                 size_t k = j;
 596                 while (k < label.size() && lowercase(label[k]) >= 'a'
 597                        && lowercase(label[k]) <= 'z')
 598                         ++k;
 599                 docstring const newc(label, j, k - j);
 600                 label.replace(i, k - i, theCounter(newc, lang));
 601         }
 602         while (true) {
 603                 //lyxerr << "label=" << label << endl;
 604
 605                 size_t const i = label.find('\\', 0);
 606                 if (i == docstring::npos)
 607                         break;
 608                 size_t const j = label.find('{', i + 1);
 609                 if (j == docstring::npos)
 610                         break;
 611                 size_t const k = label.find('}', j + 1);
 612                 if (k == docstring::npos)
 613                         break;
 614                 docstring const numbertype(label, i + 1, j - i - 1);
 615                 docstring const counter(label, j + 1, k - j - 1);
 616                 label.replace(i, k + 1 - i, labelItem(counter, numbertype));
 617         }
 618         //lyxerr << "DONE! label=" << label << endl;
 619         return label;
 620 }
 621
 622
 623 docstring Counters::prettyCounter(docstring const & name,
 624                                string const & lang) const
 625 {
 626         CounterList::const_iterator it = counterList_.find(name);
 627         if (it == counterList_.end())
 628                 return from_ascii("#");
 629         Counter const & ctr = it->second;
 630
 631         docstring const value = theCounter(name, lang);
 632         docstring const & format =
 633             translateIfPossible(ctr.prettyFormat(), lang);
 634         if (format.empty())
 635                 return value;
 636         return subst(format, from_ascii("##"), value);
 637 }
 638
 639
 640 docstring Counters::currentCounter() const
 641 {
 642         LBUFERR(!counter_stack_.empty());
 643         return counter_stack_.back();
 644 }
 645
 646
 647 void Counters::setActiveLayout(Layout const & lay)
 648 {
 649         LASSERT(!layout_stack_.empty(), return);
 650         Layout const * const lastlay = layout_stack_.back();
 651         // we want to check whether the layout has changed and, if so,
 652         // whether we are coming out of or going into an environment.
 653         if (!lastlay) {
 654                 layout_stack_.pop_back();
 655                 layout_stack_.push_back(&lay);
 656                 if (lay.isEnvironment())
 657                         beginEnvironment();
 658         } else if (lastlay->name() != lay.name()) {
 659                 layout_stack_.pop_back();
 660                 layout_stack_.push_back(&lay);
 661                 if (lastlay->isEnvironment()) {
 662                         // we are coming out of an environment
 663                         // LYXERR0("Out: " << lastlay->name());
 664                         endEnvironment();
 665                 }
 666                 if (lay.isEnvironment()) {
 667                         // we are going into a new environment
 668                         // LYXERR0("In: " << lay.name());
 669                         beginEnvironment();
 670                 }
 671         }
 672 }
 673
 674
 675 void Counters::beginEnvironment()
 676 {
 677         counter_stack_.push_back(counter_stack_.back());
 678 }
 679
 680
 681 void Counters::endEnvironment()
 682 {
 683         LASSERT(!counter_stack_.empty(), return);
 684         counter_stack_.pop_back();
 685 }
 686
 687
 688 } // namespace lyx