X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Foutput_xhtml.h;h=4c389bd0aabfa1683d4b713c74262b12dda71c7a;hb=7dda20bc9d7305648973867b388eed5fa22fde21;hp=f0e1578d1558a0baf36eba6ed9c603da8536513a;hpb=c5651b5e445639e78b916fd11f8a644c280b8a5d;p=lyx.git diff --git a/src/output_xhtml.h b/src/output_xhtml.h index f0e1578d15..4c389bd0aa 100644 --- a/src/output_xhtml.h +++ b/src/output_xhtml.h @@ -12,10 +12,11 @@ #ifndef OUTPUT_XHTML_H #define OUTPUT_XHTML_H +#include "LayoutEnums.h" #include "support/docstream.h" +#include "support/strfwd.h" #include -#include namespace lyx { @@ -26,11 +27,14 @@ 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) : tag_(tag) {} + explicit StartTag(std::string const & tag) : tag_(tag), keepempty_(false) {} /// - StartTag(std::string const & tag, std::string const & attr, + explicit StartTag(std::string const & tag, std::string const & attr, bool keepempty = false) : tag_(tag), attr_(attr), keepempty_(keepempty) {} /// @@ -49,7 +53,7 @@ struct StartTag { struct EndTag { /// - EndTag(std::string tag) : tag_(tag) {} + explicit EndTag(std::string tag) : tag_(tag) {} /// docstring asEndTag() const; /// @@ -57,10 +61,19 @@ struct EndTag { }; -// 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; @@ -70,14 +83,16 @@ struct CompTag { std::string attr_; }; +// trivial struct for output of newlines +struct CR{}; + +} // namespace html class XHTMLStream { public: /// explicit XHTMLStream(odocstream & os); /// - void cr(); - /// odocstream & os() { return os_; } /// // int & tab() { return tab_; } @@ -86,6 +101,12 @@ public: /// \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(); + /// call at start of paragraph. sets a mark so we know what tags + /// to close at the end. + void startParagraph(); + /// call at end of paragraph to clear that mark. note that this + /// will also close any tags still open. + void endParagraph(); /// XHTMLStream & operator<<(docstring const &); /// @@ -93,11 +114,26 @@ public: /// XHTMLStream & operator<<(char_type); /// - XHTMLStream & operator<<(StartTag const &); + XHTMLStream & operator<<(int); + /// + XHTMLStream & operator<<(char); + /// + XHTMLStream & operator<<(html::StartTag const &); + /// + XHTMLStream & operator<<(html::EndTag const &); /// - XHTMLStream & operator<<(EndTag const &); + XHTMLStream & operator<<(html::CompTag const &); /// - XHTMLStream & operator<<(CompTag const &); + XHTMLStream & operator<<(html::CR 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(); @@ -108,15 +144,13 @@ private: /// odocstream & os_; /// - // int tab_; - /// - typedef std::deque TagDeque; - /// - typedef std::vector TagStack; + typedef std::deque TagStack; /// holds start tags until we know there is content in them. - TagDeque pending_tags_; + TagStack pending_tags_; /// remembers the history, so we can make sure we nest properly. TagStack tag_stack_; + /// + EscapeSettings escape_; }; /// @@ -125,19 +159,26 @@ void xhtmlParagraphs(Text const & text, 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); - -// 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); -} +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