X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.h;h=94bdf0bd2b7f643fbf18802175444dfa6550323b;hb=c20e885331c9bba720e386985d0e7bcdb5bf8b9c;hp=e58e4a8db49f2f4720a921d85da0ed5c2a47d755;hpb=32fabb3f6ae58033290bcb2fea553fa5f97249c6;p=lyx.git diff --git a/src/output_xhtml.h b/src/output_xhtml.h index e58e4a8db4..94bdf0bd2b 100644 --- a/src/output_xhtml.h +++ b/src/output_xhtml.h @@ -12,23 +12,164 @@ #ifndef OUTPUT_XHTML_H #define OUTPUT_XHTML_H +#include "LayoutEnums.h" +#include "support/docstream.h" #include "support/strfwd.h" +#include + namespace lyx { class Buffer; class OutputParams; -class ParagraphList; +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 { + /// + 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_; + /// + 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_; +}; + + +// 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 { + /// + 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: + /// + 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<<(int); + /// + XHTMLStream & operator<<(char); + /// + XHTMLStream & operator<<(html::StartTag const &); + /// + XHTMLStream & operator<<(html::EndTag const &); + /// + XHTMLStream & operator<<(html::CompTag const &); + /// + enum EscapeSettings { + ESCAPE_NONE, + ESCAPE_AND, // meaning & + ESCAPE_ALL // meaning <, >, &, at present + }; + /// Sets what we are going to escape on the NEXT write. + /// Everything is reset for the next time. + XHTMLStream & operator<<(EscapeSettings); +private: + /// + void clearTagDeque(); + /// + bool isTagOpen(std::string const &); + /// + void writeError(std::string const &); + /// + odocstream & os_; + /// + typedef std::deque TagStack; + /// holds start tags until we know there is content in them. + TagStack pending_tags_; + /// remembers the history, so we can make sure we nest properly. + TagStack tag_stack_; + /// + EscapeSettings escape_; +}; /// -void xhtmlParagraphs(ParagraphList const & subset, +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); -} +/// +docstring escapeChar(char_type c, XHTMLStream::EscapeSettings e); +/// converts a string to a form safe for links, etc +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); + +} // namespace html } // namespace lyx #endif