Now tex2lyx is able to set the encoding from what it reads in the preamble.

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

diff --git a/src/tex2lyx/tex2lyx.h b/src/tex2lyx/tex2lyx.h
index 83c897d5e83e4dc6e297e61f4e04d84965b49e34..4850eeea8826ccc09402eba68efdcc9b9a3e6fba 100644 (file)
--- a/src/tex2lyx/tex2lyx.h
+++ b/src/tex2lyx/tex2lyx.h
@@ -1,37 +1,128 @@
+// -*- 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
 
-#include "texparser.h"
+#include "Parser.h"
+#include "TextClass.h"
 
 #include <iosfwd>
 #include <string>
 #include <vector>
+#include <map>
+
+
+namespace lyx {
+
+namespace support { class FileName; }
+
+class Context;
 
+/// A trivial subclass, just to give us a public default constructor
+class TeX2LyXDocClass : public DocumentClass
+{};
 
-void parse_preamble(Parser & p, std::ostream & os);
+/// in preamble.cpp
+void parse_preamble(Parser & p, std::ostream & os, 
+       std::string const & forceclass, TeX2LyXDocClass & tc);
 
-void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer);
+/// used packages with options
+extern std::map<std::string, std::vector<std::string> > used_packages;
 
-void parse_table(Parser & p, std::ostream & os, unsigned flags);
+/// in text.cpp
+std::string translate_len(std::string const &);
 
+void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
+               Context & context);
+
+/*!
+ * Parses a subdocument, usually useful in insets (whence the name).
+ *
+ * It ignores \c context.need_layout and \c context.need_end_layout and
+ * starts and ends always a new layout.
+ * Therefore this may only be used to parse text in insets or table cells.
+ */
+void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
+                        bool outer, Context const & context);
+
+
+/// in math.cpp
 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
 
-void handle_tabular(Parser & p, std::ostream & os);
 
-// Helper
-std::string parse_text(Parser & p, unsigned flags, const bool outer);
+/// in table.cpp
+void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
+                   Context & context);
+
 
-void handle_comment(Parser & p);
+/// in tex2lyx.cpp
 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, char delim = ',');
-std::string join(std::vector<std::string> const & input, char const * delim);
+void split(std::string const & s, std::vector<std::string> & result,
+       char delim = ',');
+std::string join(std::vector<std::string> const & input,
+       char const * delim);
 
 bool is_math_env(std::string const & name);
-char const ** is_known(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
+};
+
+typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
+
+/// Known TeX commands with arguments that get parsed into ERT.
+extern CommandMap known_commands;
+/// Known TeX environments with arguments that get parsed into ERT.
+extern CommandMap known_environments;
+/// Known TeX math environments with arguments that get parsed into LyX mathed.
+extern CommandMap known_math_environments;
+///
+extern bool noweb_mode;
+
+/// path of the master .tex file
+extern std::string getMasterFilePath();
+/// path of the currently processed .tex file
+extern std::string getParentFilePath();
+
+
+/*!
+ *  Reads tex input from \a infilename and writes lyx output to \a outfilename.
+ *  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.
+ *  \return true if the conversion was successful, else false.
+ */
+bool tex2lyx(std::string const & infilename, support::FileName const & outfilename);
+
+
+} // namespace lyx
+
 #endif