1 #

2 # Symbol Table

3 #

4

5 import re

6 from Cython import Utils

7 from Errors import warning, error, InternalError

8 from StringEncoding import EncodedString

9 import Options, Naming

10 import PyrexTypes

11 from PyrexTypes import py_object_type, unspecified_type

12 import TypeSlots

13 from TypeSlots import \

14 pyfunction_signature, pymethod_signature, \

15 get_special_method_signature, get_property_accessor_signature

16 import ControlFlow

17 import Code

18 import __builtin__ as builtins

19 try:

20 set

21 except NameError:

22 from sets import Set as set

23

24 possible_identifier = re.compile(ur"(?![0-9])\w+$", re.U).match

25 nice_identifier = re.compile('^[a-zA-Z0-0_]+$').match

26

27 iso_c99_keywords = set(

28 ['auto', 'break', 'case', 'char', 'const', 'continue', 'default', 'do',

29 'double', 'else', 'enum', 'extern', 'float', 'for', 'goto', 'if',

30 'int', 'long', 'register', 'return', 'short', 'signed', 'sizeof',

31 'static', 'struct', 'switch', 'typedef', 'union', 'unsigned', 'void',

32 'volatile', 'while',

33 '_Bool', '_Complex'', _Imaginary', 'inline', 'restrict'])

34

35 def c_safe_identifier(cname):

36 # There are some C limitations on struct entry names.

37 if ((cname[:2] == '__'

38 and not (cname.startswith(Naming.pyrex_prefix)

39 or cname == '__weakref__'))

40 or cname in iso_c99_keywords):

41 cname = Naming.pyrex_prefix + cname

42 return cname

43

44 class BufferAux(object):

45 writable_needed = False

46

47 def __init__(self, buffer_info_var, stridevars, shapevars,

48 suboffsetvars):

49 self.buffer_info_var = buffer_info_var

50 self.stridevars = stridevars

51 self.shapevars = shapevars

52 self.suboffsetvars = suboffsetvars

53

54 def __repr__(self):

55 return "<BufferAux %r>" % self.__dict__

56

57 class Entry(object):

58 # A symbol table entry in a Scope or ModuleNamespace.

59 #

60 # name string Python name of entity

61 # cname string C name of entity

62 # type PyrexType Type of entity

63 # doc string Doc string

64 # init string Initial value

65 # visibility 'private' or 'public' or 'extern'

66 # is_builtin boolean Is an entry in the Python builtins dict

67 # is_cglobal boolean Is a C global variable

68 # is_pyglobal boolean Is a Python module-level variable

69 # or class attribute during

70 # class construction

71 # is_member boolean Is an assigned class member

72 # is_variable boolean Is a variable

73 # is_cfunction boolean Is a C function

74 # is_cmethod boolean Is a C method of an extension type

75 # is_unbound_cmethod boolean Is an unbound C method of an extension type

76 # is_type boolean Is a type definition

77 # is_cclass boolean Is an extension class

78 # is_const boolean Is a constant

79 # is_property boolean Is a property of an extension type:

80 # doc_cname string or None C const holding the docstring

81 # getter_cname string C func for getting property

82 # setter_cname string C func for setting or deleting property

83 # is_self_arg boolean Is the "self" arg of an exttype method

84 # is_arg boolean Is the arg of a method

85 # is_local boolean Is a local variable

86 # in_closure boolean Is referenced in an inner scope

87 # is_readonly boolean Can't be assigned to

88 # func_cname string C func implementing Python func

89 # func_modifiers [string] C function modifiers ('inline')

90 # pos position Source position where declared

91 # namespace_cname string If is_pyglobal, the C variable

92 # holding its home namespace

93 # pymethdef_cname string PyMethodDef structure

94 # signature Signature Arg & return types for Python func

95 # init_to_none boolean True if initial value should be None

96 # as_variable Entry Alternative interpretation of extension

97 # type name or builtin C function as a variable

98 # xdecref_cleanup boolean Use Py_XDECREF for error cleanup

99 # in_cinclude boolean Suppress C declaration code

100 # enum_values [Entry] For enum types, list of values

101 # qualified_name string "modname.funcname" or "modname.classname"

102 # or "modname.classname.funcname"

103 # is_declared_generic boolean Is declared as PyObject * even though its

104 # type is an extension type

105 # as_module None Module scope, if a cimported module

106 # is_inherited boolean Is an inherited attribute of an extension type

107 # pystring_cname string C name of Python version of string literal

108 # is_interned boolean For string const entries, value is interned

109 # is_identifier boolean For string const entries, value is an identifier

110 # used boolean

111 # is_special boolean Is a special method or property accessor

112 # of an extension type

113 # defined_in_pxd boolean Is defined in a .pxd file (not just declared)

114 # api boolean Generate C API for C class or function

115 # utility_code string Utility code needed when this entry is used

116 #

117 # buffer_aux BufferAux or None Extra information needed for buffer variables

118 # inline_func_in_pxd boolean Hacky special case for inline function in pxd file.

119 # Ideally this should not be necesarry.

120 # assignments [ExprNode] List of expressions that get assigned to this entry.

121

122 inline_func_in_pxd = False

123 borrowed = 0

124 init = ""

125 visibility = 'private'

126 is_builtin = 0

127 is_cglobal = 0

128 is_pyglobal = 0

129 is_member = 0

130 is_variable = 0

131 is_cfunction = 0

132 is_cmethod = 0

133 is_unbound_cmethod = 0

134 is_type = 0

135 is_cclass = 0

136 is_const = 0

137 is_property = 0

138 doc_cname = None

139 getter_cname = None

140 setter_cname = None

141 is_self_arg = 0

142 is_arg = 0

143 is_local = 0

144 in_closure = 0

145 is_declared_generic = 0

146 is_readonly = 0

147 func_cname = None

148 func_modifiers = []

149 doc = None

150 init_to_none = 0

151 as_variable = None

152 xdecref_cleanup = 0

153 in_cinclude = 0

154 as_module = None

155 is_inherited = 0

156 pystring_cname = None

157 is_identifier = 0

158 is_interned = 0

159 used = 0

160 is_special = 0

161 defined_in_pxd = 0

162 is_implemented = 0

163 api = 0

164 utility_code = None

165 is_overridable = 0

166 buffer_aux = None

167 prev_entry = None

168

169 def __init__(self, name, cname, type, pos = None, init = None):

170 self.name = name

171 self.cname = cname

172 self.type = type

173 self.pos = pos

174 self.init = init

175 self.assignments = []

176

177 def __repr__(self):

178 return "Entry(name=%s, type=%s)" % (self.name, self.type)

179

180 def redeclared(self, pos):

181 error(pos, "'%s' does not match previous declaration" % self.name)

182 error(self.pos, "Previous declaration is here")

183

184 class Scope(object):

185 # name string Unqualified name

186 # outer_scope Scope or None Enclosing scope

187 # entries {string : Entry} Python name to entry, non-types

188 # const_entries [Entry] Constant entries

189 # type_entries [Entry] Struct/union/enum/typedef/exttype entries

190 # sue_entries [Entry] Struct/union/enum entries

191 # arg_entries [Entry] Function argument entries

192 # var_entries [Entry] User-defined variable entries

193 # pyfunc_entries [Entry] Python function entries

194 # cfunc_entries [Entry] C function entries

