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