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