X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.h;h=de88282a8044a773f03a3cf8fb956a6988d8d770;hb=2098f1d8c20d51e63e670bcdc9da8996068975bf;hp=a3b8eb824e90468b7b5c75d337312b1db3eeee04;hpb=8c053ea10ce1187499bc112ae88d04d956ae48f9;p=lyx.git diff --git a/src/output_xhtml.h b/src/output_xhtml.h index a3b8eb824e..de88282a80 100644 --- a/src/output_xhtml.h +++ b/src/output_xhtml.h @@ -12,30 +12,156 @@ #ifndef OUTPUT_XHTML_H #define OUTPUT_XHTML_H +#include "support/docstream.h" #include "support/strfwd.h" +#include +#include + namespace lyx { class Buffer; class OutputParams; class Text; +// Inspiration for the *Tag structs and for XHTMLStream +// came from MathStream and its cousins. + +/// Attributes will be escaped automatically and so should NOT +/// be escaped before passing to the constructor. +struct StartTag { + /// + explicit StartTag(std::string const & tag) : tag_(tag) {} + /// + 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_; + /// + std::string attr_; + /// whether to keep things like "" or discard them + /// you would want this for td, e.g, but maybe not for a div + bool keepempty_; +}; + + +struct EndTag { + /// + explicit EndTag(std::string tag) : tag_(tag) {} + /// + docstring asEndTag() const; + /// + std::string tag_; +}; + + +/// Tags like +/// Attributes will be escaped automatically and so should NOT +/// be escaped before passing 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) {} + /// + docstring asTag() const; + /// + std::string tag_; + /// + std::string attr_; +}; + + +class XHTMLStream { +public: + /// + explicit XHTMLStream(odocstream & os); + /// + void cr(); + /// + odocstream & os() { return os_; } + /// + // int & tab() { return tab_; } + /// closes any font tags that are eligible to be closed, + /// i.e., last on the tag_stack_. + /// \return false if there are open font tags we could not close. + /// because they are "blocked" by open non-font tags on the stack. + bool closeFontTags(); + /// + XHTMLStream & operator<<(docstring const &); + /// + XHTMLStream & operator<<(const char *); + /// + XHTMLStream & operator<<(char_type); + /// + XHTMLStream & operator<<(StartTag const &); + /// + XHTMLStream & operator<<(EndTag const &); + /// + XHTMLStream & operator<<(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::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); 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); +/// +docstring escapeChar(char_type c); +/// converts a string to a form safe for links, etc +docstring htmlize(docstring const & str); +/// 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); + +// to be removed +/// \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); } } // namespace lyx