4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef OUTPUT_XHTML_H
13 #define OUTPUT_XHTML_H
15 #include "LayoutEnums.h"
17 #include "support/docstream.h"
18 #include "support/strfwd.h"
30 // Inspiration for the *Tag structs and for XHTMLStream
31 // came from MathStream and its cousins.
38 /// Attributes will be escaped automatically and so should NOT
39 /// be escaped before being passed to the constructor.
43 explicit StartTag(std::string const & tag) : tag_(tag), keepempty_(false) {}
45 explicit StartTag(std::string const & tag, std::string const & attr,
46 bool keepempty = false)
47 : tag_(tag), attr_(attr), keepempty_(keepempty) {}
49 virtual ~StartTag() {}
51 virtual docstring writeTag() const;
53 virtual docstring writeEndTag() const;
55 virtual FontTag const * asFontTag() const { return 0; }
57 virtual bool operator==(StartTag const & rhs) const
58 { return tag_ == rhs.tag_; }
60 virtual bool operator!=(StartTag const & rhs) const
61 { return !(*this == rhs); }
63 virtual bool operator==(FontTag const & rhs) const;
68 /// whether to keep things like "<tag></tag>" or discard them
69 /// you would want this for td, e.g, but maybe not for a div
78 explicit EndTag(std::string tag) : tag_(tag) {}
82 virtual docstring writeEndTag() const;
84 bool operator==(StartTag const & rhs) const
85 { return tag_ == rhs.tag_; }
87 bool operator!=(StartTag const & rhs) const
88 { return !(*this == rhs); }
90 virtual EndFontTag const * asFontTag() const { return 0; }
97 /// Attributes will be escaped automatically and so should NOT
98 /// be escaped before being passed to the constructor.
102 explicit CompTag(std::string const & tag)
105 explicit CompTag(std::string const & tag, std::string const & attr)
106 : tag_(tag), attr_(attr) {}
108 docstring writeTag() const;
116 /// A special case of StartTag, used exclusively for tags that wrap paragraphs.
117 struct ParTag : public StartTag
120 explicit ParTag(std::string const & tag, std::string const & attr,
121 std::string const & parid)
122 : StartTag(tag, attr), parid_(parid)
127 docstring writeTag() const;
128 /// the "magic par label" for this paragraph
170 struct FontTag : public StartTag
173 explicit FontTag(FontTypes type);
175 FontTag const * asFontTag() const { return this; }
177 bool operator==(StartTag const &) const;
179 FontTypes font_type_;
184 struct EndFontTag : public EndTag
187 explicit EndFontTag(FontTypes type);
189 EndFontTag const * asFontTag() const { return this; }
191 FontTypes font_type_;
195 // trivial struct for output of newlines
203 explicit XHTMLStream(odocstream & os);
205 odocstream & os() { return os_; }
207 // int & tab() { return tab_; }
208 /// closes any font tags that are eligible to be closed,
209 /// i.e., last on the tag_stack_.
210 /// \return false if there are open font tags we could not close.
211 /// because they are "blocked" by open non-font tags on the stack.
212 bool closeFontTags();
213 /// call at start of paragraph. sets a mark so we know what tags
214 /// to close at the end.
215 void startParagraph(bool keep_empty);
216 /// call at end of paragraph to clear that mark. note that this
217 /// will also close any tags still open.
220 XHTMLStream & operator<<(docstring const &);
222 XHTMLStream & operator<<(const char *);
224 XHTMLStream & operator<<(char_type);
226 XHTMLStream & operator<<(int);
228 XHTMLStream & operator<<(char);
230 XHTMLStream & operator<<(html::StartTag const &);
232 XHTMLStream & operator<<(html::EndTag const &);
234 XHTMLStream & operator<<(html::CompTag const &);
236 XHTMLStream & operator<<(html::ParTag const &);
238 XHTMLStream & operator<<(html::FontTag const &);
240 XHTMLStream & operator<<(html::CR const &);
242 enum EscapeSettings {
244 ESCAPE_AND, // meaning &
245 ESCAPE_ALL // meaning <, >, &, at present
247 /// Sets what we are going to escape on the NEXT write.
248 /// Everything is reset for the next time.
249 XHTMLStream & operator<<(EscapeSettings);
251 /// This routine is for debugging the tag stack, etc. Code
252 /// for it is disabled by default, however, so you will need
253 /// to enable it if you want to use it.
254 void dumpTagStack(std::string const & msg) const;
258 void clearTagDeque();
260 bool isTagOpen(html::StartTag const &) const;
262 bool isTagOpen(html::EndTag const &) const;
264 bool isTagPending(html::StartTag const &) const;
266 void writeError(std::string const &) const;
270 EscapeSettings escape_;
271 // What we would really like to do here is simply use a
272 // deque<StartTag>. But we want to store both StartTags and
273 // sub-classes thereof on this stack, which means we run into the
274 // so-called polymorphic class problem with the STL. We therefore have
275 // to use a deque<StartTag *>, which leads to the question who will
276 // own these pointers and how they will be deleted, so we use shared
279 typedef std::shared_ptr<html::StartTag> TagPtr;
280 typedef std::deque<TagPtr> TagDeque;
282 template <typename T>
283 TagPtr makeTagPtr(T const & tag) { return std::make_shared<T>(tag); }
285 TagDeque pending_tags_;
291 void xhtmlParagraphs(Text const & text,
294 OutputParams const & runparams);
296 /// \return a string appropriate for setting alignment in CSS
297 /// Does NOT return "justify" for "block"
298 std::string alignmentToCSS(LyXAlignment align);
302 docstring escapeChar(char_type c, XHTMLStream::EscapeSettings e);
303 /// converts a string to a form safe for links, etc
304 docstring htmlize(docstring const & str, XHTMLStream::EscapeSettings e);
305 /// cleans \param str for use as an atttribute by replacing
306 /// all non-alnum by "_"
307 docstring cleanAttr(docstring const & str);
308 /// \p c must be ASCII
309 docstring escapeChar(char c, XHTMLStream::EscapeSettings e);