Nodes.py 163 KB
Newer Older
William Stein's avatar
William Stein committed
1 2 3 4
#
#   Pyrex - Parse tree nodes
#

5
import string, sys, os, time, copy
William Stein's avatar
William Stein committed
6 7

import Code
8
from Errors import error, warning, InternalError
William Stein's avatar
William Stein committed
9 10
import Naming
import PyrexTypes
11
import TypeSlots
12
from PyrexTypes import py_object_type, error_type, CTypedefType, CFuncType
13
from Symtab import ModuleScope, LocalScope, GeneratorLocalScope, \
William Stein's avatar
William Stein committed
14
    StructOrUnionScope, PyClassScope, CClassScope
15
from Cython.Utils import open_new_file, replace_suffix, EncodedString
William Stein's avatar
William Stein committed
16
import Options
17
import ControlFlow
William Stein's avatar
William Stein committed
18 19 20

from DebugFlags import debug_disposal_code

Gary Furnish's avatar
Gary Furnish committed
21
absolute_path_length = 0
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

def relative_position(pos):
    """
    We embed the relative filename in the generated C file, since we
    don't want to have to regnerate and compile all the source code
    whenever the Python install directory moves (which could happen,
    e.g,. when distributing binaries.)
    
    INPUT:
        a position tuple -- (absolute filename, line number column position)

    OUTPUT:
        relative filename
        line number

    AUTHOR: William Stein
    """
Gary Furnish's avatar
Gary Furnish committed
39 40 41
    global absolute_path_length
    if absolute_path_length==0:
        absolute_path_length = len(os.path.abspath(os.getcwd())) 
42
    return (pos[0].get_filenametable_entry()[absolute_path_length+1:], pos[1])
43 44 45 46

def embed_position(pos, docstring):
    if not Options.embed_pos_in_docstring:
        return docstring
47
    pos_line = u'File: %s (starting at line %s)' % relative_position(pos)
48 49
    if docstring is None:
        # unicode string
50
        return EncodedString(pos_line)
51 52 53 54 55 56 57 58 59 60 61 62

    # make sure we can encode the filename in the docstring encoding
    # otherwise make the docstring a unicode string
    encoding = docstring.encoding
    if encoding is not None:
        try:
            encoded_bytes = pos_line.encode(encoding)
        except UnicodeEncodeError:
            encoding = None

    if not docstring:
        # reuse the string encoding of the original docstring
63
        doc = EncodedString(pos_line)
64
    else:
65
        doc = EncodedString(pos_line + u'\\n' + docstring)
66 67
    doc.encoding = encoding
    return doc
68

Stefan Behnel's avatar
Stefan Behnel committed
69
class Node(object):
William Stein's avatar
William Stein committed
70 71 72 73 74 75
    #  pos         (string, int, int)   Source file position
    #  is_name     boolean              Is a NameNode
    #  is_literal  boolean              Is a ConstNode
    
    is_name = 0
    is_literal = 0
76

77 78 79
    # All descandants should set child_attrs to a list of the attributes
    # containing nodes considered "children" in the tree. Each such attribute
    # can either contain a single node or a list of nodes. See Visitor.py.
80
    child_attrs = None
William Stein's avatar
William Stein committed
81 82 83 84 85
    
    def __init__(self, pos, **kw):
        self.pos = pos
        self.__dict__.update(kw)
    
86 87 88 89 90 91 92 93 94
    gil_message = "Operation"

    def gil_check(self, env):
        if env.nogil:
            self.gil_error()

    def gil_error(self):
        error(self.pos, "%s not allowed without gil" % self.gil_message)

95 96 97 98 99 100
    def clone_node(self):
        """Clone the node. This is defined as a shallow copy, except for member lists
           amongst the child attributes (from get_child_accessors) which are also
           copied. Lists containing child nodes are thus seen as a way for the node
           to hold multiple children directly; the list is not treated as a seperate
           level in the tree."""
101 102 103
        result = copy.copy(self)
        for attrname in result.child_attrs:
            value = getattr(result, attrname)
104
            if isinstance(value, list):
105
                setattr(result, attrname, [x for x in value])
106
        return result
107
    
108
    
William Stein's avatar
William Stein committed
109
    #
110
    #  There are 4 phases of parse tree processing, applied in order to
William Stein's avatar
William Stein committed
111 112
    #  all the statements in a given scope-block:
    #
113 114 115 116
    #  (0) analyse_control_flow
    #        Create the control flow tree into which state can be asserted and
    #        queried.
    #
William Stein's avatar
William Stein committed
117 118 119 120 121
    #  (1) analyse_declarations
    #        Make symbol table entries for all declarations at the current
    #        level, both explicit (def, cdef, etc.) and implicit (assignment
    #        to an otherwise undeclared name).
    #
122
    #  (2) analyse_expressions
William Stein's avatar
William Stein committed
123 124 125 126 127 128 129
    #         Determine the result types of expressions and fill in the
    #         'type' attribute of each ExprNode. Insert coercion nodes into the
    #         tree where needed to convert to and from Python objects. 
    #         Allocate temporary locals for intermediate results. Fill
    #         in the 'result_code' attribute of each ExprNode with a C code
    #         fragment.
    #
130
    #  (3) generate_code
William Stein's avatar
William Stein committed
131 132 133 134 135
    #         Emit C code for all declarations, statements and expressions.
    #         Recursively applies the 3 processing phases to the bodies of
    #         functions.
    #
    
136 137 138
    def analyse_control_flow(self, env):
        pass
    
William Stein's avatar
William Stein committed
139 140 141 142 143 144 145 146 147 148
    def analyse_declarations(self, env):
        pass
    
    def analyse_expressions(self, env):
        raise InternalError("analyse_expressions not implemented for %s" % \
            self.__class__.__name__)
    
    def generate_code(self, code):
        raise InternalError("generate_code not implemented for %s" % \
            self.__class__.__name__)
149 150 151 152 153
            
    def annotate(self, code):
        # mro does the wrong thing
        if isinstance(self, BlockNode):
            self.body.annotate(code)
154 155
            
    def end_pos(self):
Stefan Behnel's avatar
Stefan Behnel committed
156 157
        if not self.child_attrs:
            return self.pos
158 159 160
        try:
            return self._end_pos
        except AttributeError:
Stefan Behnel's avatar
Stefan Behnel committed
161
            pos = self.pos
162
            for attr in self.child_attrs:
163
                child = getattr(self, attr)
164
                # Sometimes lists, sometimes nodes
165 166 167
                if child is None:
                    pass
                elif isinstance(child, list):
Stefan Behnel's avatar
Stefan Behnel committed
168 169
                    for c in child:
                        pos = max(pos, c.end_pos())
170
                else:
Stefan Behnel's avatar
Stefan Behnel committed
171 172 173
                    pos = max(pos, child.end_pos())
            self._end_pos = pos
            return pos
William Stein's avatar
William Stein committed
174

175 176 177 178 179
    def dump(self, level=0, filter_out=("pos",)):
        def dump_child(x, level):
            if isinstance(x, Node):
                return x.dump(level)
            elif isinstance(x, list):
Robert Bradshaw's avatar
Robert Bradshaw committed
180
                return "[%s]" % ", ".join([dump_child(item, level) for item in x])
181 182 183 184 185 186
            else:
                return repr(x)
            
        
        attrs = [(key, value) for key, value in self.__dict__.iteritems() if key not in filter_out]
        if len(attrs) == 0:
187
            return "<%s (%d)>" % (self.__class__.__name__, id(self))
188 189
        else:
            indent = "  " * level
190
            res = "<%s (%d)\n" % (self.__class__.__name__, id(self))
191 192 193 194 195
            for key, value in attrs:
                res += "%s  %s: %s\n" % (indent, key, dump_child(value, level + 1))
            res += "%s>" % indent
            return res
        
William Stein's avatar
William Stein committed
196 197 198 199 200 201 202 203 204
class BlockNode:
    #  Mixin class for nodes representing a declaration block.

    def generate_const_definitions(self, env, code):
        if env.const_entries:
            code.putln("")
            for entry in env.const_entries:
                if not entry.is_interned:
                    code.put_var_declaration(entry, static = 1)
205 206 207 208 209 210 211

    def generate_interned_string_decls(self, env, code):
        entries = env.global_scope().new_interned_string_entries
        if entries:
            code.putln("")
            for entry in entries:
                code.put_var_declaration(entry, static = 1)
William Stein's avatar
William Stein committed
212
            code.putln("")
213
            for entry in entries:
William Stein's avatar
William Stein committed
214
                code.putln(
215 216 217
                    "static PyObject *%s;" % entry.pystring_cname)
            del entries[:]

William Stein's avatar
William Stein committed
218
    def generate_py_string_decls(self, env, code):
219 220
        if env is None:
            return # earlier error
William Stein's avatar
William Stein committed
221 222 223 224
        entries = env.pystring_entries
        if entries:
            code.putln("")
            for entry in entries:
225 226 227
                if not entry.is_interned:
                    code.putln(
                        "static PyObject *%s;" % entry.pystring_cname)
228

229 230 231 232 233 234 235 236 237 238 239
    def generate_interned_num_decls(self, env, code):
        #  Flush accumulated interned nums from the global scope
        #  and generate declarations for them.
        genv = env.global_scope()
        entries = genv.interned_nums
        if entries:
            code.putln("")
            for entry in entries:
                code.putln(
                    "static PyObject *%s;" % entry.cname)
            del entries[:]
William Stein's avatar
William Stein committed
240

241
    def generate_cached_builtins_decls(self, env, code):
242
        entries = env.global_scope().undeclared_cached_builtins
243 244 245 246 247
        if len(entries) > 0:
            code.putln("")
        for entry in entries:
            code.putln("static PyObject *%s;" % entry.cname)
        del entries[:]
248
        
William Stein's avatar
William Stein committed
249 250 251 252

class StatListNode(Node):
    # stats     a list of StatNode
    
253
    child_attrs = ["stats"]
254 255 256 257 258

    def create_analysed(pos, env, *args, **kw):
        node = StatListNode(pos, *args, **kw)
        return node # No node-specific analysis necesarry
    create_analysed = staticmethod(create_analysed)
259
    
260 261 262 263
    def analyse_control_flow(self, env):
        for stat in self.stats:
            stat.analyse_control_flow(env)

William Stein's avatar
William Stein committed
264 265 266 267 268 269 270 271 272 273
    def analyse_declarations(self, env):
        #print "StatListNode.analyse_declarations" ###
        for stat in self.stats:
            stat.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        #print "StatListNode.analyse_expressions" ###
        for stat in self.stats:
            stat.analyse_expressions(env)
    
274
    def generate_function_definitions(self, env, code, transforms):
William Stein's avatar
William Stein committed
275 276
        #print "StatListNode.generate_function_definitions" ###
        for stat in self.stats:
277
            stat.generate_function_definitions(env, code, transforms)
William Stein's avatar
William Stein committed
278 279 280 281 282 283
            
    def generate_execution_code(self, code):
        #print "StatListNode.generate_execution_code" ###
        for stat in self.stats:
            code.mark_pos(stat.pos)
            stat.generate_execution_code(code)
284 285 286 287
            
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)
William Stein's avatar
William Stein committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
    

class StatNode(Node):
    #
    #  Code generation for statements is split into the following subphases:
    #
    #  (1) generate_function_definitions
    #        Emit C code for the definitions of any structs,
    #        unions, enums and functions defined in the current
    #        scope-block.
    #
    #  (2) generate_execution_code
    #        Emit C code for executable statements.
    #
    
303
    def generate_function_definitions(self, env, code, transforms):
William Stein's avatar
William Stein committed
304 305 306 307 308 309 310 311 312 313 314
        pass
    
    def generate_execution_code(self, code):
        raise InternalError("generate_execution_code not implemented for %s" % \
            self.__class__.__name__)


class CDefExternNode(StatNode):
    #  include_file   string or None
    #  body           StatNode
    
315 316
    child_attrs = ["body"]
    
William Stein's avatar
William Stein committed
317 318 319 320 321 322 323 324 325 326 327 328 329
    def analyse_declarations(self, env):
        if self.include_file:
            env.add_include_file(self.include_file)
        old_cinclude_flag = env.in_cinclude
        env.in_cinclude = 1
        self.body.analyse_declarations(env)
        env.in_cinclude = old_cinclude_flag
    
    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        pass
330 331 332

    def annotate(self, code):
        self.body.annotate(code)
William Stein's avatar
William Stein committed
333 334 335 336 337 338 339 340 341 342 343 344
        

class CDeclaratorNode(Node):
    # Part of a C declaration.
    #
    # Processing during analyse_declarations phase:
    #
    #   analyse
    #      Returns (name, type) pair where name is the
    #      CNameDeclaratorNode of the name being declared 
    #      and type is the type it is being declared as.
    #
345 346 347
    #  calling_convention  string   Calling convention of CFuncDeclaratorNode
    #                               for which this is a base 

348 349
    child_attrs = []

350 351
    calling_convention = ""

William Stein's avatar
William Stein committed
352 353

class CNameDeclaratorNode(CDeclaratorNode):
Robert Bradshaw's avatar
Robert Bradshaw committed
354 355 356
    #  name    string             The Pyrex name being declared
    #  cname   string or None     C name, if specified
    #  default ExprNode or None   the value assigned on declaration
William Stein's avatar
William Stein committed
357
    
Robert Bradshaw's avatar
Robert Bradshaw committed
358
    child_attrs = ['default']
359
    
360
    default = None
361
    
362 363 364 365 366
    def analyse(self, base_type, env, nonempty = 0):
        if nonempty and self.name == '':
            # Must have mistaken the name for the type. 
            self.name = base_type.name
            base_type = py_object_type
367
        self.type = base_type
William Stein's avatar
William Stein committed
368
        return self, base_type
369
        
William Stein's avatar
William Stein committed
370 371 372
class CPtrDeclaratorNode(CDeclaratorNode):
    # base     CDeclaratorNode
    
373 374
    child_attrs = ["base"]

375
    def analyse(self, base_type, env, nonempty = 0):
William Stein's avatar
William Stein committed
376 377 378 379
        if base_type.is_pyobject:
            error(self.pos,
                "Pointer base type cannot be a Python object")
        ptr_type = PyrexTypes.c_ptr_type(base_type)
