File: element_content.mli

package info (click to toggle)
tyxml 4.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 944 kB
  • sloc: ml: 9,712; makefile: 91; javascript: 3
file content (93 lines) | stat: -rw-r--r-- 3,026 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
(* TyXML
 * http://www.ocsigen.org/tyxml
 * Copyright (C) 2016 Anton Bachin
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1301, USA.
*)

(** Element child argument assemblers. These are almost parsers, except they
    only tell how to pass already-parsed children to element functions. *)

type assembler =
  lang:Common.lang ->
  loc:Location.t ->
  name:string ->
  expression Common.value list ->
  (arg_label * expression) list
(** Assemblers satisfy: [assembler ~lang ~loc ~name children] evaluates
    to a list of optionally-labeled parse trees for passing [children] to the
    the element function for element [name]. For example, for a table element

{[
<table>
  <thead>
    <tr><th>A</th><th>B</th></tr>
  </thead>
  <tbody>
  </tbody>
</table>
]}

    The assembler [table], when called with the parsed children, will evaluate
    to parse trees representing

{[
~thead:(* the thead element *) [(* the tbody element *)]
]}

    This satisfies the child arguments in the signature of
    [Html_sigs.T.tablex]. The [~table] label is represented by the string
    ["table"], and the unlabeled list argument is paired with the empty string.

    The argument [implementation] is the name of the module providing the
    run-time implementation of the element function that will be applied to the
    children. It is either [Html] or [Svg], and is based on the element's
    namespace. It is used for wrapping child elements, and for scoping child
    [txt] elements.

    The [name] argument is used for error reporting. *)

(** {2 Generic} *)

val nullary : assembler
val unary : assembler
val star : assembler

(** {2 Special-cased} *)

val html : assembler
val head : assembler
val figure : assembler
val object_ : assembler
val audio_video : assembler
val table : assembler
val fieldset : assembler
val datalist : assembler
val details : assembler
val menu : assembler
val picture : assembler
val script : assembler
val textarea : assembler

(** {1 Misc utilities} *)

(** Remove txt node containing only whitespace that are at the beginning or the end
    of the list. *)
val filter_surrounding_whitespace :
  expression Common.value list ->
  expression Common.value list

(** Improve an assembler by removing txt nodes containing only whitespace *)
val comp_filter_whitespace : assembler -> assembler