-// 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) {}
- /// <tag_ attr_>
- docstring asTag() const;
- /// </tag_>
- docstring asEndTag() const;
- ///
- std::string tag_;
- ///
- std::string attr_;
- /// whether to keep things like "<tag></tag>" 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) {}
- /// </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 <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 asTag() const;
- ///
- std::string tag_;
- ///
- std::string attr_;
-};
-
-// trivial struct for output of newlines
-struct CR{};
-
-} // namespace html
-
-class XHTMLStream {
-public:
- ///
- explicit XHTMLStream(odocstream & os);
- ///
- 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();
- /// call at start of paragraph. sets a mark so we know what tags
- /// 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.
- void endParagraph();
- ///
- 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 &);
- ///
- 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);
-#if 0
- /// This routine is for debugging the tag stack, etc. Code
- /// for it is disabled by default, however, so you will need
- /// to enable it if you want to use it.
- void dumpTagStack(std::string const & msg) const;
-#endif
-private:
- ///
- void clearTagDeque();
- ///
- bool isTagOpen(std::string const &) const;
- ///
- bool isTagPending(std::string const &) const;
- ///
- void writeError(std::string const &) const;
- ///
- odocstream & os_;
- ///
- typedef std::deque<html::StartTag> 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_;
-};