some tabular fixes for the problems reported by Helge

[lyx.git] / src / tex2lyx / tex2lyx.h

diff --git a/src/tex2lyx/tex2lyx.h b/src/tex2lyx/tex2lyx.h
index 74b21e290782aa9b2f64a2c98a0408545914b724..adf77034a58c78fecba10d9df9774214de2f25b3 100644 (file)
--- a/src/tex2lyx/tex2lyx.h
+++ b/src/tex2lyx/tex2lyx.h
@@ -1,4 +1,15 @@
 // -*- C++ -*-
+/**
+ * \file tex2lyx.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author André Pönitz
+ * \author Jean-Marc Lasgouttes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 #ifndef TEX2LYX_H
 #define TEX2LYX_H
 
@@ -8,11 +19,15 @@
 #include <iosfwd>
 #include <string>
 #include <vector>
+#include <map>
 
 class Context;
 
 /// in preamble.C
-LyXTextClass const parse_preamble(Parser & p, std::ostream & os);
+LyXTextClass const parse_preamble(Parser & p, std::ostream & os, std::string const & forceclass);
+
+/// used packages with options
+extern std::map<std::string, std::vector<std::string> > used_packages;
 
 
 /// in text.C
@@ -22,7 +37,8 @@ void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
 //std::string parse_text(Parser & p, unsigned flags, const bool outer,
 //                    Context & context);
 
-void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags, 
+/// parses a subdocument, usually useful in insets (whence the name)
+void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
                         bool outer, Context & context);
 
 
@@ -31,11 +47,11 @@ void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
 
 
 /// in table.C
-void handle_tabular(Parser & p, std::ostream & os, Context & context);
+void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
+                    Context & context);
 
 
 /// in tex2lyx.C
-void handle_comment(Parser & p);
 std::string const trim(std::string const & a, char const * p = " \t\n\r");
 
 void split(std::string const & s, std::vector<std::string> & result,
@@ -44,10 +60,42 @@ std::string join(std::vector<std::string> const & input,
        char const * delim);
 
 bool is_math_env(std::string const & name);
-char const ** is_known(std::string const & str, char const ** what);
+char const * const * is_known(std::string const &, char const * const *);
+
+/*!
+ * Adds the command \p command to the list of known commands.
+ * \param o1 first optional parameter to the latex command \newcommand
+ * (with brackets), or the empty string if there were no optional arguments.
+ * \param o2 wether \newcommand had a second optional parameter
+ */
+void add_known_command(std::string const & command, std::string const & o1,
+                       bool o2);
 
 // Access to environment stack
 extern std::vector<std::string> active_environments;
 std::string active_environment();
 
+enum ArgumentType {
+       required,
+       verbatim,
+       optional
+};
+
+/// Known TeX commands with arguments that get parsed into ERT.
+extern std::map<std::string, std::vector<ArgumentType> > known_commands;
+
+
+/// path of the master .tex file
+extern std::string getMasterFilePath();
+
+
+/*! Reads tex input from \a is and writes lyx output to \a os.
+ *  Uses some common settings for the preamble, so this should only
+ *  be used more than once for included documents.
+ *  Caution: Overwrites the existing preamble settings if the new document
+ *  contains a preamble. */
+void tex2lyx(std::istream &, std::ostream &);
+/// \return true if the conversion was successful, else false.
+bool tex2lyx(std::string const &, std::string const &);
+
 #endif