X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.h;h=986070ddd6745155144f5afcb119ff60ef0547f9;hb=a3c84666b2dbfc75c9a80cf4f94612149cb2b570;hp=09d58ea16734aee2980066a6d10e0adfe35d0400;hpb=62b624031047eb2eae8d09bde05a65baff2ea69a;p=lyx.git diff --git a/src/output_xhtml.h b/src/output_xhtml.h index 09d58ea167..986070ddd6 100644 --- a/src/output_xhtml.h +++ b/src/output_xhtml.h @@ -12,7 +12,9 @@ #ifndef OUTPUT_XHTML_H #define OUTPUT_XHTML_H +#include "LayoutEnums.h" #include "support/docstream.h" +#include "support/strfwd.h" #include #include @@ -23,11 +25,23 @@ class Buffer; class OutputParams; class Text; +// Inspiration for the *Tag structs and for XHTMLStream +// came from MathStream and its cousins. + +namespace html { +/// Attributes will be escaped automatically and so should NOT +/// be escaped before being passed to the constructor. struct StartTag { /// - StartTag(std::string const & tag, std::string const & attr, + explicit StartTag(std::string const & tag) : tag_(tag), keepempty_(false) {} + /// + explicit StartTag(std::string const & tag, std::string const & attr, bool keepempty = false) : tag_(tag), attr_(attr), keepempty_(keepempty) {} + /// + docstring asTag() const; + /// + docstring asEndTag() const; /// std::string tag_; /// @@ -40,23 +54,37 @@ struct StartTag { struct EndTag { /// - EndTag(std::string tag) : tag_(tag) {} + explicit EndTag(std::string tag) : tag_(tag) {} + /// + docstring asEndTag() const; /// std::string tag_; }; -// Tags like +// FIXME XHTML +// We need to allow these to be deferrable, which means it should +// inherit from StartTag. This is probably better, anyway, but we'll +// need to re-work a bit of code.... +/// Tags like +/// Attributes will be escaped automatically and so should NOT +/// be escaped before being passed to the constructor. struct CompTag { /// - CompTag(std::string const & tag, std::string const & attr) + explicit CompTag(std::string const & tag) + : tag_(tag) {} + /// + explicit CompTag(std::string const & tag, std::string const & attr) : tag_(tag), attr_(attr) {} + /// + docstring asTag() const; /// std::string tag_; /// std::string attr_; }; +} // namespace html class XHTMLStream { public: @@ -76,49 +104,74 @@ public: /// XHTMLStream & operator<<(docstring const &); /// - //XHTMLStream & operator<<(char_type); + XHTMLStream & operator<<(const char *); + /// + XHTMLStream & operator<<(char_type); + /// + XHTMLStream & operator<<(int); /// - XHTMLStream & operator<<(StartTag const &); + XHTMLStream & operator<<(char); /// - XHTMLStream & operator<<(EndTag const &); + XHTMLStream & operator<<(html::StartTag const &); /// - XHTMLStream & operator<<(CompTag const &); + XHTMLStream & operator<<(html::EndTag const &); + /// + XHTMLStream & operator<<(html::CompTag const &); + /// A trivial struct that functions as a stream modifier. + /// << NextRaw() causes the next string-like thing sent to the + /// stream not to be escaped. + struct NextRaw {}; + /// + XHTMLStream & operator<<(NextRaw const &); private: /// void clearTagDeque(); /// bool isTagOpen(std::string const &); /// + void writeError(std::string const &); + /// odocstream & os_; /// // int tab_; /// - typedef std::deque TagDeque; + typedef std::deque TagDeque; /// - typedef std::vector TagStack; + typedef std::vector TagStack; /// holds start tags until we know there is content in them. TagDeque pending_tags_; /// remembers the history, so we can make sure we nest properly. TagStack tag_stack_; + /// + bool nextraw_; }; /// void xhtmlParagraphs(Text const & text, Buffer const & buf, - odocstream & os, + XHTMLStream & xs, OutputParams const & runparams); +/// \return a string appropriate for setting alignment in CSS +/// Does NOT return "justify" for "block" +std::string alignmentToCSS(LyXAlignment align); + namespace html { /// docstring escapeChar(char_type c); /// converts a string to a form safe for links, etc docstring htmlize(docstring const & str); -/// \return true if tag was opened, false if not -bool openTag(odocstream & os, std::string const & tag, - std::string const & attr); -/// \return true if tag was opened, false if not -bool closeTag(odocstream & os, std::string const & tag); -} +/// cleans \param str for use as an atttribute by replacing +/// all non-alnum by "_" +docstring cleanAttr(docstring const & str); +/// +std::string escapeChar(char c); +/// +std::string htmlize(std::string const & str); +/// +std::string cleanAttr(std::string const & str); + +} // namespace html } // namespace lyx #endif