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