-
Notifications
You must be signed in to change notification settings - Fork 125
/
elvis.opa
150 lines (128 loc) · 4.48 KB
/
elvis.opa
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
Copyright © 2011 MLstate
This file is part of OPA.
OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
OPA 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 Affero General Public License for
more details.
You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Elvis
*
* @category UI
* @author David Rajchenbach-Teller, 2011
* @destination PUBLIC
* @stability EXPERIMENTAL
*/
/**
* An elvis ("element of vision") is a data structure that can be displayed in the browser screen.
* Elvises are abstract data structures, characterized by the events they can post (the "sources")
* and their accessors.
*
* ** Relationships between Elvises and Xhtml
* - elvises are not xhtml (although they are certainly implemented as such)
* - elvises are not referenced by their ID
* - for display, elvises are inserted into xhtml
* - styling, positioning, etc. are done with CSS and selectors, through the indirection of the [Styler] widget
* - DOM events are used to implement Elvis, but they are low-level informations, not meant to be seen outside the Elvis
*
* ** Events
* - each Elvis publishes a number of [source]s, corresponding the events it can send
* - a channel or a function can be registered to listen on a [source], and possibly unregistered later
* - an Elvis MUST NOT listen to its own [source]s
*
* ** Implementation guidelines
* - Each xhtml node in an Elvis should have a class name
*/
/**
* {1 Standard event names}
*
* - [{chosen: void}] -- a button was pressed, an item was selected in a list, etc.
* - [{value_changed: {old: 'a new:'a}}]
* - [{value_rejected:{old: 'a rejected:'b}}]
*/
@abstract type Elvis.elvis('sources, 'implem) = {
sources: 'sources /**Sources of events that the elvis can send (e.g. "selected", "value changed", etc.)
Use this to register event observers (or, possibly, to trigger artificial events).
Note: By design, an elvis MUST NOT register with its own sources.*/
implem: 'implem /**Anything that may be needed to access the functions of this elvis, e.g. to set content*/
display: Elvis.theme ->/**Anything required to (re)display the elvis.*/
{
xhtml: xhtml /**The xhtml code for the display part of this elvis.*/
dom: dom /**A {e concrete} [dom] corresponding to [xhtml] page.*/
}
}
@abstract type Elvis.masked = {}
@abstract type Elvis.theme = list(string)
Elvis = {{
/**
* Convert an elvis into something that can be injected on a page
*
* Note: Called automatically by magic_to_xhtml
*/
for_display(elvis: Elvis.elvis(_, _)): xhtml =
(
for_display_in_theme(elvis, (["mlstate_default"]))
)
/**
* Convert an elvis into something that can be injected on a page
*/
for_display_in_theme(elvis: Elvis.elvis(_, _), theme: Elvis.theme): xhtml =
(
(elvis).display(theme).xhtml
)
/**
* Access the event sources of the elvis
*/
sources(elvis: Elvis.elvis('sources, 'implem)): 'sources =
(
(elvis).sources
)
implem(elvis: Elvis.elvis('sources, 'implem)): 'implem =
(
(elvis).implem
)
/**
* Construct an Elvis
*/
make(sources: 'sources, implem: 'implem, display: Elvis.theme -> {xhtml:xhtml; dom:dom}): Elvis.elvis('sources, 'implem) =
(
({~sources ~implem ~display})
)
/**
* Existential stuff
*/
pack(elvis: Elvis.elvis(_, _)): Elvis.elvis(Elvis.masked, Elvis.masked) =
(
({sources=masked implem=masked display=(elvis).display})
)
pack_sources(elvis: Elvis.elvis(_, 'b)): Elvis.elvis(Elvis.masked, 'b) =
(
({sources=masked implem=(elvis).implem display=(elvis).display})
)
pack_implem(elvis: Elvis.elvis('a, _)): Elvis.elvis('a, Elvis.masked) =
(
({sources=(elvis).sources implem=masked display=(elvis).display})
)
masked: Elvis.masked = ({})
Theme =
{{
of_classes(classes: list(string)): Elvis.theme =
(
(classes)
)
get_classes(theme: Elvis.theme): string =
(
List.to_string_using("", "", " ", (theme))
)
add_class(class:string, theme: Elvis.theme): Elvis.theme =
(
([class | (theme)])
)
}}
}}