1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # HTML output facilities
20 # You can define subclass and override methods head and body
24 # redef body do add("p").text("Hello World!")
27 # HTMLPage use fluent interface so you can chain calls as:
28 # add("div").attr("id", "mydiv").text("My Div")
37 private var root
= new HTMLTag("html")
38 private var current
: HTMLTag = root
39 private var stack
= new List[HTMLTag]
41 redef fun write_to
(stream
) do
49 stream
.write
"<!DOCTYPE html>"
53 # Add a html tag to the current element
54 # add("div").attr("id", "mydiv").text("My Div")
55 fun add
(tag
: String): HTMLTag do
56 var node
= new HTMLTag(tag
)
61 # Add a raw html string
62 # add_html("<a href='#top'>top</a>")
63 fun add_html
(html
: String) do current
.add
(new HTMLRaw(html
))
67 # add("li").text("item1")
68 # add("li").text("item2")
70 fun open
(tag
: String): HTMLTag do
76 # Close previously opened tag
77 # Ensure: tag = previous.tag
78 fun close
(tag
: String) do
79 if not tag
== current
.tag
then
80 print
"Error: Trying to close '{tag}', last opened tag was '{current.tag}'."
90 # HTML tagname: 'div' for <div></div>
94 self.is_void
= (once
["area", "base", "br", "col", "command", "embed", "hr", "img", "input", "keygen", "link", "meta", "param", "source", "track", "wbr"]).has
(tag
)
97 # Is the HTML element a void element?
99 # assert new HTMLTag("img").is_void == true
100 # assert new HTMLTag("p").is_void == false
103 init with_attrs
(tag
: String, attrs
: Map[String, String]) do
109 var attrs
: Map[String, String] = new HashMap[String, String]
111 # Get the attributed value of 'prop' or null if 'prop' is undifened
112 # var img = new HTMLTag("img")
113 # img.attr("src", "./image.png").attr("alt", "image")
114 # assert img.get_attr("src") == "./image.png"
115 fun get_attr
(key
: String): nullable String do
116 if not attrs
.has_key
(key
) then return null
120 # Set a 'value' for 'key'
121 # var img = new HTMLTag("img")
122 # img.attr("src", "./image.png").attr("alt", "image")
123 # assert img.write_to_string == """<img src="./image.png" alt="image"/>"""
124 fun attr
(key
: String, value
: String): HTMLTag do
129 # Add a CSS class to the HTML tag
130 # var img = new HTMLTag("img")
131 # img.add_class("logo").add_class("fullpage")
132 # assert img.write_to_string == """<img class="logo fullpage"/>"""
133 fun add_class
(klass
: String): HTMLTag do
139 var classes
: Set[String] = new HashSet[String]
141 # Add multiple CSS classes
142 # var img = new HTMLTag("img")
143 # img.add_classes(["logo", "fullpage"])
144 # assert img.write_to_string == """<img class="logo fullpage"/>"""
145 fun add_classes
(classes
: Collection[String]): HTMLTag do
146 self.classes
.add_all
(classes
)
150 # Set a CSS 'value' for 'prop'
151 # var img = new HTMLTag("img")
152 # img.css("border", "2px solid black").css("position", "absolute")
153 # assert img.write_to_string == """<img style="border: 2px solid black; position: absolute"/>"""
154 fun css
(prop
: String, value
: String): HTMLTag do
155 css_props
[prop
] = value
158 private var css_props
: Map[String, String] = new HashMap[String, String]
160 # Get CSS value for 'prop'
161 # var img = new HTMLTag("img")
162 # img.css("border", "2px solid black").css("position", "absolute")
163 # assert img.get_css("border") == "2px solid black"
164 # assert img.get_css("color") == null
165 fun get_css
(prop
: String): nullable String do
166 if not css_props
.has_key
(prop
) then return null
167 return css_props
[prop
]
170 # Replace `self` by `parent`.
172 # var elem = new HTMLTag("li")
173 # elem.add_outer(new HTMLTag("ul"))
174 # assert elem.write_to_string == "<ul><li></li></ul>"
175 fun add_outer
(parent
: HTMLTag) do
176 # copy self in new object
177 var child
= new HTMLTag(self.tag
)
178 child
.attrs
= self.attrs
179 child
.classes
= self.classes
180 child
.css_props
= self.css_props
181 child
.children
= self.children
182 # add copy in parent children elements
183 parent
.children
.add
(child
)
184 # replace self by parent
185 self.tag
= parent
.tag
186 self.attrs
= parent
.attrs
187 self.classes
= parent
.classes
188 self.css_props
= parent
.css_props
189 self.is_void
= parent
.is_void
190 self.children
= parent
.children
193 # Add a HTML 'child' to self
194 # var ul = new HTMLTag("ul")
195 # ul.add(new HTMLTag("li"))
196 # assert ul.write_to_string == "<ul><li></li></ul>"
197 fun add
(child
: HTMLTag) do children
.add
(child
)
199 # List of children HTML elements
200 var children
: Set[HTMLTag] = new HashSet[HTMLTag]
202 # Clear all child and set the text of element
203 # var p = new HTMLTag("p")
204 # p.text("Hello World!")
205 # assert p.write_to_string == "<p>Hello World!</p>"
206 # Text is escaped see: `standard::String::html_escape`
207 fun text
(txt
: String): HTMLTag do
214 # Append text to element
215 # var p = new HTMLTag("p")
217 # p.add(new HTMLTag("br"))
219 # assert p.write_to_string == "<p>Hello<br/>World!</p>"
220 # Text is escaped see: standard::String::html_escape
221 fun append
(txt
: String): HTMLTag do
222 add
(new HTMLRaw(txt
.html_escape
))
226 # Append raw HTML to element
227 # var p = new HTMLTag("p")
229 # p.add_raw_html("<bla/>")
230 # p.html #- "<p>Hello<bla/></p>"
231 # Note: the HTML in insered as it, no verification is done
232 fun add_raw_html
(txt
: String): HTMLTag do
233 add
(new HTMLRaw(txt
))
237 redef fun write_to
(stream
) do
238 var res
= new Array[String]
245 # In order to avoid recursive concatenation,
246 # this function collects in `res` all the small fragments of `String`
247 private fun render_in
(res
: Sequence[String])
252 if is_void
and children
.is_empty
then
256 for child
in children
do child
.render_in
(res
)
263 private fun render_attrs_in
(res
: Sequence[String]) do
264 if attrs
.has_key
("class") or not classes
.is_empty
then
266 for cls in classes do
267 res.add cls.html_escape
270 if attrs.has_key("class") then
271 res.add attrs["class"].html_escape
274 if res.last == " " then res.pop
278 if attrs
.has_key
("style") or not css_props
.is_empty
then
280 for k, v in css_props do
281 res.add k.html_escape
283 res.add v.html_escape
286 if attrs.has_key("style
") then
287 res.add(attrs["style
"].html_escape)
289 if res.last == "; " then res.pop
293 if attrs
.is_empty
then return
295 for key
, value
in attrs
do
296 if key
== "class" or key
== "style" then continue
298 res
.add key
.html_escape
300 res.add value.html_escape
306 private class HTMLRaw
309 private var content
: String
310 init(content
: String) do self.content
= content
311 redef fun render_in
(res
) do res
.add content