X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetQuotes.h;h=41bad175b8157c342829b302e17e038bfdd4baa6;hb=9e308ddb0323719152d97371e0ab0ee80c318010;hp=93ed979cb54f21d89885bd6c24cf07612300bcda;hpb=db8c16d554ebb1dcb319e44d318572de6eff024b;p=lyx.git diff --git a/src/insets/InsetQuotes.h b/src/insets/InsetQuotes.h index 93ed979cb5..41bad175b8 100644 --- a/src/insets/InsetQuotes.h +++ b/src/insets/InsetQuotes.h @@ -5,6 +5,7 @@ * Licence details can be found in the file COPYING. * * \author Jean-Marc Lasgouttes + * \author Jürgen Spitzmüller * * Full author contact details are available in file CREDITS. */ @@ -12,54 +13,113 @@ #ifndef INSET_QUOTES_H #define INSET_QUOTES_H - #include "Inset.h" -#include "support/types.h" +#include namespace lyx { -class BufferParams; -class Language; -class LaTeXFeatures; +/// +enum class QuoteStyle : int { + /// + English, + /// + Swedish, + /// + German, + /// + Polish, + /// + Swiss, + /// + Danish, + /// + Plain, + /// + British, + /// + SwedishG, + /// + French, + /// + FrenchIN, + /// + Russian, + /// + CJK, + /// + CJKAngle, + /// + Hungarian, + /// + Dynamic +}; + +/// +enum class QuoteSide : int { + /// + Opening, + /// + Closing +}; + +/// +enum class QuoteLevel : int { + /// + Secondary, + /// + Primary +}; /** Quotes. Used for the various quotes. German, English, French, all either double or single **/ -class InsetQuotes : public Inset { +class InsetQuotesParams { public: - /// - enum quote_language { - /// - EnglishQ, - /// - SwedishQ, - /// - GermanQ, - /// - PolishQ, - /// - FrenchQ, - /// - DanishQ - }; - /// - enum quote_side { - /// - LeftQ, - /// - RightQ - }; - /// - enum quote_times { - /// - SingleQ, - /// - DoubleQ - }; + /// Returns the unicode character of a given quote + char_type getQuoteChar(QuoteStyle const &, QuoteLevel const &, + QuoteSide const &, bool const rtl = false) const; + /// Returns a map of quotation marks + std::map getTypes() const; + /// + docstring getLaTeXQuote(char_type c, std::string const &, + bool const rtl = false) const; + /// + docstring getXMLQuote(char_type c) const; + /// Returns a descriptive label of a style suitable for dialog and menu + docstring const getGuiLabel(QuoteStyle const & qs, + bool langdef = false) const; + /// Returns a descriptive label of a given char + docstring const getShortGuiLabel(docstring const & str) const; + /// + int stylescount() const; + /// Returns the matching style shortcut char + char getStyleChar(QuoteStyle const & style) const; + /// Returns the quote style from the shortcut string + QuoteStyle getQuoteStyle(std::string const & s, + bool const allow_wildcards = false, + QuoteStyle fallback = QuoteStyle::English) const; + /// Returns the quote sind from the shortcut string + QuoteSide getQuoteSide(std::string const & s, + bool const allow_wildcards = false, + QuoteSide fallback = QuoteSide::Opening) const; + /// Returns the quote level from the shortcut string + QuoteLevel getQuoteLevel(std::string const & s, + bool const allow_wildcards = false, + QuoteLevel fallback = QuoteLevel::Primary) const; +}; + +/// +extern InsetQuotesParams quoteparams; +/** Quotes. + Used for the various quotes. German, English, French, all either + double or single **/ +class InsetQuotes : public Inset +{ +public: /** The constructor works like this: \begin{itemize} \item fls <- french single quote left @@ -67,59 +127,100 @@ public: \item etc. \end{itemize} */ - explicit InsetQuotes(std::string const & str = "eld"); - /// Create the right quote inset after character c - InsetQuotes(char_type c, BufferParams const & params); + explicit InsetQuotes(Buffer * buf, std::string const & str = "eld"); /// Direct access to inner/outer quotation marks - InsetQuotes(char_type c, quote_language l, quote_times t); + InsetQuotes(Buffer * buf, char_type c, QuoteLevel level, + std::string const & side = std::string(), + std::string const & style = std::string()); + /// + docstring layoutName() const override; + /// + void metrics(MetricsInfo &, Dimension &) const override; /// - docstring name() const; + void draw(PainterInfo & pi, int x, int y) const override; /// - void metrics(MetricsInfo &, Dimension &) const; + void write(std::ostream &) const override; /// - void draw(PainterInfo & pi, int x, int y) const; + void read(Lexer & lex) override; /// - void write(std::ostream &) const; + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override; /// - void read(Lexer & lex); + void latex(otexstream &, OutputParams const &) const override; /// - int latex(odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const override; /// - int plaintext(odocstream &, OutputParams const &) const; + void docbook(XMLStream &, OutputParams const &) const override; /// - int docbook(odocstream &, OutputParams const &) const; + docstring xhtml(XMLStream &, OutputParams const &) const override; - /// the string that is passed to the TOC - void textString(odocstream &) const; + /// + bool hasToString() const override { return true; } + /// + void toString(odocstream &) const override; + /// + void forOutliner(docstring &, size_t const maxlen, bool const) const override; + /// Update the contextual information of this inset + void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override; + + /// + void validate(LaTeXFeatures &) const override; /// - void validate(LaTeXFeatures &) const; + std::string contextMenuName() const override; /// - InsetCode lyxCode() const { return QUOTE_CODE; } + InsetCode lyxCode() const override { return QUOTE_CODE; } /// should this inset be handled like a normal character - bool isChar() const { return true; } + bool isChar() const override { return true; } + + /// Returns the current quote type + std::string getType() const; + /// + std::pair isWords() const override; private: /// - Inset * clone() const; + Inset * clone() const override { return new InsetQuotes(*this); } + /// Decide whether we need left or right quotation marks + void setSide(char_type c); + /// + void parseString(std::string const &, + bool const allow_wildcards = false); /// - quote_language language_; + docstring displayString() const; /// - quote_side side_; + docstring getQuoteXMLEntity() const; /// - quote_times times_; + QuoteStyle getStyle(std::string const &); - /** The parameters of the constructor are the language, the - side and the multiplicity of the quote. - */ - InsetQuotes(quote_language l, quote_side s, quote_times t); - /// Decide whether we need left or right quotation marks - void getPosition(char_type c); /// - void parseString(std::string const &); + QuoteStyle style_ = QuoteStyle::English; + /// + QuoteSide side_ = QuoteSide::Opening; + /// + QuoteLevel level_ = QuoteLevel::Primary; + /// + QuoteStyle global_style_ = QuoteStyle::English; + /// Code of the contextual language + std::string context_lang_; + /// Is this in a pass-thru context? + bool pass_thru_ = false; + /// Do we use fontspec? + bool fontspec_ = false; + /// Do we have an internal font encoding? + bool internal_fontenc_ = false; + /// Are we writing RTL? + bool rtl_ = false; + /// + friend class InsetQuotesParams; + +protected: + /// \name Protected functions inherited from Inset class + //@{ /// - docstring dispString() const; + void doDispatch(Cursor & cur, FuncRequest & cmd) override; + //@} }; } // namespace lyx