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")
36 private var root
= new HTMLTag("html")
37 private var current
: HTMLTag = root
38 private var stack
= new List[HTMLTag]
40 # Render the page as a html string
49 return "<!DOCTYPE html>{root.html}"
52 # Add a html tag to the current element
53 # add("div").attr("id", "mydiv").text("My Div")
54 fun add
(tag
: String): HTMLTag do
55 var node
= new HTMLTag(tag
)
60 # Add a raw html string
61 # add_html("<a href='#top'>top</a>")
62 fun add_html
(html
: String) do current
.add
(new HTMLRaw(html
))
66 # add("li").text("item1")
67 # add("li").text("item2")
69 fun open
(tag
: String): HTMLTag do
75 # Close previously opened tag
76 # Ensure: tag = previous.tag
77 fun close
(tag
: String) do
78 if not tag
== current
.tag
then
79 print
"Error: Trying to close '{tag}', last opened tag was '{current.tag}'."
85 # Save html page in the specified file
86 fun save
(file
: String) do
87 var out
= new OFStream.open
(file
)
88 out
.write
(self.render
)
94 # HTML tagname: 'div' for <div></div>
96 init(tag
: String) do self.tag
= tag
98 init with_attrs
(tag
: String, attrs
: Map[String, String]) do
104 var attrs
: Map[String, String] = new HashMap[String, String]
106 # Get the attributed value of 'prop' or null if 'prop' is undifened
107 fun get_attr
(key
: String): nullable String do
108 if not attrs
.has_key
(key
) then return null
112 # Set a 'value' for 'key'
113 # var img = new HTMLTag("img")
114 # img.attr("src", "./image.png").attr("alt", "image")
115 fun attr
(key
: String, value
: String): HTMLTag do
120 # Add a CSS class to the HTML tag
121 # var img = new HTMLTag("img")
122 # img.add_class("logo").add_class("fullpage")
123 fun add_class
(klass
: String): HTMLTag do
127 private var classes
: Set[String] = new HashSet[String]
129 # Add multiple CSS classes
130 fun add_classes
(classes
: Collection[String]): HTMLTag do
131 self.classes
.add_all
(classes
)
135 # Set a CSS 'value' for 'prop'
136 # var img = new HTMLTag("img")
137 # img.css("border", "2px solid black").css("position", "absolute")
138 fun css
(prop
: String, value
: String): HTMLTag do
139 css_props
[prop
] = value
142 private var css_props
: Map[String, String] = new HashMap[String, String]
144 # Get CSS value for 'prop'
145 fun get_css
(prop
: String): nullable String do
146 if not css_props
.has_key
(prop
) then return null
147 return css_props
[prop
]
150 # Add a HTML 'child' to self
151 # var ul = new HTMLTag("ul")
152 # ul.add(new HTMLTag("li"))
153 fun add
(child
: HTMLTag) do children
.add
(child
)
155 # List of children HTML elements
156 var children
: Set[HTMLTag] = new HashSet[HTMLTag]
158 # Clear all child and set the text of element
159 # var p = new HTMLTag("p")
160 # p.text("Hello World!")
161 # assert p.html == "<p>Hello World!</p>"
162 # Text is escaped see: `standard::String::html_escape`
163 fun text
(txt
: String): HTMLTag do
170 # Append text to element
171 # var p = new HTMLTag("p")
173 # p.add(new HTMLTag("br"))
175 # assert p.html == "<p>Hello<br/>World!</p>"
176 # Text is escaped see: standard::String::html_escape
177 fun append
(txt
: String): HTMLTag do
178 add
(new HTMLRaw(txt
.html_escape
))
182 # Append raw HTML to element
183 # var p = new HTMLTag("p")
185 # p.add_raw_html("<bla/>")
186 # p.html #- "<p>Hello<bla/></p>"
187 # Note: the HTML in insered as it, no verification is done
188 fun add_raw_html
(txt
: String): HTMLTag do
189 add
(new HTMLRaw(txt
))
193 # Render the element as HTML string
195 var res
= new Array[String]
200 # Save html page in the specified file
201 fun save
(file
: String) do
202 var out
= new OFStream.open
(file
)
203 var res
= new Array[String]
211 # In order to avoid recursive concatenation,
212 # this function collects in `res` all the small fragments of `String`
213 private fun render_in
(res
: Sequence[String])
218 if tag
!= "script" and children
.is_empty
then
222 for child
in children
do child
.render_in
(res
)
229 private fun render_attrs_in
(res
: Sequence[String]) do
230 if attrs
.has_key
("class") or not classes
.is_empty
then
232 for cls in classes do
233 res.add cls.html_escape
236 if attrs.has_key("class") then
237 res.add attrs["class"].html_escape
240 if res.last == " " then res.pop
244 if attrs
.has_key
("style") or not css_props
.is_empty
then
247 res.add k.html_escape
249 res.add v.html_escape
252 if attrs.has_key("style
") then
253 res.add(attrs["style
"].html_escape)
255 if res.last == "; " then res.pop
259 if attrs
.is_empty
then return
261 for key
, value
in attrs
do
262 if key
== "class" or key
== "style" then continue
264 res
.add key
.html_escape
266 res.add value.html_escape
272 private class HTMLRaw
275 private var content
: String
276 init(content
: String) do self.content
= content
277 redef fun html
do return content
278 redef fun render_in
(res
) do res
.add content