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