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