X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ftex2lyx%2Ftex2lyx.h;h=37585fddf4bd5cae34def45cfd801474a1ee5b56;hb=7c6ae4d7401639ac0dd2eb83b0c1b7c61b0b8c13;hp=b6ff734132440bd98c5249bd0b4fb8b443895390;hpb=b38d210152d3297af0e152d1ee432f71d7797abb;p=lyx.git diff --git a/src/tex2lyx/tex2lyx.h b/src/tex2lyx/tex2lyx.h index b6ff734132..37585fddf4 100644 --- a/src/tex2lyx/tex2lyx.h +++ b/src/tex2lyx/tex2lyx.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author André Pönitz + * \author André Pönitz * \author Jean-Marc Lasgouttes * * Full author contact details are available in file CREDITS. @@ -13,46 +13,76 @@ #ifndef TEX2LYX_H #define TEX2LYX_H -#include "texparser.h" -#include "lyxtextclass.h" +#include "Parser.h" +#include "TextClass.h" #include #include #include #include + +namespace lyx { + +namespace support { class FileName; } + +/// Simple support for frontend::Alert::warning(). +namespace frontend { +namespace Alert { + void warning(docstring const & title, docstring const & message, + bool const &); +} +} + class Context; -/// in preamble.C -LyXTextClass const parse_preamble(Parser & p, std::ostream & os, std::string const & forceclass); +/// A trivial subclass, just to give us a public default constructor +class TeX2LyXDocClass : public DocumentClass +{ +public: + void setName(std::string const & name) { name_ = name; } +}; -/// used packages with options -extern std::map > used_packages; +/// Translate babel language name to LyX language name +extern std::string babel2lyx(std::string const & language); +/// Translate polyglossia language name to LyX language name +extern std::string polyglossia2lyx(std::string const & language); +/// Translate basic color name or RGB color in LaTeX syntax to LyX color code +extern std::string rgbcolor2code(std::string const & name); +/// in text.cpp +std::string translate_len(std::string const &); -/// in text.C void parse_text(Parser & p, std::ostream & os, unsigned flags, bool outer, Context & context); -//std::string parse_text(Parser & p, unsigned flags, const bool outer, -// Context & context); - -/// parses a subdocument, usually useful in insets (whence the name) +/*! + * 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 & context); + bool outer, Context const & context, + InsetLayout const * layout = 0); + +/// Guess document language from \p p if CJK is used. +/// \p lang is used for all non-CJK contents. +std::string guessLanguage(Parser & p, std::string const & lang); -/// in math.C +/// in math.cpp void parse_math(Parser & p, std::ostream & os, unsigned flags, mode_type mode); -/// in table.C -void handle_tabular(Parser & p, std::ostream & os, bool is_long_tabular, - Context & context); +/// in table.cpp +void handle_tabular(Parser & p, std::ostream & os, std::string const & name, + std::string const & width, Context & context); -/// in tex2lyx.C -std::string const trim(std::string const & a, char const * p = " \t\n\r"); +/// in tex2lyx.cpp +std::string const trimSpaceAndEol(std::string const & a); void split(std::string const & s, std::vector & result, char delim = ','); @@ -60,28 +90,69 @@ std::string join(std::vector const & input, char const * delim); bool is_math_env(std::string const & name); +bool is_display_math_env(std::string const & name); 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 + * \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 + * \param o2 wether \\newcommand had a second optional parameter. + * If \p definition is not empty the command is assumed to be from the LyX + * preamble and added to possible_textclass_commands. */ void add_known_command(std::string const & command, std::string const & o1, - bool o2); - + bool o2, docstring const & definition = docstring()); +extern void add_known_environment(std::string const & environment, + std::string const & o1, bool o2, docstring const & beg, + docstring const & end); +extern Layout const * findLayoutWithoutModule(TextClass const & textclass, + std::string const & name, bool command); +extern InsetLayout const * findInsetLayoutWithoutModule( + TextClass const & textclass, std::string const & name, bool command); +/*! + * Check whether a module provides command (if \p command is true) or + * environment (if \p command is false) \p name, and add the module to the + * list of used modules if yes. + */ +extern bool checkModule(std::string const & name, bool command); // Access to environment stack extern std::vector active_environments; std::string active_environment(); enum ArgumentType { required, + req_group, verbatim, - optional + item, + optional, + opt_group, + displaymath, +}; + +class FullCommand { +public: + FullCommand() {} + FullCommand(std::vector const & a, docstring const & d) + : args(a), def(d) {} + std::vector args; + docstring def; +}; + +class FullEnvironment { +public: + FullEnvironment() {} + FullEnvironment(std::vector const & a, + docstring const & b, docstring const & e) + : args(a), beg(b), end(e) {} + std::vector args; + docstring beg; + docstring end; }; typedef std::map > CommandMap; +typedef std::map FullCommandMap; +typedef std::map FullEnvironmentMap; /// Known TeX commands with arguments that get parsed into ERT. extern CommandMap known_commands; @@ -89,21 +160,47 @@ extern CommandMap known_commands; extern CommandMap known_environments; /// Known TeX math environments with arguments that get parsed into LyX mathed. extern CommandMap known_math_environments; - -/// path of the master .tex file -extern std::string getMasterFilePath(); -/// path of the currently processed .tex file -extern std::string getParentFilePath(); +/// Commands that might be defined by the document class or modules +extern FullCommandMap possible_textclass_commands; +/// Environments that might be defined by the document class or modules +extern FullEnvironmentMap possible_textclass_environments; +/// +extern bool noweb_mode; +/// Did we recognize any pdflatex-only construct? +extern bool pdflatex; +/// Did we recognize any xetex-only construct? +extern bool xetex; +/// Do we have non-CJK Japanese? +extern bool is_nonCJKJapanese; +/// LyX format that is created by tex2lyx +extern int const LYX_FORMAT; + +/// Absolute path of the master .lyx or .tex file +extern std::string getMasterFilePath(bool input); +/// Absolute path of the currently processed .lyx or .tex file +extern std::string getParentFilePath(bool input); +/// Is it allowed to overwrite existing files? +extern bool overwriteFiles(); +/// Do we need to copy included files to the output directory? +extern bool copyFiles(); +/// Shall we skip child documents and keep them as TeX? +extern bool skipChildren(); /*! * Reads tex input from \a infilename and writes lyx output to \a outfilename. + * The (latex) encoding can be provided as \a encoding. * 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, std::string const & outfilename); +bool tex2lyx(std::string const & infilename, + support::FileName const & outfilename, + std::string const & encoding); + + +} // namespace lyx #endif