4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
17 #include "TextClass.h"
27 namespace support { class FileName; }
29 /// Simple support for frontend::Alert::warning().
32 void warning(docstring const & title, docstring const & message,
39 /// A trivial subclass, just to give us a public default constructor
40 class TeX2LyXDocClass : public DocumentClass
43 void setName(std::string const & name) { name_ = name; }
46 /// Translate babel language name to LyX language name
47 extern std::string babel2lyx(std::string const & language);
48 /// Translate basic color name or RGB color in LaTeX syntax to LyX color code
49 extern std::string rgbcolor2code(std::string const & name);
52 std::string translate_len(std::string const &);
54 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
58 * Parses a subdocument, usually useful in insets (whence the name).
60 * It ignores \c context.need_layout and \c context.need_end_layout and
61 * starts and ends always a new layout.
62 * Therefore this may only be used to parse text in insets or table cells.
64 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
65 bool outer, Context const & context,
66 InsetLayout const * layout = 0);
70 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
74 void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular,
79 std::string const trimSpaceAndEol(std::string const & a);
81 void split(std::string const & s, std::vector<std::string> & result,
83 std::string join(std::vector<std::string> const & input,
86 bool is_math_env(std::string const & name);
87 char const * const * is_known(std::string const &, char const * const *);
90 * Adds the command \p command to the list of known commands.
91 * \param o1 first optional parameter to the latex command \\newcommand
92 * (with brackets), or the empty string if there were no optional arguments.
93 * \param o2 wether \\newcommand had a second optional parameter.
94 * If \p definition is not empty the command is assumed to be from the LyX
95 * preamble and added to possible_textclass_commands.
97 void add_known_command(std::string const & command, std::string const & o1,
98 bool o2, docstring const & definition = docstring());
99 extern void add_known_environment(std::string const & environment,
100 std::string const & o1, bool o2, docstring const & beg,
101 docstring const & end);
102 extern Layout const * findLayoutWithoutModule(TextClass const & textclass,
103 std::string const & name, bool command);
104 extern InsetLayout const * findInsetLayoutWithoutModule(
105 TextClass const & textclass, std::string const & name, bool command);
107 * Check whether a module provides command (if \p command is true) or
108 * environment (if \p command is false) \p name, and add the module to the
109 * list of used modules if yes.
111 extern bool checkModule(std::string const & name, bool command);
112 // Access to environment stack
113 extern std::vector<std::string> active_environments;
114 std::string active_environment();
126 FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
128 std::vector<ArgumentType> args;
132 class FullEnvironment {
135 FullEnvironment(std::vector<ArgumentType> const & a,
136 docstring const & b, docstring const & e)
137 : args(a), beg(b), end(e) {}
138 std::vector<ArgumentType> args;
143 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
144 typedef std::map<std::string, FullCommand> FullCommandMap;
145 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
147 /// Known TeX commands with arguments that get parsed into ERT.
148 extern CommandMap known_commands;
149 /// Known TeX environments with arguments that get parsed into ERT.
150 extern CommandMap known_environments;
151 /// Known TeX math environments with arguments that get parsed into LyX mathed.
152 extern CommandMap known_math_environments;
153 /// Commands that might be defined by the document class or modules
154 extern FullCommandMap possible_textclass_commands;
155 /// Environments that might be defined by the document class or modules
156 extern FullEnvironmentMap possible_textclass_environments;
158 extern bool noweb_mode;
159 /// Did we recognize any pdflatex-only construct?
160 extern bool pdflatex;
161 /// Did we recognize any xetex-only construct?
163 /// LyX format that is created by tex2lyx
164 extern int const LYX_FORMAT;
166 /// path of the master .tex file
167 extern std::string getMasterFilePath();
168 /// path of the currently processed .tex file
169 extern std::string getParentFilePath();
173 * Reads tex input from \a infilename and writes lyx output to \a outfilename.
174 * The (latex) encoding can be provided as \a encoding.
175 * Uses some common settings for the preamble, so this should only
176 * be used more than once for included documents.
177 * Caution: Overwrites the existing preamble settings if the new document
178 * contains a preamble.
179 * \return true if the conversion was successful, else false.
181 bool tex2lyx(std::string const & infilename,
182 support::FileName const & outfilename,
183 std::string const & encoding);