195 # c_class_entries [Entry] All extension type entries

196 # cname_to_entry {string : Entry} Temp cname to entry mapping

197 # int_to_entry {int : Entry} Temp cname to entry mapping

198 # return_type PyrexType or None Return type of function owning scope

199 # is_py_class_scope boolean Is a Python class scope

200 # is_c_class_scope boolean Is an extension type scope

201 # scope_prefix string Disambiguator for C names

202 # in_cinclude boolean Suppress C declaration code

203 # qualified_name string "modname" or "modname.classname"

204 # pystring_entries [Entry] String const entries newly used as

205 # Python strings in this scope

206 # control_flow ControlFlow Used for keeping track of environment state

207 # nogil boolean In a nogil section

208 # directives dict Helper variable for the recursive

209 # analysis, contains directive values.

210

211 is_py_class_scope = 0

212 is_c_class_scope = 0

213 is_module_scope = 0

214 scope_prefix = ""

215 in_cinclude = 0

216 nogil = 0

217

218 def __init__(self, name, outer_scope, parent_scope):

219 # The outer_scope is the next scope in the lookup chain.

220 # The parent_scope is used to derive the qualified name of this scope.

221 self.name = name

222 self.outer_scope = outer_scope

223 self.parent_scope = parent_scope

224 mangled_name = "%d%s_" % (len(name), name)

225 qual_scope = self.qualifying_scope()

226 if qual_scope:

227 self.qualified_name = qual_scope.qualify_name(name)

228 self.scope_prefix = qual_scope.scope_prefix + mangled_name

229 else:

230 self.qualified_name = name

231 self.scope_prefix = mangled_name

232 self.entries = {}

233 self.const_entries = []

234 self.type_entries = []

235 self.sue_entries = []

236 self.arg_entries = []

237 self.var_entries = []

238 self.pyfunc_entries = []

239 self.cfunc_entries = []

240 self.c_class_entries = []

241 self.defined_c_classes = []

242 self.imported_c_classes = {}

243 self.cname_to_entry = {}

244 self.string_to_entry = {}

245 self.identifier_to_entry = {}

246 self.num_to_entry = {}

247 self.obj_to_entry = {}

248 self.pystring_entries = []

249 self.buffer_entries = []

250 self.control_flow = ControlFlow.LinearControlFlow()

251 self.return_type = None

252

253 def start_branching(self, pos):

254 self.control_flow = self.control_flow.start_branch(pos)

255

256 def next_branch(self, pos):

257 self.control_flow = self.control_flow.next_branch(pos)

258

259 def finish_branching(self, pos):

260 self.control_flow = self.control_flow.finish_branch(pos)

261

262 def __str__(self):

263 return "<%s %s>" % (self.__class__.__name__, self.qualified_name)

264

265 def qualifying_scope(self):

266 return self.parent_scope

267

268 def mangle(self, prefix, name = None):

269 if name:

270 return "%s%s%s" % (prefix, self.scope_prefix, name)

271 else:

272 return self.parent_scope.mangle(prefix, self.name)

273

274 def mangle_internal(self, name):

275 # Mangle an internal name so as not to clash with any

276 # user-defined name in this scope.

277 prefix = "%s%s_" % (Naming.pyrex_prefix, name)

278 return self.mangle(prefix)

279 #return self.parent_scope.mangle(prefix, self.name)

280

281 def global_scope(self):

282 # Return the module-level scope containing this scope.

283 return self.outer_scope.global_scope()

284

285 def builtin_scope(self):

286 # Return the module-level scope containing this scope.

287 return self.outer_scope.builtin_scope()

288

289 def declare(self, name, cname, type, pos, visibility):

290 # Create new entry, and add to dictionary if

291 # name is not None. Reports a warning if already

292 # declared.

293 if not self.in_cinclude and cname and re.match("^_[_A-Z]+$", cname):

294 # See http://www.gnu.org/software/libc/manual/html_node/Reserved-Names.html#Reserved-Names

295 warning(pos, "'%s' is a reserved name in C." % cname, -1)

296 entries = self.entries

297 if name and name in entries:

298 if visibility == 'extern':

299 warning(pos, "'%s' redeclared " % name, 0)

300 elif visibility != 'ignore':

301 error(pos, "'%s' redeclared " % name)

302 entry = Entry(name, cname, type, pos = pos)

303 entry.in_cinclude = self.in_cinclude

304 if name:

305 entry.qualified_name = self.qualify_name(name)

306 entries[name] = entry

307 entry.scope = self

308 entry.visibility = visibility

309 return entry

310

311 def qualify_name(self, name):

312 return "%s.%s" % (self.qualified_name, name)

313

314 def declare_const(self, name, type, value, pos, cname = None, visibility = 'private'):

315 # Add an entry for a named constant.

316 if not cname:

317 if self.in_cinclude or visibility == 'public':

318 cname = name

319 else:

320 cname = self.mangle(Naming.enum_prefix, name)

321 entry = self.declare(name, cname, type, pos, visibility)

322 entry.is_const = 1

323 entry.value_node = value

324 return entry

325

326 def declare_type(self, name, type, pos,

327 cname = None, visibility = 'private', defining = 1):

328 # Add an entry for a type definition.

329 if not cname:

330 cname = name

331 entry = self.declare(name, cname, type, pos, visibility)

332 entry.is_type = 1

333 if defining:

334 self.type_entries.append(entry)

335 # here we would set as_variable to an object representing this type

336 return entry

337

338 def declare_typedef(self, name, base_type, pos, cname = None,

339 visibility = 'private'):

340 if not cname:

341 if self.in_cinclude or visibility == 'public':

342 cname = name

343 else:

344 cname = self.mangle(Naming.type_prefix, name)

345 try:

346 type = PyrexTypes.create_typedef_type(cname, base_type, (visibility == 'extern'))

347 except ValueError, e:

348 error(pos, e.message)

349 type = PyrexTypes.error_type

350 entry = self.declare_type(name, type, pos, cname, visibility)

351 type.qualified_name = entry.qualified_name

352 return entry

353

354 def declare_struct_or_union(self, name, kind, scope,

355 typedef_flag, pos, cname = None, visibility = 'private',

356 packed = False):

357 # Add an entry for a struct or union definition.

358 if not cname:

359 if self.in_cinclude or visibility == 'public':

360 cname = name

361 else:

362 cname = self.mangle(Naming.type_prefix, name)

363 entry = self.lookup_here(name)

364 if not entry:

365 type = PyrexTypes.CStructOrUnionType(

366 name, kind, scope, typedef_flag, cname, packed)

367 entry = self.declare_type(name, type, pos, cname,

368 visibility = visibility, defining = scope is not None)

369 self.sue_entries.append(entry)

370 type.entry = entry

371 else:

372 if not (entry.is_type and entry.type.is_struct_or_union

373 and entry.type.kind == kind):

374 warning(pos, "'%s' redeclared " % name, 0)

375 elif scope and entry.type.scope:

376 warning(pos, "'%s' already defined (ignoring second definition)" % name, 0)

377 else:

378 self.check_previous_typedef_flag(entry, typedef_flag, pos)

379 self.check_previous_visibility(entry, visibility, pos)

380 if scope:

381 entry.type.scope = scope

382 self.type_entries.append(entry)

