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 "texparser.h"
  17 #include "lyxtextclass.h"
  18
  19 #include <iosfwd>
  20 #include <string>
  21 #include <vector>
  22 #include <map>
  23
  24
  25 namespace lyx {
  26
  27 class Context;
  28
  29 /// in preamble.C
  30 LyXTextClass const parse_preamble(Parser & p, std::ostream & os, std::string const & forceclass);
  31
  32 /// used packages with options
  33 extern std::map<std::string, std::vector<std::string> > used_packages;
  34
  35
  36 /// in text.C
  37 std::string translate_len(std::string const &);
  38
  39 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
  40                 Context & context);
  41
  42 /*!
  43  * Parses a subdocument, usually useful in insets (whence the name).
  44  *
  45  * It ignores \c context.need_layout and \c context.need_end_layout and
  46  * starts and ends always a new layout.
  47  * Therefore this may only be used to parse text in insets or table cells.
  48  */
  49 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
  50                          bool outer, Context const & context);
  51
  52
  53 /// in math.C
  54 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
  55
  56
  57 /// in table.C
  58 void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
  59                     Context & context);
  60
  61
  62 /// in tex2lyx.C
  63 std::string const trim(std::string const & a, char const * p = " \t\n\r");
  64
  65 void split(std::string const & s, std::vector<std::string> & result,
  66         char delim = ',');
  67 std::string join(std::vector<std::string> const & input,
  68         char const * delim);
  69
  70 bool is_math_env(std::string const & name);
  71 char const * const * is_known(std::string const &, char const * const *);
  72
  73 /*!
  74  * Adds the command \p command to the list of known commands.
  75  * \param o1 first optional parameter to the latex command \newcommand
  76  * (with brackets), or the empty string if there were no optional arguments.
  77  * \param o2 wether \newcommand had a second optional parameter
  78  */
  79 void add_known_command(std::string const & command, std::string const & o1,
  80                        bool o2);
  81
  82 // Access to environment stack
  83 extern std::vector<std::string> active_environments;
  84 std::string active_environment();
  85
  86 enum ArgumentType {
  87         required,
  88         verbatim,
  89         optional
  90 };
  91
  92 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
  93
  94 /// Known TeX commands with arguments that get parsed into ERT.
  95 extern CommandMap known_commands;
  96 /// Known TeX environments with arguments that get parsed into ERT.
  97 extern CommandMap known_environments;
  98 /// Known TeX math environments with arguments that get parsed into LyX mathed.
  99 extern CommandMap known_math_environments;
 100 ///
 101 extern bool noweb_mode;
 102
 103 /// path of the master .tex file
 104 extern std::string getMasterFilePath();
 105 /// path of the currently processed .tex file
 106 extern std::string getParentFilePath();
 107
 108
 109 /*!
 110  *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
 111  *  Uses some common settings for the preamble, so this should only
 112  *  be used more than once for included documents.
 113  *  Caution: Overwrites the existing preamble settings if the new document
 114  *  contains a preamble.
 115  *  \return true if the conversion was successful, else false.
 116  */
 117 bool tex2lyx(std::string const & infilename, std::string const & outfilename);
 118
 119
 120 } // namespace lyx
 121
 122 #endif