X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FOutputParams.h;h=56e698c873ea0bc5160c04098fae0331ae0a215f;hb=c7d29be153debac82e3d2e8865fcc849f0a5f40d;hp=00a1e11030e896b973a35a4ddc372b82a91f0fdd;hpb=1f58d53deb3ace7b9df0b3202bda3ef006249777;p=lyx.git diff --git a/src/OutputParams.h b/src/OutputParams.h index 00a1e11030..56e698c873 100644 --- a/src/OutputParams.h +++ b/src/OutputParams.h @@ -12,12 +12,11 @@ #ifndef OUTPUTPARAMS_H #define OUTPUTPARAMS_H -#include -#include "support/types.h" -#include #include "Changes.h" +#include + namespace lyx { @@ -25,14 +24,28 @@ namespace lyx { class Encoding; class ExportData; class Font; - +class Language; class OutputParams { public: enum FLAVOR { + DVILUATEX, LATEX, + LUATEX, PDFLATEX, - XML + XETEX, + XML, + HTML, + TEXT, + LYX + }; + + enum MathFlavor { + NotApplicable, + MathAsMathML, + MathAsHTML, + MathAsImages, + MathAsLaTeX }; enum TableCell { @@ -50,18 +63,33 @@ public: OutputParams(Encoding const *); ~OutputParams(); - /** The latex that we export depends occasionally on what is to + /** The file that we export depends occasionally on what is to compile the file. */ FLAVOR flavor; + /// is it some flavor of LaTeX? + bool isLaTeX() const; + /// does this flavour support full unicode? + bool isFullUnicode() const; + + /// Same, but for math output, which only matter is XHTML output. + MathFlavor math_flavor; /** Are we to write a 'nice' LaTeX file or not. This esentially seems to mean whether InsetInclude, InsetGraphics and InsetExternal should add the absolute path to any external files or not. + Non-nice LaTeX also includes additional safe line breaks in order to + increase the precision of forward/reverse search and error reporting. */ bool nice; + /** Is this a real child (i.e., compiled as a child)? + This depends on wherefrom we export the buffer. Even children + that have a master can be compiled standalone. + */ + mutable bool is_child; + /** moving_arg == true means that the environment in which the inset is typeset is a moving argument. The inset should take care about fragile commands by preceding the latex with \\protect. @@ -74,13 +102,41 @@ public: */ bool intitle; + /** need_maketitle == true means that the last layout was a title layout + * this is to track when \maketitle needs to be output. + */ + mutable bool need_maketitle; + + /** have_maketitle == true means that \maketitle already hase been output. + */ + mutable bool have_maketitle; + + /** inbranch == true means that the environment being typeset + is inside an active branch inset. + */ + bool inbranch; + + /** inulemcmd > 0 means that the environment in which the + inset is typeset is part of a ulem command (\uline, \uuline, + \uwave, \sout or \xout). Insets that output latex commands relying + on local assignments (such as \cite) should enclose such + commands in \mbox{} in order to avoid breakage. + */ + mutable int inulemcmd; + /** the font at the point where the inset is */ Font const * local_font; /** Document language babel name */ - mutable std::string document_language; + std::string document_language; + + /** The master language. Non-null only for child documents. + Note that this is not the language of the top level master, but + of the direct parent for nested includes. + */ + mutable Language const * master_language; /** Current stream encoding. Only used for LaTeX. This must be set to the document encoding (via the constructor) @@ -110,11 +166,35 @@ public: */ bool use_babel; + /** Do we use polyglossia (instead of babel)? + */ + bool use_polyglossia; + + /** Do we use hyperref? + */ + bool use_hyperref; + + /** Are we generating multiple indices? + */ + bool use_indices; + /** Are we using japanese (pLaTeX)? */ bool use_japanese; - /** Line length to use with plaintext export. + /** Customized bibtex_command + */ + std::string bibtex_command; + + /** Customized index_command + */ + std::string index_command; + + /** Hyperref driver + */ + std::string hyperref_driver; + + /** Line length to use with plaintext or LaTeX export. */ size_type linelen; @@ -127,7 +207,17 @@ public: This is a hack: Make it possible to add stuff to constant OutputParams instances. */ - boost::shared_ptr exportdata; + std::shared_ptr exportdata; + + /** Whether we are entering a display math inset. + * Needed to correctly strike out deleted math in change tracking. + */ + mutable bool inDisplayMath; + + /** Whether we are leaving a display math inset. + * Needed to correctly track nested ulem commands in change tracking. + */ + mutable bool wasDisplayMath; /** Whether we are inside a comment inset. Insets that are including * external files like InsetGraphics, InsetInclude and InsetExternal @@ -137,6 +227,15 @@ public: */ bool inComment; + /** Whether a btUnit (for multiple biblographies) is open. + */ + mutable bool openbtUnit; + + /** Process only the children's aux files with BibTeX. + * This is necessary with chapterbib. + */ + bool only_childbibs; + /** Whether we are in a table cell. * For newline, it matters whether its content is aligned or not. */ @@ -147,6 +246,16 @@ public: */ Float inFloat; + /** Whether we are inside an index inset. + * ERT needs to know this, due to the active chars. + */ + bool inIndexEntry; + + /** Whether we are inside an IPA inset. + * Needed for proper IPA output. + */ + bool inIPA; + /** Whether we are inside an inset that is logically deleted. * A value > 0 indicates a deleted inset. */ @@ -154,29 +263,70 @@ public: /** The change information of the outermost logically deleted inset. * changeOfDeletedInset shall only be evaluated if inDeletedInset > 0. - */ + */ Change changeOfDeletedInset; /** allow output of only part of the top-level paragraphs * par_begin: beginning paragraph */ - pit_type par_begin; + mutable pit_type par_begin; /** allow output of only part of the top-level paragraphs * par_end: par_end-1 is the ending paragraph * if par_begin=par_end, output all paragraphs */ - pit_type par_end; + mutable pit_type par_end; + + /// Id of the last paragraph before an inset + mutable int lastid; + + /// Last position in the last paragraph before an inset + mutable pos_type lastpos; /// is this the last paragraph in the current buffer/inset? bool isLastPar; - /** whether or not do actual file copying and image conversion + + /** whether or not to do actual file copying and image conversion * This mode will be used to preview the source code */ bool dryrun; + + /// whether to display output errors or not + bool silent; + /// Should we output verbatim or escape LaTeX's special chars? - bool verbatim; + bool pass_thru; + + /// Should we output verbatim specific chars? + docstring pass_thru_chars; + + /// Should we output captions? + bool html_disable_captions; + + /// Are we already in a paragraph? + bool html_in_par; + + /// Does the present context even permit paragraphs? + bool html_make_pars; + + /// Are we generating this material for inclusion in a TOC-like entity? + bool for_toc; + + /// Are we generating this material for inclusion in a tooltip? + bool for_tooltip; + + /// Are we generating this material for use by advanced search? + bool for_search; + + /// Are we generating this material for instant preview? + bool for_preview; + + /// Include all children notwithstanding the use of \includeonly + bool includeall; + + /// Explicit output folder, if any is desired + std::string export_folder; };