src/tex2lyx/Parser.cpp

   1 /**
   2  * \file Parser.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "Encoding.h"
  14 #include "Parser.h"
  15 #include "support/textutils.h"
  16
  17 #include <iostream>
  18
  19 using namespace std;
  20
  21 namespace lyx {
  22
  23 namespace {
  24
  25 CatCode theCatcode[256];
  26
  27 void catInit()
  28 {
  29         static bool init_done = false;
  30         if (init_done)
  31                 return;
  32         init_done = true;
  33
  34         fill(theCatcode, theCatcode + 256, catOther);
  35         fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
  36         fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
  37
  38         theCatcode[int('\\')] = catEscape;
  39         theCatcode[int('{')]  = catBegin;
  40         theCatcode[int('}')]  = catEnd;
  41         theCatcode[int('$')]  = catMath;
  42         theCatcode[int('&')]  = catAlign;
  43         theCatcode[int('\n')] = catNewline;
  44         theCatcode[int('#')]  = catParameter;
  45         theCatcode[int('^')]  = catSuper;
  46         theCatcode[int('_')]  = catSub;
  47         theCatcode[0x7f]      = catIgnore;
  48         theCatcode[int(' ')]  = catSpace;
  49         theCatcode[int('\t')] = catSpace;
  50         theCatcode[int('\r')] = catNewline;
  51         theCatcode[int('~')]  = catActive;
  52         theCatcode[int('%')]  = catComment;
  53
  54         // This is wrong!
  55         theCatcode[int('@')]  = catLetter;
  56 }
  57
  58 /*!
  59  * Translate a line ending to '\n'.
  60  * \p c must have catcode catNewline, and it must be the last character read
  61  * from \p is.
  62  */
  63 char_type getNewline(idocstream & is, char_type c)
  64 {
  65         // we have to handle 3 different line endings:
  66         // - UNIX (\n)
  67         // - MAC  (\r)
  68         // - DOS  (\r\n)
  69         if (c == '\r') {
  70                 // MAC or DOS
  71                 char_type wc;
  72                 if (is.get(wc) && wc != '\n') {
  73                         // MAC
  74                         is.putback(wc);
  75                 }
  76                 return '\n';
  77         }
  78         // UNIX
  79         return c;
  80 }
  81
  82 CatCode catcode(char_type c)
  83 {
  84         if (c < 256)
  85                 return theCatcode[(unsigned char)c];
  86         return catOther;
  87 }
  88
  89 }
  90
  91
  92 //
  93 // Token
  94 //
  95
  96 ostream & operator<<(ostream & os, Token const & t)
  97 {
  98         if (t.cat() == catComment)
  99                 os << '%' << t.cs() << '\n';
 100         else if (t.cat() == catSpace)
 101                 os << t.cs();
 102         else if (t.cat() == catEscape)
 103                 os << '\\' << t.cs() << ' ';
 104         else if (t.cat() == catLetter)
 105                 os << t.cs();
 106         else if (t.cat() == catNewline)
 107                 os << "[" << t.cs().size() << "\\n," << t.cat() << "]\n";
 108         else
 109                 os << '[' << t.cs() << ',' << t.cat() << ']';
 110         return os;
 111 }
 112
 113
 114 string Token::asInput() const
 115 {
 116         if (cat_ == catComment)
 117                 return '%' + cs_ + '\n';
 118         if (cat_ == catEscape)
 119                 return '\\' + cs_;
 120         return cs_;
 121 }
 122
 123
 124 bool Token::isAlnumASCII() const
 125 {
 126         return cat_ == catLetter ||
 127                (cat_ == catOther && cs_.length() == 1 && isDigitASCII(cs_[0]));
 128 }
 129
 130
 131 #ifdef FILEDEBUG
 132 void debugToken(std::ostream & os, Token const & t, unsigned int flags)
 133 {
 134         char sep = ' ';
 135         os << "t: " << t << " flags: " << flags;
 136         if (flags & FLAG_BRACE_LAST) { os << sep << "BRACE_LAST"; sep = '|'; }
 137         if (flags & FLAG_RIGHT     ) { os << sep << "RIGHT"     ; sep = '|'; }
 138         if (flags & FLAG_END       ) { os << sep << "END"       ; sep = '|'; }
 139         if (flags & FLAG_BRACK_LAST) { os << sep << "BRACK_LAST"; sep = '|'; }
 140         if (flags & FLAG_TEXTMODE  ) { os << sep << "TEXTMODE"  ; sep = '|'; }
 141         if (flags & FLAG_ITEM      ) { os << sep << "ITEM"      ; sep = '|'; }
 142         if (flags & FLAG_LEAVE     ) { os << sep << "LEAVE"     ; sep = '|'; }
 143         if (flags & FLAG_SIMPLE    ) { os << sep << "SIMPLE"    ; sep = '|'; }
 144         if (flags & FLAG_EQUATION  ) { os << sep << "EQUATION"  ; sep = '|'; }
 145         if (flags & FLAG_SIMPLE2   ) { os << sep << "SIMPLE2"   ; sep = '|'; }
 146         if (flags & FLAG_OPTION    ) { os << sep << "OPTION"    ; sep = '|'; }
 147         if (flags & FLAG_BRACED    ) { os << sep << "BRACED"    ; sep = '|'; }
 148         if (flags & FLAG_CELL      ) { os << sep << "CELL"      ; sep = '|'; }
 149         if (flags & FLAG_TABBING   ) { os << sep << "TABBING"   ; sep = '|'; }
 150         os << "\n";
 151 }
 152 #endif
 153
 154
 155 //
 156 // Parser
 157 //
 158
 159
 160 Parser::Parser(idocstream & is)
 161         : lineno_(0), pos_(0), iss_(0), is_(is), encoding_latex_("utf8")
 162 {
 163 }
 164
 165
 166 Parser::Parser(string const & s)
 167         : lineno_(0), pos_(0),
 168           iss_(new idocstringstream(from_utf8(s))), is_(*iss_),
 169           encoding_latex_("utf8")
 170 {
 171 }
 172
 173
 174 Parser::~Parser()
 175 {
 176         delete iss_;
 177 }
 178
 179
 180 void Parser::setEncoding(std::string const & e)
 181 {
 182         Encoding const * enc = encodings.fromLaTeXName(e);
 183         if (!enc) {
 184                 cerr << "Unknown encoding " << e << ". Ignoring." << std::endl;
 185                 return;
 186         }
 187         //cerr << "setting encoding to " << enc->iconvName() << std::endl;
 188         is_ << lyx::setEncoding(enc->iconvName());
 189         encoding_latex_ = e;
 190 }
 191
 192
 193 void Parser::push_back(Token const & t)
 194 {
 195         tokens_.push_back(t);
 196 }
 197
 198
 199 // We return a copy here because the tokens_ vector may get reallocated
 200 Token const Parser::prev_token() const
 201 {
 202         static const Token dummy;
 203         return pos_ > 1 ? tokens_[pos_ - 2] : dummy;
 204 }
 205
 206
 207 // We return a copy here because the tokens_ vector may get reallocated
 208 Token const Parser::curr_token() const
 209 {
 210         static const Token dummy;
 211         return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
 212 }
 213
 214
 215 // We return a copy here because the tokens_ vector may get reallocated
 216 Token const Parser::next_token()
 217 {
 218         static const Token dummy;
 219         return good() ? tokens_[pos_] : dummy;
 220 }
 221
 222
 223 // We return a copy here because the tokens_ vector may get reallocated
 224 Token const Parser::next_next_token()
 225 {
 226         static const Token dummy;
 227         // If good() has not been called after the last get_token() we need
 228         // to tokenize two more tokens.
 229         if (pos_ + 1 >= tokens_.size()) {
 230                 tokenize_one();
 231                 tokenize_one();
 232         }
 233         return pos_ + 1 < tokens_.size() ? tokens_[pos_ + 1] : dummy;
 234 }
 235
 236
 237 // We return a copy here because the tokens_ vector may get reallocated
 238 Token const Parser::get_token()
 239 {
 240         static const Token dummy;
 241         //cerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << '\n';
 242         return good() ? tokens_[pos_++] : dummy;
 243 }
 244
 245
 246 bool Parser::isParagraph()
 247 {
 248         // A new paragraph in TeX ist started
 249         // - either by a newline, following any amount of whitespace
 250         //   characters (including zero), and another newline
 251         // - or the token \par
 252         if (curr_token().cat() == catNewline &&
 253             (curr_token().cs().size() > 1 ||
 254              (next_token().cat() == catSpace &&
 255               next_next_token().cat() == catNewline)))
 256                 return true;
 257         if (curr_token().cat() == catEscape && curr_token().cs() == "par")
 258                 return true;
 259         return false;
 260 }
 261
 262
 263 bool Parser::skip_spaces(bool skip_comments)
 264 {
 265         // We just silently return if we have no more tokens.
 266         // skip_spaces() should be callable at any time,
 267         // the caller must check p::good() anyway.
 268         bool skipped = false;
 269         while (good()) {
 270                 get_token();
 271                 if (isParagraph()) {
 272                         putback();
 273                         break;
 274                 }
 275                 if (curr_token().cat() == catSpace ||
 276                     curr_token().cat() == catNewline) {
 277                         skipped = true;
 278                         continue;
 279                 }
 280                 if ((curr_token().cat() == catComment && curr_token().cs().empty()))
 281                         continue;
 282                 if (skip_comments && curr_token().cat() == catComment) {
 283                         // If positions_ is not empty we are doing some kind
 284                         // of look ahead
 285                         if (!positions_.empty())
 286                                 cerr << "  Ignoring comment: "
 287                                      << curr_token().asInput();
 288                 } else {
 289                         putback();
 290                         break;
 291                 }
 292         }
 293         return skipped;
 294 }
 295
 296
 297 void Parser::unskip_spaces(bool skip_comments)
 298 {
 299         while (pos_ > 0) {
 300                 if ( curr_token().cat() == catSpace ||
 301                     (curr_token().cat() == catNewline && curr_token().cs().size() == 1))
 302                         putback();
 303                 else if (skip_comments && curr_token().cat() == catComment) {
 304                         // TODO: Get rid of this
 305                         // If positions_ is not empty we are doing some kind
 306                         // of look ahead
 307                         if (!positions_.empty())
 308                                 cerr << "Unignoring comment: "
 309                                      << curr_token().asInput();
 310                         putback();
 311                 }
 312                 else
 313                         break;
 314         }
 315 }
 316
 317
 318 void Parser::putback()
 319 {
 320         --pos_;
 321 }
 322
 323
 324 void Parser::pushPosition()
 325 {
 326         positions_.push_back(pos_);
 327 }
 328
 329
 330 void Parser::popPosition()
 331 {
 332         pos_ = positions_.back();
 333         positions_.pop_back();
 334 }
 335
 336
 337 bool Parser::good()
 338 {
 339         if (pos_ < tokens_.size())
 340                 return true;
 341         tokenize_one();
 342         return pos_ < tokens_.size();
 343 }
 344
 345
 346 char Parser::getChar()
 347 {
 348         if (!good())
 349                 error("The input stream is not well...");
 350         return get_token().character();
 351 }
 352
 353
 354 bool Parser::hasOpt()
 355 {
 356         // An optional argument can occur in any of the following forms:
 357         // - \foo[bar]
 358         // - \foo [bar]
 359         // - \foo
 360         //   [bar]
 361         // - \foo %comment
 362         //   [bar]
 363
 364         // remember current position
 365         unsigned int oldpos = pos_;
 366         // skip spaces and comments
 367         while (good()) {
 368                 get_token();
 369                 if (isParagraph()) {
 370                         putback();
 371                         break;
 372                 }
 373                 if (curr_token().cat() == catSpace ||
 374                     curr_token().cat() == catNewline ||
 375                     curr_token().cat() == catComment)
 376                         continue;
 377                 putback();
 378                 break;
 379         }
 380         bool const retval = (next_token().asInput() == "[");
 381         pos_ = oldpos;
 382         return retval;
 383 }
 384
 385
 386 Parser::Arg Parser::getFullArg(char left, char right)
 387 {
 388         skip_spaces(true);
 389
 390         // This is needed if a partial file ends with a command without arguments,
 391         // e. g. \medskip
 392         if (! good())
 393                 return make_pair(false, string());
 394
 395         string result;
 396         char c = getChar();
 397
 398         if (c != left) {
 399                 putback();
 400                 return make_pair(false, string());
 401         } else {
 402                 // for \verb a single '\' is allowed no matter what the delimiter is
 403                 // for example "\verb+\+" (reported as bug #4468)
 404                 // To support this, we allow single '\' if it is the only character
 405                 // within equal delimiters
 406                 if (next_token().cat() == catEscape)
 407                         if (next_token().character() == right && right == left)
 408                                 result += '\\';
 409                 while ((c = getChar()) != right && good()) {
 410                         // Ignore comments
 411                         if (curr_token().cat() == catComment) {
 412                                 if (!curr_token().cs().empty())
 413                                         cerr << "Ignoring comment: " << curr_token().asInput();
 414                         }
 415                         else
 416                                 result += curr_token().asInput();
 417                 }
 418         }
 419         return make_pair(true, result);
 420 }
 421
 422
 423 string Parser::getArg(char left, char right)
 424 {
 425         return getFullArg(left, right).second;
 426 }
 427
 428
 429 string Parser::getFullOpt(bool keepws)
 430 {
 431         Arg arg = getFullArg('[', ']');
 432         if (arg.first)
 433                 return '[' + arg.second + ']';
 434         if (keepws)
 435                 unskip_spaces(true);
 436         return string();
 437 }
 438
 439
 440 string Parser::getOpt(bool keepws)
 441 {
 442         string const res = getArg('[', ']');
 443         if (res.empty()) {
 444                 if (keepws)
 445                         unskip_spaces(true);
 446                 return string();
 447         }
 448         return '[' + res + ']';
 449 }
 450
 451
 452 string Parser::getFullParentheseArg()
 453 {
 454         Arg arg = getFullArg('(', ')');
 455         if (arg.first)
 456                 return '(' + arg.second + ')';
 457         return string();
 458 }
 459
 460
 461 string const Parser::verbatimEnvironment(string const & name)
 462 {
 463         if (!good())
 464                 return string();
 465
 466         ostringstream os;
 467         for (Token t = get_token(); good(); t = get_token()) {
 468                 if (t.cat() == catBegin) {
 469                         putback();
 470                         os << '{' << verbatim_item() << '}';
 471                 } else if (t.asInput() == "\\begin") {
 472                         string const env = getArg('{', '}');
 473                         os << "\\begin{" << env << '}'
 474                            << verbatimEnvironment(env)
 475                            << "\\end{" << env << '}';
 476                 } else if (t.asInput() == "\\end") {
 477                         string const end = getArg('{', '}');
 478                         if (end != name)
 479                                 cerr << "\\end{" << end
 480                                      << "} does not match \\begin{" << name
 481                                      << "}." << endl;
 482                         return os.str();
 483                 } else
 484                         os << t.asInput();
 485         }
 486         cerr << "unexpected end of input" << endl;
 487         return os.str();
 488 }
 489
 490
 491 string const Parser::plainEnvironment(string const & name)
 492 {
 493         if (!good())
 494                 return string();
 495
 496         ostringstream os;
 497         for (Token t = get_token(); good(); t = get_token()) {
 498                 if (t.asInput() == "\\end") {
 499                         string const end = getArg('{', '}');
 500                         if (end == name)
 501                                 return os.str();
 502                         else
 503                                 os << "\\end{" << end << '}';
 504                 } else
 505                         os << t.asInput();
 506         }
 507         cerr << "unexpected end of input" << endl;
 508         return os.str();
 509 }
 510
 511
 512 string const Parser::plainCommand(char left, char right, string const & name)
 513 {
 514         if (!good())
 515                 return string();
 516         // check if first token is really the start character
 517         Token tok = get_token();
 518         if (tok.character() != left) {
 519                 cerr << "first character does not match start character of command \\" << name << endl;
 520                 return string();
 521         }
 522         ostringstream os;
 523         for (Token t = get_token(); good(); t = get_token()) {
 524                 if (t.character() == right) {
 525                         return os.str();
 526                 } else
 527                         os << t.asInput();
 528         }
 529         cerr << "unexpected end of input" << endl;
 530         return os.str();
 531 }
 532
 533
 534 void Parser::tokenize_one()
 535 {
 536         catInit();
 537         char_type c;
 538         if (!is_.get(c))
 539                 return;
 540
 541         switch (catcode(c)) {
 542         case catSpace: {
 543                 docstring s(1, c);
 544                 while (is_.get(c) && catcode(c) == catSpace)
 545                         s += c;
 546                 if (catcode(c) != catSpace)
 547                         is_.putback(c);
 548                 push_back(Token(s, catSpace));
 549                 break;
 550         }
 551
 552         case catNewline: {
 553                 ++lineno_;
 554                 docstring s(1, getNewline(is_, c));
 555                 while (is_.get(c) && catcode(c) == catNewline) {
 556                         ++lineno_;
 557                         s += getNewline(is_, c);
 558                 }
 559                 if (catcode(c) != catNewline)
 560                         is_.putback(c);
 561                 push_back(Token(s, catNewline));
 562                 break;
 563         }
 564
 565         case catComment: {
 566                 // We don't treat "%\n" combinations here specially because
 567                 // we want to preserve them in the preamble
 568                 docstring s;
 569                 while (is_.get(c) && catcode(c) != catNewline)
 570                         s += c;
 571                 // handle possible DOS line ending
 572                 if (catcode(c) == catNewline)
 573                         c = getNewline(is_, c);
 574                 // Note: The '%' at the beginning and the '\n' at the end
 575                 // of the comment are not stored.
 576                 ++lineno_;
 577                 push_back(Token(s, catComment));
 578                 break;
 579         }
 580
 581         case catEscape: {
 582                 is_.get(c);
 583                 if (!is_) {
 584                         error("unexpected end of input");
 585                 } else {
 586                         docstring s(1, c);
 587                         if (catcode(c) == catLetter) {
 588                                 // collect letters
 589                                 while (is_.get(c) && catcode(c) == catLetter)
 590                                         s += c;
 591                                 if (catcode(c) != catLetter)
 592                                         is_.putback(c);
 593                         }
 594                         push_back(Token(s, catEscape));
 595                 }
 596                 break;
 597         }
 598
 599         case catIgnore: {
 600                 cerr << "ignoring a char: " << c << "\n";
 601                 break;
 602         }
 603
 604         default:
 605                 push_back(Token(docstring(1, c), catcode(c)));
 606         }
 607         //cerr << tokens_.back();
 608 }
 609
 610
 611 void Parser::dump() const
 612 {
 613         cerr << "\nTokens: ";
 614         for (unsigned i = 0; i < tokens_.size(); ++i) {
 615                 if (i == pos_)
 616                         cerr << " <#> ";
 617                 cerr << tokens_[i];
 618         }
 619         cerr << " pos: " << pos_ << "\n";
 620 }
 621
 622
 623 void Parser::error(string const & msg)
 624 {
 625         cerr << "Line ~" << lineno_ << ":  parse error: " << msg << endl;
 626         dump();
 627         //exit(1);
 628 }
 629
 630
 631 string Parser::verbatimOption()
 632 {
 633         string res;
 634         if (next_token().character() == '[') {
 635                 Token t = get_token();
 636                 for (t = get_token(); t.character() != ']' && good(); t = get_token()) {
 637                         if (t.cat() == catBegin) {
 638                                 putback();
 639                                 res += '{' + verbatim_item() + '}';
 640                         } else
 641                                 res += t.cs();
 642                 }
 643         }
 644         return res;
 645 }
 646
 647
 648 string Parser::verbatim_item()
 649 {
 650         if (!good())
 651                 error("stream bad");
 652         skip_spaces();
 653         if (next_token().cat() == catBegin) {
 654                 Token t = get_token(); // skip brace
 655                 string res;
 656                 for (Token t = get_token(); t.cat() != catEnd && good(); t = get_token()) {
 657                         if (t.cat() == catBegin) {
 658                                 putback();
 659                                 res += '{' + verbatim_item() + '}';
 660                         }
 661                         else
 662                                 res += t.asInput();
 663                 }
 664                 return res;
 665         }
 666         return get_token().asInput();
 667 }
 668
 669
 670 void Parser::reset()
 671 {
 672         pos_ = 0;
 673 }
 674
 675
 676 void Parser::setCatCode(char c, CatCode cat)
 677 {
 678         theCatcode[(unsigned char)c] = cat;
 679 }
 680
 681
 682 CatCode Parser::getCatCode(char c) const
 683 {
 684         return theCatcode[(unsigned char)c];
 685 }
 686
 687
 688 } // namespace lyx