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 polyglossia language name to LyX language name
49 extern std::string polyglossia2lyx(std::string const & language);
50 /// Translate basic color name or RGB color in LaTeX syntax to LyX color code
51 extern std::string rgbcolor2code(std::string const & name);
54 std::string translate_len(std::string const &);
56 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
60 * Parses a subdocument, usually useful in insets (whence the name).
62 * It ignores \c context.need_layout and \c context.need_end_layout and
63 * starts and ends always a new layout.
64 * Therefore this may only be used to parse text in insets or table cells.
66 void parse_text_in_inset(Parser & p, std::ostream & os, unsigned flags,
67 bool outer, Context const & context,
68 InsetLayout const * layout = 0);
70 /// Guess document language from \p p if CJK is used.
71 /// \p lang is used for all non-CJK contents.
72 std::string guessLanguage(Parser & p, std::string const & lang);
76 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
80 void handle_tabular(Parser & p, std::ostream & os, std::string const & name,
81 std::string const & width, Context & context);
85 std::string const trimSpaceAndEol(std::string const & a);
87 void split(std::string const & s, std::vector<std::string> & result,
89 std::string join(std::vector<std::string> const & input,
92 bool is_math_env(std::string const & name);
93 bool is_display_math_env(std::string const & name);
94 char const * const * is_known(std::string const &, char const * const *);
97 * Adds the command \p command to the list of known commands.
98 * \param o1 first optional parameter to the latex command \\newcommand
99 * (with brackets), or the empty string if there were no optional arguments.
100 * \param o2 wether \\newcommand had a second optional parameter.
101 * If \p definition is not empty the command is assumed to be from the LyX
102 * preamble and added to possible_textclass_commands.
104 void add_known_command(std::string const & command, std::string const & o1,
105 bool o2, docstring const & definition = docstring());
106 extern void add_known_environment(std::string const & environment,
107 std::string const & o1, bool o2, docstring const & beg,
108 docstring const & end);
109 extern void add_known_theorem(std::string const & theorem,
110 std::string const & o1, bool o2, docstring const & definition);
111 extern Layout const * findLayoutWithoutModule(TextClass const & textclass,
112 std::string const & name, bool command);
113 extern InsetLayout const * findInsetLayoutWithoutModule(
114 TextClass const & textclass, std::string const & name, bool command);
116 * Check whether a module provides command (if \p command is true) or
117 * environment (if \p command is false) \p name, and add the module to the
118 * list of used modules if yes.
120 extern bool checkModule(std::string const & name, bool command);
121 /// Is this feature already provided e.g. by the document class?
122 extern bool isProvided(std::string const & name);
123 // Access to environment stack
124 extern std::vector<std::string> active_environments;
125 std::string active_environment();
140 FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
142 std::vector<ArgumentType> args;
146 class FullEnvironment {
149 FullEnvironment(std::vector<ArgumentType> const & a,
150 docstring const & b, docstring const & e)
151 : args(a), beg(b), end(e) {}
152 std::vector<ArgumentType> args;
157 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
158 typedef std::map<std::string, FullCommand> FullCommandMap;
159 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
161 /// Known TeX commands with arguments that get parsed into ERT.
162 extern CommandMap known_commands;
163 /// Known TeX environments with arguments that get parsed into ERT.
164 extern CommandMap known_environments;
165 /// Known TeX math environments with arguments that get parsed into LyX mathed.
166 extern CommandMap known_math_environments;
167 /// Commands that might be defined by the document class or modules
168 extern FullCommandMap possible_textclass_commands;
169 /// Environments that might be defined by the document class or modules
170 extern FullEnvironmentMap possible_textclass_environments;
171 /// Theorems that might be defined by the document class or modules
172 extern FullCommandMap possible_textclass_theorems;
174 extern bool noweb_mode;
175 /// Did we recognize any pdflatex-only construct?
176 extern bool pdflatex;
177 /// Did we recognize any xetex-only construct?
179 /// Do we have non-CJK Japanese?
180 extern bool is_nonCJKJapanese;
181 /// LyX format that is created by tex2lyx
182 extern int const LYX_FORMAT;
184 /// Absolute path of the master .lyx or .tex file
185 extern std::string getMasterFilePath(bool input);
186 /// Absolute path of the currently processed .lyx or .tex file
187 extern std::string getParentFilePath(bool input);
188 /// Is it allowed to overwrite existing files?
189 extern bool overwriteFiles();
190 /// Do we need to copy included files to the output directory?
191 extern bool copyFiles();
192 /// Shall we skip child documents and keep them as TeX?
193 extern bool skipChildren();
197 * Reads tex input from \a infilename and writes lyx output to \a outfilename.
198 * The iconv name of the encoding can be provided as \a encoding.
199 * Uses some common settings for the preamble, so this should only
200 * be used more than once for included documents.
201 * Caution: Overwrites the existing preamble settings if the new document
202 * contains a preamble.
203 * \return true if the conversion was successful, else false.
205 bool tex2lyx(std::string const & infilename,
206 support::FileName const & outfilename,
207 std::string const & encoding);