380
        return self.base.analyse(ptr_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
381 382 383 384
        
class CArrayDeclaratorNode(CDeclaratorNode):
    # base        CDeclaratorNode
    # dimension   ExprNode
385 386

    child_attrs = ["base", "dimension"]
William Stein's avatar
William Stein committed
387
    
388
    def analyse(self, base_type, env, nonempty = 0):
William Stein's avatar
William Stein committed
389 390 391 392 393 394 395 396 397 398 399 400 401
        if self.dimension:
            self.dimension.analyse_const_expression(env)
            if not self.dimension.type.is_int:
                error(self.dimension.pos, "Array dimension not integer")
            size = self.dimension.result_code
        else:
            size = None
        if not base_type.is_complete():
            error(self.pos,
                "Array element type '%s' is incomplete" % base_type)
        if base_type.is_pyobject:
            error(self.pos,
                "Array element cannot be a Python object")
402 403 404
        if base_type.is_cfunction:
            error(self.pos,
                "Array element cannot be a function")
William Stein's avatar
William Stein committed
405
        array_type = PyrexTypes.c_array_type(base_type, size)
406
        return self.base.analyse(array_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
407 408 409 410 411 412 413 414


class CFuncDeclaratorNode(CDeclaratorNode):
    # base             CDeclaratorNode
    # args             [CArgDeclNode]
    # has_varargs      boolean
    # exception_value  ConstNode
    # exception_check  boolean    True if PyErr_Occurred check needed
415 416
    # nogil            boolean    Can be called without gil
    # with_gil         boolean    Acquire gil around function body
417
    
418 419
    child_attrs = ["base", "args", "exception_value"]

420
    overridable = 0
421
    optional_arg_count = 0
William Stein's avatar
William Stein committed
422

423
    def analyse(self, return_type, env, nonempty = 0):
William Stein's avatar
William Stein committed
424 425
        func_type_args = []
        for arg_node in self.args:
426
            name_declarator, type = arg_node.analyse(env, nonempty = nonempty)
William Stein's avatar
William Stein committed
427 428 429 430 431 432 433 434 435
            name = name_declarator.name
            if name_declarator.cname:
                error(self.pos, 
                    "Function argument cannot have C name specification")
            # Turn *[] argument into **
            if type.is_array:
                type = PyrexTypes.c_ptr_type(type.base_type)
            # Catch attempted C-style func(void) decl
            if type.is_void:
Robert Bradshaw's avatar
Robert Bradshaw committed
436
                error(arg_node.pos, "Use spam() rather than spam(void) to declare a function with no arguments.")
437 438 439
#            if type.is_pyobject and self.nogil:
#                error(self.pos,
#                    "Function with Python argument cannot be declared nogil")
William Stein's avatar
William Stein committed
440 441 442
            func_type_args.append(
                PyrexTypes.CFuncTypeArg(name, type, arg_node.pos))
            if arg_node.default:
443
                self.optional_arg_count += 1
444 445
            elif self.optional_arg_count:
                error(self.pos, "Non-default argument follows default argument")
446 447 448
        
        if self.optional_arg_count:
            scope = StructOrUnionScope()
449
            scope.declare_var('%sn' % Naming.pyrex_prefix, PyrexTypes.c_int_type, self.pos)
450 451
            for arg in func_type_args[len(func_type_args)-self.optional_arg_count:]:
                scope.declare_var(arg.name, arg.type, arg.pos, allow_pyobject = 1)
452
            struct_cname = env.mangle(Naming.opt_arg_prefix, self.base.name)
453 454 455 456 457 458
            self.op_args_struct = env.global_scope().declare_struct_or_union(name = struct_cname,
                                        kind = 'struct',
                                        scope = scope,
                                        typedef_flag = 0,
                                        pos = self.pos,
                                        cname = struct_cname)
459
            self.op_args_struct.defined_in_pxd = 1
460 461
            self.op_args_struct.used = 1
        
William Stein's avatar
William Stein committed
462 463 464
        exc_val = None
        exc_check = 0
        if return_type.is_pyobject \
Robert Bradshaw's avatar
Robert Bradshaw committed
465 466
            and (self.exception_value or self.exception_check) \
            and self.exception_check != '+':
William Stein's avatar
William Stein committed
467 468 469 470 471
                error(self.pos,
                    "Exception clause not allowed for function returning Python object")
        else:
            if self.exception_value:
                self.exception_value.analyse_const_expression(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
472 473 474 475 476 477 478 479 480 481 482 483 484
                if self.exception_check == '+':
                    exc_val_type = self.exception_value.type
                    if not exc_val_type.is_error and \
                          not exc_val_type.is_pyobject and \
                          not (exc_val_type.is_cfunction and not exc_val_type.return_type.is_pyobject and len(exc_val_type.args)==0):
                        error(self.exception_value.pos,
                            "Exception value must be a Python exception or cdef function with no arguments.")
                    exc_val = self.exception_value
                else:
                    exc_val = self.exception_value.result_code
                    if not return_type.assignable_from(self.exception_value.type):
                        error(self.exception_value.pos,
                            "Exception value incompatible with function return type")
William Stein's avatar
William Stein committed
485
            exc_check = self.exception_check
486 487 488 489 490 491
        if return_type.is_array:
            error(self.pos,
                "Function cannot return an array")
        if return_type.is_cfunction:
            error(self.pos,
                "Function cannot return a function")
William Stein's avatar
William Stein committed
492 493
        func_type = PyrexTypes.CFuncType(
            return_type, func_type_args, self.has_varargs, 
494
            optional_arg_count = self.optional_arg_count,
495
            exception_value = exc_val, exception_check = exc_check,
496
            calling_convention = self.base.calling_convention,
497
            nogil = self.nogil, with_gil = self.with_gil, is_overridable = self.overridable)
498
        if self.optional_arg_count:
499
            func_type.op_arg_struct = PyrexTypes.c_ptr_type(self.op_args_struct.type)
William Stein's avatar
William Stein committed
500 501 502 503 504 505 506 507 508 509 510
        return self.base.analyse(func_type, env)


class CArgDeclNode(Node):
    # Item in a function declaration argument list.
    #
    # base_type      CBaseTypeNode
    # declarator     CDeclaratorNode
    # not_none       boolean            Tagged with 'not None'
    # default        ExprNode or None
    # default_entry  Symtab.Entry       Entry for the variable holding the default value
511
    # default_result_code string        cname or code fragment for default value
William Stein's avatar
William Stein committed
512
    # is_self_arg    boolean            Is the "self" arg of an extension type method
513 514
    # is_kw_only     boolean            Is a keyword-only argument

515 516
    child_attrs = ["base_type", "declarator", "default"]

William Stein's avatar
William Stein committed
517
    is_self_arg = 0
518 519
    is_generic = 1

520
    def analyse(self, env, nonempty = 0):
521
        #print "CArgDeclNode.analyse: is_self_arg =", self.is_self_arg ###
William Stein's avatar
William Stein committed
522
        base_type = self.base_type.analyse(env)
523
        return self.declarator.analyse(base_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
524

525 526 527 528
    def annotate(self, code):
        if self.default:
            self.default.annotate(code)

William Stein's avatar
William Stein committed
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

class CBaseTypeNode(Node):
    # Abstract base class for C base type nodes.
    #
    # Processing during analyse_declarations phase:
    #
    #   analyse
    #     Returns the type.
    
    pass

class CSimpleBaseTypeNode(CBaseTypeNode):
    # name             string
    # module_path      [string]     Qualifying name components
    # is_basic_c_type  boolean
    # signed           boolean
    # longness         integer
    # is_self_arg      boolean      Is self argument of C method

548 549
    child_attrs = []
    
William Stein's avatar
William Stein committed
550 551
    def analyse(self, env):
        # Return type descriptor.
552
        #print "CSimpleBaseTypeNode.analyse: is_self_arg =", self.is_self_arg ###
William Stein's avatar
William Stein committed
553 554 555 556 557 558 559 560 561
        type = None
        if self.is_basic_c_type:
            type = PyrexTypes.simple_c_type(self.signed, self.longness, self.name)
            if not type:
                error(self.pos, "Unrecognised type modifier combination")
        elif self.name == "object" and not self.module_path:
            type = py_object_type
        elif self.name is None:
            if self.is_self_arg and env.is_c_class_scope:
562
                #print "CSimpleBaseTypeNode.analyse: defaulting to parent type" ###
William Stein's avatar
William Stein committed
563 564 565 566
                type = env.parent_type
            else:
                type = py_object_type
        else:
567
            scope = env.find_imported_module(self.module_path, self.pos)
William Stein's avatar
William Stein committed
568
            if scope:
569 570
                if scope.is_c_class_scope:
                    scope = scope.global_scope()
William Stein's avatar
William Stein committed
571 572 573 574 575 576 577 578 579 580
                entry = scope.find(self.name, self.pos)
                if entry and entry.is_type:
                    type = entry.type
                else:
                    error(self.pos, "'%s' is not a type identifier" % self.name)
        if type:
            return type
        else:
            return PyrexTypes.error_type

581
class CBufferAccessTypeNode(Node):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
582
    #  After parsing:
583 584
    #  positional_args  [ExprNode]        List of positional arguments
    #  keyword_args     DictNode          Keyword arguments
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
585 586 587 588 589
    #  base_type_node   CBaseTypeNode

    #  After PostParse:
    #  dtype_node       CBaseTypeNode
    #  ndim             int
590

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
591 592 593 594 595
    #  After analysis:
    #  type             PyrexType.PyrexType

    child_attrs = ["base_type_node", "positional_args", "keyword_args",
                   "dtype_node"]
596

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
597
    dtype_node = None
598 599
    
    def analyse(self, env):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
600 601
        base_type = self.base_type_node.analyse(env)
        dtype = self.dtype_node.analyse(env)
602
        self.type = PyrexTypes.BufferType(base_type, dtype=dtype, ndim=self.ndim)
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
603
        return self.type
William Stein's avatar
William Stein committed
604 605 606 607 608

class CComplexBaseTypeNode(CBaseTypeNode):
    # base_type   CBaseTypeNode
    # declarator  CDeclaratorNode
    
609 610
    child_attrs = ["base_type", "declarator"]

William Stein's avatar
William Stein committed
611 612 613 614 615 616 617 618 619 620 621 622
    def analyse(self, env):
        base = self.base_type.analyse(env)
        _, type = self.declarator.analyse(base, env)
        return type


class CVarDefNode(StatNode):
    #  C variable definition or forward/extern function declaration.
    #
    #  visibility    'private' or 'public' or 'extern'
    #  base_type     CBaseTypeNode
    #  declarators   [CDeclaratorNode]
623
    #  in_pxd        boolean
Stefan Behnel's avatar
Stefan Behnel committed
624
    #  api           boolean
625 626

    child_attrs = ["base_type", "declarators"]
William Stein's avatar
William Stein committed
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
    
    def analyse_declarations(self, env, dest_scope = None):
        if not dest_scope:
            dest_scope = env
        base_type = self.base_type.analyse(env)
        for declarator in self.declarators:
            name_declarator, type = declarator.analyse(base_type, env)
            if not type.is_complete():
                if not (self.visibility == 'extern' and type.is_array):
                    error(declarator.pos,
                        "Variable type '%s' is incomplete" % type)
            if self.visibility == 'extern' and type.is_pyobject:
                error(declarator.pos,
                    "Python object cannot be declared extern")
            name = name_declarator.name
            cname = name_declarator.cname
643 644 645
            if name == '':
                error(declarator.pos, "Missing name in declaration.")
                return
William Stein's avatar
William Stein committed
646
            if type.is_cfunction:
647
                entry = dest_scope.declare_cfunction(name, type, declarator.pos,
Stefan Behnel's avatar
Stefan Behnel committed
648 649
                    cname = cname, visibility = self.visibility, in_pxd = self.in_pxd,
                    api = self.api)
William Stein's avatar
William Stein committed
650
            else:
651 652 653
                if self.in_pxd and self.visibility != 'extern':
                    error(self.pos, 
                        "Only 'extern' C variable declaration allowed in .pxd file")
William Stein's avatar
William Stein committed
654 655 656 657 658 659 660 661 662
                dest_scope.declare_var(name, type, declarator.pos,
                    cname = cname, visibility = self.visibility, is_cdef = 1)
    

class CStructOrUnionDefNode(StatNode):
    #  name          string
    #  cname         string or None
    #  kind          "struct" or "union"
    #  typedef_flag  boolean
663
    #  visibility    "public" or "private"
Stefan Behnel's avatar
Stefan Behnel committed
664
    #  in_pxd        boolean
William Stein's avatar
William Stein committed
665 666 667
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
    
668 669
    child_attrs = ["attributes"]

William Stein's avatar
William Stein committed
670 671 672
    def analyse_declarations(self, env):
        scope = None
        if self.attributes is not None:
673
            scope = StructOrUnionScope(self.name)
William Stein's avatar
William Stein committed
674 675
        self.entry = env.declare_struct_or_union(
            self.name, self.kind, scope, self.typedef_flag, self.pos,
676
            self.cname, visibility = self.visibility)
William Stein's avatar
William Stein committed
677
        if self.attributes is not None:
Stefan Behnel's avatar
Stefan Behnel committed
678 679
            if self.in_pxd and not env.in_cinclude:
                self.entry.defined_in_pxd = 1
William Stein's avatar
William Stein committed
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
            for attr in self.attributes:
                attr.analyse_declarations(env, scope)
    
    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        pass


class CEnumDefNode(StatNode):
    #  name           string or None
    #  cname          string or None
    #  items          [CEnumDefItemNode]
    #  typedef_flag   boolean
Stefan Behnel's avatar
Stefan Behnel committed
695 696
    #  visibility     "public" or "private"
    #  in_pxd         boolean
William Stein's avatar
William Stein committed
697 698
    #  entry          Entry
    
699 700
    child_attrs = ["items"]
    
William Stein's avatar
William Stein committed
701 702
    def analyse_declarations(self, env):
        self.entry = env.declare_enum(self.name, self.pos,
703 704
            cname = self.cname, typedef_flag = self.typedef_flag,
            visibility = self.visibility)
Stefan Behnel's avatar
Stefan Behnel committed
705 706 707 708 709
        if self.items is not None:
            if self.in_pxd and not env.in_cinclude:
                self.entry.defined_in_pxd = 1
            for item in self.items:
                item.analyse_declarations(env, self.entry)
William Stein's avatar
William Stein committed
710 711

    def analyse_expressions(self, env):
Robert Bradshaw's avatar
Robert Bradshaw committed
712 713 714
        if self.visibility == 'public':
            self.temp = env.allocate_temp_pyobject()
            env.release_temp(self.temp)
William Stein's avatar
William Stein committed
715 716
    
    def generate_execution_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
717 718 719 720 721 722 723 724 725 726 727 728
        if self.visibility == 'public':
            for item in self.entry.enum_values:
                code.putln("%s = PyInt_FromLong(%s); %s" % (
                        self.temp,
                        item.cname,
                        code.error_goto_if_null(self.temp, item.pos)))
                code.putln('if (PyObject_SetAttrString(%s, "%s", %s) < 0) %s' % (
                        Naming.module_cname, 
                        item.name, 
                        self.temp,
                        code.error_goto(item.pos)))
                code.putln("%s = 0;" % self.temp)
William Stein's avatar
William Stein committed
729 730 731 732 733 734 735


class CEnumDefItemNode(StatNode):
    #  name     string
    #  cname    string or None
    #  value    ExprNode or None
    
736 737
    child_attrs = ["value"]

William Stein's avatar
William Stein committed
738 739 740
    def analyse_declarations(self, env, enum_entry):
        if self.value:
            self.value.analyse_const_expression(env)
741 742 743
            if not self.value.type.is_int:
                self.value = self.value.coerce_to(PyrexTypes.c_int_type, env)
                self.value.analyse_const_expression(env)
William Stein's avatar
William Stein committed
744 745 746 747 748 749 750 751 752
            value = self.value.result_code
        else:
            value = self.name
        entry = env.declare_const(self.name, enum_entry.type, 
            value, self.pos, cname = self.cname)
        enum_entry.enum_values.append(entry)


class CTypeDefNode(StatNode):
Stefan Behnel's avatar
Stefan Behnel committed
753 754 755 756
    #  base_type    CBaseTypeNode
    #  declarator   CDeclaratorNode
    #  visibility   "public" or "private"
    #  in_pxd       boolean
757 758

    child_attrs = ["base_type", "declarator"]
William Stein's avatar
William Stein committed
759 760 761 762 763 764
    
    def analyse_declarations(self, env):
        base = self.base_type.analyse(env)
        name_declarator, type = self.declarator.analyse(base, env)
        name = name_declarator.name
        cname = name_declarator.cname
Stefan Behnel's avatar
Stefan Behnel committed
765
        entry = env.declare_typedef(name, type, self.pos,
766
            cname = cname, visibility = self.visibility)
Stefan Behnel's avatar
Stefan Behnel committed
767 768
        if self.in_pxd and not env.in_cinclude:
            entry.defined_in_pxd = 1
William Stein's avatar
William Stein committed
769 770 771 772 773 774 775 776 777 778 779 780 781
    
    def analyse_expressions(self, env):
        pass
    def generate_execution_code(self, code):
        pass


class FuncDefNode(StatNode, BlockNode):
    #  Base class for function definition nodes.
    #
    #  return_type     PyrexType
    #  #filename        string        C name of filename string const
    #  entry           Symtab.Entry
782
    #  needs_closure   boolean        Whether or not this function has inner functions/classes/yield
William Stein's avatar
William Stein committed
783
    
784
    py_func = None
785
    assmt = None
786
    needs_closure = False
787 788 789 790 791 792 793
    
    def analyse_default_values(self, env):
        genv = env.global_scope()
        for arg in self.args:
            if arg.default:
                if arg.is_generic:
                    if not hasattr(arg, 'default_entry'):
794
                        arg.default.analyse_types(env)
795
                        arg.default = arg.default.coerce_to(arg.type, genv)
796 797 798
                        if arg.default.is_literal:
                            arg.default_entry = arg.default
                            arg.default_result_code = arg.default.calculate_result_code()
799 800
                            if arg.default.type != arg.type and not arg.type.is_int:
                                arg.default_result_code = arg.type.cast_code(arg.default_result_code)
801 802 803 804 805
                        else:
                            arg.default.allocate_temps(genv)
                            arg.default_entry = genv.add_default_value(arg.type)
                            arg.default_entry.used = 1
                            arg.default_result_code = arg.default_entry.cname
806 807 808 809
                else:
                    error(arg.pos,
                        "This argument cannot have a default value")
                    arg.default = None
810
    
811 812
    def need_gil_acquisition(self, lenv):
        return 0
813 814 815 816 817
        
    def create_local_scope(self, env):
        genv = env
        while env.is_py_class_scope or env.is_c_class_scope:
            env = env.outer_scope
818
        if self.needs_closure:
819
            lenv = GeneratorLocalScope(name = self.entry.name, outer_scope = genv)
820 821
        else:
            lenv = LocalScope(name = self.entry.name, outer_scope = genv)
William Stein's avatar
William Stein committed
822
        lenv.return_type = self.return_type
823 824 825
        type = self.entry.type
        if type.is_cfunction:
            lenv.nogil = type.nogil and not type.with_gil
826 827 828 829 830
        self.local_scope = lenv
        return lenv
                
    def generate_function_definitions(self, env, code, transforms):
        # Generate C code for header and body of function
William Stein's avatar
William Stein committed
831
        code.init_labels()
832
        lenv = self.local_scope
William Stein's avatar
William Stein committed
833
        # ----- Top-level constants used by this function
834
        code.mark_pos(self.pos)
835
        self.generate_interned_num_decls(lenv, code)
836
        self.generate_interned_string_decls(lenv, code)
William Stein's avatar
William Stein committed
837
        self.generate_py_string_decls(lenv, code)
838
        self.generate_cached_builtins_decls(lenv, code)
William Stein's avatar
William Stein committed
839 840 841 842 843
        #code.putln("")
        #code.put_var_declarations(lenv.const_entries, static = 1)
        self.generate_const_definitions(lenv, code)
        # ----- Function header
        code.putln("")
844 845 846 847
        if self.py_func:
            self.py_func.generate_function_header(code, 
                with_pymethdef = env.is_py_class_scope,
                proto_only=True)
William Stein's avatar
William Stein committed
848 849 850
        self.generate_function_header(code,
            with_pymethdef = env.is_py_class_scope)
        # ----- Local variable declarations
851
        lenv.mangle_closure_cnames(Naming.cur_scope_cname)
William Stein's avatar
William Stein committed
852
        self.generate_argument_declarations(lenv, code)
853 854
        if self.needs_closure:
            code.putln("/* TODO: declare and create scope object */")
William Stein's avatar
William Stein committed
855 856 857 858 859 860 861 862 863 864 865 866
        code.put_var_declarations(lenv.var_entries)
        init = ""
        if not self.return_type.is_void:
            code.putln(
                "%s%s;" % 
                    (self.return_type.declaration_code(
                        Naming.retval_cname),
                    init))
        code.put_var_declarations(lenv.temp_entries)
        self.generate_keyword_list(code)
        # ----- Extern library function declarations
        lenv.generate_library_function_declarations(code)
867 868 869 870
        # ----- GIL acquisition
        acquire_gil = self.need_gil_acquisition(lenv)
        if acquire_gil:
            code.putln("PyGILState_STATE _save = PyGILState_Ensure();")
William Stein's avatar
William Stein committed
871
        # ----- Fetch arguments
872
        self.generate_argument_parsing_code(env, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
873 874 875 876 877
        # If an argument is assigned to in the body, we must 
        # incref it to properly keep track of refcounts.
        for entry in lenv.arg_entries:
            if entry.type.is_pyobject and lenv.control_flow.get_state((entry.name, 'source')) != 'arg':
                code.put_var_incref(entry)
William Stein's avatar
William Stein committed
878 879
        # ----- Initialise local variables
        for entry in lenv.var_entries:
880
            if entry.type.is_pyobject and entry.init_to_none and entry.used:
William Stein's avatar
William Stein committed
881
                code.put_init_var_to_py_none(entry)
882
        # ----- Check and convert arguments
William Stein's avatar
William Stein committed
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
        self.generate_argument_type_tests(code)
        # ----- Function body
        self.body.generate_execution_code(code)
        # ----- Default return value
        code.putln("")
        if self.return_type.is_pyobject:
            #if self.return_type.is_extension_type:
            #	lhs = "(PyObject *)%s" % Naming.retval_cname
            #else:
            lhs = Naming.retval_cname
            code.put_init_to_py_none(lhs, self.return_type)
        else:
            val = self.return_type.default_value
            if val:
                code.putln("%s = %s;" % (Naming.retval_cname, val))
898
        #code.putln("goto %s;" % code.return_label)
William Stein's avatar
William Stein committed
899
        # ----- Error cleanup
900 901 902 903 904 905 906
        if code.error_label in code.labels_used:
            code.put_goto(code.return_label)
            code.put_label(code.error_label)
            code.put_var_xdecrefs(lenv.temp_entries)
            err_val = self.error_value()
            exc_check = self.caller_will_check_exceptions()
            if err_val is not None or exc_check:
Robert Bradshaw's avatar
Robert Bradshaw committed
907
                code.putln('__Pyx_AddTraceback("%s");' % self.entry.qualified_name)
908 909 910 911 912
            else:
                code.putln(
                    '__Pyx_WriteUnraisable("%s");' % 
                        self.entry.qualified_name)
                env.use_utility_code(unraisable_exception_utility_code)
913 914 915 916 917 918 919 920
            default_retval = self.return_type.default_value
            if err_val is None and default_retval:
                err_val = default_retval
            if err_val is not None:
                code.putln(
                    "%s = %s;" % (
                        Naming.retval_cname, 
                        err_val))
William Stein's avatar
William Stein committed
921 922
        # ----- Return cleanup
        code.put_label(code.return_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
923 924 925 926
        if not Options.init_local_none:
            for entry in lenv.var_entries:
                if lenv.control_flow.get_state((entry.name, 'initalized')) is not True:
                    entry.xdecref_cleanup = 1
927
        code.put_var_decrefs(lenv.var_entries, used_only = 1)
Robert Bradshaw's avatar
Robert Bradshaw committed
928
        # Decref any increfed args
929
        for entry in lenv.arg_entries:
Robert Bradshaw's avatar
Robert Bradshaw committed
930
            if entry.type.is_pyobject and lenv.control_flow.get_state((entry.name, 'source')) != 'arg':
931
                code.put_var_decref(entry)
William Stein's avatar
William Stein committed
932
        self.put_stararg_decrefs(code)
933 934
        if acquire_gil:
            code.putln("PyGILState_Release(_save);")
935
        code.putln("/* TODO: decref scope object */")
936
        # ----- Return
William Stein's avatar
William Stein committed
937
        if not self.return_type.is_void:
938
            code.putln("return %s;" % Naming.retval_cname)
William Stein's avatar
William Stein committed
939
        code.putln("}")
940 941
        # ----- Python version
        if self.py_func:
942
            self.py_func.generate_function_definitions(env, code, transforms)
943
        self.generate_optarg_wrapper_function(env, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
944
        
William Stein's avatar
William Stein committed
945 946 947 948 949 950 951 952 953 954
    def put_stararg_decrefs(self, code):
        pass

    def declare_argument(self, env, arg):
        if arg.type.is_void:
            error(arg.pos, "Invalid use of 'void'")
        elif not arg.type.is_complete() and not arg.type.is_array:
            error(arg.pos,
                "Argument type '%s' is incomplete" % arg.type)
        return env.declare_arg(arg.name, arg.type, arg.pos)
955
    def generate_optarg_wrapper_function(self, env, code):
William Stein's avatar
William Stein committed
956 957 958
        pass

    def generate_execution_code(self, code):
959 960 961 962
        # Evaluate and store argument default values
        for arg in self.args:
            default = arg.default
            if default:
963 964 965
                if not default.is_literal:
                    default.generate_evaluation_code(code)
                    default.make_owned_reference(code)
966
                    code.putln(
967 968 969 970 971 972 973
                        "%s = %s;" % (
                            arg.default_entry.cname,
                            default.result_as(arg.default_entry.type)))
                    if default.is_temp and default.type.is_pyobject:
                        code.putln(
                            "%s = 0;" %
                                default.result_code)
974 975 976 977
        # For Python class methods, create and store function object
        if self.assmt:
            self.assmt.generate_execution_code(code)
    
William Stein's avatar
William Stein committed
978 979 980 981 982


class CFuncDefNode(FuncDefNode):
    #  C function definition.
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
983
    #  modifiers     ['inline']
William Stein's avatar
William Stein committed
984 985 986 987
    #  visibility    'private' or 'public' or 'extern'
    #  base_type     CBaseTypeNode
    #  declarator    CDeclaratorNode
    #  body          StatListNode
988
    #  api           boolean
William Stein's avatar
William Stein committed
989
    #
990
    #  with_gil      boolean    Acquire GIL around body
William Stein's avatar
William Stein committed
991
    #  type          CFuncType
992
    #  py_func       wrapper for calling from Python
William Stein's avatar
William Stein committed
993
    
994
    child_attrs = ["base_type", "declarator", "body", "py_func"]
995

William Stein's avatar
William Stein committed
996 997 998 999 1000
    def unqualified_name(self):
        return self.entry.name
        
    def analyse_declarations(self, env):
        base_type = self.base_type.analyse(env)
1001
        name_declarator, type = self.declarator.analyse(base_type, env, self.body is not None)
1002 1003 1004
        if not type.is_cfunction:
            error(self.pos, 
                "Suite attached to non-function declaration")
William Stein's avatar
William Stein committed
1005 1006 1007 1008 1009
        # Remember the actual type according to the function header
        # written here, because the type in the symbol table entry
        # may be different if we're overriding a C method inherited
        # from the base type of an extension type.
        self.type = type
1010
        type.is_overridable = self.overridable
1011 1012 1013 1014 1015
        declarator = self.declarator
        while not hasattr(declarator, 'args'):
            declarator = declarator.base
        self.args = declarator.args
        for formal_arg, type_arg in zip(self.args, type.args):
1016 1017
            formal_arg.type = type_arg.type
            formal_arg.cname = type_arg.cname
William Stein's avatar
William Stein committed
1018 1019 1020 1021 1022
        name = name_declarator.name
        cname = name_declarator.cname
        self.entry = env.declare_cfunction(
            name, type, self.pos, 
            cname = cname, visibility = self.visibility,
1023 1024
            defining = self.body is not None,
            api = self.api)
William Stein's avatar
William Stein committed
1025
        self.return_type = type.return_type
1026
        
1027
        if self.overridable:
1028
            import ExprNodes
1029
            py_func_body = self.call_self_node(is_module_scope = env.is_module_scope)
1030
            self.py_func = DefNode(pos = self.pos, 
1031 1032
                                   name = self.entry.name,
                                   args = self.args,
1033 1034
                                   star_arg = None,
                                   starstar_arg = None,
1035
                                   doc = self.doc,
1036 1037
                                   body = py_func_body,
                                   is_wrapper = 1)
1038
            self.py_func.is_module_scope = env.is_module_scope
1039
            self.py_func.analyse_declarations(env)
1040
            self.entry.as_variable = self.py_func.entry
1041 1042
            # Reset scope entry the above cfunction
            env.entries[name] = self.entry
1043 1044
            self.py_func.interned_attr_cname = env.intern_identifier(
                self.py_func.entry.name)
1045 1046 1047
            if not env.is_module_scope or Options.lookup_module_cpdef:
                self.override = OverrideCheckNode(self.pos, py_func = self.py_func)
                self.body = StatListNode(self.pos, stats=[self.override, self.body])
1048
    
1049
    def call_self_node(self, omit_optional_args=0, is_module_scope=0):
1050 1051 1052 1053 1054
        import ExprNodes
        args = self.type.args
        if omit_optional_args:
            args = args[:len(args) - self.type.optional_arg_count]
        arg_names = [arg.name for arg in args]
1055
        if is_module_scope:
1056
            cfunc = ExprNodes.NameNode(self.pos, name=self.entry.name)
1057 1058
        else:
            self_arg = ExprNodes.NameNode(self.pos, name=arg_names[0])
1059
            cfunc = ExprNodes.AttributeNode(self.pos, obj=self_arg, attribute=self.entry.name)
1060 1061
        skip_dispatch = not is_module_scope or Options.lookup_module_cpdef
        c_call = ExprNodes.SimpleCallNode(self.pos, function=cfunc, args=[ExprNodes.NameNode(self.pos, name=n) for n in arg_names[1-is_module_scope:]], wrapper_call=skip_dispatch)
1062
        return ReturnStatNode(pos=self.pos, return_type=PyrexTypes.py_object_type, value=c_call)
1063
    
William Stein's avatar
William Stein committed
1064 1065 1066 1067 1068 1069
    def declare_arguments(self, env):
        for arg in self.type.args:
            if not arg.name:
                error(arg.pos, "Missing argument name")
            self.declare_argument(env, arg)
            
1070
    def need_gil_acquisition(self, lenv):
1071
        type = self.type
1072
        with_gil = self.type.with_gil
1073 1074 1075 1076
        if type.nogil and not with_gil:
            if type.return_type.is_pyobject:
                error(self.pos,
                      "Function with Python return type cannot be declared nogil")
1077 1078 1079 1080 1081
            for entry in lenv.var_entries + lenv.temp_entries:
                if entry.type.is_pyobject:
                    error(self.pos, "Function declared nogil has Python locals or temporaries")
        return with_gil

1082 1083 1084 1085 1086
    def analyse_expressions(self, env):
        self.analyse_default_values(env)
        if self.overridable:
            self.py_func.analyse_expressions(env)

1087
    def generate_function_header(self, code, with_pymethdef, with_opt_args = 1):
William Stein's avatar
William Stein committed
1088 1089
        arg_decls = []
        type = self.type
Stefan Behnel's avatar
Stefan Behnel committed
1090
        visibility = self.entry.visibility
1091
        for arg in type.args[:len(type.args)-type.optional_arg_count]:
William Stein's avatar
William Stein committed
1092
            arg_decls.append(arg.declaration_code())
1093 1094
        if type.optional_arg_count and with_opt_args:
            arg_decls.append(type.op_arg_struct.declaration_code(Naming.optional_args_cname))
William Stein's avatar
William Stein committed
1095 1096 1097 1098
        if type.has_varargs:
            arg_decls.append("...")
        if not arg_decls:
            arg_decls = ["void"]
1099 1100 1101 1102
        cname = self.entry.func_cname
        if not with_opt_args:
            cname += Naming.no_opt_args
        entity = type.function_header_code(cname, string.join(arg_decls, ", "))
Stefan Behnel's avatar
Stefan Behnel committed
1103
        if visibility == 'public':
William Stein's avatar
William Stein committed
1104 1105 1106 1107 1108
            dll_linkage = "DL_EXPORT"
        else:
            dll_linkage = None
        header = self.return_type.declaration_code(entity,
            dll_linkage = dll_linkage)
Stefan Behnel's avatar
Stefan Behnel committed
1109
        if visibility != 'private':
William Stein's avatar
William Stein committed
1110 1111
            storage_class = "%s " % Naming.extern_c_macro
        else:
Stefan Behnel's avatar
Stefan Behnel committed
1112
            storage_class = "static "
Robert Bradshaw's avatar
Robert Bradshaw committed
1113
        code.putln("%s%s %s {" % (
William Stein's avatar
William Stein committed
1114
            storage_class,
1115
            ' '.join(self.modifiers).upper(), # macro forms 
William Stein's avatar
William Stein committed
1116 1117 1118
            header))

    def generate_argument_declarations(self, env, code):
1119
        for arg in self.args:
1120
            if arg.default:
1121
                    code.putln('%s = %s;' % (arg.type.declaration_code(arg.cname), arg.default_result_code))
1122

William Stein's avatar
William Stein committed
1123 1124 1125
    def generate_keyword_list(self, code):
        pass
        
1126
    def generate_argument_parsing_code(self, env, code):
1127
        i = 0
1128 1129
        if self.type.optional_arg_count:
            code.putln('if (%s) {' % Naming.optional_args_cname)
1130
            for arg in self.args:
1131
                if arg.default:
1132
                    code.putln('if (%s->%sn > %s) {' % (Naming.optional_args_cname, Naming.pyrex_prefix, i))
1133 1134 1135 1136
                    declarator = arg.declarator
                    while not hasattr(declarator, 'name'):
                        declarator = declarator.base
                    code.putln('%s = %s->%s;' % (arg.cname, Naming.optional_args_cname, declarator.name))
1137 1138 1139
                    i += 1
            for _ in range(self.type.optional_arg_count):
                code.putln('}')
1140
            code.putln('}')
William Stein's avatar
William Stein committed
1141 1142 1143 1144 1145
    
    def generate_argument_conversion_code(self, code):
        pass
    
    def generate_argument_type_tests(self, code):
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
        # Generate type tests for args whose type in a parent
        # class is a supertype of the declared type.
        for arg in self.type.args:
            if arg.needs_type_test:
                self.generate_arg_type_test(arg, code)
    
    def generate_arg_type_test(self, arg, code):
        # Generate type test for one argument.
        if arg.type.typeobj_is_available():
            typeptr_cname = arg.type.typeptr_cname
1156
            arg_code = "((PyObject *)%s)" % arg.cname
1157
            code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
1158
                'if (unlikely(!__Pyx_ArgTypeTest(%s, %s, %d, "%s", %s))) %s' % (
1159 1160 1161 1162
                    arg_code, 
                    typeptr_cname,
                    not arg.not_none,
                    arg.name,
Robert Bradshaw's avatar
Robert Bradshaw committed
1163
                    type.is_builtin_type,
1164 1165 1166 1167
                    code.error_goto(arg.pos)))
        else:
            error(arg.pos, "Cannot test type of extern C class "
                "without type object name specification")
1168

William Stein's avatar
William Stein committed
1169 1170 1171 1172
    def error_value(self):
        if self.return_type.is_pyobject:
            return "0"
        else:
1173 1174
            #return None
            return self.entry.type.exception_value
William Stein's avatar
William Stein committed
1175 1176
            
    def caller_will_check_exceptions(self):
1177
        return self.entry.type.exception_check
1178
                    
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
    def generate_optarg_wrapper_function(self, env, code):
        if self.type.optional_arg_count and \
                self.type.original_sig and not self.type.original_sig.optional_arg_count:
            code.putln()
            self.generate_function_header(code, 0, with_opt_args = 0)
            if not self.return_type.is_void:
                code.put('return ')
            args = self.type.args
            arglist = [arg.cname for arg in args[:len(args)-self.type.optional_arg_count]]
            arglist.append('NULL')
            code.putln('%s(%s);' % (self.entry.func_cname, ', '.join(arglist)))
            code.putln('}')

William Stein's avatar
William Stein committed
1192 1193 1194 1195 1196 1197 1198

class PyArgDeclNode(Node):
    # Argument which must be a Python object (used
    # for * and ** arguments).
    #
    # name   string
    # entry  Symtab.Entry
1199
    child_attrs = []
William Stein's avatar
William Stein committed
1200
    
1201 1202 1203 1204 1205 1206 1207

class DecoratorNode(Node):
    # A decorator
    #
    # decorator    NameNode or CallNode
    child_attrs = ['decorator']

William Stein's avatar
William Stein committed
1208 1209 1210 1211 1212

class DefNode(FuncDefNode):
    # A Python function definition.
    #
    # name          string                 the Python name of the function
1213
    # decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
1214 1215 1216
    # args          [CArgDeclNode]         formal arguments
    # star_arg      PyArgDeclNode or None  * argument
    # starstar_arg  PyArgDeclNode or None  ** argument
1217
    # doc           EncodedString or None
William Stein's avatar
William Stein committed
1218 1219 1220 1221 1222 1223 1224
    # body          StatListNode
    #
    #  The following subnode is constructed internally
    #  when the def statement is inside a Python class definition.
    #
    #  assmt   AssignmentNode   Function construction/assignment
    
1225
    child_attrs = ["args", "star_arg", "starstar_arg", "body", "decorators"]
1226

William Stein's avatar
William Stein committed
1227
    assmt = None
1228
    num_kwonly_args = 0
1229
    num_required_kw_args = 0
1230
    reqd_kw_flags_cname = "0"
1231
    is_wrapper = 0
1232 1233
    decorators = None

1234 1235
    def __init__(self, pos, **kwds):
        FuncDefNode.__init__(self, pos, **kwds)
1236
        k = rk = r = 0
1237 1238
        for arg in self.args:
            if arg.kw_only:
1239
                k += 1
1240
                if not arg.default:
1241 1242 1243 1244 1245 1246
                    rk += 1
            if not arg.default:
                r += 1
        self.num_kwonly_args = k
        self.num_required_kw_args = rk
        self.num_required_args = r
William Stein's avatar
William Stein committed
1247
    
1248 1249
    entry = None
    
William Stein's avatar
William Stein committed
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
    def analyse_declarations(self, env):
        for arg in self.args:
            base_type = arg.base_type.analyse(env)
            name_declarator, type = \
                arg.declarator.analyse(base_type, env)
            arg.name = name_declarator.name
            if name_declarator.cname:
                error(self.pos,
                    "Python function argument cannot have C name specification")
            arg.type = type.as_argument_type()
            arg.hdr_type = None
            arg.needs_conversion = 0
            arg.needs_type_test = 0
            arg.is_generic = 1
            if arg.not_none and not arg.type.is_extension_type:
                error(self.pos,
                    "Only extension type arguments can have 'not None'")
        self.declare_pyfunction(env)
        self.analyse_signature(env)
        self.return_type = self.entry.signature.return_type()
1270 1271 1272
        if self.signature_has_generic_args():
            if self.star_arg:
                env.use_utility_code(get_stararg_utility_code)
1273 1274
            elif self.signature_has_generic_args():
                env.use_utility_code(raise_argtuple_too_long_utility_code)
1275 1276 1277 1278
            if not self.signature_has_nongeneric_args():
                env.use_utility_code(get_keyword_string_check_utility_code)
            elif self.starstar_arg:
                env.use_utility_code(get_splitkeywords_utility_code)
1279
        if self.num_required_kw_args:
1280 1281
            env.use_utility_code(get_checkkeywords_utility_code)

William Stein's avatar
William Stein committed
1282 1283
    def analyse_signature(self, env):
        any_type_tests_needed = 0
1284
        # Use the simpler calling signature for zero- and one-argument functions.
1285
        if not self.entry.is_special and not self.star_arg and not self.starstar_arg:
1286
            if self.entry.signature is TypeSlots.pyfunction_signature and Options.optimize_simple_methods:
1287 1288
                if len(self.args) == 0:
                    self.entry.signature = TypeSlots.pyfunction_noargs
1289 1290 1291
                elif len(self.args) == 1:
                    if self.args[0].default is None and not self.args[0].kw_only:
                        self.entry.signature = TypeSlots.pyfunction_onearg
1292 1293 1294
            elif self.entry.signature is TypeSlots.pymethod_signature:
                if len(self.args) == 1:
                    self.entry.signature = TypeSlots.unaryfunc
1295 1296 1297
                elif len(self.args) == 2:
                    if self.args[1].default is None and not self.args[1].kw_only:
                        self.entry.signature = TypeSlots.ibinaryfunc
1298 1299
        elif self.entry.is_special:
            self.entry.trivial_signature = len(self.args) == 1 and not (self.star_arg or self.starstar_arg)
William Stein's avatar
William Stein committed
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
        sig = self.entry.signature
        nfixed = sig.num_fixed_args()
        for i in range(nfixed):
            if i < len(self.args):
                arg = self.args[i]
                arg.is_generic = 0
                if sig.is_self_arg(i):
                    arg.is_self_arg = 1
                    arg.hdr_type = arg.type = env.parent_type
                    arg.needs_conversion = 0
                else:
                    arg.hdr_type = sig.fixed_arg_type(i)
                    if not arg.type.same_as(arg.hdr_type):
                        if arg.hdr_type.is_pyobject and arg.type.is_pyobject:
                            arg.needs_type_test = 1
                            any_type_tests_needed = 1
                        else:
                            arg.needs_conversion = 1
                if arg.needs_conversion:
                    arg.hdr_cname = Naming.arg_prefix + arg.name
                else:
                    arg.hdr_cname = Naming.var_prefix + arg.name
            else:
                self.bad_signature()
                return
        if nfixed < len(self.args):
            if not sig.has_generic_args:
                self.bad_signature()
            for arg in self.args:
Robert Bradshaw's avatar
Robert Bradshaw committed
1329 1330
                if arg.is_generic and \
                        (arg.type.is_extension_type or arg.type.is_builtin_type):
William Stein's avatar
William Stein committed
1331 1332
                    arg.needs_type_test = 1
                    any_type_tests_needed = 1
1333 1334 1335 1336 1337 1338
                elif arg.type is PyrexTypes.c_py_ssize_t_type:
                    # Want to use __index__ rather than __int__ method
                    # that PyArg_ParseTupleAndKeywords calls
                    arg.needs_conversion = 1
                    arg.hdr_type = PyrexTypes.py_object_type
                    arg.hdr_cname = Naming.arg_prefix + arg.name
William Stein's avatar
William Stein committed
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
        if any_type_tests_needed:
            env.use_utility_code(arg_type_test_utility_code)
    
    def bad_signature(self):
        sig = self.entry.signature
        expected_str = "%d" % sig.num_fixed_args()
        if sig.has_generic_args:
            expected_str = expected_str + " or more"
        name = self.name
        if name.startswith("__") and name.endswith("__"):
            desc = "Special method"
        else:
            desc = "Method"
        error(self.pos,
            "%s %s has wrong number of arguments "
            "(%d declared, %s expected)" % (
                desc, self.name, len(self.args), expected_str))
1356 1357 1358

    def signature_has_nongeneric_args(self):
        argcount = len(self.args)
Stefan Behnel's avatar
Stefan Behnel committed
1359
        if argcount == 0 or (argcount == 1 and self.args[0].is_self_arg):
1360 1361 1362 1363 1364
            return 0
        return 1

    def signature_has_generic_args(self):
        return self.entry.signature.has_generic_args
William Stein's avatar
William Stein committed
1365 1366
    
    def declare_pyfunction(self, env):
1367 1368
        #print "DefNode.declare_pyfunction:", self.name, "in", env ###
        name = self.name
1369 1370 1371
        entry = env.lookup_here(self.name)
        if entry and entry.type.is_cfunction and not self.is_wrapper:
            warning(self.pos, "Overriding cdef method with def method.", 5)
1372 1373 1374 1375
        entry = env.declare_pyfunction(self.name, self.pos)
        self.entry = entry
        prefix = env.scope_prefix
        entry.func_cname = \
1376
            Naming.pyfunc_prefix + prefix + name
1377 1378
        entry.pymethdef_cname = \
            Naming.pymethdef_prefix + prefix + name
1379 1380
        if Options.docstrings:
            entry.doc = embed_position(self.pos, self.doc)
1381 1382
            entry.doc_cname = \
                Naming.funcdoc_prefix + prefix + name
1383 1384
        else:
            entry.doc = None
1385

William Stein's avatar
William Stein committed
1386 1387 1388 1389 1390 1391
    def declare_arguments(self, env):
        for arg in self.args:
            if not arg.name:
                error(arg.pos, "Missing argument name")
            if arg.needs_conversion:
                arg.entry = env.declare_var(arg.name, arg.type, arg.pos)
1392 1393
                env.control_flow.set_state((), (arg.name, 'source'), 'arg')
                env.control_flow.set_state((), (arg.name, 'initalized'), True)
William Stein's avatar
William Stein committed
1394 1395 1396 1397 1398
                if arg.type.is_pyobject:
                    arg.entry.init = "0"
                arg.entry.init_to_none = 0
            else:
                arg.entry = self.declare_argument(env, arg)
1399
            arg.entry.used = 1
William Stein's avatar
William Stein committed
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
            arg.entry.is_self_arg = arg.is_self_arg
            if arg.hdr_type:
                if arg.is_self_arg or \
                    (arg.type.is_extension_type and not arg.hdr_type.is_extension_type):
                        arg.entry.is_declared_generic = 1
        self.declare_python_arg(env, self.star_arg)
        self.declare_python_arg(env, self.starstar_arg)

    def declare_python_arg(self, env, arg):
        if arg:
1410
            entry = env.declare_var(arg.name, 
William Stein's avatar
William Stein committed
1411
                PyrexTypes.py_object_type, arg.pos)
1412 1413 1414 1415 1416
            entry.used = 1
            entry.init = "0"
            entry.init_to_none = 0
            entry.xdecref_cleanup = 1
            arg.entry = entry
1417
            env.control_flow.set_state((), (arg.name, 'initalized'), True)
William Stein's avatar
William Stein committed
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
            
    def analyse_expressions(self, env):
        self.analyse_default_values(env)
        if env.is_py_class_scope:
            self.synthesize_assignment_node(env)
    
    def synthesize_assignment_node(self, env):
        import ExprNodes
        self.assmt = SingleAssignmentNode(self.pos,
            lhs = ExprNodes.NameNode(self.pos, name = self.name),
            rhs = ExprNodes.UnboundMethodNode(self.pos, 
                class_cname = env.class_obj_cname,
                function = ExprNodes.PyCFunctionNode(self.pos,
                    pymethdef_cname = self.entry.pymethdef_cname)))
        self.assmt.analyse_declarations(env)
        self.assmt.analyse_expressions(env)
            
1435
    def generate_function_header(self, code, with_pymethdef, proto_only=0):
William Stein's avatar
William Stein committed
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
        arg_code_list = []
        sig = self.entry.signature
        if sig.has_dummy_arg:
            arg_code_list.append(
                "PyObject *%s" % Naming.self_cname)
        for arg in self.args:
            if not arg.is_generic:
                if arg.is_self_arg:
                    arg_code_list.append("PyObject *%s" % arg.hdr_cname)
                else:
                    arg_code_list.append(
                        arg.hdr_type.declaration_code(arg.hdr_cname))
1448
        if not self.entry.is_special and sig.method_flags() == [TypeSlots.method_noargs]:
1449
            arg_code_list.append("PyObject *unused")
William Stein's avatar
William Stein committed
1450 1451 1452 1453 1454 1455 1456 1457
        if sig.has_generic_args:
            arg_code_list.append(
                "PyObject *%s, PyObject *%s"
                    % (Naming.args_cname, Naming.kwds_cname))
        arg_code = ", ".join(arg_code_list)
        dc = self.return_type.declaration_code(self.entry.func_cname)
        header = "static %s(%s)" % (dc, arg_code)
        code.putln("%s; /*proto*/" % header)
1458 1459
        if proto_only:
            return
1460
        if self.entry.doc and Options.docstrings:
William Stein's avatar
William Stein committed
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
            code.putln(
                'static char %s[] = "%s";' % (
                    self.entry.doc_cname,
                    self.entry.doc))
        if with_pymethdef:
            code.put(
                "static PyMethodDef %s = " % 
                    self.entry.pymethdef_cname)
            code.put_pymethoddef(self.entry, ";")
        code.putln("%s {" % header)

    def generate_argument_declarations(self, env, code):
        for arg in self.args:
            if arg.is_generic: # or arg.needs_conversion:
1475 1476 1477 1478
                if arg.needs_conversion:
                    code.putln("PyObject *%s = 0;" % arg.hdr_cname)
                else:
                    code.put_var_declaration(arg.entry)
William Stein's avatar
William Stein committed
1479 1480
    
    def generate_keyword_list(self, code):
1481 1482
        if self.signature_has_generic_args() and \
                self.signature_has_nongeneric_args():
1483 1484
            reqd_kw_flags = []
            has_reqd_kwds = False
William Stein's avatar
William Stein committed
1485
            code.put(
1486
                "static char *%s[] = {" %
William Stein's avatar
William Stein committed
1487 1488 1489 1490 1491 1492
                    Naming.kwdlist_cname)
            for arg in self.args:
                if arg.is_generic:
                    code.put(
                        '"%s",' % 
                            arg.name)
1493 1494 1495 1496 1497 1498
                    if arg.kw_only and not arg.default:
                        has_reqd_kwds = 1
                        flag = "1"
                    else:
                        flag = "0"
                    reqd_kw_flags.append(flag)
William Stein's avatar
William Stein committed
1499 1500
            code.putln(
                "0};")
1501 1502 1503 1504 1505 1506 1507 1508
            if has_reqd_kwds:
                flags_name = Naming.reqd_kwds_cname
                self.reqd_kw_flags_cname = flags_name
                code.putln(
                    "static char %s[] = {%s};" % (
                        flags_name,
                        ",".join(reqd_kw_flags)))

1509
    def generate_argument_parsing_code(self, env, code):
William Stein's avatar
William Stein committed
1510 1511
        # Generate PyArg_ParseTuple call for generic
        # arguments, if any.
1512 1513 1514 1515
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
        end_label = code.new_label()

1516 1517 1518
        has_kwonly_args = self.num_kwonly_args > 0
        has_star_or_kw_args = self.star_arg is not None \
            or self.starstar_arg is not None or has_kwonly_args
1519
            
1520
        if not self.signature_has_generic_args():
1521 1522
            if has_star_or_kw_args:
                error(self.pos, "This method cannot have * or keyword arguments")
1523
            self.generate_argument_conversion_code(code)
1524
            
1525 1526
        elif not self.signature_has_nongeneric_args():
            # func(*args) or func(**kw) or func(*args, **kw)
1527
            self.generate_stararg_copy_code(code)
1528
            
1529
        else:
William Stein's avatar
William Stein committed
1530 1531
            arg_addrs = []
            arg_formats = []
1532
            positional_args = []
William Stein's avatar
William Stein committed
1533 1534 1535 1536 1537 1538 1539 1540
            default_seen = 0
            for arg in self.args:
                arg_entry = arg.entry
                if arg.is_generic:
                    if arg.default:
                        code.putln(
                            "%s = %s;" % (
                                arg_entry.cname,
1541
                                arg.default_result_code))
William Stein's avatar
William Stein committed
1542 1543 1544
                        if not default_seen:
                            arg_formats.append("|")
                        default_seen = 1
1545 1546
                        if not arg.is_self_arg and not arg.kw_only:
                            positional_args.append(arg)
1547 1548 1549 1550
                    elif arg.kw_only:
                        if not default_seen:
                            arg_formats.append("|")
                        default_seen = 1
1551
                    elif default_seen:
William Stein's avatar
William Stein committed
1552
                        error(arg.pos, "Non-default argument following default argument")
1553 1554
                    elif not arg.is_self_arg:
                        positional_args.append(arg)
1555 1556 1557 1558 1559 1560
                    if arg.needs_conversion:
                        arg_addrs.append("&" + arg.hdr_cname)
                        format = arg.hdr_type.parsetuple_format
                    else:
                        arg_addrs.append("&" + arg_entry.cname)
                        format = arg_entry.type.parsetuple_format
William Stein's avatar
William Stein committed
1561 1562 1563 1564
                    if format:
                        arg_formats.append(format)
                    else:
                        error(arg.pos, 
1565
                            "Cannot convert Python object argument to type '%s' (when parsing input arguments)" 
William Stein's avatar
William Stein committed
1566
                                % arg.type)
1567

1568
            if has_star_or_kw_args:
William Stein's avatar
William Stein committed
1569
                self.generate_stararg_getting_code(code)
1570 1571 1572 1573

            self.generate_argument_tuple_parsing_code(
                positional_args, arg_formats, arg_addrs, code)

1574 1575
        code.error_label = old_error_label
        if code.label_used(our_error_label):
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
            code.put_goto(end_label)
            code.put_label(our_error_label)
            if has_star_or_kw_args:
                self.put_stararg_decrefs(code)
                self.generate_arg_decref(self.star_arg, code)
                if self.starstar_arg:
                    if self.starstar_arg.entry.xdecref_cleanup:
                        code.put_var_xdecref(self.starstar_arg.entry)
                    else:
                        code.put_var_decref(self.starstar_arg.entry)
1586
            code.putln('__Pyx_AddTraceback("%s");' % self.entry.qualified_name)
1587 1588 1589 1590 1591 1592 1593
            code.putln("return %s;" % self.error_value())
            code.put_label(end_label)

    def generate_argument_tuple_parsing_code(self, positional_args,
                                             arg_formats, arg_addrs, code):
        # Unpack inplace if it's simple
        if not self.num_required_kw_args:
1594 1595 1596 1597 1598
            min_positional_args = self.num_required_args - self.num_required_kw_args
            max_positional_args = len(positional_args)
            if len(self.args) > 0 and self.args[0].is_self_arg:
                min_positional_args -= 1
            if max_positional_args == min_positional_args:
1599
                count_cond = "likely(PyTuple_GET_SIZE(%s) == %s)" % (
1600
                    Naming.args_cname, max_positional_args)
1601
            else:
1602
                count_cond = "likely(%s <= PyTuple_GET_SIZE(%s)) && likely(PyTuple_GET_SIZE(%s) <= %s)" % (
1603
                               min_positional_args,
1604 1605
                               Naming.args_cname,
                               Naming.args_cname,
1606
                               max_positional_args)
1607
            code.putln(
1608
                'if (likely(!%s) && %s) {' % (Naming.kwds_cname, count_cond))
1609
            i = 0
1610 1611
            closing = 0
            for arg in positional_args:
1612 1613
                if arg.default:
                    code.putln('if (PyTuple_GET_SIZE(%s) > %s) {' % (Naming.args_cname, i))
1614
                    closing += 1
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
                item = "PyTuple_GET_ITEM(%s, %s)" % (Naming.args_cname, i)
                if arg.type.is_pyobject:
                    if arg.is_generic:
                        item = PyrexTypes.typecast(arg.type, PyrexTypes.py_object_type, item)
                    code.putln("%s = %s;" % (arg.entry.cname, item))
                else:
                    func = arg.type.from_py_function
                    if func:
                        code.putln("%s = %s(%s); %s" % (
                            arg.entry.cname,
                            func,
                            item,
                            code.error_goto_if(arg.type.error_condition(arg.entry.cname), arg.pos)))
                    else:
                        error(arg.pos, "Cannot convert Python object argument to type '%s'" % arg.type)
                i += 1
1631
            for _ in range(closing):
1632 1633 1634
                code.putln('}')
            code.putln(
                '}')
1635 1636 1637
            code.putln('else {')

        argformat = '"%s"' % string.join(arg_formats, "")
1638
        pt_arglist = [Naming.args_cname, Naming.kwds_cname, argformat, Naming.kwdlist_cname] + arg_addrs
1639 1640 1641 1642 1643 1644 1645 1646 1647
        pt_argstring = string.join(pt_arglist, ", ")
        code.putln(
            'if (unlikely(!PyArg_ParseTupleAndKeywords(%s))) %s' % (
                pt_argstring,
                code.error_goto(self.pos)))
        self.generate_argument_conversion_code(code)

        if not self.num_required_kw_args:
            code.putln('}')
1648

William Stein's avatar
William Stein committed
1649
    def put_stararg_decrefs(self, code):
1650 1651 1652
        if self.star_arg:
            code.put_decref(Naming.args_cname, py_object_type)
        if self.starstar_arg:
William Stein's avatar
William Stein committed
1653 1654 1655 1656 1657 1658
            code.put_xdecref(Naming.kwds_cname, py_object_type)
    
    def generate_arg_xdecref(self, arg, code):
        if arg:
            code.put_var_xdecref(arg.entry)
    
1659 1660 1661 1662
    def generate_arg_decref(self, arg, code):
        if arg:
            code.put_var_decref(arg.entry)
    
William Stein's avatar
William Stein committed
1663 1664 1665 1666 1667 1668
    def arg_address(self, arg):
        if arg:
            return "&%s" % arg.entry.cname
        else:
            return 0

1669 1670
    def generate_stararg_copy_code(self, code):
        if not self.star_arg:
1671
            self.generate_positional_args_check(code, 0)
1672 1673
        self.generate_keyword_args_check(code)

1674
        if self.starstar_arg:
1675
            code.putln("%s = (%s) ? PyDict_Copy(%s) : PyDict_New();" % (
1676 1677 1678
                    self.starstar_arg.entry.cname,
                    Naming.kwds_cname,
                    Naming.kwds_cname))
1679 1680
            code.putln("if (unlikely(!%s)) return %s;" % (
                    self.starstar_arg.entry.cname, self.error_value()))
1681 1682 1683
            self.starstar_arg.entry.xdecref_cleanup = 0
            self.starstar_arg = None

1684 1685 1686 1687 1688 1689 1690 1691
        if self.star_arg:
            code.put_incref(Naming.args_cname, py_object_type)
            code.putln("%s = %s;" % (
                    self.star_arg.entry.cname,
                    Naming.args_cname))
            self.star_arg.entry.xdecref_cleanup = 0
            self.star_arg = None

William Stein's avatar
William Stein committed
1692
    def generate_stararg_getting_code(self, code):
1693
        num_kwonly = self.num_kwonly_args
1694 1695
        fixed_args = self.entry.signature.num_fixed_args()
        nargs = len(self.args) - num_kwonly - fixed_args
Stefan Behnel's avatar
Stefan Behnel committed
1696
        error_return = "return %s;" % self.error_value()
1697

1698
        if self.star_arg:
1699
            star_arg_cname = self.star_arg.entry.cname
1700
            code.putln("if (likely(PyTuple_GET_SIZE(%s) <= %d)) {" % (
1701 1702
                    Naming.args_cname, nargs))
            code.put_incref(Naming.args_cname, py_object_type)
1703
            code.put("%s = %s; " % (star_arg_cname, Naming.empty_tuple))
1704 1705 1706
            code.put_incref(Naming.empty_tuple, py_object_type)
            code.putln("}")
            code.putln("else {")
1707
            code.putln(
1708
                "if (unlikely(__Pyx_SplitStarArg(&%s, %d, &%s) < 0)) return %s;" % (
1709 1710
                    Naming.args_cname,
                    nargs,
1711
                    star_arg_cname,
1712
                    self.error_value()))
1713
            code.putln("}")
1714
            self.star_arg.entry.xdecref_cleanup = 0
1715
        elif self.signature_has_generic_args():
Stefan Behnel's avatar
Stefan Behnel committed
1716 1717 1718
            # make sure supernumerous positional arguments do not run
            # into keyword-only arguments and provide a more helpful
            # message than PyArg_ParseTupelAndKeywords()
1719
            self.generate_positional_args_check(code, nargs)
1720 1721 1722 1723 1724

        handle_error = 0
        if self.starstar_arg:
            handle_error = 1
            code.put(
1725
                "if (unlikely(__Pyx_SplitKeywords(&%s, %s, &%s, %s) < 0)) " % (
1726 1727
                    Naming.kwds_cname,
                    Naming.kwdlist_cname,
1728
                    self.starstar_arg.entry.cname,
1729
                    self.reqd_kw_flags_cname))
1730
            self.starstar_arg.entry.xdecref_cleanup = 0
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
        elif self.num_required_kw_args:
            handle_error = 1
            code.put("if (unlikely(__Pyx_CheckRequiredKeywords(%s, %s, %s) < 0)) " % (
                    Naming.kwds_cname,
                    Naming.kwdlist_cname,
                    self.reqd_kw_flags_cname))

        if handle_error:
            if self.star_arg:
                code.putln("{")
                code.put_decref(Naming.args_cname, py_object_type)
                code.put_decref(self.star_arg.entry.cname, py_object_type)
                code.putln(error_return)
                code.putln("}")
            else:
                code.putln(error_return)
1747

1748 1749 1750
    def generate_positional_args_check(self, code, nargs):
        code.putln("if (unlikely(PyTuple_GET_SIZE(%s) > %d)) {" % (
                Naming.args_cname, nargs))
1751 1752
        code.putln("__Pyx_RaiseArgtupleTooLong(%d, PyTuple_GET_SIZE(%s));" % (
                nargs, Naming.args_cname))
1753 1754 1755
        code.putln("return %s;" % self.error_value())
        code.putln("}")

1756 1757 1758 1759 1760 1761 1762
    def generate_keyword_args_check(self, code):
        code.putln("if (unlikely(%s)) {" % Naming.kwds_cname)
        code.putln("if (unlikely(!__Pyx_CheckKeywordStrings(%s, \"%s\", %d))) return %s;" % (
                Naming.kwds_cname, self.name,
                bool(self.starstar_arg), self.error_value()))
        code.putln("}")

William Stein's avatar
William Stein committed
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
    def generate_argument_conversion_code(self, code):
        # Generate code to convert arguments from
        # signature type to declared type, if needed.
        for arg in self.args:
            if arg.needs_conversion:
                self.generate_arg_conversion(arg, code)

    def generate_arg_conversion(self, arg, code):
        # Generate conversion code for one argument.
        old_type = arg.hdr_type
        new_type = arg.type
        if old_type.is_pyobject:
Robert Bradshaw's avatar
Robert Bradshaw committed
1775 1776 1777 1778
            if arg.default:
                code.putln("if (%s) {" % arg.hdr_cname)
            else:
                code.putln("assert(%s); {" % arg.hdr_cname)
William Stein's avatar
William Stein committed
1779
            self.generate_arg_conversion_from_pyobject(arg, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
1780
            code.putln("}")
William Stein's avatar
William Stein committed
1781 1782 1783 1784 1785 1786 1787 1788
        elif new_type.is_pyobject:
            self.generate_arg_conversion_to_pyobject(arg, code)
        else:
            if new_type.assignable_from(old_type):
                code.putln(
                    "%s = %s;" % (arg.entry.cname, arg.hdr_cname))
            else:
                error(arg.pos,
1789
                    "Cannot convert 1 argument from '%s' to '%s'" %
William Stein's avatar
William Stein committed
1790 1791 1792 1793 1794
                        (old_type, new_type))
    
    def generate_arg_conversion_from_pyobject(self, arg, code):
        new_type = arg.type
        func = new_type.from_py_function
1795
        # copied from CoerceFromPyTypeNode
William Stein's avatar
William Stein committed
1796
        if func:
Robert Bradshaw's avatar
Robert Bradshaw committed
1797
            code.putln("%s = %s(%s); %s" % (
William Stein's avatar
William Stein committed
1798 1799 1800
                arg.entry.cname,
                func,
                arg.hdr_cname,
1801
                code.error_goto_if(new_type.error_condition(arg.entry.cname), arg.pos)))
William Stein's avatar
William Stein committed
1802 1803 1804 1805 1806 1807 1808 1809 1810
        else:
            error(arg.pos, 
                "Cannot convert Python object argument to type '%s'" 
                    % new_type)
    
    def generate_arg_conversion_to_pyobject(self, arg, code):
        old_type = arg.hdr_type
        func = old_type.to_py_function
        if func:
Robert Bradshaw's avatar
Robert Bradshaw committed
1811
            code.putln("%s = %s(%s); %s" % (
William Stein's avatar
William Stein committed
1812 1813 1814
                arg.entry.cname,
                func,
                arg.hdr_cname,
Robert Bradshaw's avatar
Robert Bradshaw committed
1815
                code.error_goto_if_null(arg.entry.cname, arg.pos)))
William Stein's avatar
William Stein committed
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
        else:
            error(arg.pos,
                "Cannot convert argument of type '%s' to Python object"
                    % old_type)

    def generate_argument_type_tests(self, code):
        # Generate type tests for args whose signature
        # type is PyObject * and whose declared type is
        # a subtype thereof.
        for arg in self.args:
            if arg.needs_type_test:
                self.generate_arg_type_test(arg, code)
    
    def generate_arg_type_test(self, arg, code):
        # Generate type test for one argument.
        if arg.type.typeobj_is_available():
            typeptr_cname = arg.type.typeptr_cname
            arg_code = "((PyObject *)%s)" % arg.entry.cname
            code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
1835
                'if (unlikely(!__Pyx_ArgTypeTest(%s, %s, %d, "%s", %s))) %s' % (
William Stein's avatar
William Stein committed
1836 1837 1838 1839
                    arg_code, 
                    typeptr_cname,
                    not arg.not_none,
                    arg.name,
Robert Bradshaw's avatar
Robert Bradshaw committed
1840
                    arg.type.is_builtin_type,
William Stein's avatar
William Stein committed
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
                    code.error_goto(arg.pos)))
        else:
            error(arg.pos, "Cannot test type of extern C class "
                "without type object name specification")
    
    def error_value(self):
        return self.entry.signature.error_value
    
    def caller_will_check_exceptions(self):
        return 1
            
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
class OverrideCheckNode(StatNode):
    # A Node for dispatching to the def method if it
    # is overriden. 
    #
    #  py_func
    #
    #  args
    #  func_temp
    #  body
    
Robert Bradshaw's avatar
Robert Bradshaw committed
1862
    child_attrs = ['body']
1863 1864
    
    body = None
Robert Bradshaw's avatar
Robert Bradshaw committed
1865

1866 1867
    def analyse_expressions(self, env):
        self.args = env.arg_entries
1868 1869 1870 1871
        if self.py_func.is_module_scope:
            first_arg = 0
        else:
            first_arg = 1
1872 1873
        import ExprNodes
        self.func_node = ExprNodes.PyTempNode(self.pos, env)
1874
        call_tuple = ExprNodes.TupleNode(self.pos, args=[ExprNodes.NameNode(self.pos, name=arg.name) for arg in self.args[first_arg:]])
1875 1876
        call_node = ExprNodes.SimpleCallNode(self.pos,
                                             function=self.func_node, 
1877
                                             args=[ExprNodes.NameNode(self.pos, name=arg.name) for arg in self.args[first_arg:]])
1878 1879 1880 1881 1882
        self.body = ReturnStatNode(self.pos, value=call_node)
        self.body.analyse_expressions(env)
        
    def generate_execution_code(self, code):
        # Check to see if we are an extension type
1883 1884 1885 1886
        if self.py_func.is_module_scope:
            self_arg = "((PyObject *)%s)" % Naming.module_cname
        else:
            self_arg = "((PyObject *)%s)" % self.args[0].cname
1887 1888
        code.putln("/* Check if called by wrapper */")
        code.putln("if (unlikely(%s)) %s = 0;" % (Naming.skip_dispatch_cname, Naming.skip_dispatch_cname))
1889
        code.putln("/* Check if overriden in Python */")
1890 1891 1892
        if self.py_func.is_module_scope:
            code.putln("else {")
        else:
1893
            code.putln("else if (unlikely(Py_TYPE(%s)->tp_dictoffset != 0)) {" % self_arg)
1894
        err = code.error_goto_if_null(self.func_node.result_code, self.pos)
1895
        # need to get attribute manually--scope would return cdef method
1896
        code.putln("%s = PyObject_GetAttr(%s, %s); %s" % (self.func_node.result_code, self_arg, self.py_func.interned_attr_cname, err))
1897
        # It appears that this type is not anywhere exposed in the Python/C API
1898
        is_builtin_function_or_method = '(strcmp(Py_TYPE(%s)->tp_name, "builtin_function_or_method") == 0)' % self.func_node.result_code
Robert Bradshaw's avatar
Robert Bradshaw committed
1899
        is_overridden = '(PyCFunction_GET_FUNCTION(%s) != (void *)&%s)' % (self.func_node.result_code, self.py_func.entry.func_cname)
1900 1901 1902
        code.putln('if (!%s || %s) {' % (is_builtin_function_or_method, is_overridden))
        self.body.generate_execution_code(code)
        code.putln('}')
Robert Bradshaw's avatar
Robert Bradshaw committed
1903
        code.put_decref_clear(self.func_node.result_code, PyrexTypes.py_object_type)
1904 1905
        code.putln("}")

Robert Bradshaw's avatar
Robert Bradshaw committed
1906 1907
class ClassDefNode(StatNode, BlockNode):
    pass
1908

Robert Bradshaw's avatar
Robert Bradshaw committed
1909
class PyClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
1910 1911
    #  A Python class definition.
    #
Stefan Behnel's avatar
Stefan Behnel committed
1912
    #  name     EncodedString   Name of the class
William Stein's avatar
William Stein committed
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922
    #  doc      string or None
    #  body     StatNode        Attribute definition code
    #  entry    Symtab.Entry
    #  scope    PyClassScope
    #
    #  The following subnodes are constructed internally:
    #
    #  dict     DictNode   Class dictionary
    #  classobj ClassNode  Class object
    #  target   NameNode   Variable to assign class object to
1923 1924

    child_attrs = ["body", "dict", "classobj", "target"]
William Stein's avatar
William Stein committed
1925 1926 1927 1928 1929 1930 1931 1932
    
    def __init__(self, pos, name, bases, doc, body):
        StatNode.__init__(self, pos)
        self.name = name
        self.doc = doc
        self.body = body
        import ExprNodes
        self.dict = ExprNodes.DictNode(pos, key_value_pairs = [])
1933
        if self.doc and Options.docstrings:
1934
            doc = embed_position(self.pos, self.doc)
1935
            doc_node = ExprNodes.StringNode(pos, value = doc)
William Stein's avatar
William Stein committed
1936 1937
        else:
            doc_node = None
1938
        self.classobj = ExprNodes.ClassNode(pos, name = name,
William Stein's avatar
William Stein committed
1939 1940
            bases = bases, dict = self.dict, doc = doc_node)
        self.target = ExprNodes.NameNode(pos, name = name)
1941 1942 1943 1944 1945 1946 1947
        
    def create_scope(self, env):
        genv = env
        while env.is_py_class_scope or env.is_c_class_scope:
            env = env.outer_scope
        cenv = self.scope = PyClassScope(name = self.name, outer_scope = genv)
        return cenv
William Stein's avatar
William Stein committed
1948 1949 1950
    
    def analyse_declarations(self, env):
        self.target.analyse_target_declaration(env)
1951 1952 1953
        cenv = self.create_scope(env)
        cenv.class_obj_cname = self.target.entry.cname
        self.body.analyse_declarations(cenv)
William Stein's avatar
William Stein committed
1954 1955 1956 1957 1958
    
    def analyse_expressions(self, env):
        self.dict.analyse_expressions(env)
        self.classobj.analyse_expressions(env)
        genv = env.global_scope()
1959
        cenv = self.scope
William Stein's avatar
William Stein committed
1960
        cenv.class_dict_cname = self.dict.result_code
1961
        cenv.namespace_cname = cenv.class_obj_cname = self.classobj.result_code
William Stein's avatar
William Stein committed
1962
        self.body.analyse_expressions(cenv)
1963
        self.target.analyse_target_expression(env, self.classobj)
William Stein's avatar
William Stein committed
1964
        self.dict.release_temp(env)
1965 1966
        #self.classobj.release_temp(env)
        #self.target.release_target_temp(env)
William Stein's avatar
William Stein committed
1967
    
1968
    def generate_function_definitions(self, env, code, transforms):
William Stein's avatar
William Stein committed
1969 1970
        self.generate_py_string_decls(self.scope, code)
        self.body.generate_function_definitions(
1971
            self.scope, code, transforms)
William Stein's avatar
William Stein committed
1972 1973 1974 1975 1976 1977 1978 1979 1980
    
    def generate_execution_code(self, code):
        self.dict.generate_evaluation_code(code)
        self.classobj.generate_evaluation_code(code)
        self.body.generate_execution_code(code)
        self.target.generate_assignment_code(self.classobj, code)
        self.dict.generate_disposal_code(code)


Robert Bradshaw's avatar
Robert Bradshaw committed
1981
class CClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
1982 1983 1984 1985
    #  An extension type definition.
    #
    #  visibility         'private' or 'public' or 'extern'
    #  typedef_flag       boolean
Stefan Behnel's avatar
Stefan Behnel committed
1986
    #  api                boolean
William Stein's avatar
William Stein committed
1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
    #  module_name        string or None    For import of extern type objects
    #  class_name         string            Unqualified name of class
    #  as_name            string or None    Name to declare as in this scope
    #  base_class_module  string or None    Module containing the base class
    #  base_class_name    string or None    Name of the base class
    #  objstruct_name     string or None    Specified C name of object struct
    #  typeobj_name       string or None    Specified C name of type object
    #  in_pxd             boolean           Is in a .pxd file
    #  doc                string or None
    #  body               StatNode or None
    #  entry              Symtab.Entry
    #  base_type          PyExtensionType or None
    
2000 2001
    child_attrs = ["body"]

William Stein's avatar
William Stein committed
2002 2003 2004 2005 2006 2007 2008 2009
    def analyse_declarations(self, env):
        #print "CClassDefNode.analyse_declarations:", self.class_name
        #print "...visibility =", self.visibility
        #print "...module_name =", self.module_name
        if env.in_cinclude and not self.objstruct_name:
            error(self.pos, "Object struct name specification required for "
                "C class defined in 'extern from' block")
        self.base_type = None
2010 2011 2012 2013 2014 2015 2016 2017 2018
        # Now that module imports are cached, we need to 
        # import the modules for extern classes. 
        if self.module_name:
            self.module = None
            for module in env.cimported_modules:
                if module.name == self.module_name:
                    self.module = module
            if self.module is None:
                self.module = ModuleScope(self.module_name, None, env.context)
2019
                self.module.has_extern_class = 1
2020
                env.cimported_modules.append(self.module)
2021

William Stein's avatar
William Stein committed
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038
        if self.base_class_name:
            if self.base_class_module:
                base_class_scope = env.find_module(self.base_class_module, self.pos)
            else:
                base_class_scope = env
            if base_class_scope:
                base_class_entry = base_class_scope.find(self.base_class_name, self.pos)
                if base_class_entry:
                    if not base_class_entry.is_type:
                        error(self.pos, "'%s' is not a type name" % self.base_class_name)
                    elif not base_class_entry.type.is_extension_type:
                        error(self.pos, "'%s' is not an extension type" % self.base_class_name)
                    elif not base_class_entry.type.is_complete():
                        error(self.pos, "Base class '%s' is incomplete" % self.base_class_name)
                    else:
                        self.base_type = base_class_entry.type
        has_body = self.body is not None
2039
        if self.module_name and self.visibility != 'extern':
2040 2041 2042 2043 2044 2045 2046
            module_path = self.module_name.split(".")
            home_scope = env.find_imported_module(module_path, self.pos)
            if not home_scope:
                return
        else:
            home_scope = env
        self.entry = home_scope.declare_c_class(
William Stein's avatar
William Stein committed
2047 2048 2049 2050 2051 2052 2053 2054 2055
            name = self.class_name, 
            pos = self.pos,
            defining = has_body and self.in_pxd,
            implementing = has_body and not self.in_pxd,
            module_name = self.module_name,
            base_type = self.base_type,
            objstruct_cname = self.objstruct_name,
            typeobj_cname = self.typeobj_name,
            visibility = self.visibility,
Stefan Behnel's avatar
Stefan Behnel committed
2056 2057
            typedef_flag = self.typedef_flag,
            api = self.api)
2058 2059
        if home_scope is not env and self.visibility == 'extern':
            env.add_imported_entry(self.class_name, self.entry, pos)
William Stein's avatar
William Stein committed
2060
        scope = self.entry.type.scope
2061

2062
        if self.doc and Options.docstrings:
2063
            scope.doc = embed_position(self.pos, self.doc)
2064

William Stein's avatar
William Stein committed
2065 2066 2067 2068 2069 2070 2071 2072 2073 2074
        if has_body:
            self.body.analyse_declarations(scope)
            if self.in_pxd:
                scope.defined = 1
            else:
                scope.implemented = 1
        env.allocate_vtable_names(self.entry)
        
    def analyse_expressions(self, env):
        if self.body:
Robert Bradshaw's avatar
Robert Bradshaw committed
2075 2076
            scope = self.entry.type.scope
            self.body.analyse_expressions(scope)
William Stein's avatar
William Stein committed
2077
    
2078
    def generate_function_definitions(self, env, code, transforms):
2079
        self.generate_py_string_decls(self.entry.type.scope, code)
William Stein's avatar
William Stein committed
2080 2081
        if self.body:
            self.body.generate_function_definitions(
2082
                self.entry.type.scope, code, transforms)
William Stein's avatar
William Stein committed
2083 2084 2085 2086 2087 2088
    
    def generate_execution_code(self, code):
        # This is needed to generate evaluation code for
        # default values of method arguments.
        if self.body:
            self.body.generate_execution_code(code)
2089 2090 2091 2092
            
    def annotate(self, code):
        if self.body:
            self.body.annotate(code)
William Stein's avatar
William Stein committed
2093 2094 2095 2096 2097 2098


class PropertyNode(StatNode):
    #  Definition of a property in an extension type.
    #
    #  name   string
2099
    #  doc    EncodedString or None    Doc string
William Stein's avatar
William Stein committed
2100 2101
    #  body   StatListNode
    
2102 2103
    child_attrs = ["body"]

William Stein's avatar
William Stein committed
2104 2105 2106
    def analyse_declarations(self, env):
        entry = env.declare_property(self.name, self.doc, self.pos)
        if entry:
2107
            if self.doc and Options.docstrings:
2108 2109
                doc_entry = env.get_string_const(
                    self.doc, identifier = False)
William Stein's avatar
William Stein committed
2110 2111
                entry.doc_cname = doc_entry.cname
            self.body.analyse_declarations(entry.scope)
2112

William Stein's avatar
William Stein committed
2113 2114 2115
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
    
2116 2117
    def generate_function_definitions(self, env, code, transforms):
        self.body.generate_function_definitions(env, code, transforms)
William Stein's avatar
William Stein committed
2118 2119 2120 2121

    def generate_execution_code(self, code):
        pass

2122 2123 2124
    def annotate(self, code):
        self.body.annotate(code)

William Stein's avatar
William Stein committed
2125 2126 2127 2128 2129 2130

class GlobalNode(StatNode):
    # Global variable declaration.
    #
    # names    [string]
    
2131 2132
    child_attrs = []

William Stein's avatar
William Stein committed
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
    def analyse_declarations(self, env):
        for name in self.names:
            env.declare_global(name, self.pos)

    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        pass


class ExprStatNode(StatNode):
    #  Expression used as a statement.
    #
    #  expr   ExprNode
2148 2149

    child_attrs = ["expr"]
William Stein's avatar
William Stein committed
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
    
    def analyse_expressions(self, env):
        self.expr.analyse_expressions(env)
        self.expr.release_temp(env)
    
    def generate_execution_code(self, code):
        self.expr.generate_evaluation_code(code)
        if not self.expr.is_temp and self.expr.result_code:
            code.putln("%s;" % self.expr.result_code)
        self.expr.generate_disposal_code(code)

2161 2162 2163
    def annotate(self, code):
        self.expr.annotate(code)

William Stein's avatar
William Stein committed
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174

class AssignmentNode(StatNode):
    #  Abstract base class for assignment nodes.
    #
    #  The analyse_expressions and generate_execution_code
    #  phases of assignments are split into two sub-phases
    #  each, to enable all the right hand sides of a
    #  parallel assignment to be evaluated before assigning
    #  to any of the left hand sides.

    def analyse_expressions(self, env):
2175 2176 2177 2178 2179 2180 2181
        self.analyse_types(env)
        self.allocate_rhs_temps(env)
        self.allocate_lhs_temps(env)

#	def analyse_expressions(self, env):
#		self.analyse_expressions_1(env)
#		self.analyse_expressions_2(env)
William Stein's avatar
William Stein committed
2182 2183 2184 2185

    def generate_execution_code(self, code):
        self.generate_rhs_evaluation_code(code)
        self.generate_assignment_code(code)
2186
        
William Stein's avatar
William Stein committed
2187 2188 2189 2190 2191 2192 2193 2194

class SingleAssignmentNode(AssignmentNode):
    #  The simplest case:
    #
    #    a = b
    #
    #  lhs      ExprNode      Left hand side
    #  rhs      ExprNode      Right hand side
2195
    #  first    bool          Is this guaranteed the first assignment to lhs?
2196 2197
    
    child_attrs = ["lhs", "rhs"]
2198
    first = False
William Stein's avatar
William Stein committed
2199 2200 2201 2202

    def analyse_declarations(self, env):
        self.lhs.analyse_target_declaration(env)
    
2203
    def analyse_types(self, env, use_temp = 0):
William Stein's avatar
William Stein committed
2204 2205
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
2206
        self.lhs.gil_assignment_check(env)
William Stein's avatar
William Stein committed
2207 2208 2209
        self.rhs = self.rhs.coerce_to(self.lhs.type, env)
        if use_temp:
            self.rhs = self.rhs.coerce_to_temp(env)
2210 2211
    
    def allocate_rhs_temps(self, env):
William Stein's avatar
William Stein committed
2212
        self.rhs.allocate_temps(env)
2213 2214 2215 2216 2217

    def allocate_lhs_temps(self, env):
        self.lhs.allocate_target_temps(env, self.rhs)
        #self.lhs.release_target_temp(env)
        #self.rhs.release_temp(env)		
William Stein's avatar
William Stein committed
2218
    
2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
#	def analyse_expressions_1(self, env, use_temp = 0):
#		self.rhs.analyse_types(env)
#		self.lhs.analyse_target_types(env)
#		self.rhs = self.rhs.coerce_to(self.lhs.type, env)
#		if use_temp:
#			self.rhs = self.rhs.coerce_to_temp(env)
#		self.rhs.allocate_temps(env)
#	
#	def analyse_expressions_2(self, env):
#		self.lhs.allocate_target_temps(env)
#		self.lhs.release_target_temp(env)
#		self.rhs.release_temp(env)		
2231
        
William Stein's avatar
William Stein committed
2232 2233 2234 2235 2236 2237
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
    
    def generate_assignment_code(self, code):
        self.lhs.generate_assignment_code(self.rhs, code)

2238 2239 2240 2241
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)

William Stein's avatar
William Stein committed
2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254

class CascadedAssignmentNode(AssignmentNode):
    #  An assignment with multiple left hand sides:
    #
    #    a = b = c
    #
    #  lhs_list   [ExprNode]   Left hand sides
    #  rhs        ExprNode     Right hand sides
    #
    #  Used internally:
    #
    #  coerced_rhs_list   [ExprNode]   RHS coerced to type of each LHS
    
2255
    child_attrs = ["lhs_list", "rhs", "coerced_rhs_list"]
2256
    coerced_rhs_list = None
2257

William Stein's avatar
William Stein committed
2258 2259 2260 2261
    def analyse_declarations(self, env):
        for lhs in self.lhs_list:
            lhs.analyse_target_declaration(env)
    
2262
    def analyse_types(self, env, use_temp = 0):
William Stein's avatar
William Stein committed
2263 2264 2265 2266 2267 2268 2269 2270 2271
        self.rhs.analyse_types(env)
        if use_temp:
            self.rhs = self.rhs.coerce_to_temp(env)
        else:
            self.rhs = self.rhs.coerce_to_simple(env)
        from ExprNodes import CloneNode
        self.coerced_rhs_list = []
        for lhs in self.lhs_list:
            lhs.analyse_target_types(env)
2272
            lhs.gil_assignment_check(env)
William Stein's avatar
William Stein committed
2273 2274 2275
            rhs = CloneNode(self.rhs)
            rhs = rhs.coerce_to(lhs.type, env)
            self.coerced_rhs_list.append(rhs)
2276 2277 2278 2279 2280 2281

    def allocate_rhs_temps(self, env):
        self.rhs.allocate_temps(env)
    
    def allocate_lhs_temps(self, env):
        for lhs, rhs in zip(self.lhs_list, self.coerced_rhs_list):
William Stein's avatar
William Stein committed
2282
            rhs.allocate_temps(env)
2283 2284 2285
            lhs.allocate_target_temps(env, rhs)
            #lhs.release_target_temp(env)
            #rhs.release_temp(env)
William Stein's avatar
William Stein committed
2286
        self.rhs.release_temp(env)
2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
    
#	def analyse_expressions_1(self, env, use_temp = 0):
#		self.rhs.analyse_types(env)
#		if use_temp:
#			self.rhs = self.rhs.coerce_to_temp(env)
#		else:
#			self.rhs = self.rhs.coerce_to_simple(env)
#		self.rhs.allocate_temps(env)
#	
#	def analyse_expressions_2(self, env):
#		from ExprNodes import CloneNode
#		self.coerced_rhs_list = []
#		for lhs in self.lhs_list:
#			lhs.analyse_target_types(env)
#			rhs = CloneNode(self.rhs)
#			rhs = rhs.coerce_to(lhs.type, env)
#			self.coerced_rhs_list.append(rhs)
#			rhs.allocate_temps(env)
#			lhs.allocate_target_temps(env)
#			lhs.release_target_temp(env)
#			rhs.release_temp(env)
#		self.rhs.release_temp(env)
William Stein's avatar
William Stein committed
2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
    
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
    
    def generate_assignment_code(self, code):
        for i in range(len(self.lhs_list)):
            lhs = self.lhs_list[i]
            rhs = self.coerced_rhs_list[i]
            rhs.generate_evaluation_code(code)
            lhs.generate_assignment_code(rhs, code)
            # Assignment has disposed of the cloned RHS
        self.rhs.generate_disposal_code(code)

2322 2323 2324 2325 2326 2327 2328
    def annotate(self, code):
        for i in range(len(self.lhs_list)):
            lhs = self.lhs_list[i].annotate(code)
            rhs = self.coerced_rhs_list[i].annotate(code)
        self.rhs.annotate(code)
        

William Stein's avatar
William Stein committed
2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
class ParallelAssignmentNode(AssignmentNode):
    #  A combined packing/unpacking assignment:
    #
    #    a, b, c =  d, e, f
    #
    #  This has been rearranged by the parser into
    #
    #    a = d ; b = e ; c = f
    #
    #  but we must evaluate all the right hand sides
    #  before assigning to any of the left hand sides.
    #
    #  stats     [AssignmentNode]   The constituent assignments
    
2343 2344
    child_attrs = ["stats"]

William Stein's avatar
William Stein committed
2345 2346 2347 2348 2349 2350
    def analyse_declarations(self, env):
        for stat in self.stats:
            stat.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        for stat in self.stats:
2351 2352
            stat.analyse_types(env, use_temp = 1)
            stat.allocate_rhs_temps(env)
William Stein's avatar
William Stein committed
2353
        for stat in self.stats:
2354 2355 2356 2357 2358 2359 2360
            stat.allocate_lhs_temps(env)

#	def analyse_expressions(self, env):
#		for stat in self.stats:
#			stat.analyse_expressions_1(env, use_temp = 1)
#		for stat in self.stats:
#			stat.analyse_expressions_2(env)
William Stein's avatar
William Stein committed
2361 2362 2363 2364 2365 2366 2367
    
    def generate_execution_code(self, code):
        for stat in self.stats:
            stat.generate_rhs_evaluation_code(code)
        for stat in self.stats:
            stat.generate_assignment_code(code)

2368 2369 2370 2371 2372
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)


2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
class InPlaceAssignmentNode(AssignmentNode):
    #  An in place arithmatic operand:
    #
    #    a += b
    #    a -= b
    #    ...
    #
    #  lhs      ExprNode      Left hand side
    #  rhs      ExprNode      Right hand side
    #  op       char          one of "+-*/%^&|"
    #  dup     (ExprNode)     copy of lhs used for operation (auto-generated)
    #
    #  This code is a bit tricky because in order to obey Python 
    #  semantics the sub-expressions (e.g. indices) of the lhs must 
    #  not be evaluated twice. So we must re-use the values calculated 
    #  in evaluation phase for the assignment phase as well. 
    #  Fortunately, the type of the lhs node is fairly constrained 
    #  (it must be a NameNode, AttributeNode, or IndexNode).     
    
2392
    child_attrs = ["lhs", "rhs"]
2393
    dup = None
2394

2395 2396
    def analyse_declarations(self, env):
        self.lhs.analyse_target_declaration(env)
2397 2398 2399
        
    def analyse_types(self, env):
        self.dup = self.create_dup_node(env) # re-assigns lhs to a shallow copy
2400 2401
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
2402 2403
        if Options.incref_local_binop and self.dup.type.is_pyobject:
            self.dup = self.dup.coerce_to_temp(env)
2404 2405
        
    def allocate_rhs_temps(self, env):
2406
        import ExprNodes
2407 2408 2409
        if self.lhs.type.is_pyobject:
            self.rhs = self.rhs.coerce_to_pyobject(env)
        elif self.rhs.type.is_pyobject:
2410 2411
            self.rhs = self.rhs.coerce_to(self.lhs.type, env)
        if self.lhs.type.is_pyobject:
2412
             self.result = ExprNodes.PyTempNode(self.pos, env).coerce_to(self.lhs.type, env)
2413
             self.result.allocate_temps(env)
2414 2415
#        if use_temp:
#            self.rhs = self.rhs.coerce_to_temp(env)
2416
        self.rhs.allocate_temps(env)
2417 2418 2419
        self.dup.allocate_subexpr_temps(env)
        self.dup.allocate_temp(env)
    
2420
    def allocate_lhs_temps(self, env):
2421 2422
        self.lhs.allocate_target_temps(env, self.rhs)
#        self.lhs.release_target_temp(env)
2423 2424 2425
        self.dup.release_temp(env)
        if self.dup.is_temp:
            self.dup.release_subexpr_temps(env)
2426
#        self.rhs.release_temp(env)
2427 2428 2429 2430 2431 2432 2433
        if self.lhs.type.is_pyobject:
            self.result.release_temp(env)

    def generate_execution_code(self, code):
        self.rhs.generate_evaluation_code(code)
        self.dup.generate_subexpr_evaluation_code(code)
        self.dup.generate_result_code(code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2434 2435 2436 2437
        if self.operator == "**":
            extra = ", Py_None"
        else:
            extra = ""
2438 2439
        if self.lhs.type.is_pyobject:
            code.putln(
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2440
                "%s = %s(%s, %s%s); %s" % (
2441 2442 2443 2444
                    self.result.result_code, 
                    self.py_operation_function(), 
                    self.dup.py_result(),
                    self.rhs.py_result(),
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2445
                    extra,
Robert Bradshaw's avatar
Robert Bradshaw committed
2446
                    code.error_goto_if_null(self.result.py_result(), self.pos)))
2447
            self.result.generate_evaluation_code(code) # May be a type check...
2448 2449 2450 2451
            self.rhs.generate_disposal_code(code)
            self.dup.generate_disposal_code(code)
            self.lhs.generate_assignment_code(self.result, code)
        else: 
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2452 2453 2454 2455 2456 2457 2458 2459
            c_op = self.operator
            if c_op == "//":
                c_op = "/"
            elif c_op == "**":
                if self.lhs.type.is_int and self.rhs.type.is_int:
                    error(self.pos, "** with two C int types is ambiguous")
                else:
                    error(self.pos, "No C inplace power operator")
2460
            # have to do assignment directly to avoid side-effects
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2461
            code.putln("%s %s= %s;" % (self.lhs.result_code, c_op, self.rhs.result_code) )
2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
            self.rhs.generate_disposal_code(code)
        if self.dup.is_temp:
            self.dup.generate_subexpr_disposal_code(code)
            
    def create_dup_node(self, env): 
        import ExprNodes
        self.dup = self.lhs
        self.dup.analyse_types(env)
        if isinstance(self.lhs, ExprNodes.NameNode):
            target_lhs = ExprNodes.NameNode(self.dup.pos, name = self.dup.name, is_temp = self.dup.is_temp, entry = self.dup.entry)
        elif isinstance(self.lhs, ExprNodes.AttributeNode):
            target_lhs = ExprNodes.AttributeNode(self.dup.pos, obj = ExprNodes.CloneNode(self.lhs.obj), attribute = self.dup.attribute, is_temp = self.dup.is_temp)
        elif isinstance(self.lhs, ExprNodes.IndexNode):
            target_lhs = ExprNodes.IndexNode(self.dup.pos, base = ExprNodes.CloneNode(self.dup.base), index = ExprNodes.CloneNode(self.lhs.index), is_temp = self.dup.is_temp)
        self.lhs = target_lhs
2477
        return self.dup
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
    
    def py_operation_function(self):
        return self.py_functions[self.operator]

    py_functions = {
        "|":		"PyNumber_InPlaceOr",
        "^":		"PyNumber_InPlaceXor",
        "&":		"PyNumber_InPlaceAnd",
        "+":		"PyNumber_InPlaceAdd",
        "-":		"PyNumber_InPlaceSubtract",
        "*":		"PyNumber_InPlaceMultiply",
        "/":		"PyNumber_InPlaceDivide",
        "%":		"PyNumber_InPlaceRemainder",
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2491 2492 2493 2494
        "<<":		"PyNumber_InPlaceLshift",
        ">>":		"PyNumber_InPlaceRshift",
        "**":		"PyNumber_InPlacePower",
        "//":		"PyNumber_InPlaceFloorDivide",
2495 2496
    }

2497 2498 2499 2500 2501
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)
        self.dup.annotate(code)

William Stein's avatar
William Stein committed
2502 2503 2504 2505

class PrintStatNode(StatNode):
    #  print statement
    #
2506
    #  arg_tuple         TupleNode
2507
    #  append_newline    boolean
2508 2509 2510

    child_attrs = ["arg_tuple"]

William Stein's avatar
William Stein committed
2511
    def analyse_expressions(self, env):
2512
        self.arg_tuple.analyse_expressions(env)
2513 2514
        self.arg_tuple = self.arg_tuple.coerce_to_pyobject(env)
        self.arg_tuple.release_temp(env)
2515
        env.use_utility_code(printing_utility_code)
2516 2517 2518
        self.gil_check(env)

    gil_message = "Python print statement"
2519

William Stein's avatar
William Stein committed
2520
    def generate_execution_code(self, code):
2521
        self.arg_tuple.generate_evaluation_code(code)
2522 2523 2524
        code.putln(
            "if (__Pyx_Print(%s, %d) < 0) %s" % (
                self.arg_tuple.py_result(),
2525
                self.append_newline,
2526
                code.error_goto(self.pos)))
2527
        self.arg_tuple.generate_disposal_code(code)
2528

2529
    def annotate(self, code):
2530
        self.arg_tuple.annotate(code)
William Stein's avatar
William Stein committed
2531 2532 2533 2534 2535 2536 2537


class DelStatNode(StatNode):
    #  del statement
    #
    #  args     [ExprNode]
    
2538 2539
    child_attrs = ["args"]

William Stein's avatar
William Stein committed
2540 2541 2542 2543 2544 2545
    def analyse_declarations(self, env):
        for arg in self.args:
            arg.analyse_target_declaration(env)
    
    def analyse_expressions(self, env):
        for arg in self.args:
2546
            arg.analyse_target_expression(env, None)
2547 2548 2549
            if arg.type.is_pyobject:
                self.gil_check(env)
            else:
William Stein's avatar
William Stein committed
2550
                error(arg.pos, "Deletion of non-Python object")
2551
            #arg.release_target_temp(env)
2552 2553 2554

    gil_message = "Deleting Python object"

William Stein's avatar
William Stein committed
2555 2556 2557 2558 2559 2560
    def generate_execution_code(self, code):
        for arg in self.args:
            if arg.type.is_pyobject:
                arg.generate_deletion_code(code)
            # else error reported earlier

2561 2562 2563 2564
    def annotate(self, code):
        for arg in self.args:
            arg.annotate(code)

William Stein's avatar
William Stein committed
2565 2566 2567

class PassStatNode(StatNode):
    #  pass statement
2568 2569

    child_attrs = []
William Stein's avatar
William Stein committed
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
    
    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        pass


class BreakStatNode(StatNode):

2580 2581
    child_attrs = []

William Stein's avatar
William Stein committed
2582 2583 2584 2585 2586 2587 2588
    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        if not code.break_label:
            error(self.pos, "break statement not inside loop")
        else:
2589 2590 2591 2592
            #code.putln(
            #	"goto %s;" %
            #		code.break_label)
            code.put_goto(code.break_label)
William Stein's avatar
William Stein committed
2593 2594 2595 2596


class ContinueStatNode(StatNode):

2597 2598
    child_attrs = []

William Stein's avatar
William Stein committed
2599 2600 2601 2602 2603 2604 2605 2606 2607
    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        if code.in_try_finally:
            error(self.pos, "continue statement inside try of try...finally")
        elif not code.continue_label:
            error(self.pos, "continue statement not inside loop")
        else:
2608
            code.put_goto(code.continue_label)
William Stein's avatar
William Stein committed
2609 2610 2611 2612 2613 2614 2615 2616 2617


class ReturnStatNode(StatNode):
    #  return statement
    #
    #  value         ExprNode or None
    #  return_type   PyrexType
    #  temps_in_use  [Entry]            Temps in use at time of return
    
2618 2619
    child_attrs = ["value"]

William Stein's avatar
William Stein committed
2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
    def analyse_expressions(self, env):
        return_type = env.return_type
        self.return_type = return_type
        self.temps_in_use = env.temps_in_use()
        if not return_type:
            error(self.pos, "Return not inside a function body")
            return
        if self.value:
            self.value.analyse_types(env)
            if return_type.is_void or return_type.is_returncode:
                error(self.value.pos, 
                    "Return with value in void function")
            else:
                self.value = self.value.coerce_to(env.return_type, env)
            self.value.allocate_temps(env)
            self.value.release_temp(env)
        else:
            if (not return_type.is_void
                and not return_type.is_pyobject
                and not return_type.is_returncode):
                    error(self.pos, "Return value required")
2641 2642 2643 2644 2645
        if return_type.is_pyobject:
            self.gil_check(env)

    gil_message = "Returning Python object"

William Stein's avatar
William Stein committed
2646
    def generate_execution_code(self, code):
2647
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666
        if not self.return_type:
            # error reported earlier
            return
        if self.value:
            self.value.generate_evaluation_code(code)
            self.value.make_owned_reference(code)
            code.putln(
                "%s = %s;" % (
                    Naming.retval_cname,
                    self.value.result_as(self.return_type)))
            self.value.generate_post_assignment_code(code)
        else:
            if self.return_type.is_pyobject:
                code.put_init_to_py_none(Naming.retval_cname, self.return_type)
            elif self.return_type.is_returncode:
                code.putln(
                    "%s = %s;" % (
                        Naming.retval_cname,
                        self.return_type.default_value))
2667 2668
        for entry in self.temps_in_use:
            code.put_var_decref_clear(entry)
2669 2670 2671 2672
        #code.putln(
        #	"goto %s;" %
        #		code.return_label)
        code.put_goto(code.return_label)
2673 2674 2675 2676
        
    def annotate(self, code):
        if self.value:
            self.value.annotate(code)
William Stein's avatar
William Stein committed
2677 2678 2679 2680 2681 2682 2683 2684 2685


class RaiseStatNode(StatNode):
    #  raise statement
    #
    #  exc_type    ExprNode or None
    #  exc_value   ExprNode or None
    #  exc_tb      ExprNode or None
    
2686 2687
    child_attrs = ["exc_type", "exc_value", "exc_tb"]

William Stein's avatar
William Stein committed
2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706
    def analyse_expressions(self, env):
        if self.exc_type:
            self.exc_type.analyse_types(env)
            self.exc_type = self.exc_type.coerce_to_pyobject(env)
            self.exc_type.allocate_temps(env)
        if self.exc_value:
            self.exc_value.analyse_types(env)
            self.exc_value = self.exc_value.coerce_to_pyobject(env)
            self.exc_value.allocate_temps(env)
        if self.exc_tb:
            self.exc_tb.analyse_types(env)
            self.exc_tb = self.exc_tb.coerce_to_pyobject(env)
            self.exc_tb.allocate_temps(env)
        if self.exc_type:
            self.exc_type.release_temp(env)
        if self.exc_value:
            self.exc_value.release_temp(env)
        if self.exc_tb:
            self.exc_tb.release_temp(env)
2707
        env.use_utility_code(raise_utility_code)
2708 2709 2710 2711
        self.gil_check(env)

    gil_message = "Raising exception"

William Stein's avatar
William Stein committed
2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
    def generate_execution_code(self, code):
        if self.exc_type:
            self.exc_type.generate_evaluation_code(code)
            type_code = self.exc_type.py_result()
        else:
            type_code = 0
        if self.exc_value:
            self.exc_value.generate_evaluation_code(code)
            value_code = self.exc_value.py_result()
        else:
            value_code = "0"
        if self.exc_tb:
            self.exc_tb.generate_evaluation_code(code)
            tb_code = self.exc_tb.py_result()
        else:
            tb_code = "0"
        if self.exc_type or self.exc_value or self.exc_tb:
            code.putln(
                "__Pyx_Raise(%s, %s, %s);" % (
                    type_code,
                    value_code,
                    tb_code))
        else:
            code.putln(
                "__Pyx_ReRaise();")
        if self.exc_type:
            self.exc_type.generate_disposal_code(code)
        if self.exc_value:
            self.exc_value.generate_disposal_code(code)
        if self.exc_tb:
            self.exc_tb.generate_disposal_code(code)
        code.putln(
            code.error_goto(self.pos))

2746 2747 2748 2749 2750 2751 2752 2753
    def annotate(self, code):
        if self.exc_type:
            self.exc_type.annotate(code)
        if self.exc_value:
            self.exc_value.annotate(code)
        if self.exc_tb:
            self.exc_tb.annotate(code)

William Stein's avatar
William Stein committed
2754

2755 2756
class ReraiseStatNode(StatNode):

2757 2758
    child_attrs = []

2759
    def analyse_expressions(self, env):
2760
        self.gil_check(env)
2761 2762
        env.use_utility_code(raise_utility_code)

2763 2764
    gil_message = "Raising exception"

2765 2766 2767 2768 2769 2770 2771 2772 2773
    def generate_execution_code(self, code):
        vars = code.exc_vars
        if vars:
            code.putln("__Pyx_Raise(%s, %s, %s);" % tuple(vars))
            code.putln(code.error_goto(self.pos))
        else:
            error(self.pos, "Reraise not inside except clause")
        

William Stein's avatar
William Stein committed
2774 2775 2776 2777 2778 2779
class AssertStatNode(StatNode):
    #  assert statement
    #
    #  cond    ExprNode
    #  value   ExprNode or None
    
2780 2781
    child_attrs = ["cond", "value"]

William Stein's avatar
William Stein committed
2782 2783 2784 2785 2786 2787 2788 2789 2790
    def analyse_expressions(self, env):
        self.cond = self.cond.analyse_boolean_expression(env)
        if self.value:
            self.value.analyse_types(env)
            self.value = self.value.coerce_to_pyobject(env)
            self.value.allocate_temps(env)
        self.cond.release_temp(env)
        if self.value:
            self.value.release_temp(env)
2791
        self.gil_check(env)
William Stein's avatar
William Stein committed
2792
        #env.recycle_pending_temps() # TEMPORARY
2793 2794

    gil_message = "Raising exception"
William Stein's avatar
William Stein committed
2795 2796
    
    def generate_execution_code(self, code):
2797
        code.putln("#ifndef PYREX_WITHOUT_ASSERTIONS")
William Stein's avatar
William Stein committed
2798 2799
        self.cond.generate_evaluation_code(code)
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
2800
            "if (unlikely(!%s)) {" %
William Stein's avatar
William Stein committed
2801 2802
                self.cond.result_code)
        if self.value:
2803
            self.value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
2804 2805 2806
            code.putln(
                "PyErr_SetObject(PyExc_AssertionError, %s);" %
                    self.value.py_result())
2807
            self.value.generate_disposal_code(code)
William Stein's avatar
William Stein committed
2808 2809 2810 2811 2812 2813 2814 2815
        else:
            code.putln(
                "PyErr_SetNone(PyExc_AssertionError);")
        code.putln(
                code.error_goto(self.pos))
        code.putln(
            "}")
        self.cond.generate_disposal_code(code)
2816
        code.putln("#endif")
William Stein's avatar
William Stein committed
2817

2818 2819 2820 2821 2822 2823
    def annotate(self, code):
        self.cond.annotate(code)
        if self.value:
            self.value.annotate(code)


William Stein's avatar
William Stein committed
2824 2825 2826 2827 2828
class IfStatNode(StatNode):
    #  if statement
    #
    #  if_clauses   [IfClauseNode]
    #  else_clause  StatNode or None
2829 2830

    child_attrs = ["if_clauses", "else_clause"]
William Stein's avatar
William Stein committed
2831
    
2832 2833 2834 2835 2836 2837 2838 2839 2840
    def analyse_control_flow(self, env):
        env.start_branching(self.pos)
        for if_clause in self.if_clauses:
            if_clause.analyse_control_flow(env)
            env.next_branch(if_clause.end_pos())
        if self.else_clause:
            self.else_clause.analyse_control_flow(env)
        env.finish_branching(self.end_pos())

William Stein's avatar
William Stein committed
2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853
    def analyse_declarations(self, env):
        for if_clause in self.if_clauses:
            if_clause.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        for if_clause in self.if_clauses:
            if_clause.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
    
    def generate_execution_code(self, code):
2854
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
2855 2856 2857 2858 2859 2860 2861 2862
        end_label = code.new_label()
        for if_clause in self.if_clauses:
            if_clause.generate_execution_code(code, end_label)
        if self.else_clause:
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
        code.put_label(end_label)
2863 2864 2865 2866 2867 2868
        
    def annotate(self, code):
        for if_clause in self.if_clauses:
            if_clause.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)
William Stein's avatar
William Stein committed
2869 2870 2871 2872 2873 2874 2875 2876


class IfClauseNode(Node):
    #  if or elif clause in an if statement
    #
    #  condition   ExprNode
    #  body        StatNode
    
2877 2878
    child_attrs = ["condition", "body"]

2879 2880 2881
    def analyse_control_flow(self, env):
        self.body.analyse_control_flow(env)
        
William Stein's avatar
William Stein committed
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
    def analyse_declarations(self, env):
        self.condition.analyse_declarations(env)
        self.body.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        self.condition = \
            self.condition.analyse_temp_boolean_expression(env)
        self.condition.release_temp(env)
        self.body.analyse_expressions(env)
    
    def generate_execution_code(self, code, end_label):
        self.condition.generate_evaluation_code(code)
        code.putln(
            "if (%s) {" %
                self.condition.result_code)
        self.body.generate_execution_code(code)
2898 2899 2900 2901
        #code.putln(
        #	"goto %s;" %
        #		end_label)
        code.put_goto(end_label)
William Stein's avatar
William Stein committed
2902
        code.putln("}")
2903 2904 2905 2906

    def annotate(self, code):
        self.condition.annotate(code)
        self.body.annotate(code)
William Stein's avatar
William Stein committed
2907
        
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921

class SwitchCaseNode(StatNode):
    # Generated in the optimization of an if-elif-else node
    #
    # conditions    [ExprNode]
    # body          StatNode
    
    child_attrs = ['conditions', 'body']
    
    def generate_execution_code(self, code):
        for cond in self.conditions:
            code.putln("case %s:" % cond.calculate_result_code())
        self.body.generate_execution_code(code)
        code.putln("break;")
2922
        
2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951
    def annotate(self, code):
        for cond in self.conditions:
            cond.annotate(code)
        body.annotate(code)

class SwitchStatNode(StatNode):
    # Generated in the optimization of an if-elif-else node
    #
    # test          ExprNode
    # cases         [SwitchCaseNode]
    # else_clause   StatNode or None
    
    child_attrs = ['test', 'cases', 'else_clause']
    
    def generate_execution_code(self, code):
        code.putln("switch (%s) {" % self.test.calculate_result_code())
        for case in self.cases:
            case.generate_execution_code(code)
        if self.else_clause is not None:
            code.putln("default:")
            self.else_clause.generate_execution_code(code)
        code.putln("}")

    def annotate(self, code):
        self.test.annotate(code)
        for case in self.cases:
            case.annotate(code)
        self.else_clause.annotate(code)
            
2952 2953 2954 2955 2956 2957 2958 2959 2960 2961
class LoopNode:
    
    def analyse_control_flow(self, env):
        env.start_branching(self.pos)
        self.body.analyse_control_flow(env)
        env.next_branch(self.body.end_pos())
        if self.else_clause:
            self.else_clause.analyse_control_flow(env)
        env.finish_branching(self.end_pos())

William Stein's avatar
William Stein committed
2962
    
2963
class WhileStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
2964 2965 2966 2967 2968
    #  while statement
    #
    #  condition    ExprNode
    #  body         StatNode
    #  else_clause  StatNode
2969 2970

    child_attrs = ["condition", "body", "else_clause"]
2971

William Stein's avatar
William Stein committed
2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        self.condition = \
            self.condition.analyse_temp_boolean_expression(env)
        self.condition.release_temp(env)
        #env.recycle_pending_temps() # TEMPORARY
        self.body.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
    
    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
        code.putln(
            "while (1) {")
        self.condition.generate_evaluation_code(code)
        code.putln(
            "if (!%s) break;" %
                self.condition.result_code)
        self.body.generate_execution_code(code)
2995
        code.put_label(code.continue_label)
William Stein's avatar
William Stein committed
2996 2997 2998 2999 3000 3001 3002 3003 3004
        code.putln("}")
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
        if self.else_clause:
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
        code.put_label(break_label)

3005 3006 3007 3008 3009 3010
    def annotate(self, code):
        self.condition.annotate(code)
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)

William Stein's avatar
William Stein committed
3011

Robert Bradshaw's avatar
Robert Bradshaw committed
3012 3013 3014 3015 3016 3017
def ForStatNode(pos, **kw):
    if kw.has_key('iterator'):
        return ForInStatNode(pos, **kw)
    else:
        return ForFromStatNode(pos, **kw)

3018
class ForInStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
3019 3020 3021 3022 3023 3024 3025 3026
    #  for statement
    #
    #  target        ExprNode
    #  iterator      IteratorNode
    #  body          StatNode
    #  else_clause   StatNode
    #  item          NextNode       used internally
    
3027
    child_attrs = ["target", "iterator", "body", "else_clause"]
3028
    item = None
3029
    
William Stein's avatar
William Stein committed
3030 3031 3032 3033 3034
    def analyse_declarations(self, env):
        self.target.analyse_target_declaration(env)
        self.body.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
3035 3036 3037 3038 3039 3040
            
    def analyse_range_step(self, args):
        import ExprNodes
        # The direction must be determined at compile time to set relations. 
        # Otherwise, return False. 
        if len(args) < 3:
3041
            self.step = ExprNodes.IntNode(pos = args[0].pos, value='1')
3042 3043 3044 3045 3046 3047
            self.relation1 = '<='
            self.relation2 = '<'
            return True
        else:
            step = args[2]
            if isinstance(step, ExprNodes.UnaryMinusNode) and isinstance(step.operand, ExprNodes.IntNode):
Stefan Behnel's avatar
Stefan Behnel committed
3048
                step = ExprNodes.IntNode(pos = step.pos, value=str(-int(step.operand.value, 0)))
3049
            if isinstance(step, ExprNodes.IntNode):
Stefan Behnel's avatar
Stefan Behnel committed
3050 3051
                step_value = int(step.value, 0)
                if step_value > 0:
3052 3053 3054 3055
                    self.step = step
                    self.relation1 = '<='
                    self.relation2 = '<'
                    return True
Stefan Behnel's avatar
Stefan Behnel committed
3056 3057
                elif step_value < 0:
                    self.step = ExprNodes.IntNode(pos = step.pos, value=str(-step_value))
3058 3059 3060 3061 3062
                    self.relation1 = '>='
                    self.relation2 = '>'
                    return True
        return False
                
William Stein's avatar
William Stein committed
3063 3064 3065 3066
    
    def analyse_expressions(self, env):
        import ExprNodes
        self.target.analyse_target_types(env)
3067 3068 3069 3070 3071
        if Options.convert_range and self.target.type.is_int:
            sequence = self.iterator.sequence
            if isinstance(sequence, ExprNodes.SimpleCallNode) \
                  and sequence.self is None \
                  and isinstance(sequence.function, ExprNodes.NameNode) \
Robert Bradshaw's avatar
Robert Bradshaw committed
3072
                  and (sequence.function.name == 'range' or sequence.function.name == 'xrange'):
3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087
                args = sequence.args
                # Make sure we can determine direction from step
                if self.analyse_range_step(args):
                    # Mutate to ForFrom loop type
                    self.__class__ = ForFromStatNode
                    if len(args) == 1:
                        self.bound1 = ExprNodes.IntNode(pos = sequence.pos, value='0')
                        self.bound2 = args[0]
                    else:
                        self.bound1 = args[0]
                        self.bound2 = args[1]
                    ForFromStatNode.analyse_expressions(self, env)
                    return
                    
        self.iterator.analyse_expressions(env)
William Stein's avatar
William Stein committed
3088 3089 3090
        self.item = ExprNodes.NextNode(self.iterator, env)
        self.item = self.item.coerce_to(self.target.type, env)
        self.item.allocate_temps(env)
3091 3092 3093
        self.target.allocate_target_temps(env, self.item)
        #self.item.release_temp(env)
        #self.target.release_target_temp(env)
William Stein's avatar
William Stein committed
3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106
        self.body.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
        self.iterator.release_temp(env)

    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
        self.iterator.generate_evaluation_code(code)
        code.putln(
            "for (;;) {")
        self.item.generate_evaluation_code(code)
        self.target.generate_assignment_code(self.item, code)
        self.body.generate_execution_code(code)
3107
        code.put_label(code.continue_label)
William Stein's avatar
William Stein committed
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118
        code.putln(
            "}")
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
        if self.else_clause:
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
        code.put_label(break_label)
        self.iterator.generate_disposal_code(code)

3119 3120 3121 3122 3123 3124 3125 3126
    def annotate(self, code):
        self.target.annotate(code)
        self.iterator.annotate(code)
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)
        self.item.annotate(code)

