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
|
# Copyright (C) 2016 the V8 project authors. All rights reserved.
# This code is governed by the BSD license found in the LICENSE file.
import os, re
import codecs, yaml
from collections import OrderedDict
from util.find_comments import find_comments
from util.parse_yaml import parse_yaml
from test import Test
indentPattern = re.compile(r'^(\s*)')
interpolatePattern = re.compile(r'\{\s*(\S+)\s*\}')
def indent(text, prefix = ' ', js_value = False):
'''Prefix a block of text (as defined by the "line break" control
character) with some character sequence.
:param prefix: String value to insert before each line
:param js_value: If True, the text will be interpreted as a JavaScript
value, meaning that indentation will not occur for lines that would
effect the runtime value; defaults to False
'''
if isinstance(text, list):
lines = text
else:
lines = text.split('\n')
indented = [prefix + lines[0]]
str_char = None
for line in lines[1:]:
# Determine if the beginning of the current line is part of some
# previously-opened literal value.
if js_value:
for char in indented[-1]:
if char == str_char:
str_char = None
elif str_char is None and char in '\'"`':
str_char = char
# Do not indent the current line if it is a continuation of a literal
# value or if it is empty.
if str_char or len(line) == 0:
indented.append(line)
else:
indented.append(prefix + line)
return '\n'.join(indented)
class Template:
def __init__(self, filename, encoding):
self.filename = filename
with codecs.open(filename, 'r', encoding) as template_file:
self.source = template_file.read()
self.attribs = dict()
self.regions = []
self._parse()
def _remove_comment(self, comment):
'''Create a region that is not intended to be referenced by any case,
ensuring that the comment is not emitted in the rendered file.'''
name = '__remove_comment_' + str(comment['firstchar']) + '__'
# When a removed comment ends the line, the following newline character
# should also be removed from the generated file.
lastchar = comment['lastchar']
if self.source[lastchar] == '\n':
comment['lastchar'] = comment['lastchar'] + 1
self.regions.insert(0, dict(name=name, **comment))
def _parse(self):
for comment in find_comments(self.source):
meta = parse_yaml(comment['source'])
# Do not emit the template's frontmatter in generated files
# (file-specific frontmatter is generated as part of the rendering
# process)
if meta:
self.attribs['meta'] = meta
self._remove_comment(comment)
continue
# Do not emit license information in generated files (recognized as
# comments preceeding the YAML frontmatter)
if not self.attribs.get('meta'):
self._remove_comment(comment)
continue
match = interpolatePattern.match(comment['source'])
if match == None:
continue
self.regions.insert(0, dict(name=match.group(1), **comment))
def expand_regions(self, source, context):
lines = source.split('\n')
for region in self.regions:
whitespace = indentPattern.match(lines[region['lineno']]).group(1)
value = context['regions'].get(region['name'], '')
str_char = region.get('in_string')
if str_char:
safe_char = '"' if str_char == '\'' else '\''
value = value.replace(str_char, safe_char)
value = value.replace('\n', '\\\n')
source = source[:region['firstchar']] + \
indent(value, whitespace, True).lstrip() + \
source[region['lastchar']:]
setup = context['regions'].get('setup')
if setup:
source = setup + '\n' + source
teardown = context['regions'].get('teardown')
if teardown:
source += '\n' + teardown + '\n'
return source
def _frontmatter(self, case_filename, case_values):
description = case_values['meta']['desc'].strip() + \
' (' + self.attribs['meta']['name'].strip() + ')'
lines = []
lines += [
'// This file was procedurally generated from the following sources:',
'// - ' + case_filename,
'// - ' + self.filename,
'/*---',
'description: ' + description,
]
esid = self.attribs['meta'].get('esid')
if esid:
lines.append('esid: ' + esid)
es6id = self.attribs['meta'].get('es6id')
if es6id:
lines.append('es6id: ' + es6id)
features = []
features += case_values['meta'].get('features', [])
features += self.attribs['meta'].get('features', [])
features = list(OrderedDict.fromkeys(features))
if len(features):
lines += ['features: ' + yaml.dump(features).strip()]
flags = ['generated']
flags += case_values['meta'].get('flags', [])
flags += self.attribs['meta'].get('flags', [])
flags = list(OrderedDict.fromkeys(flags))
lines += ['flags: ' + yaml.dump(flags).strip()]
includes = []
includes += case_values['meta'].get('includes', [])
includes += self.attribs['meta'].get('includes', [])
includes = list(OrderedDict.fromkeys(includes))
if len(includes):
lines += ['includes: ' + yaml.dump(includes).strip()]
if case_values['meta'].get('negative'):
if self.attribs['meta'].get('negative'):
raise Exception('Cannot specify negative in case and template file')
negative = case_values['meta'].get('negative')
else:
negative = self.attribs['meta'].get('negative')
if negative:
lines += ['negative:']
as_yaml = yaml.dump(negative,
default_flow_style=False)
lines += indent(as_yaml.strip(), ' ').split('\n')
info = []
if 'info' in self.attribs['meta']:
info.append(indent(self.attribs['meta']['info']))
if 'info' in case_values['meta']:
if len(info):
info.append('')
info.append(indent(case_values['meta']['info']))
if len(info):
lines.append('info: |')
lines += info
lines.append('---*/')
return '\n'.join(lines)
def expand(self, case_filename, case_name, case_values, encoding):
frontmatter = self._frontmatter(case_filename, case_values)
body = self.expand_regions(self.source, case_values)
assert encoding == 'utf-8'
return Test(self.attribs['meta']['path'] + case_name + '.js',
source=codecs.encode(frontmatter + '\n' + body, encoding))
|