383 if not scope and not entry.type.scope:

384 self.check_for_illegal_incomplete_ctypedef(typedef_flag, pos)

385 return entry

386

387 def check_previous_typedef_flag(self, entry, typedef_flag, pos):

388 if typedef_flag != entry.type.typedef_flag:

389 error(pos, "'%s' previously declared using '%s'" % (

390 entry.name, ("cdef", "ctypedef")[entry.type.typedef_flag]))

391

392 def check_previous_visibility(self, entry, visibility, pos):

393 if entry.visibility != visibility:

394 error(pos, "'%s' previously declared as '%s'" % (

395 entry.name, entry.visibility))

396

397 def declare_enum(self, name, pos, cname, typedef_flag,

398 visibility = 'private'):

399 if name:

400 if not cname:

401 if self.in_cinclude or visibility == 'public':

402 cname = name

403 else:

404 cname = self.mangle(Naming.type_prefix, name)

405 type = PyrexTypes.CEnumType(name, cname, typedef_flag)

406 else:

407 type = PyrexTypes.c_anon_enum_type

408 entry = self.declare_type(name, type, pos, cname = cname,

409 visibility = visibility)

410 entry.enum_values = []

411 self.sue_entries.append(entry)

412 return entry

413

414 def declare_var(self, name, type, pos,

415 cname = None, visibility = 'private', is_cdef = 0):

416 # Add an entry for a variable.

417 if not cname:

418 if visibility != 'private':

419 cname = name

420 else:

421 cname = self.mangle(Naming.var_prefix, name)

422 entry = self.declare(name, cname, type, pos, visibility)

423 entry.is_variable = 1

424 self.control_flow.set_state((), (name, 'initalized'), False)

425 return entry

426

427 def declare_builtin(self, name, pos):

428 return self.outer_scope.declare_builtin(name, pos)

429

430 def declare_pyfunction(self, name, pos):

431 # Add an entry for a Python function.

432 entry = self.lookup_here(name)

433 if entry and not entry.type.is_cfunction:

434 # This is legal Python, but for now will produce invalid C.

435 error(pos, "'%s' already declared" % name)

436 entry = self.declare_var(name, py_object_type, pos, visibility='extern')

437 entry.signature = pyfunction_signature

438 self.pyfunc_entries.append(entry)

439 return entry

440

441 def register_pyfunction(self, entry):

442 self.pyfunc_entries.append(entry)

443

444 def declare_cfunction(self, name, type, pos,

445 cname = None, visibility = 'private', defining = 0,

446 api = 0, in_pxd = 0, modifiers = ()):

447 # Add an entry for a C function.

448 entry = self.lookup_here(name)

449 if entry:

450 if visibility != 'private' and visibility != entry.visibility:

451 warning(pos, "Function '%s' previously declared as '%s'" % (name, entry.visibility), 1)

452 if not entry.type.same_as(type):

453 if visibility == 'extern' and entry.visibility == 'extern':

454 warning(pos, "Function signature does not match previous declaration", 1)

455 entry.type = type

456 else:

457 error(pos, "Function signature does not match previous declaration")

458 else:

459 if not cname:

460 if api or visibility != 'private':

461 cname = name

462 else:

463 cname = self.mangle(Naming.func_prefix, name)

464 entry = self.add_cfunction(name, type, pos, cname, visibility, modifiers)

465 entry.func_cname = cname

466 if in_pxd and visibility != 'extern':

467 entry.defined_in_pxd = 1

468 if api:

469 entry.api = 1

470 if not defining and not in_pxd and visibility != 'extern':

471 error(pos, "Non-extern C function '%s' declared but not defined" % name)

472 if defining:

473 entry.is_implemented = True

474 if modifiers:

475 entry.func_modifiers = modifiers

476 return entry

477

478 def add_cfunction(self, name, type, pos, cname, visibility, modifiers):

479 # Add a C function entry without giving it a func_cname.

480 entry = self.declare(name, cname, type, pos, visibility)

481 entry.is_cfunction = 1

482 if modifiers:

483 entry.func_modifiers = modifiers

484 self.cfunc_entries.append(entry)

485 return entry

486

487 def find(self, name, pos):

488 # Look up name, report error if not found.

489 entry = self.lookup(name)

490 if entry:

491 return entry

492 else:

493 error(pos, "'%s' is not declared" % name)

494

495 def find_imported_module(self, path, pos):

496 # Look up qualified name, must be a module, report error if not found.

497 # Path is a list of names.

498 scope = self

499 for name in path:

500 entry = scope.find(name, pos)

501 if not entry:

502 return None

503 if entry.as_module:

504 scope = entry.as_module

505 else:

506 error(pos, "'%s' is not a cimported module" % '.'.join(path))

507 return None

508 return scope

509

510 def lookup(self, name):

511 # Look up name in this scope or an enclosing one.

512 # Return None if not found.

513 return (self.lookup_here(name)

514 or (self.outer_scope and self.outer_scope.lookup_from_inner(name))

515 or None)

516

517 def lookup_from_inner(self, name):

518 # Look up name in this scope or an enclosing one.

519 # This is only called from enclosing scopes.

520 return (self.lookup_here(name)

521 or (self.outer_scope and self.outer_scope.lookup_from_inner(name))

522 or None)

523

524 def lookup_here(self, name):

525 # Look up in this scope only, return None if not found.

526 return self.entries.get(name, None)

527

528 def lookup_target(self, name):

529 # Look up name in this scope only. Declare as Python

530 # variable if not found.

531 entry = self.lookup_here(name)

532 if not entry:

533 entry = self.declare_var(name, py_object_type, None)

534 return entry

535

536 def lookup_type(self, name):

537 entry = self.lookup(name)

538 if entry and entry.is_type:

539 return entry.type

540

541 def use_utility_code(self, new_code):

542 self.global_scope().use_utility_code(new_code)

543

544 def generate_library_function_declarations(self, code):

545 # Generate extern decls for C library funcs used.

546 pass

547

548 def defines_any(self, names):

549 # Test whether any of the given names are

550 # defined in this scope.

551 for name in names:

552 if name in self.entries:

553 return 1

554 return 0

555

556 def infer_types(self):

557 from TypeInference import get_type_inferer

558 get_type_inferer().infer_types(self)

559

560 class PreImportScope(Scope):

561

562 namespace_cname = Naming.preimport_cname

563

564 def __init__(self):

565 Scope.__init__(self, Options.pre_import, None, None)

566

567 def declare_builtin(self, name, pos):

568 entry = self.declare(name, name, py_object_type, pos, 'private')

569 entry.is_variable = True

570 entry.is_pyglobal = True

571 return entry

572

573

574 class BuiltinScope(Scope):

575 # The builtin namespace.

576

577 def __init__(self):

578 if Options.pre_import is None:

579 Scope.__init__(self, "__builtin__", None, None)

580 else:

581 Scope.__init__(self, "__builtin__", PreImportScope(), None)

582 self.type_names = {}

583

584 for name, definition in self.builtin_entries.iteritems():

585 cname, type = definition

586 self.declare_var(name, type, None, cname)

587

588 def declare_builtin(self, name, pos):

589 if not hasattr(builtins, name):

590 if self.outer_scope is not None:

591 return self.outer_scope.declare_builtin(name, pos)

592 else:

593 error(pos, "undeclared name not builtin: %s"%name)

