mirror of
https://github.com/vlang/v.git
synced 2023-08-10 21:13:21 +03:00
tmpl: move to v/parser (#9052)
This commit is contained in:
Anton Zavodchikov
committed by
GitHub
GitHub
parent
26138f98af
commit
1ad4623fb8
@@ -1,127 +0,0 @@
|
||||
This package is to generate data-driven HTML output.
|
||||
|
||||
# Directives
|
||||
Each directive begins with an `@` sign.
|
||||
Some directives begin contains a `{}` block, others only have `''` (string) parameters.
|
||||
More on the directives itself.
|
||||
|
||||
Newlines on the beginning and end are ignored in `{}` blocks,
|
||||
otherwise this (see [if](#if) for this syntax):
|
||||
```html
|
||||
@if bool_val {
|
||||
<span>This is shown if bool_val is true</span>
|
||||
}
|
||||
```
|
||||
would result in:
|
||||
```html
|
||||
|
||||
<span>This is shown if bool_val is true</span>
|
||||
|
||||
```
|
||||
which could result in unreadable output.
|
||||
|
||||
## if
|
||||
The if directive consists of three parts, the `@if` tag, the condition (same syntax like in V)
|
||||
and the `{}` block where you can write html which will be rendered if the condition is true:
|
||||
```
|
||||
@if <condition> {}
|
||||
```
|
||||
|
||||
### Example
|
||||
```html
|
||||
@if bool_val {
|
||||
<span>This is shown if bool_val is true</span>
|
||||
}
|
||||
```
|
||||
One-liner:
|
||||
```html
|
||||
@if bool_val { <span>This is shown if bool_val is true</span> }
|
||||
```
|
||||
|
||||
The first example would result in:
|
||||
```html
|
||||
<span>This is shown if bool_val is true</span>
|
||||
```
|
||||
while the one-liner results in:
|
||||
```html
|
||||
<span>This is shown if bool_val is true</span>
|
||||
```
|
||||
|
||||
## for
|
||||
The for directive consists of three parts, the `@for` tag, the condition (same syntax like in V)
|
||||
and the `{}` block where you can write html which will be rendered for each loop:
|
||||
```
|
||||
@for <condition> {}
|
||||
```
|
||||
|
||||
### Example
|
||||
```html
|
||||
@for i, val in my_vals {
|
||||
<span>$i - $val</span>
|
||||
}
|
||||
```
|
||||
One-liner:
|
||||
```html
|
||||
@for i, val in my_vals { <span>$i - $val</span> }
|
||||
```
|
||||
|
||||
The first example would result in:
|
||||
```html
|
||||
<span>0 - "First"</span>
|
||||
<span>1 - "Second"</span>
|
||||
<span>2 - "Third"</span>
|
||||
...
|
||||
```
|
||||
while the one-liner results in:
|
||||
```html
|
||||
<span>0 - "First"</span>
|
||||
<span>1 - "Second"</span>
|
||||
<span>2 - "Third"</span>
|
||||
...
|
||||
```
|
||||
|
||||
You can also write (and all other for condition syntaxes that are allowed in V):
|
||||
```html
|
||||
@for i = 0; i < 5; i++ {
|
||||
<span>$i</span>
|
||||
}
|
||||
```
|
||||
|
||||
## include
|
||||
The include directive is for including other html files (which will be processed as well)
|
||||
and consists of two parts, the `@include` tag and a following `'<path>'` string.
|
||||
The path parameter is relative to the `/templates` directory in the corresponding project.
|
||||
|
||||
### Example
|
||||
Files
|
||||
```
|
||||
Project root
|
||||
/templates
|
||||
- index.html
|
||||
/headers
|
||||
- base.html
|
||||
```
|
||||
|
||||
`index.html`
|
||||
```html
|
||||
<div>@include 'header/base'</div>
|
||||
```
|
||||
> Note that there shouldn't be a file suffix,
|
||||
it is automatically appended and only allows `html` files.
|
||||
|
||||
|
||||
## js
|
||||
The js directive consists of two parts, the `@js` tag and `'<path>'` string,
|
||||
where you can insert your src
|
||||
```
|
||||
@js '<url>'
|
||||
```
|
||||
|
||||
### Example
|
||||
```html
|
||||
@js 'myscripts.js'
|
||||
```
|
||||
|
||||
# Variables
|
||||
All variables which are declared before can be used through the `@{my_var}` syntax.
|
||||
It's also possible to use properties of structs here like `@{my_struct.prop}`.
|
||||
@@ -1,168 +0,0 @@
|
||||
// Copyright (c) 2019-2021 Alexander Medvednikov. All rights reserved.
|
||||
// Use of this source code is governed by an MIT license
|
||||
// that can be found in the LICENSE file.
|
||||
module tmpl
|
||||
|
||||
import os
|
||||
import strings
|
||||
|
||||
const (
|
||||
str_start = "sb.write_string('"
|
||||
str_end = "' ) "
|
||||
)
|
||||
|
||||
// compile_file compiles the content of a file by the given path as a template
|
||||
pub fn compile_file(path string, fn_name string) string {
|
||||
basepath := os.dir(path)
|
||||
html := os.read_file(path) or { panic('html failed') }
|
||||
return compile_template(basepath, html, fn_name)
|
||||
}
|
||||
|
||||
enum State {
|
||||
html
|
||||
css // <style>
|
||||
js // <script>
|
||||
// span // span.{
|
||||
}
|
||||
|
||||
pub fn compile_template(basepath string, html_ string, fn_name string) string {
|
||||
// lines := os.read_lines(path)
|
||||
mut html := html_.trim_space()
|
||||
mut header := ''
|
||||
mut footer := ''
|
||||
if os.exists(os.join_path(basepath, 'header.html')) && html.contains('@header') {
|
||||
h := os.read_file(os.join_path(basepath, 'header.html')) or {
|
||||
panic('reading file ${os.join_path(basepath, 'header.html')} failed')
|
||||
}
|
||||
header = h.trim_space().replace("'", '"')
|
||||
html = header + html
|
||||
}
|
||||
if os.exists(os.join_path(basepath, 'footer.html')) && html.contains('@footer') {
|
||||
f := os.read_file(os.join_path(basepath, 'footer.html')) or {
|
||||
panic('reading file ${os.join_path(basepath, 'footer.html')} failed')
|
||||
}
|
||||
footer = f.trim_space().replace("'", '"')
|
||||
html += footer
|
||||
}
|
||||
mut lines := html.split_into_lines()
|
||||
lstartlength := lines.len * 30
|
||||
mut s := strings.new_builder(1000)
|
||||
// base := path.all_after_last('/').replace('.html', '')
|
||||
s.writeln("
|
||||
import strings
|
||||
// === vweb html template ===
|
||||
fn vweb_tmpl_${fn_name}() {
|
||||
mut sb := strings.new_builder($lstartlength)\n
|
||||
header := \' \' // TODO remove
|
||||
_ = header
|
||||
footer := \' \' // TODO remove
|
||||
_ = footer
|
||||
|
||||
")
|
||||
s.write_string(tmpl.str_start)
|
||||
mut state := State.html
|
||||
mut in_span := false
|
||||
// for _line in lines {
|
||||
for i := 0; i < lines.len; i++ {
|
||||
line := lines[i].trim_space()
|
||||
if line == '<style>' {
|
||||
state = .css
|
||||
} else if line == '</style>' {
|
||||
state = .html
|
||||
} else if line == '<script>' {
|
||||
state = .js
|
||||
} else if line == '</script>' {
|
||||
state = .html
|
||||
}
|
||||
if line.contains('@include ') {
|
||||
lines.delete(i)
|
||||
mut file_name := line.split("'")[1]
|
||||
mut file_ext := os.file_ext(file_name)
|
||||
if file_ext == '' {
|
||||
file_ext = '.html'
|
||||
}
|
||||
file_name = file_name.replace(file_ext, '')
|
||||
// relative path, starting with the current folder
|
||||
mut templates_folder := os.real_path(basepath)
|
||||
if file_name.contains('/') && file_name.starts_with('/') {
|
||||
// an absolute path
|
||||
templates_folder = ''
|
||||
}
|
||||
file_path := os.real_path(os.join_path(templates_folder, '$file_name$file_ext'))
|
||||
$if trace_tmpl ? {
|
||||
eprintln('>>> basepath: "$basepath" , fn_name: "$fn_name" , @include line: "$line" , file_name: "$file_name" , file_ext: "$file_ext" , templates_folder: "$templates_folder" , file_path: "$file_path"')
|
||||
}
|
||||
file_content := os.read_file(file_path) or {
|
||||
panic('Vweb: reading file $file_name from path: $file_path failed.')
|
||||
}
|
||||
file_splitted := file_content.split_into_lines().reverse()
|
||||
for f in file_splitted {
|
||||
lines.insert(i, f)
|
||||
}
|
||||
i--
|
||||
} else if line.contains('@js ') {
|
||||
pos := line.index('@js') or { continue }
|
||||
s.write_string('<script src="')
|
||||
s.write_string(line[pos + 5..line.len - 1])
|
||||
s.writeln('"></script>')
|
||||
} else if line.contains('@css ') {
|
||||
pos := line.index('@css') or { continue }
|
||||
s.write_string('<link href="')
|
||||
s.write_string(line[pos + 6..line.len - 1])
|
||||
s.writeln('" rel="stylesheet" type="text/css">')
|
||||
} else if line.contains('@if ') {
|
||||
s.writeln(tmpl.str_end)
|
||||
pos := line.index('@if') or { continue }
|
||||
s.writeln('if ' + line[pos + 4..] + '{')
|
||||
s.writeln(tmpl.str_start)
|
||||
} else if line.contains('@end') {
|
||||
// Remove new line byte
|
||||
s.go_back(1)
|
||||
|
||||
s.writeln(tmpl.str_end)
|
||||
s.writeln('}')
|
||||
s.writeln(tmpl.str_start)
|
||||
} else if line.contains('@else') {
|
||||
// Remove new line byte
|
||||
s.go_back(1)
|
||||
|
||||
s.writeln(tmpl.str_end)
|
||||
s.writeln(' } else { ')
|
||||
s.writeln(tmpl.str_start)
|
||||
} else if line.contains('@for') {
|
||||
s.writeln(tmpl.str_end)
|
||||
pos := line.index('@for') or { continue }
|
||||
s.writeln('for ' + line[pos + 4..] + '{')
|
||||
s.writeln(tmpl.str_start)
|
||||
} else if state == .html && line.contains('span.') && line.ends_with('{') {
|
||||
// `span.header {` => `<span class='header'>`
|
||||
class := line.find_between('span.', '{').trim_space()
|
||||
s.writeln('<span class="$class">')
|
||||
in_span = true
|
||||
} else if state == .html && line.contains('.') && line.ends_with('{') {
|
||||
// `.header {` => `<div class='header'>`
|
||||
class := line.find_between('.', '{').trim_space()
|
||||
s.writeln('<div class="$class">')
|
||||
} else if state == .html && line.contains('#') && line.ends_with('{') {
|
||||
// `#header {` => `<div id='header'>`
|
||||
class := line.find_between('#', '{').trim_space()
|
||||
s.writeln('<div id="$class">')
|
||||
} else if state == .html && line == '}' {
|
||||
if in_span {
|
||||
s.writeln('</span>')
|
||||
in_span = false
|
||||
} else {
|
||||
s.writeln('</div>')
|
||||
}
|
||||
} else {
|
||||
// HTML, may include `@var`
|
||||
// escaped by cgen, unless it's a `vweb.RawHtml` string
|
||||
s.writeln(line.replace('@', '$').replace('$$', '@').replace("'", "\\'"))
|
||||
}
|
||||
}
|
||||
s.writeln(tmpl.str_end)
|
||||
s.writeln('_tmpl_res_$fn_name := sb.str() ')
|
||||
s.writeln('}')
|
||||
s.writeln('// === end of vweb html template ===')
|
||||
return s.str()
|
||||
}
|
||||
Reference in New Issue
Block a user