#ifndef OUTPUT_XHTML_H
#define OUTPUT_XHTML_H
+#include "LayoutEnums.h"
+
#include "support/docstream.h"
+#include "support/shared_ptr.h"
+#include "support/strfwd.h"
#include <deque>
-#include <vector>
namespace lyx {
// Inspiration for the *Tag structs and for XHTMLStream
// came from MathStream and its cousins.
-struct StartTag {
+namespace html {
+
+struct FontTag;
+struct EndFontTag;
+
+/// 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,
- bool keepempty = false)
+ explicit StartTag(std::string const & tag, std::string const & attr,
+ bool keepempty = false)
: tag_(tag), attr_(attr), keepempty_(keepempty) {}
+ ///
+ virtual ~StartTag() {}
/// <tag_ attr_>
- docstring asTag() const;
+ virtual docstring writeTag() const;
/// </tag_>
- docstring asEndTag() const;
+ virtual docstring writeEndTag() const;
+ ///
+ virtual FontTag const * asFontTag() const { return 0; }
+ ///
+ virtual bool operator==(StartTag const & rhs) const
+ { return tag_ == rhs.tag_; }
+ ///
+ virtual bool operator!=(StartTag const & rhs) const
+ { return !(*this == rhs); }
+ ///
+ virtual bool operator==(FontTag const & rhs) const;
///
std::string tag_;
///
};
-struct EndTag {
+///
+struct EndTag
+{
+ ///
+ explicit EndTag(std::string tag) : tag_(tag) {}
///
- EndTag(std::string tag) : tag_(tag) {}
+ virtual ~EndTag() {}
/// </tag_>
- docstring asEndTag() const;
+ virtual docstring writeEndTag() const;
+ ///
+ bool operator==(StartTag const & rhs) const
+ { return tag_ == rhs.tag_; }
+ ///
+ bool operator!=(StartTag const & rhs) const
+ { return !(*this == rhs); }
+ ///
+ virtual EndFontTag const * asFontTag() const { return 0; }
///
std::string tag_;
};
-// Tags like <img />
-struct CompTag {
+/// 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, 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;
+ docstring writeTag() const;
///
std::string tag_;
///
};
+/// A special case of StartTag, used exclusively for tags that wrap paragraphs.
+struct ParTag : public StartTag
+{
+ ///
+ explicit ParTag(std::string const & tag, std::string const & attr,
+ std::string const & parid)
+ : StartTag(tag, attr), parid_(parid)
+ {}
+ ///
+ ~ParTag() {}
+ ///
+ docstring writeTag() const;
+ /// the "magic par label" for this paragraph
+ std::string parid_;
+};
+
+
+///
+enum FontTypes {
+ // ranges
+ FT_EMPH,
+ FT_NOUN,
+ FT_UBAR,
+ FT_DBAR,
+ FT_WAVE,
+ FT_SOUT,
+ // bold
+ FT_BOLD,
+ // shapes
+ FT_UPRIGHT,
+ FT_ITALIC,
+ FT_SLANTED,
+ FT_SMALLCAPS,
+ // families
+ FT_ROMAN,
+ FT_SANS,
+ FT_TYPE,
+ // sizes
+ FT_SIZE_TINY,
+ FT_SIZE_SCRIPT,
+ FT_SIZE_FOOTNOTE,
+ FT_SIZE_SMALL,
+ FT_SIZE_NORMAL,
+ FT_SIZE_LARGE,
+ FT_SIZE_LARGER,
+ FT_SIZE_LARGEST,
+ FT_SIZE_HUGE,
+ FT_SIZE_HUGER,
+ FT_SIZE_INCREASE,
+ FT_SIZE_DECREASE
+};
+
+
+///
+struct FontTag : public StartTag
+{
+ ///
+ explicit FontTag(FontTypes type);
+ ///
+ FontTag const * asFontTag() const { return this; }
+ ///
+ bool operator==(StartTag const &) const;
+ ///
+ FontTypes font_type_;
+};
+
+
+///
+struct EndFontTag : public EndTag
+{
+ ///
+ explicit EndFontTag(FontTypes type);
+ ///
+ EndFontTag const * asFontTag() const { return this; }
+ ///
+ FontTypes font_type_;
+};
+
+
+// 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_; }
/// \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<<(char_type);
///
- XHTMLStream & operator<<(StartTag const &);
+ XHTMLStream & operator<<(int);
+ ///
+ XHTMLStream & operator<<(char);
+ ///
+ XHTMLStream & operator<<(html::StartTag const &);
+ ///
+ XHTMLStream & operator<<(html::EndTag const &);
+ ///
+ XHTMLStream & operator<<(html::CompTag const &);
+ ///
+ XHTMLStream & operator<<(html::ParTag const &);
+ ///
+ XHTMLStream & operator<<(html::FontTag const &);
///
- XHTMLStream & operator<<(EndTag const &);
+ XHTMLStream & operator<<(html::CR const &);
///
- XHTMLStream & operator<<(CompTag 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 &);
+ bool isTagOpen(html::StartTag const &) const;
+ ///
+ bool isTagOpen(html::EndTag const &) const;
///
- void writeError(std::string const &);
+ bool isTagPending(html::StartTag const &) const;
+ ///
+ void writeError(std::string const &) const;
///
odocstream & os_;
///
- // int tab_;
+ EscapeSettings escape_;
+ // What we would really like to do here is simply use a
+ // deque<StartTag>. But we want to store both StartTags and
+ // sub-classes thereof on this stack, which means we run into the
+ // so-called polymorphic class problem with the STL. We therefore have
+ // to use a deque<StartTag *>, which leads to the question who will
+ // own these pointers and how they will be deleted, so we use shared
+ // pointers.
+ ///
+ typedef shared_ptr<html::StartTag> TagPtr;
+ typedef std::deque<TagPtr> TagDeque;
///
- typedef std::deque<StartTag> TagDeque;
+ template <typename T>
+ shared_ptr<T> makeTagPtr(T const & tag)
+ { return shared_ptr<T>(new T(tag)); }
///
- typedef std::vector<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_;
+ ///
+ TagDeque tag_stack_;
};
///
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);
+/// \p c must be ASCII
+docstring escapeChar(char c, XHTMLStream::EscapeSettings e);
+
+} // namespace html
} // namespace lyx
#endif
projects / lyx.git / blobdiff