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