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 "texparser.h"
  17 #include "lyxtextclass.h"
  18
  19 #include <iosfwd>
  20 #include <string>
  21 #include <vector>
  22 #include <map>
  23
  24 class Context;
  25
  26 /// in preamble.C
  27 LyXTextClass const parse_preamble(Parser & p, std::ostream & os, std::string const & forceclass);
  28
  29 /// used packages with options
  30 extern std::map<std::string, std::vector<std::string> > used_packages;
  31
  32
  33 /// in text.C
  34 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
  35                 Context & context);
  36
  37 //std::string parse_text(Parser & p, unsigned flags, const bool outer,
  38 //                     Context & context);
  39
  40 /// parses a subdocument, usually useful in insets (whence the name)
  41 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
  42                          bool outer, Context & context);
  43
  44
  45 /// in math.C
  46 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
  47
  48
  49 /// in table.C
  50 void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
  51                     Context & context);
  52
  53
  54 /// in tex2lyx.C
  55 std::string const trim(std::string const & a, char const * p = " \t\n\r");
  56
  57 void split(std::string const & s, std::vector<std::string> & result,
  58         char delim = ',');
  59 std::string join(std::vector<std::string> const & input,
  60         char const * delim);
  61
  62 bool is_math_env(std::string const & name);
  63 char const * const * is_known(std::string const &, char const * const *);
  64
  65 /*!
  66  * Adds the command \p command to the list of known commands.
  67  * \param o1 first optional parameter to the latex command \newcommand
  68  * (with brackets), or the empty string if there were no optional arguments.
  69  * \param o2 wether \newcommand had a second optional parameter
  70  */
  71 void add_known_command(std::string const & command, std::string const & o1,
  72                        bool o2);
  73
  74 // Access to environment stack
  75 extern std::vector<std::string> active_environments;
  76 std::string active_environment();
  77
  78 enum ArgumentType {
  79         required,
  80         verbatim,
  81         optional
  82 };
  83
  84 /// Known TeX commands with arguments that get parsed into ERT.
  85 extern std::map<std::string, std::vector<ArgumentType> > known_commands;
  86
  87
  88 /// path of the master .tex file
  89 extern std::string getMasterFilePath();
  90 /// path of the currently processed .tex file
  91 extern std::string getParentFilePath();
  92
  93
  94 /*!
  95  *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
  96  *  Uses some common settings for the preamble, so this should only
  97  *  be used more than once for included documents.
  98  *  Caution: Overwrites the existing preamble settings if the new document
  99  *  contains a preamble.
 100  *  \return true if the conversion was successful, else false.
 101  */
 102 bool tex2lyx(std::string const & infilename, std::string const & outfilename);
 103
 104 #endif