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/shared_ptr.h"
19 #include "support/strfwd.h"
29 // Inspiration for the *Tag structs and for XHTMLStream
30 // came from MathStream and its cousins.
37 /// Attributes will be escaped automatically and so should NOT
38 /// be escaped before being passed to the constructor.
42 explicit StartTag(std::string const & tag) : tag_(tag), keepempty_(false) {}
44 explicit StartTag(std::string const & tag, std::string const & attr,
45 bool keepempty = false)
46 : tag_(tag), attr_(attr), keepempty_(keepempty) {}
48 virtual ~StartTag() {}
50 virtual docstring writeTag() const;
52 virtual docstring writeEndTag() const;
54 virtual FontTag const * asFontTag() const { return 0; }
56 virtual bool operator==(StartTag const & rhs) const
57 { return tag_ == rhs.tag_; }
59 virtual bool operator!=(StartTag const & rhs) const
60 { return !(*this == rhs); }
62 virtual bool operator==(FontTag const & rhs) const;
67 /// whether to keep things like "<tag></tag>" or discard them
68 /// you would want this for td, e.g, but maybe not for a div
77 explicit EndTag(std::string tag) : tag_(tag) {}
81 virtual docstring writeEndTag() const;
83 bool operator==(StartTag const & rhs) const
84 { return tag_ == rhs.tag_; }
86 bool operator!=(StartTag const & rhs) const
87 { return !(*this == rhs); }
89 virtual EndFontTag const * asFontTag() const { return 0; }
96 /// Attributes will be escaped automatically and so should NOT
97 /// be escaped before being passed to the constructor.
101 explicit CompTag(std::string const & tag)
104 explicit CompTag(std::string const & tag, std::string const & attr)
105 : tag_(tag), attr_(attr) {}
107 docstring writeTag() const;
115 /// A special case of StartTag, used exclusively for tags that wrap paragraphs.
116 struct ParTag : public StartTag
119 explicit ParTag(std::string const & tag, std::string const & attr,
120 std::string const & parid)
121 : StartTag(tag, attr), parid_(parid)
126 docstring writeTag() const;
127 /// the "magic par label" for this paragraph
169 struct FontTag : public StartTag
172 explicit FontTag(FontTypes type);
174 FontTag const * asFontTag() const { return this; }
176 bool operator==(StartTag const &) const;
178 FontTypes font_type_;
183 struct EndFontTag : public EndTag
186 explicit EndFontTag(FontTypes type);
188 EndFontTag const * asFontTag() const { return this; }
190 FontTypes font_type_;
194 // trivial struct for output of newlines
202 explicit XHTMLStream(odocstream & os);
204 odocstream & os() { return os_; }
206 // int & tab() { return tab_; }
207 /// closes any font tags that are eligible to be closed,
208 /// i.e., last on the tag_stack_.
209 /// \return false if there are open font tags we could not close.
210 /// because they are "blocked" by open non-font tags on the stack.
211 bool closeFontTags();
212 /// call at start of paragraph. sets a mark so we know what tags
213 /// to close at the end.
214 void startParagraph(bool keep_empty);
215 /// call at end of paragraph to clear that mark. note that this
216 /// will also close any tags still open.
219 XHTMLStream & operator<<(docstring const &);
221 XHTMLStream & operator<<(const char *);
223 XHTMLStream & operator<<(char_type);
225 XHTMLStream & operator<<(int);
227 XHTMLStream & operator<<(char);
229 XHTMLStream & operator<<(html::StartTag const &);
231 XHTMLStream & operator<<(html::EndTag const &);
233 XHTMLStream & operator<<(html::CompTag const &);
235 XHTMLStream & operator<<(html::ParTag const &);
237 XHTMLStream & operator<<(html::FontTag const &);
239 XHTMLStream & operator<<(html::CR const &);
241 enum EscapeSettings {
243 ESCAPE_AND, // meaning &
244 ESCAPE_ALL // meaning <, >, &, at present
246 /// Sets what we are going to escape on the NEXT write.
247 /// Everything is reset for the next time.
248 XHTMLStream & operator<<(EscapeSettings);
250 /// This routine is for debugging the tag stack, etc. Code
251 /// for it is disabled by default, however, so you will need
252 /// to enable it if you want to use it.
253 void dumpTagStack(std::string const & msg) const;
257 void clearTagDeque();
259 bool isTagOpen(html::StartTag const &) const;
261 bool isTagOpen(html::EndTag const &) const;
263 bool isTagPending(html::StartTag const &) const;
265 void writeError(std::string const &) const;
269 EscapeSettings escape_;
270 // What we would really like to do here is simply use a
271 // deque<StartTag>. But we want to store both StartTags and
272 // sub-classes thereof on this stack, which means we run into the
273 // so-called polymorphic class problem with the STL. We therefore have
274 // to use a deque<StartTag *>, which leads to the question who will
275 // own these pointers and how they will be deleted, so we use shared
278 typedef shared_ptr<html::StartTag> TagPtr;
279 typedef std::deque<TagPtr> TagDeque;
281 template <typename T>
282 shared_ptr<T> makeTagPtr(T const & tag)
283 { return shared_ptr<T>(new 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);