594

595 def declare_builtin_cfunction(self, name, type, cname, python_equiv = None,

596 utility_code = None):

597 # If python_equiv == "*", the Python equivalent has the same name

598 # as the entry, otherwise it has the name specified by python_equiv.

599 name = EncodedString(name)

600 entry = self.declare_cfunction(name, type, None, cname, visibility='extern')

601 entry.utility_code = utility_code

602 if python_equiv:

603 if python_equiv == "*":

604 python_equiv = name

605 else:

606 python_equiv = EncodedString(python_equiv)

607 var_entry = Entry(python_equiv, python_equiv, py_object_type)

608 var_entry.is_variable = 1

609 var_entry.is_builtin = 1

610 entry.as_variable = var_entry

611 return entry

612

613 def declare_builtin_type(self, name, cname, utility_code = None):

614 name = EncodedString(name)

615 type = PyrexTypes.BuiltinObjectType(name, cname)

616 type.set_scope(CClassScope(name, outer_scope=None, visibility='extern'))

617 self.type_names[name] = 1

618 entry = self.declare_type(name, type, None, visibility='extern')

619

620 var_entry = Entry(name = entry.name,

621 type = self.lookup('type').type, # make sure "type" is the first type declared...

622 pos = entry.pos,

623 cname = "((PyObject*)%s)" % entry.type.typeptr_cname)

624 var_entry.is_variable = 1

625 var_entry.is_cglobal = 1

626 var_entry.is_readonly = 1

627 var_entry.utility_code = utility_code

628 entry.as_variable = var_entry

629

630 return type

631

632 def builtin_scope(self):

633 return self

634

635 builtin_entries = {

636

637 "type": ["((PyObject*)&PyType_Type)", py_object_type],

638

639 "bool": ["((PyObject*)&PyBool_Type)", py_object_type],

640 "int": ["((PyObject*)&PyInt_Type)", py_object_type],

641 "long": ["((PyObject*)&PyLong_Type)", py_object_type],

642 "float": ["((PyObject*)&PyFloat_Type)", py_object_type],

643 "complex":["((PyObject*)&PyComplex_Type)", py_object_type],

644

645 "bytes": ["((PyObject*)&PyBytes_Type)", py_object_type],

646 "str": ["((PyObject*)&PyString_Type)", py_object_type],

647 "unicode":["((PyObject*)&PyUnicode_Type)", py_object_type],

648

649 "tuple": ["((PyObject*)&PyTuple_Type)", py_object_type],

650 "list": ["((PyObject*)&PyList_Type)", py_object_type],

651 "dict": ["((PyObject*)&PyDict_Type)", py_object_type],

652 "set": ["((PyObject*)&PySet_Type)", py_object_type],

653 "frozenset": ["((PyObject*)&PyFrozenSet_Type)", py_object_type],

654

655 "slice": ["((PyObject*)&PySlice_Type)", py_object_type],

656 "file": ["((PyObject*)&PyFile_Type)", py_object_type],

657

658 "None": ["Py_None", py_object_type],

659 "False": ["Py_False", py_object_type],

660 "True": ["Py_True", py_object_type],

661 }

662

663 const_counter = 1 # As a temporary solution for compiling code in pxds

664

665 class ModuleScope(Scope):

666 # module_name string Python name of the module

667 # module_cname string C name of Python module object

668 # #module_dict_cname string C name of module dict object

669 # method_table_cname string C name of method table

670 # doc string Module doc string

671 # doc_cname string C name of module doc string

672 # utility_code_list [UtilityCode] Queuing utility codes for forwarding to Code.py

673 # python_include_files [string] Standard Python headers to be included

674 # include_files [string] Other C headers to be included

675 # string_to_entry {string : Entry} Map string const to entry

676 # identifier_to_entry {string : Entry} Map identifier string const to entry

677 # context Context

678 # parent_module Scope Parent in the import namespace

679 # module_entries {string : Entry} For cimport statements

680 # type_names {string : 1} Set of type names (used during parsing)

681 # included_files [string] Cython sources included with 'include'

682 # pxd_file_loaded boolean Corresponding .pxd file has been processed

683 # cimported_modules [ModuleScope] Modules imported with cimport

684 # types_imported {PyrexType : 1} Set of types for which import code generated

685 # has_import_star boolean Module contains import *

686

687 is_module_scope = 1

688 has_import_star = 0

689

690 def __init__(self, name, parent_module, context):

691 self.parent_module = parent_module

692 outer_scope = context.find_submodule("__builtin__")

693 Scope.__init__(self, name, outer_scope, parent_module)

694 if name != "__init__":

695 self.module_name = name

696 else:

697 # Treat Spam/__init__.pyx specially, so that when Python loads

698 # Spam/__init__.so, initSpam() is defined.

699 self.module_name = parent_module.module_name

700 self.context = context

701 self.module_cname = Naming.module_cname

702 self.module_dict_cname = Naming.moddict_cname

703 self.method_table_cname = Naming.methtable_cname

704 self.doc = ""

705 self.doc_cname = Naming.moddoc_cname

706 self.utility_code_list = []

707 self.module_entries = {}

708 self.python_include_files = ["Python.h", "structmember.h"]

709 self.include_files = []

710 self.type_names = dict(outer_scope.type_names)

711 self.pxd_file_loaded = 0

712 self.cimported_modules = []

713 self.types_imported = {}

714 self.included_files = []

715 self.has_extern_class = 0

716 self.cached_builtins = []

717 self.undeclared_cached_builtins = []

718 self.namespace_cname = self.module_cname

719 for name in ['__builtins__', '__name__', '__file__', '__doc__']:

720 self.declare_var(EncodedString(name), py_object_type, None)

721

722 def qualifying_scope(self):

723 return self.parent_module

724

725 def global_scope(self):

726 return self

727

728 def declare_builtin(self, name, pos):

729 if not hasattr(builtins, name):

730 if self.has_import_star:

731 entry = self.declare_var(name, py_object_type, pos)

732 return entry

733 elif self.outer_scope is not None:

734 return self.outer_scope.declare_builtin(name, pos)

735 else:

736 error(pos, "undeclared name not builtin: %s"%name)

737 if Options.cache_builtins:

738 for entry in self.cached_builtins:

739 if entry.name == name:

740 return entry

741 entry = self.declare(None, None, py_object_type, pos, 'private')

742 if Options.cache_builtins:

743 entry.is_builtin = 1

744 entry.is_const = 1

745 entry.name = name

746 entry.cname = Naming.builtin_prefix + name

747 self.cached_builtins.append(entry)

748 self.undeclared_cached_builtins.append(entry)

749 else:

750 entry.is_builtin = 1

751 return entry

752

753 def find_module(self, module_name, pos):

754 # Find a module in the import namespace, interpreting

755 # relative imports relative to this module's parent.

756 # Finds and parses the module's .pxd file if the module

757 # has not been referenced before.

758 return self.global_scope().context.find_module(

759 module_name, relative_to = self.parent_module, pos = pos)

760

761 def find_submodule(self, name):

762 # Find and return scope for a submodule of this module,

763 # creating a new empty one if necessary. Doesn't parse .pxd.

764 scope = self.lookup_submodule(name)

765 if not scope:

766 scope = ModuleScope(name,

767 parent_module = self, context = self.context)

