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

5 6 7 8 9 10 11
import cython
cython.declare(sys=object, os=object, time=object, copy=object,
               Builtin=object, error=object, warning=object, Naming=object, PyrexTypes=object,
               py_object_type=object, ModuleScope=object, LocalScope=object, ClosureScope=object, \
               StructOrUnionScope=object, PyClassScope=object, CClassScope=object,
               CppClassScope=object, UtilityCode=object, EncodedString=object,
               absolute_path_length=cython.Py_ssize_t)
William Stein's avatar
William Stein committed
12

13
import sys, os, time, copy
Robert Bradshaw's avatar
Robert Bradshaw committed
14

15
import Builtin
16
from Errors import error, warning, InternalError
William Stein's avatar
William Stein committed
17 18
import Naming
import PyrexTypes
19
import TypeSlots
20
from PyrexTypes import py_object_type, error_type, CFuncType
Stefan Behnel's avatar
Stefan Behnel committed
21
from Symtab import ModuleScope, LocalScope, ClosureScope, \
DaniloFreitas's avatar
DaniloFreitas committed
22
    StructOrUnionScope, PyClassScope, CClassScope, CppClassScope
23
from Cython.Utils import open_new_file, replace_suffix
24
from Code import UtilityCode, ClosureTempAllocator
25
from StringEncoding import EncodedString, escape_byte_string, split_string_literal
William Stein's avatar
William Stein committed
26
import Options
27
import DebugFlags
28
from itertools import chain
William Stein's avatar
William Stein committed
29

Gary Furnish's avatar
Gary Furnish committed
30
absolute_path_length = 0
31 32 33 34 35 36 37

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.)
38

39 40 41 42 43 44 45 46 47
    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
48 49
    global absolute_path_length
    if absolute_path_length==0:
50
        absolute_path_length = len(os.path.abspath(os.getcwd()))
51
    return (pos[0].get_filenametable_entry()[absolute_path_length+1:], pos[1])
52 53 54 55

def embed_position(pos, docstring):
    if not Options.embed_pos_in_docstring:
        return docstring
56
    pos_line = u'File: %s (starting at line %s)' % relative_position(pos)
57 58
    if docstring is None:
        # unicode string
59
        return EncodedString(pos_line)
60 61 62 63 64 65 66 67 68 69 70 71

    # 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
72
        doc = EncodedString(pos_line)
73
    else:
74
        doc = EncodedString(pos_line + u'\n' + docstring)
75 76
    doc.encoding = encoding
    return doc
77

78 79 80 81 82 83 84

from Code import CCodeWriter
from types import FunctionType

def write_func_call(func):
    def f(*args, **kwds):
        if len(args) > 1 and isinstance(args[1], CCodeWriter):
Robert Bradshaw's avatar
Robert Bradshaw committed
85 86
            # here we annotate the code with this function call
            # but only if new code is generated
87
            node, code = args[:2]
Robert Bradshaw's avatar
Robert Bradshaw committed
88 89
            marker = '                    /* %s -> %s.%s %s */' % (
                    ' ' * code.call_level,
90 91
                    node.__class__.__name__,
                    func.__name__,
Robert Bradshaw's avatar
Robert Bradshaw committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
                    node.pos[1:])
            pristine = code.buffer.stream.tell()
            code.putln(marker)
            start = code.buffer.stream.tell()
            code.call_level += 4
            res = func(*args, **kwds)
            code.call_level -= 4
            if start == code.buffer.stream.tell():
                code.buffer.stream.seek(pristine)
            else:
                marker = marker.replace('->', '<-')
                code.putln(marker)
            return res
        else:
            return func(*args, **kwds)
107 108 109 110
    return f

class VerboseCodeWriter(type):
    # Set this as a metaclass to trace function calls in code.
111
    # This slows down code generation and makes much larger files.
112 113 114 115 116 117 118 119
    def __new__(cls, name, bases, attrs):
        attrs = dict(attrs)
        for mname, m in attrs.items():
            if isinstance(m, FunctionType):
                attrs[mname] = write_func_call(m)
        return super(VerboseCodeWriter, cls).__new__(cls, name, bases, attrs)


Stefan Behnel's avatar
Stefan Behnel committed
120
class Node(object):
William Stein's avatar
William Stein committed
121 122 123
    #  pos         (string, int, int)   Source file position
    #  is_name     boolean              Is a NameNode
    #  is_literal  boolean              Is a ConstNode
124

125 126
    if DebugFlags.debug_trace_code_generation:
        __metaclass__ = VerboseCodeWriter
127

William Stein's avatar
William Stein committed
128 129
    is_name = 0
    is_literal = 0
130
    is_terminator = 0
131
    temps = None
132

133 134 135
    # 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.
136
    child_attrs = None
137

138 139 140
    cf_state = None


William Stein's avatar
William Stein committed
141 142 143
    def __init__(self, pos, **kw):
        self.pos = pos
        self.__dict__.update(kw)
144

145 146
    gil_message = "Operation"

147
    nogil_check = None
148

149
    def gil_error(self, env=None):
150
        error(self.pos, "%s not allowed without gil" % self.gil_message)
151

Robert Bradshaw's avatar
Robert Bradshaw committed
152
    cpp_message = "Operation"
153

Robert Bradshaw's avatar
Robert Bradshaw committed
154 155 156 157 158 159
    def cpp_check(self, env):
        if not env.is_cpp():
            self.cpp_error()

    def cpp_error(self):
        error(self.pos, "%s only allowed in c++" % self.cpp_message)
160

161 162 163 164 165 166
    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."""
167 168 169
        result = copy.copy(self)
        for attrname in result.child_attrs:
            value = getattr(result, attrname)
170
            if isinstance(value, list):
171
                setattr(result, attrname, [x for x in value])
172
        return result
173 174


William Stein's avatar
William Stein committed
175
    #
176
    #  There are 3 phases of parse tree processing, applied in order to
William Stein's avatar
William Stein committed
177 178
    #  all the statements in a given scope-block:
    #
179
    #  (0) analyse_declarations
William Stein's avatar
William Stein committed
180 181 182 183
    #        Make symbol table entries for all declarations at the current
    #        level, both explicit (def, cdef, etc.) and implicit (assignment
    #        to an otherwise undeclared name).
    #
184
    #  (1) analyse_expressions
William Stein's avatar
William Stein committed
185 186
    #         Determine the result types of expressions and fill in the
    #         'type' attribute of each ExprNode. Insert coercion nodes into the
187
    #         tree where needed to convert to and from Python objects.
William Stein's avatar
William Stein committed
188 189 190 191
    #         Allocate temporary locals for intermediate results. Fill
    #         in the 'result_code' attribute of each ExprNode with a C code
    #         fragment.
    #
192
    #  (2) generate_code
William Stein's avatar
William Stein committed
193 194 195 196
    #         Emit C code for all declarations, statements and expressions.
    #         Recursively applies the 3 processing phases to the bodies of
    #         functions.
    #
197

William Stein's avatar
William Stein committed
198 199
    def analyse_declarations(self, env):
        pass
200

William Stein's avatar
William Stein committed
201 202 203
    def analyse_expressions(self, env):
        raise InternalError("analyse_expressions not implemented for %s" % \
            self.__class__.__name__)
204

William Stein's avatar
William Stein committed
205 206 207
    def generate_code(self, code):
        raise InternalError("generate_code not implemented for %s" % \
            self.__class__.__name__)
208

209 210 211 212
    def annotate(self, code):
        # mro does the wrong thing
        if isinstance(self, BlockNode):
            self.body.annotate(code)
213

214 215 216 217
    def end_pos(self):
        try:
            return self._end_pos
        except AttributeError:
Stefan Behnel's avatar
Stefan Behnel committed
218
            pos = self.pos
219 220 221
            if not self.child_attrs:
                self._end_pos = pos
                return pos
222
            for attr in self.child_attrs:
223
                child = getattr(self, attr)
224
                # Sometimes lists, sometimes nodes
225 226 227
                if child is None:
                    pass
                elif isinstance(child, list):
Stefan Behnel's avatar
Stefan Behnel committed
228 229
                    for c in child:
                        pos = max(pos, c.end_pos())
230
                else:
Stefan Behnel's avatar
Stefan Behnel committed
231 232 233
                    pos = max(pos, child.end_pos())
            self._end_pos = pos
            return pos
William Stein's avatar
William Stein committed
234

235
    def dump(self, level=0, filter_out=("pos",), cutoff=100, encountered=None):
236 237
        if cutoff == 0:
            return "<...nesting level cutoff...>"
238 239 240
        if encountered is None:
            encountered = set()
        if id(self) in encountered:
241
            return "<%s (0x%x) -- already output>" % (self.__class__.__name__, id(self))
242
        encountered.add(id(self))
243

244 245
        def dump_child(x, level):
            if isinstance(x, Node):
246
                return x.dump(level, filter_out, cutoff-1, encountered)
247
            elif isinstance(x, list):
Robert Bradshaw's avatar
Robert Bradshaw committed
248
                return "[%s]" % ", ".join([dump_child(item, level) for item in x])
249 250
            else:
                return repr(x)
251 252


253
        attrs = [(key, value) for key, value in self.__dict__.items() if key not in filter_out]
254
        if len(attrs) == 0:
255
            return "<%s (0x%x)>" % (self.__class__.__name__, id(self))
256 257
        else:
            indent = "  " * level
258
            res = "<%s (0x%x)\n" % (self.__class__.__name__, id(self))
259 260 261 262
            for key, value in attrs:
                res += "%s  %s: %s\n" % (indent, key, dump_child(value, level + 1))
            res += "%s>" % indent
            return res
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277

class CompilerDirectivesNode(Node):
    """
    Sets compiler directives for the children nodes
    """
    #  directives     {string:value}  A dictionary holding the right value for
    #                                 *all* possible directives.
    #  body           Node
    child_attrs = ["body"]

    def analyse_declarations(self, env):
        old = env.directives
        env.directives = self.directives
        self.body.analyse_declarations(env)
        env.directives = old
278

279 280 281 282 283 284 285 286 287 288 289 290 291
    def analyse_expressions(self, env):
        old = env.directives
        env.directives = self.directives
        self.body.analyse_expressions(env)
        env.directives = old

    def generate_function_definitions(self, env, code):
        env_old = env.directives
        code_old = code.globalstate.directives
        code.globalstate.directives = self.directives
        self.body.generate_function_definitions(env, code)
        env.directives = env_old
        code.globalstate.directives = code_old
292

293 294 295 296 297
    def generate_execution_code(self, code):
        old = code.globalstate.directives
        code.globalstate.directives = self.directives
        self.body.generate_execution_code(code)
        code.globalstate.directives = old
298

299 300 301 302 303
    def annotate(self, code):
        old = code.globalstate.directives
        code.globalstate.directives = self.directives
        self.body.annotate(code)
        code.globalstate.directives = old
304

Stefan Behnel's avatar
Stefan Behnel committed
305
class BlockNode(object):
William Stein's avatar
William Stein committed
306 307
    #  Mixin class for nodes representing a declaration block.

308
    def generate_cached_builtins_decls(self, env, code):
309
        entries = env.global_scope().undeclared_cached_builtins
310
        for entry in entries:
311
            code.globalstate.add_cached_builtin_decl(entry)
312
        del entries[:]
313 314 315 316

    def generate_lambda_definitions(self, env, code):
        for node in env.lambda_defs:
            node.generate_function_definitions(env, code)
William Stein's avatar
William Stein committed
317 318 319

class StatListNode(Node):
    # stats     a list of StatNode
320

321
    child_attrs = ["stats"]
322 323 324 325 326

    def create_analysed(pos, env, *args, **kw):
        node = StatListNode(pos, *args, **kw)
        return node # No node-specific analysis necesarry
    create_analysed = staticmethod(create_analysed)
327

William Stein's avatar
William Stein committed
328 329 330 331
    def analyse_declarations(self, env):
        #print "StatListNode.analyse_declarations" ###
        for stat in self.stats:
            stat.analyse_declarations(env)
332

William Stein's avatar
William Stein committed
333 334 335 336
    def analyse_expressions(self, env):
        #print "StatListNode.analyse_expressions" ###
        for stat in self.stats:
            stat.analyse_expressions(env)
337

338
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
339 340
        #print "StatListNode.generate_function_definitions" ###
        for stat in self.stats:
341
            stat.generate_function_definitions(env, code)
342

William Stein's avatar
William Stein committed
343 344 345 346 347
    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)
348

349 350 351
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)
352

William Stein's avatar
William Stein committed
353 354 355 356 357 358 359 360 361 362 363 364 365

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.
    #
366

367
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
368
        pass
369

William Stein's avatar
William Stein committed
370 371 372 373 374 375 376 377
    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
378

379
    child_attrs = ["body"]
380

William Stein's avatar
William Stein committed
381 382 383 384 385 386 387
    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
388

William Stein's avatar
William Stein committed
389 390
    def analyse_expressions(self, env):
        pass
391

William Stein's avatar
William Stein committed
392 393
    def generate_execution_code(self, code):
        pass
394 395 396

    def annotate(self, code):
        self.body.annotate(code)
397

William Stein's avatar
William Stein committed
398 399 400 401 402 403 404 405

class CDeclaratorNode(Node):
    # Part of a C declaration.
    #
    # Processing during analyse_declarations phase:
    #
    #   analyse
    #      Returns (name, type) pair where name is the
406
    #      CNameDeclaratorNode of the name being declared
William Stein's avatar
William Stein committed
407 408
    #      and type is the type it is being declared as.
    #
409
    #  calling_convention  string   Calling convention of CFuncDeclaratorNode
410
    #                               for which this is a base
411

412 413
    child_attrs = []

414 415
    calling_convention = ""

William Stein's avatar
William Stein committed
416 417

class CNameDeclaratorNode(CDeclaratorNode):
418
    #  name    string             The Cython name being declared
Robert Bradshaw's avatar
Robert Bradshaw committed
419 420
    #  cname   string or None     C name, if specified
    #  default ExprNode or None   the value assigned on declaration
421

Robert Bradshaw's avatar
Robert Bradshaw committed
422
    child_attrs = ['default']
423

424
    default = None
425

426 427
    def analyse(self, base_type, env, nonempty = 0):
        if nonempty and self.name == '':
428
            # May have mistaken the name for the type.
429
            if base_type.is_ptr or base_type.is_array or base_type.is_buffer:
430
                error(self.pos, "Missing argument name")
431 432
            elif base_type.is_void:
                error(self.pos, "Use spam() rather than spam(void) to declare a function with no arguments.")
433 434 435
            else:
                self.name = base_type.declaration_code("", for_display=1, pyrex=1)
                base_type = py_object_type
436
        self.type = base_type
William Stein's avatar
William Stein committed
437
        return self, base_type
438

William Stein's avatar
William Stein committed
439 440
class CPtrDeclaratorNode(CDeclaratorNode):
    # base     CDeclaratorNode
441

442 443
    child_attrs = ["base"]

444
    def analyse(self, base_type, env, nonempty = 0):
William Stein's avatar
William Stein committed
445 446 447 448
        if base_type.is_pyobject:
            error(self.pos,
                "Pointer base type cannot be a Python object")
        ptr_type = PyrexTypes.c_ptr_type(base_type)
449
        return self.base.analyse(ptr_type, env, nonempty = nonempty)
Danilo Freitas's avatar
Danilo Freitas committed
450 451 452 453 454 455 456 457 458 459

class CReferenceDeclaratorNode(CDeclaratorNode):
    # base     CDeclaratorNode

    child_attrs = ["base"]

    def analyse(self, base_type, env, nonempty = 0):
        if base_type.is_pyobject:
            error(self.pos,
                  "Reference base type cannot be a Python object")
460
        ref_type = PyrexTypes.c_ref_type(base_type)
Danilo Freitas's avatar
Danilo Freitas committed
461 462
        return self.base.analyse(ref_type, env, nonempty = nonempty)

William Stein's avatar
William Stein committed
463 464 465
class CArrayDeclaratorNode(CDeclaratorNode):
    # base        CDeclaratorNode
    # dimension   ExprNode
466 467

    child_attrs = ["base", "dimension"]
468

469
    def analyse(self, base_type, env, nonempty = 0):
Robert Bradshaw's avatar
Robert Bradshaw committed
470 471 472 473 474 475 476 477 478 479 480 481 482
        if base_type.is_cpp_class:
            from ExprNodes import TupleNode
            if isinstance(self.dimension, TupleNode):
                args = self.dimension.args
            else:
                args = self.dimension,
            values = [v.analyse_as_type(env) for v in args]
            if None in values:
                ix = values.index(None)
                error(args[ix].pos, "Template parameter not a type.")
                return error_type
            base_type = base_type.specialize_here(self.pos, values)
            return self.base.analyse(base_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
483 484 485 486
        if self.dimension:
            self.dimension.analyse_const_expression(env)
            if not self.dimension.type.is_int:
                error(self.dimension.pos, "Array dimension not integer")
487 488 489 490 491 492 493
            size = self.dimension.get_constant_c_result_code()
            if size is not None:
                try:
                    size = int(size)
                except ValueError:
                    # runtime constant?
                    pass
William Stein's avatar
William Stein committed
494 495 496 497 498 499 500 501
        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")
502 503 504
        if base_type.is_cfunction:
            error(self.pos,
                "Array element cannot be a function")
William Stein's avatar
William Stein committed
505
        array_type = PyrexTypes.c_array_type(base_type, size)
506
        return self.base.analyse(array_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
507 508 509 510 511 512 513 514


class CFuncDeclaratorNode(CDeclaratorNode):
    # base             CDeclaratorNode
    # args             [CArgDeclNode]
    # has_varargs      boolean
    # exception_value  ConstNode
    # exception_check  boolean    True if PyErr_Occurred check needed
515 516
    # nogil            boolean    Can be called without gil
    # with_gil         boolean    Acquire gil around function body
517

518 519
    child_attrs = ["base", "args", "exception_value"]

520
    overridable = 0
521
    optional_arg_count = 0
William Stein's avatar
William Stein committed
522

523
    def analyse(self, return_type, env, nonempty = 0, directive_locals = {}):
524 525
        if nonempty:
            nonempty -= 1
William Stein's avatar
William Stein committed
526
        func_type_args = []
527 528 529
        for i, arg_node in enumerate(self.args):
            name_declarator, type = arg_node.analyse(env, nonempty = nonempty,
                                                     is_self_arg = (i == 0 and env.is_c_class_scope))
William Stein's avatar
William Stein committed
530
            name = name_declarator.name
531 532 533 534 535
            if name in directive_locals:
                type_node = directive_locals[name]
                other_type = type_node.analyse_as_type(env)
                if other_type is None:
                    error(type_node.pos, "Not a type")
Robert Bradshaw's avatar
Robert Bradshaw committed
536
                elif (type is not PyrexTypes.py_object_type
537 538 539 540 541
                      and not type.same_as(other_type)):
                    error(self.base.pos, "Signature does not agree with previous declaration")
                    error(type_node.pos, "Previous declaration here")
                else:
                    type = other_type
William Stein's avatar
William Stein committed
542
            if name_declarator.cname:
543
                error(self.pos,
William Stein's avatar
William Stein committed
544
                    "Function argument cannot have C name specification")
545 546 547
            if i==0 and env.is_c_class_scope and type.is_unspecified:
                # fix the type of self
                type = env.parent_type
William Stein's avatar
William Stein committed
548 549 550 551 552
            # 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
553
                error(arg_node.pos, "Use spam() rather than spam(void) to declare a function with no arguments.")
William Stein's avatar
William Stein committed
554 555 556
            func_type_args.append(
                PyrexTypes.CFuncTypeArg(name, type, arg_node.pos))
            if arg_node.default:
557
                self.optional_arg_count += 1
558 559
            elif self.optional_arg_count:
                error(self.pos, "Non-default argument follows default argument")
560

561 562
        if self.optional_arg_count:
            scope = StructOrUnionScope()
563
            arg_count_member = '%sn' % Naming.pyrex_prefix
Robert Bradshaw's avatar
Robert Bradshaw committed
564
            scope.declare_var(arg_count_member, PyrexTypes.c_int_type, self.pos)
565 566
            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)
567
            struct_cname = env.mangle(Naming.opt_arg_prefix, self.base.name)
568 569 570 571 572 573
            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)
574
            self.op_args_struct.defined_in_pxd = 1
575
            self.op_args_struct.used = 1
576

William Stein's avatar
William Stein committed
577 578
        exc_val = None
        exc_check = 0
579
        if self.exception_check == '+':
580
            env.add_include_file('ios')         # for std::ios_base::failure
581
            env.add_include_file('new')         # for std::bad_alloc
582
            env.add_include_file('stdexcept')
583
            env.add_include_file('typeinfo')    # for std::bad_cast
William Stein's avatar
William Stein committed
584
        if return_type.is_pyobject \
Robert Bradshaw's avatar
Robert Bradshaw committed
585 586
            and (self.exception_value or self.exception_check) \
            and self.exception_check != '+':
William Stein's avatar
William Stein committed
587 588 589 590 591
                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
592
                if self.exception_check == '+':
593
                    self.exception_value.analyse_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
594 595 596 597 598 599
                    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.")
600
                    exc_val = self.exception_value
Robert Bradshaw's avatar
Robert Bradshaw committed
601
                else:
602
                    self.exception_value = self.exception_value.coerce_to(return_type, env)
603 604 605 606 607 608 609 610
                    if self.exception_value.analyse_const_expression(env):
                        exc_val = self.exception_value.get_constant_c_result_code()
                        if exc_val is None:
                            raise InternalError("get_constant_c_result_code not implemented for %s" %
                                self.exception_value.__class__.__name__)
                        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
611
            exc_check = self.exception_check
612 613 614
        if return_type.is_cfunction:
            error(self.pos,
                "Function cannot return a function")
William Stein's avatar
William Stein committed
615
        func_type = PyrexTypes.CFuncType(
616
            return_type, func_type_args, self.has_varargs,
617
            optional_arg_count = self.optional_arg_count,
618
            exception_value = exc_val, exception_check = exc_check,
619
            calling_convention = self.base.calling_convention,
620
            nogil = self.nogil, with_gil = self.with_gil, is_overridable = self.overridable)
621
        if self.optional_arg_count:
622
            func_type.op_arg_struct = PyrexTypes.c_ptr_type(self.op_args_struct.type)
623 624 625 626 627 628 629
        callspec = env.directives['callspec']
        if callspec:
            current = func_type.calling_convention
            if current and current != callspec:
                error(self.pos, "cannot have both '%s' and '%s' "
                      "calling conventions" % (current, callspec))
            func_type.calling_convention = callspec
William Stein's avatar
William Stein committed
630 631 632 633 634 635 636 637 638
        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'
639 640
    # or_none        boolean            Tagged with 'or None'
    # accept_none    boolean            Resolved boolean for not_none/or_none
William Stein's avatar
William Stein committed
641
    # default        ExprNode or None
642
    # default_value  PyObjectConst      constant for default value
643
    # annotation     ExprNode or None   Py3 function arg annotation
William Stein's avatar
William Stein committed
644
    # is_self_arg    boolean            Is the "self" arg of an extension type method
645
    # is_type_arg    boolean            Is the "class" arg of an extension type classmethod
646 647
    # is_kw_only     boolean            Is a keyword-only argument

648 649
    child_attrs = ["base_type", "declarator", "default"]

William Stein's avatar
William Stein committed
650
    is_self_arg = 0
651
    is_type_arg = 0
652
    is_generic = 1
653 654 655
    kw_only = 0
    not_none = 0
    or_none = 0
656 657
    type = None
    name_declarator = None
658
    default_value = None
659
    annotation = None
660

661 662 663
    def analyse(self, env, nonempty = 0, is_self_arg = False):
        if is_self_arg:
            self.base_type.is_self_arg = self.is_self_arg = True
664 665 666 667 668 669 670 671 672 673 674 675
        if self.type is None:
            # The parser may missinterpret names as types...
            # We fix that here.
            if isinstance(self.declarator, CNameDeclaratorNode) and self.declarator.name == '':
                if nonempty:
                    self.declarator.name = self.base_type.name
                    self.base_type.name = None
                    self.base_type.is_basic_c_type = False
                could_be_name = True
            else:
                could_be_name = False
            base_type = self.base_type.analyse(env, could_be_name = could_be_name)
Robert Bradshaw's avatar
Robert Bradshaw committed
676
            if hasattr(self.base_type, 'arg_name') and self.base_type.arg_name:
677
                self.declarator.name = self.base_type.arg_name
678 679
            # The parser is unable to resolve the ambiguity of [] as part of the
            # type (e.g. in buffers) or empty declarator (as with arrays).
680
            # This is only arises for empty multi-dimensional arrays.
681 682
            if (base_type.is_array
                    and isinstance(self.base_type, TemplatedTypeNode)
683 684 685 686 687 688
                    and isinstance(self.declarator, CArrayDeclaratorNode)):
                declarator = self.declarator
                while isinstance(declarator.base, CArrayDeclaratorNode):
                    declarator = declarator.base
                declarator.base = self.base_type.array_declarator
                base_type = base_type.base_type
689
            return self.declarator.analyse(base_type, env, nonempty = nonempty)
690
        else:
691
            return self.name_declarator, self.type
William Stein's avatar
William Stein committed
692

693 694 695 696 697 698 699 700 701
    def calculate_default_value_code(self, code):
        if self.default_value is None:
            if self.default:
                if self.default.is_literal:
                    # will not output any code, just assign the result_code
                    self.default.generate_evaluation_code(code)
                    return self.type.cast_code(self.default.result())
                self.default_value = code.get_argument_default_const(self.type)
        return self.default_value
702

703 704 705 706
    def annotate(self, code):
        if self.default:
            self.default.annotate(code)

William Stein's avatar
William Stein committed
707 708 709 710 711 712 713 714

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

William Stein's avatar
William Stein committed
716
    pass
717

718 719
    def analyse_as_type(self, env):
        return self.analyse(env)
720

721 722
class CAnalysedBaseTypeNode(Node):
    # type            type
723

724
    child_attrs = []
725

726 727
    def analyse(self, env, could_be_name = False):
        return self.type
William Stein's avatar
William Stein committed
728 729 730 731 732 733 734

class CSimpleBaseTypeNode(CBaseTypeNode):
    # name             string
    # module_path      [string]     Qualifying name components
    # is_basic_c_type  boolean
    # signed           boolean
    # longness         integer
735
    # complex          boolean
William Stein's avatar
William Stein committed
736
    # is_self_arg      boolean      Is self argument of C method
737
    # ##is_type_arg      boolean      Is type argument of class method
William Stein's avatar
William Stein committed
738

739
    child_attrs = []
740
    arg_name = None   # in case the argument name was interpreted as a type
741 742 743
    module_path = []
    is_basic_c_type = False
    complex = False
744

745
    def analyse(self, env, could_be_name = False):
William Stein's avatar
William Stein committed
746
        # Return type descriptor.
747
        #print "CSimpleBaseTypeNode.analyse: is_self_arg =", self.is_self_arg ###
William Stein's avatar
William Stein committed
748 749 750 751 752 753 754 755 756
        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:
757
                #print "CSimpleBaseTypeNode.analyse: defaulting to parent type" ###
William Stein's avatar
William Stein committed
758
                type = env.parent_type
759 760
            ## elif self.is_type_arg and env.is_c_class_scope:
            ##     type = Builtin.type_type
William Stein's avatar
William Stein committed
761 762 763
            else:
                type = py_object_type
        else:
764 765 766 767
            if self.module_path:
                scope = env.find_imported_module(self.module_path, self.pos)
            else:
                scope = env
William Stein's avatar
William Stein committed
768
            if scope:
769 770
                if scope.is_c_class_scope:
                    scope = scope.global_scope()
771
                entry = scope.lookup(self.name)
William Stein's avatar
William Stein committed
772 773
                if entry and entry.is_type:
                    type = entry.type
774 775 776
                elif could_be_name:
                    if self.is_self_arg and env.is_c_class_scope:
                        type = env.parent_type
777 778
                    ## elif self.is_type_arg and env.is_c_class_scope:
                    ##     type = Builtin.type_type
779 780 781
                    else:
                        type = py_object_type
                    self.arg_name = self.name
William Stein's avatar
William Stein committed
782
                else:
Danilo Freitas's avatar
Danilo Freitas committed
783 784 785
                    if self.templates:
                        if not self.name in self.templates:
                            error(self.pos, "'%s' is not a type identifier" % self.name)
786
                        type = PyrexTypes.TemplatePlaceholderType(self.name)
Danilo Freitas's avatar
Danilo Freitas committed
787 788
                    else:
                        error(self.pos, "'%s' is not a type identifier" % self.name)
789
        if self.complex:
790 791 792
            if not type.is_numeric or type.is_complex:
                error(self.pos, "can only complexify c numeric types")
            type = PyrexTypes.CComplexType(type)
793
            type.create_declaration_utility_code(env)
794 795 796 797 798 799 800 801
        elif type is Builtin.complex_type:
            # Special case: optimise builtin complex type into C's
            # double complex.  The parser cannot do this (as for the
            # normal scalar types) as the user may have redeclared the
            # 'complex' type.  Testing for the exact type here works.
            type = PyrexTypes.c_double_complex_type
            type.create_declaration_utility_code(env)
            self.complex = True
William Stein's avatar
William Stein committed
802 803 804 805 806
        if type:
            return type
        else:
            return PyrexTypes.error_type

Robert Bradshaw's avatar
Robert Bradshaw committed
807
class CNestedBaseTypeNode(CBaseTypeNode):
808
    # For C++ classes that live inside other C++ classes.
Robert Bradshaw's avatar
Robert Bradshaw committed
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827

    # name             string
    # base_type        CBaseTypeNode

    child_attrs = ['base_type']

    def analyse(self, env, could_be_name = None):
        base_type = self.base_type.analyse(env)
        if base_type is PyrexTypes.error_type:
            return PyrexTypes.error_type
        if not base_type.is_cpp_class:
            error(self.pos, "'%s' is not a valid type scope" % base_type)
            return PyrexTypes.error_type
        type_entry = base_type.scope.lookup_here(self.name)
        if not type_entry or not type_entry.is_type:
            error(self.pos, "'%s.%s' is not a type identifier" % (base_type, self.name))
            return PyrexTypes.error_type
        return type_entry.type

Danilo Freitas's avatar
Danilo Freitas committed
828
class TemplatedTypeNode(CBaseTypeNode):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
829
    #  After parsing:
830 831
    #  positional_args  [ExprNode]        List of positional arguments
    #  keyword_args     DictNode          Keyword arguments
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
832 833 834
    #  base_type_node   CBaseTypeNode

    #  After analysis:
835
    #  type             PyrexTypes.BufferType or PyrexTypes.CppClassType  ...containing the right options
836

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
837

838 839
    child_attrs = ["base_type_node", "positional_args",
                   "keyword_args", "dtype_node"]
840

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
841
    dtype_node = None
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
842 843

    name = None
844

845 846 847
    def analyse(self, env, could_be_name = False, base_type = None):
        if base_type is None:
            base_type = self.base_type_node.analyse(env)
848
        if base_type.is_error: return base_type
849

850
        if base_type.is_cpp_class:
851
            # Templated class
852
            if self.keyword_args and self.keyword_args.key_value_pairs:
853 854 855 856 857
                error(self.pos, "c++ templates cannot take keyword arguments");
                self.type = PyrexTypes.error_type
            else:
                template_types = []
                for template_node in self.positional_args:
858 859 860 861 862
                    type = template_node.analyse_as_type(env)
                    if type is None:
                        error(template_node.pos, "unknown type in template argument")
                        return error_type
                    template_types.append(type)
863
                self.type = base_type.specialize_here(self.pos, template_types)
864

865 866
        elif base_type.is_pyobject:
            # Buffer
867
            import Buffer
868

869 870 871 872 873 874
            options = Buffer.analyse_buffer_options(
                self.pos,
                env,
                self.positional_args,
                self.keyword_args,
                base_type.buffer_defaults)
875

Robert Bradshaw's avatar
Robert Bradshaw committed
876 877 878
            if sys.version_info[0] < 3:
                # Py 2.x enforces byte strings as keyword arguments ...
                options = dict([ (name.encode('ASCII'), value)
879
                                 for name, value in options.items() ])
Stefan Behnel's avatar
Stefan Behnel committed
880

881
            self.type = PyrexTypes.BufferType(base_type, **options)
882

883 884
        else:
            # Array
885
            empty_declarator = CNameDeclaratorNode(self.pos, name="", cname=None)
886 887 888 889
            if len(self.positional_args) > 1 or self.keyword_args.key_value_pairs:
                error(self.pos, "invalid array declaration")
                self.type = PyrexTypes.error_type
            else:
890
                # It would be nice to merge this class with CArrayDeclaratorNode,
891 892 893 894 895
                # but arrays are part of the declaration, not the type...
                if not self.positional_args:
                    dimension = None
                else:
                    dimension = self.positional_args[0]
896 897
                self.array_declarator = CArrayDeclaratorNode(self.pos,
                    base = empty_declarator,
898 899
                    dimension = dimension)
                self.type = self.array_declarator.analyse(base_type, env)[1]
900

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
901
        return self.type
William Stein's avatar
William Stein committed
902 903 904 905

class CComplexBaseTypeNode(CBaseTypeNode):
    # base_type   CBaseTypeNode
    # declarator  CDeclaratorNode
906

907 908
    child_attrs = ["base_type", "declarator"]

909 910
    def analyse(self, env, could_be_name = False):
        base = self.base_type.analyse(env, could_be_name)
William Stein's avatar
William Stein committed
911 912 913 914 915 916 917 918 919 920
        _, 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]
921
    #  in_pxd        boolean
Stefan Behnel's avatar
Stefan Behnel committed
922
    #  api           boolean
923

924
    #  decorators    [cython.locals(...)] or None
925
    #  directive_locals { string : NameNode } locals defined by cython.locals(...)
926 927

    child_attrs = ["base_type", "declarators"]
928

Robert Bradshaw's avatar
Robert Bradshaw committed
929
    decorators = None
930
    directive_locals = None
931

William Stein's avatar
William Stein committed
932
    def analyse_declarations(self, env, dest_scope = None):
933 934
        if self.directive_locals is None:
            self.directive_locals = {}
William Stein's avatar
William Stein committed
935 936
        if not dest_scope:
            dest_scope = env
937
        self.dest_scope = dest_scope
William Stein's avatar
William Stein committed
938
        base_type = self.base_type.analyse(env)
939
        visibility = self.visibility
940

William Stein's avatar
William Stein committed
941
        for declarator in self.declarators:
942 943 944 945
            if isinstance(declarator, CFuncDeclaratorNode):
                name_declarator, type = declarator.analyse(base_type, env, directive_locals=self.directive_locals)
            else:
                name_declarator, type = declarator.analyse(base_type, env)
William Stein's avatar
William Stein committed
946 947 948 949 950 951 952 953 954
            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
955 956 957
            if name == '':
                error(declarator.pos, "Missing name in declaration.")
                return
William Stein's avatar
William Stein committed
958
            if type.is_cfunction:
959
                entry = dest_scope.declare_cfunction(name, type, declarator.pos,
960 961
                    cname = cname, visibility = self.visibility,
                    in_pxd = self.in_pxd, api = self.api)
Robert Bradshaw's avatar
Robert Bradshaw committed
962
                if entry is not None:
963
                    entry.directive_locals = copy.copy(self.directive_locals)
William Stein's avatar
William Stein committed
964
            else:
965
                if self.directive_locals:
966
                    error(self.pos, "Decorators can only be followed by functions")
967
                entry = dest_scope.declare_var(name, type, declarator.pos,
968 969
                    cname = cname, visibility = visibility,
                    in_pxd = self.in_pxd, api = self.api, is_cdef = 1)
970

William Stein's avatar
William Stein committed
971 972 973 974 975 976

class CStructOrUnionDefNode(StatNode):
    #  name          string
    #  cname         string or None
    #  kind          "struct" or "union"
    #  typedef_flag  boolean
977
    #  visibility    "public" or "private"
978
    #  api           boolean
Stefan Behnel's avatar
Stefan Behnel committed
979
    #  in_pxd        boolean
William Stein's avatar
William Stein committed
980 981
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
982
    #  packed        boolean
983

984
    child_attrs = ["attributes"]
Vitja Makarov's avatar
Vitja Makarov committed
985

986 987
    def declare(self, env, scope=None):
        if self.visibility == 'extern' and self.packed and not scope:
988
            error(self.pos, "Cannot declare extern struct as 'packed'")
William Stein's avatar
William Stein committed
989 990
        self.entry = env.declare_struct_or_union(
            self.name, self.kind, scope, self.typedef_flag, self.pos,
991 992
            self.cname, visibility = self.visibility, api = self.api,
            packed = self.packed)
993 994 995 996 997 998

    def analyse_declarations(self, env):
        scope = None
        if self.attributes is not None:
            scope = StructOrUnionScope(self.name)
        self.declare(env, scope)
William Stein's avatar
William Stein committed
999
        if self.attributes is not None:
Stefan Behnel's avatar
Stefan Behnel committed
1000 1001
            if self.in_pxd and not env.in_cinclude:
                self.entry.defined_in_pxd = 1
William Stein's avatar
William Stein committed
1002 1003
            for attr in self.attributes:
                attr.analyse_declarations(env, scope)
1004 1005 1006 1007
            if self.visibility != 'extern':
                for attr in scope.var_entries:
                    type = attr.type
                    while type.is_array:
1008 1009
                        type = type.base_type
                    if type == self.entry.type:
1010
                        error(attr.pos, "Struct cannot contain itself as a member.")
1011

William Stein's avatar
William Stein committed
1012 1013
    def analyse_expressions(self, env):
        pass
1014

William Stein's avatar
William Stein committed
1015 1016 1017 1018
    def generate_execution_code(self, code):
        pass


Robert Bradshaw's avatar
Robert Bradshaw committed
1019 1020 1021 1022
class CppClassNode(CStructOrUnionDefNode):

    #  name          string
    #  cname         string or None
1023
    #  visibility    "extern"
Robert Bradshaw's avatar
Robert Bradshaw committed
1024 1025 1026
    #  in_pxd        boolean
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
DaniloFreitas's avatar
DaniloFreitas committed
1027
    #  base_classes  [string]
Danilo Freitas's avatar
Danilo Freitas committed
1028
    #  templates     [string] or None
Robert Bradshaw's avatar
Robert Bradshaw committed
1029

1030 1031 1032 1033 1034 1035 1036 1037 1038
    def declare(self, env):
        if self.templates is None:
            template_types = None
        else:
            template_types = [PyrexTypes.TemplatePlaceholderType(template_name) for template_name in self.templates]
        self.entry = env.declare_cpp_class(
            self.name, None, self.pos,
            self.cname, base_classes = [], visibility = self.visibility, templates = template_types)

Robert Bradshaw's avatar
Robert Bradshaw committed
1039 1040
    def analyse_declarations(self, env):
        scope = None
1041
        if self.attributes is not None:
Robert Bradshaw's avatar
Robert Bradshaw committed
1042
            scope = CppClassScope(self.name, env)
1043 1044 1045 1046 1047 1048 1049 1050 1051
        base_class_types = []
        for base_class_name in self.base_classes:
            base_class_entry = env.lookup(base_class_name)
            if base_class_entry is None:
                error(self.pos, "'%s' not found" % base_class_name)
            elif not base_class_entry.is_type or not base_class_entry.type.is_cpp_class:
                error(self.pos, "'%s' is not a cpp class type" % base_class_name)
            else:
                base_class_types.append(base_class_entry.type)
1052 1053 1054 1055
        if self.templates is None:
            template_types = None
        else:
            template_types = [PyrexTypes.TemplatePlaceholderType(template_name) for template_name in self.templates]
1056
        self.entry = env.declare_cpp_class(
1057
            self.name, scope, self.pos,
1058
            self.cname, base_class_types, visibility = self.visibility, templates = template_types)
1059 1060
        if self.entry is None:
            return
Danilo Freitas's avatar
Danilo Freitas committed
1061
        self.entry.is_cpp_class = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
1062 1063 1064 1065
        if self.attributes is not None:
            if self.in_pxd and not env.in_cinclude:
                self.entry.defined_in_pxd = 1
            for attr in self.attributes:
Robert Bradshaw's avatar
Robert Bradshaw committed
1066
                attr.analyse_declarations(scope)
Robert Bradshaw's avatar
Robert Bradshaw committed
1067

William Stein's avatar
William Stein committed
1068 1069 1070 1071 1072
class CEnumDefNode(StatNode):
    #  name           string or None
    #  cname          string or None
    #  items          [CEnumDefItemNode]
    #  typedef_flag   boolean
Stefan Behnel's avatar
Stefan Behnel committed
1073
    #  visibility     "public" or "private"
1074
    #  api            boolean
Stefan Behnel's avatar
Stefan Behnel committed
1075
    #  in_pxd         boolean
William Stein's avatar
William Stein committed
1076
    #  entry          Entry
Robert Bradshaw's avatar
Robert Bradshaw committed
1077

1078
    child_attrs = ["items"]
1079

1080 1081 1082 1083 1084
    def declare(self, env):
         self.entry = env.declare_enum(self.name, self.pos,
             cname = self.cname, typedef_flag = self.typedef_flag,
             visibility = self.visibility, api = self.api)

William Stein's avatar
William Stein committed
1085
    def analyse_declarations(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
1086 1087 1088 1089 1090
        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
1091

1092 1093 1094
    def analyse_expressions(self, env):
        pass

William Stein's avatar
William Stein committed
1095
    def generate_execution_code(self, code):
1096
        if self.visibility == 'public' or self.api:
1097
            temp = code.funcstate.allocate_temp(PyrexTypes.py_object_type, manage_ref=True)
Robert Bradshaw's avatar
Robert Bradshaw committed
1098 1099
            for item in self.entry.enum_values:
                code.putln("%s = PyInt_FromLong(%s); %s" % (
1100
                        temp,
Robert Bradshaw's avatar
Robert Bradshaw committed
1101
                        item.cname,
1102
                        code.error_goto_if_null(temp, item.pos)))
Stefan Behnel's avatar
merge  
Stefan Behnel committed
1103
                code.put_gotref(temp)
1104
                code.putln('if (__Pyx_SetAttrString(%s, "%s", %s) < 0) %s' % (
1105 1106
                        Naming.module_cname,
                        item.name,
1107
                        temp,
Robert Bradshaw's avatar
Robert Bradshaw committed
1108
                        code.error_goto(item.pos)))
Stefan Behnel's avatar
merge  
Stefan Behnel committed
1109
                code.put_decref_clear(temp, PyrexTypes.py_object_type)
1110
            code.funcstate.release_temp(temp)
William Stein's avatar
William Stein committed
1111 1112 1113 1114 1115 1116


class CEnumDefItemNode(StatNode):
    #  name     string
    #  cname    string or None
    #  value    ExprNode or None
1117

1118 1119
    child_attrs = ["value"]

William Stein's avatar
William Stein committed
1120 1121 1122
    def analyse_declarations(self, env, enum_entry):
        if self.value:
            self.value.analyse_const_expression(env)
1123 1124 1125
            if not self.value.type.is_int:
                self.value = self.value.coerce_to(PyrexTypes.c_int_type, env)
                self.value.analyse_const_expression(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
1126
        entry = env.declare_const(self.name, enum_entry.type,
1127
            self.value, self.pos, cname = self.cname,
1128
            visibility = enum_entry.visibility, api = enum_entry.api)
William Stein's avatar
William Stein committed
1129 1130 1131 1132
        enum_entry.enum_values.append(entry)


class CTypeDefNode(StatNode):
Stefan Behnel's avatar
Stefan Behnel committed
1133 1134 1135
    #  base_type    CBaseTypeNode
    #  declarator   CDeclaratorNode
    #  visibility   "public" or "private"
1136
    #  api          boolean
Stefan Behnel's avatar
Stefan Behnel committed
1137
    #  in_pxd       boolean
1138 1139

    child_attrs = ["base_type", "declarator"]
1140

William Stein's avatar
William Stein committed
1141 1142 1143 1144 1145
    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
1146
        entry = env.declare_typedef(name, type, self.pos,
1147
            cname = cname, visibility = self.visibility, api = self.api)
Stefan Behnel's avatar
Stefan Behnel committed
1148 1149
        if self.in_pxd and not env.in_cinclude:
            entry.defined_in_pxd = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
1150

William Stein's avatar
William Stein committed
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
    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
1163
    #  needs_closure   boolean        Whether or not this function has inner functions/classes/yield
Vitja Makarov's avatar
Vitja Makarov committed
1164
    #  needs_outer_scope boolean      Whether or not this function requires outer scope
1165
    #  pymethdef_required boolean     Force Python method struct generation
1166
    #  directive_locals { string : NameNode } locals defined by cython.locals(...)
1167 1168
    # star_arg      PyArgDeclNode or None  * argument
    # starstar_arg  PyArgDeclNode or None  ** argument
1169

1170
    py_func = None
1171
    assmt = None
1172
    needs_closure = False
Vitja Makarov's avatar
Vitja Makarov committed
1173
    needs_outer_scope = False
1174
    pymethdef_required = False
1175
    is_generator = False
1176
    is_generator_body = False
Robert Bradshaw's avatar
Robert Bradshaw committed
1177
    modifiers = []
1178 1179
    star_arg = None
    starstar_arg = None
1180

1181 1182
    def analyse_default_values(self, env):
        genv = env.global_scope()
1183
        default_seen = 0
1184 1185
        for arg in self.args:
            if arg.default:
1186
                default_seen = 1
1187
                if arg.is_generic:
1188 1189
                    arg.default.analyse_types(env)
                    arg.default = arg.default.coerce_to(arg.type, genv)
1190 1191 1192 1193
                else:
                    error(arg.pos,
                        "This argument cannot have a default value")
                    arg.default = None
1194 1195 1196 1197
            elif arg.kw_only:
                default_seen = 1
            elif default_seen:
                error(arg.pos, "Non-default argument following default argument")
1198

1199 1200 1201 1202 1203 1204 1205 1206
    def align_argument_type(self, env, arg):
        directive_locals = self.directive_locals
        type = arg.type
        if arg.name in directive_locals:
            type_node = directive_locals[arg.name]
            other_type = type_node.analyse_as_type(env)
            if other_type is None:
                error(type_node.pos, "Not a type")
Robert Bradshaw's avatar
Robert Bradshaw committed
1207
            elif (type is not PyrexTypes.py_object_type
1208 1209 1210 1211 1212 1213 1214
                    and not type.same_as(other_type)):
                error(arg.base_type.pos, "Signature does not agree with previous declaration")
                error(type_node.pos, "Previous declaration here")
            else:
                arg.type = other_type
        return arg

1215 1216
    def need_gil_acquisition(self, lenv):
        return 0
1217

1218 1219
    def create_local_scope(self, env):
        genv = env
1220
        while genv.is_py_class_scope or genv.is_c_class_scope:
1221
            genv = genv.outer_scope
1222
        if self.needs_closure:
1223 1224 1225
            lenv = ClosureScope(name=self.entry.name,
                                outer_scope = genv,
                                scope_name=self.entry.cname)
1226
        else:
1227 1228 1229
            lenv = LocalScope(name=self.entry.name,
                              outer_scope=genv,
                              parent_scope=env)
William Stein's avatar
William Stein committed
1230
        lenv.return_type = self.return_type
1231 1232 1233
        type = self.entry.type
        if type.is_cfunction:
            lenv.nogil = type.nogil and not type.with_gil
1234
        self.local_scope = lenv
1235
        lenv.directives = env.directives
1236
        return lenv
1237

1238 1239 1240
    def generate_function_body(self, env, code):
        self.body.generate_execution_code(code)

1241
    def generate_function_definitions(self, env, code):
1242
        import Buffer
1243 1244

        lenv = self.local_scope
Vitja Makarov's avatar
Vitja Makarov committed
1245
        if lenv.is_closure_scope and not lenv.is_passthrough:
1246 1247 1248 1249 1250
            outer_scope_cname = "%s->%s" % (Naming.cur_scope_cname,
                                            Naming.outer_scope_cname)
        else:
            outer_scope_cname = Naming.outer_scope_cname
        lenv.mangle_closure_cnames(outer_scope_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
1251 1252
        # Generate closure function definitions
        self.body.generate_function_definitions(lenv, code)
Stefan Behnel's avatar
Stefan Behnel committed
1253
        # generate lambda function definitions
1254
        self.generate_lambda_definitions(lenv, code)
1255

1256 1257
        is_getbuffer_slot = (self.entry.name == "__getbuffer__" and
                             self.entry.scope.is_c_class_scope)
1258 1259 1260
        is_releasebuffer_slot = (self.entry.name == "__releasebuffer__" and
                                 self.entry.scope.is_c_class_scope)
        is_buffer_slot = is_getbuffer_slot or is_releasebuffer_slot
1261
        if is_buffer_slot:
1262 1263
            if 'cython_unused' not in self.modifiers:
                self.modifiers = self.modifiers + ['cython_unused']
1264 1265 1266 1267 1268 1269 1270 1271 1272

        preprocessor_guard = None
        if self.entry.is_special and not is_buffer_slot:
            slot = TypeSlots.method_name_to_slot.get(self.entry.name)
            if slot:
                preprocessor_guard = slot.preprocessor_guard_code()
                if (self.entry.name == '__long__' and
                    not self.entry.scope.lookup_here('__int__')):
                    preprocessor_guard = None
1273

1274
        profile = code.globalstate.directives['profile']
1275 1276 1277
        if profile and lenv.nogil:
            warning(self.pos, "Cannot profile nogil function.", 1)
            profile = False
Robert Bradshaw's avatar
Robert Bradshaw committed
1278
        if profile:
1279
            code.globalstate.use_utility_code(profile_utility_code)
1280

1281
        # Generate C code for header and body of function
1282
        code.enter_cfunc_scope()
1283
        code.return_from_error_cleanup_label = code.new_label()
1284

William Stein's avatar
William Stein committed
1285
        # ----- Top-level constants used by this function
1286
        code.mark_pos(self.pos)
1287
        self.generate_cached_builtins_decls(lenv, code)
William Stein's avatar
William Stein committed
1288 1289
        # ----- Function header
        code.putln("")
1290 1291 1292 1293

        if preprocessor_guard:
            code.putln(preprocessor_guard)

1294 1295
        with_pymethdef = (self.needs_assignment_synthesis(env, code) or
                          self.pymethdef_required)
1296
        if self.py_func:
1297
            self.py_func.generate_function_header(code,
Stefan Behnel's avatar
Stefan Behnel committed
1298
                with_pymethdef = with_pymethdef,
1299
                proto_only=True)
William Stein's avatar
William Stein committed
1300
        self.generate_function_header(code,
Stefan Behnel's avatar
Stefan Behnel committed
1301
            with_pymethdef = with_pymethdef)
William Stein's avatar
William Stein committed
1302
        # ----- Local variable declarations
1303 1304 1305 1306
        # Find function scope
        cenv = env
        while cenv.is_py_class_scope or cenv.is_c_class_scope:
            cenv = cenv.outer_scope
Vitja Makarov's avatar
Vitja Makarov committed
1307
        if self.needs_closure:
1308
            code.put(lenv.scope_class.type.declaration_code(Naming.cur_scope_cname))
Robert Bradshaw's avatar
Robert Bradshaw committed
1309
            code.putln(";")
Vitja Makarov's avatar
Vitja Makarov committed
1310 1311 1312 1313
        elif self.needs_outer_scope:
            if lenv.is_passthrough:
                code.put(lenv.scope_class.type.declaration_code(Naming.cur_scope_cname))
                code.putln(";")
1314
            code.put(cenv.scope_class.type.declaration_code(Naming.outer_scope_cname))
1315
            code.putln(";")
William Stein's avatar
William Stein committed
1316
        self.generate_argument_declarations(lenv, code)
1317

1318 1319 1320
        for entry in lenv.var_entries:
            if not entry.in_closure:
                code.put_var_declaration(entry)
1321

William Stein's avatar
William Stein committed
1322 1323
        init = ""
        if not self.return_type.is_void:
1324 1325
            if self.return_type.is_pyobject:
                init = " = NULL"
William Stein's avatar
William Stein committed
1326
            code.putln(
1327
                "%s%s;" %
1328 1329
                    (self.return_type.declaration_code(Naming.retval_cname),
                     init))
1330
        tempvardecl_code = code.insertion_point()
William Stein's avatar
William Stein committed
1331
        self.generate_keyword_list(code)
1332

1333 1334
        if profile:
            code.put_trace_declarations()
1335

William Stein's avatar
William Stein committed
1336 1337
        # ----- Extern library function declarations
        lenv.generate_library_function_declarations(code)
1338

1339
        # ----- GIL acquisition
1340
        acquire_gil = self.acquire_gil
1341 1342 1343 1344

        # See if we need to acquire the GIL for variable declarations and
        acquire_gil_for_var_decls_only = (lenv.nogil and
                                          lenv.has_with_gil_block)
1345 1346 1347 1348 1349 1350

        use_refnanny = not lenv.nogil or acquire_gil_for_var_decls_only

        if acquire_gil or acquire_gil_for_var_decls_only:
            code.put_ensure_gil()

1351
        # ----- set up refnanny
1352
        if use_refnanny:
1353
            tempvardecl_code.put_declare_refcount_context()
1354
            code.put_setup_refcount_context(self.entry.name)
1355

1356
        # ----- Automatic lead-ins for certain special functions
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1357 1358
        if is_getbuffer_slot:
            self.getbuffer_init(code)
1359
        # ----- Create closure scope object
Robert Bradshaw's avatar
Robert Bradshaw committed
1360
        if self.needs_closure:
1361
            code.putln("%s = (%s)%s->tp_new(%s, %s, NULL);" % (
1362 1363
                Naming.cur_scope_cname,
                lenv.scope_class.type.declaration_code(''),
1364
                lenv.scope_class.type.typeptr_cname,
1365
                lenv.scope_class.type.typeptr_cname,
1366 1367 1368 1369
                Naming.empty_tuple))
            code.putln("if (unlikely(!%s)) {" % Naming.cur_scope_cname)
            if is_getbuffer_slot:
                self.getbuffer_error_cleanup(code)
1370 1371

            if use_refnanny:
1372
                code.put_finish_refcount_context()
1373 1374 1375
                if acquire_gil_for_var_decls_only:
                    code.put_release_ensured_gil()

1376 1377 1378
            # FIXME: what if the error return value is a Python value?
            code.putln("return %s;" % self.error_value())
            code.putln("}")
Robert Bradshaw's avatar
Robert Bradshaw committed
1379
            code.put_gotref(Naming.cur_scope_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
1380
            # Note that it is unsafe to decref the scope at this point.
Vitja Makarov's avatar
Vitja Makarov committed
1381
        if self.needs_outer_scope:
1382 1383
            code.putln("%s = (%s)%s;" % (
                            outer_scope_cname,
1384
                            cenv.scope_class.type.declaration_code(''),
1385
                            Naming.self_cname))
Vitja Makarov's avatar
Vitja Makarov committed
1386 1387 1388
            if lenv.is_passthrough:
                code.putln("%s = %s;" % (Naming.cur_scope_cname, outer_scope_cname));
            elif self.needs_closure:
1389
                # inner closures own a reference to their outer parent
1390
                code.put_incref(outer_scope_cname, cenv.scope_class.type)
1391
                code.put_giveref(outer_scope_cname)
1392 1393 1394 1395 1396
        # ----- Trace function call
        if profile:
            # this looks a bit late, but if we don't get here due to a
            # fatal error before hand, it's not really worth tracing
            code.put_trace_call(self.entry.name, self.pos)
William Stein's avatar
William Stein committed
1397
        # ----- Fetch arguments
1398
        self.generate_argument_parsing_code(env, code)
1399
        # If an argument is assigned to in the body, we must
Robert Bradshaw's avatar
Robert Bradshaw committed
1400 1401
        # incref it to properly keep track of refcounts.
        for entry in lenv.arg_entries:
1402
            if entry.type.is_pyobject:
1403
                if (acquire_gil or entry.assignments) and not entry.in_closure:
1404
                    code.put_var_incref(entry)
1405 1406
        # ----- Initialise local buffer auxiliary variables
        for entry in lenv.var_entries + lenv.arg_entries:
1407
            if entry.type.is_buffer and entry.buffer_aux.buffer_info_var.used:
1408 1409
                code.putln("%s.buf = NULL;" %
                           entry.buffer_aux.buffer_info_var.cname)
1410
        # ----- Check and convert arguments
William Stein's avatar
William Stein committed
1411
        self.generate_argument_type_tests(code)
1412 1413 1414
        # ----- Acquire buffer arguments
        for entry in lenv.arg_entries:
            if entry.type.is_buffer:
1415 1416
                Buffer.put_acquire_arg_buffer(entry, code, self.pos)

1417 1418 1419
        if acquire_gil_for_var_decls_only:
            code.put_release_ensured_gil()

1420 1421 1422
        # -------------------------
        # ----- Function body -----
        # -------------------------
1423
        self.generate_function_body(env, code)
1424

William Stein's avatar
William Stein committed
1425 1426 1427 1428
        # ----- Default return value
        code.putln("")
        if self.return_type.is_pyobject:
            #if self.return_type.is_extension_type:
1429
            #    lhs = "(PyObject *)%s" % Naming.retval_cname
William Stein's avatar
William Stein committed
1430 1431 1432 1433 1434 1435 1436 1437
            #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))
        # ----- Error cleanup
1438 1439 1440
        if code.error_label in code.labels_used:
            code.put_goto(code.return_label)
            code.put_label(code.error_label)
1441 1442
            for cname, type in code.funcstate.all_managed_temps():
                code.put_xdecref(cname, type)
1443 1444 1445 1446 1447

            # Clean up buffers -- this calls a Python function
            # so need to save and restore error state
            buffers_present = len(lenv.buffer_entries) > 0
            if buffers_present:
1448
                code.globalstate.use_utility_code(restore_exception_utility_code)
1449
                code.putln("{ PyObject *__pyx_type, *__pyx_value, *__pyx_tb;")
1450
                code.putln("__Pyx_ErrFetch(&__pyx_type, &__pyx_value, &__pyx_tb);")
1451
                for entry in lenv.buffer_entries:
1452
                    Buffer.put_release_buffer_code(code, entry)
1453
                    #code.putln("%s = 0;" % entry.cname)
1454
                code.putln("__Pyx_ErrRestore(__pyx_type, __pyx_value, __pyx_tb);}")
1455

1456 1457 1458
            err_val = self.error_value()
            exc_check = self.caller_will_check_exceptions()
            if err_val is not None or exc_check:
1459
                # TODO: Fix exception tracing (though currently unused by cProfile).
Robert Bradshaw's avatar
Robert Bradshaw committed
1460 1461
                # code.globalstate.use_utility_code(get_exception_tuple_utility_code)
                # code.put_trace_exception()
1462 1463 1464 1465 1466

                if lenv.nogil:
                    code.putln("{")
                    code.put_ensure_gil()

1467
                code.put_add_traceback(self.entry.qualified_name)
1468 1469 1470 1471

                if lenv.nogil:
                    code.put_release_ensured_gil()
                    code.putln("}")
1472
            else:
1473 1474
                warning(self.entry.pos, "Unraisable exception in function '%s'." \
                            % self.entry.qualified_name, 0)
1475 1476 1477 1478 1479 1480
                format_tuple = (
                    self.entry.qualified_name,
                    Naming.clineno_cname,
                    Naming.lineno_cname,
                    Naming.filename_cname,
                    )
1481
                code.putln(
1482
                    '__Pyx_WriteUnraisable("%s", %s, %s, %s);' % format_tuple)
1483
                env.use_utility_code(unraisable_exception_utility_code)
1484
                env.use_utility_code(restore_exception_utility_code)
1485 1486 1487 1488
            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:
1489
                code.putln("%s = %s;" % (Naming.retval_cname, err_val))
1490 1491 1492 1493 1494 1495 1496 1497

            if is_getbuffer_slot:
                self.getbuffer_error_cleanup(code)

            # If we are using the non-error cleanup section we should
            # jump past it if we have an error. The if-test below determine
            # whether this section is used.
            if buffers_present or is_getbuffer_slot:
1498 1499 1500
                code.put_goto(code.return_from_error_cleanup_label)

        # ----- Non-error return cleanup
William Stein's avatar
William Stein committed
1501
        code.put_label(code.return_label)
1502
        for entry in lenv.buffer_entries:
1503
            if entry.used:
1504
                Buffer.put_release_buffer_code(code, entry)
1505 1506
        if is_getbuffer_slot:
            self.getbuffer_normal_cleanup(code)
1507 1508
        # ----- Return cleanup for both error and no-error return
        code.put_label(code.return_from_error_cleanup_label)
1509

1510
        for entry in lenv.var_entries:
1511 1512 1513
            if entry.type.is_pyobject:
                if entry.used and not entry.in_closure:
                    code.put_var_decref(entry)
Robert Bradshaw's avatar
Robert Bradshaw committed
1514
        # Decref any increfed args
1515
        for entry in lenv.arg_entries:
1516
            if entry.type.is_pyobject:
1517
                if (acquire_gil or entry.assignments) and not entry.in_closure:
1518
                    code.put_var_decref(entry)
Robert Bradshaw's avatar
Robert Bradshaw committed
1519 1520
        if self.needs_closure:
            code.put_decref(Naming.cur_scope_cname, lenv.scope_class.type)
1521

1522
        # ----- Return
1523
        # This code is duplicated in ModuleNode.generate_module_init_func
1524 1525 1526 1527 1528 1529 1530
        if not lenv.nogil:
            default_retval = self.return_type.default_value
            err_val = self.error_value()
            if err_val is None and default_retval:
                err_val = default_retval
            if self.return_type.is_pyobject:
                code.put_xgiveref(self.return_type.as_pyobject(Naming.retval_cname))
1531

1532 1533
        if self.entry.is_special and self.entry.name == "__hash__":
            # Returning -1 for __hash__ is supposed to signal an error
1534
            # We do as Python instances and coerce -1 into -2.
1535 1536
            code.putln("if (unlikely(%s == -1) && !PyErr_Occurred()) %s = -2;" % (
                    Naming.retval_cname, Naming.retval_cname))
1537

Robert Bradshaw's avatar
Robert Bradshaw committed
1538 1539 1540 1541 1542
        if profile:
            if self.return_type.is_pyobject:
                code.put_trace_return(Naming.retval_cname)
            else:
                code.put_trace_return("Py_None")
1543

1544
        if not lenv.nogil:
1545
            # GIL holding funcion
1546
            code.put_finish_refcount_context()
1547

1548
        if acquire_gil or acquire_gil_for_var_decls_only:
1549
            code.put_release_ensured_gil()
1550

William Stein's avatar
William Stein committed
1551
        if not self.return_type.is_void:
1552
            code.putln("return %s;" % Naming.retval_cname)
1553

William Stein's avatar
William Stein committed
1554
        code.putln("}")
1555 1556 1557 1558

        if preprocessor_guard:
            code.putln("#endif /*!(%s)*/" % preprocessor_guard)

1559
        # ----- Go back and insert temp variable declarations
1560
        tempvardecl_code.put_temp_declarations(code.funcstate)
1561
        if code.funcstate.should_declare_error_indicator:
Mark Florisson's avatar
Mark Florisson committed
1562 1563 1564 1565
            # Initialize these variables to shut up compiler warnings
            tempvardecl_code.putln("int %s = 0;" % Naming.lineno_cname)
            tempvardecl_code.putln("const char *%s = NULL;" %
                                                    Naming.filename_cname)
1566
            if code.c_line_in_traceback:
Mark Florisson's avatar
Mark Florisson committed
1567
                tempvardecl_code.putln("int %s = 0;" % Naming.clineno_cname)
1568

1569
        # ----- Python version
1570
        code.exit_cfunc_scope()
1571
        if self.py_func:
1572
            self.py_func.generate_function_definitions(env, code)
1573
        self.generate_wrapper_functions(code)
William Stein's avatar
William Stein committed
1574 1575 1576 1577 1578 1579 1580 1581

    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)
1582

1583 1584 1585
    def generate_arg_type_test(self, arg, code):
        # Generate type test for one argument.
        if arg.type.typeobj_is_available():
1586
            code.globalstate.use_utility_code(arg_type_test_utility_code)
1587 1588 1589 1590
            typeptr_cname = arg.type.typeptr_cname
            arg_code = "((PyObject *)%s)" % arg.entry.cname
            code.putln(
                'if (unlikely(!__Pyx_ArgTypeTest(%s, %s, %d, "%s", %s))) %s' % (
1591
                    arg_code,
1592 1593 1594 1595 1596 1597 1598 1599
                    typeptr_cname,
                    arg.accept_none,
                    arg.name,
                    arg.type.is_builtin_type,
                    code.error_goto(arg.pos)))
        else:
            error(arg.pos, "Cannot test type of extern C class "
                "without type object name specification")
1600 1601 1602 1603 1604 1605 1606 1607

    def generate_arg_none_check(self, arg, code):
        # Generate None check for one argument.
        code.putln('if (unlikely(((PyObject *)%s) == Py_None)) {' % arg.entry.cname)
        code.putln('''PyErr_Format(PyExc_TypeError, "Argument '%s' must not be None"); %s''' % (
            arg.name,
            code.error_goto(arg.pos)))
        code.putln('}')
1608

1609
    def generate_wrapper_functions(self, code):
William Stein's avatar
William Stein committed
1610 1611 1612
        pass

    def generate_execution_code(self, code):
1613 1614 1615 1616
        # Evaluate and store argument default values
        for arg in self.args:
            default = arg.default
            if default:
1617 1618 1619
                if not default.is_literal:
                    default.generate_evaluation_code(code)
                    default.make_owned_reference(code)
1620
                    result = default.result_as(arg.type)
1621
                    code.putln(
1622
                        "%s = %s;" % (
1623 1624 1625 1626 1627
                            arg.calculate_default_value_code(code),
                            result))
                    if arg.type.is_pyobject:
                        code.put_giveref(default.result())
                    default.generate_post_assignment_code(code)
1628
                    default.free_temps(code)
1629 1630 1631
        # 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
1632

1633
    #
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1634
    # Special code for the __getbuffer__ function
1635 1636 1637 1638 1639
    #
    def getbuffer_init(self, code):
        info = self.local_scope.arg_entries[1].cname
        # Python 3.0 betas have a bug in memoryview which makes it call
        # getbuffer with a NULL parameter. For now we work around this;
1640 1641
        # the following block should be removed when this bug is fixed.
        code.putln("if (%s != NULL) {" % info)
1642
        code.putln("%s->obj = Py_None; __Pyx_INCREF(Py_None);" % info)
1643
        code.put_giveref("%s->obj" % info) # Do not refnanny object within structs
1644
        code.putln("}")
1645 1646 1647

    def getbuffer_error_cleanup(self, code):
        info = self.local_scope.arg_entries[1].cname
1648 1649
        code.putln("if (%s != NULL && %s->obj != NULL) {"
                   % (info, info))
1650
        code.put_gotref("%s->obj" % info)
1651 1652 1653
        code.putln("__Pyx_DECREF(%s->obj); %s->obj = NULL;"
                   % (info, info))
        code.putln("}")
1654 1655 1656

    def getbuffer_normal_cleanup(self, code):
        info = self.local_scope.arg_entries[1].cname
1657
        code.putln("if (%s != NULL && %s->obj == Py_None) {" % (info, info))
1658 1659 1660
        code.put_gotref("Py_None")
        code.putln("__Pyx_DECREF(Py_None); %s->obj = NULL;" % info)
        code.putln("}")
William Stein's avatar
William Stein committed
1661 1662 1663 1664

class CFuncDefNode(FuncDefNode):
    #  C function definition.
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
1665
    #  modifiers     ['inline']
William Stein's avatar
William Stein committed
1666 1667 1668 1669
    #  visibility    'private' or 'public' or 'extern'
    #  base_type     CBaseTypeNode
    #  declarator    CDeclaratorNode
    #  body          StatListNode
1670
    #  api           boolean
1671
    #  decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
1672
    #
1673
    #  with_gil      boolean    Acquire GIL around body
William Stein's avatar
William Stein committed
1674
    #  type          CFuncType
1675
    #  py_func       wrapper for calling from Python
1676
    #  overridable   whether or not this is a cpdef function
1677
    #  inline_in_pxd whether this is an inline function in a pxd file
1678

1679
    child_attrs = ["base_type", "declarator", "body", "py_func"]
1680 1681

    inline_in_pxd = False
1682
    decorators = None
1683
    directive_locals = None
1684
    override = None
1685

William Stein's avatar
William Stein committed
1686 1687
    def unqualified_name(self):
        return self.entry.name
1688

William Stein's avatar
William Stein committed
1689
    def analyse_declarations(self, env):
1690 1691
        if self.directive_locals is None:
            self.directive_locals = {}
1692
        self.directive_locals.update(env.directives['locals'])
William Stein's avatar
William Stein committed
1693
        base_type = self.base_type.analyse(env)
1694
        # The 2 here is because we need both function and argument names.
1695 1696 1697 1698 1699 1700
        if isinstance(self.declarator, CFuncDeclaratorNode):
            name_declarator, type = self.declarator.analyse(base_type, env,
                                                            nonempty = 2 * (self.body is not None),
                                                            directive_locals = self.directive_locals)
        else:
            name_declarator, type = self.declarator.analyse(base_type, env, nonempty = 2 * (self.body is not None))
1701
        if not type.is_cfunction:
1702
            error(self.pos,
1703
                "Suite attached to non-function declaration")
William Stein's avatar
William Stein committed
1704 1705 1706 1707 1708
        # 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
1709
        type.is_overridable = self.overridable
1710 1711 1712 1713 1714
        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):
1715
            self.align_argument_type(env, type_arg)
1716
            formal_arg.type = type_arg.type
1717
            formal_arg.name = type_arg.name
1718
            formal_arg.cname = type_arg.cname
1719 1720
            if type_arg.type.is_buffer and 'inline' in self.modifiers:
                warning(formal_arg.pos, "Buffer unpacking not optimized away.", 1)
William Stein's avatar
William Stein committed
1721 1722 1723
        name = name_declarator.name
        cname = name_declarator.cname
        self.entry = env.declare_cfunction(
1724
            name, type, self.pos,
1725 1726
            cname = cname, visibility = self.visibility, api = self.api,
            defining = self.body is not None, modifiers = self.modifiers)
1727
        self.entry.inline_func_in_pxd = self.inline_in_pxd
William Stein's avatar
William Stein committed
1728
        self.return_type = type.return_type
1729 1730 1731
        if self.return_type.is_array and visibility != 'extern':
            error(self.pos,
                "Function cannot return an array")
1732

1733 1734 1735 1736
        if self.overridable and not env.is_module_scope:
            if len(self.args) < 1 or not self.args[0].type.is_pyobject:
                # An error will be produced in the cdef function
                self.overridable = False
1737

1738
        if self.overridable:
1739
            import ExprNodes
1740
            py_func_body = self.call_self_node(is_module_scope = env.is_module_scope)
1741
            self.py_func = DefNode(pos = self.pos,
1742 1743
                                   name = self.entry.name,
                                   args = self.args,
1744 1745
                                   star_arg = None,
                                   starstar_arg = None,
1746
                                   doc = self.doc,
1747 1748
                                   body = py_func_body,
                                   is_wrapper = 1)
1749
            self.py_func.is_module_scope = env.is_module_scope
1750
            self.py_func.analyse_declarations(env)
1751
            self.entry.as_variable = self.py_func.entry
1752 1753
            # Reset scope entry the above cfunction
            env.entries[name] = self.entry
1754 1755
            if (not self.entry.is_final_cmethod and
                (not env.is_module_scope or Options.lookup_module_cpdef)):
1756 1757
                self.override = OverrideCheckNode(self.pos, py_func = self.py_func)
                self.body = StatListNode(self.pos, stats=[self.override, self.body])
1758
        self.create_local_scope(env)
1759

1760
    def call_self_node(self, omit_optional_args=0, is_module_scope=0):
1761 1762 1763 1764 1765
        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]
1766
        if is_module_scope:
1767
            cfunc = ExprNodes.NameNode(self.pos, name=self.entry.name)
1768 1769
        else:
            self_arg = ExprNodes.NameNode(self.pos, name=arg_names[0])
1770
            cfunc = ExprNodes.AttributeNode(self.pos, obj=self_arg, attribute=self.entry.name)
1771 1772
        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)
1773
        return ReturnStatNode(pos=self.pos, return_type=PyrexTypes.py_object_type, value=c_call)
1774

William Stein's avatar
William Stein committed
1775 1776 1777 1778 1779
    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)
1780

1781
    def need_gil_acquisition(self, lenv):
1782 1783
        return self.type.with_gil

1784
    def nogil_check(self, env):
1785
        type = self.type
1786
        with_gil = type.with_gil
1787 1788 1789 1790
        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")
1791
            for entry in self.local_scope.var_entries:
1792
                if entry.type.is_pyobject and not entry.in_with_gil_block:
1793 1794
                    error(self.pos, "Function declared nogil has Python locals or temporaries")

1795
    def analyse_expressions(self, env):
1796
        self.local_scope.directives = env.directives
1797
        if self.py_func is not None:
1798
            # this will also analyse the default values
1799
            self.py_func.analyse_expressions(env)
1800 1801
        else:
            self.analyse_default_values(env)
1802
        self.acquire_gil = self.need_gil_acquisition(self.local_scope)
1803

Robert Bradshaw's avatar
Robert Bradshaw committed
1804 1805 1806
    def needs_assignment_synthesis(self, env, code=None):
        return False

1807
    def generate_function_header(self, code, with_pymethdef, with_opt_args = 1, with_dispatch = 1, cname = None):
1808
        scope = self.local_scope
William Stein's avatar
William Stein committed
1809 1810
        arg_decls = []
        type = self.type
1811
        for arg in type.args[:len(type.args)-type.optional_arg_count]:
1812 1813 1814 1815 1816
            arg_decl = arg.declaration_code()
            entry = scope.lookup(arg.name)
            if not entry.cf_used:
                arg_decl = 'CYTHON_UNUSED %s' % arg_decl
            arg_decls.append(arg_decl)
1817
        if with_dispatch and self.overridable:
1818 1819 1820 1821 1822 1823
            dispatch_arg = PyrexTypes.c_int_type.declaration_code(
                Naming.skip_dispatch_cname)
            if self.override:
                arg_decls.append(dispatch_arg)
            else:
                arg_decls.append('CYTHON_UNUSED %s' % dispatch_arg)
1824 1825
        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
1826 1827 1828 1829
        if type.has_varargs:
            arg_decls.append("...")
        if not arg_decls:
            arg_decls = ["void"]
1830 1831
        if cname is None:
            cname = self.entry.func_cname
1832
        entity = type.function_header_code(cname, ', '.join(arg_decls))
1833 1834
        if self.entry.visibility == 'private':
            storage_class = "static "
William Stein's avatar
William Stein committed
1835
        else:
1836
            storage_class = ""
1837 1838
        dll_linkage = None
        modifiers = ""
1839 1840
        if 'inline' in self.modifiers:
            self.modifiers[self.modifiers.index('inline')] = 'cython_inline'
1841 1842
        if self.modifiers:
            modifiers = "%s " % ' '.join(self.modifiers).upper()
Robert Bradshaw's avatar
Robert Bradshaw committed
1843

1844 1845 1846
        header = self.return_type.declaration_code(entity, dll_linkage=dll_linkage)
        #print (storage_class, modifiers, header)
        code.putln("%s%s%s {" % (storage_class, modifiers, header))
William Stein's avatar
William Stein committed
1847 1848

    def generate_argument_declarations(self, env, code):
1849
        scope = self.local_scope
1850
        for arg in self.args:
1851
            if arg.default:
1852
                entry = scope.lookup(arg.name)
1853
                if self.override or entry.cf_used:
1854 1855 1856
                    result = arg.calculate_default_value_code(code)
                    code.putln('%s = %s;' % (
                        arg.type.declaration_code(arg.cname), result))
1857

William Stein's avatar
William Stein committed
1858 1859
    def generate_keyword_list(self, code):
        pass
1860

1861
    def generate_argument_parsing_code(self, env, code):
1862
        i = 0
1863
        used = 0
1864
        if self.type.optional_arg_count:
1865
            scope = self.local_scope
1866
            code.putln('if (%s) {' % Naming.optional_args_cname)
1867
            for arg in self.args:
1868
                if arg.default:
1869
                    entry = scope.lookup(arg.name)
1870
                    if self.override or entry.cf_used:
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
                        code.putln('if (%s->%sn > %s) {' %
                                   (Naming.optional_args_cname,
                                    Naming.pyrex_prefix, i))
                        declarator = arg.declarator
                        while not hasattr(declarator, 'name'):
                            declarator = declarator.base
                        code.putln('%s = %s->%s;' %
                                   (arg.cname, Naming.optional_args_cname,
                                    self.type.opt_arg_cname(declarator.name)))
                        used += 1
1881
                    i += 1
1882
            for _ in range(used):
1883
                code.putln('}')
1884
            code.putln('}')
1885

William Stein's avatar
William Stein committed
1886 1887
    def generate_argument_conversion_code(self, code):
        pass
1888

William Stein's avatar
William Stein committed
1889
    def generate_argument_type_tests(self, code):
1890 1891 1892 1893 1894
        # 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)
1895 1896
            elif arg.type.is_pyobject and not arg.accept_none:
                self.generate_arg_none_check(arg, code)
1897

William Stein's avatar
William Stein committed
1898 1899 1900 1901
    def error_value(self):
        if self.return_type.is_pyobject:
            return "0"
        else:
1902 1903
            #return None
            return self.entry.type.exception_value
1904

William Stein's avatar
William Stein committed
1905
    def caller_will_check_exceptions(self):
1906
        return self.entry.type.exception_check
1907

1908 1909
    def generate_wrapper_functions(self, code):
        # If the C signature of a function has changed, we need to generate
1910
        # wrappers to put in the slots here.
1911 1912 1913 1914 1915 1916 1917
        k = 0
        entry = self.entry
        func_type = entry.type
        while entry.prev_entry is not None:
            k += 1
            entry = entry.prev_entry
            entry.func_cname = "%s%swrap_%s" % (self.entry.func_cname, Naming.pyrex_prefix, k)
1918
            code.putln()
1919
            self.generate_function_header(code,
1920
                                          0,
1921 1922
                                          with_dispatch = entry.type.is_overridable,
                                          with_opt_args = entry.type.optional_arg_count,
1923
                                          cname = entry.func_cname)
1924 1925 1926 1927
            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]]
1928 1929 1930 1931 1932 1933 1934 1935
            if entry.type.is_overridable:
                arglist.append(Naming.skip_dispatch_cname)
            elif func_type.is_overridable:
                arglist.append('0')
            if entry.type.optional_arg_count:
                arglist.append(Naming.optional_args_cname)
            elif func_type.optional_arg_count:
                arglist.append('NULL')
1936 1937
            code.putln('%s(%s);' % (self.entry.func_cname, ', '.join(arglist)))
            code.putln('}')
1938

William Stein's avatar
William Stein committed
1939 1940 1941 1942 1943

class PyArgDeclNode(Node):
    # Argument which must be a Python object (used
    # for * and ** arguments).
    #
1944 1945 1946
    # name        string
    # entry       Symtab.Entry
    # annotation  ExprNode or None   Py3 argument annotation
1947
    child_attrs = []
1948 1949 1950

    def generate_function_definitions(self, env, code):
        self.entry.generate_function_definitions(env, code)
1951 1952 1953 1954

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

William Stein's avatar
William Stein committed
1958 1959 1960 1961 1962

class DefNode(FuncDefNode):
    # A Python function definition.
    #
    # name          string                 the Python name of the function
Stefan Behnel's avatar
Stefan Behnel committed
1963
    # lambda_name   string                 the internal name of a lambda 'function'
1964
    # decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
1965
    # args          [CArgDeclNode]         formal arguments
1966
    # doc           EncodedString or None
William Stein's avatar
William Stein committed
1967
    # body          StatListNode
1968 1969
    # return_type_annotation
    #               ExprNode or None       the Py3 return type annotation
William Stein's avatar
William Stein committed
1970 1971 1972 1973 1974
    #
    #  The following subnode is constructed internally
    #  when the def statement is inside a Python class definition.
    #
    #  assmt   AssignmentNode   Function construction/assignment
1975
    #  py_cfunc_node  PyCFunctionNode/InnerFunctionNode   The PyCFunction to create and assign
1976

1977
    child_attrs = ["args", "star_arg", "starstar_arg", "body", "decorators"]
1978

Stefan Behnel's avatar
Stefan Behnel committed
1979
    lambda_name = None
William Stein's avatar
William Stein committed
1980
    assmt = None
1981
    num_kwonly_args = 0
1982
    num_required_kw_args = 0
1983
    reqd_kw_flags_cname = "0"
1984
    is_wrapper = 0
1985
    no_assignment_synthesis = 0
1986
    decorators = None
1987
    return_type_annotation = None
1988
    entry = None
Robert Bradshaw's avatar
Robert Bradshaw committed
1989
    acquire_gil = 0
1990
    self_in_stararg = 0
1991
    py_cfunc_node = None
1992
    doc = None
1993

1994 1995
    def __init__(self, pos, **kwds):
        FuncDefNode.__init__(self, pos, **kwds)
1996
        k = rk = r = 0
1997 1998
        for arg in self.args:
            if arg.kw_only:
1999
                k += 1
2000
                if not arg.default:
2001 2002 2003 2004 2005 2006
                    rk += 1
            if not arg.default:
                r += 1
        self.num_kwonly_args = k
        self.num_required_kw_args = rk
        self.num_required_args = r
2007

Haoyu Bai's avatar
Haoyu Bai committed
2008
    def as_cfunction(self, cfunc=None, scope=None, overridable=True):
2009 2010 2011 2012
        if self.star_arg:
            error(self.star_arg.pos, "cdef function cannot have star argument")
        if self.starstar_arg:
            error(self.starstar_arg.pos, "cdef function cannot have starstar argument")
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
        if cfunc is None:
            cfunc_args = []
            for formal_arg in self.args:
                name_declarator, type = formal_arg.analyse(scope, nonempty=1)
                cfunc_args.append(PyrexTypes.CFuncTypeArg(name = name_declarator.name,
                                                          cname = None,
                                                          type = py_object_type,
                                                          pos = formal_arg.pos))
            cfunc_type = PyrexTypes.CFuncType(return_type = py_object_type,
                                              args = cfunc_args,
                                              has_varargs = False,
                                              exception_value = None,
                                              exception_check = False,
                                              nogil = False,
                                              with_gil = False,
Haoyu Bai's avatar
Haoyu Bai committed
2028
                                              is_overridable = overridable)
2029
            cfunc = CVarDefNode(self.pos, type=cfunc_type)
2030
        else:
2031 2032
            if scope is None:
                scope = cfunc.scope
2033 2034 2035
            cfunc_type = cfunc.type
            if len(self.args) != len(cfunc_type.args) or cfunc_type.has_varargs:
                error(self.pos, "wrong number of arguments")
Stefan Behnel's avatar
Stefan Behnel committed
2036
                error(cfunc.pos, "previous declaration here")
2037 2038 2039
            for i, (formal_arg, type_arg) in enumerate(zip(self.args, cfunc_type.args)):
                name_declarator, type = formal_arg.analyse(scope, nonempty=1,
                                                           is_self_arg = (i == 0 and scope.is_c_class_scope))
Stefan Behnel's avatar
Stefan Behnel committed
2040
                if type is None or type is PyrexTypes.py_object_type:
2041 2042
                    formal_arg.type = type_arg.type
                    formal_arg.name_declarator = name_declarator
2043
        import ExprNodes
2044
        if cfunc_type.exception_value is None:
2045 2046
            exception_value = None
        else:
2047
            exception_value = ExprNodes.ConstNode(self.pos, value=cfunc_type.exception_value, type=cfunc_type.return_type)
2048
        declarator = CFuncDeclaratorNode(self.pos,
2049 2050 2051
                                         base = CNameDeclaratorNode(self.pos, name=self.name, cname=None),
                                         args = self.args,
                                         has_varargs = False,
2052
                                         exception_check = cfunc_type.exception_check,
2053
                                         exception_value = exception_value,
2054 2055
                                         with_gil = cfunc_type.with_gil,
                                         nogil = cfunc_type.nogil)
2056
        return CFuncDefNode(self.pos,
2057
                            modifiers = [],
2058
                            base_type = CAnalysedBaseTypeNode(self.pos, type=cfunc_type.return_type),
2059 2060 2061
                            declarator = declarator,
                            body = self.body,
                            doc = self.doc,
2062 2063 2064 2065
                            overridable = cfunc_type.is_overridable,
                            type = cfunc_type,
                            with_gil = cfunc_type.with_gil,
                            nogil = cfunc_type.nogil,
2066
                            visibility = 'private',
2067
                            api = False,
2068
                            directive_locals = getattr(cfunc, 'directive_locals', {}))
2069

2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
    def is_cdef_func_compatible(self):
        """Determines if the function's signature is compatible with a
        cdef function.  This can be used before calling
        .as_cfunction() to see if that will be successful.
        """
        if self.needs_closure:
            return False
        if self.star_arg or self.starstar_arg:
            return False
        return True

William Stein's avatar
William Stein committed
2081
    def analyse_declarations(self, env):
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
        self.is_classmethod = self.is_staticmethod = False
        if self.decorators:
            for decorator in self.decorators:
                func = decorator.decorator
                if func.is_name:
                    self.is_classmethod |= func.name == 'classmethod'
                    self.is_staticmethod |= func.name == 'staticmethod'

        if self.is_classmethod and env.lookup_here('classmethod'):
            # classmethod() was overridden - not much we can do here ...
            self.is_classmethod = False
        if self.is_staticmethod and env.lookup_here('staticmethod'):
            # staticmethod() was overridden - not much we can do here ...
            self.is_staticmethod = False

2097
        if self.name == '__new__' and env.is_py_class_scope:
Vitja Makarov's avatar
Vitja Makarov committed
2098 2099
            self.is_staticmethod = 1

2100
        self.analyse_argument_types(env)
2101 2102 2103 2104
        if self.name == '<lambda>':
            self.declare_lambda_function(env)
        else:
            self.declare_pyfunction(env)
2105 2106 2107 2108 2109
        self.analyse_signature(env)
        self.return_type = self.entry.signature.return_type()
        self.create_local_scope(env)

    def analyse_argument_types(self, env):
2110
        directive_locals = self.directive_locals = env.directives['locals']
2111
        allow_none_for_extension_args = env.directives['allow_none_for_extension_args']
William Stein's avatar
William Stein committed
2112
        for arg in self.args:
2113 2114 2115 2116 2117 2118 2119
            if hasattr(arg, 'name'):
                name_declarator = None
            else:
                base_type = arg.base_type.analyse(env)
                name_declarator, type = \
                    arg.declarator.analyse(base_type, env)
                arg.name = name_declarator.name
2120 2121
                arg.type = type
            self.align_argument_type(env, arg)
2122
            if name_declarator and name_declarator.cname:
William Stein's avatar
William Stein committed
2123 2124
                error(self.pos,
                    "Python function argument cannot have C name specification")
2125
            arg.type = arg.type.as_argument_type()
William Stein's avatar
William Stein committed
2126 2127 2128 2129
            arg.hdr_type = None
            arg.needs_conversion = 0
            arg.needs_type_test = 0
            arg.is_generic = 1
2130
            if arg.type.is_pyobject:
2131 2132 2133 2134
                if arg.or_none:
                    arg.accept_none = True
                elif arg.not_none:
                    arg.accept_none = False
2135
                elif arg.type.is_extension_type or arg.type.is_builtin_type:
2136 2137 2138 2139 2140 2141
                    if arg.default and arg.default.constant_result is None:
                        # special case: def func(MyType obj = None)
                        arg.accept_none = True
                    else:
                        # default depends on compiler directive
                        arg.accept_none = allow_none_for_extension_args
2142 2143 2144
                else:
                    # probably just a plain 'object'
                    arg.accept_none = True
2145
            else:
2146
                arg.accept_none = True # won't be used, but must be there
2147
                if arg.not_none:
2148
                    error(arg.pos, "Only Python type arguments can have 'not None'")
2149
                if arg.or_none:
2150
                    error(arg.pos, "Only Python type arguments can have 'or None'")
2151

William Stein's avatar
William Stein committed
2152
    def analyse_signature(self, env):
2153
        if self.entry.is_special:
2154
            if self.decorators:
2155
                error(self.pos, "special functions of cdef classes cannot have decorators")
2156 2157 2158 2159
            self.entry.trivial_signature = len(self.args) == 1 and not (self.star_arg or self.starstar_arg)
        elif not env.directives['always_allow_keywords'] and not (self.star_arg or self.starstar_arg):
            # Use the simpler calling signature for zero- and one-argument functions.
            if self.entry.signature is TypeSlots.pyfunction_signature:
2160 2161
                if len(self.args) == 0:
                    self.entry.signature = TypeSlots.pyfunction_noargs
2162 2163 2164
                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
2165 2166 2167
            elif self.entry.signature is TypeSlots.pymethod_signature:
                if len(self.args) == 1:
                    self.entry.signature = TypeSlots.unaryfunc
2168 2169 2170
                elif len(self.args) == 2:
                    if self.args[1].default is None and not self.args[1].kw_only:
                        self.entry.signature = TypeSlots.ibinaryfunc
2171

William Stein's avatar
William Stein committed
2172 2173
        sig = self.entry.signature
        nfixed = sig.num_fixed_args()
2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189
        if sig is TypeSlots.pymethod_signature and nfixed == 1 \
               and len(self.args) == 0 and self.star_arg:
            # this is the only case where a diverging number of
            # arguments is not an error - when we have no explicit
            # 'self' parameter as in method(*args)
            sig = self.entry.signature = TypeSlots.pyfunction_signature # self is not 'really' used
            self.self_in_stararg = 1
            nfixed = 0

        for i in range(min(nfixed, len(self.args))):
            arg = self.args[i]
            arg.is_generic = 0
            if sig.is_self_arg(i) and not self.is_staticmethod:
                if self.is_classmethod:
                    arg.is_type_arg = 1
                    arg.hdr_type = arg.type = Builtin.type_type
William Stein's avatar
William Stein committed
2190
                else:
2191 2192 2193
                    arg.is_self_arg = 1
                    arg.hdr_type = arg.type = env.parent_type
                arg.needs_conversion = 0
William Stein's avatar
William Stein committed
2194
            else:
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
                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
                    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

        if nfixed > len(self.args):
            self.bad_signature()
            return
        elif nfixed < len(self.args):
William Stein's avatar
William Stein committed
2210 2211 2212
            if not sig.has_generic_args:
                self.bad_signature()
            for arg in self.args:
Robert Bradshaw's avatar
Robert Bradshaw committed
2213 2214
                if arg.is_generic and \
                        (arg.type.is_extension_type or arg.type.is_builtin_type):
William Stein's avatar
William Stein committed
2215
                    arg.needs_type_test = 1
2216

William Stein's avatar
William Stein committed
2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
    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))
2231 2232 2233

    def signature_has_nongeneric_args(self):
        argcount = len(self.args)
2234 2235 2236
        if argcount == 0 or (
                argcount == 1 and (self.args[0].is_self_arg or
                                   self.args[0].is_type_arg)):
2237 2238 2239 2240 2241
            return 0
        return 1

    def signature_has_generic_args(self):
        return self.entry.signature.has_generic_args
2242

William Stein's avatar
William Stein committed
2243
    def declare_pyfunction(self, env):
2244 2245
        #print "DefNode.declare_pyfunction:", self.name, "in", env ###
        name = self.name
Stefan Behnel's avatar
Stefan Behnel committed
2246
        entry = env.lookup_here(name)
2247 2248
        if entry:
            if entry.is_final_cmethod and not env.parent_type.is_final_type:
Stefan Behnel's avatar
Stefan Behnel committed
2249
                error(self.pos, "Only final types can have final Python (def/cpdef) methods")
2250 2251 2252
            if (entry.type.is_cfunction and not entry.is_builtin_cmethod
                and not self.is_wrapper):
                warning(self.pos, "Overriding cdef method with def method.", 5)
2253
        entry = env.declare_pyfunction(name, self.pos, allow_redefine=not self.is_wrapper)
2254
        self.entry = entry
2255 2256
        prefix = env.next_id(env.scope_prefix)

2257
        entry.func_cname = \
2258
            Naming.pyfunc_prefix + prefix + name
2259 2260
        entry.pymethdef_cname = \
            Naming.pymethdef_prefix + prefix + name
2261 2262
        if Options.docstrings:
            entry.doc = embed_position(self.pos, self.doc)
2263 2264
            entry.doc_cname = \
                Naming.funcdoc_prefix + prefix + name
2265
            if entry.is_special:
2266
                if entry.name in TypeSlots.invisible or not entry.doc or (entry.name in '__getattr__' and env.directives['fast_getattr']):
2267 2268 2269
                    entry.wrapperbase_cname = None
                else:
                    entry.wrapperbase_cname = Naming.wrapperbase_prefix + prefix + name
2270 2271
        else:
            entry.doc = None
2272

Stefan Behnel's avatar
Stefan Behnel committed
2273
    def declare_lambda_function(self, env):
2274
        entry = env.declare_lambda_function(self.lambda_name, self.pos)
Stefan Behnel's avatar
Stefan Behnel committed
2275 2276 2277
        entry.doc = None
        self.entry = entry

William Stein's avatar
William Stein committed
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287
    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)
                if arg.type.is_pyobject:
                    arg.entry.init = "0"
            else:
                arg.entry = self.declare_argument(env, arg)
2288
            arg.entry.is_arg = 1
2289
            arg.entry.used = 1
William Stein's avatar
William Stein committed
2290 2291
            arg.entry.is_self_arg = arg.is_self_arg
            if arg.hdr_type:
2292
                if arg.is_self_arg or arg.is_type_arg or \
William Stein's avatar
William Stein committed
2293 2294 2295 2296 2297 2298 2299
                    (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:
2300
            if env.directives['infer_types'] != False:
2301 2302 2303 2304
                type = PyrexTypes.unspecified_type
            else:
                type = py_object_type
            entry = env.declare_var(arg.name, type, arg.pos)
2305
            entry.is_arg = 1
2306 2307 2308 2309
            entry.used = 1
            entry.init = "0"
            entry.xdecref_cleanup = 1
            arg.entry = entry
2310

William Stein's avatar
William Stein committed
2311
    def analyse_expressions(self, env):
2312
        self.local_scope.directives = env.directives
William Stein's avatar
William Stein committed
2313
        self.analyse_default_values(env)
2314
        if self.needs_assignment_synthesis(env):
Robert Bradshaw's avatar
Robert Bradshaw committed
2315
            # Shouldn't we be doing this at the module level too?
William Stein's avatar
William Stein committed
2316
            self.synthesize_assignment_node(env)
2317 2318 2319
        elif self.decorators:
            for decorator in self.decorators[::-1]:
                decorator.decorator.analyse_expressions(env)
2320

2321
    def needs_assignment_synthesis(self, env, code=None):
2322 2323
        if self.no_assignment_synthesis:
            return False
2324
        # Should enable for module level as well, that will require more testing...
2325
        if self.entry.is_anonymous:
2326
            return True
2327 2328 2329 2330 2331 2332 2333
        if env.is_module_scope:
            if code is None:
                return env.directives['binding']
            else:
                return code.globalstate.directives['binding']
        return env.is_py_class_scope or env.is_closure_scope

William Stein's avatar
William Stein committed
2334 2335
    def synthesize_assignment_node(self, env):
        import ExprNodes
2336 2337 2338
        genv = env
        while genv.is_py_class_scope or genv.is_c_class_scope:
            genv = genv.outer_scope
Vitja Makarov's avatar
Vitja Makarov committed
2339

2340
        if genv.is_closure_scope:
2341
            rhs = self.py_cfunc_node = ExprNodes.InnerFunctionNode(
Stefan Behnel's avatar
Stefan Behnel committed
2342
                self.pos, pymethdef_cname = self.entry.pymethdef_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
2343
        else:
2344
            rhs = self.py_cfunc_node = ExprNodes.PyCFunctionNode(
2345
                self.pos, pymethdef_cname = self.entry.pymethdef_cname, binding = env.directives['binding'])
2346 2347 2348 2349

        if env.is_py_class_scope:
            if not self.is_staticmethod and not self.is_classmethod:
                rhs.binding = True
2350 2351
            else:
                rhs.binding = False
2352

2353 2354 2355 2356 2357 2358 2359
        if self.decorators:
            for decorator in self.decorators[::-1]:
                rhs = ExprNodes.SimpleCallNode(
                    decorator.pos,
                    function = decorator.decorator,
                    args = [rhs])

Robert Bradshaw's avatar
Robert Bradshaw committed
2360 2361 2362
        self.assmt = SingleAssignmentNode(self.pos,
            lhs = ExprNodes.NameNode(self.pos, name = self.name),
            rhs = rhs)
William Stein's avatar
William Stein committed
2363 2364
        self.assmt.analyse_declarations(env)
        self.assmt.analyse_expressions(env)
2365

2366
    def generate_function_header(self, code, with_pymethdef, proto_only=0):
William Stein's avatar
William Stein committed
2367 2368
        arg_code_list = []
        sig = self.entry.signature
2369
        if sig.has_dummy_arg or self.self_in_stararg:
William Stein's avatar
William Stein committed
2370 2371 2372 2373
            arg_code_list.append(
                "PyObject *%s" % Naming.self_cname)
        for arg in self.args:
            if not arg.is_generic:
2374
                if arg.is_self_arg or arg.is_type_arg:
William Stein's avatar
William Stein committed
2375 2376
                    arg_code_list.append("PyObject *%s" % arg.hdr_cname)
                else:
Vitja Makarov's avatar
Vitja Makarov committed
2377 2378 2379 2380 2381 2382
                    decl = arg.hdr_type.declaration_code(arg.hdr_cname)
                    entry = self.local_scope.lookup(arg.name)
                    if not entry.cf_used:
                        arg_code_list.append('CYTHON_UNUSED ' + decl)
                    else:
                        arg_code_list.append(decl)
2383
        if not self.entry.is_special and sig.method_flags() == [TypeSlots.method_noargs]:
2384
            arg_code_list.append("CYTHON_UNUSED PyObject *unused")
Lisandro Dalcin's avatar
Lisandro Dalcin committed
2385 2386
        if (self.entry.scope.is_c_class_scope and self.entry.name == "__ipow__"):
            arg_code_list.append("CYTHON_UNUSED PyObject *unused")
William Stein's avatar
William Stein committed
2387 2388 2389 2390 2391 2392
        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)
2393 2394 2395
        mf = " ".join(self.modifiers).upper()
        if mf: mf += " "
        header = "static %s%s(%s)" % (mf, dc, arg_code)
William Stein's avatar
William Stein committed
2396
        code.putln("%s; /*proto*/" % header)
2397 2398
        if proto_only:
            return
2399
        if (Options.docstrings and self.entry.doc and
2400 2401
                not self.entry.scope.is_property_scope and
                (not self.entry.is_special or self.entry.wrapperbase_cname)):
2402
            docstr = self.entry.doc
Stefan Behnel's avatar
Stefan Behnel committed
2403
            if docstr.is_unicode:
2404
                docstr = docstr.utf8encode()
William Stein's avatar
William Stein committed
2405 2406 2407
            code.putln(
                'static char %s[] = "%s";' % (
                    self.entry.doc_cname,
2408
                    split_string_literal(escape_byte_string(docstr))))
2409 2410 2411
            if self.entry.is_special:
                code.putln(
                    "struct wrapperbase %s;" % self.entry.wrapperbase_cname)
William Stein's avatar
William Stein committed
2412 2413
        if with_pymethdef:
            code.put(
2414
                "static PyMethodDef %s = " %
William Stein's avatar
William Stein committed
2415
                    self.entry.pymethdef_cname)
2416
            code.put_pymethoddef(self.entry, ";", allow_skip=False)
William Stein's avatar
William Stein committed
2417 2418 2419 2420 2421
        code.putln("%s {" % header)

    def generate_argument_declarations(self, env, code):
        for arg in self.args:
            if arg.is_generic: # or arg.needs_conversion:
2422 2423
                if arg.needs_conversion:
                    code.putln("PyObject *%s = 0;" % arg.hdr_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
2424
                elif not arg.entry.in_closure:
2425
                    code.put_var_declaration(arg.entry)
2426

William Stein's avatar
William Stein committed
2427
    def generate_keyword_list(self, code):
2428 2429
        if self.signature_has_generic_args() and \
                self.signature_has_nongeneric_args():
William Stein's avatar
William Stein committed
2430
            code.put(
2431 2432
                "static PyObject **%s[] = {" %
                    Naming.pykwdlist_cname)
William Stein's avatar
William Stein committed
2433 2434
            for arg in self.args:
                if arg.is_generic:
2435 2436
                    pystring_cname = code.intern_identifier(arg.name)
                    code.put('&%s,' % pystring_cname)
2437
            code.putln("0};")
2438

2439
    def generate_argument_parsing_code(self, env, code):
Stefan Behnel's avatar
Stefan Behnel committed
2440 2441
        # Generate fast equivalent of PyArg_ParseTuple call for
        # generic arguments, if any, including args/kwargs
2442
        if self.entry.signature.has_dummy_arg and not self.self_in_stararg:
2443 2444 2445
            # get rid of unused argument warning
            code.putln("%s = %s;" % (Naming.self_cname, Naming.self_cname))

2446 2447
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
Stefan Behnel's avatar
Stefan Behnel committed
2448
        end_label = code.new_label("argument_unpacking_done")
2449

2450 2451 2452
        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
2453

2454
        for arg in self.args:
2455 2456 2457
            if not arg.type.is_pyobject:
                done = arg.type.create_from_py_utility_code(env)
                if not done: pass # will fail later
2458

2459
        if not self.signature_has_generic_args():
2460 2461
            if has_star_or_kw_args:
                error(self.pos, "This method cannot have * or keyword arguments")
2462
            self.generate_argument_conversion_code(code)
2463

2464 2465
        elif not self.signature_has_nongeneric_args():
            # func(*args) or func(**kw) or func(*args, **kw)
2466
            self.generate_stararg_copy_code(code)
2467

2468
        else:
2469
            positional_args = []
2470
            kw_only_args = []
William Stein's avatar
William Stein committed
2471 2472 2473 2474
            for arg in self.args:
                arg_entry = arg.entry
                if arg.is_generic:
                    if arg.default:
2475
                        if not arg.is_self_arg and not arg.is_type_arg:
2476 2477 2478 2479
                            if arg.kw_only:
                                kw_only_args.append(arg)
                            else:
                                positional_args.append(arg)
2480
                    elif arg.kw_only:
2481
                        kw_only_args.append(arg)
2482
                    elif not arg.is_self_arg and not arg.is_type_arg:
2483
                        positional_args.append(arg)
2484

2485
            self.generate_tuple_and_keyword_parsing_code(
2486
                positional_args, kw_only_args, end_label, code)
2487

2488 2489
        code.error_label = old_error_label
        if code.label_used(our_error_label):
2490 2491
            if not code.label_used(end_label):
                code.put_goto(end_label)
2492 2493 2494 2495 2496
            code.put_label(our_error_label)
            if has_star_or_kw_args:
                self.generate_arg_decref(self.star_arg, code)
                if self.starstar_arg:
                    if self.starstar_arg.entry.xdecref_cleanup:
2497
                        code.put_var_xdecref_clear(self.starstar_arg.entry)
2498
                    else:
2499
                        code.put_var_decref_clear(self.starstar_arg.entry)
2500
            code.put_add_traceback(self.entry.qualified_name)
2501 2502 2503 2504 2505
            # The arguments are put into the closure one after the
            # other, so when type errors are found, all references in
            # the closure instance must be properly ref-counted to
            # facilitate generic closure instance deallocation.  In
            # the case of an argument type error, it's best to just
Stefan Behnel's avatar
Stefan Behnel committed
2506 2507
            # DECREF+clear the already handled references, as this
            # frees their references as early as possible.
2508 2509 2510 2511 2512 2513
            for arg in self.args:
                if arg.type.is_pyobject and arg.entry.in_closure:
                    code.put_var_xdecref_clear(arg.entry)
            if self.needs_closure:
                code.put_decref(Naming.cur_scope_cname, self.local_scope.scope_class.type)
            code.put_finish_refcount_context()
2514
            code.putln("return %s;" % self.error_value())
2515
        if code.label_used(end_label):
2516 2517
            code.put_label(end_label)

2518 2519 2520 2521 2522 2523 2524 2525 2526 2527
        # fix refnanny view on closure variables here, instead of
        # doing it separately for each arg parsing special case
        if self.star_arg and self.star_arg.entry.in_closure:
            code.put_var_giveref(self.star_arg.entry)
        if self.starstar_arg and self.starstar_arg.entry.in_closure:
            code.put_var_giveref(self.starstar_arg.entry)
        for arg in self.args:
            if arg.type.is_pyobject and arg.entry.in_closure:
                code.put_var_giveref(arg.entry)

2528 2529 2530 2531
    def generate_arg_assignment(self, arg, item, code):
        if arg.type.is_pyobject:
            if arg.is_generic:
                item = PyrexTypes.typecast(arg.type, PyrexTypes.py_object_type, item)
2532 2533
            entry = arg.entry
            if entry.in_closure:
2534 2535
                code.put_incref(item, PyrexTypes.py_object_type)
            code.putln("%s = %s;" % (entry.cname, item))
2536 2537 2538 2539 2540 2541 2542 2543
        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)))
2544
            else:
2545
                error(arg.pos, "Cannot convert Python object argument to type '%s'" % arg.type)
2546

William Stein's avatar
William Stein committed
2547 2548
    def generate_arg_xdecref(self, arg, code):
        if arg:
2549
            code.put_var_xdecref_clear(arg.entry)
2550

2551 2552
    def generate_arg_decref(self, arg, code):
        if arg:
2553
            code.put_var_decref_clear(arg.entry)
William Stein's avatar
William Stein committed
2554

2555 2556
    def generate_stararg_copy_code(self, code):
        if not self.star_arg:
2557 2558 2559 2560
            code.globalstate.use_utility_code(raise_argtuple_invalid_utility_code)
            code.putln("if (unlikely(PyTuple_GET_SIZE(%s) > 0)) {" %
                       Naming.args_cname)
            code.put('__Pyx_RaiseArgtupleInvalid("%s", 1, 0, 0, PyTuple_GET_SIZE(%s)); return %s;' % (
Stefan Behnel's avatar
Stefan Behnel committed
2561
                    self.name, Naming.args_cname, self.error_value()))
2562
            code.putln("}")
2563

2564 2565 2566 2567 2568 2569 2570 2571
        if self.starstar_arg:
            if self.star_arg:
                kwarg_check = "unlikely(%s)" % Naming.kwds_cname
            else:
                kwarg_check = "%s" % Naming.kwds_cname
        else:
            kwarg_check = "unlikely(%s) && unlikely(PyDict_Size(%s) > 0)" % (
                Naming.kwds_cname, Naming.kwds_cname)
2572
        code.globalstate.use_utility_code(keyword_string_check_utility_code)
2573
        code.putln(
2574 2575
            "if (%s && unlikely(!__Pyx_CheckKeywordStrings(%s, \"%s\", %d))) return %s;" % (
                kwarg_check, Naming.kwds_cname, self.name,
2576
                bool(self.starstar_arg), self.error_value()))
2577

2578
        if self.starstar_arg:
2579
            code.putln("%s = (%s) ? PyDict_Copy(%s) : PyDict_New();" % (
2580 2581 2582
                    self.starstar_arg.entry.cname,
                    Naming.kwds_cname,
                    Naming.kwds_cname))
2583 2584
            code.putln("if (unlikely(!%s)) return %s;" % (
                    self.starstar_arg.entry.cname, self.error_value()))
2585
            self.starstar_arg.entry.xdecref_cleanup = 0
2586
            code.put_gotref(self.starstar_arg.entry.cname)
2587

2588 2589 2590 2591 2592 2593 2594 2595
        if self.self_in_stararg:
            # need to create a new tuple with 'self' inserted as first item
            code.put("%s = PyTuple_New(PyTuple_GET_SIZE(%s)+1); if (unlikely(!%s)) " % (
                    self.star_arg.entry.cname,
                    Naming.args_cname,
                    self.star_arg.entry.cname))
            if self.starstar_arg:
                code.putln("{")
2596
                code.put_decref_clear(self.starstar_arg.entry.cname, py_object_type)
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618
                code.putln("return %s;" % self.error_value())
                code.putln("}")
            else:
                code.putln("return %s;" % self.error_value())
            code.put_gotref(self.star_arg.entry.cname)
            code.put_incref(Naming.self_cname, py_object_type)
            code.put_giveref(Naming.self_cname)
            code.putln("PyTuple_SET_ITEM(%s, 0, %s);" % (
                self.star_arg.entry.cname, Naming.self_cname))
            temp = code.funcstate.allocate_temp(PyrexTypes.c_py_ssize_t_type, manage_ref=False)
            code.putln("for (%s=0; %s < PyTuple_GET_SIZE(%s); %s++) {" % (
                temp, temp, Naming.args_cname, temp))
            code.putln("PyObject* item = PyTuple_GET_ITEM(%s, %s);" % (
                Naming.args_cname, temp))
            code.put_incref("item", py_object_type)
            code.put_giveref("item")
            code.putln("PyTuple_SET_ITEM(%s, %s+1, item);" % (
                self.star_arg.entry.cname, temp))
            code.putln("}")
            code.funcstate.release_temp(temp)
            self.star_arg.entry.xdecref_cleanup = 0
        elif self.star_arg:
2619 2620 2621 2622 2623 2624
            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

2625
    def generate_tuple_and_keyword_parsing_code(self, positional_args,
2626 2627
                                                kw_only_args, success_label, code):
        argtuple_error_label = code.new_label("argtuple_error")
2628

2629
        min_positional_args = self.num_required_args - self.num_required_kw_args
2630
        if len(self.args) > 0 and (self.args[0].is_self_arg or self.args[0].is_type_arg):
2631 2632
            min_positional_args -= 1
        max_positional_args = len(positional_args)
2633 2634
        has_fixed_positional_count = not self.star_arg and \
            min_positional_args == max_positional_args
2635

Stefan Behnel's avatar
Stefan Behnel committed
2636 2637 2638
        if self.num_required_kw_args:
            code.globalstate.use_utility_code(raise_keyword_required_utility_code)

2639 2640 2641 2642 2643
        if self.starstar_arg or self.star_arg:
            self.generate_stararg_init_code(max_positional_args, code)

        # --- optimised code when we receive keyword arguments
        if self.num_required_kw_args:
2644
            likely_hint = "likely"
2645
        else:
2646 2647
            likely_hint = "unlikely"
        code.putln("if (%s(%s)) {" % (likely_hint, Naming.kwds_cname))
2648 2649
        self.generate_keyword_unpacking_code(
            min_positional_args, max_positional_args,
2650
            has_fixed_positional_count,
2651 2652 2653
            positional_args, kw_only_args, argtuple_error_label, code)

        # --- optimised code when we do not receive any keyword arguments
2654
        if (self.num_required_kw_args and min_positional_args > 0) or min_positional_args == max_positional_args:
2655 2656 2657 2658 2659 2660 2661 2662 2663
            # Python raises arg tuple related errors first, so we must
            # check the length here
            if min_positional_args == max_positional_args and not self.star_arg:
                compare = '!='
            else:
                compare = '<'
            code.putln('} else if (PyTuple_GET_SIZE(%s) %s %d) {' % (
                    Naming.args_cname, compare, min_positional_args))
            code.put_goto(argtuple_error_label)
2664

2665 2666 2667 2668 2669 2670 2671 2672 2673
        if self.num_required_kw_args:
            # pure error case: keywords required but not passed
            if max_positional_args > min_positional_args and not self.star_arg:
                code.putln('} else if (PyTuple_GET_SIZE(%s) > %d) {' % (
                        Naming.args_cname, max_positional_args))
                code.put_goto(argtuple_error_label)
            code.putln('} else {')
            for i, arg in enumerate(kw_only_args):
                if not arg.default:
2674
                    pystring_cname = code.intern_identifier(arg.name)
2675
                    # required keyword-only argument missing
2676
                    code.put('__Pyx_RaiseKeywordRequired("%s", %s); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2677
                            self.name,
2678
                            pystring_cname))
2679 2680
                    code.putln(code.error_goto(self.pos))
                    break
2681

2682 2683 2684
        elif min_positional_args == max_positional_args:
            # parse the exact number of positional arguments from the
            # args tuple
2685 2686 2687 2688 2689
            code.putln('} else {')
            for i, arg in enumerate(positional_args):
                item = "PyTuple_GET_ITEM(%s, %d)" % (Naming.args_cname, i)
                self.generate_arg_assignment(arg, item, code)
            self.generate_arg_default_assignments(code)
2690

2691 2692 2693 2694
        else:
            # parse the positional arguments from the variable length
            # args tuple
            code.putln('} else {')
2695
            self.generate_arg_default_assignments(code)
2696
            code.putln('switch (PyTuple_GET_SIZE(%s)) {' % Naming.args_cname)
2697 2698
            if self.star_arg:
                code.putln('default:')
2699 2700 2701 2702 2703 2704 2705 2706 2707
            reversed_args = list(enumerate(positional_args))[::-1]
            for i, arg in reversed_args:
                if i >= min_positional_args-1:
                    if min_positional_args > 1:
                        code.putln('case %2d:' % (i+1)) # pure code beautification
                    else:
                        code.put('case %2d: ' % (i+1))
                item = "PyTuple_GET_ITEM(%s, %d)" % (Naming.args_cname, i)
                self.generate_arg_assignment(arg, item, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
2708 2709 2710
            if min_positional_args == 0:
                code.put('case  0: ')
            code.putln('break;')
2711 2712 2713 2714 2715 2716
            if self.star_arg:
                if min_positional_args:
                    for i in range(min_positional_args-1, -1, -1):
                        code.putln('case %2d:' % i)
                    code.put_goto(argtuple_error_label)
            else:
2717 2718 2719 2720 2721 2722 2723 2724 2725
                code.put('default: ')
                code.put_goto(argtuple_error_label)
            code.putln('}')

        code.putln('}')

        if code.label_used(argtuple_error_label):
            code.put_goto(success_label)
            code.put_label(argtuple_error_label)
2726
            code.globalstate.use_utility_code(raise_argtuple_invalid_utility_code)
2727
            code.put('__Pyx_RaiseArgtupleInvalid("%s", %d, %d, %d, PyTuple_GET_SIZE(%s)); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2728
                    self.name, has_fixed_positional_count,
2729 2730 2731 2732
                    min_positional_args, max_positional_args,
                    Naming.args_cname))
            code.putln(code.error_goto(self.pos))

2733 2734 2735 2736 2737 2738
    def generate_arg_default_assignments(self, code):
        for arg in self.args:
            if arg.is_generic and arg.default:
                code.putln(
                    "%s = %s;" % (
                        arg.entry.cname,
2739
                        arg.calculate_default_value_code(code)))
2740

2741
    def generate_stararg_init_code(self, max_positional_args, code):
2742
        if self.starstar_arg:
2743
            self.starstar_arg.entry.xdecref_cleanup = 0
Stefan Behnel's avatar
Stefan Behnel committed
2744 2745 2746 2747
            code.putln('%s = PyDict_New(); if (unlikely(!%s)) return %s;' % (
                    self.starstar_arg.entry.cname,
                    self.starstar_arg.entry.cname,
                    self.error_value()))
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
2748
            code.put_gotref(self.starstar_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
2749 2750 2751 2752 2753
        if self.star_arg:
            self.star_arg.entry.xdecref_cleanup = 0
            code.putln('if (PyTuple_GET_SIZE(%s) > %d) {' % (
                    Naming.args_cname,
                    max_positional_args))
2754
            code.putln('%s = PyTuple_GetSlice(%s, %d, PyTuple_GET_SIZE(%s));' % (
Stefan Behnel's avatar
Stefan Behnel committed
2755 2756
                    self.star_arg.entry.cname, Naming.args_cname,
                    max_positional_args, Naming.args_cname))
2757
            code.putln("if (unlikely(!%s)) {" % self.star_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
2758
            if self.starstar_arg:
2759
                code.put_decref_clear(self.starstar_arg.entry.cname, py_object_type)
2760 2761
            if self.needs_closure:
                code.put_decref(Naming.cur_scope_cname, self.local_scope.scope_class.type)
2762 2763 2764 2765
            code.put_finish_refcount_context()
            code.putln('return %s;' % self.error_value())
            code.putln('}')
            code.put_gotref(self.star_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
2766 2767 2768 2769
            code.putln('} else {')
            code.put("%s = %s; " % (self.star_arg.entry.cname, Naming.empty_tuple))
            code.put_incref(Naming.empty_tuple, py_object_type)
            code.putln('}')
2770

2771
    def generate_keyword_unpacking_code(self, min_positional_args, max_positional_args,
2772 2773
                                        has_fixed_positional_count, positional_args,
                                        kw_only_args, argtuple_error_label, code):
2774 2775 2776
        all_args = tuple(positional_args) + tuple(kw_only_args)
        max_args = len(all_args)

2777 2778
        code.putln("Py_ssize_t kw_args = PyDict_Size(%s);" %
                   Naming.kwds_cname)
Stefan Behnel's avatar
Stefan Behnel committed
2779 2780
        # the 'values' array collects borrowed references to arguments
        # before doing any type coercion etc.
2781
        code.putln("PyObject* values[%d] = {%s};" % (
Stefan Behnel's avatar
Stefan Behnel committed
2782
            max_args, ','.join('0'*max_args)))
2783

2784 2785 2786 2787 2788 2789 2790 2791
        # assign borrowed Python default values to the values array,
        # so that they can be overwritten by received arguments below
        for i, arg in enumerate(all_args):
            if arg.default and arg.type.is_pyobject:
                default_value = arg.calculate_default_value_code(code)
                code.putln('values[%d] = %s;' % (i, arg.type.as_pyobject(default_value)))

        # parse the args tuple and check that it's not too long
2792
        code.putln('switch (PyTuple_GET_SIZE(%s)) {' % Naming.args_cname)
Stefan Behnel's avatar
Stefan Behnel committed
2793 2794
        if self.star_arg:
            code.putln('default:')
2795
        for i in range(max_positional_args-1, -1, -1):
2796
            code.put('case %2d: ' % (i+1))
2797 2798
            code.putln("values[%d] = PyTuple_GET_ITEM(%s, %d);" % (
                    i, Naming.args_cname, i))
2799
        code.putln('case  0: break;')
2800
        if not self.star_arg:
Stefan Behnel's avatar
Stefan Behnel committed
2801
            code.put('default: ') # more arguments than allowed
2802
            code.put_goto(argtuple_error_label)
2803 2804
        code.putln('}')

Stefan Behnel's avatar
Stefan Behnel committed
2805 2806
        # now fill up the positional/required arguments with values
        # from the kw dict
2807
        if self.num_required_args or max_positional_args > 0:
Stefan Behnel's avatar
Stefan Behnel committed
2808 2809 2810 2811
            last_required_arg = -1
            for i, arg in enumerate(all_args):
                if not arg.default:
                    last_required_arg = i
2812 2813 2814
            if last_required_arg < max_positional_args:
                last_required_arg = max_positional_args-1
            num_required_args = self.num_required_args
Stefan Behnel's avatar
Stefan Behnel committed
2815 2816
            if max_positional_args > 0:
                code.putln('switch (PyTuple_GET_SIZE(%s)) {' % Naming.args_cname)
2817
            for i, arg in enumerate(all_args[:last_required_arg+1]):
Stefan Behnel's avatar
Stefan Behnel committed
2818
                if max_positional_args > 0 and i <= max_positional_args:
2819 2820 2821 2822
                    if self.star_arg and i == max_positional_args:
                        code.putln('default:')
                    else:
                        code.putln('case %2d:' % i)
2823
                pystring_cname = code.intern_identifier(arg.name)
2824
                if arg.default:
2825 2826 2827
                    if arg.kw_only:
                        # handled separately below
                        continue
2828
                    code.putln('if (kw_args > 0) {')
2829
                    code.putln('PyObject* value = PyDict_GetItem(%s, %s);' % (
2830
                        Naming.kwds_cname, pystring_cname))
2831
                    code.putln('if (value) { values[%d] = value; kw_args--; }' % i)
2832 2833 2834 2835
                    code.putln('}')
                else:
                    num_required_args -= 1
                    code.putln('values[%d] = PyDict_GetItem(%s, %s);' % (
2836
                        i, Naming.kwds_cname, pystring_cname))
2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
                    code.putln('if (likely(values[%d])) kw_args--;' % i);
                    if i < min_positional_args:
                        if i == 0:
                            # special case: we know arg 0 is missing
                            code.put('else ')
                            code.put_goto(argtuple_error_label)
                        else:
                            # print the correct number of values (args or
                            # kwargs) that were passed into positional
                            # arguments up to this point
                            code.putln('else {')
2848
                            code.globalstate.use_utility_code(raise_argtuple_invalid_utility_code)
2849
                            code.put('__Pyx_RaiseArgtupleInvalid("%s", %d, %d, %d, %d); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2850
                                    self.name, has_fixed_positional_count,
2851 2852 2853 2854
                                    min_positional_args, max_positional_args, i))
                            code.putln(code.error_goto(self.pos))
                            code.putln('}')
                    elif arg.kw_only:
2855
                        code.putln('else {')
2856
                        code.put('__Pyx_RaiseKeywordRequired("%s", %s); ' %(
Stefan Behnel's avatar
Stefan Behnel committed
2857
                                self.name, pystring_cname))
2858 2859
                        code.putln(code.error_goto(self.pos))
                        code.putln('}')
Stefan Behnel's avatar
Stefan Behnel committed
2860 2861
            if max_positional_args > 0:
                code.putln('}')
2862

2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876
        if kw_only_args and not self.starstar_arg:
            # unpack optional keyword-only arguments
            # checking for interned strings in a dict is faster than iterating
            # but it's too likely that we must iterate if we expect **kwargs
            optional_args = []
            for i, arg in enumerate(all_args[max_positional_args:]):
                if not arg.kw_only or not arg.default:
                    continue
                optional_args.append((i+max_positional_args, arg))
            if optional_args:
                # this mimics an unrolled loop so that we can "break" out of it
                code.putln('while (kw_args > 0) {')
                code.putln('PyObject* value;')
                for i, arg in optional_args:
2877
                    pystring_cname = code.intern_identifier(arg.name)
2878 2879
                    code.putln(
                        'value = PyDict_GetItem(%s, %s);' % (
2880
                        Naming.kwds_cname, pystring_cname))
2881 2882 2883 2884 2885
                    code.putln(
                        'if (value) { values[%d] = value; if (!(--kw_args)) break; }' % i)
                code.putln('break;')
                code.putln('}')

2886
        code.putln('if (unlikely(kw_args > 0)) {')
2887 2888
        # non-positional/-required kw args left in dict: default args,
        # kw-only args, **kwargs or error
Stefan Behnel's avatar
Stefan Behnel committed
2889 2890 2891 2892 2893
        #
        # This is sort of a catch-all: except for checking required
        # arguments, this will always do the right thing for unpacking
        # keyword arguments, so that we can concentrate on optimising
        # common cases above.
2894 2895 2896
        if max_positional_args == 0:
            pos_arg_count = "0"
        elif self.star_arg:
Stefan Behnel's avatar
Stefan Behnel committed
2897 2898 2899 2900 2901 2902
            code.putln("const Py_ssize_t used_pos_args = (PyTuple_GET_SIZE(%s) < %d) ? PyTuple_GET_SIZE(%s) : %d;" % (
                    Naming.args_cname, max_positional_args,
                    Naming.args_cname, max_positional_args))
            pos_arg_count = "used_pos_args"
        else:
            pos_arg_count = "PyTuple_GET_SIZE(%s)" % Naming.args_cname
2903
        code.globalstate.use_utility_code(parse_keywords_utility_code)
Stefan Behnel's avatar
Stefan Behnel committed
2904
        code.put(
2905
            'if (unlikely(__Pyx_ParseOptionalKeywords(%s, %s, %s, values, %s, "%s") < 0)) ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2906 2907 2908 2909
                Naming.kwds_cname,
                Naming.pykwdlist_cname,
                self.starstar_arg and self.starstar_arg.entry.cname or '0',
                pos_arg_count,
Stefan Behnel's avatar
Stefan Behnel committed
2910
                self.name))
2911
        code.putln(code.error_goto(self.pos))
2912
        code.putln('}')
2913

2914
        # convert arg values to their final type and assign them
2915
        for i, arg in enumerate(all_args):
2916
            if arg.default and not arg.type.is_pyobject:
2917 2918
                code.putln("if (values[%d]) {" % i)
            self.generate_arg_assignment(arg, "values[%d]" % i, code)
2919
            if arg.default and not arg.type.is_pyobject:
2920 2921 2922 2923
                code.putln('} else {')
                code.putln(
                    "%s = %s;" % (
                        arg.entry.cname,
2924
                        arg.calculate_default_value_code(code)))
2925
                code.putln('}')
2926

William Stein's avatar
William Stein committed
2927
    def generate_argument_conversion_code(self, code):
2928 2929 2930
        # Generate code to convert arguments from signature type to
        # declared type, if needed.  Also copies signature arguments
        # into closure fields.
William Stein's avatar
William Stein committed
2931 2932 2933
        for arg in self.args:
            if arg.needs_conversion:
                self.generate_arg_conversion(arg, code)
2934
            elif arg.entry.in_closure:
2935
                if arg.type.is_pyobject:
Stefan Behnel's avatar
Stefan Behnel committed
2936 2937
                    code.put_incref(arg.hdr_cname, py_object_type)
                code.putln('%s = %s;' % (arg.entry.cname, arg.hdr_cname))
William Stein's avatar
William Stein committed
2938 2939 2940 2941 2942 2943

    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
2944 2945 2946 2947
            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
2948
            self.generate_arg_conversion_from_pyobject(arg, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
2949
            code.putln("}")
William Stein's avatar
William Stein committed
2950 2951 2952 2953 2954 2955 2956 2957
        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,
2958
                    "Cannot convert 1 argument from '%s' to '%s'" %
William Stein's avatar
William Stein committed
2959
                        (old_type, new_type))
2960

William Stein's avatar
William Stein committed
2961 2962 2963
    def generate_arg_conversion_from_pyobject(self, arg, code):
        new_type = arg.type
        func = new_type.from_py_function
2964
        # copied from CoerceFromPyTypeNode
William Stein's avatar
William Stein committed
2965
        if func:
2966 2967 2968 2969 2970
            lhs = arg.entry.cname
            rhs = "%s(%s)" % (func, arg.hdr_cname)
            if new_type.is_enum:
                rhs = PyrexTypes.typecast(new_type, PyrexTypes.c_long_type, rhs)
            code.putln("%s = %s; %s" % (
2971
                lhs,
2972
                rhs,
2973
                code.error_goto_if(new_type.error_condition(arg.entry.cname), arg.pos)))
William Stein's avatar
William Stein committed
2974
        else:
2975 2976
            error(arg.pos,
                "Cannot convert Python object argument to type '%s'"
William Stein's avatar
William Stein committed
2977
                    % new_type)
2978

William Stein's avatar
William Stein committed
2979 2980 2981 2982
    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
2983
            code.putln("%s = %s(%s); %s" % (
William Stein's avatar
William Stein committed
2984 2985 2986
                arg.entry.cname,
                func,
                arg.hdr_cname,
Robert Bradshaw's avatar
Robert Bradshaw committed
2987
                code.error_goto_if_null(arg.entry.cname, arg.pos)))
2988
            code.put_var_gotref(arg.entry)
William Stein's avatar
William Stein committed
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
        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)
3001 3002 3003
            elif not arg.accept_none and arg.type.is_pyobject:
                self.generate_arg_none_check(arg, code)

William Stein's avatar
William Stein committed
3004 3005
    def error_value(self):
        return self.entry.signature.error_value
3006

William Stein's avatar
William Stein committed
3007 3008
    def caller_will_check_exceptions(self):
        return 1
3009

3010 3011 3012 3013 3014 3015 3016 3017 3018 3019

class GeneratorDefNode(DefNode):
    # Generator DefNode.
    #
    # gbody          GeneratorBodyDefNode
    #

    is_generator = True
    needs_closure = True

Stefan Behnel's avatar
Stefan Behnel committed
3020
    child_attrs = DefNode.child_attrs + ["gbody"]
3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042

    def __init__(self, **kwargs):
        # XXX: don't actually needs a body
        kwargs['body'] = StatListNode(kwargs['pos'], stats=[])
        super(GeneratorDefNode, self).__init__(**kwargs)

    def analyse_declarations(self, env):
        super(GeneratorDefNode, self).analyse_declarations(env)
        self.gbody.local_scope = self.local_scope
        self.gbody.analyse_declarations(env)

    def generate_function_body(self, env, code):
        body_cname = self.gbody.entry.func_cname
        generator_cname = '%s->%s' % (Naming.cur_scope_cname, Naming.obj_base_cname)

        code.putln('%s.resume_label = 0;' % generator_cname)
        code.putln('%s.body = (__pyx_generator_body_t) %s;' % (generator_cname, body_cname))
        code.put_giveref(Naming.cur_scope_cname)
        code.put_finish_refcount_context()
        code.putln("return (PyObject *) %s;" % Naming.cur_scope_cname);

    def generate_function_definitions(self, env, code):
3043 3044 3045
        from ExprNodes import generator_utility_code
        env.use_utility_code(generator_utility_code)

3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056
        self.gbody.generate_function_header(code, proto=True)
        super(GeneratorDefNode, self).generate_function_definitions(env, code)
        self.gbody.generate_function_definitions(env, code)


class GeneratorBodyDefNode(DefNode):
    # Generator body DefNode.
    #

    is_generator_body = True

3057
    def __init__(self, pos=None, name=None, body=None):
3058 3059 3060 3061
        super(GeneratorBodyDefNode, self).__init__(pos=pos, body=body, name=name, doc=None,
                                                   args=[],
                                                   star_arg=None, starstar_arg=None)

3062 3063
    def declare_generator_body(self, env):
        prefix = env.next_id(env.scope_prefix)
Vitja Makarov's avatar
Vitja Makarov committed
3064
        name = env.next_id('generator')
3065 3066 3067 3068
        cname = Naming.genbody_prefix + prefix + name
        entry = env.declare_var(None, py_object_type, self.pos,
                                cname=cname, visibility='private')
        entry.func_cname = cname
3069 3070 3071 3072 3073 3074
        entry.qualified_name = EncodedString(self.name)
        self.entry = entry

    def analyse_declarations(self, env):
        self.analyse_argument_types(env)
        self.declare_generator_body(env)
3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125

    def generate_function_header(self, code, proto=False):
        header = "static PyObject *%s(%s, PyObject *%s)" % (
            self.entry.func_cname,
            self.local_scope.scope_class.type.declaration_code(Naming.cur_scope_cname),
            Naming.sent_value_cname)
        if proto:
            code.putln('%s; /* proto */' % header)
        else:
            code.putln('%s /* generator body */\n{' % header);

    def generate_function_definitions(self, env, code):
        lenv = self.local_scope

        # Generate closure function definitions
        self.body.generate_function_definitions(lenv, code)

        # Generate C code for header and body of function
        code.enter_cfunc_scope()
        code.return_from_error_cleanup_label = code.new_label()

        # ----- Top-level constants used by this function
        code.mark_pos(self.pos)
        self.generate_cached_builtins_decls(lenv, code)
        # ----- Function header
        code.putln("")
        self.generate_function_header(code)
        # ----- Local variables
        code.putln("PyObject *%s = NULL;" % Naming.retval_cname)
        tempvardecl_code = code.insertion_point()
        code.put_declare_refcount_context()
        code.put_setup_refcount_context(self.entry.name)

        # ----- Resume switch point.
        code.funcstate.init_closure_temps(lenv.scope_class.type.scope)
        resume_code = code.insertion_point()
        first_run_label = code.new_label('first_run')
        code.use_label(first_run_label)
        code.put_label(first_run_label)
        code.putln('%s' %
                   (code.error_goto_if_null(Naming.sent_value_cname, self.pos)))

        # ----- Function body
        self.generate_function_body(env, code)
        code.putln('PyErr_SetNone(PyExc_StopIteration); %s' % code.error_goto(self.pos))
        # ----- Error cleanup
        if code.error_label in code.labels_used:
            code.put_goto(code.return_label)
            code.put_label(code.error_label)
            for cname, type in code.funcstate.all_managed_temps():
                code.put_xdecref(cname, type)
3126
            code.put_add_traceback(self.entry.qualified_name)
3127 3128 3129

        # ----- Non-error return cleanup
        code.put_label(code.return_label)
3130
        code.put_xdecref(Naming.retval_cname, py_object_type)
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140
        code.putln('%s->%s.resume_label = -1;' % (Naming.cur_scope_cname, Naming.obj_base_cname))
        code.put_finish_refcount_context()
        code.putln('return NULL;');
        code.putln("}")

        # ----- Go back and insert temp variable declarations
        tempvardecl_code.put_temp_declarations(code.funcstate)
        # ----- Generator resume code
        resume_code.putln("switch (%s->%s.resume_label) {" % (Naming.cur_scope_cname, Naming.obj_base_cname));
        resume_code.putln("case 0: goto %s;" % first_run_label)
3141 3142 3143 3144 3145

        from ParseTreeTransforms import YieldNodeCollector
        collector = YieldNodeCollector()
        collector.visitchildren(self)
        for yield_expr in collector.yields:
3146 3147 3148 3149 3150 3151 3152 3153 3154
            resume_code.putln("case %d: goto %s;" % (yield_expr.label_num, yield_expr.label_name));
        resume_code.putln("default: /* CPython raises the right error here */");
        resume_code.put_finish_refcount_context()
        resume_code.putln("return NULL;");
        resume_code.putln("}");

        code.exit_cfunc_scope()


3155 3156
class OverrideCheckNode(StatNode):
    # A Node for dispatching to the def method if it
3157
    # is overriden.
3158 3159 3160 3161 3162 3163
    #
    #  py_func
    #
    #  args
    #  func_temp
    #  body
3164

Robert Bradshaw's avatar
Robert Bradshaw committed
3165
    child_attrs = ['body']
3166

3167
    body = None
Robert Bradshaw's avatar
Robert Bradshaw committed
3168

3169 3170
    def analyse_expressions(self, env):
        self.args = env.arg_entries
3171 3172 3173 3174
        if self.py_func.is_module_scope:
            first_arg = 0
        else:
            first_arg = 1
3175
        import ExprNodes
3176
        self.func_node = ExprNodes.RawCNameExprNode(self.pos, py_object_type)
3177
        call_tuple = ExprNodes.TupleNode(self.pos, args=[ExprNodes.NameNode(self.pos, name=arg.name) for arg in self.args[first_arg:]])
3178
        call_node = ExprNodes.SimpleCallNode(self.pos,
3179
                                             function=self.func_node,
3180
                                             args=[ExprNodes.NameNode(self.pos, name=arg.name) for arg in self.args[first_arg:]])
3181 3182
        self.body = ReturnStatNode(self.pos, value=call_node)
        self.body.analyse_expressions(env)
3183

3184
    def generate_execution_code(self, code):
3185
        interned_attr_cname = code.intern_identifier(self.py_func.entry.name)
3186
        # Check to see if we are an extension type
3187 3188 3189 3190
        if self.py_func.is_module_scope:
            self_arg = "((PyObject *)%s)" % Naming.module_cname
        else:
            self_arg = "((PyObject *)%s)" % self.args[0].cname
3191
        code.putln("/* Check if called by wrapper */")
3192
        code.putln("if (unlikely(%s)) ;" % Naming.skip_dispatch_cname)
3193
        code.putln("/* Check if overriden in Python */")
3194 3195 3196
        if self.py_func.is_module_scope:
            code.putln("else {")
        else:
3197
            code.putln("else if (unlikely(Py_TYPE(%s)->tp_dictoffset != 0)) {" % self_arg)
3198 3199
        func_node_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        self.func_node.set_cname(func_node_temp)
3200
        # need to get attribute manually--scope would return cdef method
3201
        err = code.error_goto_if_null(func_node_temp, self.pos)
3202
        code.putln("%s = PyObject_GetAttr(%s, %s); %s" % (
3203 3204 3205
            func_node_temp, self_arg, interned_attr_cname, err))
        code.put_gotref(func_node_temp)
        is_builtin_function_or_method = "PyCFunction_Check(%s)" % func_node_temp
Robert Bradshaw's avatar
Robert Bradshaw committed
3206
        is_overridden = "(PyCFunction_GET_FUNCTION(%s) != (void *)&%s)" % (
3207
            func_node_temp, self.py_func.entry.func_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
3208
        code.putln("if (!%s || %s) {" % (is_builtin_function_or_method, is_overridden))
3209 3210
        self.body.generate_execution_code(code)
        code.putln("}")
3211 3212
        code.put_decref_clear(func_node_temp, PyrexTypes.py_object_type)
        code.funcstate.release_temp(func_node_temp)
Robert Bradshaw's avatar
Robert Bradshaw committed
3213
        code.putln("}")
3214

Robert Bradshaw's avatar
Robert Bradshaw committed
3215 3216
class ClassDefNode(StatNode, BlockNode):
    pass
3217

Robert Bradshaw's avatar
Robert Bradshaw committed
3218
class PyClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
3219 3220
    #  A Python class definition.
    #
Stefan Behnel's avatar
Stefan Behnel committed
3221
    #  name     EncodedString   Name of the class
William Stein's avatar
William Stein committed
3222 3223 3224 3225
    #  doc      string or None
    #  body     StatNode        Attribute definition code
    #  entry    Symtab.Entry
    #  scope    PyClassScope
3226
    #  decorators    [DecoratorNode]        list of decorators or None
William Stein's avatar
William Stein committed
3227 3228 3229
    #
    #  The following subnodes are constructed internally:
    #
3230
    #  dict     DictNode   Class dictionary or Py3 namespace
William Stein's avatar
William Stein committed
3231 3232
    #  classobj ClassNode  Class object
    #  target   NameNode   Variable to assign class object to
3233

3234
    child_attrs = ["body", "dict", "metaclass", "mkw", "bases", "class_result", "target"]
3235
    decorators = None
3236
    class_result = None
Stefan Behnel's avatar
Stefan Behnel committed
3237
    py3_style_class = False # Python3 style class (bases+kwargs)
3238

3239 3240
    def __init__(self, pos, name, bases, doc, body, decorators = None,
                 keyword_args = None, starstar_arg = None):
William Stein's avatar
William Stein committed
3241 3242 3243 3244
        StatNode.__init__(self, pos)
        self.name = name
        self.doc = doc
        self.body = body
3245
        self.decorators = decorators
William Stein's avatar
William Stein committed
3246
        import ExprNodes
3247
        if self.doc and Options.docstrings:
3248
            doc = embed_position(self.pos, self.doc)
3249
            doc_node = ExprNodes.StringNode(pos, value = doc)
William Stein's avatar
William Stein committed
3250 3251
        else:
            doc_node = None
3252 3253
        if keyword_args or starstar_arg:
            self.py3_style_class = True
3254
            self.bases = bases
3255
            self.metaclass = None
3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266
            if keyword_args and not starstar_arg:
                for i, item in list(enumerate(keyword_args.key_value_pairs))[::-1]:
                    if item.key.value == 'metaclass':
                        if self.metaclass is not None:
                            error(item.pos, "keyword argument 'metaclass' passed multiple times")
                        # special case: we already know the metaclass,
                        # so we don't need to do the "build kwargs,
                        # find metaclass" dance at runtime
                        self.metaclass = item.value
                        del keyword_args.key_value_pairs[i]
            if starstar_arg or (keyword_args and keyword_args.key_value_pairs):
3267 3268
                self.mkw = ExprNodes.KeywordArgsNode(
                    pos, keyword_args = keyword_args, starstar_arg = starstar_arg)
3269 3270 3271
            else:
                self.mkw = ExprNodes.NullNode(pos)
            if self.metaclass is None:
3272 3273
                self.metaclass = ExprNodes.PyClassMetaclassNode(
                    pos, mkw = self.mkw, bases = self.bases)
3274 3275
            self.dict = ExprNodes.PyClassNamespaceNode(pos, name = name,
                        doc = doc_node, metaclass = self.metaclass, bases = self.bases,
3276
                        mkw = self.mkw)
3277 3278 3279 3280 3281 3282 3283 3284 3285 3286
            self.classobj = ExprNodes.Py3ClassNode(pos, name = name,
                    bases = self.bases, dict = self.dict, doc = doc_node,
                    metaclass = self.metaclass, mkw = self.mkw)
        else:
            self.dict = ExprNodes.DictNode(pos, key_value_pairs = [])
            self.metaclass = None
            self.mkw = None
            self.bases = None
            self.classobj = ExprNodes.ClassNode(pos, name = name,
                    bases = bases, dict = self.dict, doc = doc_node)
William Stein's avatar
William Stein committed
3287
        self.target = ExprNodes.NameNode(pos, name = name)
3288

3289 3290
    def as_cclass(self):
        """
3291
        Return this node as if it were declared as an extension class
3292
        """
3293 3294 3295
        if self.py3_style_class:
            error(self.classobj.pos, "Python3 style class could not be represented as C class")
            return
3296 3297 3298 3299 3300 3301 3302
        bases = self.classobj.bases.args
        if len(bases) == 0:
            base_class_name = None
            base_class_module = None
        elif len(bases) == 1:
            base = bases[0]
            path = []
3303 3304
            from ExprNodes import AttributeNode, NameNode
            while isinstance(base, AttributeNode):
3305 3306
                path.insert(0, base.attribute)
                base = base.obj
3307
            if isinstance(base, NameNode):
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318
                path.insert(0, base.name)
                base_class_name = path[-1]
                if len(path) > 1:
                    base_class_module = u'.'.join(path[:-1])
                else:
                    base_class_module = None
            else:
                error(self.classobj.bases.args.pos, "Invalid base class")
        else:
            error(self.classobj.bases.args.pos, "C class may only have one base class")
            return None
3319 3320

        return CClassDefNode(self.pos,
3321 3322 3323 3324 3325
                             visibility = 'private',
                             module_name = None,
                             class_name = self.name,
                             base_class_module = base_class_module,
                             base_class_name = base_class_name,
3326
                             decorators = self.decorators,
3327 3328 3329
                             body = self.body,
                             in_pxd = False,
                             doc = self.doc)
3330

3331 3332
    def create_scope(self, env):
        genv = env
3333 3334
        while genv.is_py_class_scope or genv.is_c_class_scope:
            genv = genv.outer_scope
3335 3336
        cenv = self.scope = PyClassScope(name = self.name, outer_scope = genv)
        return cenv
3337

William Stein's avatar
William Stein committed
3338
    def analyse_declarations(self, env):
3339 3340 3341 3342 3343 3344 3345 3346 3347 3348
        class_result = self.classobj
        if self.decorators:
            from ExprNodes import SimpleCallNode
            for decorator in self.decorators[::-1]:
                class_result = SimpleCallNode(
                    decorator.pos,
                    function = decorator.decorator,
                    args = [class_result])
        self.class_result = class_result
        self.class_result.analyse_declarations(env)
William Stein's avatar
William Stein committed
3349
        self.target.analyse_target_declaration(env)
3350
        cenv = self.create_scope(env)
3351
        cenv.directives = env.directives
3352 3353
        cenv.class_obj_cname = self.target.entry.cname
        self.body.analyse_declarations(cenv)
3354

William Stein's avatar
William Stein committed
3355
    def analyse_expressions(self, env):
3356 3357 3358 3359
        if self.py3_style_class:
            self.bases.analyse_expressions(env)
            self.metaclass.analyse_expressions(env)
            self.mkw.analyse_expressions(env)
William Stein's avatar
William Stein committed
3360
        self.dict.analyse_expressions(env)
3361
        self.class_result.analyse_expressions(env)
William Stein's avatar
William Stein committed
3362
        genv = env.global_scope()
3363
        cenv = self.scope
William Stein's avatar
William Stein committed
3364
        self.body.analyse_expressions(cenv)
3365
        self.target.analyse_target_expression(env, self.classobj)
3366

3367
    def generate_function_definitions(self, env, code):
3368
        self.generate_lambda_definitions(self.scope, code)
3369
        self.body.generate_function_definitions(self.scope, code)
3370

William Stein's avatar
William Stein committed
3371
    def generate_execution_code(self, code):
3372 3373
        code.pyclass_stack.append(self)
        cenv = self.scope
3374 3375 3376 3377
        if self.py3_style_class:
            self.bases.generate_evaluation_code(code)
            self.mkw.generate_evaluation_code(code)
            self.metaclass.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
3378
        self.dict.generate_evaluation_code(code)
Vitja Makarov's avatar
Vitja Makarov committed
3379 3380
        cenv.namespace_cname = cenv.class_obj_cname = self.dict.result()
        self.body.generate_execution_code(code)
3381
        self.class_result.generate_evaluation_code(code)
3382
        cenv.namespace_cname = cenv.class_obj_cname = self.classobj.result()
3383
        self.target.generate_assignment_code(self.class_result, code)
William Stein's avatar
William Stein committed
3384
        self.dict.generate_disposal_code(code)
3385
        self.dict.free_temps(code)
3386 3387 3388 3389 3390 3391 3392
        if self.py3_style_class:
            self.mkw.generate_disposal_code(code)
            self.mkw.free_temps(code)
            self.metaclass.generate_disposal_code(code)
            self.metaclass.free_temps(code)
            self.bases.generate_disposal_code(code)
            self.bases.free_temps(code)
3393
        code.pyclass_stack.pop()
William Stein's avatar
William Stein committed
3394

Robert Bradshaw's avatar
Robert Bradshaw committed
3395
class CClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
3396 3397 3398 3399
    #  An extension type definition.
    #
    #  visibility         'private' or 'public' or 'extern'
    #  typedef_flag       boolean
Stefan Behnel's avatar
Stefan Behnel committed
3400
    #  api                boolean
William Stein's avatar
William Stein committed
3401 3402 3403 3404 3405 3406 3407 3408
    #  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
3409
    #  decorators         [DecoratorNode]   list of decorators or None
William Stein's avatar
William Stein committed
3410 3411 3412 3413
    #  doc                string or None
    #  body               StatNode or None
    #  entry              Symtab.Entry
    #  base_type          PyExtensionType or None
3414 3415
    #  buffer_defaults_node DictNode or None Declares defaults for a buffer
    #  buffer_defaults_pos
3416

3417
    child_attrs = ["body"]
3418 3419
    buffer_defaults_node = None
    buffer_defaults_pos = None
3420 3421 3422 3423
    typedef_flag = False
    api = False
    objstruct_name = None
    typeobj_name = None
3424
    decorators = None
3425
    shadow = False
3426

Robert Bradshaw's avatar
Robert Bradshaw committed
3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438
    def buffer_defaults(self, env):
        if not hasattr(self, '_buffer_defaults'):
            import Buffer
            if self.buffer_defaults_node:
                self._buffer_defaults = Buffer.analyse_buffer_options(
                    self.buffer_defaults_pos,
                    env, [], self.buffer_defaults_node,
                    need_complete=False)
            else:
                self._buffer_defaults = None
        return self._buffer_defaults

3439 3440 3441 3442 3443 3444 3445 3446
    def declare(self, env):
        if self.module_name and self.visibility != 'extern':
            module_path = self.module_name.split(".")
            home_scope = env.find_imported_module(module_path, self.pos)
            if not home_scope:
                return None
        else:
            home_scope = env
3447

3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459
        self.entry = home_scope.declare_c_class(
            name = self.class_name,
            pos = self.pos,
            defining = 0,
            implementing = 0,
            module_name = self.module_name,
            base_type = None,
            objstruct_cname = self.objstruct_name,
            typeobj_cname = self.typeobj_name,
            visibility = self.visibility,
            typedef_flag = self.typedef_flag,
            api = self.api,
Robert Bradshaw's avatar
Robert Bradshaw committed
3460
            buffer_defaults = self.buffer_defaults(env),
3461 3462 3463 3464 3465 3466
            shadow = self.shadow)

    def analyse_declarations(self, env):
        #print "CClassDefNode.analyse_declarations:", self.class_name
        #print "...visibility =", self.visibility
        #print "...module_name =", self.module_name
3467

William Stein's avatar
William Stein committed
3468 3469 3470
        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")
3471 3472 3473
        if self.decorators:
            error(self.pos,
                  "Decorators not allowed on cdef classes (used on type '%s')" % self.class_name)
William Stein's avatar
William Stein committed
3474
        self.base_type = None
3475 3476
        # Now that module imports are cached, we need to
        # import the modules for extern classes.
3477 3478 3479 3480 3481 3482 3483
        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)
3484
                self.module.has_extern_class = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
3485
                env.add_imported_module(self.module)
3486

William Stein's avatar
William Stein committed
3487 3488 3489 3490 3491
        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
3492 3493 3494 3495 3496 3497
            if self.base_class_name == 'object':
                # extension classes are special and don't need to inherit from object
                if base_class_scope is None or base_class_scope.lookup('object') is None:
                    self.base_class_name = None
                    self.base_class_module = None
                    base_class_scope = None
William Stein's avatar
William Stein committed
3498 3499 3500 3501 3502
            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)
3503 3504 3505
                    elif not base_class_entry.type.is_extension_type and \
                             not (base_class_entry.type.is_builtin_type and \
                                  base_class_entry.type.objstruct_cname):
William Stein's avatar
William Stein committed
3506 3507
                        error(self.pos, "'%s' is not an extension type" % self.base_class_name)
                    elif not base_class_entry.type.is_complete():
3508 3509 3510
                        error(self.pos, "Base class '%s' of type '%s' is incomplete" % (
                            self.base_class_name, self.class_name))
                    elif base_class_entry.type.scope and base_class_entry.type.scope.directives and \
3511
                             base_class_entry.type.is_final_type:
3512 3513
                        error(self.pos, "Base class '%s' of type '%s' is final" % (
                            self.base_class_name, self.class_name))
3514 3515 3516 3517
                    elif base_class_entry.type.is_builtin_type and \
                             base_class_entry.type.name in ('tuple', 'str', 'bytes'):
                        error(self.pos, "inheritance from PyVarObject types like '%s' is not currently supported"
                              % base_class_entry.type.name)
William Stein's avatar
William Stein committed
3518 3519 3520
                    else:
                        self.base_type = base_class_entry.type
        has_body = self.body is not None
3521
        if self.module_name and self.visibility != 'extern':
3522 3523 3524 3525 3526 3527
            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
3528 3529

        if self.visibility == 'extern':
3530 3531 3532
            if (self.module_name == '__builtin__' and
                self.class_name in Builtin.builtin_types and
                env.qualified_name[:8] != 'cpython.'): # allow overloaded names for cimporting from cpython
3533
                warning(self.pos, "%s already a builtin Cython type" % self.class_name, 1)
3534

3535
        self.entry = home_scope.declare_c_class(
3536
            name = self.class_name,
William Stein's avatar
William Stein committed
3537 3538 3539 3540 3541 3542 3543 3544
            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
3545
            typedef_flag = self.typedef_flag,
3546
            api = self.api,
Robert Bradshaw's avatar
Robert Bradshaw committed
3547
            buffer_defaults = self.buffer_defaults(env),
3548
            shadow = self.shadow)
3549

3550 3551
        if self.shadow:
            home_scope.lookup(self.class_name).as_variable = self.entry
3552
        if home_scope is not env and self.visibility == 'extern':
3553
            env.add_imported_entry(self.class_name, self.entry, self.pos)
3554
        self.scope = scope = self.entry.type.scope
3555 3556
        if scope is not None:
            scope.directives = env.directives
3557

3558
        if self.doc and Options.docstrings:
3559
            scope.doc = embed_position(self.pos, self.doc)
3560

William Stein's avatar
William Stein committed
3561 3562 3563 3564 3565 3566 3567
        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)
3568

William Stein's avatar
William Stein committed
3569 3570
    def analyse_expressions(self, env):
        if self.body:
Robert Bradshaw's avatar
Robert Bradshaw committed
3571 3572
            scope = self.entry.type.scope
            self.body.analyse_expressions(scope)
3573

3574
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
3575
        if self.body:
3576 3577
            self.generate_lambda_definitions(self.scope, code)
            self.body.generate_function_definitions(self.scope, code)
3578

William Stein's avatar
William Stein committed
3579 3580 3581 3582 3583
    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)
3584

3585 3586 3587
    def annotate(self, code):
        if self.body:
            self.body.annotate(code)
William Stein's avatar
William Stein committed
3588 3589 3590 3591 3592 3593


class PropertyNode(StatNode):
    #  Definition of a property in an extension type.
    #
    #  name   string
3594
    #  doc    EncodedString or None    Doc string
William Stein's avatar
William Stein committed
3595
    #  body   StatListNode
3596

3597 3598
    child_attrs = ["body"]

William Stein's avatar
William Stein committed
3599 3600 3601
    def analyse_declarations(self, env):
        entry = env.declare_property(self.name, self.doc, self.pos)
        if entry:
3602
            entry.scope.directives = env.directives
William Stein's avatar
William Stein committed
3603
            self.body.analyse_declarations(entry.scope)
3604

William Stein's avatar
William Stein committed
3605 3606
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
3607

3608 3609
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
William Stein's avatar
William Stein committed
3610 3611 3612 3613

    def generate_execution_code(self, code):
        pass

3614 3615 3616
    def annotate(self, code):
        self.body.annotate(code)

William Stein's avatar
William Stein committed
3617 3618 3619 3620 3621

class GlobalNode(StatNode):
    # Global variable declaration.
    #
    # names    [string]
3622

3623 3624
    child_attrs = []

William Stein's avatar
William Stein committed
3625 3626 3627 3628 3629 3630
    def analyse_declarations(self, env):
        for name in self.names:
            env.declare_global(name, self.pos)

    def analyse_expressions(self, env):
        pass
3631

William Stein's avatar
William Stein committed
3632 3633 3634 3635
    def generate_execution_code(self, code):
        pass


3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
class NonlocalNode(StatNode):
    # Nonlocal variable declaration via the 'nonlocal' keyword.
    #
    # names    [string]

    child_attrs = []

    def analyse_declarations(self, env):
        for name in self.names:
            env.declare_nonlocal(name, self.pos)

    def analyse_expressions(self, env):
        pass

    def generate_execution_code(self, code):
        pass


William Stein's avatar
William Stein committed
3654 3655 3656 3657
class ExprStatNode(StatNode):
    #  Expression used as a statement.
    #
    #  expr   ExprNode
3658 3659

    child_attrs = ["expr"]
3660

Robert Bradshaw's avatar
Robert Bradshaw committed
3661 3662 3663
    def analyse_declarations(self, env):
        import ExprNodes
        if isinstance(self.expr, ExprNodes.GeneralCallNode):
3664
            func = self.expr.function.as_cython_attribute()
Robert Bradshaw's avatar
Robert Bradshaw committed
3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675
            if func == u'declare':
                args, kwds = self.expr.explicit_args_kwds()
                if len(args):
                    error(self.expr.pos, "Variable names must be specified.")
                for var, type_node in kwds.key_value_pairs:
                    type = type_node.analyse_as_type(env)
                    if type is None:
                        error(type_node.pos, "Unknown type")
                    else:
                        env.declare_var(var.value, type, var.pos, is_cdef = True)
                self.__class__ = PassStatNode
3676

William Stein's avatar
William Stein committed
3677
    def analyse_expressions(self, env):
3678
        self.expr.result_is_used = False # hint that .result() may safely be left empty
William Stein's avatar
William Stein committed
3679
        self.expr.analyse_expressions(env)
3680

3681
    def nogil_check(self, env):
3682
        if self.expr.type.is_pyobject and self.expr.is_temp:
3683 3684 3685 3686
            self.gil_error()

    gil_message = "Discarding owned Python object"

William Stein's avatar
William Stein committed
3687 3688
    def generate_execution_code(self, code):
        self.expr.generate_evaluation_code(code)
3689 3690
        if not self.expr.is_temp and self.expr.result():
            code.putln("%s;" % self.expr.result())
William Stein's avatar
William Stein committed
3691
        self.expr.generate_disposal_code(code)
3692
        self.expr.free_temps(code)
William Stein's avatar
William Stein committed
3693

3694 3695 3696
    def generate_function_definitions(self, env, code):
        self.expr.generate_function_definitions(env, code)

3697 3698 3699
    def annotate(self, code):
        self.expr.annotate(code)

William Stein's avatar
William Stein committed
3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710

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):
3711 3712
        self.analyse_types(env)

3713 3714 3715
#       def analyse_expressions(self, env):
#           self.analyse_expressions_1(env)
#           self.analyse_expressions_2(env)
William Stein's avatar
William Stein committed
3716 3717 3718 3719

    def generate_execution_code(self, code):
        self.generate_rhs_evaluation_code(code)
        self.generate_assignment_code(code)
3720

William Stein's avatar
William Stein committed
3721 3722 3723 3724 3725 3726 3727 3728

class SingleAssignmentNode(AssignmentNode):
    #  The simplest case:
    #
    #    a = b
    #
    #  lhs      ExprNode      Left hand side
    #  rhs      ExprNode      Right hand side
3729
    #  first    bool          Is this guaranteed the first assignment to lhs?
3730

3731
    child_attrs = ["lhs", "rhs"]
3732
    first = False
3733
    declaration_only = False
William Stein's avatar
William Stein committed
3734 3735

    def analyse_declarations(self, env):
3736
        import ExprNodes
3737

3738 3739
        # handle declarations of the form x = cython.foo()
        if isinstance(self.rhs, ExprNodes.CallNode):
3740
            func_name = self.rhs.function.as_cython_attribute()
3741 3742
            if func_name:
                args, kwds = self.rhs.explicit_args_kwds()
3743

3744
                if func_name in ['declare', 'typedef']:
Robert Bradshaw's avatar
Robert Bradshaw committed
3745
                    if len(args) > 2 or kwds is not None:
3746
                        error(self.rhs.pos, "Can only declare one type at a time.")
3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762
                        return
                    type = args[0].analyse_as_type(env)
                    if type is None:
                        error(args[0].pos, "Unknown type")
                        return
                    lhs = self.lhs
                    if func_name == 'declare':
                        if isinstance(lhs, ExprNodes.NameNode):
                            vars = [(lhs.name, lhs.pos)]
                        elif isinstance(lhs, ExprNodes.TupleNode):
                            vars = [(var.name, var.pos) for var in lhs.args]
                        else:
                            error(lhs.pos, "Invalid declaration")
                            return
                        for var, pos in vars:
                            env.declare_var(var, type, pos, is_cdef = True)
Robert Bradshaw's avatar
Robert Bradshaw committed
3763 3764 3765 3766 3767
                        if len(args) == 2:
                            # we have a value
                            self.rhs = args[1]
                        else:
                            self.declaration_only = True
3768
                    else:
Robert Bradshaw's avatar
Robert Bradshaw committed
3769
                        self.declaration_only = True
3770 3771
                        if not isinstance(lhs, ExprNodes.NameNode):
                            error(lhs.pos, "Invalid declaration.")
3772
                        env.declare_typedef(lhs.name, type, self.pos, visibility='private')
3773

3774 3775 3776
                elif func_name in ['struct', 'union']:
                    self.declaration_only = True
                    if len(args) > 0 or kwds is None:
3777
                        error(self.rhs.pos, "Struct or union members must be given by name.")
3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794
                        return
                    members = []
                    for member, type_node in kwds.key_value_pairs:
                        type = type_node.analyse_as_type(env)
                        if type is None:
                            error(type_node.pos, "Unknown type")
                        else:
                            members.append((member.value, type, member.pos))
                    if len(members) < len(kwds.key_value_pairs):
                        return
                    if not isinstance(self.lhs, ExprNodes.NameNode):
                        error(self.lhs.pos, "Invalid declaration.")
                    name = self.lhs.name
                    scope = StructOrUnionScope(name)
                    env.declare_struct_or_union(name, func_name, scope, False, self.rhs.pos)
                    for member, type, pos in members:
                        scope.declare_var(member, type, pos)
3795

3796 3797 3798 3799
        if self.declaration_only:
            return
        else:
            self.lhs.analyse_target_declaration(env)
3800

3801
    def analyse_types(self, env, use_temp = 0):
William Stein's avatar
William Stein committed
3802 3803
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
3804
        self.lhs.gil_assignment_check(env)
William Stein's avatar
William Stein committed
3805 3806 3807
        self.rhs = self.rhs.coerce_to(self.lhs.type, env)
        if use_temp:
            self.rhs = self.rhs.coerce_to_temp(env)
3808

William Stein's avatar
William Stein committed
3809 3810
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
3811

William Stein's avatar
William Stein committed
3812 3813 3814
    def generate_assignment_code(self, code):
        self.lhs.generate_assignment_code(self.rhs, code)

3815 3816 3817
    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

3818 3819 3820 3821
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)

William Stein's avatar
William Stein committed
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833

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
3834

3835
    child_attrs = ["lhs_list", "rhs", "coerced_rhs_list"]
3836
    coerced_rhs_list = None
3837

William Stein's avatar
William Stein committed
3838 3839 3840
    def analyse_declarations(self, env):
        for lhs in self.lhs_list:
            lhs.analyse_target_declaration(env)
3841

3842
    def analyse_types(self, env, use_temp = 0):
William Stein's avatar
William Stein committed
3843
        self.rhs.analyse_types(env)
Stefan Behnel's avatar
Stefan Behnel committed
3844 3845 3846 3847 3848
        if not self.rhs.is_simple():
            if use_temp:
                self.rhs = self.rhs.coerce_to_temp(env)
            else:
                self.rhs = self.rhs.coerce_to_simple(env)
William Stein's avatar
William Stein committed
3849 3850 3851 3852
        from ExprNodes import CloneNode
        self.coerced_rhs_list = []
        for lhs in self.lhs_list:
            lhs.analyse_target_types(env)
3853
            lhs.gil_assignment_check(env)
William Stein's avatar
William Stein committed
3854 3855 3856
            rhs = CloneNode(self.rhs)
            rhs = rhs.coerce_to(lhs.type, env)
            self.coerced_rhs_list.append(rhs)
3857

William Stein's avatar
William Stein committed
3858 3859
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
3860

William Stein's avatar
William Stein committed
3861 3862 3863 3864 3865 3866 3867 3868
    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)
3869
        self.rhs.free_temps(code)
William Stein's avatar
William Stein committed
3870

3871 3872 3873
    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

3874 3875 3876 3877 3878
    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)
3879

3880

William Stein's avatar
William Stein committed
3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893
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
3894

3895 3896
    child_attrs = ["stats"]

William Stein's avatar
William Stein committed
3897 3898 3899
    def analyse_declarations(self, env):
        for stat in self.stats:
            stat.analyse_declarations(env)
3900

William Stein's avatar
William Stein committed
3901 3902
    def analyse_expressions(self, env):
        for stat in self.stats:
3903 3904
            stat.analyse_types(env, use_temp = 1)

Robert Bradshaw's avatar
Robert Bradshaw committed
3905 3906 3907 3908 3909
#    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)
3910

William Stein's avatar
William Stein committed
3911 3912 3913 3914 3915 3916
    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)

3917 3918 3919 3920
    def generate_function_definitions(self, env, code):
        for stat in self.stats:
            stat.generate_function_definitions(env, code)

3921 3922 3923 3924 3925
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)


3926
class InPlaceAssignmentNode(AssignmentNode):
Craig Citro's avatar
Craig Citro committed
3927
    #  An in place arithmetic operand:
3928 3929 3930 3931 3932 3933 3934
    #
    #    a += b
    #    a -= b
    #    ...
    #
    #  lhs      ExprNode      Left hand side
    #  rhs      ExprNode      Right hand side
Stefan Behnel's avatar
Stefan Behnel committed
3935
    #  operator char          one of "+-*/%^&|"
3936
    #
3937 3938 3939 3940 3941 3942 3943
    #  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).

3944
    child_attrs = ["lhs", "rhs"]
3945

3946 3947
    def analyse_declarations(self, env):
        self.lhs.analyse_target_declaration(env)
3948

3949
    def analyse_types(self, env):
3950 3951
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
3952

3953
    def generate_execution_code(self, code):
3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964
        import ExprNodes
        self.rhs.generate_evaluation_code(code)
        self.lhs.generate_subexpr_evaluation_code(code)
        c_op = self.operator
        if c_op == "//":
            c_op = "/"
        elif c_op == "**":
            error(self.pos, "No C inplace power operator")
        if isinstance(self.lhs, ExprNodes.IndexNode) and self.lhs.is_buffer_access:
            if self.lhs.type.is_pyobject:
                error(self.pos, "In-place operators not allowed on object buffers in this release.")
Robert Bradshaw's avatar
Robert Bradshaw committed
3965 3966
            if c_op in ('/', '%') and self.lhs.type.is_int and not code.directives['cdivision']:
                error(self.pos, "In-place non-c divide operators not allowed on int buffers.")
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976
            self.lhs.generate_buffer_setitem_code(self.rhs, code, c_op)
        else:
            # C++
            # TODO: make sure overload is declared
            code.putln("%s %s= %s;" % (self.lhs.result(), c_op, self.rhs.result()))
        self.lhs.generate_subexpr_disposal_code(code)
        self.lhs.free_subexpr_temps(code)
        self.rhs.generate_disposal_code(code)
        self.rhs.free_temps(code)

3977 3978 3979
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)
3980

3981 3982
    def create_binop_node(self):
        import ExprNodes
3983
        return ExprNodes.binop_node(self.pos, self.operator, self.lhs, self.rhs)
3984

William Stein's avatar
William Stein committed
3985 3986 3987 3988

class PrintStatNode(StatNode):
    #  print statement
    #
3989
    #  arg_tuple         TupleNode
3990
    #  stream            ExprNode or None (stdout)
3991
    #  append_newline    boolean
3992

3993
    child_attrs = ["arg_tuple", "stream"]
3994

William Stein's avatar
William Stein committed
3995
    def analyse_expressions(self, env):
3996 3997 3998
        if self.stream:
            self.stream.analyse_expressions(env)
            self.stream = self.stream.coerce_to_pyobject(env)
3999
        self.arg_tuple.analyse_expressions(env)
4000
        self.arg_tuple = self.arg_tuple.coerce_to_pyobject(env)
4001
        env.use_utility_code(printing_utility_code)
4002 4003
        if len(self.arg_tuple.args) == 1 and self.append_newline:
            env.use_utility_code(printing_one_utility_code)
4004

4005
    nogil_check = Node.gil_error
4006
    gil_message = "Python print statement"
4007

William Stein's avatar
William Stein committed
4008
    def generate_execution_code(self, code):
4009 4010 4011 4012 4013
        if self.stream:
            self.stream.generate_evaluation_code(code)
            stream_result = self.stream.py_result()
        else:
            stream_result = '0'
4014 4015 4016
        if len(self.arg_tuple.args) == 1 and self.append_newline:
            arg = self.arg_tuple.args[0]
            arg.generate_evaluation_code(code)
4017

4018
            code.putln(
4019 4020
                "if (__Pyx_PrintOne(%s, %s) < 0) %s" % (
                    stream_result,
4021 4022 4023 4024 4025 4026 4027
                    arg.py_result(),
                    code.error_goto(self.pos)))
            arg.generate_disposal_code(code)
            arg.free_temps(code)
        else:
            self.arg_tuple.generate_evaluation_code(code)
            code.putln(
4028 4029
                "if (__Pyx_Print(%s, %s, %d) < 0) %s" % (
                    stream_result,
4030 4031 4032 4033 4034
                    self.arg_tuple.py_result(),
                    self.append_newline,
                    code.error_goto(self.pos)))
            self.arg_tuple.generate_disposal_code(code)
            self.arg_tuple.free_temps(code)
4035

4036 4037 4038 4039
        if self.stream:
            self.stream.generate_disposal_code(code)
            self.stream.free_temps(code)

4040
    def generate_function_definitions(self, env, code):
4041 4042
        if self.stream:
            self.stream.generate_function_definitions(env, code)
4043
        self.arg_tuple.generate_function_definitions(env, code)
4044

4045
    def annotate(self, code):
4046 4047
        if self.stream:
            self.stream.annotate(code)
4048
        self.arg_tuple.annotate(code)
William Stein's avatar
William Stein committed
4049 4050


4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064
class ExecStatNode(StatNode):
    #  exec statement
    #
    #  args     [ExprNode]

    child_attrs = ["args"]

    def analyse_expressions(self, env):
        for i, arg in enumerate(self.args):
            arg.analyse_expressions(env)
            arg = arg.coerce_to_pyobject(env)
            self.args[i] = arg
        env.use_utility_code(Builtin.pyexec_utility_code)

4065
    nogil_check = Node.gil_error
4066 4067 4068 4069 4070 4071 4072 4073
    gil_message = "Python exec statement"

    def generate_execution_code(self, code):
        args = []
        for arg in self.args:
            arg.generate_evaluation_code(code)
            args.append( arg.py_result() )
        args = tuple(args + ['0', '0'][:3-len(args)])
4074
        temp_result = code.funcstate.allocate_temp(PyrexTypes.py_object_type, manage_ref=True)
4075
        code.putln("%s = __Pyx_PyRun(%s, %s, %s);" % (
4076
                (temp_result,) + args))
4077 4078
        for arg in self.args:
            arg.generate_disposal_code(code)
4079
            arg.free_temps(code)
4080
        code.putln(
4081 4082 4083 4084
            code.error_goto_if_null(temp_result, self.pos))
        code.put_gotref(temp_result)
        code.put_decref_clear(temp_result, py_object_type)
        code.funcstate.release_temp(temp_result)
4085 4086 4087 4088 4089 4090

    def annotate(self, code):
        for arg in self.args:
            arg.annotate(code)


William Stein's avatar
William Stein committed
4091 4092 4093 4094
class DelStatNode(StatNode):
    #  del statement
    #
    #  args     [ExprNode]
4095

4096 4097
    child_attrs = ["args"]

William Stein's avatar
William Stein committed
4098 4099 4100
    def analyse_declarations(self, env):
        for arg in self.args:
            arg.analyse_target_declaration(env)
4101

William Stein's avatar
William Stein committed
4102 4103
    def analyse_expressions(self, env):
        for arg in self.args:
4104
            arg.analyse_target_expression(env, None)
Robert Bradshaw's avatar
Robert Bradshaw committed
4105
            if arg.type.is_pyobject:
Robert Bradshaw's avatar
Robert Bradshaw committed
4106
                pass
Robert Bradshaw's avatar
Robert Bradshaw committed
4107
            elif arg.type.is_ptr and arg.type.base_type.is_cpp_class:
Robert Bradshaw's avatar
Robert Bradshaw committed
4108
                self.cpp_check(env)
4109
            elif arg.type.is_cpp_class:
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
4110
                error(arg.pos, "Deletion of non-heap C++ object")
4111
            else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4112
                error(arg.pos, "Deletion of non-Python, non-C++ object")
4113
            #arg.release_target_temp(env)
4114

4115
    def nogil_check(self, env):
4116 4117
        for arg in self.args:
            if arg.type.is_pyobject:
4118
                self.gil_error()
4119

4120 4121
    gil_message = "Deleting Python object"

William Stein's avatar
William Stein committed
4122 4123 4124 4125
    def generate_execution_code(self, code):
        for arg in self.args:
            if arg.type.is_pyobject:
                arg.generate_deletion_code(code)
4126
            elif arg.type.is_ptr and arg.type.base_type.is_cpp_class:
Robert Bradshaw's avatar
Robert Bradshaw committed
4127
                arg.generate_result_code(code)
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
4128
                code.putln("delete %s;" % arg.result())
William Stein's avatar
William Stein committed
4129 4130
            # else error reported earlier

4131 4132 4133 4134
    def annotate(self, code):
        for arg in self.args:
            arg.annotate(code)

William Stein's avatar
William Stein committed
4135 4136 4137

class PassStatNode(StatNode):
    #  pass statement
4138 4139

    child_attrs = []
4140

William Stein's avatar
William Stein committed
4141 4142
    def analyse_expressions(self, env):
        pass
4143

William Stein's avatar
William Stein committed
4144 4145 4146 4147 4148 4149
    def generate_execution_code(self, code):
        pass


class BreakStatNode(StatNode):

4150
    child_attrs = []
4151
    is_terminator = True
4152

William Stein's avatar
William Stein committed
4153 4154
    def analyse_expressions(self, env):
        pass
4155

William Stein's avatar
William Stein committed
4156 4157 4158 4159
    def generate_execution_code(self, code):
        if not code.break_label:
            error(self.pos, "break statement not inside loop")
        else:
4160
            code.put_goto(code.break_label)
William Stein's avatar
William Stein committed
4161 4162 4163 4164


class ContinueStatNode(StatNode):

4165
    child_attrs = []
4166
    is_terminator = True
4167

William Stein's avatar
William Stein committed
4168 4169
    def analyse_expressions(self, env):
        pass
4170

William Stein's avatar
William Stein committed
4171
    def generate_execution_code(self, code):
4172
        if code.funcstate.in_try_finally:
William Stein's avatar
William Stein committed
4173 4174 4175 4176
            error(self.pos, "continue statement inside try of try...finally")
        elif not code.continue_label:
            error(self.pos, "continue statement not inside loop")
        else:
4177
            code.put_goto(code.continue_label)
William Stein's avatar
William Stein committed
4178 4179 4180 4181 4182 4183 4184


class ReturnStatNode(StatNode):
    #  return statement
    #
    #  value         ExprNode or None
    #  return_type   PyrexType
4185

4186
    child_attrs = ["value"]
4187
    is_terminator = True
4188

4189 4190 4191
    # Whether we are in a parallel section
    in_parallel = False

William Stein's avatar
William Stein committed
4192 4193 4194 4195 4196 4197 4198 4199 4200
    def analyse_expressions(self, env):
        return_type = env.return_type
        self.return_type = return_type
        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:
4201
                error(self.value.pos,
William Stein's avatar
William Stein committed
4202 4203 4204 4205 4206 4207 4208 4209
                    "Return with value in void function")
            else:
                self.value = self.value.coerce_to(env.return_type, 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")
4210

4211
    def nogil_check(self, env):
4212
        if self.return_type.is_pyobject:
4213
            self.gil_error()
4214 4215 4216

    gil_message = "Returning Python object"

William Stein's avatar
William Stein committed
4217
    def generate_execution_code(self, code):
4218
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
4219 4220 4221
        if not self.return_type:
            # error reported earlier
            return
4222 4223 4224
        if self.return_type.is_pyobject:
            code.put_xdecref(Naming.retval_cname,
                             self.return_type)
William Stein's avatar
William Stein committed
4225 4226 4227
        if self.value:
            self.value.generate_evaluation_code(code)
            self.value.make_owned_reference(code)
4228
            self.put_return(code, self.value.result_as(self.return_type))
William Stein's avatar
William Stein committed
4229
            self.value.generate_post_assignment_code(code)
4230
            self.value.free_temps(code)
William Stein's avatar
William Stein committed
4231 4232 4233 4234
        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:
4235 4236
                self.put_return(code, self.return_type.default_value)

4237
        for cname, type in code.funcstate.temps_holding_reference():
4238
            code.put_decref_clear(cname, type)
4239

4240
        code.put_goto(code.return_label)
4241

4242 4243 4244 4245 4246
    def put_return(self, code, value):
        if self.in_parallel:
            code.putln_openmp("#pragma omp critical(__pyx_returning)")
        code.putln("%s = %s;" % (Naming.retval_cname, value))

4247 4248 4249
    def generate_function_definitions(self, env, code):
        if self.value is not None:
            self.value.generate_function_definitions(env, code)
4250

4251 4252 4253
    def annotate(self, code):
        if self.value:
            self.value.annotate(code)
William Stein's avatar
William Stein committed
4254 4255 4256 4257 4258 4259 4260 4261


class RaiseStatNode(StatNode):
    #  raise statement
    #
    #  exc_type    ExprNode or None
    #  exc_value   ExprNode or None
    #  exc_tb      ExprNode or None
Haoyu Bai's avatar
Haoyu Bai committed
4262
    #  cause       ExprNode or None
4263

Haoyu Bai's avatar
Haoyu Bai committed
4264
    child_attrs = ["exc_type", "exc_value", "exc_tb", "cause"]
4265
    is_terminator = True
4266

William Stein's avatar
William Stein committed
4267 4268 4269 4270 4271 4272 4273 4274 4275 4276
    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)
        if self.exc_value:
            self.exc_value.analyse_types(env)
            self.exc_value = self.exc_value.coerce_to_pyobject(env)
        if self.exc_tb:
            self.exc_tb.analyse_types(env)
            self.exc_tb = self.exc_tb.coerce_to_pyobject(env)
Haoyu Bai's avatar
Haoyu Bai committed
4277 4278 4279
        if self.cause:
            self.cause.analyse_types(env)
            self.cause = self.cause.coerce_to_pyobject(env)
4280 4281 4282 4283 4284
        # special cases for builtin exceptions
        self.builtin_exc_name = None
        if self.exc_type and not self.exc_value and not self.exc_tb:
            exc = self.exc_type
            import ExprNodes
Robert Bradshaw's avatar
Robert Bradshaw committed
4285 4286
            if (isinstance(exc, ExprNodes.SimpleCallNode) and
                not (exc.args or (exc.arg_tuple is not None and
4287
                                  exc.arg_tuple.args))):
4288 4289 4290 4291 4292
                exc = exc.function # extract the exception type
            if exc.is_name and exc.entry.is_builtin:
                self.builtin_exc_name = exc.name
                if self.builtin_exc_name == 'MemoryError':
                    self.exc_type = None # has a separate implementation
4293

4294
    nogil_check = Node.gil_error
4295 4296
    gil_message = "Raising exception"

William Stein's avatar
William Stein committed
4297
    def generate_execution_code(self, code):
4298 4299 4300 4301
        if self.builtin_exc_name == 'MemoryError':
            code.putln('PyErr_NoMemory(); %s' % code.error_goto(self.pos))
            return

William Stein's avatar
William Stein committed
4302 4303 4304 4305
        if self.exc_type:
            self.exc_type.generate_evaluation_code(code)
            type_code = self.exc_type.py_result()
        else:
Stefan Behnel's avatar
Stefan Behnel committed
4306
            type_code = "0"
William Stein's avatar
William Stein committed
4307 4308 4309 4310 4311 4312 4313 4314 4315 4316
        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"
Haoyu Bai's avatar
Haoyu Bai committed
4317 4318 4319 4320 4321
        if self.cause:
            self.cause.generate_evaluation_code(code)
            cause_code = self.cause.py_result()
        else:
            cause_code = "0"
4322
        code.globalstate.use_utility_code(raise_utility_code)
4323
        code.putln(
Haoyu Bai's avatar
Haoyu Bai committed
4324
            "__Pyx_Raise(%s, %s, %s, %s);" % (
4325 4326
                type_code,
                value_code,
Haoyu Bai's avatar
Haoyu Bai committed
4327 4328 4329
                tb_code,
                cause_code))
        for obj in (self.exc_type, self.exc_value, self.exc_tb, self.cause):
4330 4331 4332
            if obj:
                obj.generate_disposal_code(code)
                obj.free_temps(code)
William Stein's avatar
William Stein committed
4333 4334 4335
        code.putln(
            code.error_goto(self.pos))

4336 4337 4338 4339 4340 4341 4342
    def generate_function_definitions(self, env, code):
        if self.exc_type is not None:
            self.exc_type.generate_function_definitions(env, code)
        if self.exc_value is not None:
            self.exc_value.generate_function_definitions(env, code)
        if self.exc_tb is not None:
            self.exc_tb.generate_function_definitions(env, code)
Haoyu Bai's avatar
Haoyu Bai committed
4343 4344
        if self.cause is not None:
            self.cause.generate_function_definitions(env, code)
4345

4346 4347 4348 4349 4350 4351 4352
    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)
Haoyu Bai's avatar
Haoyu Bai committed
4353 4354
        if self.cause:
            self.cause.annotate(code)
4355

William Stein's avatar
William Stein committed
4356

4357 4358
class ReraiseStatNode(StatNode):

4359
    child_attrs = []
4360
    is_terminator = True
4361

4362
    def analyse_expressions(self, env):
4363
        env.use_utility_code(restore_exception_utility_code)
4364

4365
    nogil_check = Node.gil_error
4366 4367
    gil_message = "Raising exception"

4368
    def generate_execution_code(self, code):
4369
        vars = code.funcstate.exc_vars
4370
        if vars:
4371 4372 4373 4374 4375 4376
            for varname in vars:
                code.put_giveref(varname)
            code.putln("__Pyx_ErrRestore(%s, %s, %s);" % tuple(vars))
            for varname in vars:
                code.put("%s = 0; " % varname)
            code.putln()
4377 4378 4379
            code.putln(code.error_goto(self.pos))
        else:
            error(self.pos, "Reraise not inside except clause")
4380

4381

William Stein's avatar
William Stein committed
4382 4383 4384 4385 4386
class AssertStatNode(StatNode):
    #  assert statement
    #
    #  cond    ExprNode
    #  value   ExprNode or None
4387

4388 4389
    child_attrs = ["cond", "value"]

William Stein's avatar
William Stein committed
4390 4391 4392 4393 4394
    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)
4395

4396
    nogil_check = Node.gil_error
4397
    gil_message = "Raising exception"
4398

William Stein's avatar
William Stein committed
4399
    def generate_execution_code(self, code):
4400
        code.putln("#ifndef CYTHON_WITHOUT_ASSERTIONS")
William Stein's avatar
William Stein committed
4401 4402
        self.cond.generate_evaluation_code(code)
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
4403
            "if (unlikely(!%s)) {" %
4404
                self.cond.result())
William Stein's avatar
William Stein committed
4405
        if self.value:
4406
            self.value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
4407 4408 4409
            code.putln(
                "PyErr_SetObject(PyExc_AssertionError, %s);" %
                    self.value.py_result())
4410
            self.value.generate_disposal_code(code)
4411
            self.value.free_temps(code)
William Stein's avatar
William Stein committed
4412 4413 4414 4415 4416 4417 4418 4419
        else:
            code.putln(
                "PyErr_SetNone(PyExc_AssertionError);")
        code.putln(
                code.error_goto(self.pos))
        code.putln(
            "}")
        self.cond.generate_disposal_code(code)
4420
        self.cond.free_temps(code)
4421
        code.putln("#endif")
William Stein's avatar
William Stein committed
4422

4423 4424 4425 4426 4427
    def generate_function_definitions(self, env, code):
        self.cond.generate_function_definitions(env, code)
        if self.value is not None:
            self.value.generate_function_definitions(env, code)

4428 4429 4430 4431 4432 4433
    def annotate(self, code):
        self.cond.annotate(code)
        if self.value:
            self.value.annotate(code)


William Stein's avatar
William Stein committed
4434 4435 4436 4437 4438
class IfStatNode(StatNode):
    #  if statement
    #
    #  if_clauses   [IfClauseNode]
    #  else_clause  StatNode or None
4439 4440

    child_attrs = ["if_clauses", "else_clause"]
4441

William Stein's avatar
William Stein committed
4442 4443 4444 4445 4446
    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)
4447

William Stein's avatar
William Stein committed
4448 4449 4450 4451 4452
    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)
4453

William Stein's avatar
William Stein committed
4454
    def generate_execution_code(self, code):
4455
        code.mark_pos(self.pos)
4456 4457 4458 4459 4460
        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*/ {")
William Stein's avatar
William Stein committed
4461
            self.else_clause.generate_execution_code(code)
4462 4463
            code.putln("}")
        code.put_label(end_label)
4464

4465 4466 4467 4468 4469
    def generate_function_definitions(self, env, code):
        for clause in self.if_clauses:
            clause.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)
4470

4471 4472 4473 4474 4475
    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
4476 4477 4478 4479 4480 4481 4482


class IfClauseNode(Node):
    #  if or elif clause in an if statement
    #
    #  condition   ExprNode
    #  body        StatNode
4483

4484 4485
    child_attrs = ["condition", "body"]

William Stein's avatar
William Stein committed
4486 4487
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
4488

William Stein's avatar
William Stein committed
4489 4490 4491 4492
    def analyse_expressions(self, env):
        self.condition = \
            self.condition.analyse_temp_boolean_expression(env)
        self.body.analyse_expressions(env)
4493 4494 4495

    def get_constant_condition_result(self):
        if self.condition.has_constant_result():
4496
            return bool(self.condition.constant_result)
4497 4498 4499
        else:
            return None

William Stein's avatar
William Stein committed
4500 4501 4502 4503
    def generate_execution_code(self, code, end_label):
        self.condition.generate_evaluation_code(code)
        code.putln(
            "if (%s) {" %
4504
                self.condition.result())
4505 4506
        self.condition.generate_disposal_code(code)
        self.condition.free_temps(code)
William Stein's avatar
William Stein committed
4507
        self.body.generate_execution_code(code)
4508
        code.put_goto(end_label)
William Stein's avatar
William Stein committed
4509
        code.putln("}")
4510

4511 4512 4513 4514
    def generate_function_definitions(self, env, code):
        self.condition.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)

4515 4516 4517
    def annotate(self, code):
        self.condition.annotate(code)
        self.body.annotate(code)
4518

4519 4520 4521 4522 4523 4524

class SwitchCaseNode(StatNode):
    # Generated in the optimization of an if-elif-else node
    #
    # conditions    [ExprNode]
    # body          StatNode
4525

4526
    child_attrs = ['conditions', 'body']
4527

4528 4529
    def generate_execution_code(self, code):
        for cond in self.conditions:
4530
            code.mark_pos(cond.pos)
4531 4532
            cond.generate_evaluation_code(code)
            code.putln("case %s:" % cond.result())
4533 4534
        self.body.generate_execution_code(code)
        code.putln("break;")
4535 4536 4537 4538 4539

    def generate_function_definitions(self, env, code):
        for cond in self.conditions:
            cond.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)
4540

4541 4542 4543
    def annotate(self, code):
        for cond in self.conditions:
            cond.annotate(code)
4544
        self.body.annotate(code)
4545 4546 4547 4548 4549 4550 4551

class SwitchStatNode(StatNode):
    # Generated in the optimization of an if-elif-else node
    #
    # test          ExprNode
    # cases         [SwitchCaseNode]
    # else_clause   StatNode or None
4552

4553
    child_attrs = ['test', 'cases', 'else_clause']
4554

4555
    def generate_execution_code(self, code):
4556
        self.test.generate_evaluation_code(code)
4557
        code.putln("switch (%s) {" % self.test.result())
4558 4559 4560 4561 4562
        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)
4563
            code.putln("break;")
4564 4565
        code.putln("}")

4566 4567 4568 4569 4570 4571 4572
    def generate_function_definitions(self, env, code):
        self.test.generate_function_definitions(env, code)
        for case in self.cases:
            case.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)

4573 4574 4575 4576
    def annotate(self, code):
        self.test.annotate(code)
        for case in self.cases:
            case.annotate(code)
4577 4578
        if self.else_clause is not None:
            self.else_clause.annotate(code)
4579

4580
class LoopNode(object):
4581
    pass
4582

4583

4584
class WhileStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
4585 4586 4587 4588 4589
    #  while statement
    #
    #  condition    ExprNode
    #  body         StatNode
    #  else_clause  StatNode
4590 4591

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

William Stein's avatar
William Stein committed
4593 4594 4595 4596
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
4597

William Stein's avatar
William Stein committed
4598
    def analyse_expressions(self, env):
4599 4600
        if self.condition:
            self.condition = self.condition.analyse_temp_boolean_expression(env)
William Stein's avatar
William Stein committed
4601 4602 4603
        self.body.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
4604

William Stein's avatar
William Stein committed
4605 4606 4607 4608
    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
        code.putln(
            "while (1) {")
4609 4610 4611 4612 4613 4614 4615
        if self.condition:
            self.condition.generate_evaluation_code(code)
            self.condition.generate_disposal_code(code)
            code.putln(
                "if (!%s) break;" %
                    self.condition.result())
            self.condition.free_temps(code)
William Stein's avatar
William Stein committed
4616
        self.body.generate_execution_code(code)
4617
        code.put_label(code.continue_label)
William Stein's avatar
William Stein committed
4618 4619 4620 4621 4622 4623 4624 4625 4626
        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)

4627
    def generate_function_definitions(self, env, code):
4628 4629
        if self.condition:
            self.condition.generate_function_definitions(env, code)
4630 4631 4632 4633
        self.body.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)

4634
    def annotate(self, code):
4635 4636
        if self.condition:
            self.condition.annotate(code)
4637 4638 4639 4640
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)

William Stein's avatar
William Stein committed
4641

4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685
class DictIterationNextNode(Node):
    # Helper node for calling PyDict_Next() inside of a WhileStatNode
    # and checking the dictionary size for changes.  Created in
    # Optimize.py.
    child_attrs = ['dict_obj', 'expected_size', 'pos_index_addr', 'key_addr', 'value_addr']

    def __init__(self, dict_obj, expected_size, pos_index_addr, key_addr, value_addr):
        Node.__init__(
            self, dict_obj.pos,
            dict_obj = dict_obj,
            expected_size = expected_size,
            pos_index_addr = pos_index_addr,
            key_addr = key_addr,
            value_addr = value_addr,
            type = PyrexTypes.c_bint_type)

    def analyse_expressions(self, env):
        self.dict_obj.analyse_types(env)
        self.expected_size.analyse_types(env)
        self.pos_index_addr.analyse_types(env)
        self.key_addr.analyse_types(env)
        self.value_addr.analyse_types(env)

    def generate_function_definitions(self, env, code):
        self.dict_obj.generate_function_definitions(env, code)

    def generate_execution_code(self, code):
        self.dict_obj.generate_evaluation_code(code)
        code.putln("if (unlikely(%s != PyDict_Size(%s))) {" % (
            self.expected_size.result(),
            self.dict_obj.py_result(),
            ))
        code.putln('PyErr_SetString(PyExc_RuntimeError, "dictionary changed size during iteration"); %s' % (
            code.error_goto(self.pos)))
        code.putln("}")
        self.pos_index_addr.generate_evaluation_code(code)

        code.putln("if (!PyDict_Next(%s, %s, %s, %s)) break;" % (
            self.dict_obj.py_result(),
            self.pos_index_addr.result(),
            self.key_addr.result(),
            self.value_addr.result()))


Robert Bradshaw's avatar
Robert Bradshaw committed
4686
def ForStatNode(pos, **kw):
4687
    if 'iterator' in kw:
Robert Bradshaw's avatar
Robert Bradshaw committed
4688 4689 4690 4691
        return ForInStatNode(pos, **kw)
    else:
        return ForFromStatNode(pos, **kw)

4692
class ForInStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
4693 4694 4695 4696 4697 4698 4699
    #  for statement
    #
    #  target        ExprNode
    #  iterator      IteratorNode
    #  body          StatNode
    #  else_clause   StatNode
    #  item          NextNode       used internally
4700

4701
    child_attrs = ["target", "iterator", "body", "else_clause"]
4702
    item = None
4703

William Stein's avatar
William Stein committed
4704 4705 4706 4707 4708
    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)
4709

William Stein's avatar
William Stein committed
4710 4711 4712
    def analyse_expressions(self, env):
        import ExprNodes
        self.target.analyse_target_types(env)
4713
        self.iterator.analyse_expressions(env)
4714
        self.item = ExprNodes.NextNode(self.iterator)
4715 4716 4717 4718 4719 4720
        if (self.iterator.type.is_ptr or self.iterator.type.is_array) and \
            self.target.type.assignable_from(self.iterator.type):
            # C array slice optimization.
            pass
        else:
            self.item = self.item.coerce_to(self.target.type, env)
William Stein's avatar
William Stein committed
4721 4722 4723 4724 4725 4726 4727
        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()
        self.iterator.generate_evaluation_code(code)
Mark Florisson's avatar
Mark Florisson committed
4728
        code.putln("for (;;) {")
William Stein's avatar
William Stein committed
4729 4730 4731
        self.item.generate_evaluation_code(code)
        self.target.generate_assignment_code(self.item, code)
        self.body.generate_execution_code(code)
4732
        code.put_label(code.continue_label)
Mark Florisson's avatar
Mark Florisson committed
4733
        code.putln("}")
William Stein's avatar
William Stein committed
4734 4735
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
4736

William Stein's avatar
William Stein committed
4737
        if self.else_clause:
4738 4739 4740 4741 4742 4743 4744
            # in nested loops, the 'else' block can contain a
            # 'continue' statement for the outer loop, but we may need
            # to generate cleanup code before taking that path, so we
            # intercept it here
            orig_continue_label = code.continue_label
            code.continue_label = code.new_label('outer_continue')

William Stein's avatar
William Stein committed
4745 4746 4747
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757

            if code.label_used(code.continue_label):
                code.put_goto(break_label)
                code.put_label(code.continue_label)
                self.iterator.generate_disposal_code(code)
                code.put_goto(orig_continue_label)
            code.set_loop_labels(old_loop_labels)

        if code.label_used(break_label):
            code.put_label(break_label)
William Stein's avatar
William Stein committed
4758
        self.iterator.generate_disposal_code(code)
4759
        self.iterator.free_temps(code)
William Stein's avatar
William Stein committed
4760

4761 4762 4763 4764 4765 4766 4767
    def generate_function_definitions(self, env, code):
        self.target.generate_function_definitions(env, code)
        self.iterator.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)

4768 4769 4770 4771 4772 4773 4774 4775
    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
4776

4777
class ForFromStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
4778 4779 4780 4781 4782 4783 4784
    #  for name from expr rel name rel expr
    #
    #  target        NameNode
    #  bound1        ExprNode
    #  relation1     string
    #  relation2     string
    #  bound2        ExprNode
4785
    #  step          ExprNode or None
William Stein's avatar
William Stein committed
4786 4787 4788 4789 4790
    #  body          StatNode
    #  else_clause   StatNode or None
    #
    #  Used internally:
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
4791
    #  from_range         bool
4792
    #  is_py_target       bool
4793
    #  loopvar_node       ExprNode (usually a NameNode or temp node)
William Stein's avatar
William Stein committed
4794
    #  py_loopvar_node    PyTempNode or None
4795
    child_attrs = ["target", "bound1", "bound2", "step", "body", "else_clause"]
4796 4797

    is_py_target = False
4798
    loopvar_node = None
4799
    py_loopvar_node = None
Robert Bradshaw's avatar
Robert Bradshaw committed
4800
    from_range = False
4801

4802 4803 4804 4805 4806 4807 4808
    gil_message = "For-loop using object bounds or target"

    def nogil_check(self, env):
        for x in (self.target, self.bound1, self.bound2):
            if x.type.is_pyobject:
                self.gil_error()

Robert Bradshaw's avatar
Robert Bradshaw committed
4809 4810 4811 4812 4813
    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)
4814

William Stein's avatar
William Stein committed
4815 4816 4817 4818 4819
    def analyse_expressions(self, env):
        import ExprNodes
        self.target.analyse_target_types(env)
        self.bound1.analyse_types(env)
        self.bound2.analyse_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4820 4821 4822 4823
        if self.step is not None:
            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)
            self.step.analyse_types(env)
4824

Robert Bradshaw's avatar
Robert Bradshaw committed
4825
        target_type = self.target.type
4826
        if self.target.type.is_numeric:
Robert Bradshaw's avatar
Robert Bradshaw committed
4827
            loop_type = self.target.type
4828
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4829 4830 4831 4832 4833 4834 4835 4836 4837
            loop_type = PyrexTypes.c_int_type
            if not self.bound1.type.is_pyobject:
                loop_type = PyrexTypes.widest_numeric_type(loop_type, self.bound1.type)
            if not self.bound2.type.is_pyobject:
                loop_type = PyrexTypes.widest_numeric_type(loop_type, self.bound2.type)
            if self.step is not None and not self.step.type.is_pyobject:
                loop_type = PyrexTypes.widest_numeric_type(loop_type, self.step.type)
        self.bound1 = self.bound1.coerce_to(loop_type, env)
        self.bound2 = self.bound2.coerce_to(loop_type, env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4838 4839
        if not self.bound2.is_literal:
            self.bound2 = self.bound2.coerce_to_temp(env)
4840
        if self.step is not None:
4841
            self.step = self.step.coerce_to(loop_type, env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4842 4843
            if not self.step.is_literal:
                self.step = self.step.coerce_to_temp(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4844

William Stein's avatar
William Stein committed
4845
        target_type = self.target.type
4846
        if not (target_type.is_pyobject or target_type.is_numeric):
4847
            error(self.target.pos,
Robert Bradshaw's avatar
Robert Bradshaw committed
4848
                "for-from loop variable must be c numeric type or Python object")
4849
        if target_type.is_numeric:
Robert Bradshaw's avatar
Robert Bradshaw committed
4850
            self.is_py_target = False
4851 4852
            if isinstance(self.target, ExprNodes.IndexNode) and self.target.is_buffer_access:
                raise error(self.pos, "Buffer indexing not allowed as for loop target.")
4853
            self.loopvar_node = self.target
William Stein's avatar
William Stein committed
4854 4855
            self.py_loopvar_node = None
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4856 4857
            self.is_py_target = True
            c_loopvar_node = ExprNodes.TempNode(self.pos, loop_type, env)
4858
            self.loopvar_node = c_loopvar_node
William Stein's avatar
William Stein committed
4859 4860 4861 4862 4863
            self.py_loopvar_node = \
                ExprNodes.CloneNode(c_loopvar_node).coerce_to_pyobject(env)
        self.body.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
4864

William Stein's avatar
William Stein committed
4865 4866
    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
Robert Bradshaw's avatar
Robert Bradshaw committed
4867
        from_range = self.from_range
William Stein's avatar
William Stein committed
4868 4869 4870
        self.bound1.generate_evaluation_code(code)
        self.bound2.generate_evaluation_code(code)
        offset, incop = self.relation_table[self.relation1]
4871 4872
        if self.step is not None:
            self.step.generate_evaluation_code(code)
Magnus Lie Hetland's avatar
Magnus Lie Hetland committed
4873 4874
            step = self.step.result()
            incop = "%s=%s" % (incop[0], step)
4875 4876 4877 4878 4879
        import ExprNodes
        if isinstance(self.loopvar_node, ExprNodes.TempNode):
            self.loopvar_node.allocate(code)
        if isinstance(self.py_loopvar_node, ExprNodes.TempNode):
            self.py_loopvar_node.allocate(code)
4880
        if from_range:
Robert Bradshaw's avatar
Robert Bradshaw committed
4881
            loopvar_name = code.funcstate.allocate_temp(self.target.type, False)
4882
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4883
            loopvar_name = self.loopvar_node.result()
William Stein's avatar
William Stein committed
4884 4885
        code.putln(
            "for (%s = %s%s; %s %s %s; %s%s) {" % (
4886
                loopvar_name,
4887
                self.bound1.result(), offset,
Robert Bradshaw's avatar
Robert Bradshaw committed
4888
                loopvar_name, self.relation2, self.bound2.result(),
4889
                loopvar_name, incop))
William Stein's avatar
William Stein committed
4890 4891 4892
        if self.py_loopvar_node:
            self.py_loopvar_node.generate_evaluation_code(code)
            self.target.generate_assignment_code(self.py_loopvar_node, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
4893 4894 4895
        elif from_range:
            code.putln("%s = %s;" % (
                            self.target.result(), loopvar_name))
William Stein's avatar
William Stein committed
4896 4897
        self.body.generate_execution_code(code)
        code.put_label(code.continue_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
4898
        if self.py_loopvar_node:
4899 4900 4901
            # This mess is to make for..from loops with python targets behave
            # exactly like those with C targets with regards to re-assignment
            # of the loop variable.
4902
            import ExprNodes
4903
            if self.target.entry.is_pyglobal:
4904
                # We know target is a NameNode, this is the only ugly case.
4905
                target_node = ExprNodes.PyTempNode(self.target.pos, None)
4906 4907
                target_node.allocate(code)
                interned_cname = code.intern_identifier(self.target.entry.name)
4908
                code.globalstate.use_utility_code(ExprNodes.get_name_interned_utility_code)
4909
                code.putln("%s = __Pyx_GetName(%s, %s); %s" % (
4910
                                target_node.result(),
4911
                                Naming.module_cname,
4912 4913 4914
                                interned_cname,
                                code.error_goto_if_null(target_node.result(), self.target.pos)))
                code.put_gotref(target_node.result())
4915 4916 4917
            else:
                target_node = self.target
            from_py_node = ExprNodes.CoerceFromPyTypeNode(self.loopvar_node.type, target_node, None)
4918 4919
            from_py_node.temp_code = loopvar_name
            from_py_node.generate_result_code(code)
4920
            if self.target.entry.is_pyglobal:
4921 4922
                code.put_decref(target_node.result(), target_node.type)
                target_node.release(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
4923
        code.putln("}")
4924
        if self.py_loopvar_node:
4925 4926
            # This is potentially wasteful, but we don't want the semantics to
            # depend on whether or not the loop is a python type.
4927 4928
            self.py_loopvar_node.generate_evaluation_code(code)
            self.target.generate_assignment_code(self.py_loopvar_node, code)
4929 4930
        if from_range:
            code.funcstate.release_temp(loopvar_name)
William Stein's avatar
William Stein committed
4931 4932 4933 4934 4935 4936 4937 4938
        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)
4939
        self.bound1.free_temps(code)
William Stein's avatar
William Stein committed
4940
        self.bound2.generate_disposal_code(code)
4941
        self.bound2.free_temps(code)
4942 4943 4944 4945
        if isinstance(self.loopvar_node, ExprNodes.TempNode):
            self.loopvar_node.release(code)
        if isinstance(self.py_loopvar_node, ExprNodes.TempNode):
            self.py_loopvar_node.release(code)
4946 4947
        if self.step is not None:
            self.step.generate_disposal_code(code)
4948
            self.step.free_temps(code)
4949

William Stein's avatar
William Stein committed
4950 4951 4952 4953 4954 4955 4956
    relation_table = {
        # {relop : (initial offset, increment op)}
        '<=': ("",   "++"),
        '<' : ("+1", "++"),
        '>=': ("",   "--"),
        '>' : ("-1", "--")
    }
4957 4958 4959 4960 4961 4962 4963 4964 4965 4966

    def generate_function_definitions(self, env, code):
        self.target.generate_function_definitions(env, code)
        self.bound1.generate_function_definitions(env, code)
        self.bound2.generate_function_definitions(env, code)
        if self.step is not None:
            self.step.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)
4967

4968 4969 4970 4971 4972
    def annotate(self, code):
        self.target.annotate(code)
        self.bound1.annotate(code)
        self.bound2.annotate(code)
        if self.step:
4973
            self.step.annotate(code)
4974 4975 4976
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)
William Stein's avatar
William Stein committed
4977 4978


4979 4980 4981
class WithStatNode(StatNode):
    """
    Represents a Python with statement.
4982

4983
    Implemented by the WithTransform as follows:
4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000

        MGR = EXPR
        EXIT = MGR.__exit__
        VALUE = MGR.__enter__()
        EXC = True
        try:
            try:
                TARGET = VALUE  # optional
                BODY
            except:
                EXC = False
                if not EXIT(*EXCINFO):
                    raise
        finally:
            if EXC:
                EXIT(None, None, None)
            MGR = EXIT = VALUE = None
5001 5002
    """
    #  manager          The with statement manager object
5003
    #  target           ExprNode  the target lhs of the __enter__() call
5004
    #  body             StatNode
5005

5006
    child_attrs = ["manager", "target", "body"]
5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017

    has_target = False

    def analyse_declarations(self, env):
        self.manager.analyse_declarations(env)
        self.body.analyse_declarations(env)

    def analyse_expressions(self, env):
        self.manager.analyse_types(env)
        self.body.analyse_expressions(env)

5018 5019 5020 5021
    def generate_function_definitions(self, env, code):
        self.manager.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)

5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109
    def generate_execution_code(self, code):
        code.putln("/*with:*/ {")
        self.manager.generate_evaluation_code(code)
        self.exit_var = code.funcstate.allocate_temp(py_object_type, manage_ref=False)
        code.putln("%s = PyObject_GetAttr(%s, %s); %s" % (
            self.exit_var,
            self.manager.py_result(),
            code.get_py_string_const(EncodedString('__exit__'), identifier=True),
            code.error_goto_if_null(self.exit_var, self.pos),
            ))
        code.put_gotref(self.exit_var)

        # need to free exit_var in the face of exceptions during setup
        old_error_label = code.new_error_label()
        intermediate_error_label = code.error_label

        enter_func = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        code.putln("%s = PyObject_GetAttr(%s, %s); %s" % (
            enter_func,
            self.manager.py_result(),
            code.get_py_string_const(EncodedString('__enter__'), identifier=True),
            code.error_goto_if_null(enter_func, self.pos),
            ))
        code.put_gotref(enter_func)
        self.manager.generate_disposal_code(code)
        self.manager.free_temps(code)
        self.target_temp.allocate(code)
        code.putln('%s = PyObject_Call(%s, ((PyObject *)%s), NULL); %s' % (
            self.target_temp.result(),
            enter_func,
            Naming.empty_tuple,
            code.error_goto_if_null(self.target_temp.result(), self.pos),
            ))
        code.put_gotref(self.target_temp.result())
        code.put_decref_clear(enter_func, py_object_type)
        code.funcstate.release_temp(enter_func)
        if not self.has_target:
            code.put_decref_clear(self.target_temp.result(), type=py_object_type)
            self.target_temp.release(code)
            # otherwise, WithTargetAssignmentStatNode will do it for us

        code.error_label = old_error_label
        self.body.generate_execution_code(code)

        step_over_label = code.new_label()
        code.put_goto(step_over_label)
        code.put_label(intermediate_error_label)
        code.put_decref_clear(self.exit_var, py_object_type)
        code.put_goto(old_error_label)
        code.put_label(step_over_label)

        code.funcstate.release_temp(self.exit_var)
        code.putln('}')

class WithTargetAssignmentStatNode(AssignmentNode):
    # The target assignment of the 'with' statement value (return
    # value of the __enter__() call).
    #
    # This is a special cased assignment that steals the RHS reference
    # and frees its temp.
    #
    # lhs  ExprNode  the assignment target
    # rhs  TempNode  the return value of the __enter__() call

    child_attrs = ["lhs", "rhs"]

    def analyse_declarations(self, env):
        self.lhs.analyse_target_declaration(env)

    def analyse_types(self, env):
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
        self.lhs.gil_assignment_check(env)
        self.orig_rhs = self.rhs
        self.rhs = self.rhs.coerce_to(self.lhs.type, env)

    def generate_execution_code(self, code):
        self.rhs.generate_evaluation_code(code)
        self.lhs.generate_assignment_code(self.rhs, code)
        self.orig_rhs.release(code)

    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)

5110

William Stein's avatar
William Stein committed
5111 5112 5113 5114 5115 5116
class TryExceptStatNode(StatNode):
    #  try .. except statement
    #
    #  body             StatNode
    #  except_clauses   [ExceptClauseNode]
    #  else_clause      StatNode or None
5117

5118
    child_attrs = ["body", "except_clauses", "else_clause"]
5119

William Stein's avatar
William Stein committed
5120 5121 5122 5123 5124 5125
    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)
5126
        env.use_utility_code(reset_exception_utility_code)
5127

William Stein's avatar
William Stein committed
5128 5129
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
5130
        default_clause_seen = 0
William Stein's avatar
William Stein committed
5131 5132
        for except_clause in self.except_clauses:
            except_clause.analyse_expressions(env)
5133 5134 5135 5136 5137
            if default_clause_seen:
                error(except_clause.pos, "default 'except:' must be last")
            if not except_clause.pattern:
                default_clause_seen = 1
        self.has_default_clause = default_clause_seen
William Stein's avatar
William Stein committed
5138 5139
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
5140

5141
    nogil_check = Node.gil_error
5142 5143
    gil_message = "Try-except statement"

William Stein's avatar
William Stein committed
5144
    def generate_execution_code(self, code):
5145
        old_return_label = code.return_label
5146
        old_break_label = code.break_label
5147
        old_continue_label = code.continue_label
William Stein's avatar
William Stein committed
5148 5149
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
5150 5151 5152
        except_end_label = code.new_label('exception_handled')
        except_error_label = code.new_label('except_error')
        except_return_label = code.new_label('except_return')
5153
        try_return_label = code.new_label('try_return')
5154
        try_break_label = code.new_label('try_break')
5155
        try_continue_label = code.new_label('try_continue')
5156
        try_end_label = code.new_label('try_end')
5157

5158 5159
        exc_save_vars = [code.funcstate.allocate_temp(py_object_type, False)
                         for i in xrange(3)]
5160 5161
        code.putln("{")
        code.putln("__Pyx_ExceptionSave(%s);" %
5162 5163
                   ', '.join(['&%s' % var for var in exc_save_vars]))
        for var in exc_save_vars:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
5164
            code.put_xgotref(var)
William Stein's avatar
William Stein committed
5165 5166
        code.putln(
            "/*try:*/ {")
5167
        code.return_label = try_return_label
5168
        code.break_label = try_break_label
5169
        code.continue_label = try_continue_label
William Stein's avatar
William Stein committed
5170 5171 5172
        self.body.generate_execution_code(code)
        code.putln(
            "}")
5173
        temps_to_clean_up = code.funcstate.all_free_managed_temps()
5174 5175
        code.error_label = except_error_label
        code.return_label = except_return_label
William Stein's avatar
William Stein committed
5176 5177 5178 5179 5180 5181
        if self.else_clause:
            code.putln(
                "/*else:*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln(
                "}")
5182
        for var in exc_save_vars:
5183
            code.put_xdecref_clear(var, py_object_type)
5184
        code.put_goto(try_end_label)
5185 5186
        if code.label_used(try_return_label):
            code.put_label(try_return_label)
Stefan Behnel's avatar
Stefan Behnel committed
5187 5188
            for var in exc_save_vars:
                code.put_xgiveref(var)
5189
            code.putln("__Pyx_ExceptionReset(%s);" %
5190
                       ', '.join(exc_save_vars))
5191
            code.put_goto(old_return_label)
William Stein's avatar
William Stein committed
5192
        code.put_label(our_error_label)
5193 5194
        for temp_name, type in temps_to_clean_up:
            code.put_xdecref_clear(temp_name, type)
William Stein's avatar
William Stein committed
5195
        for except_clause in self.except_clauses:
5196 5197
            except_clause.generate_handling_code(code, except_end_label)

5198 5199 5200 5201
        error_label_used = code.label_used(except_error_label)
        if error_label_used or not self.has_default_clause:
            if error_label_used:
                code.put_label(except_error_label)
Stefan Behnel's avatar
Stefan Behnel committed
5202 5203
            for var in exc_save_vars:
                code.put_xgiveref(var)
Stefan Behnel's avatar
Stefan Behnel committed
5204
            code.putln("__Pyx_ExceptionReset(%s);" %
5205
                       ', '.join(exc_save_vars))
5206 5207
            code.put_goto(old_error_label)

5208 5209 5210 5211 5212 5213
        for exit_label, old_label in zip(
            [try_break_label, try_continue_label, except_return_label],
            [old_break_label, old_continue_label, old_return_label]):

            if code.label_used(exit_label):
                code.put_label(exit_label)
Stefan Behnel's avatar
Stefan Behnel committed
5214 5215
                for var in exc_save_vars:
                    code.put_xgiveref(var)
5216
                code.putln("__Pyx_ExceptionReset(%s);" %
5217
                           ', '.join(exc_save_vars))
5218
                code.put_goto(old_label)
5219 5220 5221

        if code.label_used(except_end_label):
            code.put_label(except_end_label)
Stefan Behnel's avatar
Stefan Behnel committed
5222 5223
            for var in exc_save_vars:
                code.put_xgiveref(var)
5224
            code.putln("__Pyx_ExceptionReset(%s);" %
5225
                       ', '.join(exc_save_vars))
5226 5227 5228
        code.put_label(try_end_label)
        code.putln("}")

5229 5230 5231
        for cname in exc_save_vars:
            code.funcstate.release_temp(cname)

5232
        code.return_label = old_return_label
5233
        code.break_label = old_break_label
5234
        code.continue_label = old_continue_label
5235
        code.error_label = old_error_label
William Stein's avatar
William Stein committed
5236

5237 5238 5239 5240 5241 5242 5243
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
        for except_clause in self.except_clauses:
            except_clause.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)

5244 5245 5246 5247 5248 5249 5250
    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
5251 5252 5253 5254

class ExceptClauseNode(Node):
    #  Part of try ... except statement.
    #
5255
    #  pattern        [ExprNode]
William Stein's avatar
William Stein committed
5256 5257
    #  target         ExprNode or None
    #  body           StatNode
5258
    #  excinfo_target ResultRefNode or None   optional target for exception info
William Stein's avatar
William Stein committed
5259 5260 5261
    #  match_flag     string             result of exception match
    #  exc_value      ExcValueNode       used internally
    #  function_name  string             qualified name of enclosing function
5262
    #  exc_vars       (string * 3)       local exception variables
5263 5264 5265 5266

    # 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
5267

5268
    child_attrs = ["pattern", "target", "body", "exc_value", "excinfo_target"]
5269

5270
    exc_value = None
5271
    excinfo_target = None
5272

William Stein's avatar
William Stein committed
5273 5274 5275 5276
    def analyse_declarations(self, env):
        if self.target:
            self.target.analyse_target_declaration(env)
        self.body.analyse_declarations(env)
5277

William Stein's avatar
William Stein committed
5278 5279 5280 5281 5282
    def analyse_expressions(self, env):
        import ExprNodes
        genv = env.global_scope()
        self.function_name = env.qualified_name
        if self.pattern:
5283 5284 5285 5286
            # normalise/unpack self.pattern into a list
            for i, pattern in enumerate(self.pattern):
                pattern.analyse_expressions(env)
                self.pattern[i] = pattern.coerce_to_pyobject(env)
5287

William Stein's avatar
William Stein committed
5288
        if self.target:
5289
            self.exc_value = ExprNodes.ExcValueNode(self.pos, env)
5290
            self.target.analyse_target_expression(env, self.exc_value)
5291 5292 5293
        if self.excinfo_target is not None:
            import ExprNodes
            self.excinfo_tuple = ExprNodes.TupleNode(pos=self.pos, args=[
5294
                ExprNodes.ExcValueNode(pos=self.pos, env=env) for x in range(3)])
5295 5296
            self.excinfo_tuple.analyse_expressions(env)

William Stein's avatar
William Stein committed
5297
        self.body.analyse_expressions(env)
5298

William Stein's avatar
William Stein committed
5299 5300 5301
    def generate_handling_code(self, code, end_label):
        code.mark_pos(self.pos)
        if self.pattern:
5302 5303 5304 5305 5306
            exc_tests = []
            for pattern in self.pattern:
                pattern.generate_evaluation_code(code)
                exc_tests.append("PyErr_ExceptionMatches(%s)" % pattern.py_result())

5307
            match_flag = code.funcstate.allocate_temp(PyrexTypes.c_int_type, False)
William Stein's avatar
William Stein committed
5308
            code.putln(
5309 5310 5311 5312
                "%s = %s;" % (match_flag, ' || '.join(exc_tests)))
            for pattern in self.pattern:
                pattern.generate_disposal_code(code)
                pattern.free_temps(code)
William Stein's avatar
William Stein committed
5313 5314
            code.putln(
                "if (%s) {" %
5315 5316
                    match_flag)
            code.funcstate.release_temp(match_flag)
William Stein's avatar
William Stein committed
5317
        else:
5318
            code.putln("/*except:*/ {")
5319

Stefan Behnel's avatar
fix  
Stefan Behnel committed
5320
        if not getattr(self.body, 'stats', True) and \
Stefan Behnel's avatar
Stefan Behnel committed
5321
                self.excinfo_target is None and self.target is None:
Stefan Behnel's avatar
Stefan Behnel committed
5322 5323
            # most simple case: no exception variable, empty body (pass)
            # => reset the exception state, done
5324 5325 5326 5327
            code.putln("PyErr_Restore(0,0,0);")
            code.put_goto(end_label)
            code.putln("}")
            return
5328

5329 5330 5331
        exc_vars = [code.funcstate.allocate_temp(py_object_type,
                                                 manage_ref=True)
                    for i in xrange(3)]
5332
        code.put_add_traceback(self.function_name)
William Stein's avatar
William Stein committed
5333
        # We always have to fetch the exception value even if
5334
        # there is no target, because this also normalises the
William Stein's avatar
William Stein committed
5335
        # exception and stores it in the thread state.
5336 5337
        code.globalstate.use_utility_code(get_exception_utility_code)
        exc_args = "&%s, &%s, &%s" % tuple(exc_vars)
5338 5339
        code.putln("if (__Pyx_GetException(%s) < 0) %s" % (exc_args,
            code.error_goto(self.pos)))
5340
        for x in exc_vars:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
5341
            code.put_gotref(x)
William Stein's avatar
William Stein committed
5342
        if self.target:
5343
            self.exc_value.set_var(exc_vars[1])
5344
            self.exc_value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
5345
            self.target.generate_assignment_code(self.exc_value, code)
5346
        if self.excinfo_target is not None:
5347 5348
            for tempvar, node in zip(exc_vars, self.excinfo_tuple.args):
                node.set_var(tempvar)
5349
            self.excinfo_tuple.generate_evaluation_code(code)
5350
            self.excinfo_target.result_code = self.excinfo_tuple.result()
5351

5352 5353 5354 5355
        old_break_label, old_continue_label = code.break_label, code.continue_label
        code.break_label = code.new_label('except_break')
        code.continue_label = code.new_label('except_continue')

5356
        old_exc_vars = code.funcstate.exc_vars
5357
        code.funcstate.exc_vars = exc_vars
William Stein's avatar
William Stein committed
5358
        self.body.generate_execution_code(code)
5359
        code.funcstate.exc_vars = old_exc_vars
5360 5361
        if self.excinfo_target is not None:
            self.excinfo_tuple.generate_disposal_code(code)
5362
        for var in exc_vars:
5363
            code.put_decref_clear(var, py_object_type)
5364
        code.put_goto(end_label)
5365

Robert Bradshaw's avatar
Robert Bradshaw committed
5366 5367
        if code.label_used(code.break_label):
            code.put_label(code.break_label)
5368 5369
            if self.excinfo_target is not None:
                self.excinfo_tuple.generate_disposal_code(code)
5370
            for var in exc_vars:
5371
                code.put_decref_clear(var, py_object_type)
Robert Bradshaw's avatar
Robert Bradshaw committed
5372 5373
            code.put_goto(old_break_label)
        code.break_label = old_break_label
5374 5375 5376

        if code.label_used(code.continue_label):
            code.put_label(code.continue_label)
5377 5378
            if self.excinfo_target is not None:
                self.excinfo_tuple.generate_disposal_code(code)
5379
            for var in exc_vars:
5380
                code.put_decref_clear(var, py_object_type)
5381 5382
            code.put_goto(old_continue_label)
        code.continue_label = old_continue_label
5383

5384 5385
        if self.excinfo_target is not None:
            self.excinfo_tuple.free_temps(code)
5386 5387
        for temp in exc_vars:
            code.funcstate.release_temp(temp)
5388

William Stein's avatar
William Stein committed
5389 5390 5391
        code.putln(
            "}")

5392 5393 5394 5395
    def generate_function_definitions(self, env, code):
        if self.target is not None:
            self.target.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)
5396

5397
    def annotate(self, code):
5398
        if self.pattern:
5399 5400
            for pattern in self.pattern:
                pattern.annotate(code)
5401 5402 5403 5404
        if self.target:
            self.target.annotate(code)
        self.body.annotate(code)

William Stein's avatar
William Stein committed
5405 5406 5407 5408 5409 5410

class TryFinallyStatNode(StatNode):
    #  try ... finally statement
    #
    #  body             StatNode
    #  finally_clause   StatNode
5411
    #
William Stein's avatar
William Stein committed
5412 5413 5414 5415 5416 5417 5418 5419
    #  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.
5420

5421
    child_attrs = ["body", "finally_clause"]
5422

5423
    preserve_exception = 1
5424

5425 5426 5427
    # handle exception case, in addition to return/break/continue
    handle_error_case = True

William Stein's avatar
William Stein committed
5428 5429 5430 5431
    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.
5432

5433 5434
    is_try_finally_in_nogil = False

5435 5436 5437 5438
    def create_analysed(pos, env, body, finally_clause):
        node = TryFinallyStatNode(pos, body=body, finally_clause=finally_clause)
        return node
    create_analysed = staticmethod(create_analysed)
5439

William Stein's avatar
William Stein committed
5440 5441 5442
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        self.finally_clause.analyse_declarations(env)
5443

William Stein's avatar
William Stein committed
5444 5445 5446
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
        self.finally_clause.analyse_expressions(env)
5447

5448
    nogil_check = Node.gil_error
5449 5450
    gil_message = "Try-finally statement"

William Stein's avatar
William Stein committed
5451 5452 5453 5454 5455
    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
5456 5457
        if not self.handle_error_case:
            code.error_label = old_error_label
William Stein's avatar
William Stein committed
5458
        catch_label = code.new_label()
5459 5460 5461

        code.putln("/*try:*/ {")

William Stein's avatar
William Stein committed
5462
        if self.disallow_continue_in_try_finally:
5463 5464
            was_in_try_finally = code.funcstate.in_try_finally
            code.funcstate.in_try_finally = 1
5465

William Stein's avatar
William Stein committed
5466
        self.body.generate_execution_code(code)
5467

William Stein's avatar
William Stein committed
5468
        if self.disallow_continue_in_try_finally:
5469
            code.funcstate.in_try_finally = was_in_try_finally
5470 5471 5472

        code.putln("}")

5473
        temps_to_clean_up = code.funcstate.all_free_managed_temps()
5474
        code.mark_pos(self.finally_clause.pos)
5475 5476
        code.putln("/*finally:*/ {")

5477 5478 5479 5480 5481 5482 5483 5484
        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
5485

5486
        if cases_used:
5487 5488
            code.putln("int __pyx_why;")

5489
            if error_label_used and self.preserve_exception:
5490 5491 5492
                if self.is_try_finally_in_nogil:
                    code.declare_gilstate()

5493 5494 5495 5496
                code.putln("PyObject *%s, *%s, *%s;" % Naming.exc_vars)
                code.putln("int %s;" % Naming.exc_lineno_name)
                exc_var_init_zero = ''.join(
                                ["%s = 0; " % var for var in Naming.exc_vars])
5497 5498 5499 5500
                exc_var_init_zero += '%s = 0;' % Naming.exc_lineno_name
                code.putln(exc_var_init_zero)
            else:
                exc_var_init_zero = None
5501

5502
            code.use_label(catch_label)
5503
            code.putln("__pyx_why = 0; goto %s;" % catch_label)
5504 5505
            for i in cases_used:
                new_label = new_labels[i]
Stefan Behnel's avatar
Stefan Behnel committed
5506
                #if new_label and new_label != "<try>":
5507
                if new_label == new_error_label and self.preserve_exception:
5508
                    self.put_error_catcher(code,
5509
                        new_error_label, i+1, catch_label, temps_to_clean_up)
5510
                else:
5511 5512 5513
                    code.put('%s: ' % new_label)
                    if exc_var_init_zero:
                        code.putln(exc_var_init_zero)
5514
                    code.putln("__pyx_why = %s; goto %s;" % (i+1, catch_label))
5515
            code.put_label(catch_label)
5516

William Stein's avatar
William Stein committed
5517
        code.set_all_labels(old_labels)
5518 5519 5520
        if error_label_used:
            code.new_error_label()
            finally_error_label = code.error_label
5521

William Stein's avatar
William Stein committed
5522
        self.finally_clause.generate_execution_code(code)
5523

5524 5525 5526
        if error_label_used:
            if finally_error_label in code.labels_used and self.preserve_exception:
                over_label = code.new_label()
5527
                code.put_goto(over_label)
5528
                code.put_label(finally_error_label)
5529

5530
                code.putln("if (__pyx_why == %d) {" % (error_label_case + 1))
5531 5532
                if self.is_try_finally_in_nogil:
                    code.put_ensure_gil(declare_gilstate=False)
5533 5534
                for var in Naming.exc_vars:
                    code.putln("Py_XDECREF(%s);" % var)
5535 5536
                if self.is_try_finally_in_nogil:
                    code.put_release_ensured_gil()
5537
                code.putln("}")
5538

5539 5540
                code.put_goto(old_error_label)
                code.put_label(over_label)
5541

5542
            code.error_label = old_error_label
5543

5544 5545
        if cases_used:
            code.putln(
William Stein's avatar
William Stein committed
5546
                "switch (__pyx_why) {")
5547 5548 5549
            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
5550 5551
                    self.put_error_uncatcher(code, i+1, old_error_label)
                else:
5552
                    code.use_label(old_label)
5553 5554
                    code.putln("case %s: goto %s;" % (i+1, old_label))

5555
            # End the switch
5556
            code.putln(
5557
                "}")
5558 5559

        # End finally
William Stein's avatar
William Stein committed
5560 5561 5562
        code.putln(
            "}")

5563 5564 5565 5566
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
        self.finally_clause.generate_function_definitions(env, code)

5567 5568
    def put_error_catcher(self, code, error_label, i, catch_label,
                          temps_to_clean_up):
5569
        code.globalstate.use_utility_code(restore_exception_utility_code)
5570 5571 5572 5573 5574 5575
        code.putln("%s: {" % error_label)
        code.putln("__pyx_why = %s;" % i)

        if self.is_try_finally_in_nogil:
            code.put_ensure_gil(declare_gilstate=False)

5576 5577
        for temp_name, type in temps_to_clean_up:
            code.put_xdecref_clear(temp_name, type)
5578 5579 5580 5581 5582 5583 5584

        code.putln("__Pyx_ErrFetch(&%s, &%s, &%s);" % Naming.exc_vars)
        code.putln("%s = %s;" % (Naming.exc_lineno_name, Naming.lineno_cname))

        if self.is_try_finally_in_nogil:
            code.put_release_ensured_gil()

5585
        code.put_goto(catch_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
5586
        code.putln("}")
5587

William Stein's avatar
William Stein committed
5588
    def put_error_uncatcher(self, code, i, error_label):
5589
        code.globalstate.use_utility_code(restore_exception_utility_code)
William Stein's avatar
William Stein committed
5590
        code.putln(
5591
            "case %s: {" % i)
5592 5593 5594 5595 5596 5597 5598 5599 5600 5601

        if self.is_try_finally_in_nogil:
            code.put_ensure_gil(declare_gilstate=False)

        code.putln("__Pyx_ErrRestore(%s, %s, %s);" % Naming.exc_vars)
        code.putln("%s = %s;" % (Naming.lineno_cname, Naming.exc_lineno_name))

        if self.is_try_finally_in_nogil:
            code.put_release_ensured_gil()

5602
        for var in Naming.exc_vars:
William Stein's avatar
William Stein committed
5603
            code.putln(
5604
                   "%s = 0;" % var)
5605

5606
        code.put_goto(error_label)
William Stein's avatar
William Stein committed
5607 5608 5609
        code.putln(
            "}")

5610 5611 5612 5613
    def annotate(self, code):
        self.body.annotate(code)
        self.finally_clause.annotate(code)

William Stein's avatar
William Stein committed
5614

5615 5616 5617 5618 5619 5620 5621 5622 5623 5624
class NogilTryFinallyStatNode(TryFinallyStatNode):
    """
    A try/finally statement that may be used in nogil code sections.
    """

    preserve_exception = False
    nogil_check = None


class GILStatNode(NogilTryFinallyStatNode):
5625 5626 5627
    #  'with gil' or 'with nogil' statement
    #
    #   state   string   'gil' or 'nogil'
5628

5629 5630 5631 5632 5633 5634
    def __init__(self, pos, state, body):
        self.state = state
        TryFinallyStatNode.__init__(self, pos,
            body = body,
            finally_clause = GILExitNode(pos, state = state))

5635 5636 5637 5638
    def analyse_declarations(self, env):
        env._in_with_gil_block = (self.state == 'gil')
        if self.state == 'gil':
            env.has_with_gil_block = True
5639

5640 5641
        return super(GILStatNode, self).analyse_declarations(env)

5642
    def analyse_expressions(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
5643
        env.use_utility_code(force_init_threads_utility_code)
5644
        was_nogil = env.nogil
5645
        env.nogil = self.state == 'nogil'
5646 5647 5648
        TryFinallyStatNode.analyse_expressions(self, env)
        env.nogil = was_nogil

5649
    def generate_execution_code(self, code):
Stefan Behnel's avatar
Stefan Behnel committed
5650
        code.mark_pos(self.pos)
5651
        code.begin_block()
5652

5653
        if self.state == 'gil':
5654
            code.put_ensure_gil()
5655
        else:
5656 5657
            code.put_release_gil()

5658
        TryFinallyStatNode.generate_execution_code(self, code)
5659
        code.end_block()
5660 5661 5662


class GILExitNode(StatNode):
5663 5664 5665 5666 5667
    """
    Used as the 'finally' block in a GILStatNode

    state   string   'gil' or 'nogil'
    """
5668

5669 5670
    child_attrs = []

5671 5672 5673 5674 5675
    def analyse_expressions(self, env):
        pass

    def generate_execution_code(self, code):
        if self.state == 'gil':
5676
            code.put_release_ensured_gil()
5677
        else:
5678
            code.put_acquire_gil()
5679 5680


5681 5682 5683 5684 5685 5686 5687
class EnsureGILNode(GILExitNode):
    """
    Ensure the GIL in nogil functions for cleanup before returning.
    """

    def generate_execution_code(self, code):
        code.put_ensure_gil(declare_gilstate=False)
5688 5689


William Stein's avatar
William Stein committed
5690 5691 5692 5693 5694
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
5695 5696

    child_attrs = []
5697

William Stein's avatar
William Stein committed
5698
    def analyse_declarations(self, env):
5699 5700 5701
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
William Stein's avatar
William Stein committed
5702 5703
        module_scope = env.find_module(self.module_name, self.pos)
        if "." in self.module_name:
5704
            names = [EncodedString(name) for name in self.module_name.split(".")]
William Stein's avatar
William Stein committed
5705 5706 5707 5708 5709 5710 5711 5712 5713 5714
            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:
5715
                env.add_imported_module(module_scope)
William Stein's avatar
William Stein committed
5716 5717 5718 5719 5720 5721 5722
                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
5723

William Stein's avatar
William Stein committed
5724 5725
    def generate_execution_code(self, code):
        pass
5726

William Stein's avatar
William Stein committed
5727 5728 5729 5730

class FromCImportStatNode(StatNode):
    #  from ... cimport statement
    #
5731 5732
    #  module_name     string                        Qualified name of module
    #  imported_names  [(pos, name, as_name, kind)]  Names to be imported
5733

5734 5735
    child_attrs = []

William Stein's avatar
William Stein committed
5736
    def analyse_declarations(self, env):
5737 5738 5739
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
William Stein's avatar
William Stein committed
5740 5741
        module_scope = env.find_module(self.module_name, self.pos)
        env.add_imported_module(module_scope)
5742
        for pos, name, as_name, kind in self.imported_names:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5743 5744 5745 5746
            if name == "*":
                for local_name, entry in module_scope.entries.items():
                    env.add_imported_entry(local_name, entry, pos)
            else:
5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758
                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:
5759 5760 5761 5762 5763 5764
                        submodule_scope = env.context.find_module(name, relative_to = module_scope, pos = self.pos)
                        if submodule_scope.parent_module is module_scope:
                            env.declare_module(as_name or name, submodule_scope, self.pos)
                        else:
                            error(pos, "Name '%s' not declared in module '%s'"
                                % (name, self.module_name))
5765

Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5766 5767 5768
                if entry:
                    local_name = as_name or name
                    env.add_imported_entry(local_name, entry, pos)
5769

5770
    def declaration_matches(self, entry, kind):
5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782
        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
5783 5784 5785

    def analyse_expressions(self, env):
        pass
5786

William Stein's avatar
William Stein committed
5787 5788 5789 5790 5791 5792 5793 5794 5795
    def generate_execution_code(self, code):
        pass


class FromImportStatNode(StatNode):
    #  from ... import statement
    #
    #  module           ImportNode
    #  items            [(string, NameNode)]
5796
    #  interned_items   [(string, NameNode, ExprNode)]
William Stein's avatar
William Stein committed
5797
    #  item             PyTempNode            used internally
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5798
    #  import_star      boolean               used internally
5799 5800

    child_attrs = ["module"]
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5801
    import_star = 0
5802

William Stein's avatar
William Stein committed
5803
    def analyse_declarations(self, env):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5804 5805 5806 5807 5808 5809 5810 5811 5812
        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)
5813

William Stein's avatar
William Stein committed
5814 5815 5816
    def analyse_expressions(self, env):
        import ExprNodes
        self.module.analyse_expressions(env)
5817
        self.item = ExprNodes.RawCNameExprNode(self.pos, py_object_type)
William Stein's avatar
William Stein committed
5818 5819
        self.interned_items = []
        for name, target in self.items:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5820 5821 5822 5823 5824 5825
            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:
5826
                entry =  env.lookup(target.name)
5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839
                # check whether or not entry is already cimported
                if (entry.is_type and entry.type.name == name
                    and hasattr(entry.type, 'module_name')):
                    if entry.type.module_name == self.module.module_name.value:
                        # cimported with absolute name
                        continue
                    try:
                        # cimported with relative name
                        module = env.find_module(self.module.module_name.value,
                                                 pos=None)
                        if entry.type.module_name == module.qualified_name:
                            continue
                    except AttributeError:
5840
                        pass
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5841
                target.analyse_target_expression(env, None)
5842 5843 5844 5845
                if target.type is py_object_type:
                    coerced_item = None
                else:
                    coerced_item = self.item.coerce_to(target.type, env)
5846
                self.interned_items.append((name, target, coerced_item))
5847

William Stein's avatar
William Stein committed
5848 5849
    def generate_execution_code(self, code):
        self.module.generate_evaluation_code(code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5850 5851 5852 5853 5854 5855
        if self.import_star:
            code.putln(
                'if (%s(%s) < 0) %s;' % (
                    Naming.import_star,
                    self.module.py_result(),
                    code.error_goto(self.pos)))
5856 5857
        item_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        self.item.set_cname(item_temp)
5858 5859
        for name, target, coerced_item in self.interned_items:
            cname = code.intern_identifier(name)
5860 5861
            code.putln(
                '%s = PyObject_GetAttr(%s, %s); %s' % (
5862
                    item_temp,
5863 5864
                    self.module.py_result(),
                    cname,
5865 5866
                    code.error_goto_if_null(item_temp, self.pos)))
            code.put_gotref(item_temp)
5867 5868 5869 5870 5871 5872
            if coerced_item is None:
                target.generate_assignment_code(self.item, code)
            else:
                coerced_item.allocate_temp_result(code)
                coerced_item.generate_result_code(code)
                target.generate_assignment_code(coerced_item, code)
5873 5874
            code.put_decref_clear(item_temp, py_object_type)
        code.funcstate.release_temp(item_temp)
William Stein's avatar
William Stein committed
5875
        self.module.generate_disposal_code(code)
5876
        self.module.free_temps(code)
William Stein's avatar
William Stein committed
5877

5878

Mark Florisson's avatar
Mark Florisson committed
5879 5880 5881 5882 5883 5884 5885 5886 5887 5888
class ParallelNode(Node):
    """
    Base class for cython.parallel constructs.
    """

    nogil_check = None


class ParallelStatNode(StatNode, ParallelNode):
    """
5889
    Base class for 'with cython.parallel.parallel():' and 'for i in prange():'.
Mark Florisson's avatar
Mark Florisson committed
5890 5891 5892 5893 5894

    assignments     { Entry(var) : (var.pos, inplace_operator_or_None) }
                    assignments to variables in this parallel section

    parent          parent ParallelStatNode or None
5895 5896 5897
    is_parallel     indicates whether this node is OpenMP parallel
                    (true for #pragma omp parallel for and
                              #pragma omp parallel)
Mark Florisson's avatar
Mark Florisson committed
5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908

    is_parallel is true for:

        #pragma omp parallel
        #pragma omp parallel for

    sections, but NOT for

        #pragma omp for

    We need this to determine the sharing attributes.
5909 5910 5911

    privatization_insertion_point   a code insertion point used to make temps
                                    private (esp. the "nsteps" temp)
5912 5913 5914 5915

    args         tuple          the arguments passed to the parallel construct
    kwargs       DictNode       the keyword arguments passed to the parallel
                                construct (replaced by its compile time value)
Mark Florisson's avatar
Mark Florisson committed
5916 5917 5918 5919 5920 5921 5922 5923
    """

    child_attrs = ['body']

    body = None

    is_prange = False

5924
    error_label_used = False
5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942

    parallel_exc = (
        Naming.parallel_exc_type,
        Naming.parallel_exc_value,
        Naming.parallel_exc_tb,
    )

    parallel_pos_info = (
        Naming.parallel_filename,
        Naming.parallel_lineno,
        Naming.parallel_clineno,
    )

    pos_info = (
        Naming.filename_cname,
        Naming.lineno_cname,
        Naming.clineno_cname,
    )
5943

5944 5945
    critical_section_counter = 0

Mark Florisson's avatar
Mark Florisson committed
5946 5947
    def __init__(self, pos, **kwargs):
        super(ParallelStatNode, self).__init__(pos, **kwargs)
5948 5949

        # All assignments in this scope
Mark Florisson's avatar
Mark Florisson committed
5950 5951
        self.assignments = kwargs.get('assignments') or {}

5952 5953 5954 5955
        # All seen closure cnames and their temporary cnames
        self.seen_closure_vars = set()

        # Dict of variables that should be declared (first|last|)private or
5956 5957
        # reduction { Entry: (op, lastprivate) }.
        # If op is not None, it's a reduction.
5958
        self.privates = {}
Mark Florisson's avatar
Mark Florisson committed
5959

Mark Florisson's avatar
Mark Florisson committed
5960 5961 5962
        # [NameNode]
        self.assigned_nodes = []

Mark Florisson's avatar
Mark Florisson committed
5963 5964 5965
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)

5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976
        if self.kwargs:
            self.kwargs = self.kwargs.compile_time_value(env)
        else:
            self.kwargs = {}

        for kw, val in self.kwargs.iteritems():
            if kw not in self.valid_keyword_arguments:
                error(self.pos, "Invalid keyword argument: %s" % kw)
            else:
                setattr(self, kw, val)

5977 5978
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
5979
        self.analyse_sharing_attributes(env)
5980 5981

    def analyse_sharing_attributes(self, env):
Mark Florisson's avatar
Mark Florisson committed
5982
        """
5983 5984 5985
        Analyse the privates for this block and set them in self.privates.
        This should be called in a post-order fashion during the
        analyse_expressions phase
Mark Florisson's avatar
Mark Florisson committed
5986
        """
5987
        for entry, (pos, op) in self.assignments.iteritems():
5988 5989 5990 5991 5992 5993 5994

            if self.is_prange and not self.is_parallel:
                # closely nested prange in a with parallel block, disallow
                # assigning to privates in the with parallel block (we
                # consider it too implicit and magicky for users)
                if entry in self.parent.assignments:
                    error(pos,
Mark Florisson's avatar
Mark Florisson committed
5995
                          "Cannot assign to private of outer parallel block")
5996 5997 5998 5999 6000 6001 6002
                    continue

            if not self.is_prange and op:
                # Again possible, but considered to magicky
                error(pos, "Reductions not allowed for parallel blocks")
                continue

Mark Florisson's avatar
Mark Florisson committed
6003 6004 6005 6006
            # By default all variables should have the same values as if
            # executed sequentially
            lastprivate = True
            self.propagate_var_privatization(entry, op, lastprivate)
6007

6008
    def propagate_var_privatization(self, entry, op, lastprivate):
6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036
        """
        Propagate the sharing attributes of a variable. If the privatization is
        determined by a parent scope, done propagate further.

        If we are a prange, we propagate our sharing attributes outwards to
        other pranges. If we are a prange in parallel block and the parallel
        block does not determine the variable private, we propagate to the
        parent of the parent. Recursion stops at parallel blocks, as they have
        no concept of lastprivate or reduction.

        So the following cases propagate:

            sum is a reduction for all loops:

                for i in prange(n):
                    for j in prange(n):
                        for k in prange(n):
                            sum += i * j * k

            sum is a reduction for both loops, local_var is private to the
            parallel with block:

                for i in prange(n):
                    with parallel:
                        local_var = ... # private to the parallel
                        for j in prange(n):
                            sum += i * j

Mark Florisson's avatar
Mark Florisson committed
6037 6038
        Nested with parallel blocks are disallowed, because they wouldn't
        allow you to propagate lastprivates or reductions:
6039 6040 6041 6042

            #pragma omp parallel for lastprivate(i)
            for i in prange(n):

Mark Florisson's avatar
Mark Florisson committed
6043 6044
                sum = 0

6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060
                #pragma omp parallel private(j, sum)
                with parallel:

                    #pragma omp parallel
                    with parallel:

                        #pragma omp for lastprivate(j) reduction(+:sum)
                        for j in prange(n):
                            sum += i

                    # sum and j are well-defined here

                # sum and j are undefined here

            # sum and j are undefined here
        """
6061
        self.privates[entry] = (op, lastprivate)
6062 6063 6064 6065 6066 6067
        if self.is_prange:
            if not self.is_parallel and entry not in self.parent.assignments:
                # Parent is a parallel with block
                parent = self.parent.parent
            else:
                parent = self.parent
Mark Florisson's avatar
Mark Florisson committed
6068

6069 6070 6071 6072
            # We don't need to propagate privates, only reductions and
            # lastprivates
            if parent and (op or lastprivate):
                parent.propagate_var_privatization(entry, op, lastprivate)
Mark Florisson's avatar
Mark Florisson committed
6073 6074 6075 6076 6077 6078 6079 6080 6081

    def _allocate_closure_temp(self, code, entry):
        """
        Helper function that allocate a temporary for a closure variable that
        is assigned to.
        """
        if self.parent:
            return self.parent._allocate_closure_temp(code, entry)

6082 6083 6084
        if entry.cname in self.seen_closure_vars:
            return entry.cname

6085
        cname = code.funcstate.allocate_temp(entry.type, True)
6086 6087 6088 6089 6090 6091

        # Add both the actual cname and the temp cname, as the actual cname
        # will be replaced with the temp cname on the entry
        self.seen_closure_vars.add(entry.cname)
        self.seen_closure_vars.add(cname)

Mark Florisson's avatar
Mark Florisson committed
6092 6093 6094 6095
        self.modified_entries.append((entry, entry.cname))
        code.putln("%s = %s;" % (cname, entry.cname))
        entry.cname = cname

6096
    def initialize_privates_to_nan(self, code, exclude=None):
6097
        first = True
6098

6099
        for entry, (op, lastprivate) in self.privates.iteritems():
6100
            if not op and (not exclude or entry != exclude):
6101
                invalid_value = entry.type.invalid_value()
6102

6103
                if invalid_value:
6104 6105 6106 6107
                    if first:
                        code.putln("/* Initialize private variables to "
                                   "invalid values */")
                        code.globalstate.use_utility_code(
6108
                                invalid_values_utility_code)
6109 6110 6111
                        first = False

                    have_invalid_values = True
6112
                    code.putln("%s = %s;" % (entry.cname,
6113
                                             entry.type.cast_code(invalid_value)))
6114

6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125
    def put_num_threads(self, code):
        """
        Write self.num_threads if set as the num_threads OpenMP directive
        """
        if self.num_threads is not None:
            if isinstance(self.num_threads, (int, long)):
                code.put(" num_threads(%d)" % (self.num_threads,))
            else:
                error(self.pos, "Invalid value for num_threads argument, "
                                "expected an int")

Mark Florisson's avatar
Mark Florisson committed
6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136
    def declare_closure_privates(self, code):
        """
        If a variable is in a scope object, we need to allocate a temp and
        assign the value from the temp to the variable in the scope object
        after the parallel section. This kind of copying should be done only
        in the outermost parallel section.
        """
        self.modified_entries = []

        for entry, (pos, op) in self.assignments.iteritems():
            if entry.from_closure or entry.in_closure:
6137
                self._allocate_closure_temp(code, entry)
Mark Florisson's avatar
Mark Florisson committed
6138 6139

    def release_closure_privates(self, code):
6140 6141 6142
        """
        Release any temps used for variables in scope objects. As this is the
        outermost parallel block, we don't need to delete the cnames from
6143
        self.seen_closure_vars.
6144
        """
Mark Florisson's avatar
Mark Florisson committed
6145 6146 6147 6148 6149
        for entry, original_cname in self.modified_entries:
            code.putln("%s = %s;" % (original_cname, entry.cname))
            code.funcstate.release_temp(entry.cname)
            entry.cname = original_cname

6150 6151 6152 6153 6154 6155
    def privatize_temps(self, code, exclude_temps=()):
        """
        Make any used temporaries private. Before the relevant code block
        code.start_collecting_temps() should have been called.
        """
        if self.is_parallel:
6156
            c = self.privatization_insertion_point
6157

6158 6159 6160 6161 6162 6163 6164
            temps = code.funcstate.stop_collecting_temps()
            privates, firstprivates = [], []
            for temp, type in temps:
                if type.is_pyobject:
                    firstprivates.append(temp)
                else:
                    privates.append(temp)
6165

6166 6167 6168 6169
            if privates:
                c.put(" private(%s)" % ", ".join(privates))
            if firstprivates:
                c.put(" firstprivate(%s)" % ", ".join(firstprivates))
6170 6171 6172 6173 6174 6175 6176 6177

            if self.breaking_label_used:
                shared_vars = [Naming.parallel_why]
                if self.error_label_used:
                    shared_vars.extend(self.parallel_exc)
                    c.put(" private(%s, %s, %s)" % self.pos_info)

                c.put(" shared(%s)" % ', '.join(shared_vars))
6178

6179
    def setup_parallel_control_flow_block(self, code):
6180
        """
6181 6182
        Sets up a block that surrounds the parallel block to determine
        how the parallel section was exited. Any kind of return is
6183 6184 6185
        trapped (break, continue, return, exceptions). This is the idea:

        {
6186
            int why = 0;
6187 6188 6189 6190 6191 6192 6193

            #pragma omp parallel
            {
                return # -> goto new_return_label;
                goto end_parallel;

            new_return_label:
6194
                why = 3;
6195
                goto end_parallel;
6196

6197
            end_parallel:;
6198
                #pragma omp flush(why) # we need to flush for every iteration
6199 6200
            }

6201
            if (why == 3)
6202 6203 6204 6205 6206 6207 6208 6209
                goto old_return_label;
        }
        """
        self.old_loop_labels = code.new_loop_labels()
        self.old_error_label = code.new_error_label()
        self.old_return_label = code.return_label
        code.return_label = code.new_label(name="return")

6210 6211
        code.begin_block() # parallel control flow block
        self.begin_of_parallel_control_block_point = code.insertion_point()
6212

6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235
    def begin_parallel_block(self, code):
        """
        Each OpenMP thread in a parallel section that contains a with gil block
        must have the thread-state initialized. The call to
        PyGILState_Release() then deallocates our threadstate. If we wouldn't
        do this, each with gil block would allocate and deallocate one, thereby
        losing exception information before it can be saved before leaving the
        parallel section.
        """
        self.begin_of_parallel_block = code.insertion_point()

    def end_parallel_block(self, code):
        "Acquire the GIL, deallocate threadstate, release"
        if self.error_label_used:
            begin_code = self.begin_of_parallel_block
            end_code = code

            begin_code.put_ensure_gil(declare_gilstate=True)
            begin_code.putln("Py_BEGIN_ALLOW_THREADS")

            end_code.putln("Py_END_ALLOW_THREADS")
            end_code.put_release_ensured_gil()

6236 6237 6238 6239
    def trap_parallel_exit(self, code, should_flush=False):
        """
        Trap any kind of return inside a parallel construct. 'should_flush'
        indicates whether the variable should be flushed, which is needed by
6240 6241 6242 6243 6244 6245 6246 6247 6248
        prange to skip the loop. It also indicates whether we need to register
        a continue (we need this for parallel blocks, but not for prange
        loops, as it is a direct jump there).

        It uses the same mechanism as try/finally:
            1 continue
            2 break
            3 return
            4 error
6249
        """
6250
        save_lastprivates_label = code.new_label()
6251
        dont_return_label = code.new_label()
6252 6253 6254 6255
        insertion_point = code.insertion_point()

        self.any_label_used = False
        self.breaking_label_used = False
6256
        self.error_label_used = False
6257

6258 6259 6260 6261 6262 6263
        self.parallel_private_temps = []

        all_labels = code.get_all_labels()

        # Figure this out before starting to generate any code
        for label in all_labels:
6264 6265
            if code.label_used(label):
                self.breaking_label_used = (self.breaking_label_used or
6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276
                                            label != code.continue_label)
                self.any_label_used = True

        if self.any_label_used:
            code.put_goto(dont_return_label)

        for i, label in enumerate(all_labels):
            if not code.label_used(label):
                continue

            is_continue_label = label == code.continue_label
6277

6278
            code.put_label(label)
6279

6280 6281 6282 6283
            if not (should_flush and is_continue_label):
                if label == code.error_label:
                    self.error_label_used = True
                    self.fetch_parallel_exception(code)
6284

6285
                code.putln("%s = %d;" % (Naming.parallel_why, i + 1))
6286

6287 6288 6289 6290
            if (self.breaking_label_used and self.is_prange and not
                    is_continue_label):
                code.put_goto(save_lastprivates_label)
            else:
6291 6292
                code.put_goto(dont_return_label)

6293
        if self.any_label_used:
6294 6295 6296 6297 6298
            if self.is_prange and self.breaking_label_used:
                # Don't rely on lastprivate, save our lastprivates
                code.put_label(save_lastprivates_label)
                self.save_parallel_vars(code)

6299 6300 6301
            code.put_label(dont_return_label)

            if should_flush and self.breaking_label_used:
6302 6303
                code.putln_openmp("#pragma omp flush(%s)" % Naming.parallel_why)

6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342
    def save_parallel_vars(self, code):
        """
        The following shenanigans are instated when we break, return or
        propagate errors from a prange. In this case we cannot rely on
        lastprivate() to do its job, as no iterations may have executed yet
        in the last thread, leaving the values undefined. It is most likely
        that the breaking thread has well-defined values of the lastprivate
        variables, so we keep those values.
        """
        section_name = ("__pyx_parallel_lastprivates%d" %
                                            self.critical_section_counter)
        code.putln_openmp("#pragma omp critical(%s)" % section_name)
        ParallelStatNode.critical_section_counter += 1

        code.begin_block() # begin critical section

        c = self.begin_of_parallel_control_block_point

        temp_count = 0
        for entry, (op, lastprivate) in self.privates.iteritems():
            if not lastprivate or entry.type.is_pyobject:
                continue

            type_decl = entry.type.declaration_code("")
            temp_cname = "__pyx_parallel_temp%d" % temp_count
            private_cname = entry.cname

            temp_count += 1

            # Declare the parallel private in the outer block
            c.putln("%s %s;" % (type_decl, temp_cname))

            # Initialize before escaping
            code.putln("%s = %s;" % (temp_cname, private_cname))

            self.parallel_private_temps.append((temp_cname, private_cname))

        code.end_block() # end critical section

6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399
    def fetch_parallel_exception(self, code):
        """
        As each OpenMP thread may raise an exception, we need to fetch that
        exception from the threadstate and save it for after the parallel
        section where it can be re-raised in the master thread.

        Although it would seem that __pyx_filename, __pyx_lineno and
        __pyx_clineno are only assigned to under exception conditions (i.e.,
        when we have the GIL), and thus should be allowed to be shared without
        any race condition, they are in fact subject to the same race
        conditions that they were previously when they were global variables
        and functions were allowed to release the GIL:

            thread A                thread B
                acquire
                set lineno
                release
                                        acquire
                                        set lineno
                                        release
                acquire
                fetch exception
                release
                                        skip the fetch

                deallocate threadstate  deallocate threadstate
        """
        code.begin_block()
        code.put_ensure_gil(declare_gilstate=True)

        code.putln_openmp("#pragma omp flush(%s)" % Naming.parallel_exc_type)
        code.putln(
            "if (!%s) {" % Naming.parallel_exc_type)

        code.putln("__Pyx_ErrFetch(&%s, &%s, &%s);" % self.parallel_exc)
        pos_info = chain(*zip(self.parallel_pos_info, self.pos_info))
        code.putln("%s = %s; %s = %s; %s = %s;" % tuple(pos_info))
        code.putln('__Pyx_GOTREF(%s);' % Naming.parallel_exc_type)

        code.putln(
            "}")

        code.put_release_ensured_gil()
        code.end_block()

    def restore_parallel_exception(self, code):
        "Re-raise a parallel exception"
        code.begin_block()
        code.put_ensure_gil(declare_gilstate=True)

        code.putln("__Pyx_ErrRestore(%s, %s, %s);" % self.parallel_exc)
        pos_info = chain(*zip(self.pos_info, self.parallel_pos_info))
        code.putln("%s = %s; %s = %s; %s = %s;" % tuple(pos_info))
        code.putln("__Pyx_GIVEREF(%s);" % Naming.parallel_exc_type)

        code.put_release_ensured_gil()
        code.end_block()
6400 6401

    def restore_labels(self, code):
6402 6403 6404 6405 6406 6407
        """
        Restore all old labels. Call this before the 'else' clause to for
        loops and always before ending the parallel control flow block.
        """
        code.set_all_labels(self.old_loop_labels + (self.old_return_label,
                                                    self.old_error_label))
6408

6409 6410 6411 6412 6413 6414 6415
    def end_parallel_control_flow_block(self, code,
                                        break_=False, continue_=False):
        """
        This ends the parallel control flow block and based on how the parallel
        section was exited, takes the corresponding action. The break_ and
        continue_ parameters indicate whether these should be propagated
        outwards:
6416

6417 6418 6419 6420 6421 6422 6423
            for i in prange(...):
                with cython.parallel.parallel():
                    continue

        Here break should be trapped in the parallel block, and propagated to
        the for loop.
        """
6424 6425 6426 6427
        c = self.begin_of_parallel_control_block_point

        # Firstly, always prefer errors over returning, continue or break
        if self.error_label_used:
6428 6429 6430
            c.putln("const char *%s; int %s, %s;" % self.parallel_pos_info)
            c.putln("%s = NULL; %s = %s = 0;" % self.parallel_pos_info)

6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441
            c.putln("PyObject *%s = NULL, *%s = NULL, *%s = NULL;" %
                                                self.parallel_exc)

            code.putln(
                "if (%s) {" % Naming.parallel_exc_type)
            code.putln("/* This may have been overridden by a continue, "
                       "break or return in another thread. Prefer the error. */")
            code.putln("%s = 4;" % Naming.parallel_why)
            code.putln(
                "}")

6442 6443 6444 6445 6446 6447 6448
        if continue_:
            any_label_used = self.any_label_used
        else:
            any_label_used = self.breaking_label_used

        if any_label_used:
            # __pyx_parallel_why is used, declare and initialize
6449 6450
            c.putln("int %s;" % Naming.parallel_why)
            c.putln("%s = 0;" % Naming.parallel_why)
6451

6452 6453 6454 6455 6456 6457
            code.putln(
                "if (%s) {" % Naming.parallel_why)

            for temp_cname, private_cname in self.parallel_private_temps:
                code.putln("%s = %s;" % (private_cname, temp_cname))

6458
            code.putln("switch (%s) {" % Naming.parallel_why)
6459 6460 6461 6462 6463 6464 6465 6466 6467 6468
            if continue_:
                code.put("    case 1: ")
                code.put_goto(code.continue_label)

            if break_:
                code.put("    case 2: ")
                code.put_goto(code.break_label)

            code.put("    case 3: ")
            code.put_goto(code.return_label)
6469 6470

            if self.error_label_used:
6471
                code.globalstate.use_utility_code(restore_exception_utility_code)
6472 6473 6474
                code.putln("    case 4:")
                self.restore_parallel_exception(code)
                code.put_goto(code.error_label)
6475

6476 6477 6478
            code.putln("}") # end switch
            code.putln(
                "}") # end if
6479 6480

        code.end_block() # end parallel control flow block
6481

Mark Florisson's avatar
Mark Florisson committed
6482 6483 6484

class ParallelWithBlockNode(ParallelStatNode):
    """
6485
    This node represents a 'with cython.parallel.parallel():' block
Mark Florisson's avatar
Mark Florisson committed
6486 6487 6488 6489
    """

    nogil_check = None

6490 6491 6492 6493 6494 6495 6496 6497 6498 6499
    valid_keyword_arguments = ['num_threads']

    num_threads = None

    def analyse_declarations(self, env):
        super(ParallelWithBlockNode, self).analyse_declarations(env)
        if self.args:
            error(self.pos, "cython.parallel.parallel() does not take "
                            "positional arguments")

Mark Florisson's avatar
Mark Florisson committed
6500 6501
    def generate_execution_code(self, code):
        self.declare_closure_privates(code)
6502
        self.setup_parallel_control_flow_block(code)
Mark Florisson's avatar
Mark Florisson committed
6503 6504 6505

        code.putln("#ifdef _OPENMP")
        code.put("#pragma omp parallel ")
6506 6507

        if self.privates:
6508 6509
            privates = [e.cname for e in self.privates
                                    if not e.type.is_pyobject]
6510
            code.put('private(%s)' % ', '.join(privates))
6511

6512
        self.privatization_insertion_point = code.insertion_point()
6513
        self.put_num_threads(code)
6514
        code.putln("")
6515

6516 6517
        code.putln("#endif /* _OPENMP */")

6518
        code.begin_block() # parallel block
6519
        self.begin_parallel_block(code)
6520
        self.initialize_privates_to_nan(code)
6521
        code.funcstate.start_collecting_temps()
Mark Florisson's avatar
Mark Florisson committed
6522
        self.body.generate_execution_code(code)
6523
        self.trap_parallel_exit(code)
6524
        self.privatize_temps(code)
6525 6526
        self.end_parallel_block(code)
        code.end_block() # end parallel block
6527

6528 6529
        continue_ = code.label_used(code.continue_label)
        break_ = code.label_used(code.break_label)
6530

6531 6532 6533
        self.restore_labels(code)
        self.end_parallel_control_flow_block(code, break_=break_,
                                             continue_=continue_)
Mark Florisson's avatar
Mark Florisson committed
6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551
        self.release_closure_privates(code)


class ParallelRangeNode(ParallelStatNode):
    """
    This node represents a 'for i in cython.parallel.prange():' construct.

    target       NameNode       the target iteration variable
    else_clause  Node or None   the else clause of this loop
    """

    child_attrs = ['body', 'target', 'else_clause', 'args']

    body = target = else_clause = args = None

    start = stop = step = None

    is_prange = True
6552

6553
    nogil = None
6554 6555 6556 6557
    schedule = None
    num_threads = None

    valid_keyword_arguments = ['schedule', 'nogil', 'num_threads']
Mark Florisson's avatar
Mark Florisson committed
6558

6559 6560 6561 6562 6563
    def __init__(self, pos, **kwds):
        super(ParallelRangeNode, self).__init__(pos, **kwds)
        # Pretend to be a ForInStatNode for control flow analysis
        self.iterator = PassStatNode(pos)

Mark Florisson's avatar
Mark Florisson committed
6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580
    def analyse_declarations(self, env):
        super(ParallelRangeNode, self).analyse_declarations(env)
        self.target.analyse_target_declaration(env)
        if self.else_clause is not None:
            self.else_clause.analyse_declarations(env)

        if not self.args or len(self.args) > 3:
            error(self.pos, "Invalid number of positional arguments to prange")
            return

        if len(self.args) == 1:
            self.stop, = self.args
        elif len(self.args) == 2:
            self.start, self.stop = self.args
        else:
            self.start, self.stop, self.step = self.args

Mark Florisson's avatar
Mark Florisson committed
6581 6582 6583
        if hasattr(self.schedule, 'decode'):
            self.schedule = self.schedule.decode('ascii')

Mark Florisson's avatar
Mark Florisson committed
6584 6585
        if self.schedule not in (None, 'static', 'dynamic', 'guided',
                                 'runtime'):
Mark Florisson's avatar
Mark Florisson committed
6586
            error(self.pos, "Invalid schedule argument to prange: %s" %
Mark Florisson's avatar
Mark Florisson committed
6587 6588 6589
                                                        (self.schedule,))

    def analyse_expressions(self, env):
6590 6591 6592 6593
        if self.nogil:
            was_nogil = env.nogil
            env.nogil = True

6594 6595 6596
        if self.target is None:
            error(self.pos, "prange() can only be used as part of a for loop")
            return
Mark Florisson's avatar
Mark Florisson committed
6597

6598
        self.target.analyse_target_types(env)
Mark Florisson's avatar
Mark Florisson committed
6599

6600 6601 6602 6603 6604 6605 6606 6607
        if not self.target.type.is_numeric:
            # Not a valid type, assume one for now anyway

            if not self.target.type.is_pyobject:
                # nogil_check will catch the is_pyobject case
                error(self.target.pos,
                      "Must be of numeric type, not %s" % self.target.type)

6608
            self.index_type = PyrexTypes.c_py_ssize_t_type
6609 6610
        else:
            self.index_type = self.target.type
Mark Florisson's avatar
Mark Florisson committed
6611 6612 6613 6614 6615 6616 6617 6618 6619

        # Setup start, stop and step, allocating temps if needed
        self.names = 'start', 'stop', 'step'
        start_stop_step = self.start, self.stop, self.step

        for node, name in zip(start_stop_step, self.names):
            if node is not None:
                node.analyse_types(env)
                if not node.type.is_numeric:
6620 6621
                    error(node.pos, "%s argument must be numeric" % name)
                    continue
Mark Florisson's avatar
Mark Florisson committed
6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634

                if not node.is_literal:
                    node = node.coerce_to_temp(env)
                    setattr(self, name, node)

                # As we range from 0 to nsteps, computing the index along the
                # way, we need a fitting type for 'i' and 'nsteps'
                self.index_type = PyrexTypes.widest_numeric_type(
                                        self.index_type, node.type)

        if self.else_clause is not None:
            self.else_clause.analyse_expressions(env)

6635 6636 6637 6638 6639 6640 6641 6642
        # Although not actually an assignment in this scope, it should be
        # treated as such to ensure it is unpacked if a closure temp, and to
        # ensure lastprivate behaviour and propagation. If the target index is
        # not a NameNode, it won't have an entry, and an error was issued by
        # ParallelRangeTransform
        if hasattr(self.target, 'entry'):
            self.assignments[self.target.entry] = self.target.pos, None

6643
        super(ParallelRangeNode, self).analyse_expressions(env)
6644

6645 6646 6647
        if self.nogil:
            env.nogil = was_nogil

Mark Florisson's avatar
Mark Florisson committed
6648 6649
    def nogil_check(self, env):
        names = 'start', 'stop', 'step', 'target'
6650
        nodes = self.start, self.stop, self.step, self.target
Mark Florisson's avatar
Mark Florisson committed
6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695
        for name, node in zip(names, nodes):
            if node is not None and node.type.is_pyobject:
                error(node.pos, "%s may not be a Python object "
                                "as we don't have the GIL" % name)

    def generate_execution_code(self, code):
        """
        Generate code in the following steps

            1)  copy any closure variables determined thread-private
                into temporaries

            2)  allocate temps for start, stop and step

            3)  generate a loop that calculates the total number of steps,
                which then computes the target iteration variable for every step:

                    for i in prange(start, stop, step):
                        ...

                becomes

                    nsteps = (stop - start) / step;
                    i = start;

                    #pragma omp parallel for lastprivate(i)
                    for (temp = 0; temp < nsteps; temp++) {
                        i = start + step * temp;
                        ...
                    }

                Note that accumulation of 'i' would have a data dependency
                between iterations.

                Also, you can't do this

                    for (i = start; i < stop; i += step)
                        ...

                as the '<' operator should become '>' for descending loops.
                'for i from x < i < y:' does not suffer from this problem
                as the relational operator is known at compile time!

            4) release our temps and write back any private closure variables
        """
6696
        self.declare_closure_privates(code)
Mark Florisson's avatar
Mark Florisson committed
6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727

        # This can only be a NameNode
        target_index_cname = self.target.entry.cname

        # This will be used as the dict to format our code strings, holding
        # the start, stop , step, temps and target cnames
        fmt_dict = {
            'target': target_index_cname,
        }

        # Setup start, stop and step, allocating temps if needed
        start_stop_step = self.start, self.stop, self.step
        defaults = '0', '0', '1'
        for node, name, default in zip(start_stop_step, self.names, defaults):
            if node is None:
                result = default
            elif node.is_literal:
                result = node.get_constant_c_result_code()
            else:
                node.generate_evaluation_code(code)
                result = node.result()

            fmt_dict[name] = result

        fmt_dict['i'] = code.funcstate.allocate_temp(self.index_type, False)
        fmt_dict['nsteps'] = code.funcstate.allocate_temp(self.index_type, False)

        # TODO: check if the step is 0 and if so, raise an exception in a
        # 'with gil' block. For now, just abort
        code.putln("if (%(step)s == 0) abort();" % fmt_dict)

6728
        self.setup_parallel_control_flow_block(code) # parallel control flow block
6729

6730
        self.control_flow_var_code_point = code.insertion_point()
6731

6732
        # Note: nsteps is private in an outer scope if present
Mark Florisson's avatar
Mark Florisson committed
6733 6734
        code.putln("%(nsteps)s = (%(stop)s - %(start)s) / %(step)s;" % fmt_dict)

6735 6736 6737 6738 6739 6740 6741
        # The target iteration variable might not be initialized, do it only if
        # we are executing at least 1 iteration, otherwise we should leave the
        # target unaffected. The target iteration variable is firstprivate to
        # shut up compiler warnings caused by lastprivate, as the compiler
        # erroneously believes that nsteps may be <= 0, leaving the private
        # target index uninitialized
        code.putln("if (%(nsteps)s > 0)" % fmt_dict)
6742
        code.begin_block() # if block
6743
        code.putln("%(target)s = 0;" % fmt_dict)
Mark Florisson's avatar
Mark Florisson committed
6744
        self.generate_loop(code, fmt_dict)
6745
        code.end_block() # end if block
Mark Florisson's avatar
Mark Florisson committed
6746

6747 6748 6749
        self.restore_labels(code)

        if self.else_clause:
6750
            if self.breaking_label_used:
6751
                code.put("if (%s < 2)" % Naming.parallel_why)
6752 6753 6754 6755 6756 6757 6758

            code.begin_block() # else block
            code.putln("/* else */")
            self.else_clause.generate_execution_code(code)
            code.end_block() # end else block

        # ------ cleanup ------
6759
        self.end_parallel_control_flow_block(code) # end parallel control flow block
6760

Mark Florisson's avatar
Mark Florisson committed
6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777
        # And finally, release our privates and write back any closure
        # variables
        for temp in start_stop_step:
            if temp is not None:
                temp.generate_disposal_code(code)
                temp.free_temps(code)

        code.funcstate.release_temp(fmt_dict['i'])
        code.funcstate.release_temp(fmt_dict['nsteps'])

        self.release_closure_privates(code)

    def generate_loop(self, code, fmt_dict):
        code.putln("#ifdef _OPENMP")

        if not self.is_parallel:
            code.put("#pragma omp for")
6778
            self.privatization_insertion_point = code.insertion_point()
Mark Florisson's avatar
Mark Florisson committed
6779
            # reduction_codepoint = self.parent.privatization_insertion_point
Mark Florisson's avatar
Mark Florisson committed
6780
        else:
6781 6782
            code.put("#pragma omp parallel")
            self.privatization_insertion_point = code.insertion_point()
Mark Florisson's avatar
Mark Florisson committed
6783
            # reduction_codepoint = self.privatization_insertion_point
6784 6785 6786 6787 6788 6789 6790 6791 6792 6793
            code.putln("")
            code.putln("#endif /* _OPENMP */")

            code.begin_block() # pragma omp parallel begin block

            # Initialize the GIL if needed for this thread
            self.begin_parallel_block(code)

            code.putln("#ifdef _OPENMP")
            code.put("#pragma omp for")
Mark Florisson's avatar
Mark Florisson committed
6794

Mark Florisson's avatar
Mark Florisson committed
6795 6796 6797 6798 6799
        # Nested parallelism is not supported, so we can put reductions on the
        # for and not on the parallel (but would be valid, but gcc45 bugs on
        # the former)
        reduction_codepoint = code

6800
        for entry, (op, lastprivate) in self.privates.iteritems():
Mark Florisson's avatar
Mark Florisson committed
6801
            # Don't declare the index variable as a reduction
6802
            if op and op in "+*-&^|" and entry != self.target.entry:
6803 6804 6805
                if entry.type.is_pyobject:
                    error(self.pos, "Python objects cannot be reductions")
                else:
6806 6807 6808 6809
                    #code.put(" reduction(%s:%s)" % (op, entry.cname))
                    # This is the only way reductions + nesting works in gcc4.5
                    reduction_codepoint.put(
                                " reduction(%s:%s)" % (op, entry.cname))
6810
            else:
6811 6812
                if entry == self.target.entry:
                    code.put(" firstprivate(%s)" % entry.cname)
6813 6814
                    code.put(" lastprivate(%s)" % entry.cname)
                    continue
6815 6816

                if not entry.type.is_pyobject:
6817 6818 6819 6820 6821 6822
                    if lastprivate:
                        private = 'lastprivate'
                    else:
                        private = 'private'

                    code.put(" %s(%s)" % (private, entry.cname))
Mark Florisson's avatar
Mark Florisson committed
6823 6824 6825 6826

        if self.schedule:
            code.put(" schedule(%s)" % self.schedule)

6827
        self.put_num_threads(reduction_codepoint)
6828

6829 6830
        code.putln("")
        code.putln("#endif /* _OPENMP */")
Mark Florisson's avatar
Mark Florisson committed
6831 6832

        code.put("for (%(i)s = 0; %(i)s < %(nsteps)s; %(i)s++)" % fmt_dict)
6833
        code.begin_block() # for loop block
6834

6835
        guard_around_body_codepoint = code.insertion_point()
6836

6837 6838 6839 6840
        # Start if guard block around the body. This may be unnecessary, but
        # at least it doesn't spoil indentation
        code.begin_block()

6841 6842
        code.putln("%(target)s = %(start)s + %(step)s * %(i)s;" % fmt_dict)
        self.initialize_privates_to_nan(code, exclude=self.target.entry)
6843 6844 6845 6846

        if self.is_parallel:
            code.funcstate.start_collecting_temps()

Mark Florisson's avatar
Mark Florisson committed
6847
        self.body.generate_execution_code(code)
6848
        self.trap_parallel_exit(code, should_flush=True)
6849 6850
        self.privatize_temps(code)

6851 6852 6853
        if self.breaking_label_used:
            # Put a guard around the loop body in case return, break or
            # exceptions might be used
6854
            guard_around_body_codepoint.putln("if (%s < 2)" % Naming.parallel_why)
6855

6856
        code.end_block() # end guard around loop body
6857
        code.end_block() # end for loop block
Mark Florisson's avatar
Mark Florisson committed
6858

6859 6860 6861 6862 6863
        if self.is_parallel:
            # Release the GIL and deallocate the thread state
            self.end_parallel_block(code)
            code.end_block() # pragma omp parallel end block

6864

6865 6866 6867 6868 6869 6870 6871 6872
class CnameDecoratorNode(StatNode):
    """
    This node is for the cname decorator in CythonUtilityCode:

        @cname('the_cname')
        cdef func(...):
            ...

6873 6874
    In case of a cdef class the cname specifies the objstruct_cname.

6875 6876 6877 6878 6879 6880 6881 6882
    node        the node to which the cname decorator is applied
    cname       the cname the node should get
    """

    child_attrs = ['node']

    def analyse_declarations(self, env):
        self.node.analyse_declarations(env)
6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934

        self.is_function = isinstance(self.node, FuncDefNode)
        e = self.node.entry

        if self.is_function:
            e.cname = self.cname
            e.func_cname = self.cname
        else:
            scope = self.node.scope

            e.cname = self.cname
            e.type.objstruct_cname = self.cname
            e.type.typeobj_cname = Naming.typeobj_prefix + self.cname
            e.type.typeptr_cname = Naming.typeptr_prefix + self.cname

            e.as_variable.cname = py_object_type.cast_code(e.type.typeptr_cname)

            scope.scope_prefix = self.cname + "_"

            for name, entry in scope.entries.iteritems():
                if entry.func_cname:
                    entry.func_cname = '%s_%s' % (self.cname, entry.cname)

    def analyse_expressions(self, env):
        self.node.analyse_expressions(env)

    def generate_function_definitions(self, env, code):
        if self.is_function and env.is_c_class_scope:
            # method in cdef class, generate a prototype in the header
            h_code = code.globalstate['utility_code_proto']

            if isinstance(self.node, DefNode):
                self.node.generate_function_header(
                            h_code, with_pymethdef=False, proto_only=True)
            else:
                import ModuleNode
                entry = self.node.entry
                cname = entry.cname
                entry.cname = entry.func_cname

                ModuleNode.generate_cfunction_declaration(
                        entry,
                        env.global_scope(),
                        h_code,
                        definition=True)

                entry.cname = cname

        self.node.generate_function_definitions(env, code)

    def generate_execution_code(self, code):
        self.node.generate_execution_code(code)
6935 6936


William Stein's avatar
William Stein committed
6937 6938 6939 6940 6941 6942 6943 6944
#------------------------------------------------------------------------------------
#
#  Runtime support code
#
#------------------------------------------------------------------------------------

utility_function_predeclarations = \
"""
6945
/* inline attribute */
6946
#ifndef CYTHON_INLINE
6947
  #if defined(__GNUC__)
6948
    #define CYTHON_INLINE __inline__
6949
  #elif defined(_MSC_VER)
6950
    #define CYTHON_INLINE __inline
Robert Bradshaw's avatar
Robert Bradshaw committed
6951 6952
  #elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
    #define CYTHON_INLINE inline
6953
  #else
6954
    #define CYTHON_INLINE
6955
  #endif
6956 6957
#endif

6958 6959 6960 6961
/* unused attribute */
#ifndef CYTHON_UNUSED
# if defined(__GNUC__)
#   if !(defined(__cplusplus)) || (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4))
6962
#     define CYTHON_UNUSED __attribute__ ((__unused__))
6963 6964 6965 6966
#   else
#     define CYTHON_UNUSED
#   endif
# elif defined(__ICC) || defined(__INTEL_COMPILER)
6967
#   define CYTHON_UNUSED __attribute__ ((__unused__))
6968
# else
6969
#   define CYTHON_UNUSED
6970 6971 6972
# endif
#endif

6973
typedef struct {PyObject **p; char *s; const long n; const char* encoding; const char is_unicode; const char is_str; const char intern; } __Pyx_StringTabEntry; /*proto*/
6974

Robert Bradshaw's avatar
Robert Bradshaw committed
6975
"""
Robert Bradshaw's avatar
Robert Bradshaw committed
6976 6977 6978 6979

if Options.gcc_branch_hints:
    branch_prediction_macros = \
    """
6980
#ifdef __GNUC__
6981 6982 6983 6984 6985 6986 6987 6988
  /* Test for GCC > 2.95 */
  #if __GNUC__ > 2 || (__GNUC__ == 2 && (__GNUC_MINOR__ > 95))
    #define likely(x)   __builtin_expect(!!(x), 1)
    #define unlikely(x) __builtin_expect(!!(x), 0)
  #else /* __GNUC__ > 2 ... */
    #define likely(x)   (x)
    #define unlikely(x) (x)
  #endif /* __GNUC__ > 2 ... */
6989
#else /* __GNUC__ */
6990 6991
  #define likely(x)   (x)
  #define unlikely(x) (x)
6992
#endif /* __GNUC__ */
Robert Bradshaw's avatar
Robert Bradshaw committed
6993 6994 6995 6996 6997 6998 6999
    """
else:
    branch_prediction_macros = \
    """
#define likely(x)   (x)
#define unlikely(x) (x)
    """
William Stein's avatar
William Stein committed
7000

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

7004 7005
#get_name_interned_predeclaration = \
#"static PyObject *__Pyx_GetName(PyObject *dict, PyObject *name); /*proto*/"
William Stein's avatar
William Stein committed
7006 7007 7008

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

7009 7010
printing_utility_code = UtilityCode(
proto = """
7011
static int __Pyx_Print(PyObject*, PyObject *, int); /*proto*/
7012
#if PY_MAJOR_VERSION >= 3
7013 7014 7015
static PyObject* %s = 0;
static PyObject* %s = 0;
#endif
7016
""" % (Naming.print_function, Naming.print_function_kwargs),
7017 7018 7019 7020 7021 7022
cleanup = """
#if PY_MAJOR_VERSION >= 3
Py_CLEAR(%s);
Py_CLEAR(%s);
#endif
""" % (Naming.print_function, Naming.print_function_kwargs),
7023
impl = r"""
7024
#if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
7025
static PyObject *__Pyx_GetStdout(void) {
7026
    PyObject *f = PySys_GetObject((char *)"stdout");
William Stein's avatar
William Stein committed
7027 7028 7029 7030 7031 7032
    if (!f) {
        PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
    }
    return f;
}

7033
static int __Pyx_Print(PyObject* f, PyObject *arg_tuple, int newline) {
7034 7035
    PyObject* v;
    int i;
7036

7037 7038 7039 7040
    if (!f) {
        if (!(f = __Pyx_GetStdout()))
            return -1;
    }
7041 7042 7043 7044 7045 7046 7047
    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
7048
            return -1;
7049 7050 7051 7052 7053 7054 7055 7056
        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
7057
    }
7058 7059 7060 7061
    if (newline) {
        if (PyFile_WriteString("\n", f) < 0)
            return -1;
        PyFile_SoftSpace(f, 0);
William Stein's avatar
William Stein committed
7062 7063 7064 7065
    }
    return 0;
}

7066
#else /* Python 3 has a print function */
7067

7068
static int __Pyx_Print(PyObject* stream, PyObject *arg_tuple, int newline) {
7069 7070 7071
    PyObject* kwargs = 0;
    PyObject* result = 0;
    PyObject* end_string;
7072
    if (unlikely(!%(PRINT_FUNCTION)s)) {
7073
        %(PRINT_FUNCTION)s = __Pyx_GetAttrString(%(BUILTINS)s, "print");
7074
        if (!%(PRINT_FUNCTION)s)
7075
            return -1;
7076
    }
7077 7078 7079 7080 7081 7082
    if (stream) {
        kwargs = PyDict_New();
        if (unlikely(!kwargs))
            return -1;
        if (unlikely(PyDict_SetItemString(kwargs, "file", stream) < 0))
            goto bad;
7083 7084 7085 7086 7087 7088 7089 7090 7091
        if (!newline) {
            end_string = PyUnicode_FromStringAndSize(" ", 1);
            if (unlikely(!end_string))
                goto bad;
            if (PyDict_SetItemString(kwargs, "end", end_string) < 0) {
                Py_DECREF(end_string);
                goto bad;
            }
            Py_DECREF(end_string);
7092
        }
7093 7094
    } else if (!newline) {
        if (unlikely(!%(PRINT_KWARGS)s)) {
7095
            %(PRINT_KWARGS)s = PyDict_New();
7096
            if (unlikely(!%(PRINT_KWARGS)s))
7097
                return -1;
7098 7099
            end_string = PyUnicode_FromStringAndSize(" ", 1);
            if (unlikely(!end_string))
Stefan Behnel's avatar
Stefan Behnel committed
7100
                return -1;
7101 7102
            if (PyDict_SetItemString(%(PRINT_KWARGS)s, "end", end_string) < 0) {
                Py_DECREF(end_string);
Stefan Behnel's avatar
Stefan Behnel committed
7103
                return -1;
7104
            }
7105 7106
            Py_DECREF(end_string);
        }
7107
        kwargs = %(PRINT_KWARGS)s;
7108 7109
    }
    result = PyObject_Call(%(PRINT_FUNCTION)s, arg_tuple, kwargs);
7110
    if (unlikely(kwargs) && (kwargs != %(PRINT_KWARGS)s))
7111
        Py_DECREF(kwargs);
7112
    if (!result)
William Stein's avatar
William Stein committed
7113
        return -1;
7114
    Py_DECREF(result);
William Stein's avatar
William Stein committed
7115
    return 0;
7116
bad:
7117
    if (kwargs != %(PRINT_KWARGS)s)
7118 7119
        Py_XDECREF(kwargs);
    return -1;
William Stein's avatar
William Stein committed
7120
}
7121

7122 7123 7124 7125 7126 7127 7128 7129 7130
#endif
""" % {'BUILTINS'       : Naming.builtins_cname,
       'PRINT_FUNCTION' : Naming.print_function,
       'PRINT_KWARGS'   : Naming.print_function_kwargs}
)


printing_one_utility_code = UtilityCode(
proto = """
7131
static int __Pyx_PrintOne(PyObject* stream, PyObject *o); /*proto*/
7132 7133 7134 7135
""",
impl = r"""
#if PY_MAJOR_VERSION < 3

7136 7137 7138 7139 7140
static int __Pyx_PrintOne(PyObject* f, PyObject *o) {
    if (!f) {
        if (!(f = __Pyx_GetStdout()))
            return -1;
    }
7141 7142 7143 7144 7145 7146 7147 7148 7149
    if (PyFile_SoftSpace(f, 0)) {
        if (PyFile_WriteString(" ", f) < 0)
            return -1;
    }
    if (PyFile_WriteObject(o, f, Py_PRINT_RAW) < 0)
        return -1;
    if (PyFile_WriteString("\n", f) < 0)
        return -1;
    return 0;
7150 7151
    /* the line below is just to avoid compiler
     * compiler warnings about unused functions */
7152
    return __Pyx_Print(f, NULL, 0);
7153 7154 7155 7156
}

#else /* Python 3 has a print function */

7157
static int __Pyx_PrintOne(PyObject* stream, PyObject *o) {
7158 7159 7160 7161 7162 7163
    int res;
    PyObject* arg_tuple = PyTuple_New(1);
    if (unlikely(!arg_tuple))
        return -1;
    Py_INCREF(o);
    PyTuple_SET_ITEM(arg_tuple, 0, o);
7164
    res = __Pyx_Print(stream, arg_tuple, 1);
7165 7166 7167 7168
    Py_DECREF(arg_tuple);
    return res;
}

7169
#endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7170 7171
""",
requires=[printing_utility_code])
7172 7173


William Stein's avatar
William Stein committed
7174 7175 7176

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

7177 7178 7179 7180 7181 7182 7183 7184 7185
# Exception raising code
#
# Exceptions are raised by __Pyx_Raise() and stored as plain
# type/value/tb in PyThreadState->curexc_*.  When being caught by an
# 'except' statement, curexc_* is moved over to exc_* by
# __Pyx_GetException()

restore_exception_utility_code = UtilityCode(
proto = """
7186 7187
static CYTHON_INLINE void __Pyx_ErrRestore(PyObject *type, PyObject *value, PyObject *tb); /*proto*/
static CYTHON_INLINE void __Pyx_ErrFetch(PyObject **type, PyObject **value, PyObject **tb); /*proto*/
7188 7189
""",
impl = """
7190
static CYTHON_INLINE void __Pyx_ErrRestore(PyObject *type, PyObject *value, PyObject *tb) {
7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204
    PyObject *tmp_type, *tmp_value, *tmp_tb;
    PyThreadState *tstate = PyThreadState_GET();

    tmp_type = tstate->curexc_type;
    tmp_value = tstate->curexc_value;
    tmp_tb = tstate->curexc_traceback;
    tstate->curexc_type = type;
    tstate->curexc_value = value;
    tstate->curexc_traceback = tb;
    Py_XDECREF(tmp_type);
    Py_XDECREF(tmp_value);
    Py_XDECREF(tmp_tb);
}

7205
static CYTHON_INLINE void __Pyx_ErrFetch(PyObject **type, PyObject **value, PyObject **tb) {
7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220
    PyThreadState *tstate = PyThreadState_GET();
    *type = tstate->curexc_type;
    *value = tstate->curexc_value;
    *tb = tstate->curexc_traceback;

    tstate->curexc_type = 0;
    tstate->curexc_value = 0;
    tstate->curexc_traceback = 0;
}

""")

# The following function is based on do_raise() from ceval.c. There
# are separate versions for Python2 and Python3 as exception handling
# has changed quite a lot between the two versions.
William Stein's avatar
William Stein committed
7221

7222 7223
raise_utility_code = UtilityCode(
proto = """
Haoyu Bai's avatar
Haoyu Bai committed
7224
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb, PyObject *cause); /*proto*/
7225 7226
""",
impl = """
7227
#if PY_MAJOR_VERSION < 3
Haoyu Bai's avatar
Haoyu Bai committed
7228 7229
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb, PyObject *cause) {
    /* cause is unused */
William Stein's avatar
William Stein committed
7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247
    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);
    }
7248 7249 7250 7251 7252 7253
    #if PY_VERSION_HEX < 0x02050000
    if (!PyClass_Check(type))
    #else
    if (!PyType_Check(type))
    #endif
    {
William Stein's avatar
William Stein committed
7254 7255 7256
        /* Raising an instance.  The value should be a dummy. */
        if (value != Py_None) {
            PyErr_SetString(PyExc_TypeError,
7257
                "instance exception may not have a separate value");
William Stein's avatar
William Stein committed
7258 7259
            goto raise_error;
        }
7260 7261 7262
        /* Normalize to raise <class>, <instance> */
        Py_DECREF(value);
        value = type;
7263 7264 7265 7266 7267 7268
        #if PY_VERSION_HEX < 0x02050000
            if (PyInstance_Check(type)) {
                type = (PyObject*) ((PyInstanceObject*)type)->in_class;
                Py_INCREF(type);
            }
            else {
7269
                type = 0;
7270 7271 7272 7273 7274
                PyErr_SetString(PyExc_TypeError,
                    "raise: exception must be an old-style class or instance");
                goto raise_error;
            }
        #else
7275
            type = (PyObject*) Py_TYPE(type);
7276 7277 7278 7279 7280 7281 7282
            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
7283
    }
7284

7285
    __Pyx_ErrRestore(type, value, tb);
7286 7287 7288
    return;
raise_error:
    Py_XDECREF(value);
William Stein's avatar
William Stein committed
7289 7290 7291 7292
    Py_XDECREF(type);
    Py_XDECREF(tb);
    return;
}
7293

7294
#else /* Python 3+ */
7295

Haoyu Bai's avatar
Haoyu Bai committed
7296
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb, PyObject *cause) {
7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320
    if (tb == Py_None) {
        tb = 0;
    } else if (tb && !PyTraceBack_Check(tb)) {
        PyErr_SetString(PyExc_TypeError,
            "raise: arg 3 must be a traceback or None");
        goto bad;
    }
    if (value == Py_None)
        value = 0;

    if (PyExceptionInstance_Check(type)) {
        if (value) {
            PyErr_SetString(PyExc_TypeError,
                "instance exception may not have a separate value");
            goto bad;
        }
        value = type;
        type = (PyObject*) Py_TYPE(value);
    } else if (!PyExceptionClass_Check(type)) {
        PyErr_SetString(PyExc_TypeError,
            "raise: exception class must be a subclass of BaseException");
        goto bad;
    }

Haoyu Bai's avatar
Haoyu Bai committed
7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343
    if (cause) {
        PyObject *fixed_cause;
        if (PyExceptionClass_Check(cause)) {
            fixed_cause = PyObject_CallObject(cause, NULL);
            if (fixed_cause == NULL)
                goto bad;
        }
        else if (PyExceptionInstance_Check(cause)) {
            fixed_cause = cause;
            Py_INCREF(fixed_cause);
        }
        else {
            PyErr_SetString(PyExc_TypeError,
                            "exception causes must derive from "
                            "BaseException");
            goto bad;
        }
        if (!value) {
            value = PyObject_CallObject(type, NULL);
        }
        PyException_SetCause(value, fixed_cause);
    }

7344 7345 7346 7347
    PyErr_SetObject(type, value);

    if (tb) {
        PyThreadState *tstate = PyThreadState_GET();
7348 7349 7350 7351 7352
        PyObject* tmp_tb = tstate->curexc_traceback;
        if (tb != tmp_tb) {
            Py_INCREF(tb);
            tstate->curexc_traceback = tb;
            Py_XDECREF(tmp_tb);
7353 7354
        }
    }
7355

7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380
bad:
    return;
}
#endif
""",
requires=[restore_exception_utility_code])

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

get_exception_utility_code = UtilityCode(
proto = """
static int __Pyx_GetException(PyObject **type, PyObject **value, PyObject **tb); /*proto*/
""",
impl = """
static int __Pyx_GetException(PyObject **type, PyObject **value, PyObject **tb) {
    PyObject *local_type, *local_value, *local_tb;
    PyObject *tmp_type, *tmp_value, *tmp_tb;
    PyThreadState *tstate = PyThreadState_GET();
    local_type = tstate->curexc_type;
    local_value = tstate->curexc_value;
    local_tb = tstate->curexc_traceback;
    tstate->curexc_type = 0;
    tstate->curexc_value = 0;
    tstate->curexc_traceback = 0;
    PyErr_NormalizeException(&local_type, &local_value, &local_tb);
7381 7382 7383 7384
    if (unlikely(tstate->curexc_type))
        goto bad;
    #if PY_MAJOR_VERSION >= 3
    if (unlikely(PyException_SetTraceback(local_value, local_tb) < 0))
7385
        goto bad;
7386
    #endif
7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421
    *type = local_type;
    *value = local_value;
    *tb = local_tb;
    Py_INCREF(local_type);
    Py_INCREF(local_value);
    Py_INCREF(local_tb);
    tmp_type = tstate->exc_type;
    tmp_value = tstate->exc_value;
    tmp_tb = tstate->exc_traceback;
    tstate->exc_type = local_type;
    tstate->exc_value = local_value;
    tstate->exc_traceback = local_tb;
    /* 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);
    return 0;
bad:
    *type = 0;
    *value = 0;
    *tb = 0;
    Py_XDECREF(local_type);
    Py_XDECREF(local_value);
    Py_XDECREF(local_tb);
    return -1;
}

""")

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

get_exception_tuple_utility_code = UtilityCode(proto="""
static PyObject *__Pyx_GetExceptionTuple(void); /*proto*/
""",
7422 7423 7424
# I doubt that calling __Pyx_GetException() here is correct as it moves
# the exception from tstate->curexc_* to tstate->exc_*, which prevents
# exception handlers later on from receiving it.
7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448
impl = """
static PyObject *__Pyx_GetExceptionTuple(void) {
    PyObject *type = NULL, *value = NULL, *tb = NULL;
    if (__Pyx_GetException(&type, &value, &tb) == 0) {
        PyObject* exc_info = PyTuple_New(3);
        if (exc_info) {
            Py_INCREF(type);
            Py_INCREF(value);
            Py_INCREF(tb);
            PyTuple_SET_ITEM(exc_info, 0, type);
            PyTuple_SET_ITEM(exc_info, 1, value);
            PyTuple_SET_ITEM(exc_info, 2, tb);
            return exc_info;
        }
    }
    return NULL;
}
""",
requires=[get_exception_utility_code])

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

reset_exception_utility_code = UtilityCode(
proto = """
7449
static CYTHON_INLINE void __Pyx_ExceptionSave(PyObject **type, PyObject **value, PyObject **tb); /*proto*/
7450 7451 7452
static void __Pyx_ExceptionReset(PyObject *type, PyObject *value, PyObject *tb); /*proto*/
""",
impl = """
7453
static CYTHON_INLINE void __Pyx_ExceptionSave(PyObject **type, PyObject **value, PyObject **tb) {
7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475
    PyThreadState *tstate = PyThreadState_GET();
    *type = tstate->exc_type;
    *value = tstate->exc_value;
    *tb = tstate->exc_traceback;
    Py_XINCREF(*type);
    Py_XINCREF(*value);
    Py_XINCREF(*tb);
}

static void __Pyx_ExceptionReset(PyObject *type, PyObject *value, PyObject *tb) {
    PyObject *tmp_type, *tmp_value, *tmp_tb;
    PyThreadState *tstate = PyThreadState_GET();
    tmp_type = tstate->exc_type;
    tmp_value = tstate->exc_value;
    tmp_tb = tstate->exc_traceback;
    tstate->exc_type = type;
    tstate->exc_value = value;
    tstate->exc_traceback = tb;
    Py_XDECREF(tmp_type);
    Py_XDECREF(tmp_value);
    Py_XDECREF(tmp_tb);
}
7476
""")
William Stein's avatar
William Stein committed
7477 7478 7479

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

7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504
swap_exception_utility_code = UtilityCode(
proto = """
static CYTHON_INLINE void __Pyx_ExceptionSwap(PyObject **type, PyObject **value, PyObject **tb); /*proto*/
""",
impl = """
static CYTHON_INLINE void __Pyx_ExceptionSwap(PyObject **type, PyObject **value, PyObject **tb) {
    PyObject *tmp_type, *tmp_value, *tmp_tb;
    PyThreadState *tstate = PyThreadState_GET();

    tmp_type = tstate->exc_type;
    tmp_value = tstate->exc_value;
    tmp_tb = tstate->exc_traceback;

    tstate->exc_type = *type;
    tstate->exc_value = *value;
    tstate->exc_traceback = *tb;

    *type = tmp_type;
    *value = tmp_value;
    *tb = tmp_tb;
}
""")

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

7505 7506
arg_type_test_utility_code = UtilityCode(
proto = """
7507 7508
static int __Pyx_ArgTypeTest(PyObject *obj, PyTypeObject *type, int none_allowed,
    const char *name, int exact); /*proto*/
7509 7510
""",
impl = """
7511 7512 7513
static int __Pyx_ArgTypeTest(PyObject *obj, PyTypeObject *type, int none_allowed,
    const char *name, int exact)
{
William Stein's avatar
William Stein committed
7514 7515 7516 7517
    if (!type) {
        PyErr_Format(PyExc_SystemError, "Missing type object");
        return 0;
    }
Robert Bradshaw's avatar
Robert Bradshaw committed
7518 7519
    if (none_allowed && obj == Py_None) return 1;
    else if (exact) {
7520
        if (Py_TYPE(obj) == type) return 1;
Robert Bradshaw's avatar
Robert Bradshaw committed
7521 7522
    }
    else {
Robert Bradshaw's avatar
Robert Bradshaw committed
7523
        if (PyObject_TypeCheck(obj, type)) return 1;
Robert Bradshaw's avatar
Robert Bradshaw committed
7524
    }
William Stein's avatar
William Stein committed
7525 7526
    PyErr_Format(PyExc_TypeError,
        "Argument '%s' has incorrect type (expected %s, got %s)",
7527
        name, type->tp_name, Py_TYPE(obj)->tp_name);
William Stein's avatar
William Stein committed
7528 7529
    return 0;
}
7530
""")
William Stein's avatar
William Stein committed
7531 7532 7533

#------------------------------------------------------------------------------------
#
7534 7535 7536
#  __Pyx_RaiseArgtupleInvalid raises the correct exception when too
#  many or too few positional arguments were found.  This handles
#  Py_ssize_t formatting correctly.
7537

7538 7539
raise_argtuple_invalid_utility_code = UtilityCode(
proto = """
7540
static void __Pyx_RaiseArgtupleInvalid(const char* func_name, int exact,
7541
    Py_ssize_t num_min, Py_ssize_t num_max, Py_ssize_t num_found); /*proto*/
7542 7543
""",
impl = """
7544
static void __Pyx_RaiseArgtupleInvalid(
7545
    const char* func_name,
7546
    int exact,
7547 7548
    Py_ssize_t num_min,
    Py_ssize_t num_max,
7549
    Py_ssize_t num_found)
William Stein's avatar
William Stein committed
7550
{
7551
    Py_ssize_t num_expected;
7552
    const char *more_or_less;
7553 7554 7555 7556

    if (num_found < num_min) {
        num_expected = num_min;
        more_or_less = "at least";
7557
    } else {
7558
        num_expected = num_max;
7559
        more_or_less = "at most";
7560
    }
7561 7562
    if (exact) {
        more_or_less = "exactly";
7563
    }
Stefan Behnel's avatar
Stefan Behnel committed
7564
    PyErr_Format(PyExc_TypeError,
7565 7566 7567
                 "%s() takes %s %"PY_FORMAT_SIZE_T"d positional argument%s (%"PY_FORMAT_SIZE_T"d given)",
                 func_name, more_or_less, num_expected,
                 (num_expected == 1) ? "" : "s", num_found);
7568
}
7569
""")
7570

7571 7572
raise_keyword_required_utility_code = UtilityCode(
proto = """
7573
static CYTHON_INLINE void __Pyx_RaiseKeywordRequired(const char* func_name, PyObject* kw_name); /*proto*/
7574 7575
""",
impl = """
7576
static CYTHON_INLINE void __Pyx_RaiseKeywordRequired(
7577
    const char* func_name,
7578
    PyObject* kw_name)
7579 7580
{
    PyErr_Format(PyExc_TypeError,
7581 7582 7583 7584 7585 7586
        #if PY_MAJOR_VERSION >= 3
        "%s() needs keyword-only argument %U", func_name, kw_name);
        #else
        "%s() needs keyword-only argument %s", func_name,
        PyString_AS_STRING(kw_name));
        #endif
7587
}
7588
""")
7589

7590 7591
raise_double_keywords_utility_code = UtilityCode(
proto = """
7592
static void __Pyx_RaiseDoubleKeywordsError(
7593
    const char* func_name, PyObject* kw_name); /*proto*/
7594 7595
""",
impl = """
7596
static void __Pyx_RaiseDoubleKeywordsError(
7597
    const char* func_name,
7598
    PyObject* kw_name)
7599
{
7600
    PyErr_Format(PyExc_TypeError,
7601 7602 7603 7604 7605 7606
        #if PY_MAJOR_VERSION >= 3
        "%s() got multiple values for keyword argument '%U'", func_name, kw_name);
        #else
        "%s() got multiple values for keyword argument '%s'", func_name,
        PyString_AS_STRING(kw_name));
        #endif
7607
}
7608
""")
7609

7610 7611
#------------------------------------------------------------------------------------
#
7612 7613 7614
#  __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.
7615

7616 7617
keyword_string_check_utility_code = UtilityCode(
proto = """
7618
static CYTHON_INLINE int __Pyx_CheckKeywordStrings(PyObject *kwdict,
7619
    const char* function_name, int kw_allowed); /*proto*/
7620 7621
""",
impl = """
7622
static CYTHON_INLINE int __Pyx_CheckKeywordStrings(
7623 7624 7625 7626
    PyObject *kwdict,
    const char* function_name,
    int kw_allowed)
{
7627 7628
    PyObject* key = 0;
    Py_ssize_t pos = 0;
7629
    while (PyDict_Next(kwdict, &pos, &key, 0)) {
7630
        #if PY_MAJOR_VERSION < 3
7631
        if (unlikely(!PyString_CheckExact(key)) && unlikely(!PyString_Check(key)))
7632
        #else
7633
        if (unlikely(!PyUnicode_CheckExact(key)) && unlikely(!PyUnicode_Check(key)))
7634
        #endif
7635
            goto invalid_keyword_type;
7636
    }
7637 7638
    if ((!kw_allowed) && unlikely(key))
        goto invalid_keyword;
7639
    return 1;
7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653
invalid_keyword_type:
    PyErr_Format(PyExc_TypeError,
        "%s() keywords must be strings", function_name);
    return 0;
invalid_keyword:
    PyErr_Format(PyExc_TypeError,
    #if PY_MAJOR_VERSION < 3
        "%s() got an unexpected keyword argument '%s'",
        function_name, PyString_AsString(key));
    #else
        "%s() got an unexpected keyword argument '%U'",
        function_name, key);
    #endif
    return 0;
7654
}
7655
""")
7656

7657 7658
#------------------------------------------------------------------------------------
#
7659 7660 7661
#  __Pyx_ParseOptionalKeywords copies the optional/unknown keyword
#  arguments from the kwds dict into kwds2.  If kwds2 is NULL, unknown
#  keywords will raise an invalid keyword error.
7662
#
Stefan Behnel's avatar
Stefan Behnel committed
7663 7664
#  Three kinds of errors are checked: 1) non-string keywords, 2)
#  unexpected keywords and 3) overlap with positional arguments.
7665
#
Stefan Behnel's avatar
Stefan Behnel committed
7666 7667 7668 7669 7670
#  If num_posargs is greater 0, it denotes the number of positional
#  arguments that were passed and that must therefore not appear
#  amongst the keywords as well.
#
#  This method does not check for required keyword arguments.
7671 7672
#

7673
parse_keywords_utility_code = UtilityCode(
7674
proto = """
7675
static int __Pyx_ParseOptionalKeywords(PyObject *kwds, PyObject **argnames[], \
7676 7677
    PyObject *kwds2, PyObject *values[], Py_ssize_t num_pos_args, \
    const char* function_name); /*proto*/
7678 7679
""",
impl = """
7680
static int __Pyx_ParseOptionalKeywords(
7681
    PyObject *kwds,
Stefan Behnel's avatar
Stefan Behnel committed
7682 7683
    PyObject **argnames[],
    PyObject *kwds2,
7684
    PyObject *values[],
Stefan Behnel's avatar
Stefan Behnel committed
7685
    Py_ssize_t num_pos_args,
7686
    const char* function_name)
7687
{
7688
    PyObject *key = 0, *value = 0;
7689
    Py_ssize_t pos = 0;
7690
    PyObject*** name;
7691
    PyObject*** first_kw_arg = argnames + num_pos_args;
7692

Stefan Behnel's avatar
Stefan Behnel committed
7693
    while (PyDict_Next(kwds, &pos, &key, &value)) {
7694 7695
        name = first_kw_arg;
        while (*name && (**name != key)) name++;
7696
        if (*name) {
7697
            values[name-argnames] = value;
Stefan Behnel's avatar
Stefan Behnel committed
7698
        } else {
7699 7700 7701 7702 7703 7704
            #if PY_MAJOR_VERSION < 3
            if (unlikely(!PyString_CheckExact(key)) && unlikely(!PyString_Check(key))) {
            #else
            if (unlikely(!PyUnicode_CheckExact(key)) && unlikely(!PyUnicode_Check(key))) {
            #endif
                goto invalid_keyword_type;
7705 7706
            } else {
                for (name = first_kw_arg; *name; name++) {
7707
                    #if PY_MAJOR_VERSION >= 3
Stefan Behnel's avatar
Stefan Behnel committed
7708
                    if (PyUnicode_GET_SIZE(**name) == PyUnicode_GET_SIZE(key) &&
7709
                        PyUnicode_Compare(**name, key) == 0) break;
7710
                    #else
7711
                    if (PyString_GET_SIZE(**name) == PyString_GET_SIZE(key) &&
7712
                        _PyString_Eq(**name, key)) break;
7713 7714
                    #endif
                }
7715
                if (*name) {
7716 7717 7718 7719 7720 7721 7722 7723 7724 7725
                    values[name-argnames] = value;
                } else {
                    /* unexpected keyword found */
                    for (name=argnames; name != first_kw_arg; name++) {
                        if (**name == key) goto arg_passed_twice;
                        #if PY_MAJOR_VERSION >= 3
                        if (PyUnicode_GET_SIZE(**name) == PyUnicode_GET_SIZE(key) &&
                            PyUnicode_Compare(**name, key) == 0) goto arg_passed_twice;
                        #else
                        if (PyString_GET_SIZE(**name) == PyString_GET_SIZE(key) &&
7726
                            _PyString_Eq(**name, key)) goto arg_passed_twice;
7727 7728
                        #endif
                    }
Stefan Behnel's avatar
Stefan Behnel committed
7729 7730 7731
                    if (kwds2) {
                        if (unlikely(PyDict_SetItem(kwds2, key, value))) goto bad;
                    } else {
7732
                        goto invalid_keyword;
Stefan Behnel's avatar
Stefan Behnel committed
7733 7734
                    }
                }
7735
            }
7736
        }
7737
    }
7738
    return 0;
7739
arg_passed_twice:
Stefan Behnel's avatar
Stefan Behnel committed
7740 7741
    __Pyx_RaiseDoubleKeywordsError(function_name, **name);
    goto bad;
7742 7743 7744 7745 7746
invalid_keyword_type:
    PyErr_Format(PyExc_TypeError,
        "%s() keywords must be strings", function_name);
    goto bad;
invalid_keyword:
7747
    PyErr_Format(PyExc_TypeError,
7748
    #if PY_MAJOR_VERSION < 3
7749 7750
        "%s() got an unexpected keyword argument '%s'",
        function_name, PyString_AsString(key));
7751
    #else
7752 7753
        "%s() got an unexpected keyword argument '%U'",
        function_name, key);
7754
    #endif
William Stein's avatar
William Stein committed
7755 7756 7757
bad:
    return -1;
}
7758 7759
""",
requires=[raise_double_keywords_utility_code])
William Stein's avatar
William Stein committed
7760 7761 7762

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

7763
traceback_utility_code = UtilityCode(
7764 7765 7766 7767 7768 7769 7770 7771 7772 7773
    proto = """
static void __Pyx_AddTraceback(const char *funcname, int %(CLINENO)s,
                               int %(LINENO)s, const char *%(FILENAME)s); /*proto*/
""" % {
    'FILENAME': Naming.filename_cname,
    'LINENO':  Naming.lineno_cname,
    'CLINENO':  Naming.clineno_cname,
},

    impl = """
William Stein's avatar
William Stein committed
7774 7775 7776 7777
#include "compile.h"
#include "frameobject.h"
#include "traceback.h"

7778 7779
static void __Pyx_AddTraceback(const char *funcname, int %(CLINENO)s,
                               int %(LINENO)s, const char *%(FILENAME)s) {
William Stein's avatar
William Stein committed
7780 7781 7782 7783 7784
    PyObject *py_srcfile = 0;
    PyObject *py_funcname = 0;
    PyObject *py_globals = 0;
    PyCodeObject *py_code = 0;
    PyFrameObject *py_frame = 0;
7785 7786

    #if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
7787
    py_srcfile = PyString_FromString(%(FILENAME)s);
7788 7789 7790
    #else
    py_srcfile = PyUnicode_FromString(%(FILENAME)s);
    #endif
William Stein's avatar
William Stein committed
7791
    if (!py_srcfile) goto bad;
Robert Bradshaw's avatar
Robert Bradshaw committed
7792
    if (%(CLINENO)s) {
7793
        #if PY_MAJOR_VERSION < 3
7794
        py_funcname = PyString_FromFormat( "%%s (%%s:%%d)", funcname, %(CFILENAME)s, %(CLINENO)s);
7795
        #else
7796
        py_funcname = PyUnicode_FromFormat( "%%s (%%s:%%d)", funcname, %(CFILENAME)s, %(CLINENO)s);
7797
        #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7798 7799
    }
    else {
7800
        #if PY_MAJOR_VERSION < 3
Robert Bradshaw's avatar
Robert Bradshaw committed
7801
        py_funcname = PyString_FromString(funcname);
7802 7803 7804
        #else
        py_funcname = PyUnicode_FromString(funcname);
        #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7805
    }
William Stein's avatar
William Stein committed
7806 7807 7808 7809 7810
    if (!py_funcname) goto bad;
    py_globals = PyModule_GetDict(%(GLOBALS)s);
    if (!py_globals) goto bad;
    py_code = PyCode_New(
        0,            /*int argcount,*/
7811 7812 7813
        #if PY_MAJOR_VERSION >= 3
        0,            /*int kwonlyargcount,*/
        #endif
William Stein's avatar
William Stein committed
7814 7815 7816
        0,            /*int nlocals,*/
        0,            /*int stacksize,*/
        0,            /*int flags,*/
Robert Bradshaw's avatar
Robert Bradshaw committed
7817
        %(EMPTY_BYTES)s, /*PyObject *code,*/
Stefan Behnel's avatar
Stefan Behnel committed
7818 7819 7820 7821 7822
        %(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
7823 7824 7825
        py_srcfile,   /*PyObject *filename,*/
        py_funcname,  /*PyObject *name,*/
        %(LINENO)s,   /*int firstlineno,*/
Robert Bradshaw's avatar
Robert Bradshaw committed
7826
        %(EMPTY_BYTES)s  /*PyObject *lnotab*/
William Stein's avatar
William Stein committed
7827 7828 7829
    );
    if (!py_code) goto bad;
    py_frame = PyFrame_New(
7830
        PyThreadState_GET(), /*PyThreadState *tstate,*/
William Stein's avatar
William Stein committed
7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846
        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(py_code);
    Py_XDECREF(py_frame);
}
""" % {
    'FILENAME': Naming.filename_cname,
    'LINENO':  Naming.lineno_cname,
Robert Bradshaw's avatar
Robert Bradshaw committed
7847 7848
    'CFILENAME': Naming.cfilenm_cname,
    'CLINENO':  Naming.clineno_cname,
Stefan Behnel's avatar
Stefan Behnel committed
7849 7850
    'GLOBALS': Naming.module_cname,
    'EMPTY_TUPLE' : Naming.empty_tuple,
Robert Bradshaw's avatar
Robert Bradshaw committed
7851
    'EMPTY_BYTES' : Naming.empty_bytes,
7852
})
William Stein's avatar
William Stein committed
7853

7854 7855 7856 7857
#------------------------------------------------------------------------------------

unraisable_exception_utility_code = UtilityCode(
proto = """
7858 7859
static void __Pyx_WriteUnraisable(const char *name, int clineno,
                                  int lineno, const char *filename); /*proto*/
7860 7861
""",
impl = """
7862 7863
static void __Pyx_WriteUnraisable(const char *name, int clineno,
                                  int lineno, const char *filename) {
7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881
    PyObject *old_exc, *old_val, *old_tb;
    PyObject *ctx;
    __Pyx_ErrFetch(&old_exc, &old_val, &old_tb);
    #if PY_MAJOR_VERSION < 3
    ctx = PyString_FromString(name);
    #else
    ctx = PyUnicode_FromString(name);
    #endif
    __Pyx_ErrRestore(old_exc, old_val, old_tb);
    if (!ctx) {
        PyErr_WriteUnraisable(Py_None);
    } else {
        PyErr_WriteUnraisable(ctx);
        Py_DECREF(ctx);
    }
}
""",
requires=[restore_exception_utility_code])
7882

William Stein's avatar
William Stein committed
7883 7884
#------------------------------------------------------------------------------------

7885 7886
set_vtable_utility_code = UtilityCode(
proto = """
7887
static int __Pyx_SetVtable(PyObject *dict, void *vtable); /*proto*/
7888 7889
""",
impl = """
William Stein's avatar
William Stein committed
7890
static int __Pyx_SetVtable(PyObject *dict, void *vtable) {
7891
#if PY_VERSION_HEX >= 0x02070000 && !(PY_MAJOR_VERSION==3&&PY_MINOR_VERSION==0)
7892
    PyObject *ob = PyCapsule_New(vtable, 0, 0);
7893 7894
#else
    PyObject *ob = PyCObject_FromVoidPtr(vtable, 0);
7895 7896
#endif
    if (!ob)
William Stein's avatar
William Stein committed
7897
        goto bad;
7898
    if (PyDict_SetItemString(dict, "__pyx_vtable__", ob) < 0)
William Stein's avatar
William Stein committed
7899
        goto bad;
7900 7901
    Py_DECREF(ob);
    return 0;
William Stein's avatar
William Stein committed
7902
bad:
7903 7904
    Py_XDECREF(ob);
    return -1;
William Stein's avatar
William Stein committed
7905
}
7906
""")
William Stein's avatar
William Stein committed
7907 7908 7909

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

7910 7911
get_vtable_utility_code = UtilityCode(
proto = """
7912
static void* __Pyx_GetVtable(PyObject *dict); /*proto*/
7913 7914
""",
impl = r"""
7915 7916
static void* __Pyx_GetVtable(PyObject *dict) {
    void* ptr;
7917 7918
    PyObject *ob = PyMapping_GetItemString(dict, (char *)"__pyx_vtable__");
    if (!ob)
William Stein's avatar
William Stein committed
7919
        goto bad;
7920
#if PY_VERSION_HEX >= 0x02070000 && !(PY_MAJOR_VERSION==3&&PY_MINOR_VERSION==0)
7921
    ptr = PyCapsule_GetPointer(ob, 0);
7922
#else
7923
    ptr = PyCObject_AsVoidPtr(ob);
7924
#endif
7925 7926
    if (!ptr && !PyErr_Occurred())
        PyErr_SetString(PyExc_RuntimeError, "invalid vtable found for imported type");
7927
    Py_DECREF(ob);
7928
    return ptr;
William Stein's avatar
William Stein committed
7929
bad:
7930
    Py_XDECREF(ob);
7931
    return NULL;
William Stein's avatar
William Stein committed
7932
}
7933
""")
William Stein's avatar
William Stein committed
7934 7935 7936

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

7937 7938
init_string_tab_utility_code = UtilityCode(
proto = """
7939
static int __Pyx_InitStrings(__Pyx_StringTabEntry *t); /*proto*/
7940 7941
""",
impl = """
William Stein's avatar
William Stein committed
7942 7943
static int __Pyx_InitStrings(__Pyx_StringTabEntry *t) {
    while (t->p) {
7944
        #if PY_MAJOR_VERSION < 3
7945
        if (t->is_unicode) {
7946
            *t->p = PyUnicode_DecodeUTF8(t->s, t->n - 1, NULL);
7947 7948
        } else if (t->intern) {
            *t->p = PyString_InternFromString(t->s);
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7949 7950
        } else {
            *t->p = PyString_FromStringAndSize(t->s, t->n - 1);
Stefan Behnel's avatar
Stefan Behnel committed
7951
        }
7952
        #else  /* Python 3+ has unicode identifiers */
7953 7954 7955 7956 7957 7958 7959 7960
        if (t->is_unicode | t->is_str) {
            if (t->intern) {
                *t->p = PyUnicode_InternFromString(t->s);
            } else if (t->encoding) {
                *t->p = PyUnicode_Decode(t->s, t->n - 1, t->encoding, NULL);
            } else {
                *t->p = PyUnicode_FromStringAndSize(t->s, t->n - 1);
            }
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7961 7962
        } else {
            *t->p = PyBytes_FromStringAndSize(t->s, t->n - 1);
Stefan Behnel's avatar
Stefan Behnel committed
7963
        }
7964
        #endif
William Stein's avatar
William Stein committed
7965 7966 7967 7968 7969 7970
        if (!*t->p)
            return -1;
        ++t;
    }
    return 0;
}
7971
""")
William Stein's avatar
William Stein committed
7972 7973

#------------------------------------------------------------------------------------
7974

Stefan Behnel's avatar
Stefan Behnel committed
7975
force_init_threads_utility_code = UtilityCode(
7976 7977
proto="""
#ifndef __PYX_FORCE_INIT_THREADS
Robert Bradshaw's avatar
Robert Bradshaw committed
7978
  #define __PYX_FORCE_INIT_THREADS 0
7979 7980 7981
#endif
""")

7982 7983 7984 7985
init_threads = UtilityCode(
    init="PyEval_InitThreads();\n",
)

7986
#------------------------------------------------------------------------------------
Robert Bradshaw's avatar
Robert Bradshaw committed
7987

7988 7989
# Note that cPython ignores PyTrace_EXCEPTION,
# but maybe some other profilers don't.
Robert Bradshaw's avatar
Robert Bradshaw committed
7990

7991 7992
profile_utility_code = UtilityCode(proto="""
#ifndef CYTHON_PROFILE
7993
  #define CYTHON_PROFILE 1
7994 7995
#endif

7996
#ifndef CYTHON_PROFILE_REUSE_FRAME
7997
  #define CYTHON_PROFILE_REUSE_FRAME 0
7998
#endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7999

8000
#if CYTHON_PROFILE
Robert Bradshaw's avatar
Robert Bradshaw committed
8001

8002 8003 8004
  #include "compile.h"
  #include "frameobject.h"
  #include "traceback.h"
8005

8006 8007 8008 8009 8010 8011 8012
  #if CYTHON_PROFILE_REUSE_FRAME
    #define CYTHON_FRAME_MODIFIER static
    #define CYTHON_FRAME_DEL
  #else
    #define CYTHON_FRAME_MODIFIER
    #define CYTHON_FRAME_DEL Py_DECREF(%(FRAME)s)
  #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
8013

8014 8015 8016
  #define __Pyx_TraceDeclarations                                  \\
  static PyCodeObject *%(FRAME_CODE)s = NULL;                      \\
  CYTHON_FRAME_MODIFIER PyFrameObject *%(FRAME)s = NULL;           \\
8017
  int __Pyx_use_tracing = 0;
8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042

  #define __Pyx_TraceCall(funcname, srcfile, firstlineno)                            \\
  if (unlikely(PyThreadState_GET()->use_tracing && PyThreadState_GET()->c_profilefunc)) {      \\
      __Pyx_use_tracing = __Pyx_TraceSetupAndCall(&%(FRAME_CODE)s, &%(FRAME)s, funcname, srcfile, firstlineno);  \\
  }

  #define __Pyx_TraceException()                                                           \\
  if (unlikely(__Pyx_use_tracing( && PyThreadState_GET()->use_tracing && PyThreadState_GET()->c_profilefunc) {  \\
      PyObject *exc_info = __Pyx_GetExceptionTuple();                                      \\
      if (exc_info) {                                                                      \\
          PyThreadState_GET()->c_profilefunc(                                              \\
              PyThreadState_GET()->c_profileobj, %(FRAME)s, PyTrace_EXCEPTION, exc_info);  \\
          Py_DECREF(exc_info);                                                             \\
      }                                                                                    \\
  }

  #define __Pyx_TraceReturn(result)                                                  \\
  if (unlikely(__Pyx_use_tracing) && PyThreadState_GET()->use_tracing && PyThreadState_GET()->c_profilefunc) {  \\
      PyThreadState_GET()->c_profilefunc(                                            \\
          PyThreadState_GET()->c_profileobj, %(FRAME)s, PyTrace_RETURN, (PyObject*)result);     \\
      CYTHON_FRAME_DEL;                                                               \\
  }

  static PyCodeObject *__Pyx_createFrameCodeObject(const char *funcname, const char *srcfile, int firstlineno); /*proto*/
  static int __Pyx_TraceSetupAndCall(PyCodeObject** code, PyFrameObject** frame, const char *funcname, const char *srcfile, int firstlineno); /*proto*/
Robert Bradshaw's avatar
Robert Bradshaw committed
8043

8044
#else
Robert Bradshaw's avatar
Robert Bradshaw committed
8045

8046
  #define __Pyx_TraceDeclarations
8047 8048 8049
  #define __Pyx_TraceCall(funcname, srcfile, firstlineno)
  #define __Pyx_TraceException()
  #define __Pyx_TraceReturn(result)
Robert Bradshaw's avatar
Robert Bradshaw committed
8050

8051
#endif /* CYTHON_PROFILE */
8052
"""
Robert Bradshaw's avatar
Robert Bradshaw committed
8053 8054 8055 8056 8057 8058
% {
    "FRAME": Naming.frame_cname,
    "FRAME_CODE": Naming.frame_code_cname,
},
impl = """

8059
#if CYTHON_PROFILE
Robert Bradshaw's avatar
Robert Bradshaw committed
8060 8061 8062 8063 8064 8065

static int __Pyx_TraceSetupAndCall(PyCodeObject** code,
                                   PyFrameObject** frame,
                                   const char *funcname,
                                   const char *srcfile,
                                   int firstlineno) {
8066
    if (*frame == NULL || !CYTHON_PROFILE_REUSE_FRAME) {
Robert Bradshaw's avatar
Robert Bradshaw committed
8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118
        if (*code == NULL) {
            *code = __Pyx_createFrameCodeObject(funcname, srcfile, firstlineno);
            if (*code == NULL) return 0;
        }
        *frame = PyFrame_New(
            PyThreadState_GET(),            /*PyThreadState *tstate*/
            *code,                          /*PyCodeObject *code*/
            PyModule_GetDict(%(MODULE)s),      /*PyObject *globals*/
            0                               /*PyObject *locals*/
        );
        if (*frame == NULL) return 0;
    }
    else {
        (*frame)->f_tstate = PyThreadState_GET();
    }
    return PyThreadState_GET()->c_profilefunc(PyThreadState_GET()->c_profileobj, *frame, PyTrace_CALL, NULL) == 0;
}

static PyCodeObject *__Pyx_createFrameCodeObject(const char *funcname, const char *srcfile, int firstlineno) {
    PyObject *py_srcfile = 0;
    PyObject *py_funcname = 0;
    PyCodeObject *py_code = 0;

    #if PY_MAJOR_VERSION < 3
    py_funcname = PyString_FromString(funcname);
    py_srcfile = PyString_FromString(srcfile);
    #else
    py_funcname = PyUnicode_FromString(funcname);
    py_srcfile = PyUnicode_FromString(srcfile);
    #endif
    if (!py_funcname | !py_srcfile) goto bad;

    py_code = PyCode_New(
        0,                /*int argcount,*/
        #if PY_MAJOR_VERSION >= 3
        0,                /*int kwonlyargcount,*/
        #endif
        0,                /*int nlocals,*/
        0,                /*int stacksize,*/
        0,                /*int flags,*/
        %(EMPTY_BYTES)s,  /*PyObject *code,*/
        %(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,*/
        py_srcfile,       /*PyObject *filename,*/
        py_funcname,      /*PyObject *name,*/
        firstlineno,      /*int firstlineno,*/
        %(EMPTY_BYTES)s   /*PyObject *lnotab*/
    );

8119
bad:
Robert Bradshaw's avatar
Robert Bradshaw committed
8120 8121
    Py_XDECREF(py_srcfile);
    Py_XDECREF(py_funcname);
8122

Robert Bradshaw's avatar
Robert Bradshaw committed
8123 8124 8125
    return py_code;
}

8126
#endif /* CYTHON_PROFILE */
Robert Bradshaw's avatar
Robert Bradshaw committed
8127 8128 8129 8130 8131
""" % {
    'EMPTY_TUPLE' : Naming.empty_tuple,
    'EMPTY_BYTES' : Naming.empty_bytes,
    "MODULE": Naming.module_cname,
})
8132 8133 8134

################ Utility code for cython.parallel stuff ################

8135 8136 8137
invalid_values_utility_code = UtilityCode(
proto="""\
#include <string.h>
8138

8139
void __pyx_init_nan(void);
8140

8141 8142 8143 8144 8145 8146
static float %(PYX_NAN)s;
"""  % vars(Naming),

init="""
/* Initialize NaN. The sign is irrelevant, an exponent with all bits 1 and
   a nonzero mantissa means NaN. If the first bit in the mantissa is 1, it is
8147
   a quiet NaN. */
8148 8149
    memset(&%(PYX_NAN)s, 0xFF, sizeof(%(PYX_NAN)s));
""" % vars(Naming))
8150