William Stein's avatar
William Stein committed
3127

3128
class ForFromStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
3129 3130 3131 3132 3133 3134 3135
    #  for name from expr rel name rel expr
    #
    #  target        NameNode
    #  bound1        ExprNode
    #  relation1     string
    #  relation2     string
    #  bound2        ExprNode
3136
    #  step          ExprNode or None
William Stein's avatar
William Stein committed
3137 3138 3139 3140 3141
    #  body          StatNode
    #  else_clause   StatNode or None
    #
    #  Used internally:
    #
3142
    #  is_py_target       bool
William Stein's avatar
William Stein committed
3143 3144
    #  loopvar_name       string
    #  py_loopvar_node    PyTempNode or None
3145
    child_attrs = ["target", "bound1", "bound2", "step", "body", "else_clause"]
William Stein's avatar
William Stein committed
3146
    
Robert Bradshaw's avatar
Robert Bradshaw committed
3147 3148 3149 3150 3151 3152
    def analyse_declarations(self, env):
        self.target.analyse_target_declaration(env)
        self.body.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
    
William Stein's avatar
William Stein committed
3153 3154 3155 3156 3157
    def analyse_expressions(self, env):
        import ExprNodes
        self.target.analyse_target_types(env)
        self.bound1.analyse_types(env)
        self.bound2.analyse_types(env)
