* ANNOUNCE

[lyx.git] / src / output_xhtml.h

diff --git a/src/output_xhtml.h b/src/output_xhtml.h
index bed9971a30c209a215f04cff3361de5c2782b869..986070ddd6745155144f5afcb119ff60ef0547f9 100644 (file)
--- a/src/output_xhtml.h
+++ b/src/output_xhtml.h
@@ -12,7 +12,9 @@
 #ifndef OUTPUT_XHTML_H
 #define OUTPUT_XHTML_H
 
+#include "LayoutEnums.h"
 #include "support/docstream.h"
+#include "support/strfwd.h"
 
 #include <deque>
 #include <vector>
@@ -26,11 +28,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) {}
        /// <tag_ attr_>
@@ -49,7 +54,7 @@ struct StartTag {
 
 struct EndTag {
        ///
-       EndTag(std::string tag) : tag_(tag) {}
+       explicit EndTag(std::string tag) : tag_(tag) {}
        /// </tag_>
        docstring asEndTag() const;
        ///
@@ -57,13 +62,19 @@ struct EndTag {
 };
 
 
-// Tags like <img />
+// 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 {
        ///
-       CompTag(std::string const & tag)
+       explicit CompTag(std::string const & tag)
                : tag_(tag) {}
        ///
-       CompTag(std::string const & tag, std::string const & attr)
+       explicit CompTag(std::string const & tag, std::string const & attr)
                : tag_(tag), attr_(attr) {}
        /// <tag_ attr_ />
        docstring asTag() const;
@@ -73,6 +84,7 @@ struct CompTag {
        std::string attr_;
 };
 
+} // namespace html
 
 class XHTMLStream {
 public:
@@ -96,11 +108,21 @@ public:
        ///
        XHTMLStream & operator<<(char_type);
        ///
-       XHTMLStream & operator<<(StartTag const &);
+       XHTMLStream & operator<<(int);
+       ///
+       XHTMLStream & operator<<(char);
+       ///
+       XHTMLStream & operator<<(html::StartTag const &);
        ///
-       XHTMLStream & operator<<(EndTag const &);
+       XHTMLStream & operator<<(html::EndTag const &);
        ///
-       XHTMLStream & operator<<(CompTag const &);
+       XHTMLStream & operator<<(html::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();
@@ -113,13 +135,15 @@ private:
        ///
        // int tab_;
        ///
-       typedef std::deque<StartTag> TagDeque;
+       typedef std::deque<html::StartTag> TagDeque;
        ///
-       typedef std::vector<StartTag> TagStack;
+       typedef std::vector<html::StartTag> 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_;
 };
 
 ///
@@ -128,19 +152,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);
 /// 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 html
 } // namespace lyx
 
 #endif