0
|
1 |
#
|
|
2 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
# All rights reserved.
|
|
4 |
# This component and the accompanying materials are made available
|
|
5 |
# under the terms of "Eclipse Public License v1.0"
|
|
6 |
# which accompanies this distribution, and is available
|
|
7 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
#
|
|
9 |
# Initial Contributors:
|
|
10 |
# Nokia Corporation - initial contribution.
|
|
11 |
#
|
|
12 |
# Contributors:
|
|
13 |
#
|
|
14 |
# Description:
|
|
15 |
#
|
|
16 |
'''
|
|
17 |
Template plugin for ConE that handles templateml files. Utilizes Jinja template engine.
|
|
18 |
'''
|
|
19 |
|
|
20 |
import re
|
|
21 |
import os
|
|
22 |
import logging
|
|
23 |
import codecs
|
3
|
24 |
import pkg_resources
|
|
25 |
from jinja2 import Environment, DictLoader
|
0
|
26 |
import traceback
|
|
27 |
try:
|
|
28 |
from cElementTree import ElementTree
|
|
29 |
except ImportError:
|
|
30 |
try:
|
|
31 |
from elementtree import ElementTree
|
|
32 |
except ImportError:
|
|
33 |
try:
|
|
34 |
from xml.etree import cElementTree as ElementTree
|
|
35 |
except ImportError:
|
|
36 |
from xml.etree import ElementTree
|
|
37 |
|
|
38 |
try:
|
|
39 |
from cElementTree import ElementInclude
|
|
40 |
except ImportError:
|
|
41 |
try:
|
|
42 |
from elementtree import ElementInclude
|
|
43 |
except ImportError:
|
|
44 |
try:
|
|
45 |
from xml.etree import cElementInclude as ElementInclude
|
|
46 |
except ImportError:
|
|
47 |
from xml.etree import ElementInclude
|
|
48 |
|
|
49 |
|
3
|
50 |
from cone.public import exceptions,plugin,utils
|
0
|
51 |
|
|
52 |
ROOT_PATH = os.path.dirname(os.path.abspath(__file__))
|
|
53 |
|
|
54 |
class TemplatemlImpl(plugin.ImplBase):
|
|
55 |
|
|
56 |
context = None
|
|
57 |
|
|
58 |
"""
|
|
59 |
Implementation class of template plugin.
|
|
60 |
"""
|
|
61 |
|
3
|
62 |
IMPL_TYPE_ID = "templateml"
|
0
|
63 |
|
|
64 |
def __init__(self,ref,configuration, reader=None):
|
|
65 |
"""
|
|
66 |
Overloading the default constructor
|
|
67 |
"""
|
|
68 |
plugin.ImplBase.__init__(self,ref,configuration)
|
|
69 |
self.logger = logging.getLogger('cone.templateml(%s)' % self.ref)
|
|
70 |
self.errors = False
|
|
71 |
self.reader = reader
|
|
72 |
if self.reader and self.reader.tags:
|
|
73 |
self.set_tags(self.reader.tags)
|
3
|
74 |
|
|
75 |
def __getstate__(self):
|
|
76 |
state = super(TemplatemlImpl, self).__getstate__()
|
|
77 |
state['reader'] = self.reader
|
|
78 |
return state
|
0
|
79 |
|
3
|
80 |
def get_context(self, generation_context):
|
|
81 |
ddict = generation_context.impl_data_dict
|
|
82 |
if ddict.get('templateml_context', None) is None:
|
|
83 |
ddict['templateml_context'] = self.create_dict()
|
|
84 |
return ddict['templateml_context']
|
0
|
85 |
|
|
86 |
def generate(self, context=None):
|
|
87 |
"""
|
|
88 |
Generate the given implementation.
|
|
89 |
"""
|
3
|
90 |
self.context = context
|
|
91 |
self.logger.debug('Generating from %s:%s' % (self.ref, self.lineno))
|
|
92 |
self.create_output(context)
|
0
|
93 |
return
|
|
94 |
|
3
|
95 |
def create_output(self, generation_context):
|
|
96 |
templateml_context = self.get_context(generation_context)
|
|
97 |
templateml_context['gen_context'] = generation_context
|
|
98 |
if not generation_context.configuration:
|
|
99 |
generation_context.configuration = self.configuration
|
|
100 |
self.reader.expand_output_refs_by_default_view()
|
|
101 |
generator = Generator(self.reader.outputs, self.reader.filters, templateml_context, self)
|
|
102 |
generator.generate(generation_context, self.ref)
|
0
|
103 |
return
|
|
104 |
|
|
105 |
def get_refs(self):
|
|
106 |
refs = []
|
|
107 |
for output in self.reader.outputs:
|
|
108 |
template = output.template.template
|
|
109 |
refs.extend(self._extract_refs_from_template(template))
|
3
|
110 |
refs_oa = self._extract_refs_from_output_attribs(output)
|
|
111 |
for r in refs_oa:
|
|
112 |
if refs.count(r) < 1:
|
|
113 |
refs.append(r)
|
|
114 |
return refs
|
|
115 |
|
|
116 |
def _extract_refs_from_output_attribs(self, output):
|
|
117 |
refs = []
|
|
118 |
pattern = re.compile(r'\$\{(.*)\}', re.UNICODE)
|
|
119 |
for key, value in vars(output).iteritems():
|
|
120 |
m = pattern.search(str(value))
|
|
121 |
if m:
|
|
122 |
ref = m.group(1)
|
|
123 |
refs.append(ref)
|
|
124 |
if key == 'ref':
|
|
125 |
refs.append(value)
|
0
|
126 |
return refs
|
|
127 |
|
|
128 |
@classmethod
|
|
129 |
def _extract_refs_from_template(cls, template_text):
|
|
130 |
refs = []
|
|
131 |
pattern = re.compile(r'feat_tree\.((?:\.?\w+)*)', re.UNICODE)
|
|
132 |
for m in re.finditer(pattern, template_text):
|
|
133 |
ref = m.group(1)
|
|
134 |
|
|
135 |
# ref may now be e.g. 'MyFeature.MySetting._value', so
|
|
136 |
# remove the last part if it starts with an underscore
|
|
137 |
index = ref.rfind('.')
|
|
138 |
if index != -1 and index < len(ref) and ref[index + 1] == '_':
|
|
139 |
ref = ref[:index]
|
|
140 |
|
|
141 |
refs.append(ref)
|
|
142 |
return refs
|
|
143 |
|
|
144 |
def has_ref(self, refs):
|
|
145 |
"""
|
|
146 |
@returns True if the implementation uses the given ref as input value.
|
|
147 |
Otherwise return False.
|
|
148 |
"""
|
|
149 |
|
|
150 |
# Does not support template inheritance
|
|
151 |
|
|
152 |
if not isinstance(refs, list):
|
|
153 |
refs = [refs]
|
|
154 |
|
|
155 |
for output in self.reader.outputs:
|
|
156 |
if re.search("feat_list.*", output.template.template) != None:
|
|
157 |
return True
|
3
|
158 |
return plugin.uses_ref(refs, self.get_refs())
|
0
|
159 |
|
|
160 |
|
|
161 |
def list_output_files(self):
|
|
162 |
""" Return a list of output files as an array. """
|
|
163 |
result = []
|
|
164 |
for output in self.reader.outputs:
|
3
|
165 |
filename = ""
|
|
166 |
if output.fearef != None:
|
|
167 |
filename = self.configuration.get_default_view().get_feature(output.fearef).value
|
|
168 |
else:
|
|
169 |
filename = output.filename
|
|
170 |
result.append(os.path.normpath(os.path.join(self.output, output.path, filename)))
|
0
|
171 |
return result
|
|
172 |
|
|
173 |
def create_dict(self):
|
|
174 |
"""
|
|
175 |
Creates dict from configuration that can be passed to template engine.
|
|
176 |
"""
|
|
177 |
|
|
178 |
context_dict = {}
|
|
179 |
|
|
180 |
if self.configuration:
|
|
181 |
dview = self.configuration.get_default_view()
|
|
182 |
feat_list = []
|
3
|
183 |
feat_tree = FeatureDictProxy(None)
|
0
|
184 |
|
|
185 |
def add_feature(feature, feature_dict):
|
|
186 |
fea_dict = FeatureDictProxy(feature)
|
|
187 |
feat_list.append(fea_dict)
|
|
188 |
feature_dict[feature.ref] = fea_dict
|
|
189 |
|
|
190 |
# Recursively add sub-features
|
|
191 |
for sfeat in feature.list_features():
|
|
192 |
add_feature(feature.get_feature(sfeat), fea_dict)
|
|
193 |
|
|
194 |
for fea in dview.list_features():
|
|
195 |
add_feature(dview.get_feature(fea), feat_tree)
|
|
196 |
|
|
197 |
context_dict['feat_list'] = feat_list
|
|
198 |
context_dict['feat_tree'] = feat_tree
|
|
199 |
context_dict['configuration'] = self.configuration
|
|
200 |
|
|
201 |
return context_dict
|
|
202 |
|
|
203 |
def _expand_refs(text, config):
|
|
204 |
if config is not None:
|
|
205 |
return utils.expand_refs_by_default_view(text, config.get_default_view())
|
|
206 |
else:
|
|
207 |
return text
|
|
208 |
|
|
209 |
def _read_relative_file(configuration, relative_path, file_path):
|
|
210 |
"""
|
|
211 |
Read data from a file relative to the given other file path.
|
|
212 |
"""
|
|
213 |
# Get the actual path (relative to the current file)
|
|
214 |
base_path = os.path.dirname(file_path)
|
|
215 |
tempfile_path = os.path.normpath(os.path.join(base_path, relative_path)).replace('\\', '/')
|
|
216 |
|
|
217 |
# Read the file
|
|
218 |
resource = configuration.get_resource(tempfile_path)
|
|
219 |
try: return resource.read()
|
|
220 |
finally: resource.close()
|
|
221 |
|
|
222 |
class TemplatemlImplReader(plugin.ReaderBase):
|
|
223 |
"""
|
|
224 |
Parses a single templateml file
|
|
225 |
"""
|
|
226 |
NAMESPACE = 'http://www.s60.com/xml/templateml/1'
|
3
|
227 |
NAMESPACE_ID = 'templateml'
|
|
228 |
ROOT_ELEMENT_NAME = 'templateml'
|
0
|
229 |
FILE_EXTENSIONS = ['templateml']
|
3
|
230 |
NEWLINE_WIN_PARSE_OPTIONS = ['win', 'windows', 'dos', 'symbian', 'symbianos', 'cr+lf', 'crlf']
|
0
|
231 |
|
|
232 |
def __init__(self, resource_ref=None, configuration=None):
|
|
233 |
self.desc = None
|
|
234 |
self.namespaces = [self.NAMESPACE]
|
|
235 |
self.outputs = None
|
|
236 |
self.filters = None
|
|
237 |
self.tags = None
|
|
238 |
self.resource_ref = resource_ref
|
|
239 |
self.configuration = configuration
|
|
240 |
|
|
241 |
|
|
242 |
@classmethod
|
|
243 |
def read_impl(cls, resource_ref, configuration, etree):
|
|
244 |
reader = TemplatemlImplReader(resource_ref, configuration)
|
|
245 |
reader.from_elementtree(etree)
|
|
246 |
return TemplatemlImpl(resource_ref, configuration, reader)
|
|
247 |
|
3
|
248 |
@classmethod
|
|
249 |
def get_schema_data(cls):
|
|
250 |
return pkg_resources.resource_string('templatemlplugin', 'xsd/templateml.xsd')
|
|
251 |
|
0
|
252 |
def fromstring(self, xml_string):
|
|
253 |
etree = ElementTree.fromstring(xml_string)
|
|
254 |
self.from_elementtree(etree)
|
|
255 |
|
|
256 |
def from_elementtree(self, etree):
|
|
257 |
ElementInclude.include(etree)
|
|
258 |
self.desc = self.parse_desc(etree)
|
|
259 |
self.outputs = self.parse_outputs(etree)
|
|
260 |
self.filters = self.parse_filters(etree)
|
|
261 |
self.tags = self.parse_tags(etree)
|
|
262 |
|
|
263 |
def parse_desc(self,etree):
|
|
264 |
desc = ""
|
|
265 |
desc_elem = etree.find("{%s}desc" % self.namespaces[0])
|
|
266 |
if desc_elem != None:
|
|
267 |
desc = desc_elem.text
|
|
268 |
return desc
|
|
269 |
|
|
270 |
def parse_filters(self, etree):
|
|
271 |
filters = []
|
|
272 |
filter_elems = etree.findall("{%s}filter" % self.namespaces[0])
|
|
273 |
for filter_elem in filter_elems:
|
|
274 |
if filter_elem != None:
|
|
275 |
filter = Filter()
|
|
276 |
|
|
277 |
if filter_elem.get('name') != None:
|
|
278 |
name = filter_elem.get('name')
|
|
279 |
if self.configuration != None:
|
|
280 |
name = utils.expand_refs_by_default_view(name, self.configuration.get_default_view())
|
|
281 |
filter.set_name(name)
|
|
282 |
if filter_elem.get('file') != None:
|
|
283 |
file = filter_elem.get('file')
|
|
284 |
if self.configuration != None:
|
|
285 |
file = utils.expand_refs_by_default_view(file, self.configuration.get_default_view())
|
|
286 |
filter.set_path(file)
|
|
287 |
if filter_elem.text != None:
|
|
288 |
filter.set_code(filter_elem.text)
|
|
289 |
if filter_elem.get('file') != None:
|
|
290 |
logging.getLogger('cone.templateml').warning("In filter element file attribute and text defined. Using filter found from file attribute.")
|
|
291 |
filters.append(filter)
|
4
|
292 |
|
|
293 |
filters_elems = etree.findall("{%s}filters" % self.namespaces[0])
|
|
294 |
for filters_elem in filters_elems:
|
|
295 |
if filters_elem != None:
|
|
296 |
filter = Filter()
|
|
297 |
if filters_elem.get('file') != None:
|
|
298 |
file = filters_elem.get('file')
|
|
299 |
if self.configuration != None:
|
|
300 |
file = utils.expand_refs_by_default_view(file, self.configuration.get_default_view())
|
|
301 |
filter.set_path(file)
|
|
302 |
if filters_elem.text != None:
|
|
303 |
filter.set_code(filters_elem.text)
|
|
304 |
if filters_elem.get('file') != None:
|
|
305 |
logging.getLogger('cone.templateml'). warning("In filters element file attribute and text defined. Using filters found from file attribute.")
|
|
306 |
filters.append(filter)
|
|
307 |
|
0
|
308 |
return filters
|
|
309 |
|
|
310 |
def parse_tags(self, etree):
|
|
311 |
tags = {}
|
|
312 |
for tag in etree.getiterator("{%s}tag" % self.namespaces[0]):
|
|
313 |
tagname = tag.get('name','')
|
|
314 |
tagvalue = tag.get('value')
|
|
315 |
values = tags.get(tagname,[])
|
|
316 |
values.append(tagvalue)
|
|
317 |
tags[tagname] = values
|
|
318 |
return tags
|
|
319 |
|
|
320 |
def parse_template(self, output_elem):
|
|
321 |
tempfile = TempFile()
|
|
322 |
template_elems = output_elem.findall("{%s}template" % self.namespaces[0])
|
|
323 |
|
|
324 |
for template_elem in template_elems:
|
|
325 |
if template_elem.text != None:
|
|
326 |
tempfile.set_template(template_elem.text)
|
|
327 |
else:
|
|
328 |
for selem in template_elem:
|
|
329 |
tempfile.set_template(selem.text)
|
|
330 |
|
|
331 |
if template_elem.get('file') != None:
|
|
332 |
file = template_elem.get('file')
|
|
333 |
if template_elem.text != None:
|
|
334 |
logging.getLogger('cone.templateml').warning("In template element file attribute and text defined. Using template found from file attribute.")
|
|
335 |
template_text = _read_relative_file(self.configuration, file, self.resource_ref)
|
|
336 |
tempfile.set_template(template_text)
|
3
|
337 |
|
0
|
338 |
return tempfile
|
|
339 |
|
|
340 |
def parse_outputs(self, etree):
|
|
341 |
outputs = []
|
|
342 |
output_elems = etree.findall("{%s}output" % self.namespaces[0])
|
|
343 |
for output_elem in output_elems:
|
|
344 |
if output_elem != None:
|
|
345 |
outputfile = OutputFile()
|
3
|
346 |
outputfile.set_output_elem(output_elem)
|
0
|
347 |
if output_elem.get('encoding') != None:
|
|
348 |
encoding = output_elem.get('encoding')
|
|
349 |
outputfile.set_encoding(encoding)
|
|
350 |
if output_elem.get('file') != None:
|
|
351 |
file = output_elem.get('file')
|
|
352 |
outputfile.set_filename(file)
|
|
353 |
if output_elem.get('dir') != None:
|
|
354 |
dir = output_elem.get('dir')
|
|
355 |
outputfile.set_path(dir)
|
|
356 |
if output_elem.get('ref'):
|
|
357 |
# Fetch the output value from a configuration reference
|
3
|
358 |
outputfile.set_fearef(output_elem.get('ref'))
|
0
|
359 |
if output_elem.get('bom'):
|
3
|
360 |
outputfile.set_bom(output_elem.get('bom'))
|
|
361 |
if output_elem.get('newline', ''):
|
|
362 |
outputfile.set_newline(output_elem.get('newline', ''))
|
|
363 |
|
0
|
364 |
outputfile.set_template(self.parse_template(output_elem))
|
|
365 |
outputfile.set_filters(self.parse_filters(output_elem))
|
|
366 |
outputs.append(outputfile)
|
3
|
367 |
|
0
|
368 |
return outputs
|
|
369 |
|
3
|
370 |
def expand_output_refs_by_default_view(self):
|
|
371 |
for output in self.outputs:
|
|
372 |
if output.encoding:
|
|
373 |
if self.configuration != None:
|
|
374 |
output.set_encoding(utils.expand_refs_by_default_view(output.encoding, self.configuration.get_default_view()))
|
|
375 |
try:
|
|
376 |
codecs.lookup(output.encoding)
|
|
377 |
except LookupError:
|
|
378 |
raise exceptions.ParseError("Invalid output encoding: %s" % output.encoding)
|
|
379 |
if output.filename:
|
|
380 |
if self.configuration != None:
|
|
381 |
output.set_filename(utils.expand_refs_by_default_view(output.filename, self.configuration.get_default_view()))
|
|
382 |
if output.path:
|
|
383 |
if self.configuration != None:
|
|
384 |
output.set_path(utils.expand_refs_by_default_view(output.path, self.configuration.get_default_view()))
|
|
385 |
if output.newline:
|
|
386 |
newline = output.newline
|
|
387 |
if self.configuration != None:
|
|
388 |
newline = utils.expand_refs_by_default_view(output.newline, self.configuration.get_default_view())
|
|
389 |
if newline.lower() in self.NEWLINE_WIN_PARSE_OPTIONS:
|
|
390 |
output.set_newline(OutputFile.NEWLINE_WIN)
|
|
391 |
if output.bom:
|
|
392 |
bom = output.bom
|
|
393 |
if self.configuration != None:
|
|
394 |
bom = utils.expand_refs_by_default_view(output.bom, self.configuration.get_default_view())
|
|
395 |
output.bom = bom.lower() in ('1', 'true', 't', 'yes', 'y')
|
|
396 |
if output.fearef:
|
|
397 |
if self.configuration != None:
|
|
398 |
fea = self.configuration.get_default_view().get_feature(output.fearef)
|
|
399 |
output.set_filename(fea.value)
|
|
400 |
|
0
|
401 |
class Generator(object):
|
|
402 |
"""
|
|
403 |
Class that generates
|
|
404 |
"""
|
|
405 |
|
3
|
406 |
def __init__(self, outputs, filters, context, implementation=None):
|
0
|
407 |
self.outputs = outputs
|
|
408 |
self.filters = filters
|
|
409 |
self.context = context
|
3
|
410 |
self.implementation = implementation
|
0
|
411 |
|
3
|
412 |
def generate(self, generation_context, ref):
|
0
|
413 |
"""
|
|
414 |
Generates output based on templates
|
|
415 |
"""
|
|
416 |
if self.outputs != None:
|
|
417 |
|
|
418 |
for output in self.outputs:
|
|
419 |
try:
|
3
|
420 |
out_path = output.path
|
|
421 |
out_filepath = os.path.join(out_path, output.filename)
|
|
422 |
logging.getLogger('cone.templateml').debug("Output file '%s', encoding '%s'" % (out_filepath, output.encoding))
|
0
|
423 |
|
3
|
424 |
out_file = generation_context.create_file(out_filepath, implementation=self.implementation)
|
0
|
425 |
|
|
426 |
if output.template.path:
|
3
|
427 |
output.template.template = _read_relative_file(generation_context.configuration, output.template.path, ref)
|
0
|
428 |
|
|
429 |
dict_loader = DictLoader({'template': output.template.template})
|
3
|
430 |
|
|
431 |
if output.newline == OutputFile.NEWLINE_WIN:
|
|
432 |
env = Environment(loader=dict_loader, newline_sequence='\r\n')
|
|
433 |
else:
|
|
434 |
env = Environment(loader=dict_loader)
|
0
|
435 |
|
|
436 |
# Common filters
|
|
437 |
for filter in self.filters:
|
|
438 |
if filter.path:
|
3
|
439 |
filter.code = _read_relative_file(generation_context.configuration, filter.path, ref)
|
0
|
440 |
|
|
441 |
if not filter.code:
|
|
442 |
logging.getLogger('cone.templateml').warning("Skipping empty filter definition.")
|
|
443 |
else:
|
4
|
444 |
# filter elements (lambda functions) have names
|
|
445 |
if filter.name:
|
|
446 |
env.filters[str(filter.name)] = eval(filter.code.replace('\r', ''))
|
|
447 |
# filters elements (any python functions) do not have names
|
|
448 |
else:
|
|
449 |
funcs = {}
|
|
450 |
exec(filter.code.strip().replace('\r', ''), funcs)
|
|
451 |
for k,v in funcs.items():
|
|
452 |
env.filters[k] = v
|
0
|
453 |
|
|
454 |
# Output file specific filters
|
|
455 |
for filter in output.filters:
|
|
456 |
if filter.path:
|
3
|
457 |
filter.code = _read_relative_file(generation_context.configuration, filter.path, ref)
|
0
|
458 |
|
|
459 |
if not filter.code:
|
|
460 |
logging.getLogger('cone.templateml').warning("Skipping empty filter definition.")
|
|
461 |
else:
|
4
|
462 |
if filter.name:
|
|
463 |
env.filters[str(filter.name)] = eval(filter.code.replace('\r', ''))
|
|
464 |
else:
|
|
465 |
funcs = {}
|
|
466 |
exec(filter.code.strip().replace('\r', ''), funcs)
|
|
467 |
for k,v in funcs.items():
|
|
468 |
env.filters[k] = v
|
0
|
469 |
|
|
470 |
template = env.get_template('template')
|
|
471 |
|
|
472 |
file_string = template.render(self.context)
|
|
473 |
out_file.write(self._encode_data(file_string, output.encoding, output.bom))
|
|
474 |
out_file.close()
|
|
475 |
|
|
476 |
except Exception, e:
|
3
|
477 |
utils.log_exception(
|
|
478 |
logging.getLogger('cone.templateml'),
|
|
479 |
'%r: Failed to generate output: %s: %s' % (self.implementation, type(e).__name__, e))
|
0
|
480 |
else:
|
|
481 |
logging.getLogger('cone.templateml').info('No (valid) templates found.')
|
|
482 |
|
|
483 |
def _encode_data(self, data, encoding, write_bom):
|
|
484 |
"""
|
|
485 |
Encode the given data using the given encoding and BOM definition.
|
|
486 |
@param data: The data to encode.
|
|
487 |
@param encoding: The encoding to use.
|
|
488 |
@param write_bom: True or False to define whether the BOM should be written
|
|
489 |
for Unicode encodings, None for default.
|
|
490 |
"""
|
|
491 |
data = data.encode(encoding)
|
|
492 |
|
|
493 |
# Check if we need to do special handling for BOM
|
|
494 |
if write_bom is not None:
|
|
495 |
BOM_MAPPING = {'utf-8' : codecs.BOM_UTF8,
|
|
496 |
'utf-16' : codecs.BOM_UTF16,
|
|
497 |
'utf-16-be' : codecs.BOM_UTF16_BE,
|
|
498 |
'utf-16-le' : codecs.BOM_UTF16_LE}
|
|
499 |
|
|
500 |
# Use the name from a CodecInfo object to account for
|
|
501 |
# aliases (e.g. U8 and UTF-8 both map to utf-8)
|
|
502 |
codec_info = codecs.lookup(encoding)
|
|
503 |
if codec_info.name in BOM_MAPPING:
|
|
504 |
# Add or remove as necessary
|
|
505 |
BOM = BOM_MAPPING[codec_info.name]
|
|
506 |
if write_bom == True and not data.startswith(BOM):
|
|
507 |
data = BOM + data
|
|
508 |
elif write_bom == False and data.startswith(BOM):
|
|
509 |
data = data[len(BOM):]
|
|
510 |
return data
|
|
511 |
|
|
512 |
|
|
513 |
class OutputFile(object):
|
3
|
514 |
NEWLINE_UNIX = "unix"
|
|
515 |
NEWLINE_WIN = "win"
|
|
516 |
|
0
|
517 |
def __init__(self):
|
|
518 |
self.filename = ''
|
|
519 |
self.path = ''
|
|
520 |
self.encoding = "utf-8"
|
|
521 |
self.template = TempFile()
|
|
522 |
self.filters = []
|
|
523 |
self.bom = None
|
3
|
524 |
self.newline = self.NEWLINE_UNIX
|
|
525 |
self.fearef = None
|
|
526 |
self.output_elem = None
|
|
527 |
|
|
528 |
def set_newline(self, newline):
|
|
529 |
self.newline = newline
|
0
|
530 |
|
|
531 |
def set_filename(self, filename):
|
|
532 |
self.filename = filename
|
|
533 |
|
|
534 |
def set_path(self, path):
|
|
535 |
self.path = path
|
|
536 |
|
|
537 |
def set_encoding(self, encoding):
|
|
538 |
self.encoding = encoding
|
|
539 |
|
|
540 |
def set_template(self, template):
|
|
541 |
self.template = template
|
|
542 |
|
|
543 |
def add_filter(self, filter):
|
3
|
544 |
self.filters.append(filter)
|
0
|
545 |
|
|
546 |
def set_filters(self, filters):
|
|
547 |
self.filters = filters
|
|
548 |
|
3
|
549 |
def set_bom(self, bom):
|
|
550 |
self.bom = bom
|
|
551 |
|
|
552 |
def set_fearef(self, ref):
|
|
553 |
self.fearef = ref
|
|
554 |
|
|
555 |
def set_output_elem(self, output_elem):
|
|
556 |
self.output_elem = output_elem
|
|
557 |
|
0
|
558 |
def __eq__(self, other):
|
3
|
559 |
if other:
|
|
560 |
if (self.template == other.template and self.newline == other.newline and self.encoding == other.encoding and self.path == other.path and self.filename == other.filename and self.filters == other.filters):
|
|
561 |
return True
|
0
|
562 |
return False
|
|
563 |
|
|
564 |
def __repr__(self):
|
|
565 |
return "OutputFile(filename=%r, path=%r, encoding=%r, template=%r, filters=%r" % (self.filename, self.path, self.encoding, self.template, self.filters)
|
|
566 |
|
|
567 |
class TempFile(object):
|
|
568 |
def __init__(self):
|
|
569 |
self.template = ""
|
|
570 |
self.extensions = []
|
|
571 |
self.filters = []
|
|
572 |
self.path = ''
|
|
573 |
|
|
574 |
def set_path(self, path):
|
|
575 |
self.path = path
|
|
576 |
|
|
577 |
def set_template(self, template):
|
|
578 |
self.template = template
|
|
579 |
|
|
580 |
def add_extension(self, extension):
|
|
581 |
self.extensions.append(extension)
|
|
582 |
|
|
583 |
def add_filter(self, filter):
|
|
584 |
self.filters.append(filter)
|
|
585 |
|
|
586 |
def add_filter2(self, name, code):
|
|
587 |
self.filters.append(Filter(name, code))
|
|
588 |
|
|
589 |
def __eq__(self, other):
|
3
|
590 |
if other:
|
|
591 |
if self.template == other.template and self.filters == other.filters and self.extensions == other.extensions and self.path == other.path:
|
|
592 |
return True
|
0
|
593 |
return False
|
3
|
594 |
|
0
|
595 |
|
|
596 |
class Filter(object):
|
|
597 |
def __init__(self):
|
|
598 |
self.name = None
|
|
599 |
self.code = None
|
|
600 |
self.path = None
|
|
601 |
|
|
602 |
def set_path(self, path):
|
|
603 |
self.path = path
|
|
604 |
|
|
605 |
def set_name(self, name):
|
|
606 |
self.name = name
|
|
607 |
|
|
608 |
def set_code(self, code):
|
|
609 |
self.code = code
|
|
610 |
|
|
611 |
def __eq__(self, other):
|
|
612 |
if self.name == other.name and self.code == other.code and self.path == other.path:
|
|
613 |
return True
|
|
614 |
return False
|
|
615 |
|
|
616 |
class FeatureDictProxy(object):
|
|
617 |
"""
|
|
618 |
Proxy class that behaves like a dictionary, but loads attributes from
|
|
619 |
the Feature object it proxies only when they are requested.
|
|
620 |
"""
|
|
621 |
def __init__(self, feature):
|
|
622 |
self._feature = feature
|
|
623 |
self._children = {}
|
|
624 |
|
|
625 |
def _get_dict(self):
|
3
|
626 |
result = {}
|
|
627 |
if self._feature is not None:
|
|
628 |
result.update({
|
|
629 |
'_name' : self._feature.name,
|
|
630 |
'_namespace' : self._feature.namespace,
|
|
631 |
'_value' : self._feature.get_value(),
|
|
632 |
'_fqr' : self._feature.fqr,
|
|
633 |
'_type' : self._feature.type})
|
|
634 |
result.update(self._children)
|
0
|
635 |
return result
|
|
636 |
|
|
637 |
def items(self):
|
|
638 |
return self._get_dict().items()
|
|
639 |
|
|
640 |
def iteritems(self):
|
|
641 |
return self._get_dict().iteritems()
|
|
642 |
|
|
643 |
def __getitem__(self, name):
|
3
|
644 |
if self._feature is not None:
|
|
645 |
if name == '_name': return self._feature.name
|
|
646 |
elif name == '_namespace': return self._feature.namespace
|
|
647 |
elif name == '_value': return self._feature.get_value()
|
|
648 |
elif name == '_fqr': return self._feature.fqr
|
|
649 |
elif name == '_type': return self._feature.type
|
|
650 |
|
|
651 |
try:
|
|
652 |
return self._children[name]
|
|
653 |
except KeyError:
|
|
654 |
if self._feature:
|
|
655 |
msg = "Feature '%s.%s' not found" % (self._feature.fqr, name)
|
|
656 |
else:
|
|
657 |
msg = "Feature '%s' not found" % name
|
|
658 |
raise exceptions.NotFound(msg)
|
0
|
659 |
|
|
660 |
def __setitem__(self, name, value):
|
|
661 |
self._children[name] = value
|
|
662 |
|
|
663 |
def __len__(self):
|
|
664 |
return len(self._get_dict())
|
|
665 |
|
|
666 |
def __eq__(self, other):
|
|
667 |
if not isinstance(other, dict):
|
|
668 |
return False
|
|
669 |
else:
|
|
670 |
return self._get_dict() == other
|
|
671 |
|
|
672 |
def __ne__(self, other):
|
|
673 |
return not (self == other)
|