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 "Lexer.h"
  18
  19 #include "support/convert.h"
  20 #include "support/debug.h"
  21 #include "support/gettext.h"
  22 #include "support/lassert.h"
  23 #include "support/lstrings.h"
  24
  25 #include <algorithm>
  26 #include <sstream>
  27
  28 using namespace std;
  29 using namespace lyx::support;
  30
  31 namespace lyx {
  32
  33
  34 Counter::Counter()
  35 {
  36         reset();
  37 }
  38
  39
  40 Counter::Counter(docstring const & mc, docstring const & ls,
  41                  docstring const & lsa)
  42         : master_(mc), labelstring_(ls), labelstringappendix_(lsa)
  43 {
  44         reset();
  45 }
  46
  47
  48 bool Counter::read(Lexer & lex)
  49 {
  50         enum {
  51                 CT_WITHIN = 1,
  52                 CT_LABELSTRING,
  53                 CT_LABELSTRING_APPENDIX,
  54                 CT_END
  55         };
  56
  57         LexerKeyword counterTags[] = {
  58                 { "end", CT_END },
  59                 { "labelstring", CT_LABELSTRING },
  60                 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
  61                 { "within", CT_WITHIN }
  62         };
  63
  64         lex.pushTable(counterTags);
  65
  66         bool getout = false;
  67         while (!getout && lex.isOK()) {
  68                 int le = lex.lex();
  69                 switch (le) {
  70                         case Lexer::LEX_UNDEF:
  71                                 lex.printError("Unknown counter tag `$$Token'");
  72                                 continue;
  73                         default:
  74                                 break;
  75                 }
  76                 switch (le) {
  77                         case CT_WITHIN:
  78                                 lex.next();
  79                                 master_ = lex.getDocString();
  80                                 if (master_ == "none")
  81                                         master_.erase();
  82                                 break;
  83                         case CT_LABELSTRING:
  84                                 lex.next();
  85                                 labelstring_ = lex.getDocString();
  86                                 labelstringappendix_ = labelstring_;
  87                                 break;
  88                         case CT_LABELSTRING_APPENDIX:
  89                                 lex.next();
  90                                 labelstringappendix_ = lex.getDocString();
  91                                 break;
  92                         case CT_END:
  93                                 getout = true;
  94                                 break;
  95                 }
  96         }
  97
  98         // Here if have a full counter if getout == true
  99         if (!getout)
 100                 LYXERR0("No End tag found for counter!");
 101         lex.popTable();
 102         return getout;
 103 }
 104
 105 void Counter::set(int v)
 106 {
 107         value_ = v;
 108 }
 109
 110
 111 void Counter::addto(int v)
 112 {
 113         value_ += v;
 114 }
 115
 116
 117 int Counter::value() const
 118 {
 119         return value_;
 120 }
 121
 122
 123 void Counter::step()
 124 {
 125         ++value_;
 126 }
 127
 128
 129 void Counter::reset()
 130 {
 131         value_ = 0;
 132 }
 133
 134
 135 docstring const & Counter::master() const
 136 {
 137         return master_;
 138 }
 139
 140
 141 docstring const & Counter::labelString(bool in_appendix) const
 142 {
 143         return in_appendix ? labelstringappendix_ : labelstring_;
 144 }
 145
 146
 147 Counter::StringMap & Counter::flatLabelStrings(bool in_appendix) const
 148 {
 149         return in_appendix ? flatlabelstringappendix_ : flatlabelstring_;
 150 }
 151
 152
 153 void Counters::newCounter(docstring const & newc,
 154                           docstring const & masterc,
 155                           docstring const & ls,
 156                           docstring const & lsa)
 157 {
 158         if (!masterc.empty() && !hasCounter(masterc)) {
 159                 lyxerr << "Master counter does not exist: "
 160                        << to_utf8(masterc)
 161                        << endl;
 162                 return;
 163         }
 164         counterList_[newc] = Counter(masterc, ls, lsa);
 165 }
 166
 167
 168 bool Counters::hasCounter(docstring const & c) const
 169 {
 170         return counterList_.find(c) != counterList_.end();
 171 }
 172
 173
 174 bool Counters::read(Lexer & lex, docstring const & name)
 175 {
 176         if (hasCounter(name)) {
 177                 LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
 178                 return counterList_[name].read(lex);
 179         }
 180         LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
 181         Counter cnt;
 182         bool success = cnt.read(lex);
 183         if (success)
 184                 counterList_[name] = cnt;
 185         else
 186                 LYXERR0("Error reading counter `" << name << "'!");
 187         return success;
 188 }
 189
 190
 191 void Counters::set(docstring const & ctr, int const val)
 192 {
 193         CounterList::iterator const it = counterList_.find(ctr);
 194         if (it == counterList_.end()) {
 195                 lyxerr << "set: Counter does not exist: "
 196                        << to_utf8(ctr) << endl;
 197                 return;
 198         }
 199         it->second.set(val);
 200 }
 201
 202
 203 void Counters::addto(docstring const & ctr, int const val)
 204 {
 205         CounterList::iterator const it = counterList_.find(ctr);
 206         if (it == counterList_.end()) {
 207                 lyxerr << "addto: Counter does not exist: "
 208                        << to_utf8(ctr) << endl;
 209                 return;
 210         }
 211         it->second.addto(val);
 212 }
 213
 214
 215 int Counters::value(docstring const & ctr) const
 216 {
 217         CounterList::const_iterator const cit = counterList_.find(ctr);
 218         if (cit == counterList_.end()) {
 219                 lyxerr << "value: Counter does not exist: "
 220                        << to_utf8(ctr) << endl;
 221                 return 0;
 222         }
 223         return cit->second.value();
 224 }
 225
 226
 227 void Counters::step(docstring const & ctr)
 228 {
 229         CounterList::iterator it = counterList_.find(ctr);
 230         if (it == counterList_.end()) {
 231                 lyxerr << "step: Counter does not exist: "
 232                        << to_utf8(ctr) << endl;
 233                 return;
 234         }
 235
 236         it->second.step();
 237         it = counterList_.begin();
 238         CounterList::iterator const end = counterList_.end();
 239         for (; it != end; ++it) {
 240                 if (it->second.master() == ctr) {
 241                         it->second.reset();
 242                 }
 243         }
 244 }
 245
 246
 247 void Counters::reset()
 248 {
 249         appendix_ = false;
 250         subfloat_ = false;
 251         current_float_.erase();
 252         CounterList::iterator it = counterList_.begin();
 253         CounterList::iterator const end = counterList_.end();
 254         for (; it != end; ++it)
 255                 it->second.reset();
 256 }
 257
 258
 259 void Counters::reset(docstring const & match)
 260 {
 261         LASSERT(!match.empty(), /**/);
 262
 263         CounterList::iterator it = counterList_.begin();
 264         CounterList::iterator end = counterList_.end();
 265         for (; it != end; ++it) {
 266                 if (it->first.find(match) != string::npos)
 267                         it->second.reset();
 268         }
 269 }
 270
 271
 272 void Counters::copy(Counters & from, Counters & to, docstring const & match)
 273 {
 274         CounterList::iterator it = counterList_.begin();
 275         CounterList::iterator end = counterList_.end();
 276         for (; it != end; ++it) {
 277                 if (it->first.find(match) != string::npos || match == "") {
 278                         to.set(it->first, from.value(it->first));
 279                 }
 280         }
 281 }
 282
 283
 284 namespace {
 285
 286 char loweralphaCounter(int const n)
 287 {
 288         if (n < 1 || n > 26)
 289                 return '?';
 290         return 'a' + n - 1;
 291 }
 292
 293
 294 char alphaCounter(int const n)
 295 {
 296         if (n < 1 || n > 26)
 297                 return '?';
 298         return 'A' + n - 1;
 299 }
 300
 301
 302 char hebrewCounter(int const n)
 303 {
 304         static const char hebrew[22] = {
 305                 '\xe0', '\xe1', '\xe2', '\xe3', '\xe4', '\xe5', '\xe6', '\xe7', '\xe8',
 306                 '\xe9', '\xeb', '\xec', '\xee', '\xf0', '\xf1', '\xf2', '\xf4', '\xf6',
 307                 '\xf7', '\xf8', '\xf9', '\xfa'
 308         };
 309
 310         if (n < 1 || n > 22)
 311                 return '?';
 312         return hebrew[n - 1];
 313 }
 314
 315
 316
 317 // On the special cases, see http://mathworld.wolfram.com/RomanNumerals.html
 318 // and for a list of roman numerals up to and including 3999, see
 319 // http://www.research.att.com/~njas/sequences/a006968.txt. (Thanks to Joost
 320 // for this info.)
 321 docstring const romanCounter(int const n)
 322 {
 323         static char const * const ones[9] = {
 324                 "I",   "II",  "III", "IV", "V",
 325                 "VI",  "VII", "VIII", "IX"
 326         };
 327
 328         static char const * const tens[9] = {
 329                 "X", "XX", "XXX", "XL", "L",
 330                 "LX", "LXX", "LXXX", "XC"
 331         };
 332
 333         static char const * const hunds[9] = {
 334                 "C", "CC", "CCC", "CD", "D",
 335                 "DC", "DCC", "DCCC", "CM"
 336         };
 337
 338         if (n > 1000 || n < 1)
 339                 return from_ascii("??");
 340
 341         int val = n;
 342         string roman;
 343         switch (n) {
 344         //special cases
 345         case 900:
 346                 roman = "CM";
 347                 break;
 348         case 400:
 349                 roman = "CD";
 350                 break;
 351         default:
 352                 if (val >= 100) {
 353                         int hundreds = val / 100;
 354                         roman = hunds[hundreds - 1];
 355                         val = val % 100;
 356                 }
 357                 if (val >= 10) {
 358                         switch (val) {
 359                         //special case
 360                         case 90:
 361                                 roman = roman + "XC";
 362                                 val = 0; //skip next
 363                                 break;
 364                         default:
 365                                 int tensnum = val / 10;
 366                                 roman = roman + tens[tensnum - 1];
 367                                 val = val % 10;
 368                         } // end switch
 369                 } // end tens
 370                 if (val > 0)
 371                         roman = roman + ones[val -1];
 372         }
 373         return from_ascii(roman);
 374 }
 375
 376
 377 docstring const lowerromanCounter(int const n)
 378 {
 379         return lowercase(romanCounter(n));
 380 }
 381
 382 } // namespace anon
 383
 384
 385 docstring Counters::labelItem(docstring const & ctr,
 386                               docstring const & numbertype) const
 387 {
 388         CounterList::const_iterator const cit = counterList_.find(ctr);
 389         if (cit == counterList_.end()) {
 390                 lyxerr << "Counter "
 391                        << to_utf8(ctr)
 392                        << " does not exist." << endl;
 393                 return docstring();
 394         }
 395
 396         int val = cit->second.value();
 397
 398         if (numbertype == "hebrew")
 399                 return docstring(1, hebrewCounter(val));
 400
 401         if (numbertype == "alph")
 402                 return docstring(1, loweralphaCounter(val));
 403
 404         if (numbertype == "Alph")
 405                 return docstring(1, alphaCounter(val));
 406
 407         if (numbertype == "roman")
 408                 return lowerromanCounter(val);
 409
 410         if (numbertype == "Roman")
 411                 return romanCounter(val);
 412
 413         return convert<docstring>(val);
 414 }
 415
 416
 417 docstring Counters::theCounter(docstring const & counter,
 418                                string const & lang) const
 419 {
 420         CounterList::const_iterator it = counterList_.find(counter);
 421         if (it == counterList_.end())
 422                 return from_ascii("??");
 423         Counter const & ctr = it->second;
 424         Counter::StringMap & sm = ctr.flatLabelStrings(appendix());
 425         Counter::StringMap::iterator smit = sm.find(lang);
 426         if (smit != sm.end())
 427                 return counterLabel(smit->second, lang);
 428
 429         vector<docstring> callers;
 430         docstring const & fls = flattenLabelString(counter, appendix(),
 431                                                    lang, callers);
 432         sm[lang] = fls;
 433         return counterLabel(fls, lang);
 434 }
 435
 436
 437 docstring Counters::flattenLabelString(docstring const & counter,
 438                                        bool in_appendix,
 439                                        string const & lang,
 440                                        vector<docstring> & callers) const
 441 {
 442         docstring label;
 443
 444         if (find(callers.begin(), callers.end(), counter) != callers.end()) {
 445                 // recursion detected
 446                 lyxerr << "Warning: Recursion in label for counter `"
 447                        << counter << "' detected"
 448                        << endl;
 449                 return from_ascii("??");
 450         }
 451
 452         CounterList::const_iterator it = counterList_.find(counter);
 453         if (it == counterList_.end())
 454                 return from_ascii("??");
 455         Counter const & c = it->second;
 456
 457         docstring ls = translateIfPossible(c.labelString(in_appendix), lang);
 458
 459         callers.push_back(counter);
 460         if (ls.empty()) {
 461                 if (!c.master().empty())
 462                         ls = flattenLabelString(c.master(), in_appendix, lang, callers)
 463                                 + from_ascii(".");
 464                 callers.pop_back();
 465                 return ls + from_ascii("\\arabic{") + counter + "}";
 466         }
 467
 468         while (true) {
 469                 //lyxerr << "ls=" << to_utf8(ls) << endl;
 470                 size_t const i = ls.find(from_ascii("\\the"), 0);
 471                 if (i == docstring::npos)
 472                         break;
 473                 size_t const j = i + 4;
 474                 size_t k = j;
 475                 while (k < ls.size() && lowercase(ls[k]) >= 'a'
 476                        && lowercase(ls[k]) <= 'z')
 477                         ++k;
 478                 docstring const newc = ls.substr(j, k - j);
 479                 docstring const repl = flattenLabelString(newc, in_appendix,
 480                                                           lang, callers);
 481                 ls.replace(i, k - j + 4, repl);
 482         }
 483         callers.pop_back();
 484
 485         return ls;
 486 }
 487
 488
 489 docstring Counters::counterLabel(docstring const & format,
 490                                  string const & lang) const
 491 {
 492         docstring label = format;
 493
 494         // FIXME: Using regexps would be better, but we compile boost without
 495         // wide regexps currently.
 496         docstring const the = from_ascii("\\the");
 497         while (true) {
 498                 //lyxerr << "label=" << label << endl;
 499                 size_t const i = label.find(the, 0);
 500                 if (i == docstring::npos)
 501                         break;
 502                 size_t const j = i + 4;
 503                 size_t k = j;
 504                 while (k < label.size() && lowercase(label[k]) >= 'a'
 505                        && lowercase(label[k]) <= 'z')
 506                         ++k;
 507                 docstring const newc(label, j, k - j);
 508                 label.replace(i, k - i, theCounter(newc, lang));
 509         }
 510         while (true) {
 511                 //lyxerr << "label=" << label << endl;
 512
 513                 size_t const i = label.find('\\', 0);
 514                 if (i == docstring::npos)
 515                         break;
 516                 size_t const j = label.find('{', i + 1);
 517                 if (j == docstring::npos)
 518                         break;
 519                 size_t const k = label.find('}', j + 1);
 520                 if (k == docstring::npos)
 521                         break;
 522                 docstring const numbertype(label, i + 1, j - i - 1);
 523                 docstring const counter(label, j + 1, k - j - 1);
 524                 label.replace(i, k + 1 - i, labelItem(counter, numbertype));
 525         }
 526         //lyxerr << "DONE! label=" << label << endl;
 527         return label;
 528 }
 529
 530
 531 } // namespace lyx