3158 3159 3160 3161 3162 3163
        if self.target.type.is_numeric:
            self.bound1 = self.bound1.coerce_to(self.target.type, env)
            self.bound2 = self.bound2.coerce_to(self.target.type, env)
        else:
            self.bound1 = self.bound1.coerce_to_integer(env)
            self.bound2 = self.bound2.coerce_to_integer(env)
3164
        if self.step is not None:
3165 3166
            if isinstance(self.step, ExprNodes.UnaryMinusNode):
                warning(self.step.pos, "Probable infinite loop in for-from-by statment. Consider switching the directions of the relations.", 2)
3167 3168
            self.step.analyse_types(env)
            self.step = self.step.coerce_to_integer(env)
William Stein's avatar
William Stein committed
3169 3170 3171
        if not (self.bound2.is_name or self.bound2.is_literal):
            self.bound2 = self.bound2.coerce_to_temp(env)
        target_type = self.target.type
3172
        if not (target_type.is_pyobject or target_type.is_numeric):
3173 3174 3175 3176 3177 3178
            error(self.target.pos,
                "Integer for-loop variable must be of type int or Python object")
        #if not (target_type.is_pyobject
        #	or target_type.assignable_from(PyrexTypes.c_int_type)):
        #		error(self.target.pos,
        #			"Cannot assign integer to variable of type '%s'" % target_type)
