src/tex2lyx/tex2lyx.h

   1 // -*- C++ -*-
   2 /**
   3  * \file tex2lyx.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  * \author Jean-Marc Lasgouttes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef TEX2LYX_H
  14 #define TEX2LYX_H
  15
  16 #include "Parser.h"
  17 #include "TextClass.h"
  18
  19 #include <iosfwd>
  20 #include <string>
  21 #include <vector>
  22 #include <map>
  23
  24
  25 namespace lyx {
  26
  27 namespace support { class FileName; }
  28
  29 /// Simple support for frontend::Alert::warning().
  30 namespace frontend {
  31 namespace Alert {
  32         void warning(docstring const & title, docstring const & message,
  33                                  bool const &);
  34 }
  35 }
  36
  37 class Context;
  38
  39 /// A trivial subclass, just to give us a public default constructor
  40 class TeX2LyXDocClass : public DocumentClass
  41 {
  42 public:
  43         void setName(std::string const & name) { name_ = name; }
  44 };
  45
  46 /// Translate babel language name to LyX language name
  47 extern std::string babel2lyx(std::string const & language);
  48 /// Translate polyglossia language name to LyX language name
  49 extern std::string polyglossia2lyx(std::string const & language);
  50 /// Translate basic color name or RGB color in LaTeX syntax to LyX color code
  51 extern std::string rgbcolor2code(std::string const & name);
  52
  53 /// in text.cpp
  54 std::string translate_len(std::string const &);
  55
  56 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
  57                 Context & context);
  58
  59 /*!
  60  * Parses a subdocument, usually useful in insets (whence the name).
  61  *
  62  * It ignores \c context.need_layout and \c context.need_end_layout and
  63  * starts and ends always a new layout.
  64  * Therefore this may only be used to parse text in insets or table cells.
  65  */
  66 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
  67                          bool outer, Context const & context,
  68                          InsetLayout const * layout = 0);
  69
  70
  71 /// in math.cpp
  72 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
  73
  74
  75 /// in table.cpp
  76 void handle_tabular(Parser & p, std::ostream & os, std::string const & name,
  77                     std::string const & width, Context & context);
  78
  79
  80 /// in tex2lyx.cpp
  81 std::string const trimSpaceAndEol(std::string const & a);
  82
  83 void split(std::string const & s, std::vector<std::string> & result,
  84         char delim = ',');
  85 std::string join(std::vector<std::string> const & input,
  86         char const * delim);
  87
  88 bool is_math_env(std::string const & name);
  89 bool is_display_math_env(std::string const & name);
  90 char const * const * is_known(std::string const &, char const * const *);
  91
  92 /*!
  93  * Adds the command \p command to the list of known commands.
  94  * \param o1 first optional parameter to the latex command \\newcommand
  95  * (with brackets), or the empty string if there were no optional arguments.
  96  * \param o2 wether \\newcommand had a second optional parameter.
  97  * If \p definition is not empty the command is assumed to be from the LyX
  98  * preamble and added to possible_textclass_commands.
  99  */
 100 void add_known_command(std::string const & command, std::string const & o1,
 101         bool o2, docstring const & definition = docstring());
 102 extern void add_known_environment(std::string const & environment,
 103         std::string const & o1, bool o2, docstring const & beg,
 104         docstring const & end);
 105 extern Layout const * findLayoutWithoutModule(TextClass const & textclass,
 106         std::string const & name, bool command);
 107 extern InsetLayout const * findInsetLayoutWithoutModule(
 108         TextClass const & textclass, std::string const & name, bool command);
 109 /*!
 110  * Check whether a module provides command (if \p command is true) or
 111  * environment (if \p command is false) \p name, and add the module to the
 112  * list of used modules if yes.
 113  */
 114 extern bool checkModule(std::string const & name, bool command);
 115 // Access to environment stack
 116 extern std::vector<std::string> active_environments;
 117 std::string active_environment();
 118
 119 enum ArgumentType {
 120         required,
 121         req_group,
 122         verbatim,
 123         item,
 124         optional,
 125         opt_group,
 126         displaymath,
 127 };
 128
 129 class FullCommand {
 130 public:
 131         FullCommand() {}
 132         FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
 133                 : args(a), def(d) {}
 134         std::vector<ArgumentType> args;
 135         docstring def;
 136 };
 137
 138 class FullEnvironment {
 139 public:
 140         FullEnvironment() {}
 141         FullEnvironment(std::vector<ArgumentType> const & a,
 142                         docstring const & b, docstring const & e)
 143                 : args(a), beg(b), end(e) {}
 144         std::vector<ArgumentType> args;
 145         docstring beg;
 146         docstring end;
 147 };
 148
 149 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
 150 typedef std::map<std::string, FullCommand> FullCommandMap;
 151 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
 152
 153 /// Known TeX commands with arguments that get parsed into ERT.
 154 extern CommandMap known_commands;
 155 /// Known TeX environments with arguments that get parsed into ERT.
 156 extern CommandMap known_environments;
 157 /// Known TeX math environments with arguments that get parsed into LyX mathed.
 158 extern CommandMap known_math_environments;
 159 /// Commands that might be defined by the document class or modules
 160 extern FullCommandMap possible_textclass_commands;
 161 /// Environments that might be defined by the document class or modules
 162 extern FullEnvironmentMap possible_textclass_environments;
 163 ///
 164 extern bool noweb_mode;
 165 /// Did we recognize any pdflatex-only construct?
 166 extern bool pdflatex;
 167 /// Did we recognize any xetex-only construct?
 168 extern bool xetex;
 169 /// Do we have CJK?
 170 extern bool have_CJK;
 171 /// Do we have non-CJK Japanese?
 172 extern bool is_nonCJKJapanese;
 173 /// LyX format that is created by tex2lyx
 174 extern int const LYX_FORMAT;
 175
 176 /// Absolute path of the master .lyx or .tex file
 177 extern std::string getMasterFilePath(bool input);
 178 /// Absolute path of the currently processed .lyx or .tex file
 179 extern std::string getParentFilePath(bool input);
 180 /// Is it allowed to overwrite existing files?
 181 extern bool overwriteFiles();
 182 /// Do we need to copy included files to the output directory?
 183 extern bool copyFiles();
 184
 185
 186 /*!
 187  *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
 188  *  The (latex) encoding can be provided as \a encoding.
 189  *  Uses some common settings for the preamble, so this should only
 190  *  be used more than once for included documents.
 191  *  Caution: Overwrites the existing preamble settings if the new document
 192  *  contains a preamble.
 193  *  \return true if the conversion was successful, else false.
 194  */
 195 bool tex2lyx(std::string const & infilename,
 196              support::FileName const & outfilename,
 197              std::string const & encoding);
 198
 199
 200 } // namespace lyx
 201
 202 #endif