src/mathed/MathStream.h

   1 // -*- C++ -*-
   2 /**
   3  * \file MathStream.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef MATH_MATHMLSTREAM_H
  13 #define MATH_MATHMLSTREAM_H
  14
  15 #include "InsetMath.h"
  16
  17 #include "TexRow.h"
  18 #include "texstream.h"
  19
  20 #include "support/Changer.h"
  21 #include "support/strfwd.h"
  22
  23
  24 namespace lyx {
  25
  26 class Encoding;
  27 class MathAtom;
  28 class MathData;
  29
  30 //
  31 // LaTeX/LyX
  32 //
  33
  34 class TeXMathStream {
  35 public:
  36         ///
  37         enum OutputType {
  38                 wsDefault,
  39                 wsDryrun,
  40                 wsPreview
  41         };
  42         ///
  43         enum UlemCmdType {
  44                 NONE,
  45                 UNDERLINE,
  46                 STRIKEOUT
  47         };
  48         ///
  49         explicit TeXMathStream(otexrowstream & os, bool fragile = false,
  50                                bool latex = false, OutputType output = wsDefault,
  51                                Encoding const * encoding = nullptr);
  52         ///
  53         ~TeXMathStream();
  54         ///
  55         int line() const { return line_; }
  56         ///
  57         bool fragile() const { return fragile_; }
  58         ///
  59         bool latex() const { return latex_; }
  60         ///
  61         OutputType output() const { return output_; }
  62         ///
  63         otexrowstream & os() { return os_; }
  64         ///
  65         TexRow & texrow() { return os_.texrow(); }
  66         ///
  67         bool & firstitem() { return firstitem_; }
  68         ///
  69         void addlines(unsigned int);
  70         /// record whether we can write an immediately following newline char
  71         void canBreakLine(bool breakline) { canbreakline_ = breakline; }
  72         /// tell whether we can write an immediately following newline char
  73         bool canBreakLine() const { return canbreakline_; }
  74         /// record whether we have to take care for striking out display math
  75         void strikeoutMath(bool mathsout) { mathsout_ = mathsout; }
  76         /// tell whether we have to take care for striking out display math
  77         bool strikeoutMath() const { return mathsout_; }
  78         /// record which ulem command type we are inside
  79         void ulemCmd(UlemCmdType ulemcmd) { ulemcmd_ = ulemcmd; }
  80         /// tell which ulem command type we are inside
  81         UlemCmdType ulemCmd() const { return ulemcmd_; }
  82         /// writes space if next thing is isalpha()
  83         void pendingSpace(bool how);
  84         /// writes space if next thing is isalpha()
  85         bool pendingSpace() const { return pendingspace_; }
  86         /// tell whether to write the closing brace of \ensuremath
  87         void pendingBrace(bool brace);
  88         /// tell whether to write the closing brace of \ensuremath
  89         bool pendingBrace() const { return pendingbrace_; }
  90         /// tell whether we are in text mode or not when producing latex code
  91         void textMode(bool textmode);
  92         /// tell whether we are in text mode or not when producing latex code
  93         bool textMode() const { return textmode_; }
  94         /// tell whether we are allowed to switch mode when producing latex code
  95         void lockedMode(bool locked);
  96         /// tell whether we are allowed to switch mode when producing latex code
  97         bool lockedMode() const { return locked_; }
  98         /// tell whether to use only ascii chars when producing latex code
  99         void asciiOnly(bool ascii);
 100         /// tell whether to use only ascii chars when producing latex code
 101         bool asciiOnly() const { return ascii_; }
 102         /// tell whether we are in a MathClass inset
 103         void inMathClass(bool mathclass) { mathclass_ = mathclass; };
 104         /// tell whether we are in a MathClass inset
 105         bool inMathClass() const { return mathclass_; }
 106         /// LaTeX encoding
 107         Encoding const * encoding() const { return encoding_; }
 108
 109         /// Temporarily change the TexRow information about the outer row entry.
 110         Changer changeRowEntry(TexRow::RowEntry entry);
 111         /// TexRow::starts the innermost outer math inset
 112         /// returns true if the outer row entry will appear at this line
 113         bool startOuterRow();
 114 private:
 115         ///
 116         otexrowstream & os_;
 117         /// do we have to write \\protect sometimes
 118         bool fragile_ = false;
 119         /// are we at the beginning of an MathData?
 120         bool firstitem_ = false;
 121         /// are we writing to .tex?
 122         int latex_ = false;
 123         /// output type (default, source preview, instant preview)?
 124         OutputType output_ = wsDefault;
 125         /// do we have a space pending?
 126         bool pendingspace_ = false;
 127         /// do we have a brace pending?
 128         bool pendingbrace_ = false;
 129         /// are we in text mode when producing latex code?
 130         bool textmode_ = false;
 131         /// are we allowed to switch mode when producing latex code?
 132         bool locked_ = false;
 133         /// should we use only ascii chars when producing latex code?
 134         bool ascii_ = false;
 135         /// are we allowed to output an immediately following newline?
 136         bool canbreakline_ = true;
 137         /// should we take care for striking out display math?
 138         bool mathsout_ = false;
 139         /// what ulem command are we inside (none, underline, strikeout)?
 140         UlemCmdType ulemcmd_ = NONE;
 141         ///
 142         int line_ = 0;
 143         ///
 144         Encoding const * encoding_ = nullptr;
 145         /// Row entry we are in
 146         TexRow::RowEntry row_entry_ = TexRow::row_none;
 147         /// whether we are in a MathClass inset
 148         bool mathclass_ = false;
 149 };
 150
 151 ///
 152 TeXMathStream & operator<<(TeXMathStream &, MathAtom const &);
 153 ///
 154 TeXMathStream & operator<<(TeXMathStream &, MathData const &);
 155 ///
 156 TeXMathStream & operator<<(TeXMathStream &, docstring const &);
 157 ///
 158 TeXMathStream & operator<<(TeXMathStream &, char const * const);
 159 ///
 160 TeXMathStream & operator<<(TeXMathStream &, char);
 161 ///
 162 TeXMathStream & operator<<(TeXMathStream &, int);
 163 ///
 164 TeXMathStream & operator<<(TeXMathStream &, unsigned int);
 165
 166 /// ensure correct mode, possibly by opening \ensuremath or \lyxmathsym
 167 bool ensureMath(TeXMathStream & os, bool needs_mathmode = true,
 168                 bool macro = false, bool textmode_macro = false);
 169
 170 /// ensure the requested mode, possibly by closing \ensuremath or \lyxmathsym
 171 int ensureMode(TeXMathStream & os, InsetMath::mode_type mode, bool locked, bool ascii);
 172
 173
 174 /**
 175  * MathEnsurer - utility class for ensuring math mode
 176  *
 177  * A local variable of this type can be used to either ensure math mode
 178  * or delay the writing of a pending brace when outputting LaTeX.
 179  * A LyX InsetMathMacro is always assumed needing a math mode environment, while
 180  * no assumption is made for macros defined through \newcommand or \def.
 181  *
 182  * Example 1:
 183  *
 184  *      MathEnsurer ensurer(os);
 185  *
 186  * If not already in math mode, inserts an \ensuremath command followed
 187  * by an open brace. This brace will be automatically closed when exiting
 188  * math mode. Math mode is automatically exited when writing something
 189  * that doesn't explicitly require math mode.
 190  *
 191  * Example 2:
 192  *
 193  *      MathEnsurer ensurer(os, false);
 194  *
 195  * Simply suspend writing a closing brace until the end of ensurer's scope.
 196  *
 197  * Example 3:
 198  *
 199  *      MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
 200  *
 201  * This form is mainly used for math macros as they are treated specially.
 202  * In essence, the macros defined in the lib/symbols file and tagged as
 203  * textmode will be enclosed in \lyxmathsym if they appear in a math mode
 204  * environment, while macros defined in the preamble or ERT are left as is.
 205  * The third parameter must be set to true and the fourth parameter has also
 206  * to be specified. Only the following 3 different cases are handled.
 207  *
 208  * When the needs_mathmode parameter is true the behavior is as in Example 1.
 209  * This is the case for a LyX InsetMathMacro or a macro not tagged as textmode.
 210  *
 211  * When the needs_mathmode and textmode_macro parameters are both false the
 212  * macro is left in the same (text or math mode) environment it was entered.
 213  * This is because it is assumed that the macro was designed for that mode
 214  * and we have no way to tell the contrary.
 215  * This is the case for macros defined by using \newcommand or \def in ERT.
 216  *
 217  * When the needs_mathmode parameter is false while textmode_macro is true the
 218  * macro will be enclosed in \lyxmathsym if it appears in a math mode environment.
 219  * This is the case for the macros tagged as textmode in lib/symbols.
 220  */
 221 class MathEnsurer
 222 {
 223 public:
 224         ///
 225         explicit MathEnsurer(TeXMathStream & os, bool needs_mathmode = true,
 226                              bool macro = false, bool textmode_macro = false)
 227                 : os_(os), brace_(ensureMath(os, needs_mathmode, macro, textmode_macro)) {}
 228         ///
 229         ~MathEnsurer() { os_.pendingBrace(brace_); }
 230 private:
 231         ///
 232         TeXMathStream & os_;
 233         ///
 234         bool brace_;
 235 };
 236
 237
 238 /**
 239  * ModeSpecifier - utility class for specifying a given mode (math or text)
 240  *
 241  * A local variable of this type can be used to specify that a command or
 242  * environment works in a given mode. For example, \mbox works in text
 243  * mode, but \boxed works in math mode. Note that no mode changing commands
 244  * are needed, but we have to track the current mode, hence this class.
 245  * This is only used when exporting to latex and helps determining whether
 246  * the mode needs being temporarily switched when a command would not work
 247  * in the current mode. As there are cases where this switching is to be
 248  * avoided, the optional third parameter can be used to lock the mode.
 249  * When the mode is locked, the optional fourth parameter specifies whether
 250  * strings are to be output by using a suitable ascii representation.
 251  *
 252  * Example 1:
 253  *
 254  *      ModeSpecifier specifier(os, TEXT_MODE);
 255  *
 256  * Sets the current mode to text mode and allows mode switching.
 257  *
 258  * Example 2:
 259  *
 260  *      ModeSpecifier specifier(os, TEXT_MODE, true);
 261  *
 262  * Sets the current mode to text mode and disallows mode switching.
 263  *
 264  * Example 3:
 265  *
 266  *      ModeSpecifier specifier(os, TEXT_MODE, true, true);
 267  *
 268  * Sets the current mode to text mode, disallows mode switching, and outputs
 269  * strings as ascii only.
 270  *
 271  * At the end of specifier's scope the mode is reset to its previous value.
 272  */
 273 class ModeSpecifier
 274 {
 275 public:
 276         ///
 277         explicit ModeSpecifier(TeXMathStream & os, InsetMath::mode_type mode,
 278                                bool locked = false, bool ascii = false)
 279                 : os_(os), oldmodes_(ensureMode(os, mode, locked, ascii)) {}
 280         ///
 281         ~ModeSpecifier()
 282         {
 283                 os_.textMode(oldmodes_ & 0x01);
 284                 os_.lockedMode(oldmodes_ & 0x02);
 285                 os_.asciiOnly(oldmodes_ & 0x04);
 286         }
 287 private:
 288         ///
 289         TeXMathStream & os_;
 290         ///
 291         int oldmodes_;
 292 };
 293
 294
 295
 296 //
 297 //  MathML
 298 //
 299
 300
 301 /// Start tag.
 302 class MTag {
 303 public:
 304         ///
 305         MTag(char const * const tag, std::string const & attr = std::string())
 306                 : tag_(tag), attr_(attr) {}
 307         ///
 308         char const * const tag_;
 309         ///
 310         std::string attr_;
 311 };
 312
 313
 314 /// End tag.
 315 class ETag {
 316 public:
 317         ///
 318         explicit ETag(char const * const tag) : tag_(tag) {}
 319         ///
 320         char const * const tag_;
 321 };
 322
 323
 324 /// Compound tag (no content, directly closed).
 325 class CTag {
 326 public:
 327         ///
 328         CTag(char const * const tag, std::string const & attr = "")
 329             : tag_(tag), attr_(attr) {}
 330         ///
 331         char const * const tag_;
 332     ///
 333     std::string attr_;
 334 };
 335
 336
 337 /// Throw MathExportException to signal that the attempt to export
 338 /// some math in the current format did not succeed. E.g., we can't
 339 /// export xymatrix as MathML, so that will throw, and we'll fall back
 340 /// to images.
 341 class MathExportException : public std::exception {};
 342
 343
 344 class MathMLStream {
 345 public:
 346         /// Builds a stream proxy for os; the MathML namespace is given by xmlns (supposed to be already defined elsewhere in the document).
 347         explicit MathMLStream(odocstream & os, std::string const & xmlns = "", bool xmlMode = false);
 348         ///
 349         void cr();
 350         ///
 351         odocstream & os() { return os_; }
 352         ///
 353         int line() const { return line_; }
 354         ///
 355         int & tab() { return tab_; }
 356         ///
 357         friend MathMLStream & operator<<(MathMLStream &, char const *);
 358         ///
 359         void defer(docstring const &);
 360         ///
 361         void defer(std::string const &);
 362         ///
 363         docstring deferred() const;
 364         ///
 365         bool inText() const { return in_text_; }
 366         ///
 367         std::string xmlns() const { return xmlns_; }
 368         ///
 369         bool xmlMode() const { return xml_mode_; }
 370         /// Returns the tag name prefixed by the name space if needed.
 371         std::string namespacedTag(std::string const & tag) const {
 372                 return (xmlns().empty() ? "" : xmlns() + ":") + tag;
 373         }
 374 private:
 375         ///
 376         void setTextMode(bool t) { in_text_ = t; }
 377         ///
 378         odocstream & os_;
 379         ///
 380         int tab_;
 381         ///
 382         int line_;
 383         ///
 384         bool in_text_;
 385         ///
 386         odocstringstream deferred_;
 387         ///
 388         std::string xmlns_;
 389         ///
 390         bool xml_mode_;
 391         ///
 392         friend class SetMode;
 393 };
 394
 395 ///
 396 MathMLStream & operator<<(MathMLStream &, MathAtom const &);
 397 ///
 398 MathMLStream & operator<<(MathMLStream &, MathData const &);
 399 ///
 400 MathMLStream & operator<<(MathMLStream &, docstring const &);
 401 ///
 402 MathMLStream & operator<<(MathMLStream &, char const *);
 403 ///
 404 MathMLStream & operator<<(MathMLStream &, char);
 405 ///
 406 MathMLStream & operator<<(MathMLStream &, char_type);
 407 ///
 408 MathMLStream & operator<<(MathMLStream &, MTag const &);
 409 ///
 410 MathMLStream & operator<<(MathMLStream &, ETag const &);
 411 ///
 412 MathMLStream & operator<<(MathMLStream &, CTag const &);
 413
 414
 415 /// A simpler version of ModeSpecifier, for MathML
 416 class SetMode {
 417 public:
 418         ///
 419         explicit SetMode(MathMLStream & ms, bool text);
 420         ///
 421         ~SetMode();
 422 private:
 423         ///
 424         MathMLStream & ms_;
 425         ///
 426         bool was_text_;
 427 };
 428
 429
 430 class HtmlStream {
 431 public:
 432         ///
 433         explicit HtmlStream(odocstream & os);
 434         ///
 435         void cr();
 436         ///
 437         odocstream & os() { return os_; }
 438         ///
 439         int line() const { return line_; }
 440         ///
 441         int & tab() { return tab_; }
 442         ///
 443         friend HtmlStream & operator<<(HtmlStream &, char const *);
 444         ///
 445         void defer(docstring const &);
 446         ///
 447         void defer(std::string const &);
 448         ///
 449         docstring deferred() const;
 450         ///
 451         bool inText() const { return in_text_; }
 452 private:
 453         ///
 454         void setTextMode(bool t) { in_text_ = t; }
 455         ///
 456         odocstream & os_;
 457         ///
 458         int tab_;
 459         ///
 460         int line_;
 461         ///
 462         bool in_text_;
 463         ///
 464         odocstringstream deferred_;
 465         ///
 466         friend class SetHTMLMode;
 467 };
 468
 469 ///
 470 HtmlStream & operator<<(HtmlStream &, MathAtom const &);
 471 ///
 472 HtmlStream & operator<<(HtmlStream &, MathData const &);
 473 ///
 474 HtmlStream & operator<<(HtmlStream &, docstring const &);
 475 ///
 476 HtmlStream & operator<<(HtmlStream &, char const *);
 477 ///
 478 HtmlStream & operator<<(HtmlStream &, char);
 479 ///
 480 HtmlStream & operator<<(HtmlStream &, char_type);
 481 ///
 482 HtmlStream & operator<<(HtmlStream &, MTag const &);
 483 ///
 484 HtmlStream & operator<<(HtmlStream &, ETag const &);
 485
 486
 487 class SetHTMLMode {
 488 public:
 489         ///
 490         explicit SetHTMLMode(HtmlStream & os, bool text);
 491         ///
 492         ~SetHTMLMode();
 493 private:
 494         ///
 495         HtmlStream & os_;
 496         ///
 497         bool was_text_;
 498 };
 499
 500
 501 //
 502 // Debugging
 503 //
 504
 505 class NormalStream {
 506 public:
 507         ///
 508         explicit NormalStream(odocstream & os) : os_(os) {}
 509         ///
 510         odocstream & os() { return os_; }
 511 private:
 512         ///
 513         odocstream & os_;
 514 };
 515
 516 ///
 517 NormalStream & operator<<(NormalStream &, MathAtom const &);
 518 ///
 519 NormalStream & operator<<(NormalStream &, MathData const &);
 520 ///
 521 NormalStream & operator<<(NormalStream &, docstring const &);
 522 ///
 523 NormalStream & operator<<(NormalStream &, char const *);
 524 ///
 525 NormalStream & operator<<(NormalStream &, char);
 526 ///
 527 NormalStream & operator<<(NormalStream &, int);
 528
 529
 530 //
 531 // Maple
 532 //
 533
 534
 535 class MapleStream {
 536 public:
 537         ///
 538         explicit MapleStream(odocstream & os) : os_(os) {}
 539         ///
 540         odocstream & os() { return os_; }
 541 private:
 542         ///
 543         odocstream & os_;
 544 };
 545
 546
 547 ///
 548 MapleStream & operator<<(MapleStream &, MathAtom const &);
 549 ///
 550 MapleStream & operator<<(MapleStream &, MathData const &);
 551 ///
 552 MapleStream & operator<<(MapleStream &, docstring const &);
 553 ///
 554 MapleStream & operator<<(MapleStream &, char_type);
 555 ///
 556 MapleStream & operator<<(MapleStream &, char const *);
 557 ///
 558 MapleStream & operator<<(MapleStream &, char);
 559 ///
 560 MapleStream & operator<<(MapleStream &, int);
 561
 562
 563 //
 564 // Maxima
 565 //
 566
 567
 568 class MaximaStream {
 569 public:
 570         ///
 571         explicit MaximaStream(odocstream & os) : os_(os) {}
 572         ///
 573         odocstream & os() { return os_; }
 574 private:
 575         ///
 576         odocstream & os_;
 577 };
 578
 579
 580 ///
 581 MaximaStream & operator<<(MaximaStream &, MathAtom const &);
 582 ///
 583 MaximaStream & operator<<(MaximaStream &, MathData const &);
 584 ///
 585 MaximaStream & operator<<(MaximaStream &, docstring const &);
 586 ///
 587 MaximaStream & operator<<(MaximaStream &, char_type);
 588 ///
 589 MaximaStream & operator<<(MaximaStream &, char const *);
 590 ///
 591 MaximaStream & operator<<(MaximaStream &, char);
 592 ///
 593 MaximaStream & operator<<(MaximaStream &, int);
 594
 595
 596 //
 597 // Mathematica
 598 //
 599
 600
 601 class MathematicaStream {
 602 public:
 603         ///
 604         explicit MathematicaStream(odocstream & os) : os_(os) {}
 605         ///
 606         odocstream & os() { return os_; }
 607 private:
 608         ///
 609         odocstream & os_;
 610 };
 611
 612
 613 ///
 614 MathematicaStream & operator<<(MathematicaStream &, MathAtom const &);
 615 ///
 616 MathematicaStream & operator<<(MathematicaStream &, MathData const &);
 617 ///
 618 MathematicaStream & operator<<(MathematicaStream &, docstring const &);
 619 ///
 620 MathematicaStream & operator<<(MathematicaStream &, char const *);
 621 ///
 622 MathematicaStream & operator<<(MathematicaStream &, char);
 623 ///
 624 MathematicaStream & operator<<(MathematicaStream &, int);
 625
 626
 627 //
 628 // Octave
 629 //
 630
 631
 632 class OctaveStream {
 633 public:
 634         ///
 635         explicit OctaveStream(odocstream & os) : os_(os) {}
 636         ///
 637         odocstream & os() { return os_; }
 638 private:
 639         ///
 640         odocstream & os_;
 641 };
 642
 643 ///
 644 OctaveStream & operator<<(OctaveStream &, MathAtom const &);
 645 ///
 646 OctaveStream & operator<<(OctaveStream &, MathData const &);
 647 ///
 648 OctaveStream & operator<<(OctaveStream &, docstring const &);
 649 ///
 650 OctaveStream & operator<<(OctaveStream &, char_type);
 651 ///
 652 OctaveStream & operator<<(OctaveStream &, char const *);
 653 ///
 654 OctaveStream & operator<<(OctaveStream &, char);
 655 ///
 656 OctaveStream & operator<<(OctaveStream &, int);
 657
 658
 659 docstring convertDelimToXMLEscape(docstring const & name, bool xmlmode);
 660
 661 } // namespace lyx
 662
 663 #endif