3179
        if target_type.is_numeric:
3180
            self.is_py_target = 0
William Stein's avatar
William Stein committed
3181 3182 3183
            self.loopvar_name = self.target.entry.cname
            self.py_loopvar_node = None
        else:
3184
            self.is_py_target = 1
William Stein's avatar
William Stein committed
3185 3186 3187 3188 3189 3190 3191 3192
            c_loopvar_node = ExprNodes.TempNode(self.pos, 
                PyrexTypes.c_long_type, env)
            c_loopvar_node.allocate_temps(env)
            self.loopvar_name = c_loopvar_node.result_code
            self.py_loopvar_node = \
                ExprNodes.CloneNode(c_loopvar_node).coerce_to_pyobject(env)
        self.bound1.allocate_temps(env)
        self.bound2.allocate_temps(env)
3193 3194
        if self.step is not None:
            self.step.allocate_temps(env)
3195
        if self.is_py_target:
William Stein's avatar
William Stein committed
3196
            self.py_loopvar_node.allocate_temps(env)
3197 3198 3199
            self.target.allocate_target_temps(env, self.py_loopvar_node)
            #self.target.release_target_temp(env)
            #self.py_loopvar_node.release_temp(env)
William Stein's avatar
William Stein committed
3200
        self.body.analyse_expressions(env)
