listerrors.lyx : Update a link.

[lyx.git] / src / output_xhtml.h

diff --git a/src/output_xhtml.h b/src/output_xhtml.h
index de88282a8044a773f03a3cf8fb956a6988d8d770..416e0daf4909337cdcf091693dd92e880d0a4b67 100644 (file)
--- a/src/output_xhtml.h
+++ b/src/output_xhtml.h
@@ -12,11 +12,11 @@
 #ifndef OUTPUT_XHTML_H
 #define OUTPUT_XHTML_H
 
+#include "LayoutEnums.h"
 #include "support/docstream.h"
 #include "support/strfwd.h"
 
 #include <deque>
-#include <vector>
 
 namespace lyx {
 
@@ -27,11 +27,12 @@ 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 passing to the constructor.
+/// be escaped before being passed to the constructor.
 struct StartTag {
        ///
-       explicit StartTag(std::string const & tag) : tag_(tag) {}
+       explicit StartTag(std::string const & tag) : tag_(tag), keepempty_(false) {}
        ///
        explicit StartTag(std::string const & tag, std::string const & attr, 
                bool keepempty = false) 
@@ -60,9 +61,13 @@ struct EndTag {
 };
 
 
+// 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 passing to the constructor.
+/// be escaped before being passed to the constructor.
 struct CompTag {
        ///
        explicit CompTag(std::string const & tag)
@@ -78,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_; }
@@ -94,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(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 &);
        ///
@@ -101,17 +114,26 @@ 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 &);
-       /// 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<<(html::CompTag const &);
        ///
-       XHTMLStream & operator<<(NextRaw 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();
@@ -122,17 +144,13 @@ private:
        ///
        odocstream & os_;
        ///
-       // int tab_;
-       ///
-       typedef std::deque<StartTag> TagDeque;
-       ///
-       typedef std::vector<StartTag> TagStack;
+       typedef std::deque<html::StartTag> 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_;
        /// 
-       bool nextraw_;
+       EscapeSettings escape_;
 };
 
 ///
@@ -141,28 +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);
+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);
+std::string escapeChar(char c, XHTMLStream::EscapeSettings e);
 /// 
-std::string htmlize(std::string const & str);
+std::string htmlize(std::string const & str, XHTMLStream::EscapeSettings e);
 /// 
 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