768 self.module_entries[name] = scope

769 return scope

770

771 def lookup_submodule(self, name):

772 # Return scope for submodule of this module, or None.

773 return self.module_entries.get(name, None)

774

775 def add_include_file(self, filename):

776 if filename not in self.python_include_files \

777 and filename not in self.include_files:

778 self.include_files.append(filename)

779

780 def add_imported_module(self, scope):

781 if scope not in self.cimported_modules:

782 for filename in scope.include_files:

783 self.add_include_file(filename)

784 self.cimported_modules.append(scope)

785 for m in scope.cimported_modules:

786 self.add_imported_module(m)

787

788 def add_imported_entry(self, name, entry, pos):

789 if entry not in self.entries:

790 self.entries[name] = entry

791 else:

792 warning(pos, "'%s' redeclared " % name, 0)

793

794 def declare_module(self, name, scope, pos):

795 # Declare a cimported module. This is represented as a

796 # Python module-level variable entry with a module

797 # scope attached to it. Reports an error and returns

798 # None if previously declared as something else.

799 entry = self.lookup_here(name)

800 if entry:

801 if entry.is_pyglobal and entry.as_module is scope:

802 return entry # Already declared as the same module

803 if not (entry.is_pyglobal and not entry.as_module):

804 # SAGE -- I put this here so Pyrex

805 # cimport's work across directories.

806 # Currently it tries to multiply define

807 # every module appearing in an import list.

808 # It shouldn't be an error for a module

809 # name to appear again, and indeed the generated

810 # code compiles fine.

811 return entry

812 warning(pos, "'%s' redeclared " % name, 0)

813 return None

814 else:

815 entry = self.declare_var(name, py_object_type, pos)

816 entry.as_module = scope

817 self.add_imported_module(scope)

818 return entry

819

820 def declare_var(self, name, type, pos,

821 cname = None, visibility = 'private', is_cdef = 0):

822 # Add an entry for a global variable. If it is a Python

823 # object type, and not declared with cdef, it will live

824 # in the module dictionary, otherwise it will be a C

825 # global variable.

826 entry = Scope.declare_var(self, name, type, pos,

827 cname, visibility, is_cdef)

828 if not visibility in ('private', 'public', 'extern'):

829 error(pos, "Module-level variable cannot be declared %s" % visibility)

830 if not is_cdef:

831 if type is unspecified_type:

832 type = py_object_type

833 if not (type.is_pyobject and not type.is_extension_type):

834 raise InternalError(

835 "Non-cdef global variable is not a generic Python object")

836 entry.is_pyglobal = 1

837 else:

838 entry.is_cglobal = 1

839 if entry.type.is_pyobject:

840 entry.init = 0

841 self.var_entries.append(entry)

842 return entry

843

844 def declare_global(self, name, pos):

845 entry = self.lookup_here(name)

846 if not entry:

847 self.declare_var(name, py_object_type, pos)

848

849 def use_utility_code(self, new_code):

850 if new_code is not None:

851 self.utility_code_list.append(new_code)

852

853 def declare_c_class(self, name, pos, defining = 0, implementing = 0,

854 module_name = None, base_type = None, objstruct_cname = None,

855 typeobj_cname = None, visibility = 'private', typedef_flag = 0, api = 0,

856 buffer_defaults = None):

857 # If this is a non-extern typedef class, expose the typedef, but use

858 # the non-typedef struct internally to avoid needing forward

859 # declarations for anonymous structs.

860 if typedef_flag and visibility != 'extern':

861 if visibility != 'public':

862 warning(pos, "ctypedef only valid for public and extern classes", 2)

863 objtypedef_cname = objstruct_cname

864 objstruct_cname = None

865 typedef_flag = 0

866 else:

867 objtypedef_cname = None

868 #

869 # Look for previous declaration as a type

870 #

871 entry = self.lookup_here(name)

872 if entry:

873 type = entry.type

874 if not (entry.is_type and type.is_extension_type):

875 entry = None # Will cause redeclaration and produce an error

876 else:

877 scope = type.scope

878 if typedef_flag and (not scope or scope.defined):

879 self.check_previous_typedef_flag(entry, typedef_flag, pos)

880 if (scope and scope.defined) or (base_type and type.base_type):

881 if base_type and base_type is not type.base_type:

882 error(pos, "Base type does not match previous declaration")

883 if base_type and not type.base_type:

884 type.base_type = base_type

885 #

886 # Make a new entry if needed

887 #

888 if not entry:

889 type = PyrexTypes.PyExtensionType(name, typedef_flag, base_type)

890 type.pos = pos

891 type.buffer_defaults = buffer_defaults

892 if objtypedef_cname is not None:

893 type.objtypedef_cname = objtypedef_cname

894 if visibility == 'extern':

895 type.module_name = module_name

896 else:

897 type.module_name = self.qualified_name

898 type.typeptr_cname = self.mangle(Naming.typeptr_prefix, name)

899 entry = self.declare_type(name, type, pos, visibility = visibility,

900 defining = 0)

901 entry.is_cclass = True

902 if objstruct_cname:

903 type.objstruct_cname = objstruct_cname

904 elif not entry.in_cinclude:

905 type.objstruct_cname = self.mangle(Naming.objstruct_prefix, name)

906 else:

907 error(entry.pos,

908 "Object name required for 'public' or 'extern' C class")

909 self.attach_var_entry_to_c_class(entry)

910 self.c_class_entries.append(entry)

911 #

912 # Check for re-definition and create scope if needed

913 #

914 if not type.scope:

915 if defining or implementing:

916 scope = CClassScope(name = name, outer_scope = self,

917 visibility = visibility)

918 if base_type and base_type.scope:

919 scope.declare_inherited_c_attributes(base_type.scope)

920 type.set_scope(scope)

921 self.type_entries.append(entry)

922 else:

923 self.check_for_illegal_incomplete_ctypedef(typedef_flag, pos)

924 else:

925 if defining and type.scope.defined:

926 error(pos, "C class '%s' already defined" % name)

927 elif implementing and type.scope.implemented:

928 error(pos, "C class '%s' already implemented" % name)

929 #

930 # Fill in options, checking for compatibility with any previous declaration

931 #

932 if defining:

933 entry.defined_in_pxd = 1

934 if implementing: # So that filenames in runtime exceptions refer to

935 entry.pos = pos # the .pyx file and not the .pxd file

936 if visibility != 'private' and entry.visibility != visibility:

937 error(pos, "Class '%s' previously declared as '%s'"

938 % (name, entry.visibility))

939 if api:

940 entry.api = 1

941 if objstruct_cname:

942 if type.objstruct_cname and type.objstruct_cname != objstruct_cname:

943 error(pos, "Object struct name differs from previous declaration")

944 type.objstruct_cname = objstruct_cname

945 if typeobj_cname:

946 if type.typeobj_cname and type.typeobj_cname != typeobj_cname:

947 error(pos, "Type object name differs from previous declaration")

948 type.typeobj_cname = typeobj_cname

949 #

950 # Return new or existing entry

951 #

952 return entry

953

954 def check_for_illegal_incomplete_ctypedef(self, typedef_flag, pos):

955 if typedef_flag and not self.in_cinclude:

956 error(pos, "Forward-referenced type must use 'cdef', not 'ctypedef'")

957

