-
+
+
+
+
+ Imports
-
+
Imports
+ +
-
+ NwtTokenKind = enum + + + + +++ +Types
++
--- -
Token = object kind*: NwtTokenKind value*: string line*: int - charinbuf*: int -- - - - -
+ charinbuf*: int +- + + + +
Loop[T] = object +Types
+
Loop[T] = object index*: int ## which element (start from 1) index0*: int ## which elemen (start from 0) first*: bool ## if this is the first loop iteration @@ -245,122 +189,151 @@Types
nextitem*: Option[T] ## get the item from the next loop iteration length*: int ## the length of the seq, (same as mySeq.len()) revindex0*: int ## which element, counted from the end (last one is 0) - revindex*: int ## which element, counted from the end (last one is 1) -
allowedCharsInSlug = {'0'..'9', 'A'..'Z', 'a'..'z'}
allowedCharsInSlug = {'0'..'9', 'A'..'Z', 'a'..'z'}
proc cycle[T](loop: Loop; elems: openArray[T]): T
{% for (loop, row) in rows.loop() %} +Procs
+
proc cycle[T](loop: Loop; elems: openArray[T]): T
{% for (loop, row) in rows.loop() %} <li class="{{ loop.cycle(@["odd", "even"]) }}">{{ row }}</li> {% endfor %}- -
proc includeRaw(path: string): string {....raises: [IOError], tags: [ReadIOEffect].}
proc includeRawStatic(path: static string): string
proc includeRaw(path: string): string {....raises: [IOError], tags: [ReadIOEffect], + forbids: [].}
proc includeRawStatic(path: static string): string
proc includeStaticAsDataurl(path: static string; ++-+-- -
proc includeStaticAsDataurl(path: static string; mimeOverride: static string = ""): string- - -Includes a ressource as a dataurl on compile time. - -
+- + + Includes a ressource as a dataurl on compile time. + +
--- -
func nl2br(str: string; keepNl = true): string {....raises: [], tags: [].}- - -Converts all n to <br> if keepNL == true: newlines will still be in the output. -
--- -
proc slugify(str: string; sperator = "-"; allowedChars = allowedCharsInSlug): string {. - ...raises: [], tags: [].}- - -converts any string to an url friendly one. Removes any special chars and replaces non ASCII runes to their ASCII representation. - -
+++-- +
func nl2br(str: string; keepNl = true): string {....raises: [], tags: [], + forbids: [].}- + + Converts all n to <br> if keepNL == true: newlines will still be in the output. + +
-+- -
func spaceless(str: string): string {....raises: [], tags: [].}- -Removes unneeded whitespaces between html tags, warning, this is NOT smart. So it will destroy <textarea> and <pre> content! +
+-+-- +
proc slugify(str: string; sperator = "-"; allowedChars = allowedCharsInSlug): string {. + ...raises: [], tags: [], forbids: [].}- + + converts any string to an url friendly one. Removes any special chars and replaces non ASCII runes to their ASCII representation. + +
+-+ +- -
proc truncate(str: string; num: Natural; preserveWords = true; suf = "..."): string {. - ...raises: [], tags: [].}- +
+++-truncates a string to "num" characters. when the string was truncated it appends the suf to the text. if preserveWords is true it will not cut words in half but the output string could be shorter than num characters. +- +
func spaceless(str: string): string {....raises: [], tags: [], forbids: [].}- + + Removes unneeded whitespaces between html tags, warning, this is NOT smart. So it will destroy <textarea> and <pre> content! + +
++-+-- +
proc truncate(str: string; num: Natural; preserveWords = true; suf = "..."): string {. + ...raises: [], tags: [], forbids: [].}- + + truncates a string to "num" characters. when the string was truncated it appends the suf to the text. if preserveWords is true it will not cut words in half but the output string could be shorter than num characters. + +
+-Iterators
--
+-+- -
iterator loop[T](a: openArray[T]): tuple[loop: Loop[T], val: T] {.inline.}- - -yields a Loop object with every item. Inside the loop body you have access to the following fields.
{% for (loop, row) in rows.loop() %} +Iterators
++
+-+-- +
iterator loop[T](a: openArray[T]): tuple[loop: Loop[T], val: T] {.inline.}- + + yields a Loop object with every item. Inside the loop body you have access to the following fields.
+{% for (loop, row) in rows.loop() %} {{ loop.index0 }} {{ loop.index }} {{ loop.revindex0 }} @@ -372,61 +345,75 @@+ +Iterators
{% if loop.nextitem.isSome() %}{{ loop.nextitem.get() }}{% endif %} <li class="{{ loop.cycle(@["odd", "even"]) }}">{{row}}</li> {% endfor %}-Macros
--
+-+- -
macro `|`(aa, bb: untyped): string- - -'filter' alias, often used in other template engines. a | b is an alias to a.b. This enables syntax like this: .. code-block:: Nim
- +{{ "foo baa baz" | slugify()}}
Macros
++
+-+-- +
macro `|`(aa, bb: untyped): string- + + 'filter' alias, often used in other template engines. a | b is an alias to a.b. This enables syntax like this: .. code-block:: Nim {{ "foo baa baz" | slugify()}} + +
+-Templates
--
-- -
template `?`(con, body: untyped): untyped- - -shorthand if eg. for toggling html classes.
+<input class="{% ?isDisabled: "disable" %}">- -Templates
++
++++-- +
template `?`(con, body: untyped): untyped- + + shorthand if eg. for toggling html classes.
<input class="{% ?isDisabled: "disable" %}">+ +-+- -
template `~`(aa, bb: untyped): string- -
~ (tilde) Converts all operands into strings and concatenates them. like: $aa & $bb
++-+-- +
template `~`(aa, bb: untyped): string- + +
+~ (tilde) Converts all operands into strings and concatenates them. like: $aa & $bb
{{ "Hello " ~ name ~ "!" }} would return (assuming name is set to 'Nim') Hello Nim!.
+ +
macro compileTemplateFile(path: static string; iter: static bool = false; +Macros
+
macro compileTemplateFile(path: static string; baseDir: static string = ""; + iter: static bool = false; varname: static string = "result"; context: untyped = nil): untyped
proc yourFunc(yourParams: bool): string = +
proc yourFunc(yourParams: bool): string = compileTemplateFile(getScriptDir() / "relative/path.nimja) echo yourFunc(true)
If iter = true then the macro can be used in an iterator body this could be used for streaming templates, or to save memory when a big template is rendered and the http server can send data in chunks.
@@ -182,16 +130,20 @@macro compileTemplateStr(str: typed; iter: static bool = false; +++-- -
macro compileTemplateStr(str: typed; baseDir: static string = ""; + iter: static bool = false; varname: static string = "result"; context: untyped = nil): untyped- - -Compiles a Nimja template from a string.
proc yourFunc(yourParams: bool): string = +- + + Compiles a Nimja template from a string.
+ +proc yourFunc(yourParams: bool): string = compileTemplateString("{%if yourParams%}TRUE{%endif%}") echo yourFunc(true)If iter = true then the macro can be used in an iterator body this could be used for streaming templates, or to save memory when a big template is rendered and the http server can send data in chunks.
@@ -210,28 +162,36 @@Macros
var foo = 123 proc render(): string = compileTemplateString("{{node.bb}}{{baa}}", {node: rax, baa: foo}) - --+- -
macro tmplf(str: static string; context: untyped = nil): string- -Compiles a Nimja template file and returns directly. Can be used inline, without a wrapper proc.
echo tmplf("""/some/template.nimja""")A context can be supplied to the template, to override the variable names:
+++ ++-- +
macro tmplf(str: static string; baseDir: static string = ""; + context: untyped = nil): string- + + Compiles a Nimja template file and returns directly. Can be used inline, without a wrapper proc.
+ +echo tmplf("""/some/template.nimja""")A context can be supplied to the template, to override the variable names:
type Rax = object aa: string bb: float var rax = Rax(aa: "aaaa", bb: 13.37) echo tmplf("""/some/template.nimja""", {node: rax})- --+- -
macro tmpls(str: static string; context: untyped = nil): string- -Compiles a Nimja template string and returns directly. Can be used inline, without a wrapper proc.
echo tmpls("""{% if true %}Is true!{% endif %}""")A context can be supplied to the template, to override the variable names:
++-+-- +
macro tmpls(str: static string; baseDir: static string = ""; + context: untyped = nil): string- + + Compiles a Nimja template string and returns directly. Can be used inline, without a wrapper proc.
+echo tmpls("""{% if true %}Is true!{% endif %}""")A context can be supplied to the template, to override the variable names:
type Rax = object aa: string @@ -239,29 +199,34 @@+ +Macros
var rax = Rax(aa: "aaaa", bb: 13.37) var foo = 123 echo tmpls("""{% if node.aa == "aaaa" %}{{node.bb}}{% endif %}{{baa}}""", {node: rax, baa: foo})-+Exports
--getScriptDir -
Exports
+
template getScriptDir(): string
Helper for staticRead.
+ + + + +template getScriptDir(): string
Helper for staticRead.
returns the absolute path to your project, on compile time.
- -template read(path: untyped): untyped
template read(path: untyped): untyped