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