958 def allocate_vtable_names(self, entry):

959 # If extension type has a vtable, allocate vtable struct and

960 # slot names for it.

961 type = entry.type

962 if type.base_type and type.base_type.vtabslot_cname:

963 #print "...allocating vtabslot_cname because base type has one" ###

964 type.vtabslot_cname = "%s.%s" % (

965 Naming.obj_base_cname, type.base_type.vtabslot_cname)

966 elif type.scope and type.scope.cfunc_entries:

967 #print "...allocating vtabslot_cname because there are C methods" ###

968 type.vtabslot_cname = Naming.vtabslot_cname

969 if type.vtabslot_cname:

970 #print "...allocating other vtable related cnames" ###

971 type.vtabstruct_cname = self.mangle(Naming.vtabstruct_prefix, entry.name)

972 type.vtabptr_cname = self.mangle(Naming.vtabptr_prefix, entry.name)

973

974 def check_c_classes_pxd(self):

975 # Performs post-analysis checking and finishing up of extension types

976 # being implemented in this module. This is called only for the .pxd.

977 #

978 # Checks all extension types declared in this scope to

979 # make sure that:

980 #

981 # * The extension type is fully declared

982 #

983 # Also allocates a name for the vtable if needed.

984 #

985 for entry in self.c_class_entries:

986 # Check defined

987 if not entry.type.scope:

988 error(entry.pos, "C class '%s' is declared but not defined" % entry.name)

989

990 def check_c_classes(self):

991 # Performs post-analysis checking and finishing up of extension types

992 # being implemented in this module. This is called only for the main

993 # .pyx file scope, not for cimported .pxd scopes.

994 #

995 # Checks all extension types declared in this scope to

996 # make sure that:

997 #

998 # * The extension type is implemented

999 # * All required object and type names have been specified or generated

1000 # * All non-inherited C methods are implemented

1001 #

1002 # Also allocates a name for the vtable if needed.

1003 #

1004 debug_check_c_classes = 0

1005 if debug_check_c_classes:

1006 print("Scope.check_c_classes: checking scope " + self.qualified_name)

1007 for entry in self.c_class_entries:

1008 if debug_check_c_classes:

1009 print("...entry %s %s" % (entry.name, entry))

1010 print("......type = ", entry.type)

1011 print("......visibility = ", entry.visibility)

1012 type = entry.type

1013 name = entry.name

1014 visibility = entry.visibility

1015 # Check defined

1016 if not type.scope:

1017 error(entry.pos, "C class '%s' is declared but not defined" % name)

1018 # Generate typeobj_cname

1019 if visibility != 'extern' and not type.typeobj_cname:

1020 type.typeobj_cname = self.mangle(Naming.typeobj_prefix, name)

1021 ## Generate typeptr_cname

1022 #type.typeptr_cname = self.mangle(Naming.typeptr_prefix, name)

1023 # Check C methods defined

1024 if type.scope:

1025 for method_entry in type.scope.cfunc_entries:

1026 if not method_entry.is_inherited and not method_entry.func_cname:

1027 error(method_entry.pos, "C method '%s' is declared but not defined" %

1028 method_entry.name)

1029 # Allocate vtable name if necessary

1030 if type.vtabslot_cname:

1031 #print "ModuleScope.check_c_classes: allocating vtable cname for", self ###

1032 type.vtable_cname = self.mangle(Naming.vtable_prefix, entry.name)

1033

1034 def check_c_functions(self):

1035 # Performs post-analysis checking making sure all

1036 # defined c functions are actually implemented.

1037 for name, entry in self.entries.items():

1038 if entry.is_cfunction:

1039 if (entry.defined_in_pxd

1040 and entry.scope is self

1041 and entry.visibility != 'extern'

1042 and not entry.in_cinclude

1043 and not entry.is_implemented):

1044 error(entry.pos, "Non-extern C function '%s' declared but not defined" % name)

1045

1046 def attach_var_entry_to_c_class(self, entry):

1047 # The name of an extension class has to serve as both a type

1048 # name and a variable name holding the type object. It is

1049 # represented in the symbol table by a type entry with a

1050 # variable entry attached to it. For the variable entry,

1051 # we use a read-only C global variable whose name is an

1052 # expression that refers to the type object.

1053 import Builtin

1054 var_entry = Entry(name = entry.name,

1055 type = Builtin.type_type,

1056 pos = entry.pos,

1057 cname = "((PyObject*)%s)" % entry.type.typeptr_cname)

1058 var_entry.is_variable = 1

1059 var_entry.is_cglobal = 1

1060 var_entry.is_readonly = 1

1061 entry.as_variable = var_entry

1062

1063 def infer_types(self):

1064 from TypeInference import PyObjectTypeInferer

1065 PyObjectTypeInferer().infer_types(self)

1066

1067 class LocalScope(Scope):

1068

1069 def __init__(self, name, outer_scope, parent_scope = None):

1070 if parent_scope is None:

1071 parent_scope = outer_scope

1072 Scope.__init__(self, name, outer_scope, parent_scope)

1073

1074 def mangle(self, prefix, name):

1075 return prefix + name

1076

1077 def declare_arg(self, name, type, pos):

1078 # Add an entry for an argument of a function.

1079 cname = self.mangle(Naming.var_prefix, name)

1080 entry = self.declare(name, cname, type, pos, 'private')

1081 entry.is_variable = 1

1082 if type.is_pyobject:

1083 entry.init = "0"

1084 entry.is_arg = 1

1085 #entry.borrowed = 1 # Not using borrowed arg refs for now

1086 self.arg_entries.append(entry)

1087 self.control_flow.set_state((), (name, 'source'), 'arg')

1088 return entry

1089

1090 def declare_var(self, name, type, pos,

1091 cname = None, visibility = 'private', is_cdef = 0):

1092 # Add an entry for a local variable.

1093 if visibility in ('public', 'readonly'):

1094 error(pos, "Local variable cannot be declared %s" % visibility)

1095 entry = Scope.declare_var(self, name, type, pos,

1096 cname, visibility, is_cdef)

1097 if type.is_pyobject and not Options.init_local_none:

1098 entry.init = "0"

1099 entry.init_to_none = (type.is_pyobject or type.is_unspecified) and Options.init_local_none

1100 entry.is_local = 1

1101 self.var_entries.append(entry)

1102 return entry

1103

1104 def declare_global(self, name, pos):

1105 # Pull entry from global scope into local scope.

1106 if self.lookup_here(name):

1107 warning(pos, "'%s' redeclared ", 0)

1108 else:

1109 entry = self.global_scope().lookup_target(name)

1110 self.entries[name] = entry

1111

1112 def lookup_from_inner(self, name):

1113 entry = self.lookup_here(name)

1114 if entry:

1115 entry.in_closure = 1

1116 return entry

1117 else:

1118 return (self.outer_scope and self.outer_scope.lookup_from_inner(name)) or None

1119

1120 def mangle_closure_cnames(self, scope_var):

1121 for entry in self.entries.values():

1122 if entry.in_closure:

1123 if not hasattr(entry, 'orig_cname'):

1124 entry.orig_cname = entry.cname

1125 entry.cname = scope_var + "->" + entry.cname

1126

1127

1128 class GeneratorLocalScope(LocalScope):

1129

1130 def mangle_closure_cnames(self, scope_var):

