forked from ariatemplates/ariatemplates
-
Notifications
You must be signed in to change notification settings - Fork 0
/
BaseCtxt.js
210 lines (194 loc) · 8.31 KB
/
BaseCtxt.js
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
* Copyright 2012 Amadeus s.a.s.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A context object is a wrapper around a Template. It provides the basic methods needed to call a macro on a template.
* This class is extended by aria.templates.TemplateCtxt and aria.templates.CSSCtxt
*/
Aria.classDefinition({
$classpath : "aria.templates.BaseCtxt",
$singleton : false,
$constructor : function () {
/**
* Configuration parameters passed to initTemplate. Bean: aria.templates.CfgBeans.InitCSSTemplateCfg
* @type Object
* @protected
*/
this._cfg = null;
/**
* List of chunks generated by the template engine
* @type Array
* @protected
*/
this._out = null;
/**
* CSS template that the context is wrapping
* @protected
* @type aria.templates.CSSTemplate
*/
this._tpl = null;
/**
* Stores references to the macro libraries accessed by the template or library
* @protected
* @type Array
*/
this._macrolibs = [];
/**
* Stores references to the CSS macro libraries accessed by the CSS template or CSS library
* @protected
* @type Array
*/
this._csslibs = [];
},
$destructor : function () {
// call destructor foreach in this._macrolibs, this._csslibs
if (!this._macrolibs && !this._csslibs) {
return;
}
this.__disposeLibs(this._macrolibs);
this.__disposeLibs(this._csslibs);
this._macrolibs = null;
this._csslibs = null;
},
$statics : {
// ERROR MESSAGES:
TEMPLATE_CONSTR_ERROR : "Error while creating a new instance of template '%1' - please check script constructor.",
TEMPLATE_DESTR_ERROR : "Error while destroying an instance of template '%1' - please check script destructor.",
MACRO_NOT_FOUND : "Missing macro '%1' in template '%2'.",
MACRO_CALL_ERROR : "Error while calling macro '%1' in template '%2'.",
LIBRARY_HANDLE_CONFLICT : "Template error: can't load shared macro library '%1'. A macro, text template, variable or another library has already been declared with the same name.",
LIBRARY_ALREADY_LOADED : "Template error: library at classpath '%1' has already been loaded."
},
$prototype : {
/**
* Check that a macro object is correctly defined A macro object should have
*
* <pre>
* {name : String, args: Array}
* </pre>
*/
checkMacro : function (macro) {
if (macro == null) {
return this._cfg.macro;
}
if (typeof(macro) == "string") {
macro = {
name : macro,
args : [],
scope : this._tpl
};
} else {
if (macro.args == null) {
macro.args = [];
}
if (macro.scope == null) {
macro.scope = this._tpl;
}
}
// TODO: add a stronger check
return macro;
},
/**
* Call a macro. Note: this protected function is also called from the out object (MarkupWriter).
* @protected
*/
_callMacro : function (out, macro) {
this.$assert(62, this._out != null);
macro = this.checkMacro(macro);
var tpl = macro.scope;
var fct = tpl["macro_" + macro.name];
if (fct == null) {
this.$logError(this.MACRO_NOT_FOUND, [macro.name, tpl.$classpath]);
}
try {
fct.apply(tpl, macro.args);
} catch (ex) {
this.$logError(this.MACRO_CALL_ERROR, [macro.name, tpl.$classpath], ex);
}
},
/**
* Private function, creates links to the macro libraries / CSS macro libraries declared in the template. Sets
* handle names as properties of the template pointing to the appropriate library.
* @param {Object} libsMap A map of all libraries declared by the template, Library, CSS template or CSS library
* in the form { handle : "class.path", handle2 : "class.path2" }
* @param {String} libsType Indicates whether macro libs or CSS libs are loaded.
*/
__loadLibs : function (libsMap, libsType) {
this.$assert(134, (libsType == "macrolibs" || libsType == "csslibs"));
if (libsType == "macrolibs") {
var libsArray = this._macrolibs;
var ctxtLibsContainerName = "__$macrolibs";
var libCtxtClass = aria.templates.TemplateCtxt;
var itf = aria.templates.ITemplate;
} else if (libsType == "csslibs") {
var libsArray = this._csslibs;
var ctxtLibsContainerName = "__$csslibs";
var libCtxtClass = aria.templates.CSSCtxt;
var itf = aria.templates.ICSS;
}
// libsMap ~= {myLib : "path.to.lib1", otherLib : "path.to.otherLib"}
var allClasspaths = {}; // simply stores all classpaths which need to be loaded, to avoid repetitions
var allCPlength = 0; // number of classpaths to be loaded
for (var handle in libsMap) {
if (libsMap.hasOwnProperty(handle)) {
if (this._tpl[handle] !== undefined) {
// a variable, macro or other library with the same name has already been declared
// ignore the library declaration
delete libsMap[handle];
this.$logError(this.LIBRARY_HANDLE_CONFLICT, [handle]);
continue;
} else if (allClasspaths[libsMap[handle]]) {
// we've already loaded a library with the same classpath: throw an error
this.$logError(this.LIBRARY_ALREADY_LOADED, [handle]);
continue;
}
allClasspaths[libsMap[handle]] = true;
allCPlength++;
}
}
if (allCPlength === 0) {
// no deps - sync cb
return;
}
for (var handle in libsMap) {
if (libsMap.hasOwnProperty(handle)) {
// bind handle to template scope
this._tpl[handle] = Aria.getClassInstance(libsMap[handle]);
// TODO: clean this code which uses a template context without initializing it the
// usual way (there is no call to the initTemplate method, because a library has less things to do,
// but there should be a common initialization method for things which are common)
// Create a shortcut for the __$write method which is often used:
this._tpl[handle].__$write = this._tpl.__$write;
var libCtxt = new libCtxtClass();
libCtxt._tpl = this._tpl[handle];
libsArray.push(libCtxt);
itf.call(this._tpl[handle], libCtxt);
libCtxt._tpl.__$initTemplate();
libCtxt.__loadLibs(libCtxt._tpl[ctxtLibsContainerName], libsType);
}
}
},
/**
* Private function, disposes macro libraries / CSS macro libraries.
* @param {Array} libs contains libraries to dispose
*/
__disposeLibs : function (libs) {
for (var i = 0; i < libs.length; i++) {
var lib = libs[i];
aria.templates.ITemplate.prototype.$destructor.call(lib._tpl);
lib.$dispose();
}
}
}
});