Routines for calculating numerical labels for BibTeX citations.

[lyx.git] / src / output_xhtml.h

diff --git a/src/output_xhtml.h b/src/output_xhtml.h
index 70c7f55bff607a8384b981d140048fd47b20dc5f..de88282a8044a773f03a3cf8fb956a6988d8d770 100644 (file)
--- a/src/output_xhtml.h
+++ b/src/output_xhtml.h
@@ -13,6 +13,7 @@
 #define OUTPUT_XHTML_H
 
 #include "support/docstream.h"
+#include "support/strfwd.h"
 
 #include <deque>
 #include <vector>
@@ -23,18 +24,22 @@ class Buffer;
 class OutputParams;
 class Text;
 
-///
-void xhtmlParagraphs(Text const & text,
-                      Buffer const & buf,
-                      odocstream & os,
-                      OutputParams const & runparams);
+// 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 passing to the constructor.
 struct StartTag {
        ///
-       StartTag(std::string const & tag, std::string const & attr, 
+       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) {}
+       /// <tag_ attr_>
+       docstring asTag() const;
+       /// </tag_>
+       docstring asEndTag() const;
        ///
        std::string tag_;
        ///
@@ -47,17 +52,26 @@ struct StartTag {
 
 struct EndTag {
        ///
-       EndTag(std::string tag) : tag_(tag) {}
+       explicit EndTag(std::string tag) : tag_(tag) {}
+       /// </tag_>
+       docstring asEndTag() const;
        ///
        std::string tag_;
 };
 
 
-// Tags like <img />
+/// Tags like <img />
+/// Attributes will be escaped automatically and so should NOT
+/// be escaped before passing 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) {}
+       /// <tag_ attr_ />
+       docstring asTag() const;
        ///
        std::string tag_;
        ///
@@ -83,19 +97,29 @@ public:
        ///
        XHTMLStream & operator<<(docstring const &);
        ///
-       //XHTMLStream & operator<<(char_type);
+       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_;
@@ -107,13 +131,32 @@ private:
        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,
+                      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);
+/// 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);