3201
        if self.is_py_target:
William Stein's avatar
William Stein committed
3202 3203 3204 3205 3206
            c_loopvar_node.release_temp(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
        self.bound1.release_temp(env)
        self.bound2.release_temp(env)
3207 3208
        if self.step is not None:
            self.step.release_temp(env)
William Stein's avatar
William Stein committed
3209 3210 3211 3212 3213 3214
            
    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
        self.bound1.generate_evaluation_code(code)
        self.bound2.generate_evaluation_code(code)
        offset, incop = self.relation_table[self.relation1]
3215 3216 3217
        if self.step is not None:
            self.step.generate_evaluation_code(code)
            incop = "%s=%s" % (incop[0], self.step.result_code)
William Stein's avatar
William Stein committed
3218 3219 3220 3221 3222
        code.putln(
            "for (%s = %s%s; %s %s %s; %s%s) {" % (
                self.loopvar_name,
                self.bound1.result_code, offset,
                self.loopvar_name, self.relation2, self.bound2.result_code,
3223
                self.loopvar_name, incop))
William Stein's avatar
William Stein committed
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
        if self.py_loopvar_node:
            self.py_loopvar_node.generate_evaluation_code(code)
            self.target.generate_assignment_code(self.py_loopvar_node, code)
        self.body.generate_execution_code(code)
        code.put_label(code.continue_label)
        code.putln("}")
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
        if self.else_clause:
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
        code.put_label(break_label)
        self.bound1.generate_disposal_code(code)
        self.bound2.generate_disposal_code(code)
3239 3240
        if self.step is not None:
            self.step.generate_disposal_code(code)
William Stein's avatar
William Stein committed
3241 3242 3243 3244 3245 3246 3247 3248
    
    relation_table = {
        # {relop : (initial offset, increment op)}
        '<=': ("",   "++"),
        '<' : ("+1", "++"),
        '>=': ("",   "--"),
        '>' : ("-1", "--")
    }
3249 3250 3251 3252 3253 3254 3255 3256 3257 3258
    
    def annotate(self, code):
        self.target.annotate(code)
        self.bound1.annotate(code)
        self.bound2.annotate(code)
        if self.step:
            self.bound2.annotate(code)
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)
William Stein's avatar
William Stein committed
3259 3260


3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272
class WithStatNode(StatNode):
    """
    Represents a Python with statement.
    
    This is only used at parse tree level; and is not present in
    analysis or generation phases.
    """
    #  manager          The with statement manager object
    #  target            Node (lhs expression)
    #  body             StatNode
    child_attrs = ["manager", "target", "body"]

William Stein's avatar
William Stein committed
3273 3274 3275 3276 3277 3278 3279
class TryExceptStatNode(StatNode):
    #  try .. except statement
    #
    #  body             StatNode
    #  except_clauses   [ExceptClauseNode]
    #  else_clause      StatNode or None
    #  cleanup_list     [Entry]            temps to clean up on error
3280

3281
    child_attrs = ["body", "except_clauses", "else_clause"]
William Stein's avatar
William Stein committed
3282
    