1131 # for entry in self.entries.values() + self.temp_entries:

1132 # entry.in_closure = 1

1133 LocalScope.mangle_closure_cnames(self, scope_var)

1134

1135 # def mangle(self, prefix, name):

1136 # return "%s->%s" % (Naming.scope_obj_cname, name)

1137

1138 class StructOrUnionScope(Scope):

1139 # Namespace of a C struct or union.

1140

1141 def __init__(self, name="?"):

1142 Scope.__init__(self, name, None, None)

1143

1144 def declare_var(self, name, type, pos,

1145 cname = None, visibility = 'private', is_cdef = 0, allow_pyobject = 0):

1146 # Add an entry for an attribute.

1147 if not cname:

1148 cname = name

1149 if visibility == 'private':

1150 cname = c_safe_identifier(cname)

1151 if type.is_cfunction:

1152 type = PyrexTypes.CPtrType(type)

1153 entry = self.declare(name, cname, type, pos, visibility)

1154 entry.is_variable = 1

1155 self.var_entries.append(entry)

1156 if type.is_pyobject and not allow_pyobject:

1157 error(pos,

1158 "C struct/union member cannot be a Python object")

1159 if visibility != 'private':

1160 error(pos,

1161 "C struct/union member cannot be declared %s" % visibility)

1162 return entry

1163

1164 def declare_cfunction(self, name, type, pos,

1165 cname = None, visibility = 'private', defining = 0,

1166 api = 0, in_pxd = 0, modifiers = ()):

1167 return self.declare_var(name, type, pos, cname, visibility)

1168

1169 class ClassScope(Scope):

1170 # Abstract base class for namespace of

1171 # Python class or extension type.

1172 #

1173 # class_name string Pyrex name of the class

1174 # scope_prefix string Additional prefix for names

1175 # declared in the class

1176 # doc string or None Doc string

1177

1178 def __init__(self, name, outer_scope):

1179 Scope.__init__(self, name, outer_scope, outer_scope)

1180 self.class_name = name

1181 self.doc = None

1182

1183 def add_string_const(self, value, identifier = False):

1184 return self.outer_scope.add_string_const(value, identifier)

1185

1186 def lookup(self, name):

1187 if name == "classmethod":

1188 # We don't want to use the builtin classmethod here 'cause it won't do the

1189 # right thing in this scope (as the class memebers aren't still functions).

1190 # Don't want to add a cfunction to this scope 'cause that would mess with

1191 # the type definition, so we just return the right entry.

1192 self.use_utility_code(classmethod_utility_code)

1193 entry = Entry(

1194 "classmethod",

1195 "__Pyx_Method_ClassMethod",

1196 PyrexTypes.CFuncType(

1197 py_object_type,

1198 [PyrexTypes.CFuncTypeArg("", py_object_type, None)], 0, 0))

1199 entry.is_cfunction = 1

1200 return entry

1201 else:

1202 return Scope.lookup(self, name)

1203

1204

1205 class PyClassScope(ClassScope):

1206 # Namespace of a Python class.

1207 #

1208 # class_obj_cname string C variable holding class object

1209

1210 is_py_class_scope = 1

1211

1212 def declare_var(self, name, type, pos,

1213 cname = None, visibility = 'private', is_cdef = 0):

1214 if type is unspecified_type:

1215 type = py_object_type

1216 # Add an entry for a class attribute.

1217 entry = Scope.declare_var(self, name, type, pos,

1218 cname, visibility, is_cdef)

1219 entry.is_pyglobal = 1

1220 return entry

1221

1222 def add_default_value(self, type):

1223 return self.outer_scope.add_default_value(type)

1224

1225

1226 class CClassScope(ClassScope):

1227 # Namespace of an extension type.

1228 #

1229 # parent_type CClassType

1230 # #typeobj_cname string or None

1231 # #objstruct_cname string

1232 # method_table_cname string

1233 # member_table_cname string

1234 # getset_table_cname string

1235 # has_pyobject_attrs boolean Any PyObject attributes?

1236 # public_attr_entries boolean public/readonly attrs

1237 # property_entries [Entry]

1238 # defined boolean Defined in .pxd file

1239 # implemented boolean Defined in .pyx file

1240 # inherited_var_entries [Entry] Adapted var entries from base class

1241

1242 is_c_class_scope = 1

1243

1244 def __init__(self, name, outer_scope, visibility):

1245 ClassScope.__init__(self, name, outer_scope)

1246 if visibility != 'extern':

1247 self.method_table_cname = outer_scope.mangle(Naming.methtab_prefix, name)

1248 self.member_table_cname = outer_scope.mangle(Naming.memtab_prefix, name)

1249 self.getset_table_cname = outer_scope.mangle(Naming.gstab_prefix, name)

1250 self.has_pyobject_attrs = 0

1251 self.public_attr_entries = []

1252 self.property_entries = []

1253 self.inherited_var_entries = []

1254 self.defined = 0

1255 self.implemented = 0

1256

1257 def needs_gc(self):

1258 # If the type or any of its base types have Python-valued

1259 # C attributes, then it needs to participate in GC.

1260 return self.has_pyobject_attrs or \

1261 (self.parent_type.base_type and

1262 self.parent_type.base_type.scope is not None and

1263 self.parent_type.base_type.scope.needs_gc())

1264

1265 def declare_var(self, name, type, pos,

1266 cname = None, visibility = 'private', is_cdef = 0):

1267 if is_cdef:

1268 # Add an entry for an attribute.

1269 if self.defined:

1270 error(pos,

1271 "C attributes cannot be added in implementation part of"

1272 " extension type defined in a pxd")

1273 if get_special_method_signature(name):

1274 error(pos,

1275 "The name '%s' is reserved for a special method."

1276 % name)

1277 if not cname:

1278 cname = name

1279 if visibility == 'private':

1280 cname = c_safe_identifier(cname)

1281 entry = self.declare(name, cname, type, pos, visibility)

1282 entry.is_variable = 1

1283 self.var_entries.append(entry)

1284 if type.is_pyobject:

1285 self.has_pyobject_attrs = 1

1286 if visibility not in ('private', 'public', 'readonly'):

1287 error(pos,

1288 "Attribute of extension type cannot be declared %s" % visibility)

1289 if visibility in ('public', 'readonly'):

1290 if type.pymemberdef_typecode:

1291 self.public_attr_entries.append(entry)

1292 if name == "__weakref__":

1293 error(pos, "Special attribute __weakref__ cannot be exposed to Python")

1294 else:

1295 error(pos,

1296 "C attribute of type '%s' cannot be accessed from Python" % type)

1297 if visibility == 'public' and type.is_extension_type:

1298 error(pos,

1299 "Non-generic Python attribute cannot be exposed for writing from Python")

1300 return entry

1301 else:

1302 if type is unspecified_type:

1303 type = py_object_type

1304 # Add an entry for a class attribute.

1305 entry = Scope.declare_var(self, name, type, pos,

1306 cname, visibility, is_cdef)

1307 entry.is_member = 1

1308 entry.is_pyglobal = 1 # xxx: is_pyglobal changes behaviour in so many places that

1309 # I keep it in for now. is_member should be enough

1310 # later on

1311 self.namespace_cname = "(PyObject *)%s" % self.parent_type.typeptr_cname

1312 return entry

