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