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