1313

1314

1315 def declare_pyfunction(self, name, pos):

1316 # Add an entry for a method.

1317 if name in ('__eq__', '__ne__', '__lt__', '__gt__', '__le__', '__ge__'):

1318 error(pos, "Special method %s must be implemented via __richcmp__" % name)

1319 if name == "__new__":

1320 warning(pos, "__new__ method of extension type will change semantics "

1321 "in a future version of Pyrex and Cython. Use __cinit__ instead.")

1322 name = EncodedString("__cinit__")

1323 entry = self.declare_var(name, py_object_type, pos, visibility='extern')

1324 special_sig = get_special_method_signature(name)

1325 if special_sig:

1326 # Special methods get put in the method table with a particular

1327 # signature declared in advance.

1328 entry.signature = special_sig

1329 entry.is_special = 1

1330 else:

1331 entry.signature = pymethod_signature

1332 entry.is_special = 0

1333

1334 self.pyfunc_entries.append(entry)

1335 return entry

1336

1337 def lookup_here(self, name):

1338 if name == "__new__":

1339 name = EncodedString("__cinit__")

1340 return ClassScope.lookup_here(self, name)

1341

1342 def declare_cfunction(self, name, type, pos,

1343 cname = None, visibility = 'private',

1344 defining = 0, api = 0, in_pxd = 0, modifiers = ()):

1345 if get_special_method_signature(name):

1346 error(pos, "Special methods must be declared with 'def', not 'cdef'")

1347 args = type.args

1348 if not args:

1349 error(pos, "C method has no self argument")

1350 elif not args[0].type.same_as(self.parent_type):

1351 error(pos, "Self argument (%s) of C method '%s' does not match parent type (%s)" %

1352 (args[0].type, name, self.parent_type))

1353 entry = self.lookup_here(name)

1354 if entry:

1355 if not entry.is_cfunction:

1356 warning(pos, "'%s' redeclared " % name, 0)

1357 else:

1358 if defining and entry.func_cname:

1359 error(pos, "'%s' already defined" % name)

1360 #print "CClassScope.declare_cfunction: checking signature" ###

1361 if type.same_c_signature_as(entry.type, as_cmethod = 1) and type.nogil == entry.type.nogil:

1362 pass

1363 elif type.compatible_signature_with(entry.type, as_cmethod = 1) and type.nogil == entry.type.nogil:

1364 entry = self.add_cfunction(name, type, pos, cname or name, visibility='ignore', modifiers=modifiers)

1365 defining = 1

1366 else:

1367 error(pos, "Signature not compatible with previous declaration")

1368 error(entry.pos, "Previous declaration is here")

1369 else:

1370 if self.defined:

1371 error(pos,

1372 "C method '%s' not previously declared in definition part of"

1373 " extension type" % name)

1374 entry = self.add_cfunction(name, type, pos, cname or name,

1375 visibility, modifiers)

1376 if defining:

1377 entry.func_cname = self.mangle(Naming.func_prefix, name)

1378 return entry

1379

1380 def add_cfunction(self, name, type, pos, cname, visibility, modifiers):

1381 # Add a cfunction entry without giving it a func_cname.

1382 prev_entry = self.lookup_here(name)

1383 entry = ClassScope.add_cfunction(self, name, type, pos, cname,

1384 visibility, modifiers)

1385 entry.is_cmethod = 1

1386 entry.prev_entry = prev_entry

1387 return entry

1388

1389 def declare_property(self, name, doc, pos):

1390 entry = self.lookup_here(name)

1391 if entry is None:

1392 entry = self.declare(name, name, py_object_type, pos, 'private')

1393 entry.is_property = 1

1394 entry.doc = doc

1395 entry.scope = PropertyScope(name,

1396 outer_scope = self.global_scope(), parent_scope = self)

1397 entry.scope.parent_type = self.parent_type

1398 self.property_entries.append(entry)

1399 return entry

1400

1401 def declare_inherited_c_attributes(self, base_scope):

1402 # Declare entries for all the C attributes of an

1403 # inherited type, with cnames modified appropriately

1404 # to work with this type.

1405 def adapt(cname):

1406 return "%s.%s" % (Naming.obj_base_cname, base_entry.cname)

1407 for base_entry in \

1408 base_scope.inherited_var_entries + base_scope.var_entries:

1409 entry = self.declare(base_entry.name, adapt(base_entry.cname),

1410 base_entry.type, None, 'private')

1411 entry.is_variable = 1

1412 self.inherited_var_entries.append(entry)

1413 for base_entry in base_scope.cfunc_entries:

1414 entry = self.add_cfunction(base_entry.name, base_entry.type,

1415 base_entry.pos, adapt(base_entry.cname),

1416 base_entry.visibility, base_entry.func_modifiers)

1417 entry.is_inherited = 1

1418

1419

1420 class PropertyScope(Scope):

1421 # Scope holding the __get__, __set__ and __del__ methods for

1422 # a property of an extension type.

1423 #

1424 # parent_type PyExtensionType The type to which the property belongs

1425

1426 def declare_pyfunction(self, name, pos):

1427 # Add an entry for a method.

1428 signature = get_property_accessor_signature(name)

1429 if signature:

1430 entry = self.declare(name, name, py_object_type, pos, 'private')

1431 entry.is_special = 1

1432 entry.signature = signature

1433 return entry

1434 else:

1435 error(pos, "Only __get__, __set__ and __del__ methods allowed "

1436 "in a property declaration")

1437 return None

1438

1439

1440 # Should this go elsewhere (and then get imported)?

1441 #------------------------------------------------------------------------------------

1442

1443 classmethod_utility_code = Code.UtilityCode(

1444 proto = """

1445 #include "descrobject.h"

1446 static PyObject* __Pyx_Method_ClassMethod(PyObject *method); /*proto*/

1447 """,

1448 impl = """

1449 static PyObject* __Pyx_Method_ClassMethod(PyObject *method) {

1450 /* It appears that PyMethodDescr_Type is not anywhere exposed in the Python/C API */

1451 static PyTypeObject *methoddescr_type = NULL;

1452 if (methoddescr_type == NULL) {

1453 PyObject *meth = __Pyx_GetAttrString((PyObject*)&PyList_Type, "append");

1454 if (!meth) return NULL;

1455 methoddescr_type = Py_TYPE(meth);

1456 Py_DECREF(meth);

1457 }

1458 if (PyObject_TypeCheck(method, methoddescr_type)) { /* cdef classes */

1459 PyMethodDescrObject *descr = (PyMethodDescrObject *)method;

1460 #if PY_VERSION_HEX < 0x03020000

1461 PyTypeObject *d_type = descr->d_type;

1462 #else

1463 PyTypeObject *d_type = descr->d_common.d_type;

1464 #endif

1465 return PyDescr_NewClassMethod(d_type, descr->d_method);

1466 }

1467 else if (PyMethod_Check(method)) { /* python classes */

1468 return PyClassMethod_New(PyMethod_GET_FUNCTION(method));

1469 }

1470 else if (PyCFunction_Check(method)) {

1471 return PyClassMethod_New(method);

1472 }

1473 PyErr_Format(PyExc_TypeError,

1474 "Class-level classmethod() can only be called on"

1475 "a method_descriptor or instance method.");

1476 return NULL;

1477 }

1478 """)