4 * This file is part of LyX, the document processor.
5 * License details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
16 #include "support/docstring.h"
27 // Inspiration for the *Tag structs and for XMLStream
28 // came from MathStream and its cousins.
42 explicit XMLStream(odocstream & os): os_(os), escape_(ESCAPE_ALL), is_last_tag_cr_(true) {}
44 odocstream & os() { return os_; }
46 // int & tab() { return tab_; }
47 /// closes any font tags that are eligible to be closed,
48 /// i.e., last on the tag_stack_.
49 /// \return false if there are open font tags we could not close.
50 /// because they are "blocked" by open non-font tags on the stack.
52 /// sets a mark so we know what tags to close at the end.
53 /// normally called at the start of a paragraph.
54 void startDivision(bool keep_empty);
55 /// clears the mark set by previous method.
56 /// there should not be any other tags open before it on the stack,
57 /// but if there are, we will close them.
60 XMLStream & operator<<(docstring const &);
62 XMLStream & operator<<(const char *);
64 XMLStream & operator<<(char_type);
66 XMLStream & operator<<(int);
68 XMLStream & operator<<(char);
70 XMLStream & operator<<(xml::StartTag const &);
72 XMLStream & operator<<(xml::EndTag const &);
74 XMLStream & operator<<(xml::CompTag const &);
76 XMLStream & operator<<(xml::ParTag const &);
78 XMLStream & operator<<(xml::FontTag const &);
80 XMLStream & operator<<(xml::CR const &);
84 ESCAPE_AND, // meaning &
85 ESCAPE_ALL, // meaning <, >, &, at present, except things that are forbidden in comments
86 ESCAPE_COMMENTS // Anything that is forbidden within comments
88 /// Sets what we are going to escape on the NEXT write.
89 /// Everything is reset for the next time.
90 XMLStream & operator<<(EscapeSettings);
91 /// This routine is for debugging the tag stack, etc. Code
92 /// for it is disabled by default, however, so you will need
93 /// to enable it if you want to use it.
94 void dumpTagStack(std::string const & msg);
96 bool isTagOpen(xml::StartTag const &, int maxdepth = -1) const;
98 bool isTagOpen(xml::EndTag const &, int maxdepth = -1) const;
100 bool isTagPending(xml::StartTag const &, int maxdepth = -1) const;
101 /// Is the last tag that was added to the stream a new line (CR)? This is mostly to known
102 /// whether a new line must be added. Therefore, consider that an empty stream just had a CR,
103 /// that simplifies the logic using this code.
104 bool isLastTagCR() const { return is_last_tag_cr_; };
106 void writeError(std::string const &) const;
108 void writeError(docstring const &) const;
111 void clearTagDeque();
115 EscapeSettings escape_;
116 // What we would really like to do here is simply use a
117 // deque<StartTag>. But we want to store both StartTags and
118 // sub-classes thereof on this stack, which means we run into the
119 // so-called polymorphic class problem with the STL. We therefore have
120 // to use a deque<StartTag *>, which leads to the question who will
121 // own these pointers and how they will be deleted, so we use shared
124 typedef std::shared_ptr<xml::StartTag> TagPtr;
125 typedef std::deque<TagPtr> TagDeque;
127 template <typename T>
128 TagPtr makeTagPtr(T const & tag) { return std::make_shared<T>(tag); }
130 TagDeque pending_tags_;
134 bool is_last_tag_cr_;
136 bool pending_tags_empty() { return pending_tags_.empty();};
141 /// Escape the given character, if necessary, to an entity.
142 docstring escapeChar(char_type c, XMLStream::EscapeSettings e);
144 /// Escape the given character, if necessary, to an entity.
145 docstring escapeChar(char c, XMLStream::EscapeSettings e);
147 /// Escape a word instead of a single character
148 docstring escapeString(docstring const & raw, XMLStream::EscapeSettings e=XMLStream::ESCAPE_ALL);
150 /// cleans \param str for use as an attribute by replacing all non-altnum by "_"
151 docstring cleanAttr(docstring const & str);
153 /// \p c must be ASCII
154 docstring escapeChar(char c, XMLStream::EscapeSettings e);
156 /// replaces illegal characters from ID attributes
157 docstring cleanID(docstring const &orig);
159 /// returns a unique numeric ID
160 docstring uniqueID(docstring const & label);
165 /// Attributes will be escaped automatically and so should NOT
166 /// be escaped before being passed to the constructor.
170 explicit StartTag(std::string const & tag) : tag_(from_ascii(tag)), keepempty_(false) {}
172 explicit StartTag(docstring const & tag) : tag_(tag), keepempty_(false) {}
174 explicit StartTag(docstring const & tag, docstring const & attr,
175 bool keepempty = false)
176 : tag_(tag), attr_(attr), keepempty_(keepempty) {}
178 explicit StartTag(std::string const & tag, std::string const & attr,
179 bool keepempty = false)
180 : tag_(from_ascii(tag)), attr_(from_ascii(attr)), keepempty_(keepempty) {}
182 explicit StartTag(std::string const & tag, docstring const & attr,
183 bool keepempty = false)
184 : tag_(from_ascii(tag)), attr_(attr), keepempty_(keepempty) {}
186 virtual ~StartTag() {}
188 virtual docstring writeTag() const;
190 virtual docstring writeEndTag() const;
192 virtual FontTag const * asFontTag() const { return nullptr; }
194 virtual bool operator==(StartTag const & rhs) const
195 { return tag_ == rhs.tag_; }
197 virtual bool operator!=(StartTag const & rhs) const
198 { return !(*this == rhs); }
200 virtual bool operator==(FontTag const & rhs) const;
205 /// whether to keep things like "<tag></tag>" or discard them
206 /// you would want this for td, e.g, but maybe not for a div
215 explicit EndTag(std::string tag) : tag_(from_ascii(tag)) {}
217 explicit EndTag(docstring tag) : tag_(tag) {}
221 virtual docstring writeEndTag() const;
223 bool operator==(StartTag const & rhs) const
224 { return tag_ == rhs.tag_; }
226 bool operator!=(StartTag const & rhs) const
227 { return !(*this == rhs); }
229 virtual EndFontTag const * asFontTag() const { return 0; }
235 /// Tags like <img />
236 /// Attributes will be escaped automatically and so should NOT
237 /// be escaped before being passed to the constructor.
241 explicit CompTag(std::string const & tag)
244 explicit CompTag(std::string const & tag, std::string const & attr)
245 : tag_(tag), attr_(attr) {}
247 docstring writeTag() const;
255 /// A special case of StartTag, used exclusively for tags that wrap paragraphs.
256 /// parid is only used for HTML output; XML is supposed to use attr for this.
257 struct ParTag : public StartTag
260 explicit ParTag(std::string const & tag, const std::string & attr): StartTag(tag, from_utf8(attr)) {}
301 // When updating this list, also update fontToTag in both output_docbook.cpp and output_xhtml.cpp,
302 // fontToRole in output_docbook.cpp, and fontToAttribute in output_xhtml.cpp.
307 struct FontTag : public StartTag
310 FontTag(docstring const & tag, FontTypes type): StartTag(tag), font_type_(type) {}
312 FontTag(std::string const & tag, FontTypes type): StartTag(from_utf8(tag)), font_type_(type) {}
314 FontTag(docstring const & tag, docstring const & attr, FontTypes type): StartTag(tag, attr), font_type_(type) {}
316 FontTag(std::string const & tag, std::string const & attr, FontTypes type): StartTag(from_utf8(tag), from_utf8(attr)), font_type_(type) {}
318 FontTag const * asFontTag() const override { return this; }
320 bool operator==(StartTag const &) const override;
322 FontTypes font_type_;
327 struct EndFontTag : public EndTag
330 EndFontTag(docstring const & tag, FontTypes type): EndTag(tag), font_type_(type) {}
332 EndFontTag(std::string const & tag, FontTypes type): EndTag(from_utf8(tag)), font_type_(type) {}
334 EndFontTag const * asFontTag() const override { return this; }
336 FontTypes font_type_;
340 // trivial struct for output of newlines
343 // an illegal tag for internal use
344 xml::StartTag const parsep_tag("&LyX_parsep_tag&");
347 void openTag(odocstream & os, std::string const & name,
348 std::string const & attribute = std::string());
351 void openTag(Buffer const & buf, odocstream & os,
352 OutputParams const & runparams, Paragraph const & par);
355 void closeTag(odocstream & os, std::string const & name);
358 void closeTag(odocstream & os, Paragraph const & par);