]> git.lyx.org Git - lyx.git/blobdiff - src/OutputParams.h
Fix commented out code
[lyx.git] / src / OutputParams.h
index d3c2921b4654c89e11ffdfd1c4a327a92444ed99..5aa6080de7f0b96fed97fd527661de1eca55958a 100644 (file)
 #define OUTPUTPARAMS_H
 
 
-#include "support/shared_ptr.h"
 #include "Changes.h"
 
+#include <memory>
+
 
 namespace lyx {
 
@@ -38,7 +39,7 @@ public:
                TEXT,
                LYX
        };
-       
+
        enum MathFlavor {
                NotApplicable,
                MathAsMathML,
@@ -59,6 +60,14 @@ public:
                SUBFLOAT
        };
 
+       enum CtObject {
+               CT_NORMAL,
+               CT_OBJECT,
+               CT_DISPLAYOBJECT,
+               CT_UDISPLAYOBJECT,
+               CT_OMITOBJECT
+       };
+
        OutputParams(Encoding const *);
        ~OutputParams();
 
@@ -70,17 +79,27 @@ public:
        bool isLaTeX() const;
        /// does this flavour support full unicode?
        bool isFullUnicode() const;
-       
+       /// Do we use the bidi package (which does some reordering and stuff)?
+       bool useBidiPackage() 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.
@@ -93,13 +112,18 @@ public:
        */
        bool intitle;
 
-       /** inulemcmd == true means that the environment in which the
-           inset is typeset is part of a ulem command (\uline, \uuline,
-           \uwave, or \sout). Insets that output latex commands relying
-           on local assignments (such as \cite) should enclose such
+       /** 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 or soul command (e.g., \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 bool inulemcmd;
+       mutable int inulemcmd;
 
        /** the font at the point where the inset is
         */
@@ -107,12 +131,20 @@ public:
 
        /** Document language babel name
         */
-       mutable std::string document_language;
+       std::string document_language;
+
+       /// main font encoding of the document
+       std::string main_fontenc;
 
        /** 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;
 
+       /// Active characters
+       std::string active_chars;
+
        /** Current stream encoding. Only used for LaTeX.
            This must be set to the document encoding (via the constructor)
            before output starts. Afterwards it must be kept up to date for
@@ -145,6 +177,13 @@ public:
        */
        bool use_polyglossia;
 
+       /** Do we use hyperref?
+       */
+       bool use_hyperref;
+
+       /// Do we use the CJK package?
+       bool use_CJK;
+
        /** Are we generating multiple indices?
        */
        bool use_indices;
@@ -155,11 +194,18 @@ public:
 
        /** Customized bibtex_command
        */
-       mutable std::string bibtex_command;
+       std::string bibtex_command;
 
        /** Customized index_command
        */
-       mutable std::string index_command;
+       std::string index_command;
+
+       /// The Xindy language module
+       std::string xindy_language;
+
+       /** Hyperref driver
+       */
+       std::string hyperref_driver;
 
        /** Line length to use with plaintext or LaTeX export.
        */
@@ -174,7 +220,30 @@ public:
            This is a hack: Make it possible to add stuff to constant
            OutputParams instances.
        */
-       shared_ptr<ExportData> exportdata;
+       std::shared_ptr<ExportData> exportdata;
+
+       /** Store labels, index entries (etc.) (in \ref post_macro)
+        *  and output them later. This is used in particular to get
+        *  labels and index entries (and potentially other fragile commands)
+        *  outside of moving arguments (bug 2154)
+        */
+       bool postpone_fragile_stuff;
+
+       /** Stuff to be postponed and output after the current macro
+        *  (if \ref postpone_fragile_stuff is true). Used for labels and index
+        *  entries in commands with moving arguments (\\section, \\caption etc.)
+        */
+       mutable docstring post_macro;
+
+       /** 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
@@ -184,6 +253,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.
          */
@@ -206,14 +284,19 @@ public:
 
        /** Whether we are inside an inset that is logically deleted.
         *  A value > 0 indicates a deleted inset.
-         */
+       */
        int inDeletedInset;
 
        /** The change information of the outermost logically deleted inset.
         *  changeOfDeletedInset shall only be evaluated if inDeletedInset > 0.
-         */ 
+       */
        Change changeOfDeletedInset;
 
+       /** What kind of change tracking object is this?
+        * Relevant for strikeout method in output
+        */
+       mutable CtObject ctObject;
+
        /** allow output of only part of the top-level paragraphs
         *  par_begin: beginning paragraph
         */
@@ -229,32 +312,50 @@ public:
        mutable int lastid;
 
        /// Last position in the last paragraph before an inset
-       mutable int lastpos;
+       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 pass_thru;
-       
+
+       /// Should we output verbatim specific chars?
+       docstring pass_thru_chars;
+
+       /// A specific newline macro
+       std::string newlinecmd;
+
        /// 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;