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, Context & context);
  51
  52
  53 /// in tex2lyx.C
  54 std::string const trim(std::string const & a, char const * p = " \t\n\r");
  55
  56 void split(std::string const & s, std::vector<std::string> & result,
  57         char delim = ',');
  58 std::string join(std::vector<std::string> const & input,
  59         char const * delim);
  60
  61 bool is_math_env(std::string const & name);
  62 char const * const * is_known(std::string const &, char const * const *);
  63
  64 // Access to environment stack
  65 extern std::vector<std::string> active_environments;
  66 std::string active_environment();
  67
  68 enum ArgumentType {
  69         required,
  70         verbatim,
  71         optional
  72 };
  73
  74 /// Known TeX commands with arguments that get parsed into ERT.
  75 extern std::map<std::string, std::vector<ArgumentType> > known_commands;
  76
  77
  78 /// path of the master .tex file
  79 extern std::string getMasterFilePath();
  80
  81
  82 /*! Reads tex input from \a is and writes lyx output to \a os.
  83  *  Uses some common settings for the preamble, so this should only
  84  *  be used more than once for included documents.
  85  *  Caution: Overwrites the existing preamble settings if the new document
  86  *  contains a preamble. */
  87 void tex2lyx(std::istream &, std::ostream &);
  88 /// \return true if the conversion was successful, else false.
  89 bool tex2lyx(std::string const &, std::string const &);
  90
  91 #endif