3283 3284 3285
    def analyse_control_flow(self, env):
        env.start_branching(self.pos)
        self.body.analyse_control_flow(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
3286 3287 3288 3289 3290
        successful_try = env.control_flow # grab this for later
        env.next_branch(self.body.end_pos())
        env.finish_branching(self.body.end_pos())
        
        env.start_branching(self.except_clauses[0].pos)
3291 3292
        for except_clause in self.except_clauses:
            except_clause.analyse_control_flow(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
3293 3294 3295 3296
            env.next_branch(except_clause.end_pos())
            
        # the else cause it executed only when the try clause finishes
        env.control_flow.incoming = successful_try
3297 3298 3299 3300
        if self.else_clause:
            self.else_clause.analyse_control_flow(env)
        env.finish_branching(self.end_pos())

William Stein's avatar
William Stein committed
3301 3302 3303 3304 3305 3306
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        for except_clause in self.except_clauses:
            except_clause.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
3307
        self.gil_check(env)
William Stein's avatar
William Stein committed
3308 3309
    
    def analyse_expressions(self, env):
3310

William Stein's avatar
William Stein committed
3311 3312 3313 3314 3315 3316
        self.body.analyse_expressions(env)
        self.cleanup_list = env.free_temp_entries[:]
        for except_clause in self.except_clauses:
            except_clause.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
3317 3318 3319 3320
        self.gil_check(env)

    gil_message = "Try-except statement"

William Stein's avatar
William Stein committed
3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
    def generate_execution_code(self, code):
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
        end_label = code.new_label()
        code.putln(
            "/*try:*/ {")
        self.body.generate_execution_code(code)
        code.putln(
            "}")
        code.error_label = old_error_label
        if self.else_clause:
            code.putln(
                "/*else:*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln(
                "}")
3337
        code.put_goto(end_label)
William Stein's avatar
William Stein committed
3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348
        code.put_label(our_error_label)
        code.put_var_xdecrefs_clear(self.cleanup_list)
        default_clause_seen = 0
        for except_clause in self.except_clauses:
            if not except_clause.pattern:
                default_clause_seen = 1
            else:
                if default_clause_seen:
                    error(except_clause.pos, "Default except clause not last")
            except_clause.generate_handling_code(code, end_label)
        if not default_clause_seen:
3349
            code.put_goto(code.error_label)
William Stein's avatar
William Stein committed
3350 3351
        code.put_label(end_label)

3352 3353 3354 3355 3356 3357 3358
    def annotate(self, code):
        self.body.annotate(code)
        for except_node in self.except_clauses:
            except_node.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)

William Stein's avatar
William Stein committed
3359 3360 3361 3362 3363 3364 3365

class ExceptClauseNode(Node):
    #  Part of try ... except statement.
    #
    #  pattern        ExprNode
    #  target         ExprNode or None
    #  body           StatNode
3366
    #  excinfo_target NameNode or None   optional target for exception info
William Stein's avatar
William Stein committed
3367 3368 3369
    #  match_flag     string             result of exception match
    #  exc_value      ExcValueNode       used internally
    #  function_name  string             qualified name of enclosing function
3370
    #  exc_vars       (string * 3)       local exception variables
3371 3372 3373 3374

    # excinfo_target is never set by the parser, but can be set by a transform
    # in order to extract more extensive information about the exception as a
    # sys.exc_info()-style tuple into a target variable
William Stein's avatar
William Stein committed
3375
    
3376
    child_attrs = ["pattern", "target", "body", "exc_value", "excinfo_target"]
3377

3378
    exc_value = None
3379
    excinfo_target = None
3380

William Stein's avatar
William Stein committed
3381 3382 3383
    def analyse_declarations(self, env):
        if self.target:
            self.target.analyse_target_declaration(env)
3384 3385
        if self.excinfo_target is not None:
            self.excinfo_target.analyse_target_declaration(env)
William Stein's avatar
William Stein committed
3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397
        self.body.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        import ExprNodes
        genv = env.global_scope()
        self.function_name = env.qualified_name
        if self.pattern:
            self.pattern.analyse_expressions(env)
            self.pattern = self.pattern.coerce_to_pyobject(env)
            self.match_flag = env.allocate_temp(PyrexTypes.c_int_type)
            self.pattern.release_temp(env)
            env.release_temp(self.match_flag)
3398
        self.exc_vars = [env.allocate_temp(py_object_type) for i in xrange(3)]
William Stein's avatar
William Stein committed
3399
        if self.target:
3400 3401
            self.exc_value = ExprNodes.ExcValueNode(self.pos, env, self.exc_vars[1])
            self.exc_value.allocate_temps(env)
3402
            self.target.analyse_target_expression(env, self.exc_value)
3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413
        if self.excinfo_target is not None:
            import ExprNodes
            self.excinfo_tuple = ExprNodes.TupleNode(pos=self.pos, args=[
                ExprNodes.ExcValueNode(pos=self.pos, env=env, var=self.exc_vars[0]),
                ExprNodes.ExcValueNode(pos=self.pos, env=env, var=self.exc_vars[1]),
                ExprNodes.ExcValueNode(pos=self.pos, env=env, var=self.exc_vars[2])
            ])
            self.excinfo_tuple.analyse_expressions(env)
            self.excinfo_tuple.allocate_temps(env)
            self.excinfo_target.analyse_target_expression(env, self.excinfo_tuple)

William Stein's avatar
William Stein committed
3414
        self.body.analyse_expressions(env)
3415 3416 3417
        for var in self.exc_vars:
            env.release_temp(var)
        env.use_utility_code(get_exception_utility_code)
William Stein's avatar
William Stein committed
3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431
    
    def generate_handling_code(self, code, end_label):
        code.mark_pos(self.pos)
        if self.pattern:
            self.pattern.generate_evaluation_code(code)
            code.putln(
                "%s = PyErr_ExceptionMatches(%s);" % (
                    self.match_flag,
                    self.pattern.py_result()))
            self.pattern.generate_disposal_code(code)
            code.putln(
                "if (%s) {" %
                    self.match_flag)
        else:
3432 3433
            code.putln("/*except:*/ {")
        code.putln('__Pyx_AddTraceback("%s");' % self.function_name)
William Stein's avatar
William Stein committed
3434 3435 3436
        # We always have to fetch the exception value even if
        # there is no target, because this also normalises the 
        # exception and stores it in the thread state.
3437 3438 3439
        exc_args = "&%s, &%s, &%s" % tuple(self.exc_vars)
        code.putln("if (__Pyx_GetException(%s) < 0) %s" % (exc_args,
            code.error_goto(self.pos)))
William Stein's avatar
William Stein committed
3440
        if self.target:
3441
            self.exc_value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
3442
            self.target.generate_assignment_code(self.exc_value, code)
3443 3444 3445 3446
        if self.excinfo_target is not None:
            self.excinfo_tuple.generate_evaluation_code(code)
            self.excinfo_target.generate_assignment_code(self.excinfo_tuple, code)

3447 3448
        old_exc_vars = code.exc_vars
        code.exc_vars = self.exc_vars
William Stein's avatar
William Stein committed
3449
        self.body.generate_execution_code(code)
3450 3451
        code.exc_vars = old_exc_vars
        for var in self.exc_vars:
3452
            code.putln("Py_DECREF(%s); %s = 0;" % (var, var))
3453
        code.put_goto(end_label)
William Stein's avatar
William Stein committed
3454 3455 3456
        code.putln(
            "}")

3457
    def annotate(self, code):
3458 3459
        if self.pattern:
            self.pattern.annotate(code)
3460 3461 3462 3463
        if self.target:
            self.target.annotate(code)
        self.body.annotate(code)

William Stein's avatar
William Stein committed
3464 3465 3466 3467 3468 3469

class TryFinallyStatNode(StatNode):
    #  try ... finally statement
    #
    #  body             StatNode
    #  finally_clause   StatNode
3470
    #
William Stein's avatar
William Stein committed
3471 3472 3473 3474 3475 3476 3477 3478 3479 3480
    #  cleanup_list     [Entry]      temps to clean up on error
    #
    #  The plan is that we funnel all continue, break
    #  return and error gotos into the beginning of the
    #  finally block, setting a variable to remember which
    #  one we're doing. At the end of the finally block, we
    #  switch on the variable to figure out where to go.
    #  In addition, if we're doing an error, we save the
    #  exception on entry to the finally block and restore
    #  it on exit.
3481

3482
    child_attrs = ["body", "finally_clause"]
William Stein's avatar
William Stein committed
3483
    
3484 3485
    preserve_exception = 1
    
William Stein's avatar
William Stein committed
3486 3487 3488 3489
    disallow_continue_in_try_finally = 0
    # There doesn't seem to be any point in disallowing
    # continue in the try block, since we have no problem
    # handling it.
3490 3491 3492 3493 3494 3495

    def create_analysed(pos, env, body, finally_clause):
        node = TryFinallyStatNode(pos, body=body, finally_clause=finally_clause)
        node.cleanup_list = []
        return node
    create_analysed = staticmethod(create_analysed)
William Stein's avatar
William Stein committed
3496
    
3497 3498 3499 3500
    def analyse_control_flow(self, env):
        env.start_branching(self.pos)
        self.body.analyse_control_flow(env)
        env.next_branch(self.body.end_pos())
Robert Bradshaw's avatar
Robert Bradshaw committed
3501
        env.finish_branching(self.body.end_pos())
3502 3503
        self.finally_clause.analyse_control_flow(env)

William Stein's avatar
William Stein committed
3504 3505 3506 3507 3508 3509 3510 3511
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        self.finally_clause.analyse_declarations(env)
    
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
        self.cleanup_list = env.free_temp_entries[:]
        self.finally_clause.analyse_expressions(env)
3512 3513 3514 3515
        self.gil_check(env)

    gil_message = "Try-finally statement"

William Stein's avatar
William Stein committed
3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533
    def generate_execution_code(self, code):
        old_error_label = code.error_label
        old_labels = code.all_new_labels()
        new_labels = code.get_all_labels()
        new_error_label = code.error_label
        catch_label = code.new_label()
        code.putln(
            "/*try:*/ {")
        if self.disallow_continue_in_try_finally:
            was_in_try_finally = code.in_try_finally
            code.in_try_finally = 1
        self.body.generate_execution_code(code)
        if self.disallow_continue_in_try_finally:
            code.in_try_finally = was_in_try_finally
        code.putln(
            "}")
        code.putln(
            "/*finally:*/ {")
3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554
        cases_used = []
        error_label_used = 0
        for i, new_label in enumerate(new_labels):
            if new_label in code.labels_used:
                cases_used.append(i)
                if new_label == new_error_label:
                    error_label_used = 1
                    error_label_case = i
        if cases_used:
            code.putln(
                    "int __pyx_why;")
            if error_label_used and self.preserve_exception:
                code.putln(
                    "PyObject *%s, *%s, *%s;" % Naming.exc_vars)
                code.putln(
                    "int %s;" % Naming.exc_lineno_name)
            code.use_label(catch_label)
            code.putln(
                    "__pyx_why = 0; goto %s;" % catch_label)
            for i in cases_used:
                new_label = new_labels[i]
Stefan Behnel's avatar
Stefan Behnel committed
3555
                #if new_label and new_label != "<try>":
3556 3557 3558 3559 3560 3561 3562 3563 3564 3565
                if new_label == new_error_label and self.preserve_exception:
                    self.put_error_catcher(code, 
                        new_error_label, i+1, catch_label)
                else:
                    code.putln(
                        "%s: __pyx_why = %s; goto %s;" % (
                            new_label,
                            i+1,
                            catch_label))
            code.put_label(catch_label)
William Stein's avatar
William Stein committed
3566
        code.set_all_labels(old_labels)
3567 3568 3569
        if error_label_used:
            code.new_error_label()
            finally_error_label = code.error_label
William Stein's avatar
William Stein committed
3570
        self.finally_clause.generate_execution_code(code)
3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584
        if error_label_used:
            if finally_error_label in code.labels_used and self.preserve_exception:
                over_label = code.new_label()
                code.put_goto(over_label);
                code.put_label(finally_error_label)
                code.putln("if (__pyx_why == %d) {" % (error_label_case + 1))
                for var in Naming.exc_vars:
                    code.putln("Py_XDECREF(%s);" % var)
                code.putln("}")
                code.put_goto(old_error_label)
                code.put_label(over_label)
            code.error_label = old_error_label
        if cases_used:
            code.putln(
William Stein's avatar
William Stein committed
3585
                "switch (__pyx_why) {")
3586 3587 3588
            for i in cases_used:
                old_label = old_labels[i]
                if old_label == old_error_label and self.preserve_exception:
William Stein's avatar
William Stein committed
3589 3590
                    self.put_error_uncatcher(code, i+1, old_error_label)
                else:
3591
                    code.use_label(old_label)
William Stein's avatar
William Stein committed
3592 3593 3594
                    code.putln(
                        "case %s: goto %s;" % (
                            i+1,
3595 3596
                            old_label))
            code.putln(
William Stein's avatar
William Stein committed
3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610
                "}")		
        code.putln(
            "}")

    def put_error_catcher(self, code, error_label, i, catch_label):
        code.putln(
            "%s: {" %
                error_label)
        code.putln(
                "__pyx_why = %s;" %
                    i)
        code.put_var_xdecrefs_clear(self.cleanup_list)
        code.putln(
                "PyErr_Fetch(&%s, &%s, &%s);" %
3611
                    Naming.exc_vars)
William Stein's avatar
William Stein committed
3612 3613
        code.putln(
                "%s = %s;" % (
3614
                    Naming.exc_lineno_name, Naming.lineno_cname))
3615 3616 3617 3618
        #code.putln(
        #		"goto %s;" %
        #			catch_label)
        code.put_goto(catch_label)
William Stein's avatar
William Stein committed
3619 3620 3621 3622 3623 3624 3625 3626 3627
        code.putln(
            "}")
            
    def put_error_uncatcher(self, code, i, error_label):
        code.putln(
            "case %s: {" %
                i)
        code.putln(
                "PyErr_Restore(%s, %s, %s);" %
3628
                    Naming.exc_vars)
William Stein's avatar
William Stein committed
3629 3630
        code.putln(
                "%s = %s;" % (
3631 3632
                    Naming.lineno_cname, Naming.exc_lineno_name))
        for var in Naming.exc_vars:
William Stein's avatar
William Stein committed
3633 3634 3635
            code.putln(
                "%s = 0;" %
                    var)
3636
        code.put_goto(error_label)
William Stein's avatar
William Stein committed
3637 3638 3639
        code.putln(
            "}")

3640 3641 3642 3643
    def annotate(self, code):
        self.body.annotate(code)
        self.finally_clause.annotate(code)

William Stein's avatar
William Stein committed
3644

3645 3646 3647 3648 3649
class GILStatNode(TryFinallyStatNode):
    #  'with gil' or 'with nogil' statement
    #
    #   state   string   'gil' or 'nogil'
        
3650 3651
    child_attrs = []
    
3652 3653 3654 3655 3656 3657 3658 3659
    preserve_exception = 0

    def __init__(self, pos, state, body):
        self.state = state
        TryFinallyStatNode.__init__(self, pos,
            body = body,
            finally_clause = GILExitNode(pos, state = state))

3660 3661 3662 3663 3664 3665 3666 3667 3668
    def analyse_expressions(self, env):
        was_nogil = env.nogil
        env.nogil = 1
        TryFinallyStatNode.analyse_expressions(self, env)
        env.nogil = was_nogil

    def gil_check(self, env):
        pass

3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684
    def generate_execution_code(self, code):
        code.putln("/*with %s:*/ {" % self.state)
        if self.state == 'gil':
            code.putln("PyGILState_STATE _save = PyGILState_Ensure();")
        else:
            code.putln("PyThreadState *_save;")
            code.putln("Py_UNBLOCK_THREADS")
        TryFinallyStatNode.generate_execution_code(self, code)
        code.putln("}")


class GILExitNode(StatNode):
    #  Used as the 'finally' block in a GILStatNode
    #
    #  state   string   'gil' or 'nogil'

3685 3686
    child_attrs = []

3687 3688 3689 3690 3691 3692 3693 3694 3695 3696
    def analyse_expressions(self, env):
        pass

    def generate_execution_code(self, code):
        if self.state == 'gil':
            code.putln("PyGILState_Release();")
        else:
            code.putln("Py_BLOCK_THREADS")


William Stein's avatar
William Stein committed
3697 3698 3699 3700 3701
class CImportStatNode(StatNode):
    #  cimport statement
    #
    #  module_name   string           Qualified name of module being imported
    #  as_name       string or None   Name specified in "as" clause, if any
3702 3703

    child_attrs = []
William Stein's avatar
William Stein committed
3704 3705
    
    def analyse_declarations(self, env):
3706 3707 3708
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
William Stein's avatar
William Stein committed
3709 3710
        module_scope = env.find_module(self.module_name, self.pos)
        if "." in self.module_name:
3711
            names = [EncodedString(name) for name in self.module_name.split(".")]
William Stein's avatar
William Stein committed
3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736
            top_name = names[0]
            top_module_scope = env.context.find_submodule(top_name)
            module_scope = top_module_scope
            for name in names[1:]:
                submodule_scope = module_scope.find_submodule(name)
                module_scope.declare_module(name, submodule_scope, self.pos)
                module_scope = submodule_scope
            if self.as_name:
                env.declare_module(self.as_name, module_scope, self.pos)
            else:
                env.declare_module(top_name, top_module_scope, self.pos)
        else:
            name = self.as_name or self.module_name
            env.declare_module(name, module_scope, self.pos)

    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        pass
    

class FromCImportStatNode(StatNode):
    #  from ... cimport statement
    #
3737 3738
    #  module_name     string                        Qualified name of module
    #  imported_names  [(pos, name, as_name, kind)]  Names to be imported
William Stein's avatar
William Stein committed
3739
    
3740 3741
    child_attrs = []

William Stein's avatar
William Stein committed
3742
    def analyse_declarations(self, env):
3743 3744 3745
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
William Stein's avatar
William Stein committed
3746 3747
        module_scope = env.find_module(self.module_name, self.pos)
        env.add_imported_module(module_scope)
3748
        for pos, name, as_name, kind in self.imported_names:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3749 3750 3751 3752
            if name == "*":
                for local_name, entry in module_scope.entries.items():
                    env.add_imported_entry(local_name, entry, pos)
            else:
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767
                entry = module_scope.lookup(name)
                if entry:
                    if kind and not self.declaration_matches(entry, kind):
                        entry.redeclared(pos)
                else:
                    if kind == 'struct' or kind == 'union':
                        entry = module_scope.declare_struct_or_union(name,
                            kind = kind, scope = None, typedef_flag = 0, pos = pos)
                    elif kind == 'class':
                        entry = module_scope.declare_c_class(name, pos = pos,
                            module_name = self.module_name)
                    else:
                        error(pos, "Name '%s' not declared in module '%s'"
                            % (name, self.module_name))
                        
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3768 3769 3770
                if entry:
                    local_name = as_name or name
                    env.add_imported_entry(local_name, entry, pos)
3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784
    
    def declaration_matches(self, entry, kind):
		if not entry.is_type:
			return 0
		type = entry.type
		if kind == 'class':
			if not type.is_extension_type:
				return 0
		else:
			if not type.is_struct_or_union:
				return 0
			if kind <> type.kind:
				return 0
		return 1
William Stein's avatar
William Stein committed
3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799

    def analyse_expressions(self, env):
        pass
    
    def generate_execution_code(self, code):
        pass


class FromImportStatNode(StatNode):
    #  from ... import statement
    #
    #  module           ImportNode
    #  items            [(string, NameNode)]
    #  interned_items   [(string, NameNode)]
    #  item             PyTempNode            used internally
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3800
    #  import_star      boolean               used internally
3801 3802

    child_attrs = ["module"]
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3803
    import_star = 0
William Stein's avatar
William Stein committed
3804 3805
    
    def analyse_declarations(self, env):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3806 3807 3808 3809 3810 3811 3812 3813 3814
        for name, target in self.items:
            if name == "*":
                if not env.is_module_scope:
                    error(self.pos, "import * only allowed at module level")
                    return
                env.has_import_star = 1
                self.import_star = 1
            else:
                target.analyse_target_declaration(env)
William Stein's avatar
William Stein committed
3815 3816 3817 3818 3819 3820 3821 3822
    
    def analyse_expressions(self, env):
        import ExprNodes
        self.module.analyse_expressions(env)
        self.item = ExprNodes.PyTempNode(self.pos, env)
        self.item.allocate_temp(env)
        self.interned_items = []
        for name, target in self.items:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3823 3824 3825 3826 3827 3828 3829 3830 3831 3832
            if name == '*':
                for _, entry in env.entries.items():
                    if not entry.is_type and entry.type.is_extension_type:
                        env.use_utility_code(ExprNodes.type_test_utility_code)
                        break
            else:
                self.interned_items.append(
                    (env.intern_identifier(name), target))
                target.analyse_target_expression(env, None)
                #target.release_target_temp(env) # was release_temp ?!?
William Stein's avatar
William Stein committed
3833 3834 3835 3836 3837
        self.module.release_temp(env)
        self.item.release_temp(env)
    
    def generate_execution_code(self, code):
        self.module.generate_evaluation_code(code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3838 3839 3840 3841 3842 3843
        if self.import_star:
            code.putln(
                'if (%s(%s) < 0) %s;' % (
                    Naming.import_star,
                    self.module.py_result(),
                    code.error_goto(self.pos)))
3844 3845 3846 3847 3848 3849 3850 3851
        for cname, target in self.interned_items:
            code.putln(
                '%s = PyObject_GetAttr(%s, %s); %s' % (
                    self.item.result_code, 
                    self.module.py_result(),
                    cname,
                    code.error_goto_if_null(self.item.result_code, self.pos)))
            target.generate_assignment_code(self.item, code)
William Stein's avatar
William Stein committed
3852 3853 3854 3855 3856 3857 3858 3859 3860 3861
        self.module.generate_disposal_code(code)

#------------------------------------------------------------------------------------
#
#  Runtime support code
#
#------------------------------------------------------------------------------------

utility_function_predeclarations = \
"""
3862 3863 3864
#ifdef __GNUC__
#define INLINE __inline__
#elif _WIN32
3865
#define INLINE __inline
3866 3867 3868 3869
#else
#define INLINE 
#endif

3870
typedef struct {PyObject **p; char *s; long n; char is_unicode; char intern; char is_identifier;} __Pyx_StringTabEntry; /*proto*/
3871

3872 3873 3874 3875 3876
""" + """

static int %(skip_dispatch_cname)s = 0;

""" % { 'skip_dispatch_cname': Naming.skip_dispatch_cname }
Robert Bradshaw's avatar
Robert Bradshaw committed
3877 3878 3879 3880

if Options.gcc_branch_hints:
    branch_prediction_macros = \
    """
3881
#ifdef __GNUC__
3882 3883 3884
/* Test for GCC > 2.95 */
#if __GNUC__ > 2 || \
              (__GNUC__ == 2 && (__GNUC_MINOR__ > 95)) 
Robert Bradshaw's avatar
Robert Bradshaw committed
3885 3886
#define likely(x)   __builtin_expect(!!(x), 1)
#define unlikely(x) __builtin_expect(!!(x), 0)
3887 3888 3889 3890
#else /* __GNUC__ > 2 ... */
#define likely(x)   (x)
#define unlikely(x) (x)
#endif /* __GNUC__ > 2 ... */
3891 3892 3893 3894
#else /* __GNUC__ */
#define likely(x)   (x)
#define unlikely(x) (x)
#endif /* __GNUC__ */
Robert Bradshaw's avatar
Robert Bradshaw committed
3895 3896 3897 3898 3899 3900 3901
    """
else:
    branch_prediction_macros = \
    """
#define likely(x)   (x)
#define unlikely(x) (x)
    """
William Stein's avatar
William Stein committed
3902

3903 3904
#get_name_predeclaration = \
#"static PyObject *__Pyx_GetName(PyObject *dict, char *name); /*proto*/"
William Stein's avatar
William Stein committed
3905

3906 3907
#get_name_interned_predeclaration = \
#"static PyObject *__Pyx_GetName(PyObject *dict, PyObject *name); /*proto*/"
William Stein's avatar
William Stein committed
3908 3909 3910

#------------------------------------------------------------------------------------

3911 3912
printing_utility_code = [
"""
3913 3914
static int __Pyx_Print(PyObject *, int); /*proto*/
#if PY_MAJOR_VERSION >= 3
3915 3916 3917 3918 3919
static PyObject* %s = 0;
static PyObject* %s = 0;
#endif
""" % (Naming.print_function, Naming.print_function_kwargs), r"""
#if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
3920 3921 3922 3923 3924 3925 3926 3927
static PyObject *__Pyx_GetStdout(void) {
    PyObject *f = PySys_GetObject("stdout");
    if (!f) {
        PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
    }
    return f;
}

3928
static int __Pyx_Print(PyObject *arg_tuple, int newline) {
William Stein's avatar
William Stein committed
3929
    PyObject *f;
3930 3931
    PyObject* v;
    int i;
William Stein's avatar
William Stein committed
3932 3933 3934
    
    if (!(f = __Pyx_GetStdout()))
        return -1;
3935 3936 3937 3938 3939 3940 3941
    for (i=0; i < PyTuple_GET_SIZE(arg_tuple); i++) {
        if (PyFile_SoftSpace(f, 1)) {
            if (PyFile_WriteString(" ", f) < 0)
                return -1;
        }
        v = PyTuple_GET_ITEM(arg_tuple, i);
        if (PyFile_WriteObject(v, f, Py_PRINT_RAW) < 0)
William Stein's avatar
William Stein committed
3942
            return -1;
3943 3944 3945 3946 3947 3948 3949 3950
        if (PyString_Check(v)) {
            char *s = PyString_AsString(v);
            Py_ssize_t len = PyString_Size(v);
            if (len > 0 &&
                isspace(Py_CHARMASK(s[len-1])) &&
                s[len-1] != ' ')
                    PyFile_SoftSpace(f, 0);
        }
William Stein's avatar
William Stein committed
3951
    }
3952 3953 3954 3955
    if (newline) {
        if (PyFile_WriteString("\n", f) < 0)
            return -1;
        PyFile_SoftSpace(f, 0);
William Stein's avatar
William Stein committed
3956 3957 3958 3959
    }
    return 0;
}

3960 3961 3962 3963 3964 3965 3966 3967
#else /* Python 3 has a print function */
static int __Pyx_Print(PyObject *arg_tuple, int newline) {
    PyObject* kwargs = 0;
    PyObject* result = 0;
    PyObject* end_string;
    if (!%(PRINT_FUNCTION)s) {
        %(PRINT_FUNCTION)s = PyObject_GetAttrString(%(BUILTINS)s, "print");
        if (!%(PRINT_FUNCTION)s)
3968
            return -1;
3969 3970 3971 3972 3973
    }
    if (!newline) {
        if (!%(PRINT_KWARGS)s) {
            %(PRINT_KWARGS)s = PyDict_New();
            if (!%(PRINT_KWARGS)s)
3974
                return -1;
3975 3976
            end_string = PyUnicode_FromStringAndSize(" ", 1);
            if (!end_string)
3977
                return -1;
3978 3979
            if (PyDict_SetItemString(%(PRINT_KWARGS)s, "end", end_string) < 0) {
                Py_DECREF(end_string);
3980
                return -1;
3981 3982 3983 3984 3985 3986 3987
            }
            Py_DECREF(end_string);
        }
        kwargs = %(PRINT_KWARGS)s;
    }
    result = PyObject_Call(%(PRINT_FUNCTION)s, arg_tuple, kwargs);
    if (!result)
William Stein's avatar
William Stein committed
3988
        return -1;
3989
    Py_DECREF(result);
William Stein's avatar
William Stein committed
3990 3991
    return 0;
}
3992 3993 3994 3995 3996
#endif
""" % {'BUILTINS'       : Naming.builtins_cname,
       'PRINT_FUNCTION' : Naming.print_function,
       'PRINT_KWARGS'   : Naming.print_function_kwargs}
]
William Stein's avatar
William Stein committed
3997 3998 3999 4000 4001

#------------------------------------------------------------------------------------

# The following function is based on do_raise() from ceval.c.

4002
raise_utility_code = [
William Stein's avatar
William Stein committed
4003
"""
4004 4005
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb); /*proto*/
""","""
William Stein's avatar
William Stein committed
4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb) {
    Py_XINCREF(type);
    Py_XINCREF(value);
    Py_XINCREF(tb);
    /* First, check the traceback argument, replacing None with NULL. */
    if (tb == Py_None) {
        Py_DECREF(tb);
        tb = 0;
    }
    else if (tb != NULL && !PyTraceBack_Check(tb)) {
        PyErr_SetString(PyExc_TypeError,
            "raise: arg 3 must be a traceback or None");
        goto raise_error;
    }
    /* Next, replace a missing value with None */
    if (value == NULL) {
        value = Py_None;
        Py_INCREF(value);
    }
4025 4026 4027 4028 4029 4030
    #if PY_VERSION_HEX < 0x02050000
    if (!PyClass_Check(type))
    #else
    if (!PyType_Check(type))
    #endif
    {
William Stein's avatar
William Stein committed
4031 4032 4033
        /* Raising an instance.  The value should be a dummy. */
        if (value != Py_None) {
            PyErr_SetString(PyExc_TypeError,
4034
                "instance exception may not have a separate value");
William Stein's avatar
William Stein committed
4035 4036
            goto raise_error;
        }
4037 4038 4039
        /* Normalize to raise <class>, <instance> */
        Py_DECREF(value);
        value = type;
4040 4041 4042 4043 4044 4045
        #if PY_VERSION_HEX < 0x02050000
            if (PyInstance_Check(type)) {
                type = (PyObject*) ((PyInstanceObject*)type)->in_class;
                Py_INCREF(type);
            }
            else {
4046
                type = 0;
4047 4048 4049 4050 4051
                PyErr_SetString(PyExc_TypeError,
                    "raise: exception must be an old-style class or instance");
                goto raise_error;
            }
        #else
4052
            type = (PyObject*) Py_TYPE(type);
4053 4054 4055 4056 4057 4058 4059
            Py_INCREF(type);
            if (!PyType_IsSubtype((PyTypeObject *)type, (PyTypeObject *)PyExc_BaseException)) {
                PyErr_SetString(PyExc_TypeError,
                    "raise: exception class must be a subclass of BaseException");
                goto raise_error;
            }
        #endif
William Stein's avatar
William Stein committed
4060
    }
4061 4062 4063 4064
    PyErr_Restore(type, value, tb);
    return;
raise_error:
    Py_XDECREF(value);
William Stein's avatar
William Stein committed
4065 4066 4067 4068
    Py_XDECREF(type);
    Py_XDECREF(tb);
    return;
}
4069
"""]
William Stein's avatar
William Stein committed
4070 4071 4072

#------------------------------------------------------------------------------------

4073
reraise_utility_code = [
William Stein's avatar
William Stein committed
4074
"""
4075 4076
static void __Pyx_ReRaise(void); /*proto*/
""","""
William Stein's avatar
William Stein committed
4077 4078 4079 4080 4081 4082 4083 4084 4085 4086
static void __Pyx_ReRaise(void) {
    PyThreadState *tstate = PyThreadState_Get();
    PyObject *type = tstate->exc_type;
    PyObject *value = tstate->exc_value;
    PyObject *tb = tstate->exc_traceback;
    Py_XINCREF(type);
    Py_XINCREF(value);
    Py_XINCREF(tb);
    PyErr_Restore(type, value, tb);
}
4087
"""]
William Stein's avatar
William Stein committed
4088 4089 4090

#------------------------------------------------------------------------------------

4091
arg_type_test_utility_code = [
William Stein's avatar
William Stein committed
4092
"""
Robert Bradshaw's avatar
Robert Bradshaw committed
4093
static int __Pyx_ArgTypeTest(PyObject *obj, PyTypeObject *type, int none_allowed, char *name, int exact); /*proto*/
4094
""","""
Robert Bradshaw's avatar
Robert Bradshaw committed
4095
static int __Pyx_ArgTypeTest(PyObject *obj, PyTypeObject *type, int none_allowed, char *name, int exact) {
William Stein's avatar
William Stein committed
4096 4097 4098 4099
    if (!type) {
        PyErr_Format(PyExc_SystemError, "Missing type object");
        return 0;
    }
Robert Bradshaw's avatar
Robert Bradshaw committed
4100 4101
    if (none_allowed && obj == Py_None) return 1;
    else if (exact) {
4102
        if (Py_TYPE(obj) == type) return 1;
Robert Bradshaw's avatar
Robert Bradshaw committed
4103 4104
    }
    else {
Robert Bradshaw's avatar
Robert Bradshaw committed
4105
        if (PyObject_TypeCheck(obj, type)) return 1;
Robert Bradshaw's avatar
Robert Bradshaw committed
4106
    }
William Stein's avatar
William Stein committed
4107 4108
    PyErr_Format(PyExc_TypeError,
        "Argument '%s' has incorrect type (expected %s, got %s)",
4109
        name, type->tp_name, Py_TYPE(obj)->tp_name);
William Stein's avatar
William Stein committed
4110 4111
    return 0;
}
4112
"""]
William Stein's avatar
William Stein committed
4113 4114 4115

#------------------------------------------------------------------------------------
#
4116
#  __Pyx_SplitStarArg splits the args tuple into two parts, one part
4117 4118 4119 4120 4121
#  suitable for passing to PyArg_ParseTupleAndKeywords, and the other
#  containing any extra arguments. On success, replaces the borrowed
#  reference *args with references to a new tuple, and passes back a
#  new reference in *args2.  Does not touch any of its arguments on
#  failure.
William Stein's avatar
William Stein committed
4122

4123
get_stararg_utility_code = [
William Stein's avatar
William Stein committed
4124
"""
4125
static INLINE int __Pyx_SplitStarArg(PyObject **args, Py_ssize_t nargs, PyObject **args2); /*proto*/
4126
""","""
4127
static INLINE int __Pyx_SplitStarArg(
William Stein's avatar
William Stein committed
4128
    PyObject **args, 
4129
    Py_ssize_t nargs,
4130
    PyObject **args2)
William Stein's avatar
William Stein committed
4131
{
4132
    PyObject *args1 = 0;
4133
    args1 = PyTuple_GetSlice(*args, 0, nargs);
4134 4135
    if (!args1) {
        *args2 = 0;
4136
        return -1;
4137
    }
4138
    *args2 = PyTuple_GetSlice(*args, nargs, PyTuple_GET_SIZE(*args));
4139 4140 4141 4142
    if (!*args2) {
        Py_DECREF(args1);
        return -1;
    }
4143 4144 4145 4146 4147
    *args = args1;
    return 0;
}
"""]

4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171
#------------------------------------------------------------------------------------
#
#  __Pyx_RaiseArgtupleTooLong raises the correct exception when too
#  many positional arguments were found.  This handles Py_ssize_t
#  formatting correctly.

raise_argtuple_too_long_utility_code = [
"""
static INLINE void __Pyx_RaiseArgtupleTooLong(Py_ssize_t num_expected, Py_ssize_t num_found); /*proto*/
""","""
static INLINE void __Pyx_RaiseArgtupleTooLong(
    Py_ssize_t num_expected,
    Py_ssize_t num_found)
{
    const char* error_message =
    #if PY_VERSION_HEX < 0x02050000
        "function takes at most %d positional arguments (%d given)";
    #else
        "function takes at most %zd positional arguments (%zd given)";
    #endif
    PyErr_Format(PyExc_TypeError, error_message, num_expected, num_found);
}
"""]

4172 4173
#------------------------------------------------------------------------------------
#
4174 4175 4176
#  __Pyx_CheckKeywordStrings raises an error if non-string keywords
#  were passed to a function, or if any keywords were passed to a
#  function that does not accept them.
4177

4178
get_keyword_string_check_utility_code = [
4179
"""
4180
static int __Pyx_CheckKeywordStrings(PyObject *kwdict, const char* function_name, int kw_allowed); /*proto*/
4181
""","""
4182 4183 4184 4185 4186
static int __Pyx_CheckKeywordStrings(
    PyObject *kwdict,
    const char* function_name,
    int kw_allowed)
{
4187 4188
    PyObject* key = 0;
    Py_ssize_t pos = 0;
4189
    while (PyDict_Next(kwdict, &pos, &key, 0)) {
4190
        #if PY_MAJOR_VERSION < 3
4191
        if (unlikely(!PyString_Check(key))) {
4192 4193 4194
        #else
        if (unlikely(!PyUnicode_Check(key))) {
        #endif
4195 4196 4197 4198
            PyErr_Format(PyExc_TypeError,
                         "%s() keywords must be strings", function_name);
            return 0;
        }
4199
    }
4200
    if (unlikely(!kw_allowed) && unlikely(key)) {
4201 4202
        PyErr_Format(PyExc_TypeError,
                     "'%s' is an invalid keyword argument for this function",
4203
        #if PY_MAJOR_VERSION < 3
4204
                     PyString_AsString(key));
4205 4206 4207
        #else
                     PyUnicode_AsString(key));
        #endif
4208
        return 0;
4209
    }
4210
    return 1;
4211 4212 4213
}
"""]

4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246
#------------------------------------------------------------------------------------
#
#  __Pyx_SplitKeywords splits the kwds dict into two parts one part
#  suitable for passing to PyArg_ParseTupleAndKeywords, and the other
#  containing any extra arguments. On success, replaces the borrowed
#  reference *kwds with references to a new dict, and passes back a
#  new reference in *kwds2.  Does not touch any of its arguments on
#  failure.
#
#  Any of *kwds and kwds2 may be 0 (but not kwds). If *kwds == 0, it
#  is not changed. If kwds2 == 0 and *kwds != 0, a new reference to
#  the same dictionary is passed back in *kwds.
#
#  If rqd_kwds is not 0, it is an array of booleans corresponding to
#  the names in kwd_list, indicating required keyword arguments. If
#  any of these are not present in kwds, an exception is raised.
#

get_splitkeywords_utility_code = [
"""
static int __Pyx_SplitKeywords(PyObject **kwds, char *kwd_list[], \
    PyObject **kwds2, char rqd_kwds[]); /*proto*/
""","""
static int __Pyx_SplitKeywords(
    PyObject **kwds,
    char *kwd_list[], 
    PyObject **kwds2,
    char rqd_kwds[])
{
    PyObject *s = 0, *x = 0, *kwds1 = 0;
    int i;
    char **p;
    
4247
    if (*kwds) {
4248 4249 4250 4251 4252 4253 4254
        kwds1 = PyDict_New();
        if (!kwds1)
            goto bad;
        *kwds2 = PyDict_Copy(*kwds);
        if (!*kwds2)
            goto bad;
        for (i = 0, p = kwd_list; *p; i++, p++) {
4255
            #if PY_MAJOR_VERSION < 3
4256
            s = PyString_FromString(*p);
4257 4258 4259
            #else
            s = PyUnicode_FromString(*p);
            #endif
4260 4261 4262 4263 4264 4265
            x = PyDict_GetItem(*kwds, s);
            if (x) {
                if (PyDict_SetItem(kwds1, s, x) < 0)
                    goto bad;
                if (PyDict_DelItem(*kwds2, s) < 0)
                    goto bad;
4266
            }
4267 4268 4269
            else if (rqd_kwds && rqd_kwds[i])
                goto missing_kwarg;
            Py_DECREF(s);
William Stein's avatar
William Stein committed
4270
        }
4271
        s = 0;
William Stein's avatar
William Stein committed
4272 4273
    }
    else {
4274
        if (rqd_kwds) {
4275
            for (i = 0, p = kwd_list; *p; i++, p++)
4276 4277 4278
                if (rqd_kwds[i])
                    goto missing_kwarg;
        }
4279 4280 4281
        *kwds2 = PyDict_New();
        if (!*kwds2)
            goto bad;
William Stein's avatar
William Stein committed
4282
    }
4283

William Stein's avatar
William Stein committed
4284 4285
    *kwds = kwds1;
    return 0;
4286 4287 4288
missing_kwarg:
    PyErr_Format(PyExc_TypeError,
        "required keyword argument '%s' is missing", *p);
William Stein's avatar
William Stein committed
4289
bad:
4290
    Py_XDECREF(s);
William Stein's avatar
William Stein committed
4291
    Py_XDECREF(kwds1);
4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318
    Py_XDECREF(*kwds2);
    return -1;
}
"""]

get_checkkeywords_utility_code = [
"""
static INLINE int __Pyx_CheckRequiredKeywords(PyObject *kwds, char *kwd_list[],
    char rqd_kwds[]); /*proto*/
""","""
static INLINE int __Pyx_CheckRequiredKeywords(
    PyObject *kwds,
    char *kwd_list[],
    char rqd_kwds[])
{
    int i;
    char **p;

    if (kwds) {
        for (i = 0, p = kwd_list; *p; i++, p++)
            if (rqd_kwds[i] && !PyDict_GetItemString(kwds, *p))
                goto missing_kwarg;
    }
    else {
        for (i = 0, p = kwd_list; *p; i++, p++)
            if (rqd_kwds[i])
                goto missing_kwarg;
4319
    }
4320 4321 4322 4323 4324

    return 0;
missing_kwarg:
    PyErr_Format(PyExc_TypeError,
        "required keyword argument '%s' is missing", *p);
William Stein's avatar
William Stein committed
4325 4326
    return -1;
}
4327
"""]
William Stein's avatar
William Stein committed
4328 4329 4330

#------------------------------------------------------------------------------------

4331
unraisable_exception_utility_code = [
William Stein's avatar
William Stein committed
4332
"""
4333
static void __Pyx_WriteUnraisable(const char *name); /*proto*/
4334
""","""
4335
static void __Pyx_WriteUnraisable(const char *name) {
William Stein's avatar
William Stein committed
4336 4337 4338
    PyObject *old_exc, *old_val, *old_tb;
    PyObject *ctx;
    PyErr_Fetch(&old_exc, &old_val, &old_tb);
4339
    #if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
4340
    ctx = PyString_FromString(name);
4341 4342 4343
    #else
    ctx = PyUnicode_FromString(name);
    #endif
William Stein's avatar
William Stein committed
4344 4345 4346 4347
    PyErr_Restore(old_exc, old_val, old_tb);
    if (!ctx)
        ctx = Py_None;
    PyErr_WriteUnraisable(ctx);
4348 4349
}
"""]
William Stein's avatar
William Stein committed
4350 4351 4352

#------------------------------------------------------------------------------------

4353
traceback_utility_code = [
William Stein's avatar
William Stein committed
4354
"""
4355
static void __Pyx_AddTraceback(const char *funcname); /*proto*/
4356
""","""
William Stein's avatar
William Stein committed
4357 4358 4359 4360
#include "compile.h"
#include "frameobject.h"
#include "traceback.h"

4361
static void __Pyx_AddTraceback(const char *funcname) {
William Stein's avatar
William Stein committed
4362 4363 4364 4365 4366 4367
    PyObject *py_srcfile = 0;
    PyObject *py_funcname = 0;
    PyObject *py_globals = 0;
    PyObject *empty_string = 0;
    PyCodeObject *py_code = 0;
    PyFrameObject *py_frame = 0;
4368 4369

    #if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
4370
    py_srcfile = PyString_FromString(%(FILENAME)s);
4371 4372 4373
    #else
    py_srcfile = PyUnicode_FromString(%(FILENAME)s);
    #endif
William Stein's avatar
William Stein committed
4374
    if (!py_srcfile) goto bad;
Robert Bradshaw's avatar
Robert Bradshaw committed
4375
    if (%(CLINENO)s) {
4376
        #if PY_MAJOR_VERSION < 3
Robert Bradshaw's avatar
Robert Bradshaw committed
4377
        py_funcname = PyString_FromFormat( "%%s (%%s:%%u)", funcname, %(CFILENAME)s, %(CLINENO)s);
4378 4379 4380
        #else
        py_funcname = PyUnicode_FromFormat( "%%s (%%s:%%u)", funcname, %(CFILENAME)s, %(CLINENO)s);
        #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
4381 4382
    }
    else {
4383
        #if PY_MAJOR_VERSION < 3
Robert Bradshaw's avatar
Robert Bradshaw committed
4384
        py_funcname = PyString_FromString(funcname);
4385 4386 4387
        #else
        py_funcname = PyUnicode_FromString(funcname);
        #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
4388
    }
William Stein's avatar
William Stein committed
4389 4390 4391
    if (!py_funcname) goto bad;
    py_globals = PyModule_GetDict(%(GLOBALS)s);
    if (!py_globals) goto bad;
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
4392
    #if PY_MAJOR_VERSION < 3
Stefan Behnel's avatar
Stefan Behnel committed
4393
    empty_string = PyString_FromStringAndSize("", 0);
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
4394 4395 4396
    #else
    empty_string = PyBytes_FromStringAndSize("", 0);
    #endif
William Stein's avatar
William Stein committed
4397 4398 4399
    if (!empty_string) goto bad;
    py_code = PyCode_New(
        0,            /*int argcount,*/
4400 4401 4402
        #if PY_MAJOR_VERSION >= 3
        0,            /*int kwonlyargcount,*/
        #endif
William Stein's avatar
William Stein committed
4403 4404 4405 4406
        0,            /*int nlocals,*/
        0,            /*int stacksize,*/
        0,            /*int flags,*/
        empty_string, /*PyObject *code,*/
Stefan Behnel's avatar
Stefan Behnel committed
4407 4408 4409 4410 4411
        %(EMPTY_TUPLE)s,  /*PyObject *consts,*/
        %(EMPTY_TUPLE)s,  /*PyObject *names,*/
        %(EMPTY_TUPLE)s,  /*PyObject *varnames,*/
        %(EMPTY_TUPLE)s,  /*PyObject *freevars,*/
        %(EMPTY_TUPLE)s,  /*PyObject *cellvars,*/
William Stein's avatar
William Stein committed
4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436
        py_srcfile,   /*PyObject *filename,*/
        py_funcname,  /*PyObject *name,*/
        %(LINENO)s,   /*int firstlineno,*/
        empty_string  /*PyObject *lnotab*/
    );
    if (!py_code) goto bad;
    py_frame = PyFrame_New(
        PyThreadState_Get(), /*PyThreadState *tstate,*/
        py_code,             /*PyCodeObject *code,*/
        py_globals,          /*PyObject *globals,*/
        0                    /*PyObject *locals*/
    );
    if (!py_frame) goto bad;
    py_frame->f_lineno = %(LINENO)s;
    PyTraceBack_Here(py_frame);
bad:
    Py_XDECREF(py_srcfile);
    Py_XDECREF(py_funcname);
    Py_XDECREF(empty_string);
    Py_XDECREF(py_code);
    Py_XDECREF(py_frame);
}
""" % {
    'FILENAME': Naming.filename_cname,
    'LINENO':  Naming.lineno_cname,
Robert Bradshaw's avatar
Robert Bradshaw committed
4437 4438
    'CFILENAME': Naming.cfilenm_cname,
    'CLINENO':  Naming.clineno_cname,
Stefan Behnel's avatar
Stefan Behnel committed
4439 4440
    'GLOBALS': Naming.module_cname,
    'EMPTY_TUPLE' : Naming.empty_tuple,
4441
}]
William Stein's avatar
William Stein committed
4442 4443 4444

#------------------------------------------------------------------------------------

4445
set_vtable_utility_code = [
William Stein's avatar
William Stein committed
4446
"""
4447 4448
static int __Pyx_SetVtable(PyObject *dict, void *vtable); /*proto*/
""","""
William Stein's avatar
William Stein committed
4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466
static int __Pyx_SetVtable(PyObject *dict, void *vtable) {
    PyObject *pycobj = 0;
    int result;
    
    pycobj = PyCObject_FromVoidPtr(vtable, 0);
    if (!pycobj)
        goto bad;
    if (PyDict_SetItemString(dict, "__pyx_vtable__", pycobj) < 0)
        goto bad;
    result = 0;
    goto done;

bad:
    result = -1;
done:
    Py_XDECREF(pycobj);
    return result;
}
4467
"""]
William Stein's avatar
William Stein committed
4468 4469 4470

#------------------------------------------------------------------------------------

4471 4472 4473 4474
get_vtable_utility_code = [
"""
static int __Pyx_GetVtable(PyObject *dict, void *vtabptr); /*proto*/
""",r"""
William Stein's avatar
William Stein committed
4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493
static int __Pyx_GetVtable(PyObject *dict, void *vtabptr) {
    int result;
    PyObject *pycobj;
    
    pycobj = PyMapping_GetItemString(dict, "__pyx_vtable__");
    if (!pycobj)
        goto bad;
    *(void **)vtabptr = PyCObject_AsVoidPtr(pycobj);
    if (!*(void **)vtabptr)
        goto bad;
    result = 0;
    goto done;

bad:
    result = -1;
done:
    Py_XDECREF(pycobj);
    return result;
}
4494
"""]
William Stein's avatar
William Stein committed
4495 4496 4497

#------------------------------------------------------------------------------------

4498
init_string_tab_utility_code = [
William Stein's avatar
William Stein committed
4499
"""
4500 4501
static int __Pyx_InitStrings(__Pyx_StringTabEntry *t); /*proto*/
""","""
William Stein's avatar
William Stein committed
4502 4503
static int __Pyx_InitStrings(__Pyx_StringTabEntry *t) {
    while (t->p) {
4504
        #if PY_MAJOR_VERSION < 3
4505
        if (t->is_unicode && (!t->is_identifier)) {
4506
            *t->p = PyUnicode_DecodeUTF8(t->s, t->n - 1, NULL);
4507 4508
        } else if (t->intern) {
            *t->p = PyString_InternFromString(t->s);
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
4509 4510
        } else {
            *t->p = PyString_FromStringAndSize(t->s, t->n - 1);
Stefan Behnel's avatar
Stefan Behnel committed
4511
        }
4512 4513 4514 4515 4516
        #else  /* Python 3+ has unicode identifiers */
        if (t->is_identifier || (t->is_unicode && t->intern)) {
            *t->p = PyUnicode_InternFromString(t->s);
        } else if (t->is_unicode) {
            *t->p = PyUnicode_FromStringAndSize(t->s, t->n - 1);
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
4517 4518
        } else {
            *t->p = PyBytes_FromStringAndSize(t->s, t->n - 1);
Stefan Behnel's avatar
Stefan Behnel committed
4519
        }
4520
        #endif
William Stein's avatar
William Stein committed
4521 4522 4523 4524 4525 4526
        if (!*t->p)
            return -1;
        ++t;
    }
    return 0;
}
4527
"""]
William Stein's avatar
William Stein committed
4528 4529

#------------------------------------------------------------------------------------
4530

4531
get_exception_utility_code = [
4532
"""
4533
static int __Pyx_GetException(PyObject **type, PyObject **value, PyObject **tb); /*proto*/
4534
""","""
4535
static int __Pyx_GetException(PyObject **type, PyObject **value, PyObject **tb) {
4536
    PyObject *tmp_type, *tmp_value, *tmp_tb;
4537 4538 4539 4540 4541 4542 4543 4544
    PyThreadState *tstate = PyThreadState_Get();
    PyErr_Fetch(type, value, tb);
    PyErr_NormalizeException(type, value, tb);
    if (PyErr_Occurred())
        goto bad;
    Py_INCREF(*type);
    Py_INCREF(*value);
    Py_INCREF(*tb);
4545 4546 4547
    tmp_type = tstate->exc_type;
    tmp_value = tstate->exc_value;
    tmp_tb = tstate->exc_traceback;
4548 4549 4550
    tstate->exc_type = *type;
    tstate->exc_value = *value;
    tstate->exc_traceback = *tb;
4551 4552 4553 4554 4555
    /* Make sure tstate is in a consistent state when we XDECREF
    these objects (XDECREF may run arbitrary code). */
    Py_XDECREF(tmp_type);
    Py_XDECREF(tmp_value);
    Py_XDECREF(tmp_tb);
4556
    return 0;
4557 4558 4559 4560 4561
bad:
    Py_XDECREF(*type);
    Py_XDECREF(*value);
    Py_XDECREF(*tb);
    return -1;
4562
}
4563

4564
"""]
4565 4566

#------------------------------------------------------------------------------------