]> git.lyx.org Git - lyx.git/blobdiff - src/output_xhtml.h
Automatically show the review toolbar if the document has tracked changes
[lyx.git] / src / output_xhtml.h
index 0bcc9849c0e354c9781cfcccdbe4bc7e06000589..473ebe335a41a744e83663c22aab32fefdf1de8e 100644 (file)
@@ -31,6 +31,9 @@ class Text;
 
 namespace html {
 
+struct FontTag;
+struct EndFontTag;
+
 /// Attributes will be escaped automatically and so should NOT
 /// be escaped before being passed to the constructor.
 struct StartTag
@@ -38,22 +41,26 @@ struct StartTag
        ///
        explicit StartTag(std::string const & tag) : tag_(tag), keepempty_(false) {}
        ///
-       explicit StartTag(std::string const & tag, std::string const & attr, 
-               bool keepempty = false) 
+       explicit StartTag(std::string const & tag, std::string const & attr,
+               bool keepempty = false)
                : tag_(tag), attr_(attr), keepempty_(keepempty) {}
        ///
-       ~StartTag() {}
+       virtual ~StartTag() {}
        /// <tag_ attr_>
-       virtual docstring asTag() const;
+       virtual docstring writeTag() const;
        /// </tag_>
-       virtual docstring asEndTag() const;
+       virtual docstring writeEndTag() const;
        ///
-       bool operator==(StartTag const & rhs) const
+       virtual FontTag const * asFontTag() const { return 0; }
+       ///
+       virtual bool operator==(StartTag const & rhs) const
                { return tag_ == rhs.tag_; }
        ///
-       bool operator!=(StartTag const & rhs) const
+       virtual bool operator!=(StartTag const & rhs) const
                { return !(*this == rhs); }
        ///
+       virtual bool operator==(FontTag const & rhs) const;
+       ///
        std::string tag_;
        ///
        std::string attr_;
@@ -63,6 +70,48 @@ struct StartTag
 };
 
 
+///
+struct EndTag
+{
+       ///
+       explicit EndTag(std::string tag) : tag_(tag) {}
+       ///
+       virtual ~EndTag() {}
+       /// </tag_>
+       virtual docstring writeEndTag() const;
+       ///
+       bool operator==(StartTag const & rhs) const
+               { return tag_ == rhs.tag_; }
+       ///
+       bool operator!=(StartTag const & rhs) const
+               { return !(*this == rhs); }
+       ///
+       virtual EndFontTag const * asFontTag() const { return 0; }
+       ///
+       std::string tag_;
+};
+
+
+/// Tags like <img />
+/// Attributes will be escaped automatically and so should NOT
+/// be escaped before being passed to the constructor.
+struct CompTag
+{
+       ///
+       explicit CompTag(std::string const & tag)
+               : tag_(tag) {}
+       ///
+       explicit CompTag(std::string const & tag, std::string const & attr)
+               : tag_(tag), attr_(attr) {}
+       /// <tag_ attr_ />
+       docstring writeTag() const;
+       ///
+       std::string tag_;
+       ///
+       std::string attr_;
+};
+
+
 /// A special case of StartTag, used exclusively for tags that wrap paragraphs.
 struct ParTag : public StartTag
 {
@@ -74,7 +123,7 @@ struct ParTag : public StartTag
        ///
        ~ParTag() {}
        ///
-       docstring asTag() const;
+       docstring writeTag() const;
        /// the "magic par label" for this paragraph
        std::string parid_;
 };
@@ -82,20 +131,37 @@ struct ParTag : public StartTag
 
 ///
 enum FontTypes {
+       // ranges
        FT_EMPH,
-       FT_BOLD,
        FT_NOUN,
        FT_UBAR,
        FT_DBAR,
-       FT_SOUT,
        FT_WAVE,
+       FT_SOUT,
+       // bold
+       FT_BOLD,
+       // shapes
+       FT_UPRIGHT,
        FT_ITALIC,
        FT_SLANTED,
        FT_SMALLCAPS,
+       // families
        FT_ROMAN,
        FT_SANS,
-       FT_TYPER
-       // SIZES?
+       FT_TYPE,
+       // sizes
+       FT_SIZE_TINY,
+       FT_SIZE_SCRIPT,
+       FT_SIZE_FOOTNOTE,
+       FT_SIZE_SMALL,
+       FT_SIZE_NORMAL,
+       FT_SIZE_LARGE,
+       FT_SIZE_LARGER,
+       FT_SIZE_LARGEST,
+       FT_SIZE_HUGE,
+       FT_SIZE_HUGER,
+       FT_SIZE_INCREASE,
+       FT_SIZE_DECREASE
 };
 
 
