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
  56 /// in text.cpp
  57 std::string translate_len(std::string const &);
  58
  59 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
  60                 Context & context);
  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 const & context,
  71                          InsetLayout const * layout = 0);
  72
  73
  74 /// in math.cpp
  75 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
  76
  77
  78 /// in table.cpp
  79 void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
  80                     Context & context);
  81
  82
  83 /// in tex2lyx.cpp
  84 std::string const trim(std::string const & a, char const * p = " \t\n\r");
  85
  86 void split(std::string const & s, std::vector<std::string> & result,
  87         char delim = ',');
  88 std::string join(std::vector<std::string> const & input,
  89         char const * delim);
  90
  91 bool is_math_env(std::string const & name);
  92 char const * const * is_known(std::string const &, char const * const *);
  93
  94 /*!
  95  * Adds the command \p command to the list of known commands.
  96  * \param o1 first optional parameter to the latex command \\newcommand
  97  * (with brackets), or the empty string if there were no optional arguments.
  98  * \param o2 wether \\newcommand had a second optional parameter.
  99  * If \p definition is not empty the command is assumed to be from the LyX
 100  * preamble and added to possible_textclass_commands.
 101  */
 102 void add_known_command(std::string const & command, std::string const & o1,
 103         bool o2, docstring const & definition = docstring());
 104 extern void add_known_environment(std::string const & environment,
 105         std::string const & o1, bool o2, docstring const & beg,
 106         docstring const & end);
 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 // Access to environment stack
 118 extern std::vector<std::string> active_environments;
 119 std::string active_environment();
 120
 121 enum ArgumentType {
 122         required,
 123         verbatim,
 124         item,
 125         optional
 126 };
 127
 128 class FullCommand {
 129 public:
 130         FullCommand() {}
 131         FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
 132                 : args(a), def(d) {}
 133         std::vector<ArgumentType> args;
 134         docstring def;
 135 };
 136
 137 class FullEnvironment {
 138 public:
 139         FullEnvironment() {}
 140         FullEnvironment(std::vector<ArgumentType> const & a,
 141                         docstring const & b, docstring const & e)
 142                 : args(a), beg(b), end(e) {}
 143         std::vector<ArgumentType> args;
 144         docstring beg;
 145         docstring end;
 146 };
 147
 148 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
 149 typedef std::map<std::string, FullCommand> FullCommandMap;
 150 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
 151
 152 /// Known TeX commands with arguments that get parsed into ERT.
 153 extern CommandMap known_commands;
 154 /// Known TeX environments with arguments that get parsed into ERT.
 155 extern CommandMap known_environments;
 156 /// Known TeX math environments with arguments that get parsed into LyX mathed.
 157 extern CommandMap known_math_environments;
 158 /// Commands that might be defined by the document class or modules
 159 extern FullCommandMap possible_textclass_commands;
 160 /// Environments that might be defined by the document class or modules
 161 extern FullEnvironmentMap possible_textclass_environments;
 162 ///
 163 extern bool noweb_mode;
 164 /// Did we recognize any pdflatex-only construct?
 165 extern bool pdflatex;
 166 /// LyX format that is created by tex2lyx
 167 int const LYX_FORMAT = 345;
 168
 169 /// path of the master .tex file
 170 extern std::string getMasterFilePath();
 171 /// path of the currently processed .tex file
 172 extern std::string getParentFilePath();
 173
 174
 175 /*!
 176  *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
 177  *  The (latex) encoding can be provided as \a encoding.
 178  *  Uses some common settings for the preamble, so this should only
 179  *  be used more than once for included documents.
 180  *  Caution: Overwrites the existing preamble settings if the new document
 181  *  contains a preamble.
 182  *  \return true if the conversion was successful, else false.
 183  */
 184 bool tex2lyx(std::string const & infilename,
 185              support::FileName const & outfilename,
 186              std::string const & encoding);
 187
 188
 189 } // namespace lyx
 190
 191 #endif