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; }
31 /// A trivial subclass, just to give us a public default constructor
32 class TeX2LyXDocClass : public DocumentClass
35 void setName(std::string const & name) { name_ = name; }
38 /// Translate babel language name to LyX language name
39 extern std::string babel2lyx(std::string const & language);
40 /// Translate LyX language name to babel language name
41 extern std::string lyx2babel(std::string const & language);
42 /// Translate polyglossia language name to LyX language name
43 extern std::string polyglossia2lyx(std::string const & language);
44 /// Translate basic color name or RGB color in LaTeX syntax to LyX color code
45 extern std::string rgbcolor2code(std::string const & name);
48 std::string translate_len(std::string const &);
50 void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer,
51 Context & context, std::string const rdelim = std::string());
52 void check_comment_bib(std::ostream & os, Context & context);
54 void fix_child_filename(std::string & name);
56 std::string const normalize_filename(std::string const & name);
58 std::string find_file(std::string const & name, std::string const & path,
59 char const * const * extensions);
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,
71 std::string const rdelim = std::string());
73 /// Guess document language from \p p if CJK is used.
74 /// \p lang is used for all non-CJK contents.
75 std::string guessLanguage(Parser & p, std::string const & lang);
79 void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode);
83 void handle_tabular(Parser & p, std::ostream & os, std::string const & name,
84 std::string const & width, Context & context);
88 std::string const trimSpaceAndEol(std::string const & a);
90 void split(std::string const & s, std::vector<std::string> & result,
92 std::string join(std::vector<std::string> const & input,
95 bool is_math_env(std::string const & name);
96 bool is_display_math_env(std::string const & name);
97 /// Is first string in the array of strings (second parameter)
98 char const * const * is_known(std::string const &, char const * const *);
101 * Adds the command \p command to the list of known commands.
102 * \param o1 first optional parameter to the latex command \\newcommand
103 * (with brackets), or the empty string if there were no optional arguments.
104 * \param o2 wether \\newcommand had a second optional parameter.
105 * If \p definition is not empty the command is assumed to be from the LyX
106 * preamble and added to possible_textclass_commands.
108 void add_known_command(std::string const & command, std::string const & o1,
109 bool o2, docstring const & definition = docstring());
110 extern void add_known_environment(std::string const & environment,
111 std::string const & o1, bool o2, docstring const & beg,
112 docstring const & end);
113 extern void add_known_theorem(std::string const & theorem,
114 std::string const & o1, bool o2, docstring const & definition);
115 extern Layout const * findLayoutWithoutModule(TextClass const & tc,
116 std::string const & name, bool command);
117 extern InsetLayout const * findInsetLayoutWithoutModule(TextClass const & tc, std::string const & name, bool command);
119 * Check whether a module provides command (if \p command is true) or
120 * environment (if \p command is false) \p name, and add the module to the
121 * list of used modules if yes.
123 extern bool checkModule(std::string const & name, bool command);
124 /// Is this feature already provided e.g. by the document class?
125 extern bool isProvided(std::string const & name);
126 // Access to environment stack
127 extern std::vector<std::string> active_environments;
128 std::string active_environment();
143 FullCommand(std::vector<ArgumentType> const & a, docstring const & d)
145 std::vector<ArgumentType> args;
149 class FullEnvironment {
152 FullEnvironment(std::vector<ArgumentType> const & a,
153 docstring const & b, docstring const & e)
154 : args(a), beg(b), end(e) {}
155 std::vector<ArgumentType> args;
160 typedef std::map<std::string, std::vector<ArgumentType> > CommandMap;
161 typedef std::map<std::string, FullCommand> FullCommandMap;
162 typedef std::map<std::string, FullEnvironment> FullEnvironmentMap;
164 /// Known TeX commands with arguments that get parsed into ERT.
165 extern CommandMap known_commands;
166 /// Known TeX environments with arguments that get parsed into ERT.
167 extern CommandMap known_environments;
168 /// Known TeX math environments with arguments that get parsed into LyX mathed.
169 extern CommandMap known_math_environments;
170 /// Commands that might be defined by the document class or modules
171 extern FullCommandMap possible_textclass_commands;
172 /// Environments that might be defined by the document class or modules
173 extern FullEnvironmentMap possible_textclass_environments;
174 /// Theorems that might be defined by the document class or modules
175 extern FullCommandMap possible_textclass_theorems;
177 extern bool noweb_mode;
178 /// Did we recognize any pdflatex-only construct?
179 extern bool pdflatex;
180 /// Did we recognize any xetex-only construct?
182 /// Do we have non-CJK Japanese?
183 extern bool is_nonCJKJapanese;
184 /// LyX format that is created by tex2lyx
185 extern int const LYX_FORMAT;
187 /// Absolute path of the master .lyx or .tex file
188 extern std::string getMasterFilePath(bool input);
189 /// Absolute path of the currently processed .lyx or .tex file
190 extern std::string getParentFilePath(bool input);
191 /// Is it allowed to overwrite existing files?
192 extern bool overwriteFiles();
193 /// Do we need to copy included files to the output directory?
194 extern bool copyFiles();
195 /// Shall we skip child documents and keep them as TeX?
196 extern bool skipChildren();
197 /// Does tex2lyx run in roundtrip mode?
198 extern bool roundtripMode();
202 * Reads tex input from \a infilename and writes lyx output to \a outfilename.
203 * The iconv name of the encoding can be provided as \a encoding.
204 * Uses some common settings for the preamble, so this should only
205 * be used more than once for included documents.
206 * Caution: Overwrites the existing preamble settings if the new document
207 * contains a preamble.
208 * \return true if the conversion was successful, else false.
210 bool tex2lyx(std::string const & infilename,
211 support::FileName const & outfilename,
212 std::string const & encoding);