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 /// in preamble.cpp
  47 void parse_preamble(Parser & p, std::ostream & os,
  48         std::string const & forceclass, TeX2LyXDocClass & tc);
  49 /// Translate babel language name to LyX language name
  50 extern std::string babel2lyx(std::string const & language);
  51
  52 /// used packages with options
  53 extern std::map<std::string, std::vector<std::string> > used_packages;
  54 extern const char * const modules_placeholder;
  55 extern std::string h_inputencoding;
  56 extern std::string h_paragraph_separation;
  57
  58 /// in text.cpp
  59 std::string translate_len(std::string const &);
  60
  61 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
  62                 Context & context);
  63
  64 /*!
  65  * Parses a subdocument, usually useful in insets (whence the name).
  66  *
  67  * It ignores \c context.need_layout and \c context.need_end_layout and
  68  * starts and ends always a new layout.
  69  * Therefore this may only be used to parse text in insets or table cells.
  70  */
  71 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
  72                          bool outer, Context const & context,
  73                          InsetLayout const * layout = 0);
  74
  75
  76 /// in math.cpp
  77 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
  78
  79
  80 /// in table.cpp
  81 void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
  82                     Context & context);
  83
  84
  85 /// in tex2lyx.cpp
  86 std::string const trimSpaceAndEol(std::string const & a);
  87
  88 void split(std::string const & s, std::vector<std::string> & result,
  89         char delim = ',');
  90 std::string join(std::vector<std::string> const & input,
  91         char const * delim);
  92
  93 bool is_math_env(std::string const & name);
  94 char const * const * is_known(std::string const &, char const * const *);
  95
  96 /*!
  97  * Adds the command \p command to the list of known commands.
  98  * \param o1 first optional parameter to the latex command \\newcommand
  99  * (with brackets), or the empty string if there were no optional arguments.
 100  * \param o2 wether \\newcommand had a second optional parameter.
 101  * If \p definition is not empty the command is assumed to be from the LyX
 102  * preamble and added to possible_textclass_commands.
 103  */
 104 void add_known_command(std::string const & command, std::string const & o1,
 105         bool o2, docstring const & definition = docstring());
 106 extern void add_known_environment(std::string const & environment,
 107         std::string const & o1, bool o2, docstring const & beg,
 108         docstring const & end);
 109 extern Layout const * findLayoutWithoutModule(TextClass const & textclass,
 110         std::string const & name, bool command);
 111 extern InsetLayout const * findInsetLayoutWithoutModule(
 112         TextClass const & textclass, std::string const & name, bool command);
 113 /*!
 114  * Check whether a module provides command (if \p command is true) or
 115  * environment (if \p command is false) \p name, and add the module to the
 116  * list of used modules if yes.
 117  */
 118 extern bool checkModule(std::string const & name, bool command);
 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         verbatim,
 126         item,
 127         optional
 128 };
 129
 130 class FullCommand {
 131 public:
 132         FullCommand() {}
 133         FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
 134                 : args(a), def(d) {}
 135         std::vector<ArgumentType> args;
 136         docstring def;
 137 };
 138
 139 class FullEnvironment {
 140 public:
 141         FullEnvironment() {}
 142         FullEnvironment(std::vector<ArgumentType> const & a,
 143                         docstring const & b, docstring const & e)
 144                 : args(a), beg(b), end(e) {}
 145         std::vector<ArgumentType> args;
 146         docstring beg;
 147         docstring end;
 148 };
 149
 150 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
 151 typedef std::map<std::string, FullCommand> FullCommandMap;
 152 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
 153
 154 /// Known TeX commands with arguments that get parsed into ERT.
 155 extern CommandMap known_commands;
 156 /// Known TeX environments with arguments that get parsed into ERT.
 157 extern CommandMap known_environments;
 158 /// Known TeX math environments with arguments that get parsed into LyX mathed.
 159 extern CommandMap known_math_environments;
 160 /// Commands that might be defined by the document class or modules
 161 extern FullCommandMap possible_textclass_commands;
 162 /// Environments that might be defined by the document class or modules
 163 extern FullEnvironmentMap possible_textclass_environments;
 164 ///
 165 extern bool noweb_mode;
 166 /// Did we recognize any pdflatex-only construct?
 167 extern bool pdflatex;
 168 /// LyX format that is created by tex2lyx
 169 extern int const LYX_FORMAT;
 170
 171 /// path of the master .tex file
 172 extern std::string getMasterFilePath();
 173 /// path of the currently processed .tex file
 174 extern std::string getParentFilePath();
 175
 176
 177 /*!
 178  *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
 179  *  The (latex) encoding can be provided as \a encoding.
 180  *  Uses some common settings for the preamble, so this should only
 181  *  be used more than once for included documents.
 182  *  Caution: Overwrites the existing preamble settings if the new document
 183  *  contains a preamble.
 184  *  \return true if the conversion was successful, else false.
 185  */
 186 bool tex2lyx(std::string const & infilename,
 187              support::FileName const & outfilename,
 188              std::string const & encoding);
 189
 190
 191 } // namespace lyx
 192
 193 #endif