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 class Context;
  30
  31 /// A trivial subclass, just to give us a public default constructor
  32 class TeX2LyXDocClass : public DocumentClass
  33 {
  34 public:
  35         void setName(std::string const & name) { name_ = name; }
  36 };
  37
  38 /// Translate babel language name to LyX language name
  39 extern std::string babel2lyx(std::string const & language);
  40 /// Translate LyX language name to babel language name
  41 extern std::string lyx2babel(std::string const & language);
  42 /// Translate polyglossia language name to LyX language name
  43 extern std::string polyglossia2lyx(std::string const & language);
  44 /// Translate basic color name or RGB color in LaTeX syntax to LyX color code
  45 extern std::string rgbcolor2code(std::string const & name);
  46
  47 /// in text.cpp
  48 std::string translate_len(std::string const &);
  49
  50 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
  51                 Context & context);
  52 void check_comment_bib(std::ostream & os, Context & context);
  53
  54 /*!
  55  * Parses a subdocument, usually useful in insets (whence the name).
  56  *
  57  * It ignores \c context.need_layout and \c context.need_end_layout and
  58  * starts and ends always a new layout.
  59  * Therefore this may only be used to parse text in insets or table cells.
  60  */
  61 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
  62                          bool outer, Context const & context,
  63                          InsetLayout const * layout = 0);
  64
  65 /// Guess document language from \p p if CJK is used.
  66 /// \p lang is used for all non-CJK contents.
  67 std::string guessLanguage(Parser & p, std::string const & lang);
  68
  69
  70 /// in math.cpp
  71 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
  72
  73
  74 /// in table.cpp
  75 void handle_tabular(Parser & p, std::ostream & os, std::string const & name,
  76                     std::string const & width, Context & context);
  77
  78
  79 /// in tex2lyx.cpp
  80 std::string const trimSpaceAndEol(std::string const & a);
  81
  82 void split(std::string const & s, std::vector<std::string> & result,
  83         char delim = ',');
  84 std::string join(std::vector<std::string> const & input,
  85         char const * delim);
  86
  87 bool is_math_env(std::string const & name);
  88 bool is_display_math_env(std::string const & name);
  89 /// Is first string in the array of strings (second parameter)
  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 void add_known_theorem(std::string const & theorem,
 106         std::string const & o1, bool o2, docstring const & definition);
 107 extern Layout const * findLayoutWithoutModule(TextClass const & textclass,
 108         std::string const & name, bool command);
 109 extern InsetLayout const * findInsetLayoutWithoutModule(
 110         TextClass const & textclass, std::string const & name, bool command);
 111 /*!
 112  * Check whether a module provides command (if \p command is true) or
 113  * environment (if \p command is false) \p name, and add the module to the
 114  * list of used modules if yes.
 115  */
 116 extern bool checkModule(std::string const & name, bool command);
 117 /// Is this feature already provided e.g. by the document class?
 118 extern bool isProvided(std::string const & name);
 119 // Access to environment stack
 120 extern std::vector<std::string> active_environments;
 121 std::string active_environment();
 122
 123 enum ArgumentType {
 124         required,
 125         req_group,
 126         verbatim,
 127         item,
 128         optional,
 129         opt_group,
 130         displaymath,
 131 };
 132
 133 class FullCommand {
 134 public:
 135         FullCommand() {}
 136         FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
 137                 : args(a), def(d) {}
 138         std::vector<ArgumentType> args;
 139         docstring def;
 140 };
 141
 142 class FullEnvironment {
 143 public:
 144         FullEnvironment() {}
 145         FullEnvironment(std::vector<ArgumentType> const & a,
 146                         docstring const & b, docstring const & e)
 147                 : args(a), beg(b), end(e) {}
 148         std::vector<ArgumentType> args;
 149         docstring beg;
 150         docstring end;
 151 };
 152
 153 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
 154 typedef std::map<std::string, FullCommand> FullCommandMap;
 155 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
 156
 157 /// Known TeX commands with arguments that get parsed into ERT.
 158 extern CommandMap known_commands;
 159 /// Known TeX environments with arguments that get parsed into ERT.
 160 extern CommandMap known_environments;
 161 /// Known TeX math environments with arguments that get parsed into LyX mathed.
 162 extern CommandMap known_math_environments;
 163 /// Commands that might be defined by the document class or modules
 164 extern FullCommandMap possible_textclass_commands;
 165 /// Environments that might be defined by the document class or modules
 166 extern FullEnvironmentMap possible_textclass_environments;
 167 /// Theorems that might be defined by the document class or modules
 168 extern FullCommandMap possible_textclass_theorems;
 169 ///
 170 extern bool noweb_mode;
 171 /// Did we recognize any pdflatex-only construct?
 172 extern bool pdflatex;
 173 /// Did we recognize any xetex-only construct?
 174 extern bool xetex;
 175 /// Do we have non-CJK Japanese?
 176 extern bool is_nonCJKJapanese;
 177 /// LyX format that is created by tex2lyx
 178 extern int const LYX_FORMAT;
 179
 180 /// Absolute path of the master .lyx or .tex file
 181 extern std::string getMasterFilePath(bool input);
 182 /// Absolute path of the currently processed .lyx or .tex file
 183 extern std::string getParentFilePath(bool input);
 184 /// Is it allowed to overwrite existing files?
 185 extern bool overwriteFiles();
 186 /// Do we need to copy included files to the output directory?
 187 extern bool copyFiles();
 188 /// Shall we skip child documents and keep them as TeX?
 189 extern bool skipChildren();
 190 /// Does tex2lyx run in roundtrip mode?
 191 extern bool roundtripMode();
 192
 193
 194 /*!
 195  *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
 196  *  The iconv name of the encoding can be provided as \a encoding.
 197  *  Uses some common settings for the preamble, so this should only
 198  *  be used more than once for included documents.
 199  *  Caution: Overwrites the existing preamble settings if the new document
 200  *  contains a preamble.
 201  *  \return true if the conversion was successful, else false.
 202  */
 203 bool tex2lyx(std::string const & infilename,
 204              support::FileName const & outfilename,
 205              std::string const & encoding);
 206
 207
 208 } // namespace lyx
 209
 210 #endif