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