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