@@ -105,56 +171,23 @@ struct FontTag : public StartTag
        ///
        explicit FontTag(FontTypes type);
        ///
-       docstring asTag() const;
-       ///
-       docstring asEndTag() const;
-       ///
-       bool isFontTag() { return true; }
+       FontTag const * asFontTag() const { return this; }
        ///
-       bool operator==(FontTag const & rhs)
-               { return font_type_ == rhs.font_type_; }
-       /// Asserts.
-       bool operator==(StartTag const &);
+       bool operator==(StartTag const &) const;
        ///
        FontTypes font_type_;
 };
 
 
 ///
-struct EndTag
-{
-       ///
-       explicit EndTag(std::string tag) : tag_(tag) {}
-       /// </tag_>
-       docstring asEndTag() const;
-       ///
-       bool operator==(StartTag const & rhs) const
-               { return tag_ == rhs.tag_; }
-       ///
-       bool operator!=(StartTag const & rhs) const
-               { return !(*this == rhs); }
-       ///
-       std::string tag_;
-};
-
-
-/// Tags like <img />
-/// Attributes will be escaped automatically and so should NOT
-/// be escaped before being passed to the constructor.
-struct CompTag
+struct EndFontTag : public EndTag
 {
        ///
-       explicit CompTag(std::string const & tag)
-               : tag_(tag) {}
-       ///
-       explicit CompTag(std::string const & tag, std::string const & attr)
-               : tag_(tag), attr_(attr) {}
-       /// <tag_ attr_ />
-       docstring asTag() const;
+       explicit EndFontTag(FontTypes type);
        ///
-       std::string tag_;
+       EndFontTag const * asFontTag() const { return this; }
        ///
-       std::string attr_;
+       FontTypes font_type_;
 };
 
 
@@ -177,10 +210,10 @@ public:
        /// because they are "blocked" by open non-font tags on the stack.
        bool closeFontTags();
        /// call at start of paragraph. sets a mark so we know what tags
-       /// to close at the end. 
+       /// to close at the end.
        void startParagraph(bool keep_empty);
        /// call at end of paragraph to clear that mark. note that this
-       /// will also close any tags still open. 
+       /// will also close any tags still open.
        void endParagraph();
        ///
        XHTMLStream & operator<<(docstring const &);
@@ -201,6 +234,8 @@ public:
        ///
        XHTMLStream & operator<<(html::ParTag const &);
        ///
+       XHTMLStream & operator<<(html::FontTag const &);
+       ///
        XHTMLStream & operator<<(html::CR const &);
        ///
        enum EscapeSettings {
@@ -230,11 +265,11 @@ private:
        void writeError(std::string const &) const;
        ///
        odocstream & os_;
-       /// 
+       ///
        EscapeSettings escape_;
        // What we would really like to do here is simply use a
        // deque<StartTag>. But we want to store both StartTags and
-       // sub-classes thereof on this stack, which means we run into the 
+       // sub-classes thereof on this stack, which means we run into the
        // so-called polymorphic class problem with the STL. We therefore have
        // to use a deque<StartTag *>, which leads to the question who will
        // own these pointers and how they will be deleted, so we use shared
@@ -243,8 +278,8 @@ private:
        typedef shared_ptr<html::StartTag> TagPtr;
        typedef std::deque<TagPtr> TagDeque;
        ///
-       template <typename T> 
-       shared_ptr<T> makeTagPtr(T const & tag) 
+       template <typename T>
+       shared_ptr<T> makeTagPtr(T const & tag)
                { return shared_ptr<T>(new T(tag)); }
        ///
        TagDeque pending_tags_;
@@ -270,12 +305,8 @@ docstring htmlize(docstring const & str, XHTMLStream::EscapeSettings e);
 /// cleans \param str for use as an atttribute by replacing
 /// all non-alnum by "_"
 docstring cleanAttr(docstring const & str);
-///
-std::string escapeChar(char c, XHTMLStream::EscapeSettings e);
-/// 
-std::string htmlize(std::string const & str, XHTMLStream::EscapeSettings e);
-/// 
-std::string cleanAttr(std::string const & str);
+/// \p c must be ASCII
+docstring escapeChar(char c, XHTMLStream::EscapeSettings e);
 
 } // namespace html
 } // namespace lyx