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
  16 #include <iostream>
  17
  18 using namespace std;
  19
  20 namespace lyx {
  21
  22 namespace {
  23
  24 CatCode theCatcode[256];
  25
  26 void catInit()
  27 {
  28         static bool init_done = false;
  29         if (init_done)
  30                 return;
  31         init_done = true;
  32
  33         fill(theCatcode, theCatcode + 256, catOther);
  34         fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
  35         fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
  36
  37         theCatcode[int('\\')] = catEscape;
  38         theCatcode[int('{')]  = catBegin;
  39         theCatcode[int('}')]  = catEnd;
  40         theCatcode[int('$')]  = catMath;
  41         theCatcode[int('&')]  = catAlign;
  42         theCatcode[int('\n')] = catNewline;
  43         theCatcode[int('#')]  = catParameter;
  44         theCatcode[int('^')]  = catSuper;
  45         theCatcode[int('_')]  = catSub;
  46         theCatcode[0x7f]      = catIgnore;
  47         theCatcode[int(' ')]  = catSpace;
  48         theCatcode[int('\t')] = catSpace;
  49         theCatcode[int('\r')] = catNewline;
  50         theCatcode[int('~')]  = catActive;
  51         theCatcode[int('%')]  = catComment;
  52
  53         // This is wrong!
  54         theCatcode[int('@')]  = catLetter;
  55 }
  56
  57 /*!
  58  * Translate a line ending to '\n'.
  59  * \p c must have catcode catNewline, and it must be the last character read
  60  * from \p is.
  61  */
  62 char_type getNewline(idocstream & is, char_type c)
  63 {
  64         // we have to handle 3 different line endings:
  65         // - UNIX (\n)
  66         // - MAC  (\r)
  67         // - DOS  (\r\n)
  68         if (c == '\r') {
  69                 // MAC or DOS
  70                 char_type wc;
  71                 if (is.get(wc) && wc != '\n') {
  72                         // MAC
  73                         is.putback(wc);
  74                 }
  75                 return '\n';
  76         }
  77         // UNIX
  78         return c;
  79 }
  80
  81 CatCode catcode(char_type c)
  82 {
  83         if (c < 256)
  84                 return theCatcode[(unsigned char)c];
  85         return catOther;
  86 }
  87
  88 }
  89
  90
  91 //
  92 // Token
  93 //
  94
  95 ostream & operator<<(ostream & os, Token const & t)
  96 {
  97         if (t.cat() == catComment)
  98                 os << '%' << t.cs() << '\n';
  99         else if (t.cat() == catSpace)
 100                 os << t.cs();
 101         else if (t.cat() == catEscape)
 102                 os << '\\' << t.cs() << ' ';
 103         else if (t.cat() == catLetter)
 104                 os << t.cs();
 105         else if (t.cat() == catNewline)
 106                 os << "[" << t.cs().size() << "\\n," << t.cat() << "]\n";
 107         else
 108                 os << '[' << t.cs() << ',' << t.cat() << ']';
 109         return os;
 110 }
 111
 112
 113 string Token::asString() const
 114 {
 115         return cs_;
 116 }
 117
 118
 119 string Token::asInput() const
 120 {
 121         if (cat_ == catComment)
 122                 return '%' + cs_ + '\n';
 123         if (cat_ == catEscape)
 124                 return '\\' + cs_;
 125         return cs_;
 126 }
 127
 128
 129 //
 130 // Parser
 131 //
 132
 133
 134 Parser::Parser(idocstream & is)
 135         : lineno_(0), pos_(0), iss_(0), is_(is), encoding_latex_("utf8")
 136 {
 137 }
 138
 139
 140 Parser::Parser(string const & s)
 141         : lineno_(0), pos_(0),
 142           iss_(new idocstringstream(from_utf8(s))), is_(*iss_),
 143           encoding_latex_("utf8")
 144 {
 145 }
 146
 147
 148 Parser::~Parser()
 149 {
 150         delete iss_;
 151 }
 152
 153
 154 void Parser::setEncoding(std::string const & e)
 155 {
 156         Encoding const * enc = encodings.fromLaTeXName(e);
 157         //cerr << "setting encoding to " << enc->iconvName()<<std::endl;
 158         is_ << lyx::setEncoding(enc->iconvName());
 159         encoding_latex_ = e;
 160 }
 161
 162
 163 void Parser::push_back(Token const & t)
 164 {
 165         tokens_.push_back(t);
 166 }
 167
 168
 169 // We return a copy here because the tokens_ vector may get reallocated
 170 Token const Parser::prev_token() const
 171 {
 172         static const Token dummy;
 173         return pos_ > 1 ? tokens_[pos_ - 2] : dummy;
 174 }
 175
 176
 177 // We return a copy here because the tokens_ vector may get reallocated
 178 Token const Parser::curr_token() const
 179 {
 180         static const Token dummy;
 181         return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
 182 }
 183
 184
 185 // We return a copy here because the tokens_ vector may get reallocated
 186 Token const Parser::next_token()
 187 {
 188         static const Token dummy;
 189         return good() ? tokens_[pos_] : dummy;
 190 }
 191
 192
 193 // We return a copy here because the tokens_ vector may get reallocated
 194 Token const Parser::get_token()
 195 {
 196         static const Token dummy;
 197         //cerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << '\n';
 198         return good() ? tokens_[pos_++] : dummy;
 199 }
 200
 201
 202 bool Parser::isParagraph()
 203 {
 204         // A new paragraph in TeX ist started
 205         // - either by a newline, following any amount of whitespace
 206         //   characters (including zero), and another newline
 207         // - or the token \par
 208         if (curr_token().cat() == catNewline &&
 209             (curr_token().cs().size() > 1 ||
 210              (next_token().cat() == catSpace &&
 211               pos_ < tokens_.size() - 1 &&
 212               tokens_[pos_ + 1].cat() == catNewline)))
 213                 return true;
 214         if (curr_token().cat() == catEscape && curr_token().cs() == "par")
 215                 return true;
 216         return false;
 217 }
 218
 219
 220 void Parser::skip_spaces(bool skip_comments)
 221 {
 222         // We just silently return if we have no more tokens.
 223         // skip_spaces() should be callable at any time,
 224         // the caller must check p::good() anyway.
 225         while (good()) {
 226                 get_token();
 227                 if (isParagraph()) {
 228                         putback();
 229                         break;
 230                 }
 231                 if ( curr_token().cat() == catSpace ||
 232                      curr_token().cat() == catNewline ||
 233                     (curr_token().cat() == catComment && curr_token().cs().empty()))
 234                         continue;
 235                 if (skip_comments && curr_token().cat() == catComment)
 236                         cerr << "  Ignoring comment: " << curr_token().asInput();
 237                 else {
 238                         putback();
 239                         break;
 240                 }
 241         }
 242 }
 243
 244
 245 void Parser::unskip_spaces(bool skip_comments)
 246 {
 247         while (pos_ > 0) {
 248                 if ( curr_token().cat() == catSpace ||
 249                     (curr_token().cat() == catNewline && curr_token().cs().size() == 1))
 250                         putback();
 251                 else if (skip_comments && curr_token().cat() == catComment) {
 252                         // TODO: Get rid of this
 253                         cerr << "Unignoring comment: " << curr_token().asInput();
 254                         putback();
 255                 }
 256                 else
 257                         break;
 258         }
 259 }
 260
 261
 262 void Parser::putback()
 263 {
 264         --pos_;
 265 }
 266
 267
 268 bool Parser::good()
 269 {
 270         if (pos_ < tokens_.size())
 271                 return true;
 272         tokenize_one();
 273         return pos_ < tokens_.size();
 274 }
 275
 276
 277 char Parser::getChar()
 278 {
 279         if (!good())
 280                 error("The input stream is not well...");
 281         return get_token().character();
 282 }
 283
 284
 285 Parser::Arg Parser::getFullArg(char left, char right)
 286 {
 287         skip_spaces(true);
 288
 289         // This is needed if a partial file ends with a command without arguments,
 290         // e. g. \medskip
 291         if (! good())
 292                 return make_pair(false, string());
 293
 294         string result;
 295         char c = getChar();
 296
 297         if (c != left) {
 298                 putback();
 299                 return make_pair(false, string());
 300         } else
 301                 while ((c = getChar()) != right && good()) {
 302                         // Ignore comments
 303                         if (curr_token().cat() == catComment) {
 304                                 if (!curr_token().cs().empty())
 305                                         cerr << "Ignoring comment: " << curr_token().asInput();
 306                         }
 307                         else
 308                                 result += curr_token().asInput();
 309                 }
 310
 311         return make_pair(true, result);
 312 }
 313
 314
 315 string Parser::getArg(char left, char right)
 316 {
 317         return getFullArg(left, right).second;
 318 }
 319
 320
 321 string Parser::getFullOpt()
 322 {
 323         Arg arg = getFullArg('[', ']');
 324         if (arg.first)
 325                 return '[' + arg.second + ']';
 326         return string();
 327 }
 328
 329
 330 string Parser::getOpt()
 331 {
 332         string const res = getArg('[', ']');
 333         return res.empty() ? string() : '[' + res + ']';
 334 }
 335
 336
 337 string Parser::getFullParentheseArg()
 338 {
 339         Arg arg = getFullArg('(', ')');
 340         if (arg.first)
 341                 return '(' + arg.second + ')';
 342         return string();
 343 }
 344
 345
 346 string const Parser::verbatimEnvironment(string const & name)
 347 {
 348         if (!good())
 349                 return string();
 350
 351         ostringstream os;
 352         for (Token t = get_token(); good(); t = get_token()) {
 353                 if (t.cat() == catBegin) {
 354                         putback();
 355                         os << '{' << verbatim_item() << '}';
 356                 } else if (t.asInput() == "\\begin") {
 357                         string const env = getArg('{', '}');
 358                         os << "\\begin{" << env << '}'
 359                            << verbatimEnvironment(env)
 360                            << "\\end{" << env << '}';
 361                 } else if (t.asInput() == "\\end") {
 362                         string const end = getArg('{', '}');
 363                         if (end != name)
 364                                 cerr << "\\end{" << end
 365                                      << "} does not match \\begin{" << name
 366                                      << "}." << endl;
 367                         return os.str();
 368                 } else
 369                         os << t.asInput();
 370         }
 371         cerr << "unexpected end of input" << endl;
 372         return os.str();
 373 }
 374
 375
 376 void Parser::tokenize_one()
 377 {
 378         catInit();
 379         char_type c;
 380         if (!is_.get(c))
 381                 return;
 382
 383         switch (catcode(c)) {
 384         case catSpace: {
 385                 docstring s(1, c);
 386                 while (is_.get(c) && catcode(c) == catSpace)
 387                         s += c;
 388                 if (catcode(c) != catSpace)
 389                         is_.putback(c);
 390                 push_back(Token(s, catSpace));
 391                 break;
 392         }
 393
 394         case catNewline: {
 395                 ++lineno_;
 396                 docstring s(1, getNewline(is_, c));
 397                 while (is_.get(c) && catcode(c) == catNewline) {
 398                         ++lineno_;
 399                         s += getNewline(is_, c);
 400                 }
 401                 if (catcode(c) != catNewline)
 402                         is_.putback(c);
 403                 push_back(Token(s, catNewline));
 404                 break;
 405         }
 406
 407         case catComment: {
 408                 // We don't treat "%\n" combinations here specially because
 409                 // we want to preserve them in the preamble
 410                 docstring s;
 411                 while (is_.get(c) && catcode(c) != catNewline)
 412                         s += c;
 413                 // handle possible DOS line ending
 414                 if (catcode(c) == catNewline)
 415                         c = getNewline(is_, c);
 416                 // Note: The '%' at the beginning and the '\n' at the end
 417                 // of the comment are not stored.
 418                 ++lineno_;
 419                 push_back(Token(s, catComment));
 420                 break;
 421         }
 422
 423         case catEscape: {
 424                 is_.get(c);
 425                 if (!is_) {
 426                         error("unexpected end of input");
 427                 } else {
 428                         docstring s(1, c);
 429                         if (catcode(c) == catLetter) {
 430                                 // collect letters
 431                                 while (is_.get(c) && catcode(c) == catLetter)
 432                                         s += c;
 433                                 if (catcode(c) != catLetter)
 434                                         is_.putback(c);
 435                         }
 436                         push_back(Token(s, catEscape));
 437                 }
 438                 break;
 439         }
 440
 441         case catIgnore: {
 442                 cerr << "ignoring a char: " << c << "\n";
 443                 break;
 444         }
 445
 446         default:
 447                 push_back(Token(docstring(1, c), catcode(c)));
 448         }
 449         //cerr << tokens_.back();
 450 }
 451
 452
 453 void Parser::dump() const
 454 {
 455         cerr << "\nTokens: ";
 456         for (unsigned i = 0; i < tokens_.size(); ++i) {
 457                 if (i == pos_)
 458                         cerr << " <#> ";
 459                 cerr << tokens_[i];
 460         }
 461         cerr << " pos: " << pos_ << "\n";
 462 }
 463
 464
 465 void Parser::error(string const & msg)
 466 {
 467         cerr << "Line ~" << lineno_ << ":  parse error: " << msg << endl;
 468         dump();
 469         //exit(1);
 470 }
 471
 472
 473 string Parser::verbatimOption()
 474 {
 475         string res;
 476         if (next_token().character() == '[') {
 477                 Token t = get_token();
 478                 for (t = get_token(); t.character() != ']' && good(); t = get_token()) {
 479                         if (t.cat() == catBegin) {
 480                                 putback();
 481                                 res += '{' + verbatim_item() + '}';
 482                         } else
 483                                 res += t.asString();
 484                 }
 485         }
 486         return res;
 487 }
 488
 489
 490 string Parser::verbatim_item()
 491 {
 492         if (!good())
 493                 error("stream bad");
 494         skip_spaces();
 495         if (next_token().cat() == catBegin) {
 496                 Token t = get_token(); // skip brace
 497                 string res;
 498                 for (Token t = get_token(); t.cat() != catEnd && good(); t = get_token()) {
 499                         if (t.cat() == catBegin) {
 500                                 putback();
 501                                 res += '{' + verbatim_item() + '}';
 502                         }
 503                         else
 504                                 res += t.asInput();
 505                 }
 506                 return res;
 507         }
 508         return get_token().asInput();
 509 }
 510
 511
 512 void Parser::reset()
 513 {
 514         pos_ = 0;
 515 }
 516
 517
 518 void Parser::setCatCode(char c, CatCode cat)
 519 {
 520         theCatcode[(unsigned char)c] = cat;
 521 }
 522
 523
 524 CatCode Parser::getCatCode(char c) const
 525 {
 526         return theCatcode[(unsigned char)c];
 527 }
 528
 529
 530 } // namespace lyx