blob: 242eccf3d37d783eeb2485db82f2ece395757e12 [file] [log] [blame]
Benjamin Petersonf51d36a2011-12-29 12:07:21 -06001#! /usr/bin/env python
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00002"""Generate C code from an ASDL description."""
3
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03004import os
5import sys
6
7from argparse import ArgumentParser
8from pathlib import Path
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009
10import asdl
11
Victor Stinnerce72e1c2013-07-27 00:00:36 +020012TABSIZE = 4
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000013MAX_COL = 80
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +030014AUTOGEN_MESSAGE = "/* File automatically generated by {}. */\n\n"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000015
16def get_c_type(name):
17 """Return a string for the C name of the type.
18
Eli Bendersky5e3d3382014-05-09 17:58:22 -070019 This function special cases the default types provided by asdl.
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000020 """
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000021 if name in asdl.builtin_types:
22 return name
23 else:
24 return "%s_ty" % name
25
26def reflow_lines(s, depth):
27 """Reflow the line s indented depth tabs.
28
29 Return a sequence of lines where no line extends beyond MAX_COL
30 when properly indented. The first line is properly indented based
31 exclusively on depth * TABSIZE. All following lines -- these are
32 the reflowed lines generated by this function -- start at the same
33 column as the first character beyond the opening { in the first
34 line.
35 """
36 size = MAX_COL - depth * TABSIZE
37 if len(s) < size:
38 return [s]
39
40 lines = []
41 cur = s
42 padding = ""
43 while len(cur) > size:
44 i = cur.rfind(' ', 0, size)
45 # XXX this should be fixed for real
46 if i == -1 and 'GeneratorExp' in cur:
47 i = size + 3
Brett Cannonf0365512006-08-25 04:06:31 +000048 assert i != -1, "Impossible line %d to reflow: %r" % (size, s)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000049 lines.append(padding + cur[:i])
50 if len(lines) == 1:
51 # find new size based on brace
52 j = cur.find('{', 0, i)
53 if j >= 0:
54 j += 2 # account for the brace and the space after it
55 size -= j
56 padding = " " * j
57 else:
58 j = cur.find('(', 0, i)
59 if j >= 0:
60 j += 1 # account for the paren (no space after it)
61 size -= j
62 padding = " " * j
63 cur = cur[i+1:]
64 else:
65 lines.append(padding + cur)
66 return lines
67
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +030068def reflow_c_string(s, depth):
69 return '"%s"' % s.replace('\n', '\\n"\n%s"' % (' ' * depth * TABSIZE))
70
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000071def is_simple(sum):
72 """Return True if a sum is a simple.
73
74 A sum is simple if its types have no fields, e.g.
75 unaryop = Invert | Not | UAdd | USub
76 """
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000077 for t in sum.types:
78 if t.fields:
79 return False
80 return True
81
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +030082def asdl_of(name, obj):
83 if isinstance(obj, asdl.Product) or isinstance(obj, asdl.Constructor):
84 fields = ", ".join(map(str, obj.fields))
85 if fields:
86 fields = "({})".format(fields)
87 return "{}{}".format(name, fields)
88 else:
89 if is_simple(obj):
90 types = " | ".join(type.name for type in obj.types)
91 else:
92 sep = "\n{}| ".format(" " * (len(name) + 1))
93 types = sep.join(
94 asdl_of(type.name, type) for type in obj.types
95 )
96 return "{} = {}".format(name, types)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +000097
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000098class EmitVisitor(asdl.VisitorBase):
99 """Visit that emits lines"""
100
101 def __init__(self, file):
102 self.file = file
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200103 self.identifiers = set()
Dino Viehlandac46eb42019-09-11 10:16:34 -0700104 self.singletons = set()
105 self.types = set()
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000106 super(EmitVisitor, self).__init__()
107
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200108 def emit_identifier(self, name):
Dino Viehlandac46eb42019-09-11 10:16:34 -0700109 self.identifiers.add(str(name))
110
111 def emit_singleton(self, name):
112 self.singletons.add(str(name))
113
114 def emit_type(self, name):
115 self.types.add(str(name))
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200116
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000117 def emit(self, s, depth, reflow=True):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000118 # XXX reflow long lines?
119 if reflow:
120 lines = reflow_lines(s, depth)
121 else:
122 lines = [s]
123 for line in lines:
Serhiy Storchaka5d84cb32017-09-15 06:28:22 +0300124 if line:
125 line = (" " * TABSIZE * depth) + line
126 self.file.write(line + "\n")
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000127
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000128
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000129class TypeDefVisitor(EmitVisitor):
130 def visitModule(self, mod):
131 for dfn in mod.dfns:
132 self.visit(dfn)
133
134 def visitType(self, type, depth=0):
135 self.visit(type.value, type.name, depth)
136
137 def visitSum(self, sum, name, depth):
138 if is_simple(sum):
139 self.simple_sum(sum, name, depth)
140 else:
141 self.sum_with_constructors(sum, name, depth)
142
143 def simple_sum(self, sum, name, depth):
144 enum = []
145 for i in range(len(sum.types)):
146 type = sum.types[i]
147 enum.append("%s=%d" % (type.name, i + 1))
148 enums = ", ".join(enum)
149 ctype = get_c_type(name)
150 s = "typedef enum _%s { %s } %s;" % (name, enums, ctype)
151 self.emit(s, depth)
152 self.emit("", depth)
153
154 def sum_with_constructors(self, sum, name, depth):
155 ctype = get_c_type(name)
156 s = "typedef struct _%(name)s *%(ctype)s;" % locals()
157 self.emit(s, depth)
158 self.emit("", depth)
159
160 def visitProduct(self, product, name, depth):
161 ctype = get_c_type(name)
162 s = "typedef struct _%(name)s *%(ctype)s;" % locals()
163 self.emit(s, depth)
164 self.emit("", depth)
165
Pablo Galindoa5634c42020-09-16 19:42:00 +0100166class SequenceDefVisitor(EmitVisitor):
167 def visitModule(self, mod):
168 for dfn in mod.dfns:
169 self.visit(dfn)
170
171 def visitType(self, type, depth=0):
172 self.visit(type.value, type.name, depth)
173
174 def visitSum(self, sum, name, depth):
175 if is_simple(sum):
176 return
177 self.emit_sequence_constructor(name, depth)
178
179 def emit_sequence_constructor(self, name,depth):
180 ctype = get_c_type(name)
181 self.emit("""\
182typedef struct {
183 _ASDL_SEQ_HEAD
184 %(ctype)s typed_elements[1];
185} asdl_%(name)s_seq;""" % locals(), reflow=False, depth=depth)
186 self.emit("", depth)
187 self.emit("asdl_%(name)s_seq *_Py_asdl_%(name)s_seq_new(Py_ssize_t size, PyArena *arena);" % locals(), depth)
188 self.emit("", depth)
189
190 def visitProduct(self, product, name, depth):
191 self.emit_sequence_constructor(name, depth)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000192
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000193class StructVisitor(EmitVisitor):
Eli Bendersky5e3d3382014-05-09 17:58:22 -0700194 """Visitor to generate typedefs for AST."""
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000195
196 def visitModule(self, mod):
197 for dfn in mod.dfns:
198 self.visit(dfn)
199
200 def visitType(self, type, depth=0):
201 self.visit(type.value, type.name, depth)
202
203 def visitSum(self, sum, name, depth):
204 if not is_simple(sum):
205 self.sum_with_constructors(sum, name, depth)
206
207 def sum_with_constructors(self, sum, name, depth):
208 def emit(s, depth=depth):
209 self.emit(s % sys._getframe(1).f_locals, depth)
210 enum = []
211 for i in range(len(sum.types)):
212 type = sum.types[i]
213 enum.append("%s_kind=%d" % (type.name, i + 1))
214
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000215 emit("enum _%(name)s_kind {" + ", ".join(enum) + "};")
216
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000217 emit("struct _%(name)s {")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000218 emit("enum _%(name)s_kind kind;", depth + 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000219 emit("union {", depth + 1)
220 for t in sum.types:
221 self.visit(t, depth + 2)
222 emit("} v;", depth + 1)
223 for field in sum.attributes:
224 # rudimentary attribute handling
225 type = str(field.type)
226 assert type in asdl.builtin_types, type
227 emit("%s %s;" % (type, field.name), depth + 1);
228 emit("};")
229 emit("")
230
231 def visitConstructor(self, cons, depth):
232 if cons.fields:
233 self.emit("struct {", depth)
234 for f in cons.fields:
235 self.visit(f, depth + 1)
236 self.emit("} %s;" % cons.name, depth)
237 self.emit("", depth)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000238
239 def visitField(self, field, depth):
240 # XXX need to lookup field.type, because it might be something
241 # like a builtin...
242 ctype = get_c_type(field.type)
243 name = field.name
244 if field.seq:
Eli Bendersky5e3d3382014-05-09 17:58:22 -0700245 if field.type == 'cmpop':
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000246 self.emit("asdl_int_seq *%(name)s;" % locals(), depth)
247 else:
Pablo Galindoa5634c42020-09-16 19:42:00 +0100248 _type = field.type
249 self.emit("asdl_%(_type)s_seq *%(name)s;" % locals(), depth)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000250 else:
251 self.emit("%(ctype)s %(name)s;" % locals(), depth)
252
253 def visitProduct(self, product, name, depth):
254 self.emit("struct _%(name)s {" % locals(), depth)
255 for f in product.fields:
256 self.visit(f, depth + 1)
Benjamin Petersoncda75be2013-03-18 10:48:58 -0700257 for field in product.attributes:
258 # rudimentary attribute handling
259 type = str(field.type)
260 assert type in asdl.builtin_types, type
261 self.emit("%s %s;" % (type, field.name), depth + 1);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000262 self.emit("};", depth)
263 self.emit("", depth)
264
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000265
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000266class PrototypeVisitor(EmitVisitor):
267 """Generate function prototypes for the .h file"""
268
269 def visitModule(self, mod):
270 for dfn in mod.dfns:
271 self.visit(dfn)
272
273 def visitType(self, type):
274 self.visit(type.value, type.name)
275
276 def visitSum(self, sum, name):
277 if is_simple(sum):
278 pass # XXX
279 else:
280 for t in sum.types:
281 self.visit(t, name, sum.attributes)
282
283 def get_args(self, fields):
284 """Return list of C argument into, one for each field.
285
286 Argument info is 3-tuple of a C type, variable name, and flag
287 that is true if type can be NULL.
288 """
289 args = []
290 unnamed = {}
291 for f in fields:
292 if f.name is None:
293 name = f.type
294 c = unnamed[name] = unnamed.get(name, 0) + 1
295 if c > 1:
296 name = "name%d" % (c - 1)
297 else:
298 name = f.name
299 # XXX should extend get_c_type() to handle this
300 if f.seq:
Eli Bendersky5e3d3382014-05-09 17:58:22 -0700301 if f.type == 'cmpop':
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000302 ctype = "asdl_int_seq *"
303 else:
Pablo Galindoa5634c42020-09-16 19:42:00 +0100304 ctype = f"asdl_{f.type}_seq *"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000305 else:
306 ctype = get_c_type(f.type)
307 args.append((ctype, name, f.opt or f.seq))
308 return args
309
310 def visitConstructor(self, cons, type, attrs):
311 args = self.get_args(cons.fields)
312 attrs = self.get_args(attrs)
313 ctype = get_c_type(type)
314 self.emit_function(cons.name, ctype, args, attrs)
315
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000316 def emit_function(self, name, ctype, args, attrs, union=True):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000317 args = args + attrs
318 if args:
319 argstr = ", ".join(["%s %s" % (atype, aname)
320 for atype, aname, opt in args])
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000321 argstr += ", PyArena *arena"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000322 else:
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000323 argstr = "PyArena *arena"
Thomas Woutersb2137042007-02-01 18:02:27 +0000324 margs = "a0"
325 for i in range(1, len(args)+1):
326 margs += ", a%d" % i
327 self.emit("#define %s(%s) _Py_%s(%s)" % (name, margs, name, margs), 0,
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000328 reflow=False)
329 self.emit("%s _Py_%s(%s);" % (ctype, name, argstr), False)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000330
331 def visitProduct(self, prod, name):
332 self.emit_function(name, get_c_type(name),
Victor Stinnerc106c682015-11-06 17:01:48 +0100333 self.get_args(prod.fields),
334 self.get_args(prod.attributes),
335 union=False)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000336
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000337
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000338class FunctionVisitor(PrototypeVisitor):
339 """Visitor to generate constructor functions for AST."""
340
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000341 def emit_function(self, name, ctype, args, attrs, union=True):
342 def emit(s, depth=0, reflow=True):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000343 self.emit(s, depth, reflow)
344 argstr = ", ".join(["%s %s" % (atype, aname)
345 for atype, aname, opt in args + attrs])
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000346 if argstr:
347 argstr += ", PyArena *arena"
348 else:
349 argstr = "PyArena *arena"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000350 self.emit("%s" % ctype, 0)
351 emit("%s(%s)" % (name, argstr))
352 emit("{")
353 emit("%s p;" % ctype, 1)
354 for argtype, argname, opt in args:
Neal Norwitz3591bbe2007-02-26 19:04:49 +0000355 if not opt and argtype != "int":
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000356 emit("if (!%s) {" % argname, 1)
357 emit("PyErr_SetString(PyExc_ValueError,", 2)
Batuhan Taskaya091951a2020-05-06 17:29:32 +0300358 msg = "field '%s' is required for %s" % (argname, name)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000359 emit(' "%s");' % msg,
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000360 2, reflow=False)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000361 emit('return NULL;', 2)
362 emit('}', 1)
363
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000364 emit("p = (%s)PyArena_Malloc(arena, sizeof(*p));" % ctype, 1);
Thomas Woutersa44f3a32007-02-26 18:20:15 +0000365 emit("if (!p)", 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000366 emit("return NULL;", 2)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000367 if union:
368 self.emit_body_union(name, args, attrs)
369 else:
370 self.emit_body_struct(name, args, attrs)
371 emit("return p;", 1)
372 emit("}")
373 emit("")
374
375 def emit_body_union(self, name, args, attrs):
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000376 def emit(s, depth=0, reflow=True):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000377 self.emit(s, depth, reflow)
378 emit("p->kind = %s_kind;" % name, 1)
379 for argtype, argname, opt in args:
380 emit("p->v.%s.%s = %s;" % (name, argname, argname), 1)
381 for argtype, argname, opt in attrs:
382 emit("p->%s = %s;" % (argname, argname), 1)
383
384 def emit_body_struct(self, name, args, attrs):
Benjamin Peterson87c8d872009-06-11 22:54:11 +0000385 def emit(s, depth=0, reflow=True):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000386 self.emit(s, depth, reflow)
387 for argtype, argname, opt in args:
388 emit("p->%s = %s;" % (argname, argname), 1)
Victor Stinnerc106c682015-11-06 17:01:48 +0100389 for argtype, argname, opt in attrs:
390 emit("p->%s = %s;" % (argname, argname), 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000391
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000392
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000393class PickleVisitor(EmitVisitor):
394
395 def visitModule(self, mod):
396 for dfn in mod.dfns:
397 self.visit(dfn)
398
399 def visitType(self, type):
400 self.visit(type.value, type.name)
401
402 def visitSum(self, sum, name):
403 pass
404
405 def visitProduct(self, sum, name):
406 pass
407
408 def visitConstructor(self, cons, name):
409 pass
410
411 def visitField(self, sum):
412 pass
413
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000414
415class Obj2ModPrototypeVisitor(PickleVisitor):
416 def visitProduct(self, prod, name):
Victor Stinner74419f02020-07-03 11:35:37 +0200417 code = "static int obj2ast_%s(astmodulestate *state, PyObject* obj, %s* out, PyArena* arena);"
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000418 self.emit(code % (name, get_c_type(name)), 0)
419
420 visitSum = visitProduct
421
422
423class Obj2ModVisitor(PickleVisitor):
424 def funcHeader(self, name):
425 ctype = get_c_type(name)
426 self.emit("int", 0)
Victor Stinner74419f02020-07-03 11:35:37 +0200427 self.emit("obj2ast_%s(astmodulestate *state, PyObject* obj, %s* out, PyArena* arena)" % (name, ctype), 0)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000428 self.emit("{", 0)
Benjamin Peterson0e9e98e2010-11-20 02:01:45 +0000429 self.emit("int isinstance;", 1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000430 self.emit("", 0)
431
Benjamin Peterson5b066812010-11-20 01:38:49 +0000432 def sumTrailer(self, name, add_label=False):
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000433 self.emit("", 0)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000434 # there's really nothing more we can do if this fails ...
Benjamin Peterson5b066812010-11-20 01:38:49 +0000435 error = "expected some sort of %s, but got %%R" % name
436 format = "PyErr_Format(PyExc_TypeError, \"%s\", obj);"
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000437 self.emit(format % error, 1, reflow=False)
Benjamin Peterson5b066812010-11-20 01:38:49 +0000438 if add_label:
439 self.emit("failed:", 1)
Benjamin Peterson0a4dae52010-11-21 15:12:34 +0000440 self.emit("Py_XDECREF(tmp);", 1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000441 self.emit("return 1;", 1)
442 self.emit("}", 0)
443 self.emit("", 0)
444
445 def simpleSum(self, sum, name):
446 self.funcHeader(name)
447 for t in sum.types:
Benjamin Peterson97dd9872009-12-13 01:23:39 +0000448 line = ("isinstance = PyObject_IsInstance(obj, "
Victor Stinner74419f02020-07-03 11:35:37 +0200449 "state->%s_type);")
Benjamin Peterson97dd9872009-12-13 01:23:39 +0000450 self.emit(line % (t.name,), 1)
451 self.emit("if (isinstance == -1) {", 1)
452 self.emit("return 1;", 2)
453 self.emit("}", 1)
454 self.emit("if (isinstance) {", 1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000455 self.emit("*out = %s;" % t.name, 2)
456 self.emit("return 0;", 2)
457 self.emit("}", 1)
458 self.sumTrailer(name)
459
460 def buildArgs(self, fields):
461 return ", ".join(fields + ["arena"])
462
463 def complexSum(self, sum, name):
464 self.funcHeader(name)
Benjamin Petersond8f65972010-11-20 04:31:07 +0000465 self.emit("PyObject *tmp = NULL;", 1)
Dino Viehlandac46eb42019-09-11 10:16:34 -0700466 self.emit("PyObject *tp;", 1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000467 for a in sum.attributes:
468 self.visitAttributeDeclaration(a, name, sum=sum)
469 self.emit("", 0)
470 # XXX: should we only do this for 'expr'?
471 self.emit("if (obj == Py_None) {", 1)
472 self.emit("*out = NULL;", 2)
473 self.emit("return 0;", 2)
474 self.emit("}", 1)
475 for a in sum.attributes:
476 self.visitField(a, name, sum=sum, depth=1)
477 for t in sum.types:
Victor Stinner74419f02020-07-03 11:35:37 +0200478 self.emit("tp = state->%s_type;" % (t.name,), 1)
Dino Viehlandac46eb42019-09-11 10:16:34 -0700479 self.emit("isinstance = PyObject_IsInstance(obj, tp);", 1)
Benjamin Peterson97dd9872009-12-13 01:23:39 +0000480 self.emit("if (isinstance == -1) {", 1)
481 self.emit("return 1;", 2)
482 self.emit("}", 1)
483 self.emit("if (isinstance) {", 1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000484 for f in t.fields:
485 self.visitFieldDeclaration(f, t.name, sum=sum, depth=2)
486 self.emit("", 0)
487 for f in t.fields:
488 self.visitField(f, t.name, sum=sum, depth=2)
Eli Bendersky5e3d3382014-05-09 17:58:22 -0700489 args = [f.name for f in t.fields] + [a.name for a in sum.attributes]
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000490 self.emit("*out = %s(%s);" % (t.name, self.buildArgs(args)), 2)
491 self.emit("if (*out == NULL) goto failed;", 2)
492 self.emit("return 0;", 2)
493 self.emit("}", 1)
Benjamin Peterson5b066812010-11-20 01:38:49 +0000494 self.sumTrailer(name, True)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000495
496 def visitAttributeDeclaration(self, a, name, sum=sum):
497 ctype = get_c_type(a.type)
498 self.emit("%s %s;" % (ctype, a.name), 1)
499
500 def visitSum(self, sum, name):
501 if is_simple(sum):
502 self.simpleSum(sum, name)
503 else:
504 self.complexSum(sum, name)
505
506 def visitProduct(self, prod, name):
507 ctype = get_c_type(name)
508 self.emit("int", 0)
Victor Stinner74419f02020-07-03 11:35:37 +0200509 self.emit("obj2ast_%s(astmodulestate *state, PyObject* obj, %s* out, PyArena* arena)" % (name, ctype), 0)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000510 self.emit("{", 0)
511 self.emit("PyObject* tmp = NULL;", 1)
512 for f in prod.fields:
513 self.visitFieldDeclaration(f, name, prod=prod, depth=1)
Victor Stinnerc106c682015-11-06 17:01:48 +0100514 for a in prod.attributes:
515 self.visitFieldDeclaration(a, name, prod=prod, depth=1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000516 self.emit("", 0)
517 for f in prod.fields:
518 self.visitField(f, name, prod=prod, depth=1)
Victor Stinnerc106c682015-11-06 17:01:48 +0100519 for a in prod.attributes:
520 self.visitField(a, name, prod=prod, depth=1)
Eli Bendersky5e3d3382014-05-09 17:58:22 -0700521 args = [f.name for f in prod.fields]
Victor Stinnerc106c682015-11-06 17:01:48 +0100522 args.extend([a.name for a in prod.attributes])
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000523 self.emit("*out = %s(%s);" % (name, self.buildArgs(args)), 1)
524 self.emit("return 0;", 1)
525 self.emit("failed:", 0)
526 self.emit("Py_XDECREF(tmp);", 1)
527 self.emit("return 1;", 1)
528 self.emit("}", 0)
529 self.emit("", 0)
530
531 def visitFieldDeclaration(self, field, name, sum=None, prod=None, depth=0):
532 ctype = get_c_type(field.type)
533 if field.seq:
534 if self.isSimpleType(field):
535 self.emit("asdl_int_seq* %s;" % field.name, depth)
536 else:
Pablo Galindoa5634c42020-09-16 19:42:00 +0100537 _type = field.type
538 self.emit(f"asdl_{field.type}_seq* {field.name};", depth)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000539 else:
540 ctype = get_c_type(field.type)
541 self.emit("%s %s;" % (ctype, field.name), depth)
542
543 def isSimpleSum(self, field):
544 # XXX can the members of this list be determined automatically?
Eli Bendersky5e3d3382014-05-09 17:58:22 -0700545 return field.type in ('expr_context', 'boolop', 'operator',
546 'unaryop', 'cmpop')
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000547
548 def isNumeric(self, field):
549 return get_c_type(field.type) in ("int", "bool")
550
551 def isSimpleType(self, field):
552 return self.isSimpleSum(field) or self.isNumeric(field)
553
554 def visitField(self, field, name, sum=None, prod=None, depth=0):
555 ctype = get_c_type(field.type)
Victor Stinner74419f02020-07-03 11:35:37 +0200556 line = "if (_PyObject_LookupAttr(obj, state->%s, &tmp) < 0) {"
Dino Viehlandac46eb42019-09-11 10:16:34 -0700557 self.emit(line % field.name, depth)
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200558 self.emit("return 1;", depth+1)
559 self.emit("}", depth)
Serhiy Storchakabba22392017-11-11 16:41:32 +0200560 if not field.opt:
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200561 self.emit("if (tmp == NULL) {", depth)
562 message = "required field \\\"%s\\\" missing from %s" % (field.name, name)
563 format = "PyErr_SetString(PyExc_TypeError, \"%s\");"
564 self.emit(format % message, depth+1, reflow=False)
565 self.emit("return 1;", depth+1)
Benjamin Petersoncda75be2013-03-18 10:48:58 -0700566 else:
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200567 self.emit("if (tmp == NULL || tmp == Py_None) {", depth)
568 self.emit("Py_CLEAR(tmp);", depth+1)
569 if self.isNumeric(field):
570 self.emit("%s = 0;" % field.name, depth+1)
571 elif not self.isSimpleType(field):
572 self.emit("%s = NULL;" % field.name, depth+1)
573 else:
574 raise TypeError("could not determine the default value for %s" % field.name)
575 self.emit("}", depth)
576 self.emit("else {", depth)
577
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000578 self.emit("int res;", depth+1)
579 if field.seq:
580 self.emit("Py_ssize_t len;", depth+1)
581 self.emit("Py_ssize_t i;", depth+1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000582 self.emit("if (!PyList_Check(tmp)) {", depth+1)
583 self.emit("PyErr_Format(PyExc_TypeError, \"%s field \\\"%s\\\" must "
Dino Viehlandac46eb42019-09-11 10:16:34 -0700584 "be a list, not a %%.200s\", _PyType_Name(Py_TYPE(tmp)));" %
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000585 (name, field.name),
586 depth+2, reflow=False)
587 self.emit("goto failed;", depth+2)
588 self.emit("}", depth+1)
589 self.emit("len = PyList_GET_SIZE(tmp);", depth+1)
590 if self.isSimpleType(field):
Antoine Pitroud01d396e2013-10-12 22:52:43 +0200591 self.emit("%s = _Py_asdl_int_seq_new(len, arena);" % field.name, depth+1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000592 else:
Pablo Galindoa5634c42020-09-16 19:42:00 +0100593 self.emit("%s = _Py_asdl_%s_seq_new(len, arena);" % (field.name, field.type), depth+1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000594 self.emit("if (%s == NULL) goto failed;" % field.name, depth+1)
595 self.emit("for (i = 0; i < len; i++) {", depth+1)
Yuan Chao Chou2af565b2017-08-04 10:53:12 -0700596 self.emit("%s val;" % ctype, depth+2)
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300597 self.emit("PyObject *tmp2 = PyList_GET_ITEM(tmp, i);", depth+2)
598 self.emit("Py_INCREF(tmp2);", depth+2)
Victor Stinner74419f02020-07-03 11:35:37 +0200599 self.emit("res = obj2ast_%s(state, tmp2, &val, arena);" %
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000600 field.type, depth+2, reflow=False)
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300601 self.emit("Py_DECREF(tmp2);", depth+2)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000602 self.emit("if (res != 0) goto failed;", depth+2)
Serhiy Storchakacf380602016-10-07 21:51:28 +0300603 self.emit("if (len != PyList_GET_SIZE(tmp)) {", depth+2)
604 self.emit("PyErr_SetString(PyExc_RuntimeError, \"%s field \\\"%s\\\" "
605 "changed size during iteration\");" %
606 (name, field.name),
607 depth+3, reflow=False)
608 self.emit("goto failed;", depth+3)
609 self.emit("}", depth+2)
Yuan Chao Chou2af565b2017-08-04 10:53:12 -0700610 self.emit("asdl_seq_SET(%s, i, val);" % field.name, depth+2)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000611 self.emit("}", depth+1)
612 else:
Victor Stinner74419f02020-07-03 11:35:37 +0200613 self.emit("res = obj2ast_%s(state, tmp, &%s, arena);" %
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000614 (field.type, field.name), depth+1)
615 self.emit("if (res != 0) goto failed;", depth+1)
616
Victor Stinner1acc1292013-07-27 00:03:47 +0200617 self.emit("Py_CLEAR(tmp);", depth+1)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000618 self.emit("}", depth)
619
620
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000621class MarshalPrototypeVisitor(PickleVisitor):
622
623 def prototype(self, sum, name):
624 ctype = get_c_type(name)
Neal Norwitz6576bd82005-11-13 18:41:28 +0000625 self.emit("static int marshal_write_%s(PyObject **, int *, %s);"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000626 % (name, ctype), 0)
627
628 visitProduct = visitSum = prototype
629
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000630
Pablo Galindoa5634c42020-09-16 19:42:00 +0100631class SequenceConstructorVisitor(EmitVisitor):
632 def visitModule(self, mod):
633 for dfn in mod.dfns:
634 self.visit(dfn)
635
636 def visitType(self, type):
637 self.visit(type.value, type.name)
638
639 def visitProduct(self, prod, name):
640 self.emit_sequence_constructor(name, get_c_type(name))
641
642 def visitSum(self, sum, name):
643 if not is_simple(sum):
644 self.emit_sequence_constructor(name, get_c_type(name))
645
646 def emit_sequence_constructor(self, name, type):
647 self.emit(f"GENERATE_ASDL_SEQ_CONSTRUCTOR({name}, {type})", depth=0)
648
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000649class PyTypesDeclareVisitor(PickleVisitor):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000650
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000651 def visitProduct(self, prod, name):
Dino Viehlandac46eb42019-09-11 10:16:34 -0700652 self.emit_type("%s_type" % name)
Victor Stinner74419f02020-07-03 11:35:37 +0200653 self.emit("static PyObject* ast2obj_%s(astmodulestate *state, void*);" % name, 0)
Benjamin Petersoncda75be2013-03-18 10:48:58 -0700654 if prod.attributes:
655 for a in prod.attributes:
656 self.emit_identifier(a.name)
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300657 self.emit("static const char * const %s_attributes[] = {" % name, 0)
Benjamin Petersoncda75be2013-03-18 10:48:58 -0700658 for a in prod.attributes:
659 self.emit('"%s",' % a.name, 1)
660 self.emit("};", 0)
Martin v. Löwis8d0701d2006-02-26 23:40:20 +0000661 if prod.fields:
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200662 for f in prod.fields:
663 self.emit_identifier(f.name)
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300664 self.emit("static const char * const %s_fields[]={" % name,0)
Martin v. Löwis8d0701d2006-02-26 23:40:20 +0000665 for f in prod.fields:
666 self.emit('"%s",' % f.name, 1)
667 self.emit("};", 0)
Tim Peters710ab3b2006-02-28 18:30:36 +0000668
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000669 def visitSum(self, sum, name):
Dino Viehlandac46eb42019-09-11 10:16:34 -0700670 self.emit_type("%s_type" % name)
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000671 if sum.attributes:
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200672 for a in sum.attributes:
673 self.emit_identifier(a.name)
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300674 self.emit("static const char * const %s_attributes[] = {" % name, 0)
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000675 for a in sum.attributes:
676 self.emit('"%s",' % a.name, 1)
677 self.emit("};", 0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000678 ptype = "void*"
679 if is_simple(sum):
680 ptype = get_c_type(name)
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000681 for t in sum.types:
Dino Viehlandac46eb42019-09-11 10:16:34 -0700682 self.emit_singleton("%s_singleton" % t.name)
Victor Stinner74419f02020-07-03 11:35:37 +0200683 self.emit("static PyObject* ast2obj_%s(astmodulestate *state, %s);" % (name, ptype), 0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000684 for t in sum.types:
685 self.visitConstructor(t, name)
Tim Peters710ab3b2006-02-28 18:30:36 +0000686
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000687 def visitConstructor(self, cons, name):
Martin v. Löwis8d0701d2006-02-26 23:40:20 +0000688 if cons.fields:
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200689 for t in cons.fields:
690 self.emit_identifier(t.name)
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300691 self.emit("static const char * const %s_fields[]={" % cons.name, 0)
Martin v. Löwis8d0701d2006-02-26 23:40:20 +0000692 for t in cons.fields:
693 self.emit('"%s",' % t.name, 1)
694 self.emit("};",0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000695
Pablo Galindoa5634c42020-09-16 19:42:00 +0100696
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000697class PyTypesVisitor(PickleVisitor):
698
699 def visitModule(self, mod):
700 self.emit("""
INADA Naokifc489082017-01-25 22:33:43 +0900701
Benjamin Peterson7e0dbfb2012-03-12 09:46:44 -0700702typedef struct {
Victor Stinner45e50de2012-03-13 01:17:31 +0100703 PyObject_HEAD
Benjamin Peterson7e0dbfb2012-03-12 09:46:44 -0700704 PyObject *dict;
705} AST_object;
706
Benjamin Peterson1767e022012-03-14 21:50:29 -0500707static void
708ast_dealloc(AST_object *self)
709{
INADA Naokia6296d32017-08-24 14:55:17 +0900710 /* bpo-31095: UnTrack is needed before calling any callbacks */
Eddie Elizondo0247e802019-09-14 09:38:17 -0400711 PyTypeObject *tp = Py_TYPE(self);
INADA Naokia6296d32017-08-24 14:55:17 +0900712 PyObject_GC_UnTrack(self);
Benjamin Peterson1767e022012-03-14 21:50:29 -0500713 Py_CLEAR(self->dict);
Eddie Elizondo0247e802019-09-14 09:38:17 -0400714 freefunc free_func = PyType_GetSlot(tp, Py_tp_free);
715 assert(free_func != NULL);
716 free_func(self);
717 Py_DECREF(tp);
Benjamin Peterson1767e022012-03-14 21:50:29 -0500718}
719
Neal Norwitz207c9f32008-03-31 04:42:11 +0000720static int
Benjamin Peterson81071762012-07-08 11:03:46 -0700721ast_traverse(AST_object *self, visitproc visit, void *arg)
722{
Pablo Galindo1cf15af2020-05-27 10:03:38 +0100723 Py_VISIT(Py_TYPE(self));
Benjamin Peterson81071762012-07-08 11:03:46 -0700724 Py_VISIT(self->dict);
725 return 0;
726}
727
Serhiy Storchakaa5c42282018-05-31 07:34:34 +0300728static int
Benjamin Peterson81071762012-07-08 11:03:46 -0700729ast_clear(AST_object *self)
730{
731 Py_CLEAR(self->dict);
Serhiy Storchakaa5c42282018-05-31 07:34:34 +0300732 return 0;
Benjamin Peterson81071762012-07-08 11:03:46 -0700733}
734
735static int
Neal Norwitz207c9f32008-03-31 04:42:11 +0000736ast_type_init(PyObject *self, PyObject *args, PyObject *kw)
737{
Victor Stinner1f764532020-07-04 23:18:15 +0200738 astmodulestate *state = get_global_ast_state();
739 if (state == NULL) {
740 return -1;
741 }
742
Neal Norwitz207c9f32008-03-31 04:42:11 +0000743 Py_ssize_t i, numfields = 0;
744 int res = -1;
745 PyObject *key, *value, *fields;
Victor Stinner74419f02020-07-03 11:35:37 +0200746 if (_PyObject_LookupAttr((PyObject*)Py_TYPE(self), state->_fields, &fields) < 0) {
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200747 goto cleanup;
748 }
Neal Norwitz207c9f32008-03-31 04:42:11 +0000749 if (fields) {
750 numfields = PySequence_Size(fields);
Rémi Lapeyrec73914a2020-05-24 23:12:57 +0200751 if (numfields == -1) {
Neal Norwitz207c9f32008-03-31 04:42:11 +0000752 goto cleanup;
Rémi Lapeyrec73914a2020-05-24 23:12:57 +0200753 }
Neal Norwitz207c9f32008-03-31 04:42:11 +0000754 }
INADA Naoki4c78c522017-02-24 02:48:17 +0900755
Neal Norwitz207c9f32008-03-31 04:42:11 +0000756 res = 0; /* if no error occurs, this stays 0 to the end */
INADA Naoki4c78c522017-02-24 02:48:17 +0900757 if (numfields < PyTuple_GET_SIZE(args)) {
758 PyErr_Format(PyExc_TypeError, "%.400s constructor takes at most "
759 "%zd positional argument%s",
Dino Viehlandac46eb42019-09-11 10:16:34 -0700760 _PyType_Name(Py_TYPE(self)),
INADA Naoki4c78c522017-02-24 02:48:17 +0900761 numfields, numfields == 1 ? "" : "s");
762 res = -1;
763 goto cleanup;
764 }
765 for (i = 0; i < PyTuple_GET_SIZE(args); i++) {
766 /* cannot be reached when fields is NULL */
767 PyObject *name = PySequence_GetItem(fields, i);
768 if (!name) {
Neal Norwitz207c9f32008-03-31 04:42:11 +0000769 res = -1;
770 goto cleanup;
771 }
INADA Naoki4c78c522017-02-24 02:48:17 +0900772 res = PyObject_SetAttr(self, name, PyTuple_GET_ITEM(args, i));
773 Py_DECREF(name);
Rémi Lapeyrec73914a2020-05-24 23:12:57 +0200774 if (res < 0) {
INADA Naoki4c78c522017-02-24 02:48:17 +0900775 goto cleanup;
Rémi Lapeyrec73914a2020-05-24 23:12:57 +0200776 }
Neal Norwitz207c9f32008-03-31 04:42:11 +0000777 }
778 if (kw) {
779 i = 0; /* needed by PyDict_Next */
780 while (PyDict_Next(kw, &i, &key, &value)) {
Rémi Lapeyrec73914a2020-05-24 23:12:57 +0200781 int contains = PySequence_Contains(fields, key);
782 if (contains == -1) {
783 res = -1;
Neal Norwitz207c9f32008-03-31 04:42:11 +0000784 goto cleanup;
Rémi Lapeyrec73914a2020-05-24 23:12:57 +0200785 } else if (contains == 1) {
786 Py_ssize_t p = PySequence_Index(fields, key);
787 if (p == -1) {
788 res = -1;
789 goto cleanup;
790 }
791 if (p < PyTuple_GET_SIZE(args)) {
792 PyErr_Format(PyExc_TypeError,
793 "%.400s got multiple values for argument '%U'",
794 Py_TYPE(self)->tp_name, key);
795 res = -1;
796 goto cleanup;
797 }
798 }
799 res = PyObject_SetAttr(self, key, value);
800 if (res < 0) {
801 goto cleanup;
802 }
Neal Norwitz207c9f32008-03-31 04:42:11 +0000803 }
804 }
805 cleanup:
806 Py_XDECREF(fields);
807 return res;
808}
809
Neal Norwitzee9b10a2008-03-31 05:29:39 +0000810/* Pickling support */
811static PyObject *
812ast_type_reduce(PyObject *self, PyObject *unused)
813{
Victor Stinner91e1bc12020-07-03 14:15:53 +0200814 astmodulestate *state = get_global_ast_state();
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +0200815 if (state == NULL) {
816 return NULL;
817 }
818
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200819 PyObject *dict;
Victor Stinner74419f02020-07-03 11:35:37 +0200820 if (_PyObject_LookupAttr(self, state->__dict__, &dict) < 0) {
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200821 return NULL;
Neal Norwitzee9b10a2008-03-31 05:29:39 +0000822 }
823 if (dict) {
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200824 return Py_BuildValue("O()N", Py_TYPE(self), dict);
Neal Norwitzee9b10a2008-03-31 05:29:39 +0000825 }
826 return Py_BuildValue("O()", Py_TYPE(self));
827}
828
Eddie Elizondo3368f3c2019-09-19 09:29:05 -0700829static PyMemberDef ast_type_members[] = {
830 {"__dictoffset__", T_PYSSIZET, offsetof(AST_object, dict), READONLY},
831 {NULL} /* Sentinel */
832};
833
Neal Norwitzee9b10a2008-03-31 05:29:39 +0000834static PyMethodDef ast_type_methods[] = {
835 {"__reduce__", ast_type_reduce, METH_NOARGS, NULL},
836 {NULL}
837};
838
Benjamin Peterson7e0dbfb2012-03-12 09:46:44 -0700839static PyGetSetDef ast_type_getsets[] = {
840 {"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict},
841 {NULL}
842};
843
Dino Viehlandac46eb42019-09-11 10:16:34 -0700844static PyType_Slot AST_type_slots[] = {
845 {Py_tp_dealloc, ast_dealloc},
846 {Py_tp_getattro, PyObject_GenericGetAttr},
847 {Py_tp_setattro, PyObject_GenericSetAttr},
848 {Py_tp_traverse, ast_traverse},
849 {Py_tp_clear, ast_clear},
Eddie Elizondo3368f3c2019-09-19 09:29:05 -0700850 {Py_tp_members, ast_type_members},
Dino Viehlandac46eb42019-09-11 10:16:34 -0700851 {Py_tp_methods, ast_type_methods},
852 {Py_tp_getset, ast_type_getsets},
853 {Py_tp_init, ast_type_init},
854 {Py_tp_alloc, PyType_GenericAlloc},
855 {Py_tp_new, PyType_GenericNew},
Dino Viehlandac46eb42019-09-11 10:16:34 -0700856 {Py_tp_free, PyObject_GC_Del},
857 {0, 0},
858};
859
860static PyType_Spec AST_type_spec = {
Serhiy Storchakabace59d2020-03-22 20:33:34 +0200861 "ast.AST",
Benjamin Peterson7e0dbfb2012-03-12 09:46:44 -0700862 sizeof(AST_object),
Neal Norwitz207c9f32008-03-31 04:42:11 +0000863 0,
Dino Viehlandac46eb42019-09-11 10:16:34 -0700864 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
865 AST_type_slots
Neal Norwitz207c9f32008-03-31 04:42:11 +0000866};
867
Dino Viehlandac46eb42019-09-11 10:16:34 -0700868static PyObject *
Victor Stinner74419f02020-07-03 11:35:37 +0200869make_type(astmodulestate *state, const char *type, PyObject* base,
870 const char* const* fields, int num_fields, const char *doc)
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000871{
872 PyObject *fnames, *result;
873 int i;
Neal Norwitzee9b10a2008-03-31 05:29:39 +0000874 fnames = PyTuple_New(num_fields);
875 if (!fnames) return NULL;
876 for (i = 0; i < num_fields; i++) {
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300877 PyObject *field = PyUnicode_InternFromString(fields[i]);
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000878 if (!field) {
879 Py_DECREF(fnames);
880 return NULL;
881 }
882 PyTuple_SET_ITEM(fnames, i, field);
883 }
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +0300884 result = PyObject_CallFunction((PyObject*)&PyType_Type, "s(O){OOOOOs}",
INADA Naokifc489082017-01-25 22:33:43 +0900885 type, base,
Victor Stinner74419f02020-07-03 11:35:37 +0200886 state->_fields, fnames,
887 state->__module__,
888 state->ast,
889 state->__doc__, doc);
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000890 Py_DECREF(fnames);
Dino Viehlandac46eb42019-09-11 10:16:34 -0700891 return result;
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000892}
893
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300894static int
Victor Stinner74419f02020-07-03 11:35:37 +0200895add_attributes(astmodulestate *state, PyObject *type, const char * const *attrs, int num_fields)
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000896{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000897 int i, result;
Neal Norwitz207c9f32008-03-31 04:42:11 +0000898 PyObject *s, *l = PyTuple_New(num_fields);
Benjamin Peterson3e5cd1d2010-06-27 21:45:24 +0000899 if (!l)
900 return 0;
901 for (i = 0; i < num_fields; i++) {
Serhiy Storchaka43c97312019-09-10 13:02:30 +0300902 s = PyUnicode_InternFromString(attrs[i]);
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000903 if (!s) {
904 Py_DECREF(l);
905 return 0;
906 }
Neal Norwitz207c9f32008-03-31 04:42:11 +0000907 PyTuple_SET_ITEM(l, i, s);
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000908 }
Victor Stinner74419f02020-07-03 11:35:37 +0200909 result = PyObject_SetAttr(type, state->_attributes, l) >= 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000910 Py_DECREF(l);
911 return result;
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000912}
913
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000914/* Conversion AST -> Python */
915
Victor Stinner74419f02020-07-03 11:35:37 +0200916static PyObject* ast2obj_list(astmodulestate *state, asdl_seq *seq, PyObject* (*func)(astmodulestate *state, void*))
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000917{
Benjamin Peterson77fa9372012-05-15 10:10:27 -0700918 Py_ssize_t i, n = asdl_seq_LEN(seq);
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000919 PyObject *result = PyList_New(n);
920 PyObject *value;
921 if (!result)
922 return NULL;
923 for (i = 0; i < n; i++) {
Pablo Galindoa5634c42020-09-16 19:42:00 +0100924 value = func(state, asdl_seq_GET_UNTYPED(seq, i));
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000925 if (!value) {
926 Py_DECREF(result);
927 return NULL;
928 }
929 PyList_SET_ITEM(result, i, value);
930 }
931 return result;
932}
933
Victor Stinner74419f02020-07-03 11:35:37 +0200934static PyObject* ast2obj_object(astmodulestate *Py_UNUSED(state), void *o)
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000935{
936 if (!o)
937 o = Py_None;
938 Py_INCREF((PyObject*)o);
939 return (PyObject*)o;
940}
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100941#define ast2obj_constant ast2obj_object
Martin v. Löwisbd260da2006-02-26 19:42:26 +0000942#define ast2obj_identifier ast2obj_object
943#define ast2obj_string ast2obj_object
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000944
Victor Stinner74419f02020-07-03 11:35:37 +0200945static PyObject* ast2obj_int(astmodulestate *Py_UNUSED(state), long b)
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000946{
Christian Heimes2b1c5922007-12-02 22:43:00 +0000947 return PyLong_FromLong(b);
Martin v. Löwis577b5b92006-02-27 15:23:19 +0000948}
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000949
950/* Conversion Python -> AST */
951
Victor Stinner74419f02020-07-03 11:35:37 +0200952static int obj2ast_object(astmodulestate *Py_UNUSED(state), PyObject* obj, PyObject** out, PyArena* arena)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000953{
954 if (obj == Py_None)
955 obj = NULL;
Christian Heimes70c94e72013-07-27 00:33:13 +0200956 if (obj) {
957 if (PyArena_AddPyObject(arena, obj) < 0) {
958 *out = NULL;
959 return -1;
960 }
961 Py_INCREF(obj);
962 }
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000963 *out = obj;
964 return 0;
965}
966
Victor Stinner74419f02020-07-03 11:35:37 +0200967static int obj2ast_constant(astmodulestate *Py_UNUSED(state), PyObject* obj, PyObject** out, PyArena* arena)
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100968{
Serhiy Storchaka3f228112018-09-27 17:42:37 +0300969 if (PyArena_AddPyObject(arena, obj) < 0) {
970 *out = NULL;
971 return -1;
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100972 }
Serhiy Storchaka3f228112018-09-27 17:42:37 +0300973 Py_INCREF(obj);
Victor Stinnerf2c1aa12016-01-26 00:40:57 +0100974 *out = obj;
975 return 0;
976}
977
Victor Stinner74419f02020-07-03 11:35:37 +0200978static int obj2ast_identifier(astmodulestate *state, PyObject* obj, PyObject** out, PyArena* arena)
Benjamin Peterson2193d2b2011-07-22 10:50:23 -0500979{
Benjamin Peterson180e6352011-07-22 11:09:07 -0500980 if (!PyUnicode_CheckExact(obj) && obj != Py_None) {
981 PyErr_SetString(PyExc_TypeError, "AST identifier must be of type str");
Benjamin Peterson2193d2b2011-07-22 10:50:23 -0500982 return 1;
983 }
Victor Stinner74419f02020-07-03 11:35:37 +0200984 return obj2ast_object(state, obj, out, arena);
Benjamin Peterson2193d2b2011-07-22 10:50:23 -0500985}
986
Victor Stinner74419f02020-07-03 11:35:37 +0200987static int obj2ast_string(astmodulestate *state, PyObject* obj, PyObject** out, PyArena* arena)
Guido van Rossumdcfcd142019-01-31 03:40:27 -0800988{
989 if (!PyUnicode_CheckExact(obj) && !PyBytes_CheckExact(obj)) {
990 PyErr_SetString(PyExc_TypeError, "AST string must be of type str");
991 return 1;
992 }
Victor Stinner74419f02020-07-03 11:35:37 +0200993 return obj2ast_object(state, obj, out, arena);
Guido van Rossumdcfcd142019-01-31 03:40:27 -0800994}
995
Victor Stinner74419f02020-07-03 11:35:37 +0200996static int obj2ast_int(astmodulestate* Py_UNUSED(state), PyObject* obj, int* out, PyArena* arena)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +0000997{
998 int i;
999 if (!PyLong_Check(obj)) {
Amaury Forgeot d'Arc58e87612011-11-22 21:51:55 +01001000 PyErr_Format(PyExc_ValueError, "invalid integer value: %R", obj);
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001001 return 1;
1002 }
1003
Serhiy Storchaka481d3af2015-09-06 23:29:04 +03001004 i = _PyLong_AsInt(obj);
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001005 if (i == -1 && PyErr_Occurred())
1006 return 1;
1007 *out = i;
1008 return 0;
1009}
1010
Victor Stinner74419f02020-07-03 11:35:37 +02001011static int add_ast_fields(astmodulestate *state)
Benjamin Peterson206e3072008-10-19 14:07:49 +00001012{
Dino Viehlandac46eb42019-09-11 10:16:34 -07001013 PyObject *empty_tuple;
Benjamin Peterson206e3072008-10-19 14:07:49 +00001014 empty_tuple = PyTuple_New(0);
1015 if (!empty_tuple ||
Victor Stinner74419f02020-07-03 11:35:37 +02001016 PyObject_SetAttrString(state->AST_type, "_fields", empty_tuple) < 0 ||
1017 PyObject_SetAttrString(state->AST_type, "_attributes", empty_tuple) < 0) {
Benjamin Peterson206e3072008-10-19 14:07:49 +00001018 Py_XDECREF(empty_tuple);
1019 return -1;
1020 }
1021 Py_DECREF(empty_tuple);
1022 return 0;
1023}
1024
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001025""", 0, reflow=False)
1026
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001027 self.emit("static int init_types(astmodulestate *state)",0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001028 self.emit("{", 0)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001029 self.emit("if (state->initialized) return 1;", 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001030 self.emit("if (init_identifiers(state) < 0) return 0;", 1)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001031 self.emit("state->AST_type = PyType_FromSpec(&AST_type_spec);", 1)
1032 self.emit("if (!state->AST_type) return 0;", 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001033 self.emit("if (add_ast_fields(state) < 0) return 0;", 1)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001034 for dfn in mod.dfns:
1035 self.visit(dfn)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001036 self.emit("state->initialized = 1;", 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001037 self.emit("return 1;", 1);
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001038 self.emit("}", 0)
1039
1040 def visitProduct(self, prod, name):
Martin v. Löwis8d0701d2006-02-26 23:40:20 +00001041 if prod.fields:
Eli Bendersky5e3d3382014-05-09 17:58:22 -07001042 fields = name+"_fields"
Martin v. Löwis8d0701d2006-02-26 23:40:20 +00001043 else:
1044 fields = "NULL"
Victor Stinner74419f02020-07-03 11:35:37 +02001045 self.emit('state->%s_type = make_type(state, "%s", state->AST_type, %s, %d,' %
Martin v. Löwis8d0701d2006-02-26 23:40:20 +00001046 (name, name, fields, len(prod.fields)), 1)
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +03001047 self.emit('%s);' % reflow_c_string(asdl_of(name, prod), 2), 2, reflow=False)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001048 self.emit("if (!state->%s_type) return 0;" % name, 1)
1049 self.emit_type("AST_type")
1050 self.emit_type("%s_type" % name)
Benjamin Petersoncda75be2013-03-18 10:48:58 -07001051 if prod.attributes:
Victor Stinner74419f02020-07-03 11:35:37 +02001052 self.emit("if (!add_attributes(state, state->%s_type, %s_attributes, %d)) return 0;" %
Benjamin Petersoncda75be2013-03-18 10:48:58 -07001053 (name, name, len(prod.attributes)), 1)
1054 else:
Victor Stinner74419f02020-07-03 11:35:37 +02001055 self.emit("if (!add_attributes(state, state->%s_type, NULL, 0)) return 0;" % name, 1)
Serhiy Storchakab7e95252020-03-10 00:07:47 +02001056 self.emit_defaults(name, prod.fields, 1)
1057 self.emit_defaults(name, prod.attributes, 1)
Tim Peters710ab3b2006-02-28 18:30:36 +00001058
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001059 def visitSum(self, sum, name):
Victor Stinner74419f02020-07-03 11:35:37 +02001060 self.emit('state->%s_type = make_type(state, "%s", state->AST_type, NULL, 0,' %
Neal Norwitz207c9f32008-03-31 04:42:11 +00001061 (name, name), 1)
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +03001062 self.emit('%s);' % reflow_c_string(asdl_of(name, sum), 2), 2, reflow=False)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001063 self.emit_type("%s_type" % name)
1064 self.emit("if (!state->%s_type) return 0;" % name, 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001065 if sum.attributes:
Victor Stinner74419f02020-07-03 11:35:37 +02001066 self.emit("if (!add_attributes(state, state->%s_type, %s_attributes, %d)) return 0;" %
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001067 (name, name, len(sum.attributes)), 1)
1068 else:
Victor Stinner74419f02020-07-03 11:35:37 +02001069 self.emit("if (!add_attributes(state, state->%s_type, NULL, 0)) return 0;" % name, 1)
Serhiy Storchakab7e95252020-03-10 00:07:47 +02001070 self.emit_defaults(name, sum.attributes, 1)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001071 simple = is_simple(sum)
1072 for t in sum.types:
1073 self.visitConstructor(t, name, simple)
Tim Peters710ab3b2006-02-28 18:30:36 +00001074
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001075 def visitConstructor(self, cons, name, simple):
Martin v. Löwis8d0701d2006-02-26 23:40:20 +00001076 if cons.fields:
Eli Bendersky5e3d3382014-05-09 17:58:22 -07001077 fields = cons.name+"_fields"
Martin v. Löwis8d0701d2006-02-26 23:40:20 +00001078 else:
1079 fields = "NULL"
Victor Stinner74419f02020-07-03 11:35:37 +02001080 self.emit('state->%s_type = make_type(state, "%s", state->%s_type, %s, %d,' %
Martin v. Löwis8d0701d2006-02-26 23:40:20 +00001081 (cons.name, cons.name, name, fields, len(cons.fields)), 1)
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +03001082 self.emit('%s);' % reflow_c_string(asdl_of(cons.name, cons), 2), 2, reflow=False)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001083 self.emit("if (!state->%s_type) return 0;" % cons.name, 1)
1084 self.emit_type("%s_type" % cons.name)
Serhiy Storchakab7e95252020-03-10 00:07:47 +02001085 self.emit_defaults(cons.name, cons.fields, 1)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001086 if simple:
Dino Viehlandac46eb42019-09-11 10:16:34 -07001087 self.emit("state->%s_singleton = PyType_GenericNew((PyTypeObject *)"
1088 "state->%s_type, NULL, NULL);" %
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001089 (cons.name, cons.name), 1)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001090 self.emit("if (!state->%s_singleton) return 0;" % cons.name, 1)
Tim Peters710ab3b2006-02-28 18:30:36 +00001091
Serhiy Storchakab7e95252020-03-10 00:07:47 +02001092 def emit_defaults(self, name, fields, depth):
1093 for field in fields:
1094 if field.opt:
1095 self.emit('if (PyObject_SetAttr(state->%s_type, state->%s, Py_None) == -1)' %
1096 (name, field.name), depth)
1097 self.emit("return 0;", depth+1)
1098
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001099
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001100class ASTModuleVisitor(PickleVisitor):
1101
1102 def visitModule(self, mod):
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001103 self.emit("static int", 0)
1104 self.emit("astmodule_exec(PyObject *m)", 0)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001105 self.emit("{", 0)
Victor Stinner74419f02020-07-03 11:35:37 +02001106 self.emit('astmodulestate *state = get_ast_state(m);', 1)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001107 self.emit("", 0)
Victor Stinner74419f02020-07-03 11:35:37 +02001108
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001109 self.emit("if (!init_types(state)) {", 1)
1110 self.emit("return -1;", 2)
Victor Stinner91e1bc12020-07-03 14:15:53 +02001111 self.emit("}", 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001112 self.emit('if (PyModule_AddObject(m, "AST", state->AST_type) < 0) {', 1)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001113 self.emit('return -1;', 2)
Brandt Bucherd2f96672020-02-06 06:45:46 -08001114 self.emit('}', 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001115 self.emit('Py_INCREF(state->AST_type);', 1)
Brandt Bucherd2f96672020-02-06 06:45:46 -08001116 self.emit('if (PyModule_AddIntMacro(m, PyCF_ALLOW_TOP_LEVEL_AWAIT) < 0) {', 1)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001117 self.emit("return -1;", 2)
Brandt Bucherd2f96672020-02-06 06:45:46 -08001118 self.emit('}', 1)
1119 self.emit('if (PyModule_AddIntMacro(m, PyCF_ONLY_AST) < 0) {', 1)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001120 self.emit("return -1;", 2)
Brandt Bucherd2f96672020-02-06 06:45:46 -08001121 self.emit('}', 1)
1122 self.emit('if (PyModule_AddIntMacro(m, PyCF_TYPE_COMMENTS) < 0) {', 1)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001123 self.emit("return -1;", 2)
Brandt Bucherd2f96672020-02-06 06:45:46 -08001124 self.emit('}', 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001125 for dfn in mod.dfns:
1126 self.visit(dfn)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001127 self.emit("return 0;", 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001128 self.emit("}", 0)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001129 self.emit("", 0)
1130 self.emit("""
1131static PyModuleDef_Slot astmodule_slots[] = {
1132 {Py_mod_exec, astmodule_exec},
1133 {0, NULL}
1134};
1135
1136static struct PyModuleDef _astmodule = {
1137 PyModuleDef_HEAD_INIT,
1138 .m_name = "_ast",
Victor Stinnere5fbe0c2020-09-15 18:03:34 +02001139 // The _ast module uses a global state (global_ast_state).
1140 .m_size = 0,
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001141 .m_slots = astmodule_slots,
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001142};
1143
1144PyMODINIT_FUNC
1145PyInit__ast(void)
1146{
1147 return PyModuleDef_Init(&_astmodule);
1148}
1149""".strip(), 0, reflow=False)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001150
1151 def visitProduct(self, prod, name):
1152 self.addObj(name)
Tim Peters710ab3b2006-02-28 18:30:36 +00001153
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001154 def visitSum(self, sum, name):
1155 self.addObj(name)
1156 for t in sum.types:
1157 self.visitConstructor(t, name)
Tim Peters710ab3b2006-02-28 18:30:36 +00001158
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001159 def visitConstructor(self, cons, name):
1160 self.addObj(cons.name)
Tim Peters710ab3b2006-02-28 18:30:36 +00001161
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001162 def addObj(self, name):
Dino Viehlandac46eb42019-09-11 10:16:34 -07001163 self.emit("if (PyModule_AddObject(m, \"%s\", "
Victor Stinner74419f02020-07-03 11:35:37 +02001164 "state->%s_type) < 0) {" % (name, name), 1)
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001165 self.emit("return -1;", 2)
Brandt Bucherd2f96672020-02-06 06:45:46 -08001166 self.emit('}', 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001167 self.emit("Py_INCREF(state->%s_type);" % name, 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001168
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001169
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001170_SPECIALIZED_SEQUENCES = ('stmt', 'expr')
1171
1172def find_sequence(fields, doing_specialization):
1173 """Return True if any field uses a sequence."""
1174 for f in fields:
1175 if f.seq:
1176 if not doing_specialization:
1177 return True
1178 if str(f.type) not in _SPECIALIZED_SEQUENCES:
1179 return True
1180 return False
1181
1182def has_sequence(types, doing_specialization):
1183 for t in types:
1184 if find_sequence(t.fields, doing_specialization):
1185 return True
1186 return False
1187
1188
1189class StaticVisitor(PickleVisitor):
Ezio Melotti7c4a7e62013-08-26 01:32:56 +03001190 CODE = '''Very simple, always emit this static code. Override CODE'''
Neal Norwitz7b5a6042005-11-13 19:14:20 +00001191
1192 def visit(self, object):
1193 self.emit(self.CODE, 0, reflow=False)
1194
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001195
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001196class ObjVisitor(PickleVisitor):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001197
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001198 def func_begin(self, name):
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001199 ctype = get_c_type(name)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001200 self.emit("PyObject*", 0)
Victor Stinner74419f02020-07-03 11:35:37 +02001201 self.emit("ast2obj_%s(astmodulestate *state, void* _o)" % (name), 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001202 self.emit("{", 0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001203 self.emit("%s o = (%s)_o;" % (ctype, ctype), 1)
1204 self.emit("PyObject *result = NULL, *value = NULL;", 1)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001205 self.emit("PyTypeObject *tp;", 1)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001206 self.emit('if (!o) {', 1)
INADA Naokifc489082017-01-25 22:33:43 +09001207 self.emit("Py_RETURN_NONE;", 2)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001208 self.emit("}", 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001209
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001210 def func_end(self):
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001211 self.emit("return result;", 1)
1212 self.emit("failed:", 0)
1213 self.emit("Py_XDECREF(value);", 1)
1214 self.emit("Py_XDECREF(result);", 1)
1215 self.emit("return NULL;", 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001216 self.emit("}", 0)
1217 self.emit("", 0)
1218
1219 def visitSum(self, sum, name):
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001220 if is_simple(sum):
1221 self.simpleSum(sum, name)
1222 return
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001223 self.func_begin(name)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001224 self.emit("switch (o->kind) {", 1)
1225 for i in range(len(sum.types)):
1226 t = sum.types[i]
1227 self.visitConstructor(t, i + 1, name)
1228 self.emit("}", 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001229 for a in sum.attributes:
Victor Stinner74419f02020-07-03 11:35:37 +02001230 self.emit("value = ast2obj_%s(state, o->%s);" % (a.type, a.name), 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001231 self.emit("if (!value) goto failed;", 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001232 self.emit('if (PyObject_SetAttr(result, state->%s, value) < 0)' % a.name, 1)
Martin v. Löwis03e5bc02006-03-02 00:31:27 +00001233 self.emit('goto failed;', 2)
1234 self.emit('Py_DECREF(value);', 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001235 self.func_end()
Tim Peters710ab3b2006-02-28 18:30:36 +00001236
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001237 def simpleSum(self, sum, name):
Victor Stinner74419f02020-07-03 11:35:37 +02001238 self.emit("PyObject* ast2obj_%s(astmodulestate *state, %s_ty o)" % (name, name), 0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001239 self.emit("{", 0)
1240 self.emit("switch(o) {", 1)
1241 for t in sum.types:
1242 self.emit("case %s:" % t.name, 2)
Victor Stinner74419f02020-07-03 11:35:37 +02001243 self.emit("Py_INCREF(state->%s_singleton);" % t.name, 3)
1244 self.emit("return state->%s_singleton;" % t.name, 3)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001245 self.emit("}", 1)
Batuhan Taskaya091951a2020-05-06 17:29:32 +03001246 self.emit("Py_UNREACHABLE();", 1);
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001247 self.emit("}", 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001248
1249 def visitProduct(self, prod, name):
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001250 self.func_begin(name)
Victor Stinner74419f02020-07-03 11:35:37 +02001251 self.emit("tp = (PyTypeObject *)state->%s_type;" % name, 1)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001252 self.emit("result = PyType_GenericNew(tp, NULL, NULL);", 1);
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001253 self.emit("if (!result) return NULL;", 1)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001254 for field in prod.fields:
1255 self.visitField(field, name, 1, True)
Benjamin Petersoncda75be2013-03-18 10:48:58 -07001256 for a in prod.attributes:
Victor Stinner74419f02020-07-03 11:35:37 +02001257 self.emit("value = ast2obj_%s(state, o->%s);" % (a.type, a.name), 1)
Benjamin Petersoncda75be2013-03-18 10:48:58 -07001258 self.emit("if (!value) goto failed;", 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001259 self.emit("if (PyObject_SetAttr(result, state->%s, value) < 0)" % a.name, 1)
Benjamin Petersoncda75be2013-03-18 10:48:58 -07001260 self.emit('goto failed;', 2)
1261 self.emit('Py_DECREF(value);', 1)
Martin v. Löwis577b5b92006-02-27 15:23:19 +00001262 self.func_end()
Tim Peters536cf992005-12-25 23:18:31 +00001263
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001264 def visitConstructor(self, cons, enum, name):
1265 self.emit("case %s_kind:" % cons.name, 1)
Victor Stinner74419f02020-07-03 11:35:37 +02001266 self.emit("tp = (PyTypeObject *)state->%s_type;" % cons.name, 2)
Dino Viehlandac46eb42019-09-11 10:16:34 -07001267 self.emit("result = PyType_GenericNew(tp, NULL, NULL);", 2);
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001268 self.emit("if (!result) goto failed;", 2)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001269 for f in cons.fields:
1270 self.visitField(f, cons.name, 2, False)
1271 self.emit("break;", 2)
1272
1273 def visitField(self, field, name, depth, product):
1274 def emit(s, d):
1275 self.emit(s, depth + d)
1276 if product:
1277 value = "o->%s" % field.name
1278 else:
1279 value = "o->v.%s.%s" % (name, field.name)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001280 self.set(field, value, depth)
1281 emit("if (!value) goto failed;", 0)
Victor Stinner74419f02020-07-03 11:35:37 +02001282 emit("if (PyObject_SetAttr(result, state->%s, value) == -1)" % field.name, 0)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001283 emit("goto failed;", 1)
1284 emit("Py_DECREF(value);", 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001285
1286 def emitSeq(self, field, value, depth, emit):
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001287 emit("seq = %s;" % value, 0)
1288 emit("n = asdl_seq_LEN(seq);", 0)
1289 emit("value = PyList_New(n);", 0)
1290 emit("if (!value) goto failed;", 0)
1291 emit("for (i = 0; i < n; i++) {", 0)
1292 self.set("value", field, "asdl_seq_GET(seq, i)", depth + 1)
1293 emit("if (!value1) goto failed;", 1)
1294 emit("PyList_SET_ITEM(value, i, value1);", 1)
1295 emit("value1 = NULL;", 1)
1296 emit("}", 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001297
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001298 def set(self, field, value, depth):
1299 if field.seq:
Martin v. Löwisce1d5d22006-02-26 20:51:25 +00001300 # XXX should really check for is_simple, but that requires a symbol table
Eli Bendersky5e3d3382014-05-09 17:58:22 -07001301 if field.type == "cmpop":
Martin v. Löwisce1d5d22006-02-26 20:51:25 +00001302 # While the sequence elements are stored as void*,
1303 # ast2obj_cmpop expects an enum
1304 self.emit("{", depth)
Benjamin Peterson77fa9372012-05-15 10:10:27 -07001305 self.emit("Py_ssize_t i, n = asdl_seq_LEN(%s);" % value, depth+1)
Martin v. Löwisce1d5d22006-02-26 20:51:25 +00001306 self.emit("value = PyList_New(n);", depth+1)
1307 self.emit("if (!value) goto failed;", depth+1)
1308 self.emit("for(i = 0; i < n; i++)", depth+1)
1309 # This cannot fail, so no need for error handling
Victor Stinner74419f02020-07-03 11:35:37 +02001310 self.emit("PyList_SET_ITEM(value, i, ast2obj_cmpop(state, (cmpop_ty)asdl_seq_GET(%s, i)));" % value,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001311 depth+2, reflow=False)
Martin v. Löwisce1d5d22006-02-26 20:51:25 +00001312 self.emit("}", depth)
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001313 else:
Pablo Galindoa5634c42020-09-16 19:42:00 +01001314 self.emit("value = ast2obj_list(state, (asdl_seq*)%s, ast2obj_%s);" % (value, field.type), depth)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001315 else:
1316 ctype = get_c_type(field.type)
Victor Stinner74419f02020-07-03 11:35:37 +02001317 self.emit("value = ast2obj_%s(state, %s);" % (field.type, value), depth, reflow=False)
Tim Peters536cf992005-12-25 23:18:31 +00001318
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001319
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001320class PartingShots(StaticVisitor):
1321
1322 CODE = """
1323PyObject* PyAST_mod2obj(mod_ty t)
1324{
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001325 astmodulestate *state = get_global_ast_state();
1326 if (state == NULL) {
Victor Stinnerbdf630c2013-07-17 00:17:15 +02001327 return NULL;
Victor Stinner91e1bc12020-07-03 14:15:53 +02001328 }
Victor Stinner74419f02020-07-03 11:35:37 +02001329 return ast2obj_mod(state, t);
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001330}
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001331
Neal Norwitzdb4115f2008-03-31 04:20:05 +00001332/* mode is 0 for "exec", 1 for "eval" and 2 for "single" input */
1333mod_ty PyAST_obj2mod(PyObject* ast, PyArena* arena, int mode)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001334{
Serhiy Storchaka43c97312019-09-10 13:02:30 +03001335 const char * const req_name[] = {"Module", "Expression", "Interactive"};
Benjamin Peterson97dd9872009-12-13 01:23:39 +00001336 int isinstance;
Benjamin Petersonc2f665e2014-02-10 22:19:02 -05001337
Steve Dowerb82e17e2019-05-23 08:45:22 -07001338 if (PySys_Audit("compile", "OO", ast, Py_None) < 0) {
1339 return NULL;
1340 }
1341
Victor Stinner91e1bc12020-07-03 14:15:53 +02001342 astmodulestate *state = get_global_ast_state();
Victor Stinner74419f02020-07-03 11:35:37 +02001343 PyObject *req_type[3];
1344 req_type[0] = state->Module_type;
1345 req_type[1] = state->Expression_type;
1346 req_type[2] = state->Interactive_type;
Benjamin Petersonc2f665e2014-02-10 22:19:02 -05001347
Guido van Rossum3a32e3b2019-02-01 11:37:34 -08001348 assert(0 <= mode && mode <= 2);
Neal Norwitzdb4115f2008-03-31 04:20:05 +00001349
Benjamin Peterson97dd9872009-12-13 01:23:39 +00001350 isinstance = PyObject_IsInstance(ast, req_type[mode]);
1351 if (isinstance == -1)
1352 return NULL;
1353 if (!isinstance) {
Neal Norwitzdb4115f2008-03-31 04:20:05 +00001354 PyErr_Format(PyExc_TypeError, "expected %s node, got %.400s",
Dino Viehlandac46eb42019-09-11 10:16:34 -07001355 req_name[mode], _PyType_Name(Py_TYPE(ast)));
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001356 return NULL;
1357 }
Dong-hee Naa05fcd32019-10-10 16:41:26 +09001358
1359 mod_ty res = NULL;
Victor Stinner74419f02020-07-03 11:35:37 +02001360 if (obj2ast_mod(state, ast, &res, arena) != 0)
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001361 return NULL;
1362 else
1363 return res;
1364}
1365
1366int PyAST_Check(PyObject* obj)
1367{
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001368 astmodulestate *state = get_global_ast_state();
1369 if (state == NULL) {
Victor Stinnerbdf630c2013-07-17 00:17:15 +02001370 return -1;
Victor Stinner91e1bc12020-07-03 14:15:53 +02001371 }
Victor Stinner74419f02020-07-03 11:35:37 +02001372 return PyObject_IsInstance(obj, state->AST_type);
Martin v. Löwis618dc5e2008-03-30 20:03:44 +00001373}
Martin v. Löwisbd260da2006-02-26 19:42:26 +00001374"""
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001375
1376class ChainOfVisitors:
1377 def __init__(self, *visitors):
1378 self.visitors = visitors
1379
1380 def visit(self, object):
1381 for v in self.visitors:
1382 v.visit(object)
Neal Norwitz7b5a6042005-11-13 19:14:20 +00001383 v.emit("", 0)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001384
Dino Viehlandac46eb42019-09-11 10:16:34 -07001385
1386def generate_module_def(f, mod):
1387 # Gather all the data needed for ModuleSpec
1388 visitor_list = set()
1389 with open(os.devnull, "w") as devnull:
1390 visitor = PyTypesDeclareVisitor(devnull)
1391 visitor.visit(mod)
1392 visitor_list.add(visitor)
1393 visitor = PyTypesVisitor(devnull)
1394 visitor.visit(mod)
1395 visitor_list.add(visitor)
1396
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +03001397 state_strings = {
Serhiy Storchakabace59d2020-03-22 20:33:34 +02001398 "ast",
Batuhan Taşkaya4ab362c2020-03-16 11:12:53 +03001399 "_fields",
1400 "__doc__",
1401 "__dict__",
1402 "__module__",
1403 "_attributes",
1404 }
1405 module_state = state_strings.copy()
Dino Viehlandac46eb42019-09-11 10:16:34 -07001406 for visitor in visitor_list:
1407 for identifier in visitor.identifiers:
1408 module_state.add(identifier)
1409 state_strings.add(identifier)
1410 for singleton in visitor.singletons:
1411 module_state.add(singleton)
1412 for tp in visitor.types:
1413 module_state.add(tp)
1414 state_strings = sorted(state_strings)
1415 module_state = sorted(module_state)
1416 f.write('typedef struct {\n')
1417 f.write(' int initialized;\n')
1418 for s in module_state:
1419 f.write(' PyObject *' + s + ';\n')
1420 f.write('} astmodulestate;\n\n')
1421 f.write("""
Victor Stinnere5fbe0c2020-09-15 18:03:34 +02001422// Forward declaration
1423static int init_types(astmodulestate *state);
1424
1425// bpo-41194, bpo-41261, bpo-41631: The _ast module uses a global state.
1426static astmodulestate global_ast_state = {0};
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001427
1428static astmodulestate*
1429get_global_ast_state(void)
1430{
Victor Stinnere5fbe0c2020-09-15 18:03:34 +02001431 astmodulestate* state = &global_ast_state;
1432 if (!init_types(state)) {
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001433 return NULL;
1434 }
Victor Stinnerb1cc6ba2020-07-03 20:01:46 +02001435 return state;
Victor Stinner74419f02020-07-03 11:35:37 +02001436}
Dino Viehlandac46eb42019-09-11 10:16:34 -07001437
Victor Stinnere5fbe0c2020-09-15 18:03:34 +02001438static astmodulestate*
1439get_ast_state(PyObject* Py_UNUSED(module))
Dino Viehlandac46eb42019-09-11 10:16:34 -07001440{
Victor Stinnere5fbe0c2020-09-15 18:03:34 +02001441 astmodulestate* state = get_global_ast_state();
1442 // get_ast_state() must only be called after _ast module is imported,
1443 // and astmodule_exec() calls init_types()
1444 assert(state != NULL);
1445 return state;
1446}
1447
1448void _PyAST_Fini(PyThreadState *tstate)
1449{
1450 astmodulestate* state = &global_ast_state;
Dino Viehlandac46eb42019-09-11 10:16:34 -07001451""")
1452 for s in module_state:
Victor Stinner74419f02020-07-03 11:35:37 +02001453 f.write(" Py_CLEAR(state->" + s + ');\n')
Dino Viehlandac46eb42019-09-11 10:16:34 -07001454 f.write("""
Victor Stinnere5fbe0c2020-09-15 18:03:34 +02001455 state->initialized = 0;
Dino Viehlandac46eb42019-09-11 10:16:34 -07001456}
1457
Dino Viehlandac46eb42019-09-11 10:16:34 -07001458""")
Victor Stinner74419f02020-07-03 11:35:37 +02001459 f.write('static int init_identifiers(astmodulestate *state)\n')
Dino Viehlandac46eb42019-09-11 10:16:34 -07001460 f.write('{\n')
Dino Viehlandac46eb42019-09-11 10:16:34 -07001461 for identifier in state_strings:
1462 f.write(' if ((state->' + identifier)
1463 f.write(' = PyUnicode_InternFromString("')
1464 f.write(identifier + '")) == NULL) return 0;\n')
1465 f.write(' return 1;\n')
1466 f.write('};\n\n')
1467
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001468def write_header(f, mod):
1469 f.write('#ifndef Py_PYTHON_AST_H\n')
1470 f.write('#define Py_PYTHON_AST_H\n')
1471 f.write('#ifdef __cplusplus\n')
1472 f.write('extern "C" {\n')
1473 f.write('#endif\n')
1474 f.write('\n')
1475 f.write('#ifndef Py_LIMITED_API\n')
1476 f.write('#include "asdl.h"\n')
1477 f.write('\n')
1478 f.write('#undef Yield /* undefine macro conflicting with <winbase.h> */\n')
1479 f.write('\n')
1480 c = ChainOfVisitors(TypeDefVisitor(f),
Pablo Galindoa5634c42020-09-16 19:42:00 +01001481 SequenceDefVisitor(f),
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001482 StructVisitor(f))
1483 c.visit(mod)
1484 f.write("// Note: these macros affect function definitions, not only call sites.\n")
1485 PrototypeVisitor(f).visit(mod)
1486 f.write("\n")
1487 f.write("PyObject* PyAST_mod2obj(mod_ty t);\n")
1488 f.write("mod_ty PyAST_obj2mod(PyObject* ast, PyArena* arena, int mode);\n")
1489 f.write("int PyAST_Check(PyObject* obj);\n")
1490 f.write("#endif /* !Py_LIMITED_API */\n")
1491 f.write('\n')
1492 f.write('#ifdef __cplusplus\n')
1493 f.write('}\n')
1494 f.write('#endif\n')
1495 f.write('#endif /* !Py_PYTHON_AST_H */\n')
Dino Viehlandac46eb42019-09-11 10:16:34 -07001496
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001497def write_source(f, mod):
1498 f.write('#include <stddef.h>\n')
1499 f.write('\n')
1500 f.write('#include "Python.h"\n')
1501 f.write('#include "%s-ast.h"\n' % mod.name)
1502 f.write('#include "structmember.h" // PyMemberDef\n')
1503 f.write('\n')
Thomas Wouterscf297e42007-02-23 15:07:44 +00001504
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001505 generate_module_def(f, mod)
1506
1507 v = ChainOfVisitors(
Pablo Galindoa5634c42020-09-16 19:42:00 +01001508 SequenceConstructorVisitor(f),
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001509 PyTypesDeclareVisitor(f),
1510 PyTypesVisitor(f),
1511 Obj2ModPrototypeVisitor(f),
1512 FunctionVisitor(f),
1513 ObjVisitor(f),
1514 Obj2ModVisitor(f),
1515 ASTModuleVisitor(f),
1516 PartingShots(f),
1517 )
1518 v.visit(mod)
1519
1520def main(input_file, c_file, h_file, dump_module=False):
1521 auto_gen_msg = AUTOGEN_MESSAGE.format("/".join(Path(__file__).parts[-2:]))
1522 mod = asdl.parse(input_file)
Eli Bendersky5e3d3382014-05-09 17:58:22 -07001523 if dump_module:
1524 print('Parsed Module:')
1525 print(mod)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001526 if not asdl.check(mod):
1527 sys.exit(1)
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001528 for file, writer in (c_file, write_source), (h_file, write_header):
1529 if file is not None:
1530 with file.open("w") as f:
1531 f.write(auto_gen_msg)
1532 writer(f, mod)
1533 print(file, "regenerated.")
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001534
1535if __name__ == "__main__":
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001536 parser = ArgumentParser()
1537 parser.add_argument("input_file", type=Path)
1538 parser.add_argument("-C", "--c-file", type=Path, default=None)
1539 parser.add_argument("-H", "--h-file", type=Path, default=None)
1540 parser.add_argument("-d", "--dump-module", action="store_true")
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001541
Batuhan Taskaya63b8e0c2020-05-18 20:42:10 +03001542 options = parser.parse_args()
1543 main(**vars(options))