Nodes.py 309 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, CompileError
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

807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
class MemoryViewTypeNode(CBaseTypeNode):

    child_attrs = ['base_type_node', 'axes']

    def analyse(self, env, could_be_name = False):

        base_type = self.base_type_node.analyse(env)
        if base_type.is_error: return base_type

        import MemoryView

        try:
            axes_specs = MemoryView.get_axes_specs(env, self.axes)
        except CompileError, e:
            error(e.position, e.message_only)
            self.type = PyrexTypes.ErrorType()
            return self.type

825 826
        self.type = PyrexTypes.MemoryViewType(base_type, axes_specs, env)
        MemoryView.use_memview_util_code(env)
827
        return self.type
828

Robert Bradshaw's avatar
Robert Bradshaw committed
829
class CNestedBaseTypeNode(CBaseTypeNode):
830
    # For C++ classes that live inside other C++ classes.
Robert Bradshaw's avatar
Robert Bradshaw committed
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847

    # 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

848

Danilo Freitas's avatar
Danilo Freitas committed
849
class TemplatedTypeNode(CBaseTypeNode):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
850
    #  After parsing:
851 852
    #  positional_args  [ExprNode]        List of positional arguments
    #  keyword_args     DictNode          Keyword arguments
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
853 854 855
    #  base_type_node   CBaseTypeNode

    #  After analysis:
856
    #  type             PyrexTypes.BufferType or PyrexTypes.CppClassType  ...containing the right options
857

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
858

859 860
    child_attrs = ["base_type_node", "positional_args",
                   "keyword_args", "dtype_node"]
861

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
862
    dtype_node = None
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
863 864

    name = None
865

866 867 868
    def analyse(self, env, could_be_name = False, base_type = None):
        if base_type is None:
            base_type = self.base_type_node.analyse(env)
869
        if base_type.is_error: return base_type
870

871
        if base_type.is_cpp_class:
872
            # Templated class
873
            if self.keyword_args and self.keyword_args.key_value_pairs:
874 875 876 877 878
                error(self.pos, "c++ templates cannot take keyword arguments");
                self.type = PyrexTypes.error_type
            else:
                template_types = []
                for template_node in self.positional_args:
879 880 881 882 883
                    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)
884
                self.type = base_type.specialize_here(self.pos, template_types)
885

886 887
        elif base_type.is_pyobject:
            # Buffer
888
            import Buffer
889

890 891 892 893 894 895
            options = Buffer.analyse_buffer_options(
                self.pos,
                env,
                self.positional_args,
                self.keyword_args,
                base_type.buffer_defaults)
896

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

902
            self.type = PyrexTypes.BufferType(base_type, **options)
903

904 905
        else:
            # Array
906
            empty_declarator = CNameDeclaratorNode(self.pos, name="", cname=None)
907 908 909 910
            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:
911
                # It would be nice to merge this class with CArrayDeclaratorNode,
912 913 914 915 916
                # but arrays are part of the declaration, not the type...
                if not self.positional_args:
                    dimension = None
                else:
                    dimension = self.positional_args[0]
917 918
                self.array_declarator = CArrayDeclaratorNode(self.pos,
                    base = empty_declarator,
919 920
                    dimension = dimension)
                self.type = self.array_declarator.analyse(base_type, env)[1]
921

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
922
        return self.type
William Stein's avatar
William Stein committed
923 924 925 926

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

928 929
    child_attrs = ["base_type", "declarator"]

930 931
    def analyse(self, env, could_be_name = False):
        base = self.base_type.analyse(env, could_be_name)
William Stein's avatar
William Stein committed
932 933 934 935 936 937 938 939 940 941
        _, 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]
942
    #  in_pxd        boolean
Stefan Behnel's avatar
Stefan Behnel committed
943
    #  api           boolean
944

945
    #  decorators    [cython.locals(...)] or None
946
    #  directive_locals { string : NameNode } locals defined by cython.locals(...)
947 948

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

Robert Bradshaw's avatar
Robert Bradshaw committed
950
    decorators = None
951
    directive_locals = None
952

William Stein's avatar
William Stein committed
953
    def analyse_declarations(self, env, dest_scope = None):
954 955
        if self.directive_locals is None:
            self.directive_locals = {}
William Stein's avatar
William Stein committed
956 957
        if not dest_scope:
            dest_scope = env
958
        self.dest_scope = dest_scope
William Stein's avatar
William Stein committed
959
        base_type = self.base_type.analyse(env)
960
        visibility = self.visibility
961

William Stein's avatar
William Stein committed
962
        for declarator in self.declarators:
963 964 965 966
            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
967
            if not type.is_complete():
Kurt Smith's avatar
Kurt Smith committed
968
                if not (self.visibility == 'extern' and type.is_array or type.is_memoryview):
William Stein's avatar
William Stein committed
969 970 971 972 973 974 975
                    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
976 977 978
            if name == '':
                error(declarator.pos, "Missing name in declaration.")
                return
William Stein's avatar
William Stein committed
979
            if type.is_cfunction:
980
                entry = dest_scope.declare_cfunction(name, type, declarator.pos,
981 982
                    cname = cname, visibility = self.visibility,
                    in_pxd = self.in_pxd, api = self.api)
Robert Bradshaw's avatar
Robert Bradshaw committed
983
                if entry is not None:
984
                    entry.directive_locals = copy.copy(self.directive_locals)
William Stein's avatar
William Stein committed
985
            else:
986
                if self.directive_locals:
987
                    error(self.pos, "Decorators can only be followed by functions")
988
                entry = dest_scope.declare_var(name, type, declarator.pos,
989 990
                    cname = cname, visibility = visibility,
                    in_pxd = self.in_pxd, api = self.api, is_cdef = 1)
991

William Stein's avatar
William Stein committed
992 993 994 995 996 997

class CStructOrUnionDefNode(StatNode):
    #  name          string
    #  cname         string or None
    #  kind          "struct" or "union"
    #  typedef_flag  boolean
998
    #  visibility    "public" or "private"
999
    #  api           boolean
Stefan Behnel's avatar
Stefan Behnel committed
1000
    #  in_pxd        boolean
William Stein's avatar
William Stein committed
1001 1002
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
1003
    #  packed        boolean
1004

1005
    child_attrs = ["attributes"]
Vitja Makarov's avatar
Vitja Makarov committed
1006

1007 1008
    def declare(self, env, scope=None):
        if self.visibility == 'extern' and self.packed and not scope:
1009
            error(self.pos, "Cannot declare extern struct as 'packed'")
William Stein's avatar
William Stein committed
1010 1011
        self.entry = env.declare_struct_or_union(
            self.name, self.kind, scope, self.typedef_flag, self.pos,
1012 1013
            self.cname, visibility = self.visibility, api = self.api,
            packed = self.packed)
1014 1015 1016 1017 1018 1019

    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
1020
        if self.attributes is not None:
Stefan Behnel's avatar
Stefan Behnel committed
1021 1022
            if self.in_pxd and not env.in_cinclude:
                self.entry.defined_in_pxd = 1
William Stein's avatar
William Stein committed
1023 1024
            for attr in self.attributes:
                attr.analyse_declarations(env, scope)
1025 1026 1027 1028
            if self.visibility != 'extern':
                for attr in scope.var_entries:
                    type = attr.type
                    while type.is_array:
1029 1030
                        type = type.base_type
                    if type == self.entry.type:
1031
                        error(attr.pos, "Struct cannot contain itself as a member.")
1032

William Stein's avatar
William Stein committed
1033 1034
    def analyse_expressions(self, env):
        pass
1035

William Stein's avatar
William Stein committed
1036 1037 1038 1039
    def generate_execution_code(self, code):
        pass


Robert Bradshaw's avatar
Robert Bradshaw committed
1040 1041 1042 1043
class CppClassNode(CStructOrUnionDefNode):

    #  name          string
    #  cname         string or None
1044
    #  visibility    "extern"
Robert Bradshaw's avatar
Robert Bradshaw committed
1045 1046 1047
    #  in_pxd        boolean
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
DaniloFreitas's avatar
DaniloFreitas committed
1048
    #  base_classes  [string]
Danilo Freitas's avatar
Danilo Freitas committed
1049
    #  templates     [string] or None
Robert Bradshaw's avatar
Robert Bradshaw committed
1050

1051 1052 1053 1054 1055 1056 1057 1058 1059
    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
1060 1061
    def analyse_declarations(self, env):
        scope = None
1062
        if self.attributes is not None:
Robert Bradshaw's avatar
Robert Bradshaw committed
1063
            scope = CppClassScope(self.name, env)
1064 1065 1066 1067 1068 1069 1070 1071 1072
        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)
1073 1074 1075 1076
        if self.templates is None:
            template_types = None
        else:
            template_types = [PyrexTypes.TemplatePlaceholderType(template_name) for template_name in self.templates]
1077
        self.entry = env.declare_cpp_class(
1078
            self.name, scope, self.pos,
1079
            self.cname, base_class_types, visibility = self.visibility, templates = template_types)
1080 1081
        if self.entry is None:
            return
Danilo Freitas's avatar
Danilo Freitas committed
1082
        self.entry.is_cpp_class = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
1083 1084 1085 1086
        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
1087
                attr.analyse_declarations(scope)
Robert Bradshaw's avatar
Robert Bradshaw committed
1088

William Stein's avatar
William Stein committed
1089 1090 1091 1092 1093
class CEnumDefNode(StatNode):
    #  name           string or None
    #  cname          string or None
    #  items          [CEnumDefItemNode]
    #  typedef_flag   boolean
Stefan Behnel's avatar
Stefan Behnel committed
1094
    #  visibility     "public" or "private"
1095
    #  api            boolean
Stefan Behnel's avatar
Stefan Behnel committed
1096
    #  in_pxd         boolean
William Stein's avatar
William Stein committed
1097
    #  entry          Entry
Robert Bradshaw's avatar
Robert Bradshaw committed
1098

1099
    child_attrs = ["items"]
1100

1101 1102 1103 1104 1105
    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
1106
    def analyse_declarations(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
1107 1108 1109 1110 1111
        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
1112

1113 1114 1115
    def analyse_expressions(self, env):
        pass

William Stein's avatar
William Stein committed
1116
    def generate_execution_code(self, code):
1117
        if self.visibility == 'public' or self.api:
1118
            temp = code.funcstate.allocate_temp(PyrexTypes.py_object_type, manage_ref=True)
Robert Bradshaw's avatar
Robert Bradshaw committed
1119 1120
            for item in self.entry.enum_values:
                code.putln("%s = PyInt_FromLong(%s); %s" % (
1121
                        temp,
Robert Bradshaw's avatar
Robert Bradshaw committed
1122
                        item.cname,
1123
                        code.error_goto_if_null(temp, item.pos)))
Stefan Behnel's avatar
merge  
Stefan Behnel committed
1124
                code.put_gotref(temp)
1125
                code.putln('if (__Pyx_SetAttrString(%s, "%s", %s) < 0) %s' % (
1126 1127
                        Naming.module_cname,
                        item.name,
1128
                        temp,
Robert Bradshaw's avatar
Robert Bradshaw committed
1129
                        code.error_goto(item.pos)))
Stefan Behnel's avatar
merge  
Stefan Behnel committed
1130
                code.put_decref_clear(temp, PyrexTypes.py_object_type)
1131
            code.funcstate.release_temp(temp)
William Stein's avatar
William Stein committed
1132 1133 1134 1135 1136 1137


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

1139 1140
    child_attrs = ["value"]

William Stein's avatar
William Stein committed
1141 1142 1143
    def analyse_declarations(self, env, enum_entry):
        if self.value:
            self.value.analyse_const_expression(env)
1144 1145 1146
            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
1147
        entry = env.declare_const(self.name, enum_entry.type,
1148
            self.value, self.pos, cname = self.cname,
1149
            visibility = enum_entry.visibility, api = enum_entry.api)
William Stein's avatar
William Stein committed
1150 1151 1152 1153
        enum_entry.enum_values.append(entry)


class CTypeDefNode(StatNode):
Stefan Behnel's avatar
Stefan Behnel committed
1154 1155 1156
    #  base_type    CBaseTypeNode
    #  declarator   CDeclaratorNode
    #  visibility   "public" or "private"
1157
    #  api          boolean
Stefan Behnel's avatar
Stefan Behnel committed
1158
    #  in_pxd       boolean
1159 1160

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

William Stein's avatar
William Stein committed
1162 1163 1164 1165 1166
    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
1167
        entry = env.declare_typedef(name, type, self.pos,
1168
            cname = cname, visibility = self.visibility, api = self.api)
Stefan Behnel's avatar
Stefan Behnel committed
1169 1170
        if self.in_pxd and not env.in_cinclude:
            entry.defined_in_pxd = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
1171

William Stein's avatar
William Stein committed
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
    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
1184
    #  needs_closure   boolean        Whether or not this function has inner functions/classes/yield
Vitja Makarov's avatar
Vitja Makarov committed
1185
    #  needs_outer_scope boolean      Whether or not this function requires outer scope
1186
    #  pymethdef_required boolean     Force Python method struct generation
1187
    #  directive_locals { string : NameNode } locals defined by cython.locals(...)
1188 1189
    # star_arg      PyArgDeclNode or None  * argument
    # starstar_arg  PyArgDeclNode or None  ** argument
1190

1191
    py_func = None
1192
    assmt = None
1193
    needs_closure = False
Vitja Makarov's avatar
Vitja Makarov committed
1194
    needs_outer_scope = False
1195
    pymethdef_required = False
1196
    is_generator = False
1197
    is_generator_body = False
Robert Bradshaw's avatar
Robert Bradshaw committed
1198
    modifiers = []
1199 1200
    star_arg = None
    starstar_arg = None
1201

1202 1203
    def analyse_default_values(self, env):
        genv = env.global_scope()
1204
        default_seen = 0
1205 1206
        for arg in self.args:
            if arg.default:
1207
                default_seen = 1
1208
                if arg.is_generic:
1209 1210
                    arg.default.analyse_types(env)
                    arg.default = arg.default.coerce_to(arg.type, genv)
1211 1212 1213 1214
                else:
                    error(arg.pos,
                        "This argument cannot have a default value")
                    arg.default = None
1215 1216 1217 1218
            elif arg.kw_only:
                default_seen = 1
            elif default_seen:
                error(arg.pos, "Non-default argument following default argument")
1219

1220 1221 1222 1223 1224 1225 1226 1227
    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
1228
            elif (type is not PyrexTypes.py_object_type
1229 1230 1231 1232 1233 1234 1235
                    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

1236 1237
    def need_gil_acquisition(self, lenv):
        return 0
1238

1239 1240
    def create_local_scope(self, env):
        genv = env
1241
        while genv.is_py_class_scope or genv.is_c_class_scope:
1242
            genv = genv.outer_scope
1243
        if self.needs_closure:
1244 1245
            lenv = ClosureScope(name=self.entry.name,
                                outer_scope = genv,
1246
                                parent_scope = env,
1247
                                scope_name=self.entry.cname)
1248
        else:
1249 1250 1251
            lenv = LocalScope(name=self.entry.name,
                              outer_scope=genv,
                              parent_scope=env)
William Stein's avatar
William Stein committed
1252
        lenv.return_type = self.return_type
1253 1254 1255
        type = self.entry.type
        if type.is_cfunction:
            lenv.nogil = type.nogil and not type.with_gil
1256
        self.local_scope = lenv
1257
        lenv.directives = env.directives
1258
        return lenv
1259

1260 1261 1262
    def generate_function_body(self, env, code):
        self.body.generate_execution_code(code)

1263
    def generate_function_definitions(self, env, code):
1264
        import Buffer
1265 1266

        lenv = self.local_scope
Vitja Makarov's avatar
Vitja Makarov committed
1267
        if lenv.is_closure_scope and not lenv.is_passthrough:
1268 1269 1270 1271 1272
            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
1273 1274
        # Generate closure function definitions
        self.body.generate_function_definitions(lenv, code)
Stefan Behnel's avatar
Stefan Behnel committed
1275
        # generate lambda function definitions
1276
        self.generate_lambda_definitions(lenv, code)
1277

1278 1279
        is_getbuffer_slot = (self.entry.name == "__getbuffer__" and
                             self.entry.scope.is_c_class_scope)
1280 1281 1282
        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
1283
        if is_buffer_slot:
1284 1285
            if 'cython_unused' not in self.modifiers:
                self.modifiers = self.modifiers + ['cython_unused']
1286 1287 1288 1289 1290 1291 1292 1293 1294

        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
1295

1296
        profile = code.globalstate.directives['profile']
1297 1298 1299
        if profile and lenv.nogil:
            warning(self.pos, "Cannot profile nogil function.", 1)
            profile = False
Robert Bradshaw's avatar
Robert Bradshaw committed
1300
        if profile:
1301
            code.globalstate.use_utility_code(profile_utility_code)
1302

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

William Stein's avatar
William Stein committed
1307
        # ----- Top-level constants used by this function
1308
        code.mark_pos(self.pos)
1309
        self.generate_cached_builtins_decls(lenv, code)
William Stein's avatar
William Stein committed
1310 1311
        # ----- Function header
        code.putln("")
1312 1313 1314 1315

        if preprocessor_guard:
            code.putln(preprocessor_guard)

1316 1317
        with_pymethdef = (self.needs_assignment_synthesis(env, code) or
                          self.pymethdef_required)
1318
        if self.py_func:
1319
            self.py_func.generate_function_header(code,
Stefan Behnel's avatar
Stefan Behnel committed
1320
                with_pymethdef = with_pymethdef,
1321
                proto_only=True)
William Stein's avatar
William Stein committed
1322
        self.generate_function_header(code,
Stefan Behnel's avatar
Stefan Behnel committed
1323
            with_pymethdef = with_pymethdef)
William Stein's avatar
William Stein committed
1324
        # ----- Local variable declarations
1325 1326 1327 1328
        # 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
1329
        if self.needs_closure:
1330
            code.put(lenv.scope_class.type.declaration_code(Naming.cur_scope_cname))
Robert Bradshaw's avatar
Robert Bradshaw committed
1331
            code.putln(";")
Vitja Makarov's avatar
Vitja Makarov committed
1332 1333 1334 1335
        elif self.needs_outer_scope:
            if lenv.is_passthrough:
                code.put(lenv.scope_class.type.declaration_code(Naming.cur_scope_cname))
                code.putln(";")
1336
            code.put(cenv.scope_class.type.declaration_code(Naming.outer_scope_cname))
1337
            code.putln(";")
William Stein's avatar
William Stein committed
1338
        self.generate_argument_declarations(lenv, code)
1339

1340 1341 1342
        for entry in lenv.var_entries:
            if not entry.in_closure:
                code.put_var_declaration(entry)
1343

William Stein's avatar
William Stein committed
1344 1345
        init = ""
        if not self.return_type.is_void:
1346 1347
            if self.return_type.is_pyobject:
                init = " = NULL"
William Stein's avatar
William Stein committed
1348
            code.putln(
1349
                "%s%s;" %
1350 1351
                    (self.return_type.declaration_code(Naming.retval_cname),
                     init))
1352
        tempvardecl_code = code.insertion_point()
William Stein's avatar
William Stein committed
1353
        self.generate_keyword_list(code)
1354

1355 1356
        if profile:
            code.put_trace_declarations()
1357

William Stein's avatar
William Stein committed
1358 1359
        # ----- Extern library function declarations
        lenv.generate_library_function_declarations(code)
1360

1361
        # ----- GIL acquisition
1362
        acquire_gil = self.acquire_gil
1363 1364 1365 1366

        # 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)
1367 1368 1369 1370 1371 1372

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

1373
        # ----- set up refnanny
1374
        if use_refnanny:
1375
            tempvardecl_code.put_declare_refcount_context()
1376
            code.put_setup_refcount_context(self.entry.name)
1377

1378
        # ----- Automatic lead-ins for certain special functions
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1379 1380
        if is_getbuffer_slot:
            self.getbuffer_init(code)
1381
        # ----- Create closure scope object
Robert Bradshaw's avatar
Robert Bradshaw committed
1382
        if self.needs_closure:
1383
            code.putln("%s = (%s)%s->tp_new(%s, %s, NULL);" % (
1384 1385
                Naming.cur_scope_cname,
                lenv.scope_class.type.declaration_code(''),
1386
                lenv.scope_class.type.typeptr_cname,
1387
                lenv.scope_class.type.typeptr_cname,
1388 1389 1390 1391
                Naming.empty_tuple))
            code.putln("if (unlikely(!%s)) {" % Naming.cur_scope_cname)
            if is_getbuffer_slot:
                self.getbuffer_error_cleanup(code)
1392 1393

            if use_refnanny:
1394
                code.put_finish_refcount_context()
1395 1396 1397
                if acquire_gil_for_var_decls_only:
                    code.put_release_ensured_gil()

1398 1399 1400
            # 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
1401
            code.put_gotref(Naming.cur_scope_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
1402
            # Note that it is unsafe to decref the scope at this point.
Vitja Makarov's avatar
Vitja Makarov committed
1403
        if self.needs_outer_scope:
1404 1405
            code.putln("%s = (%s)%s;" % (
                            outer_scope_cname,
1406
                            cenv.scope_class.type.declaration_code(''),
1407
                            Naming.self_cname))
Vitja Makarov's avatar
Vitja Makarov committed
1408 1409 1410
            if lenv.is_passthrough:
                code.putln("%s = %s;" % (Naming.cur_scope_cname, outer_scope_cname));
            elif self.needs_closure:
1411
                # inner closures own a reference to their outer parent
1412
                code.put_incref(outer_scope_cname, cenv.scope_class.type)
1413
                code.put_giveref(outer_scope_cname)
1414 1415 1416 1417 1418
        # ----- 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
1419
        # ----- Fetch arguments
1420
        self.generate_argument_parsing_code(env, code)
1421
        # If an argument is assigned to in the body, we must
Robert Bradshaw's avatar
Robert Bradshaw committed
1422 1423
        # incref it to properly keep track of refcounts.
        for entry in lenv.arg_entries:
1424
            if entry.type.is_pyobject:
1425
                if (acquire_gil or entry.assignments) and not entry.in_closure:
1426
                    code.put_var_incref(entry)
1427 1428
        # ----- Initialise local buffer auxiliary variables
        for entry in lenv.var_entries + lenv.arg_entries:
1429 1430
            if entry.type.is_buffer and entry.buffer_aux.buflocal_nd_var.used:
                Buffer.put_init_vars(entry, code)
1431
        # ----- Check and convert arguments
William Stein's avatar
William Stein committed
1432
        self.generate_argument_type_tests(code)
1433 1434 1435
        # ----- Acquire buffer arguments
        for entry in lenv.arg_entries:
            if entry.type.is_buffer:
1436 1437
                Buffer.put_acquire_arg_buffer(entry, code, self.pos)

1438 1439 1440
        if acquire_gil_for_var_decls_only:
            code.put_release_ensured_gil()

1441 1442 1443
        # -------------------------
        # ----- Function body -----
        # -------------------------
1444
        self.generate_function_body(env, code)
1445

William Stein's avatar
William Stein committed
1446 1447 1448 1449
        # ----- Default return value
        code.putln("")
        if self.return_type.is_pyobject:
            #if self.return_type.is_extension_type:
1450
            #    lhs = "(PyObject *)%s" % Naming.retval_cname
William Stein's avatar
William Stein committed
1451 1452 1453 1454 1455 1456 1457 1458
            #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
1459 1460 1461
        if code.error_label in code.labels_used:
            code.put_goto(code.return_label)
            code.put_label(code.error_label)
1462 1463
            for cname, type in code.funcstate.all_managed_temps():
                code.put_xdecref(cname, type)
1464 1465 1466 1467 1468

            # 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:
1469
                code.globalstate.use_utility_code(restore_exception_utility_code)
1470
                code.putln("{ PyObject *__pyx_type, *__pyx_value, *__pyx_tb;")
1471
                code.putln("__Pyx_ErrFetch(&__pyx_type, &__pyx_value, &__pyx_tb);")
1472
                for entry in lenv.buffer_entries:
1473
                    Buffer.put_release_buffer_code(code, entry)
1474
                    #code.putln("%s = 0;" % entry.cname)
1475
                code.putln("__Pyx_ErrRestore(__pyx_type, __pyx_value, __pyx_tb);}")
1476

1477 1478 1479
            err_val = self.error_value()
            exc_check = self.caller_will_check_exceptions()
            if err_val is not None or exc_check:
1480
                # TODO: Fix exception tracing (though currently unused by cProfile).
Robert Bradshaw's avatar
Robert Bradshaw committed
1481 1482
                # code.globalstate.use_utility_code(get_exception_tuple_utility_code)
                # code.put_trace_exception()
1483 1484 1485 1486 1487

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

1488
                code.put_add_traceback(self.entry.qualified_name)
1489 1490 1491 1492

                if lenv.nogil:
                    code.put_release_ensured_gil()
                    code.putln("}")
1493
            else:
1494 1495
                warning(self.entry.pos, "Unraisable exception in function '%s'." \
                            % self.entry.qualified_name, 0)
1496 1497 1498 1499 1500 1501
                format_tuple = (
                    self.entry.qualified_name,
                    Naming.clineno_cname,
                    Naming.lineno_cname,
                    Naming.filename_cname,
                    )
1502
                code.putln(
1503
                    '__Pyx_WriteUnraisable("%s", %s, %s, %s);' % format_tuple)
1504
                env.use_utility_code(unraisable_exception_utility_code)
1505
                env.use_utility_code(restore_exception_utility_code)
1506 1507 1508 1509
            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:
1510
                code.putln("%s = %s;" % (Naming.retval_cname, err_val))
1511 1512 1513 1514 1515 1516 1517 1518

            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:
1519 1520 1521
                code.put_goto(code.return_from_error_cleanup_label)

        # ----- Non-error return cleanup
William Stein's avatar
William Stein committed
1522
        code.put_label(code.return_label)
1523
        for entry in lenv.buffer_entries:
1524
            if entry.used:
1525
                Buffer.put_release_buffer_code(code, entry)
1526 1527
        if is_getbuffer_slot:
            self.getbuffer_normal_cleanup(code)
1528 1529
        # ----- Return cleanup for both error and no-error return
        code.put_label(code.return_from_error_cleanup_label)
1530

1531
        for entry in lenv.var_entries:
1532 1533 1534
            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
1535
        # Decref any increfed args
1536
        for entry in lenv.arg_entries:
1537
            if entry.type.is_pyobject:
1538
                if (acquire_gil or entry.assignments) and not entry.in_closure:
1539
                    code.put_var_decref(entry)
Robert Bradshaw's avatar
Robert Bradshaw committed
1540 1541
        if self.needs_closure:
            code.put_decref(Naming.cur_scope_cname, lenv.scope_class.type)
1542

1543
        # ----- Return
1544
        # This code is duplicated in ModuleNode.generate_module_init_func
1545 1546 1547 1548 1549 1550 1551
        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))
1552

1553 1554
        if self.entry.is_special and self.entry.name == "__hash__":
            # Returning -1 for __hash__ is supposed to signal an error
1555
            # We do as Python instances and coerce -1 into -2.
1556 1557
            code.putln("if (unlikely(%s == -1) && !PyErr_Occurred()) %s = -2;" % (
                    Naming.retval_cname, Naming.retval_cname))
1558

Robert Bradshaw's avatar
Robert Bradshaw committed
1559 1560 1561 1562 1563
        if profile:
            if self.return_type.is_pyobject:
                code.put_trace_return(Naming.retval_cname)
            else:
                code.put_trace_return("Py_None")
1564

1565
        if not lenv.nogil:
1566
            # GIL holding funcion
1567
            code.put_finish_refcount_context()
1568

1569
        if acquire_gil or acquire_gil_for_var_decls_only:
1570
            code.put_release_ensured_gil()
1571

William Stein's avatar
William Stein committed
1572
        if not self.return_type.is_void:
1573
            code.putln("return %s;" % Naming.retval_cname)
1574

William Stein's avatar
William Stein committed
1575
        code.putln("}")
1576 1577 1578 1579

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

1580
        # ----- Go back and insert temp variable declarations
1581
        tempvardecl_code.put_temp_declarations(code.funcstate)
1582
        if code.funcstate.should_declare_error_indicator:
Mark Florisson's avatar
Mark Florisson committed
1583 1584 1585 1586
            # 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)
1587
            if code.c_line_in_traceback:
Mark Florisson's avatar
Mark Florisson committed
1588
                tempvardecl_code.putln("int %s = 0;" % Naming.clineno_cname)
1589

1590
        # ----- Python version
1591
        code.exit_cfunc_scope()
1592
        if self.py_func:
1593
            self.py_func.generate_function_definitions(env, code)
1594
        self.generate_wrapper_functions(code)
William Stein's avatar
William Stein committed
1595 1596 1597 1598 1599 1600 1601 1602

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

1604 1605 1606
    def generate_arg_type_test(self, arg, code):
        # Generate type test for one argument.
        if arg.type.typeobj_is_available():
1607
            code.globalstate.use_utility_code(arg_type_test_utility_code)
1608 1609 1610 1611
            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' % (
1612
                    arg_code,
1613 1614 1615 1616 1617 1618 1619 1620
                    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")
1621 1622 1623 1624 1625 1626 1627 1628

    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('}')
1629

1630
    def generate_wrapper_functions(self, code):
William Stein's avatar
William Stein committed
1631 1632 1633
        pass

    def generate_execution_code(self, code):
1634 1635 1636 1637
        # Evaluate and store argument default values
        for arg in self.args:
            default = arg.default
            if default:
1638 1639 1640
                if not default.is_literal:
                    default.generate_evaluation_code(code)
                    default.make_owned_reference(code)
1641
                    result = default.result_as(arg.type)
1642
                    code.putln(
1643
                        "%s = %s;" % (
1644 1645 1646 1647 1648
                            arg.calculate_default_value_code(code),
                            result))
                    if arg.type.is_pyobject:
                        code.put_giveref(default.result())
                    default.generate_post_assignment_code(code)
1649
                    default.free_temps(code)
1650 1651 1652
        # 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
1653

1654
    #
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1655
    # Special code for the __getbuffer__ function
1656 1657 1658 1659 1660
    #
    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;
1661 1662
        # the following block should be removed when this bug is fixed.
        code.putln("if (%s != NULL) {" % info)
1663
        code.putln("%s->obj = Py_None; __Pyx_INCREF(Py_None);" % info)
1664
        code.put_giveref("%s->obj" % info) # Do not refnanny object within structs
1665
        code.putln("}")
1666 1667 1668

    def getbuffer_error_cleanup(self, code):
        info = self.local_scope.arg_entries[1].cname
1669 1670
        code.putln("if (%s != NULL && %s->obj != NULL) {"
                   % (info, info))
1671
        code.put_gotref("%s->obj" % info)
1672 1673 1674
        code.putln("__Pyx_DECREF(%s->obj); %s->obj = NULL;"
                   % (info, info))
        code.putln("}")
1675 1676 1677

    def getbuffer_normal_cleanup(self, code):
        info = self.local_scope.arg_entries[1].cname
1678
        code.putln("if (%s != NULL && %s->obj == Py_None) {" % (info, info))
1679 1680 1681
        code.put_gotref("Py_None")
        code.putln("__Pyx_DECREF(Py_None); %s->obj = NULL;" % info)
        code.putln("}")
William Stein's avatar
William Stein committed
1682 1683 1684 1685

class CFuncDefNode(FuncDefNode):
    #  C function definition.
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
1686
    #  modifiers     ['inline']
William Stein's avatar
William Stein committed
1687 1688 1689 1690
    #  visibility    'private' or 'public' or 'extern'
    #  base_type     CBaseTypeNode
    #  declarator    CDeclaratorNode
    #  body          StatListNode
1691
    #  api           boolean
1692
    #  decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
1693
    #
1694
    #  with_gil      boolean    Acquire GIL around body
William Stein's avatar
William Stein committed
1695
    #  type          CFuncType
1696
    #  py_func       wrapper for calling from Python
1697
    #  overridable   whether or not this is a cpdef function
1698
    #  inline_in_pxd whether this is an inline function in a pxd file
1699

1700
    child_attrs = ["base_type", "declarator", "body", "py_func"]
1701 1702

    inline_in_pxd = False
1703
    decorators = None
1704
    directive_locals = None
1705
    override = None
1706

William Stein's avatar
William Stein committed
1707 1708
    def unqualified_name(self):
        return self.entry.name
1709

William Stein's avatar
William Stein committed
1710
    def analyse_declarations(self, env):
1711 1712
        if self.directive_locals is None:
            self.directive_locals = {}
1713
        self.directive_locals.update(env.directives['locals'])
William Stein's avatar
William Stein committed
1714
        base_type = self.base_type.analyse(env)
1715
        # The 2 here is because we need both function and argument names.
1716 1717 1718 1719 1720 1721
        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))
1722
        if not type.is_cfunction:
1723
            error(self.pos,
1724
                "Suite attached to non-function declaration")
William Stein's avatar
William Stein committed
1725 1726 1727 1728 1729
        # 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
1730
        type.is_overridable = self.overridable
1731 1732 1733 1734 1735
        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):
1736
            self.align_argument_type(env, type_arg)
1737
            formal_arg.type = type_arg.type
1738
            formal_arg.name = type_arg.name
1739
            formal_arg.cname = type_arg.cname
1740 1741
            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
1742 1743 1744
        name = name_declarator.name
        cname = name_declarator.cname
        self.entry = env.declare_cfunction(
1745
            name, type, self.pos,
1746 1747
            cname = cname, visibility = self.visibility, api = self.api,
            defining = self.body is not None, modifiers = self.modifiers)
1748
        self.entry.inline_func_in_pxd = self.inline_in_pxd
William Stein's avatar
William Stein committed
1749
        self.return_type = type.return_type
1750
        if self.return_type.is_array and self.visibility != 'extern':
1751 1752
            error(self.pos,
                "Function cannot return an array")
1753

1754 1755 1756 1757
        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
1758

1759
        if self.overridable:
1760
            import ExprNodes
1761
            py_func_body = self.call_self_node(is_module_scope = env.is_module_scope)
1762
            self.py_func = DefNode(pos = self.pos,
1763 1764
                                   name = self.entry.name,
                                   args = self.args,
1765 1766
                                   star_arg = None,
                                   starstar_arg = None,
1767
                                   doc = self.doc,
1768 1769
                                   body = py_func_body,
                                   is_wrapper = 1)
1770
            self.py_func.is_module_scope = env.is_module_scope
1771
            self.py_func.analyse_declarations(env)
1772
            self.entry.as_variable = self.py_func.entry
1773 1774
            # Reset scope entry the above cfunction
            env.entries[name] = self.entry
1775 1776
            if (not self.entry.is_final_cmethod and
                (not env.is_module_scope or Options.lookup_module_cpdef)):
1777 1778
                self.override = OverrideCheckNode(self.pos, py_func = self.py_func)
                self.body = StatListNode(self.pos, stats=[self.override, self.body])
1779
        self.create_local_scope(env)
1780

1781
    def call_self_node(self, omit_optional_args=0, is_module_scope=0):
1782 1783 1784 1785 1786
        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]
1787
        if is_module_scope:
1788
            cfunc = ExprNodes.NameNode(self.pos, name=self.entry.name)
1789 1790
        else:
            self_arg = ExprNodes.NameNode(self.pos, name=arg_names[0])
1791
            cfunc = ExprNodes.AttributeNode(self.pos, obj=self_arg, attribute=self.entry.name)
1792 1793
        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)
1794
        return ReturnStatNode(pos=self.pos, return_type=PyrexTypes.py_object_type, value=c_call)
1795

William Stein's avatar
William Stein committed
1796 1797 1798 1799 1800
    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)
1801

1802
    def need_gil_acquisition(self, lenv):
1803 1804
        return self.type.with_gil

1805
    def nogil_check(self, env):
1806
        type = self.type
1807
        with_gil = type.with_gil
1808 1809 1810 1811
        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")
1812
            for entry in self.local_scope.var_entries:
1813
                if entry.type.is_pyobject and not entry.in_with_gil_block:
1814 1815
                    error(self.pos, "Function declared nogil has Python locals or temporaries")

1816
    def analyse_expressions(self, env):
1817
        self.local_scope.directives = env.directives
1818
        if self.py_func is not None:
1819
            # this will also analyse the default values
1820
            self.py_func.analyse_expressions(env)
1821 1822
        else:
            self.analyse_default_values(env)
1823
        self.acquire_gil = self.need_gil_acquisition(self.local_scope)
1824

Robert Bradshaw's avatar
Robert Bradshaw committed
1825 1826 1827
    def needs_assignment_synthesis(self, env, code=None):
        return False

1828
    def generate_function_header(self, code, with_pymethdef, with_opt_args = 1, with_dispatch = 1, cname = None):
1829
        scope = self.local_scope
William Stein's avatar
William Stein committed
1830 1831
        arg_decls = []
        type = self.type
1832
        for arg in type.args[:len(type.args)-type.optional_arg_count]:
1833 1834 1835 1836 1837
            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)
1838
        if with_dispatch and self.overridable:
1839 1840 1841 1842 1843 1844
            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)
1845 1846
        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
1847 1848 1849 1850
        if type.has_varargs:
            arg_decls.append("...")
        if not arg_decls:
            arg_decls = ["void"]
1851 1852
        if cname is None:
            cname = self.entry.func_cname
1853
        entity = type.function_header_code(cname, ', '.join(arg_decls))
1854 1855
        if self.entry.visibility == 'private':
            storage_class = "static "
William Stein's avatar
William Stein committed
1856
        else:
1857
            storage_class = ""
1858 1859
        dll_linkage = None
        modifiers = ""
1860 1861
        if 'inline' in self.modifiers:
            self.modifiers[self.modifiers.index('inline')] = 'cython_inline'
1862 1863
        if self.modifiers:
            modifiers = "%s " % ' '.join(self.modifiers).upper()
Robert Bradshaw's avatar
Robert Bradshaw committed
1864

1865 1866 1867
        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
1868 1869

    def generate_argument_declarations(self, env, code):
1870
        scope = self.local_scope
1871
        for arg in self.args:
1872
            if arg.default:
1873
                entry = scope.lookup(arg.name)
1874
                if self.override or entry.cf_used:
1875 1876 1877
                    result = arg.calculate_default_value_code(code)
                    code.putln('%s = %s;' % (
                        arg.type.declaration_code(arg.cname), result))
1878

William Stein's avatar
William Stein committed
1879 1880
    def generate_keyword_list(self, code):
        pass
1881

1882
    def generate_argument_parsing_code(self, env, code):
1883
        i = 0
1884
        used = 0
1885
        if self.type.optional_arg_count:
1886
            scope = self.local_scope
1887
            code.putln('if (%s) {' % Naming.optional_args_cname)
1888
            for arg in self.args:
1889
                if arg.default:
1890
                    entry = scope.lookup(arg.name)
1891
                    if self.override or entry.cf_used:
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
                        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
1902
                    i += 1
1903
            for _ in range(used):
1904
                code.putln('}')
1905
            code.putln('}')
1906

William Stein's avatar
William Stein committed
1907 1908
    def generate_argument_conversion_code(self, code):
        pass
1909

William Stein's avatar
William Stein committed
1910
    def generate_argument_type_tests(self, code):
1911 1912 1913 1914 1915
        # 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)
1916 1917
            elif arg.type.is_pyobject and not arg.accept_none:
                self.generate_arg_none_check(arg, code)
1918

William Stein's avatar
William Stein committed
1919 1920 1921 1922
    def error_value(self):
        if self.return_type.is_pyobject:
            return "0"
        else:
1923 1924
            #return None
            return self.entry.type.exception_value
1925

William Stein's avatar
William Stein committed
1926
    def caller_will_check_exceptions(self):
1927
        return self.entry.type.exception_check
1928

1929 1930
    def generate_wrapper_functions(self, code):
        # If the C signature of a function has changed, we need to generate
1931
        # wrappers to put in the slots here.
1932 1933 1934 1935 1936 1937 1938
        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)
1939
            code.putln()
1940
            self.generate_function_header(code,
1941
                                          0,
1942 1943
                                          with_dispatch = entry.type.is_overridable,
                                          with_opt_args = entry.type.optional_arg_count,
1944
                                          cname = entry.func_cname)
1945 1946 1947 1948
            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]]
1949 1950 1951 1952 1953 1954 1955 1956
            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')
1957 1958
            code.putln('%s(%s);' % (self.entry.func_cname, ', '.join(arglist)))
            code.putln('}')
1959

William Stein's avatar
William Stein committed
1960 1961 1962 1963 1964

class PyArgDeclNode(Node):
    # Argument which must be a Python object (used
    # for * and ** arguments).
    #
1965 1966 1967
    # name        string
    # entry       Symtab.Entry
    # annotation  ExprNode or None   Py3 argument annotation
1968
    child_attrs = []
1969 1970 1971

    def generate_function_definitions(self, env, code):
        self.entry.generate_function_definitions(env, code)
1972 1973 1974 1975

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

William Stein's avatar
William Stein committed
1979 1980 1981 1982 1983

class DefNode(FuncDefNode):
    # A Python function definition.
    #
    # name          string                 the Python name of the function
Stefan Behnel's avatar
Stefan Behnel committed
1984
    # lambda_name   string                 the internal name of a lambda 'function'
1985
    # decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
1986
    # args          [CArgDeclNode]         formal arguments
1987
    # doc           EncodedString or None
William Stein's avatar
William Stein committed
1988
    # body          StatListNode
1989 1990
    # return_type_annotation
    #               ExprNode or None       the Py3 return type annotation
William Stein's avatar
William Stein committed
1991 1992 1993 1994 1995
    #
    #  The following subnode is constructed internally
    #  when the def statement is inside a Python class definition.
    #
    #  assmt   AssignmentNode   Function construction/assignment
1996
    #  py_cfunc_node  PyCFunctionNode/InnerFunctionNode   The PyCFunction to create and assign
1997

1998
    child_attrs = ["args", "star_arg", "starstar_arg", "body", "decorators"]
1999

Stefan Behnel's avatar
Stefan Behnel committed
2000
    lambda_name = None
William Stein's avatar
William Stein committed
2001
    assmt = None
2002
    num_kwonly_args = 0
2003
    num_required_kw_args = 0
2004
    reqd_kw_flags_cname = "0"
2005
    is_wrapper = 0
2006
    no_assignment_synthesis = 0
2007
    decorators = None
2008
    return_type_annotation = None
2009
    entry = None
Robert Bradshaw's avatar
Robert Bradshaw committed
2010
    acquire_gil = 0
2011
    self_in_stararg = 0
2012
    py_cfunc_node = None
2013
    doc = None
2014

2015 2016
    def __init__(self, pos, **kwds):
        FuncDefNode.__init__(self, pos, **kwds)
2017
        k = rk = r = 0
2018 2019
        for arg in self.args:
            if arg.kw_only:
2020
                k += 1
2021
                if not arg.default:
2022 2023 2024 2025 2026 2027
                    rk += 1
            if not arg.default:
                r += 1
        self.num_kwonly_args = k
        self.num_required_kw_args = rk
        self.num_required_args = r
2028

Haoyu Bai's avatar
Haoyu Bai committed
2029
    def as_cfunction(self, cfunc=None, scope=None, overridable=True):
2030 2031 2032 2033
        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")
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048
        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
2049
                                              is_overridable = overridable)
2050
            cfunc = CVarDefNode(self.pos, type=cfunc_type)
2051
        else:
2052 2053
            if scope is None:
                scope = cfunc.scope
2054 2055 2056
            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
2057
                error(cfunc.pos, "previous declaration here")
2058 2059 2060
            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
2061
                if type is None or type is PyrexTypes.py_object_type:
2062 2063
                    formal_arg.type = type_arg.type
                    formal_arg.name_declarator = name_declarator
2064
        import ExprNodes
2065
        if cfunc_type.exception_value is None:
2066 2067
            exception_value = None
        else:
2068
            exception_value = ExprNodes.ConstNode(self.pos, value=cfunc_type.exception_value, type=cfunc_type.return_type)
2069
        declarator = CFuncDeclaratorNode(self.pos,
2070 2071 2072
                                         base = CNameDeclaratorNode(self.pos, name=self.name, cname=None),
                                         args = self.args,
                                         has_varargs = False,
2073
                                         exception_check = cfunc_type.exception_check,
2074
                                         exception_value = exception_value,
2075 2076
                                         with_gil = cfunc_type.with_gil,
                                         nogil = cfunc_type.nogil)
2077
        return CFuncDefNode(self.pos,
2078
                            modifiers = [],
2079
                            base_type = CAnalysedBaseTypeNode(self.pos, type=cfunc_type.return_type),
2080 2081 2082
                            declarator = declarator,
                            body = self.body,
                            doc = self.doc,
2083 2084 2085 2086
                            overridable = cfunc_type.is_overridable,
                            type = cfunc_type,
                            with_gil = cfunc_type.with_gil,
                            nogil = cfunc_type.nogil,
2087
                            visibility = 'private',
2088
                            api = False,
2089
                            directive_locals = getattr(cfunc, 'directive_locals', {}))
2090

2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
    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
2102
    def analyse_declarations(self, env):
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
        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

2118
        if self.name == '__new__' and env.is_py_class_scope:
Vitja Makarov's avatar
Vitja Makarov committed
2119 2120
            self.is_staticmethod = 1

2121
        self.analyse_argument_types(env)
2122 2123 2124 2125
        if self.name == '<lambda>':
            self.declare_lambda_function(env)
        else:
            self.declare_pyfunction(env)
2126 2127 2128 2129 2130
        self.analyse_signature(env)
        self.return_type = self.entry.signature.return_type()
        self.create_local_scope(env)

    def analyse_argument_types(self, env):
2131
        directive_locals = self.directive_locals = env.directives['locals']
2132
        allow_none_for_extension_args = env.directives['allow_none_for_extension_args']
William Stein's avatar
William Stein committed
2133
        for arg in self.args:
2134 2135 2136 2137 2138 2139 2140
            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
2141 2142
                arg.type = type
            self.align_argument_type(env, arg)
2143
            if name_declarator and name_declarator.cname:
William Stein's avatar
William Stein committed
2144 2145
                error(self.pos,
                    "Python function argument cannot have C name specification")
2146
            arg.type = arg.type.as_argument_type()
William Stein's avatar
William Stein committed
2147 2148 2149 2150
            arg.hdr_type = None
            arg.needs_conversion = 0
            arg.needs_type_test = 0
            arg.is_generic = 1
2151
            if arg.type.is_pyobject:
2152 2153 2154 2155
                if arg.or_none:
                    arg.accept_none = True
                elif arg.not_none:
                    arg.accept_none = False
2156
                elif arg.type.is_extension_type or arg.type.is_builtin_type:
2157 2158 2159 2160 2161 2162
                    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
2163 2164 2165
                else:
                    # probably just a plain 'object'
                    arg.accept_none = True
2166
            else:
2167
                arg.accept_none = True # won't be used, but must be there
2168
                if arg.not_none:
2169
                    error(arg.pos, "Only Python type arguments can have 'not None'")
2170
                if arg.or_none:
2171
                    error(arg.pos, "Only Python type arguments can have 'or None'")
2172

William Stein's avatar
William Stein committed
2173
    def analyse_signature(self, env):
2174
        if self.entry.is_special:
2175
            if self.decorators:
2176
                error(self.pos, "special functions of cdef classes cannot have decorators")
2177 2178 2179 2180
            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:
2181 2182
                if len(self.args) == 0:
                    self.entry.signature = TypeSlots.pyfunction_noargs
2183 2184 2185
                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
2186 2187 2188
            elif self.entry.signature is TypeSlots.pymethod_signature:
                if len(self.args) == 1:
                    self.entry.signature = TypeSlots.unaryfunc
2189 2190 2191
                elif len(self.args) == 2:
                    if self.args[1].default is None and not self.args[1].kw_only:
                        self.entry.signature = TypeSlots.ibinaryfunc
2192

William Stein's avatar
William Stein committed
2193 2194
        sig = self.entry.signature
        nfixed = sig.num_fixed_args()
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
        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
2211
                else:
2212 2213 2214
                    arg.is_self_arg = 1
                    arg.hdr_type = arg.type = env.parent_type
                arg.needs_conversion = 0
William Stein's avatar
William Stein committed
2215
            else:
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
                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
2231 2232 2233
            if not sig.has_generic_args:
                self.bad_signature()
            for arg in self.args:
Robert Bradshaw's avatar
Robert Bradshaw committed
2234 2235
                if arg.is_generic and \
                        (arg.type.is_extension_type or arg.type.is_builtin_type):
William Stein's avatar
William Stein committed
2236
                    arg.needs_type_test = 1
2237

William Stein's avatar
William Stein committed
2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251
    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))
2252 2253 2254

    def signature_has_nongeneric_args(self):
        argcount = len(self.args)
2255 2256 2257
        if argcount == 0 or (
                argcount == 1 and (self.args[0].is_self_arg or
                                   self.args[0].is_type_arg)):
2258 2259 2260 2261 2262
            return 0
        return 1

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

William Stein's avatar
William Stein committed
2264
    def declare_pyfunction(self, env):
2265 2266
        #print "DefNode.declare_pyfunction:", self.name, "in", env ###
        name = self.name
Stefan Behnel's avatar
Stefan Behnel committed
2267
        entry = env.lookup_here(name)
2268 2269
        if entry:
            if entry.is_final_cmethod and not env.parent_type.is_final_type:
Stefan Behnel's avatar
Stefan Behnel committed
2270
                error(self.pos, "Only final types can have final Python (def/cpdef) methods")
2271 2272 2273
            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)
2274
        entry = env.declare_pyfunction(name, self.pos, allow_redefine=not self.is_wrapper)
2275
        self.entry = entry
2276
        prefix = env.next_id(env.scope_prefix)
2277 2278
        entry.func_cname = Naming.pyfunc_prefix + prefix + name
        entry.pymethdef_cname = Naming.pymethdef_prefix + prefix + name
2279 2280
        if Options.docstrings:
            entry.doc = embed_position(self.pos, self.doc)
2281
            entry.doc_cname = Naming.funcdoc_prefix + prefix + name
2282
            if entry.is_special:
2283
                if entry.name in TypeSlots.invisible or not entry.doc or (entry.name in '__getattr__' and env.directives['fast_getattr']):
2284 2285 2286
                    entry.wrapperbase_cname = None
                else:
                    entry.wrapperbase_cname = Naming.wrapperbase_prefix + prefix + name
2287 2288
        else:
            entry.doc = None
2289

Stefan Behnel's avatar
Stefan Behnel committed
2290
    def declare_lambda_function(self, env):
2291
        entry = env.declare_lambda_function(self.lambda_name, self.pos)
Stefan Behnel's avatar
Stefan Behnel committed
2292 2293 2294
        entry.doc = None
        self.entry = entry

William Stein's avatar
William Stein committed
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304
    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)
2305
            arg.entry.is_arg = 1
2306
            arg.entry.used = 1
William Stein's avatar
William Stein committed
2307 2308
            arg.entry.is_self_arg = arg.is_self_arg
            if arg.hdr_type:
2309
                if arg.is_self_arg or arg.is_type_arg or \
William Stein's avatar
William Stein committed
2310 2311 2312 2313 2314 2315 2316
                    (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:
2317
            if env.directives['infer_types'] != False:
2318 2319 2320 2321
                type = PyrexTypes.unspecified_type
            else:
                type = py_object_type
            entry = env.declare_var(arg.name, type, arg.pos)
2322
            entry.is_arg = 1
2323 2324 2325 2326
            entry.used = 1
            entry.init = "0"
            entry.xdecref_cleanup = 1
            arg.entry = entry
2327

William Stein's avatar
William Stein committed
2328
    def analyse_expressions(self, env):
2329
        self.local_scope.directives = env.directives
William Stein's avatar
William Stein committed
2330
        self.analyse_default_values(env)
2331
        if self.needs_assignment_synthesis(env):
Robert Bradshaw's avatar
Robert Bradshaw committed
2332
            # Shouldn't we be doing this at the module level too?
William Stein's avatar
William Stein committed
2333
            self.synthesize_assignment_node(env)
2334 2335 2336
        elif self.decorators:
            for decorator in self.decorators[::-1]:
                decorator.decorator.analyse_expressions(env)
2337

2338
    def needs_assignment_synthesis(self, env, code=None):
2339 2340
        if self.no_assignment_synthesis:
            return False
2341
        # Should enable for module level as well, that will require more testing...
2342
        if self.entry.is_anonymous:
2343
            return True
2344 2345 2346 2347 2348 2349 2350
        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
2351 2352
    def synthesize_assignment_node(self, env):
        import ExprNodes
2353 2354 2355
        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
2356

2357
        if genv.is_closure_scope:
2358
            rhs = self.py_cfunc_node = ExprNodes.InnerFunctionNode(
2359 2360
                self.pos, pymethdef_cname = self.entry.pymethdef_cname,
                code_object = ExprNodes.CodeObjectNode(self))
Robert Bradshaw's avatar
Robert Bradshaw committed
2361
        else:
2362
            rhs = self.py_cfunc_node = ExprNodes.PyCFunctionNode(
2363 2364 2365
                self.pos, pymethdef_cname = self.entry.pymethdef_cname,
                binding = env.directives['binding'],
                code_object = ExprNodes.CodeObjectNode(self))
2366 2367 2368 2369

        if env.is_py_class_scope:
            if not self.is_staticmethod and not self.is_classmethod:
                rhs.binding = True
2370 2371
            else:
                rhs.binding = False
2372

2373 2374 2375 2376 2377 2378 2379
        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
2380 2381 2382
        self.assmt = SingleAssignmentNode(self.pos,
            lhs = ExprNodes.NameNode(self.pos, name = self.name),
            rhs = rhs)
William Stein's avatar
William Stein committed
2383 2384
        self.assmt.analyse_declarations(env)
        self.assmt.analyse_expressions(env)
2385

2386
    def generate_function_header(self, code, with_pymethdef, proto_only=0):
William Stein's avatar
William Stein committed
2387 2388
        arg_code_list = []
        sig = self.entry.signature
2389
        if sig.has_dummy_arg or self.self_in_stararg:
William Stein's avatar
William Stein committed
2390 2391 2392 2393
            arg_code_list.append(
                "PyObject *%s" % Naming.self_cname)
        for arg in self.args:
            if not arg.is_generic:
2394
                if arg.is_self_arg or arg.is_type_arg:
William Stein's avatar
William Stein committed
2395 2396
                    arg_code_list.append("PyObject *%s" % arg.hdr_cname)
                else:
Vitja Makarov's avatar
Vitja Makarov committed
2397 2398 2399 2400 2401 2402
                    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)
2403
        if not self.entry.is_special and sig.method_flags() == [TypeSlots.method_noargs]:
2404
            arg_code_list.append("CYTHON_UNUSED PyObject *unused")
Lisandro Dalcin's avatar
Lisandro Dalcin committed
2405 2406
        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
2407 2408 2409 2410 2411 2412
        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)
2413 2414 2415
        mf = " ".join(self.modifiers).upper()
        if mf: mf += " "
        header = "static %s%s(%s)" % (mf, dc, arg_code)
William Stein's avatar
William Stein committed
2416
        code.putln("%s; /*proto*/" % header)
2417 2418
        if proto_only:
            return
2419
        if (Options.docstrings and self.entry.doc and
2420 2421
                not self.entry.scope.is_property_scope and
                (not self.entry.is_special or self.entry.wrapperbase_cname)):
2422
            docstr = self.entry.doc
Stefan Behnel's avatar
Stefan Behnel committed
2423
            if docstr.is_unicode:
2424
                docstr = docstr.utf8encode()
William Stein's avatar
William Stein committed
2425 2426 2427
            code.putln(
                'static char %s[] = "%s";' % (
                    self.entry.doc_cname,
2428
                    split_string_literal(escape_byte_string(docstr))))
2429 2430 2431
            if self.entry.is_special:
                code.putln(
                    "struct wrapperbase %s;" % self.entry.wrapperbase_cname)
William Stein's avatar
William Stein committed
2432 2433
        if with_pymethdef:
            code.put(
2434
                "static PyMethodDef %s = " %
William Stein's avatar
William Stein committed
2435
                    self.entry.pymethdef_cname)
2436
            code.put_pymethoddef(self.entry, ";", allow_skip=False)
William Stein's avatar
William Stein committed
2437 2438 2439 2440 2441
        code.putln("%s {" % header)

    def generate_argument_declarations(self, env, code):
        for arg in self.args:
            if arg.is_generic: # or arg.needs_conversion:
2442 2443
                if arg.needs_conversion:
                    code.putln("PyObject *%s = 0;" % arg.hdr_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
2444
                elif not arg.entry.in_closure:
2445
                    code.put_var_declaration(arg.entry)
2446

William Stein's avatar
William Stein committed
2447
    def generate_keyword_list(self, code):
2448 2449
        if self.signature_has_generic_args() and \
                self.signature_has_nongeneric_args():
William Stein's avatar
William Stein committed
2450
            code.put(
2451 2452
                "static PyObject **%s[] = {" %
                    Naming.pykwdlist_cname)
William Stein's avatar
William Stein committed
2453 2454
            for arg in self.args:
                if arg.is_generic:
2455 2456
                    pystring_cname = code.intern_identifier(arg.name)
                    code.put('&%s,' % pystring_cname)
2457
            code.putln("0};")
2458

2459
    def generate_argument_parsing_code(self, env, code):
Stefan Behnel's avatar
Stefan Behnel committed
2460 2461
        # Generate fast equivalent of PyArg_ParseTuple call for
        # generic arguments, if any, including args/kwargs
2462
        if self.entry.signature.has_dummy_arg and not self.self_in_stararg:
2463 2464 2465
            # get rid of unused argument warning
            code.putln("%s = %s;" % (Naming.self_cname, Naming.self_cname))

2466 2467
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
Stefan Behnel's avatar
Stefan Behnel committed
2468
        end_label = code.new_label("argument_unpacking_done")
2469

2470 2471 2472
        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
2473

2474
        for arg in self.args:
2475
            if not arg.type.is_pyobject:
2476 2477 2478 2479 2480
                if not arg.type.create_from_py_utility_code(env):
                    pass # will fail later
            elif arg.is_self_arg and arg.entry.in_closure:
                # must store 'self' in the closure explicitly for extension types
                self.generate_arg_assignment(arg, arg.hdr_cname, code)
2481

2482
        if not self.signature_has_generic_args():
2483 2484
            if has_star_or_kw_args:
                error(self.pos, "This method cannot have * or keyword arguments")
2485
            self.generate_argument_conversion_code(code)
2486

2487 2488
        elif not self.signature_has_nongeneric_args():
            # func(*args) or func(**kw) or func(*args, **kw)
2489
            self.generate_stararg_copy_code(code)
2490

2491
        else:
2492
            positional_args = []
2493
            kw_only_args = []
William Stein's avatar
William Stein committed
2494 2495 2496 2497
            for arg in self.args:
                arg_entry = arg.entry
                if arg.is_generic:
                    if arg.default:
2498
                        if not arg.is_self_arg and not arg.is_type_arg:
2499 2500 2501 2502
                            if arg.kw_only:
                                kw_only_args.append(arg)
                            else:
                                positional_args.append(arg)
2503
                    elif arg.kw_only:
2504
                        kw_only_args.append(arg)
2505
                    elif not arg.is_self_arg and not arg.is_type_arg:
2506
                        positional_args.append(arg)
2507

2508
            self.generate_tuple_and_keyword_parsing_code(
2509
                positional_args, kw_only_args, end_label, code)
2510

2511 2512
        code.error_label = old_error_label
        if code.label_used(our_error_label):
2513 2514
            if not code.label_used(end_label):
                code.put_goto(end_label)
2515 2516 2517 2518 2519
            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:
2520
                        code.put_var_xdecref_clear(self.starstar_arg.entry)
2521
                    else:
2522
                        code.put_var_decref_clear(self.starstar_arg.entry)
2523
            code.put_add_traceback(self.entry.qualified_name)
2524 2525 2526 2527 2528
            # 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
2529 2530
            # DECREF+clear the already handled references, as this
            # frees their references as early as possible.
2531 2532 2533 2534 2535 2536
            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()
2537
            code.putln("return %s;" % self.error_value())
2538
        if code.label_used(end_label):
2539 2540
            code.put_label(end_label)

2541 2542 2543 2544 2545 2546 2547 2548 2549 2550
        # 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)

2551 2552 2553 2554
    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)
2555 2556
            entry = arg.entry
            if entry.in_closure:
2557 2558
                code.put_incref(item, PyrexTypes.py_object_type)
            code.putln("%s = %s;" % (entry.cname, item))
2559 2560 2561 2562 2563 2564 2565 2566
        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)))
2567
            else:
2568
                error(arg.pos, "Cannot convert Python object argument to type '%s'" % arg.type)
2569

William Stein's avatar
William Stein committed
2570 2571
    def generate_arg_xdecref(self, arg, code):
        if arg:
2572
            code.put_var_xdecref_clear(arg.entry)
2573

2574 2575
    def generate_arg_decref(self, arg, code):
        if arg:
2576
            code.put_var_decref_clear(arg.entry)
William Stein's avatar
William Stein committed
2577

2578 2579
    def generate_stararg_copy_code(self, code):
        if not self.star_arg:
2580 2581 2582 2583
            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
2584
                    self.name, Naming.args_cname, self.error_value()))
2585
            code.putln("}")
2586

2587 2588 2589 2590 2591 2592 2593 2594
        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)
2595
        code.globalstate.use_utility_code(keyword_string_check_utility_code)
2596
        code.putln(
2597 2598
            "if (%s && unlikely(!__Pyx_CheckKeywordStrings(%s, \"%s\", %d))) return %s;" % (
                kwarg_check, Naming.kwds_cname, self.name,
2599
                bool(self.starstar_arg), self.error_value()))
2600

2601
        if self.starstar_arg:
2602
            code.putln("%s = (%s) ? PyDict_Copy(%s) : PyDict_New();" % (
2603 2604 2605
                    self.starstar_arg.entry.cname,
                    Naming.kwds_cname,
                    Naming.kwds_cname))
2606 2607
            code.putln("if (unlikely(!%s)) return %s;" % (
                    self.starstar_arg.entry.cname, self.error_value()))
2608
            self.starstar_arg.entry.xdecref_cleanup = 0
2609
            code.put_gotref(self.starstar_arg.entry.cname)
2610

2611 2612 2613 2614 2615 2616 2617 2618
        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("{")
2619
                code.put_decref_clear(self.starstar_arg.entry.cname, py_object_type)
2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
                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:
2642 2643 2644 2645 2646 2647
            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

2648
    def generate_tuple_and_keyword_parsing_code(self, positional_args,
2649 2650
                                                kw_only_args, success_label, code):
        argtuple_error_label = code.new_label("argtuple_error")
2651

2652
        min_positional_args = self.num_required_args - self.num_required_kw_args
2653
        if len(self.args) > 0 and (self.args[0].is_self_arg or self.args[0].is_type_arg):
2654 2655
            min_positional_args -= 1
        max_positional_args = len(positional_args)
2656 2657
        has_fixed_positional_count = not self.star_arg and \
            min_positional_args == max_positional_args
2658
        has_kw_only_args = bool(kw_only_args)
2659

Stefan Behnel's avatar
Stefan Behnel committed
2660 2661 2662
        if self.num_required_kw_args:
            code.globalstate.use_utility_code(raise_keyword_required_utility_code)

2663 2664 2665
        if self.starstar_arg or self.star_arg:
            self.generate_stararg_init_code(max_positional_args, code)

2666 2667 2668 2669 2670 2671 2672 2673 2674 2675
        # Before being converted and assigned to the target variables,
        # borrowed references to all unpacked argument values are
        # collected into a local PyObject* array, regardless if they
        # were taken from default arguments, positional arguments or
        # keyword arguments.
        code.putln('{')
        all_args = tuple(positional_args) + tuple(kw_only_args)
        self.generate_argument_values_setup_code(
            all_args, max_positional_args, argtuple_error_label, code)

2676
        # --- optimised code when we receive keyword arguments
2677 2678 2679
        code.putln("if (%s(%s)) {" % (
            (self.num_required_kw_args > 0) and "likely" or "unlikely",
            Naming.kwds_cname))
2680 2681
        self.generate_keyword_unpacking_code(
            min_positional_args, max_positional_args,
2682 2683
            has_fixed_positional_count, has_kw_only_args,
            all_args, argtuple_error_label, code)
2684 2685

        # --- optimised code when we do not receive any keyword arguments
2686
        if (self.num_required_kw_args and min_positional_args > 0) or min_positional_args == max_positional_args:
2687 2688 2689 2690 2691 2692 2693 2694 2695
            # 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)
2696

2697 2698 2699 2700 2701 2702 2703 2704 2705
        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:
2706
                    pystring_cname = code.intern_identifier(arg.name)
2707
                    # required keyword-only argument missing
2708
                    code.put('__Pyx_RaiseKeywordRequired("%s", %s); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2709
                            self.name,
2710
                            pystring_cname))
2711 2712
                    code.putln(code.error_goto(self.pos))
                    break
2713

2714
        else:
2715
            # optimised tuple unpacking code
2716
            code.putln('} else {')
2717 2718 2719 2720 2721
            if min_positional_args == max_positional_args:
                # parse the exact number of positional arguments from
                # the args tuple
                for i, arg in enumerate(positional_args):
                    code.putln("values[%d] = PyTuple_GET_ITEM(%s, %d);" % (i, Naming.args_cname, i))
2722
            else:
2723 2724 2725 2726 2727 2728 2729 2730
                # parse the positional arguments from the variable length
                # args tuple and reject illegal argument tuple sizes
                code.putln('switch (PyTuple_GET_SIZE(%s)) {' % Naming.args_cname)
                if self.star_arg:
                    code.putln('default:')
                reversed_args = list(enumerate(positional_args))[::-1]
                for i, arg in reversed_args:
                    if i >= min_positional_args-1:
2731
                        code.put('case %2d: ' % (i+1))
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759
                    code.putln("values[%d] = PyTuple_GET_ITEM(%s, %d);" % (i, Naming.args_cname, i))
                if min_positional_args == 0:
                    code.put('case  0: ')
                code.putln('break;')
                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:
                    code.put('default: ')
                    code.put_goto(argtuple_error_label)
                code.putln('}')

        code.putln('}')

        # convert arg values to their final type and assign them
        for i, arg in enumerate(all_args):
            if arg.default and not arg.type.is_pyobject:
                code.putln("if (values[%d]) {" % i)
            self.generate_arg_assignment(arg, "values[%d]" % i, code)
            if arg.default and not arg.type.is_pyobject:
                code.putln('} else {')
                code.putln(
                    "%s = %s;" % (
                        arg.entry.cname,
                        arg.calculate_default_value_code(code)))
                code.putln('}')
2760 2761 2762 2763 2764 2765

        code.putln('}')

        if code.label_used(argtuple_error_label):
            code.put_goto(success_label)
            code.put_label(argtuple_error_label)
2766
            code.globalstate.use_utility_code(raise_argtuple_invalid_utility_code)
2767
            code.put('__Pyx_RaiseArgtupleInvalid("%s", %d, %d, %d, PyTuple_GET_SIZE(%s)); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2768
                    self.name, has_fixed_positional_count,
2769 2770 2771 2772
                    min_positional_args, max_positional_args,
                    Naming.args_cname))
            code.putln(code.error_goto(self.pos))

2773 2774 2775 2776 2777 2778
    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,
2779
                        arg.calculate_default_value_code(code)))
2780

2781
    def generate_stararg_init_code(self, max_positional_args, code):
2782
        if self.starstar_arg:
2783
            self.starstar_arg.entry.xdecref_cleanup = 0
Stefan Behnel's avatar
Stefan Behnel committed
2784 2785 2786 2787
            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
2788
            code.put_gotref(self.starstar_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
2789 2790 2791 2792 2793
        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))
2794
            code.putln('%s = PyTuple_GetSlice(%s, %d, PyTuple_GET_SIZE(%s));' % (
Stefan Behnel's avatar
Stefan Behnel committed
2795 2796
                    self.star_arg.entry.cname, Naming.args_cname,
                    max_positional_args, Naming.args_cname))
2797
            code.putln("if (unlikely(!%s)) {" % self.star_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
2798
            if self.starstar_arg:
2799
                code.put_decref_clear(self.starstar_arg.entry.cname, py_object_type)
2800 2801
            if self.needs_closure:
                code.put_decref(Naming.cur_scope_cname, self.local_scope.scope_class.type)
2802 2803 2804 2805
            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
2806 2807 2808 2809
            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('}')
2810

2811 2812
    def generate_argument_values_setup_code(self, args, max_positional_args, argtuple_error_label, code):
        max_args = len(args)
Stefan Behnel's avatar
Stefan Behnel committed
2813 2814
        # the 'values' array collects borrowed references to arguments
        # before doing any type coercion etc.
2815
        code.putln("PyObject* values[%d] = {%s};" % (
Stefan Behnel's avatar
Stefan Behnel committed
2816
            max_args, ','.join('0'*max_args)))
2817

2818 2819
        # assign borrowed Python default values to the values array,
        # so that they can be overwritten by received arguments below
2820
        for i, arg in enumerate(args):
2821 2822 2823 2824
            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)))

2825 2826 2827 2828
    def generate_keyword_unpacking_code(self, min_positional_args, max_positional_args,
                                        has_fixed_positional_count, has_kw_only_args,
                                        all_args, argtuple_error_label, code):
        code.putln('Py_ssize_t kw_args;')
2829
        code.putln('const Py_ssize_t pos_args = PyTuple_GET_SIZE(%s);' % Naming.args_cname)
2830
        # copy the values from the args tuple and check that it's not too long
2831
        code.putln('switch (pos_args) {')
Stefan Behnel's avatar
Stefan Behnel committed
2832 2833
        if self.star_arg:
            code.putln('default:')
2834
        for i in range(max_positional_args-1, -1, -1):
2835
            code.put('case %2d: ' % (i+1))
2836 2837
            code.putln("values[%d] = PyTuple_GET_ITEM(%s, %d);" % (
                    i, Naming.args_cname, i))
2838
        code.putln('case  0: break;')
2839
        if not self.star_arg:
Stefan Behnel's avatar
Stefan Behnel committed
2840
            code.put('default: ') # more arguments than allowed
2841
            code.put_goto(argtuple_error_label)
2842 2843
        code.putln('}')

2844 2845 2846 2847 2848 2849 2850 2851 2852
        # The code above is very often (but not always) the same as
        # the optimised non-kwargs tuple unpacking code, so we keep
        # the code block above at the very top, before the following
        # 'external' PyDict_Size() call, to make it easy for the C
        # compiler to merge the two separate tuple unpacking
        # implementations into one when they turn out to be identical.

        # If we received kwargs, fill up the positional/required
        # arguments with values from the kw dict
2853
        code.putln('kw_args = PyDict_Size(%s);' % Naming.kwds_cname)
2854
        if self.num_required_args or max_positional_args > 0:
Stefan Behnel's avatar
Stefan Behnel committed
2855 2856 2857 2858
            last_required_arg = -1
            for i, arg in enumerate(all_args):
                if not arg.default:
                    last_required_arg = i
2859 2860
            if last_required_arg < max_positional_args:
                last_required_arg = max_positional_args-1
Stefan Behnel's avatar
Stefan Behnel committed
2861
            if max_positional_args > 0:
2862
                code.putln('switch (pos_args) {')
2863
            for i, arg in enumerate(all_args[:last_required_arg+1]):
Stefan Behnel's avatar
Stefan Behnel committed
2864
                if max_positional_args > 0 and i <= max_positional_args:
2865 2866 2867 2868
                    if self.star_arg and i == max_positional_args:
                        code.putln('default:')
                    else:
                        code.putln('case %2d:' % i)
2869
                pystring_cname = code.intern_identifier(arg.name)
2870
                if arg.default:
2871 2872 2873
                    if arg.kw_only:
                        # handled separately below
                        continue
2874
                    code.putln('if (kw_args > 0) {')
2875
                    code.putln('PyObject* value = PyDict_GetItem(%s, %s);' % (
2876
                        Naming.kwds_cname, pystring_cname))
2877
                    code.putln('if (value) { values[%d] = value; kw_args--; }' % i)
2878 2879 2880
                    code.putln('}')
                else:
                    code.putln('values[%d] = PyDict_GetItem(%s, %s);' % (
2881
                        i, Naming.kwds_cname, pystring_cname))
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
                    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 {')
2893
                            code.globalstate.use_utility_code(raise_argtuple_invalid_utility_code)
2894
                            code.put('__Pyx_RaiseArgtupleInvalid("%s", %d, %d, %d, %d); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
2895
                                    self.name, has_fixed_positional_count,
2896 2897 2898 2899
                                    min_positional_args, max_positional_args, i))
                            code.putln(code.error_goto(self.pos))
                            code.putln('}')
                    elif arg.kw_only:
2900
                        code.putln('else {')
2901
                        code.put('__Pyx_RaiseKeywordRequired("%s", %s); ' %(
Stefan Behnel's avatar
Stefan Behnel committed
2902
                                self.name, pystring_cname))
2903 2904
                        code.putln(code.error_goto(self.pos))
                        code.putln('}')
Stefan Behnel's avatar
Stefan Behnel committed
2905 2906
            if max_positional_args > 0:
                code.putln('}')
2907

2908
        if has_kw_only_args and not self.starstar_arg:
2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921
            # 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:
2922
                    pystring_cname = code.intern_identifier(arg.name)
2923 2924
                    code.putln(
                        'value = PyDict_GetItem(%s, %s);' % (
2925
                        Naming.kwds_cname, pystring_cname))
2926 2927 2928 2929 2930
                    code.putln(
                        'if (value) { values[%d] = value; if (!(--kw_args)) break; }' % i)
                code.putln('break;')
                code.putln('}')

2931
        code.putln('if (unlikely(kw_args > 0)) {')
2932 2933
        # non-positional/-required kw args left in dict: default args,
        # kw-only args, **kwargs or error
Stefan Behnel's avatar
Stefan Behnel committed
2934 2935 2936 2937 2938
        #
        # 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.
2939 2940 2941
        if max_positional_args == 0:
            pos_arg_count = "0"
        elif self.star_arg:
2942 2943
            code.putln("const Py_ssize_t used_pos_args = (pos_args < %d) ? pos_args : %d;" % (
                    max_positional_args, max_positional_args))
Stefan Behnel's avatar
Stefan Behnel committed
2944 2945
            pos_arg_count = "used_pos_args"
        else:
2946
            pos_arg_count = "pos_args"
2947
        code.globalstate.use_utility_code(parse_keywords_utility_code)
Stefan Behnel's avatar
Stefan Behnel committed
2948 2949
        code.putln(
            'if (unlikely(__Pyx_ParseOptionalKeywords(%s, %s, %s, values, %s, "%s") < 0)) %s' % (
Stefan Behnel's avatar
Stefan Behnel committed
2950 2951 2952 2953
                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
2954 2955
                self.name,
                code.error_goto(self.pos)))
2956
        code.putln('}')
2957

William Stein's avatar
William Stein committed
2958
    def generate_argument_conversion_code(self, code):
2959 2960 2961
        # 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
2962 2963 2964
        for arg in self.args:
            if arg.needs_conversion:
                self.generate_arg_conversion(arg, code)
2965
            elif not arg.is_self_arg and arg.entry.in_closure:
2966
                if arg.type.is_pyobject:
Stefan Behnel's avatar
Stefan Behnel committed
2967 2968
                    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
2969 2970 2971 2972 2973 2974

    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
2975 2976 2977 2978
            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
2979
            self.generate_arg_conversion_from_pyobject(arg, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
2980
            code.putln("}")
William Stein's avatar
William Stein committed
2981 2982 2983 2984 2985 2986 2987 2988
        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,
2989
                    "Cannot convert 1 argument from '%s' to '%s'" %
William Stein's avatar
William Stein committed
2990
                        (old_type, new_type))
2991

William Stein's avatar
William Stein committed
2992 2993 2994
    def generate_arg_conversion_from_pyobject(self, arg, code):
        new_type = arg.type
        func = new_type.from_py_function
2995
        # copied from CoerceFromPyTypeNode
William Stein's avatar
William Stein committed
2996
        if func:
2997 2998 2999 3000 3001
            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" % (
3002
                lhs,
3003
                rhs,
3004
                code.error_goto_if(new_type.error_condition(arg.entry.cname), arg.pos)))
William Stein's avatar
William Stein committed
3005
        else:
3006 3007
            error(arg.pos,
                "Cannot convert Python object argument to type '%s'"
William Stein's avatar
William Stein committed
3008
                    % new_type)
3009

William Stein's avatar
William Stein committed
3010 3011 3012 3013
    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
3014
            code.putln("%s = %s(%s); %s" % (
William Stein's avatar
William Stein committed
3015 3016 3017
                arg.entry.cname,
                func,
                arg.hdr_cname,
Robert Bradshaw's avatar
Robert Bradshaw committed
3018
                code.error_goto_if_null(arg.entry.cname, arg.pos)))
3019
            code.put_var_gotref(arg.entry)
William Stein's avatar
William Stein committed
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031
        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)
3032 3033 3034
            elif not arg.accept_none and arg.type.is_pyobject:
                self.generate_arg_none_check(arg, code)

William Stein's avatar
William Stein committed
3035 3036
    def error_value(self):
        return self.entry.signature.error_value
3037

William Stein's avatar
William Stein committed
3038 3039
    def caller_will_check_exceptions(self):
        return 1
3040

3041 3042 3043 3044 3045 3046 3047 3048 3049 3050

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

    is_generator = True
    needs_closure = True

Stefan Behnel's avatar
Stefan Behnel committed
3051
    child_attrs = DefNode.child_attrs + ["gbody"]
3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073

    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):
3074 3075 3076
        from ExprNodes import generator_utility_code
        env.use_utility_code(generator_utility_code)

3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087
        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

3088
    def __init__(self, pos=None, name=None, body=None):
3089 3090 3091 3092
        super(GeneratorBodyDefNode, self).__init__(pos=pos, body=body, name=name, doc=None,
                                                   args=[],
                                                   star_arg=None, starstar_arg=None)

3093 3094
    def declare_generator_body(self, env):
        prefix = env.next_id(env.scope_prefix)
Vitja Makarov's avatar
Vitja Makarov committed
3095
        name = env.next_id('generator')
3096 3097 3098 3099
        cname = Naming.genbody_prefix + prefix + name
        entry = env.declare_var(None, py_object_type, self.pos,
                                cname=cname, visibility='private')
        entry.func_cname = cname
3100 3101 3102 3103 3104 3105
        entry.qualified_name = EncodedString(self.name)
        self.entry = entry

    def analyse_declarations(self, env):
        self.analyse_argument_types(env)
        self.declare_generator_body(env)
3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156

    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)
3157
            code.put_add_traceback(self.entry.qualified_name)
3158 3159 3160

        # ----- Non-error return cleanup
        code.put_label(code.return_label)
3161
        code.put_xdecref(Naming.retval_cname, py_object_type)
3162 3163 3164 3165 3166 3167 3168 3169 3170 3171
        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)
3172 3173 3174 3175 3176

        from ParseTreeTransforms import YieldNodeCollector
        collector = YieldNodeCollector()
        collector.visitchildren(self)
        for yield_expr in collector.yields:
3177 3178 3179 3180 3181 3182 3183 3184 3185
            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()


3186 3187
class OverrideCheckNode(StatNode):
    # A Node for dispatching to the def method if it
3188
    # is overriden.
3189 3190 3191 3192 3193 3194
    #
    #  py_func
    #
    #  args
    #  func_temp
    #  body
3195

Robert Bradshaw's avatar
Robert Bradshaw committed
3196
    child_attrs = ['body']
3197

3198
    body = None
Robert Bradshaw's avatar
Robert Bradshaw committed
3199

3200 3201
    def analyse_expressions(self, env):
        self.args = env.arg_entries
3202 3203 3204 3205
        if self.py_func.is_module_scope:
            first_arg = 0
        else:
            first_arg = 1
3206
        import ExprNodes
3207
        self.func_node = ExprNodes.RawCNameExprNode(self.pos, py_object_type)
3208
        call_tuple = ExprNodes.TupleNode(self.pos, args=[ExprNodes.NameNode(self.pos, name=arg.name) for arg in self.args[first_arg:]])
3209
        call_node = ExprNodes.SimpleCallNode(self.pos,
3210
                                             function=self.func_node,
3211
                                             args=[ExprNodes.NameNode(self.pos, name=arg.name) for arg in self.args[first_arg:]])
3212 3213
        self.body = ReturnStatNode(self.pos, value=call_node)
        self.body.analyse_expressions(env)
3214

3215
    def generate_execution_code(self, code):
3216
        interned_attr_cname = code.intern_identifier(self.py_func.entry.name)
3217
        # Check to see if we are an extension type
3218 3219 3220 3221
        if self.py_func.is_module_scope:
            self_arg = "((PyObject *)%s)" % Naming.module_cname
        else:
            self_arg = "((PyObject *)%s)" % self.args[0].cname
3222
        code.putln("/* Check if called by wrapper */")
3223
        code.putln("if (unlikely(%s)) ;" % Naming.skip_dispatch_cname)
3224
        code.putln("/* Check if overriden in Python */")
3225 3226 3227
        if self.py_func.is_module_scope:
            code.putln("else {")
        else:
3228
            code.putln("else if (unlikely(Py_TYPE(%s)->tp_dictoffset != 0)) {" % self_arg)
3229 3230
        func_node_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        self.func_node.set_cname(func_node_temp)
3231
        # need to get attribute manually--scope would return cdef method
3232
        err = code.error_goto_if_null(func_node_temp, self.pos)
3233
        code.putln("%s = PyObject_GetAttr(%s, %s); %s" % (
3234 3235 3236
            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
3237
        is_overridden = "(PyCFunction_GET_FUNCTION(%s) != (void *)&%s)" % (
3238
            func_node_temp, self.py_func.entry.func_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
3239
        code.putln("if (!%s || %s) {" % (is_builtin_function_or_method, is_overridden))
3240 3241
        self.body.generate_execution_code(code)
        code.putln("}")
3242 3243
        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
3244
        code.putln("}")
3245

Robert Bradshaw's avatar
Robert Bradshaw committed
3246 3247
class ClassDefNode(StatNode, BlockNode):
    pass
3248

Robert Bradshaw's avatar
Robert Bradshaw committed
3249
class PyClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
3250 3251
    #  A Python class definition.
    #
Stefan Behnel's avatar
Stefan Behnel committed
3252
    #  name     EncodedString   Name of the class
William Stein's avatar
William Stein committed
3253 3254 3255 3256
    #  doc      string or None
    #  body     StatNode        Attribute definition code
    #  entry    Symtab.Entry
    #  scope    PyClassScope
3257
    #  decorators    [DecoratorNode]        list of decorators or None
William Stein's avatar
William Stein committed
3258 3259 3260
    #
    #  The following subnodes are constructed internally:
    #
3261
    #  dict     DictNode   Class dictionary or Py3 namespace
William Stein's avatar
William Stein committed
3262 3263
    #  classobj ClassNode  Class object
    #  target   NameNode   Variable to assign class object to
3264

3265
    child_attrs = ["body", "dict", "metaclass", "mkw", "bases", "class_result", "target"]
3266
    decorators = None
3267
    class_result = None
Stefan Behnel's avatar
Stefan Behnel committed
3268
    py3_style_class = False # Python3 style class (bases+kwargs)
3269

3270 3271
    def __init__(self, pos, name, bases, doc, body, decorators = None,
                 keyword_args = None, starstar_arg = None):
William Stein's avatar
William Stein committed
3272 3273 3274 3275
        StatNode.__init__(self, pos)
        self.name = name
        self.doc = doc
        self.body = body
3276
        self.decorators = decorators
William Stein's avatar
William Stein committed
3277
        import ExprNodes
3278
        if self.doc and Options.docstrings:
3279
            doc = embed_position(self.pos, self.doc)
3280
            doc_node = ExprNodes.StringNode(pos, value = doc)
William Stein's avatar
William Stein committed
3281 3282
        else:
            doc_node = None
3283 3284
        if keyword_args or starstar_arg:
            self.py3_style_class = True
3285
            self.bases = bases
3286
            self.metaclass = None
3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297
            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):
3298 3299
                self.mkw = ExprNodes.KeywordArgsNode(
                    pos, keyword_args = keyword_args, starstar_arg = starstar_arg)
3300 3301 3302
            else:
                self.mkw = ExprNodes.NullNode(pos)
            if self.metaclass is None:
3303 3304
                self.metaclass = ExprNodes.PyClassMetaclassNode(
                    pos, mkw = self.mkw, bases = self.bases)
3305 3306
            self.dict = ExprNodes.PyClassNamespaceNode(pos, name = name,
                        doc = doc_node, metaclass = self.metaclass, bases = self.bases,
3307
                        mkw = self.mkw)
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317
            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
3318
        self.target = ExprNodes.NameNode(pos, name = name)
3319

3320 3321
    def as_cclass(self):
        """
3322
        Return this node as if it were declared as an extension class
3323
        """
3324 3325 3326
        if self.py3_style_class:
            error(self.classobj.pos, "Python3 style class could not be represented as C class")
            return
3327 3328 3329 3330 3331 3332 3333
        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 = []
3334 3335
            from ExprNodes import AttributeNode, NameNode
            while isinstance(base, AttributeNode):
3336 3337
                path.insert(0, base.attribute)
                base = base.obj
3338
            if isinstance(base, NameNode):
3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349
                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
3350 3351

        return CClassDefNode(self.pos,
3352 3353 3354 3355 3356
                             visibility = 'private',
                             module_name = None,
                             class_name = self.name,
                             base_class_module = base_class_module,
                             base_class_name = base_class_name,
3357
                             decorators = self.decorators,
3358 3359 3360
                             body = self.body,
                             in_pxd = False,
                             doc = self.doc)
3361

3362 3363
    def create_scope(self, env):
        genv = env
3364 3365
        while genv.is_py_class_scope or genv.is_c_class_scope:
            genv = genv.outer_scope
3366 3367
        cenv = self.scope = PyClassScope(name = self.name, outer_scope = genv)
        return cenv
3368

William Stein's avatar
William Stein committed
3369
    def analyse_declarations(self, env):
3370 3371 3372 3373 3374 3375 3376 3377 3378 3379
        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
3380
        self.target.analyse_target_declaration(env)
3381
        cenv = self.create_scope(env)
3382
        cenv.directives = env.directives
3383 3384
        cenv.class_obj_cname = self.target.entry.cname
        self.body.analyse_declarations(cenv)
3385

William Stein's avatar
William Stein committed
3386
    def analyse_expressions(self, env):
3387 3388 3389 3390
        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
3391
        self.dict.analyse_expressions(env)
3392
        self.class_result.analyse_expressions(env)
William Stein's avatar
William Stein committed
3393
        genv = env.global_scope()
3394
        cenv = self.scope
William Stein's avatar
William Stein committed
3395
        self.body.analyse_expressions(cenv)
3396
        self.target.analyse_target_expression(env, self.classobj)
3397

3398
    def generate_function_definitions(self, env, code):
3399
        self.generate_lambda_definitions(self.scope, code)
3400
        self.body.generate_function_definitions(self.scope, code)
3401

William Stein's avatar
William Stein committed
3402
    def generate_execution_code(self, code):
3403 3404
        code.pyclass_stack.append(self)
        cenv = self.scope
3405 3406 3407 3408
        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
3409
        self.dict.generate_evaluation_code(code)
Vitja Makarov's avatar
Vitja Makarov committed
3410 3411
        cenv.namespace_cname = cenv.class_obj_cname = self.dict.result()
        self.body.generate_execution_code(code)
3412
        self.class_result.generate_evaluation_code(code)
3413
        cenv.namespace_cname = cenv.class_obj_cname = self.classobj.result()
3414
        self.target.generate_assignment_code(self.class_result, code)
William Stein's avatar
William Stein committed
3415
        self.dict.generate_disposal_code(code)
3416
        self.dict.free_temps(code)
3417 3418 3419 3420 3421 3422 3423
        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)
3424
        code.pyclass_stack.pop()
William Stein's avatar
William Stein committed
3425

Robert Bradshaw's avatar
Robert Bradshaw committed
3426
class CClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
3427 3428 3429 3430
    #  An extension type definition.
    #
    #  visibility         'private' or 'public' or 'extern'
    #  typedef_flag       boolean
Stefan Behnel's avatar
Stefan Behnel committed
3431
    #  api                boolean
William Stein's avatar
William Stein committed
3432 3433 3434 3435 3436 3437 3438 3439
    #  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
3440
    #  decorators         [DecoratorNode]   list of decorators or None
William Stein's avatar
William Stein committed
3441 3442 3443 3444
    #  doc                string or None
    #  body               StatNode or None
    #  entry              Symtab.Entry
    #  base_type          PyExtensionType or None
3445 3446
    #  buffer_defaults_node DictNode or None Declares defaults for a buffer
    #  buffer_defaults_pos
3447

3448
    child_attrs = ["body"]
3449 3450
    buffer_defaults_node = None
    buffer_defaults_pos = None
3451 3452 3453 3454
    typedef_flag = False
    api = False
    objstruct_name = None
    typeobj_name = None
3455
    decorators = None
3456
    shadow = False
3457

Robert Bradshaw's avatar
Robert Bradshaw committed
3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469
    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

3470 3471 3472 3473 3474 3475 3476 3477
    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
3478

3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490
        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
3491
            buffer_defaults = self.buffer_defaults(env),
3492 3493 3494 3495 3496 3497
            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
3498

William Stein's avatar
William Stein committed
3499 3500 3501
        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")
3502 3503 3504
        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
3505
        self.base_type = None
3506 3507
        # Now that module imports are cached, we need to
        # import the modules for extern classes.
3508 3509 3510 3511 3512 3513 3514
        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)
3515
                self.module.has_extern_class = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
3516
                env.add_imported_module(self.module)
3517

William Stein's avatar
William Stein committed
3518 3519 3520 3521 3522
        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
3523 3524 3525 3526 3527 3528
            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
3529 3530 3531 3532 3533
            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)
3534 3535 3536
                    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
3537 3538
                        error(self.pos, "'%s' is not an extension type" % self.base_class_name)
                    elif not base_class_entry.type.is_complete():
3539 3540 3541
                        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 \
3542
                             base_class_entry.type.is_final_type:
3543 3544
                        error(self.pos, "Base class '%s' of type '%s' is final" % (
                            self.base_class_name, self.class_name))
3545 3546 3547 3548
                    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
3549 3550 3551
                    else:
                        self.base_type = base_class_entry.type
        has_body = self.body is not None
3552
        if self.module_name and self.visibility != 'extern':
3553 3554 3555 3556 3557 3558
            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
3559 3560

        if self.visibility == 'extern':
3561 3562 3563
            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
3564
                warning(self.pos, "%s already a builtin Cython type" % self.class_name, 1)
3565

3566
        self.entry = home_scope.declare_c_class(
3567
            name = self.class_name,
William Stein's avatar
William Stein committed
3568 3569 3570 3571 3572 3573 3574 3575
            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
3576
            typedef_flag = self.typedef_flag,
3577
            api = self.api,
Robert Bradshaw's avatar
Robert Bradshaw committed
3578
            buffer_defaults = self.buffer_defaults(env),
3579
            shadow = self.shadow)
3580

3581 3582
        if self.shadow:
            home_scope.lookup(self.class_name).as_variable = self.entry
3583
        if home_scope is not env and self.visibility == 'extern':
3584
            env.add_imported_entry(self.class_name, self.entry, self.pos)
3585
        self.scope = scope = self.entry.type.scope
3586 3587
        if scope is not None:
            scope.directives = env.directives
3588

3589
        if self.doc and Options.docstrings:
3590
            scope.doc = embed_position(self.pos, self.doc)
3591

William Stein's avatar
William Stein committed
3592 3593 3594 3595 3596 3597 3598
        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)
3599

William Stein's avatar
William Stein committed
3600 3601
    def analyse_expressions(self, env):
        if self.body:
Robert Bradshaw's avatar
Robert Bradshaw committed
3602 3603
            scope = self.entry.type.scope
            self.body.analyse_expressions(scope)
3604

3605
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
3606
        if self.body:
3607 3608
            self.generate_lambda_definitions(self.scope, code)
            self.body.generate_function_definitions(self.scope, code)
3609

William Stein's avatar
William Stein committed
3610 3611 3612 3613 3614
    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)
3615

3616 3617 3618
    def annotate(self, code):
        if self.body:
            self.body.annotate(code)
William Stein's avatar
William Stein committed
3619 3620 3621 3622 3623 3624


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

3628 3629
    child_attrs = ["body"]

William Stein's avatar
William Stein committed
3630 3631 3632
    def analyse_declarations(self, env):
        entry = env.declare_property(self.name, self.doc, self.pos)
        if entry:
3633
            entry.scope.directives = env.directives
William Stein's avatar
William Stein committed
3634
            self.body.analyse_declarations(entry.scope)
3635

William Stein's avatar
William Stein committed
3636 3637
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
3638

3639 3640
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
William Stein's avatar
William Stein committed
3641 3642 3643 3644

    def generate_execution_code(self, code):
        pass

3645 3646 3647
    def annotate(self, code):
        self.body.annotate(code)

William Stein's avatar
William Stein committed
3648 3649 3650 3651 3652

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

3654 3655
    child_attrs = []

William Stein's avatar
William Stein committed
3656 3657 3658 3659 3660 3661
    def analyse_declarations(self, env):
        for name in self.names:
            env.declare_global(name, self.pos)

    def analyse_expressions(self, env):
        pass
3662

William Stein's avatar
William Stein committed
3663 3664 3665 3666
    def generate_execution_code(self, code):
        pass


3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684
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
3685 3686 3687 3688
class ExprStatNode(StatNode):
    #  Expression used as a statement.
    #
    #  expr   ExprNode
3689 3690

    child_attrs = ["expr"]
3691

Robert Bradshaw's avatar
Robert Bradshaw committed
3692 3693 3694
    def analyse_declarations(self, env):
        import ExprNodes
        if isinstance(self.expr, ExprNodes.GeneralCallNode):
3695
            func = self.expr.function.as_cython_attribute()
Robert Bradshaw's avatar
Robert Bradshaw committed
3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706
            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
3707

William Stein's avatar
William Stein committed
3708
    def analyse_expressions(self, env):
3709
        self.expr.result_is_used = False # hint that .result() may safely be left empty
William Stein's avatar
William Stein committed
3710
        self.expr.analyse_expressions(env)
3711

3712
    def nogil_check(self, env):
3713
        if self.expr.type.is_pyobject and self.expr.is_temp:
3714 3715 3716 3717
            self.gil_error()

    gil_message = "Discarding owned Python object"

William Stein's avatar
William Stein committed
3718 3719
    def generate_execution_code(self, code):
        self.expr.generate_evaluation_code(code)
3720 3721
        if not self.expr.is_temp and self.expr.result():
            code.putln("%s;" % self.expr.result())
William Stein's avatar
William Stein committed
3722
        self.expr.generate_disposal_code(code)
3723
        self.expr.free_temps(code)
William Stein's avatar
William Stein committed
3724

3725 3726 3727
    def generate_function_definitions(self, env, code):
        self.expr.generate_function_definitions(env, code)

3728 3729 3730
    def annotate(self, code):
        self.expr.annotate(code)

William Stein's avatar
William Stein committed
3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741

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):
3742 3743
        self.analyse_types(env)

3744 3745 3746
#       def analyse_expressions(self, env):
#           self.analyse_expressions_1(env)
#           self.analyse_expressions_2(env)
William Stein's avatar
William Stein committed
3747 3748 3749 3750

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

William Stein's avatar
William Stein committed
3752 3753 3754 3755 3756 3757 3758 3759

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

3762
    child_attrs = ["lhs", "rhs"]
3763
    first = False
3764
    declaration_only = False
William Stein's avatar
William Stein committed
3765 3766

    def analyse_declarations(self, env):
3767
        import ExprNodes
3768

3769 3770
        # handle declarations of the form x = cython.foo()
        if isinstance(self.rhs, ExprNodes.CallNode):
3771
            func_name = self.rhs.function.as_cython_attribute()
3772 3773
            if func_name:
                args, kwds = self.rhs.explicit_args_kwds()
3774

3775
                if func_name in ['declare', 'typedef']:
Robert Bradshaw's avatar
Robert Bradshaw committed
3776
                    if len(args) > 2 or kwds is not None:
3777
                        error(self.rhs.pos, "Can only declare one type at a time.")
3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793
                        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
3794 3795 3796 3797 3798
                        if len(args) == 2:
                            # we have a value
                            self.rhs = args[1]
                        else:
                            self.declaration_only = True
3799
                    else:
Robert Bradshaw's avatar
Robert Bradshaw committed
3800
                        self.declaration_only = True
3801 3802
                        if not isinstance(lhs, ExprNodes.NameNode):
                            error(lhs.pos, "Invalid declaration.")
3803
                        env.declare_typedef(lhs.name, type, self.pos, visibility='private')
3804

3805 3806 3807
                elif func_name in ['struct', 'union']:
                    self.declaration_only = True
                    if len(args) > 0 or kwds is None:
3808
                        error(self.rhs.pos, "Struct or union members must be given by name.")
3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825
                        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)
3826

3827 3828 3829 3830
        if self.declaration_only:
            return
        else:
            self.lhs.analyse_target_declaration(env)
3831

3832
    def analyse_types(self, env, use_temp = 0):
William Stein's avatar
William Stein committed
3833 3834
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
3835
        self.lhs.gil_assignment_check(env)
William Stein's avatar
William Stein committed
3836 3837 3838
        self.rhs = self.rhs.coerce_to(self.lhs.type, env)
        if use_temp:
            self.rhs = self.rhs.coerce_to_temp(env)
3839

William Stein's avatar
William Stein committed
3840 3841
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
3842

William Stein's avatar
William Stein committed
3843 3844 3845
    def generate_assignment_code(self, code):
        self.lhs.generate_assignment_code(self.rhs, code)

3846 3847 3848
    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

3849 3850 3851 3852
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)

William Stein's avatar
William Stein committed
3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864

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
3865

3866
    child_attrs = ["lhs_list", "rhs", "coerced_rhs_list"]
3867
    coerced_rhs_list = None
3868

William Stein's avatar
William Stein committed
3869 3870 3871
    def analyse_declarations(self, env):
        for lhs in self.lhs_list:
            lhs.analyse_target_declaration(env)
3872

3873
    def analyse_types(self, env, use_temp = 0):
William Stein's avatar
William Stein committed
3874
        self.rhs.analyse_types(env)
Stefan Behnel's avatar
Stefan Behnel committed
3875 3876 3877 3878 3879
        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
3880 3881 3882 3883
        from ExprNodes import CloneNode
        self.coerced_rhs_list = []
        for lhs in self.lhs_list:
            lhs.analyse_target_types(env)
3884
            lhs.gil_assignment_check(env)
William Stein's avatar
William Stein committed
3885 3886 3887
            rhs = CloneNode(self.rhs)
            rhs = rhs.coerce_to(lhs.type, env)
            self.coerced_rhs_list.append(rhs)
3888

William Stein's avatar
William Stein committed
3889 3890
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
3891

William Stein's avatar
William Stein committed
3892 3893 3894 3895 3896 3897 3898 3899
    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)
3900
        self.rhs.free_temps(code)
William Stein's avatar
William Stein committed
3901

3902 3903 3904
    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

3905 3906 3907 3908 3909
    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)
3910

3911

William Stein's avatar
William Stein committed
3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924
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
3925

3926 3927
    child_attrs = ["stats"]

William Stein's avatar
William Stein committed
3928 3929 3930
    def analyse_declarations(self, env):
        for stat in self.stats:
            stat.analyse_declarations(env)
3931

William Stein's avatar
William Stein committed
3932 3933
    def analyse_expressions(self, env):
        for stat in self.stats:
3934 3935
            stat.analyse_types(env, use_temp = 1)

Robert Bradshaw's avatar
Robert Bradshaw committed
3936 3937 3938 3939 3940
#    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)
3941

William Stein's avatar
William Stein committed
3942 3943 3944 3945 3946 3947
    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)

3948 3949 3950 3951
    def generate_function_definitions(self, env, code):
        for stat in self.stats:
            stat.generate_function_definitions(env, code)

3952 3953 3954 3955 3956
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)


3957
class InPlaceAssignmentNode(AssignmentNode):
Craig Citro's avatar
Craig Citro committed
3958
    #  An in place arithmetic operand:
3959 3960 3961 3962 3963 3964 3965
    #
    #    a += b
    #    a -= b
    #    ...
    #
    #  lhs      ExprNode      Left hand side
    #  rhs      ExprNode      Right hand side
Stefan Behnel's avatar
Stefan Behnel committed
3966
    #  operator char          one of "+-*/%^&|"
3967
    #
3968 3969 3970 3971 3972 3973 3974
    #  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).

3975
    child_attrs = ["lhs", "rhs"]
3976

3977 3978
    def analyse_declarations(self, env):
        self.lhs.analyse_target_declaration(env)
3979

3980
    def analyse_types(self, env):
3981 3982
        self.rhs.analyse_types(env)
        self.lhs.analyse_target_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
3983

3984
    def generate_execution_code(self, code):
3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995
        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
3996 3997
            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.")
3998 3999 4000 4001 4002 4003 4004 4005 4006 4007
            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)

4008 4009 4010
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)
4011

4012 4013
    def create_binop_node(self):
        import ExprNodes
4014
        return ExprNodes.binop_node(self.pos, self.operator, self.lhs, self.rhs)
4015

William Stein's avatar
William Stein committed
4016 4017 4018 4019

class PrintStatNode(StatNode):
    #  print statement
    #
4020
    #  arg_tuple         TupleNode
4021
    #  stream            ExprNode or None (stdout)
4022
    #  append_newline    boolean
4023

4024
    child_attrs = ["arg_tuple", "stream"]
4025

William Stein's avatar
William Stein committed
4026
    def analyse_expressions(self, env):
4027 4028 4029
        if self.stream:
            self.stream.analyse_expressions(env)
            self.stream = self.stream.coerce_to_pyobject(env)
4030
        self.arg_tuple.analyse_expressions(env)
4031
        self.arg_tuple = self.arg_tuple.coerce_to_pyobject(env)
4032
        env.use_utility_code(printing_utility_code)
4033 4034
        if len(self.arg_tuple.args) == 1 and self.append_newline:
            env.use_utility_code(printing_one_utility_code)
4035

4036
    nogil_check = Node.gil_error
4037
    gil_message = "Python print statement"
4038

William Stein's avatar
William Stein committed
4039
    def generate_execution_code(self, code):
4040 4041 4042 4043 4044
        if self.stream:
            self.stream.generate_evaluation_code(code)
            stream_result = self.stream.py_result()
        else:
            stream_result = '0'
4045 4046 4047
        if len(self.arg_tuple.args) == 1 and self.append_newline:
            arg = self.arg_tuple.args[0]
            arg.generate_evaluation_code(code)
4048

4049
            code.putln(
4050 4051
                "if (__Pyx_PrintOne(%s, %s) < 0) %s" % (
                    stream_result,
4052 4053 4054 4055 4056 4057 4058
                    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(
4059 4060
                "if (__Pyx_Print(%s, %s, %d) < 0) %s" % (
                    stream_result,
4061 4062 4063 4064 4065
                    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)
4066

4067 4068 4069 4070
        if self.stream:
            self.stream.generate_disposal_code(code)
            self.stream.free_temps(code)

4071
    def generate_function_definitions(self, env, code):
4072 4073
        if self.stream:
            self.stream.generate_function_definitions(env, code)
4074
        self.arg_tuple.generate_function_definitions(env, code)
4075

4076
    def annotate(self, code):
4077 4078
        if self.stream:
            self.stream.annotate(code)
4079
        self.arg_tuple.annotate(code)
William Stein's avatar
William Stein committed
4080 4081


4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095
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)

4096
    nogil_check = Node.gil_error
4097 4098 4099 4100 4101 4102 4103 4104
    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)])
4105
        temp_result = code.funcstate.allocate_temp(PyrexTypes.py_object_type, manage_ref=True)
4106
        code.putln("%s = __Pyx_PyRun(%s, %s, %s);" % (
4107
                (temp_result,) + args))
4108 4109
        for arg in self.args:
            arg.generate_disposal_code(code)
4110
            arg.free_temps(code)
4111
        code.putln(
4112 4113 4114 4115
            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)
4116 4117 4118 4119 4120 4121

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


William Stein's avatar
William Stein committed
4122 4123 4124 4125
class DelStatNode(StatNode):
    #  del statement
    #
    #  args     [ExprNode]
4126

4127 4128
    child_attrs = ["args"]

William Stein's avatar
William Stein committed
4129 4130 4131
    def analyse_declarations(self, env):
        for arg in self.args:
            arg.analyse_target_declaration(env)
4132

William Stein's avatar
William Stein committed
4133 4134
    def analyse_expressions(self, env):
        for arg in self.args:
4135
            arg.analyse_target_expression(env, None)
Robert Bradshaw's avatar
Robert Bradshaw committed
4136
            if arg.type.is_pyobject:
Robert Bradshaw's avatar
Robert Bradshaw committed
4137
                pass
Robert Bradshaw's avatar
Robert Bradshaw committed
4138
            elif arg.type.is_ptr and arg.type.base_type.is_cpp_class:
Robert Bradshaw's avatar
Robert Bradshaw committed
4139
                self.cpp_check(env)
4140
            elif arg.type.is_cpp_class:
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
4141
                error(arg.pos, "Deletion of non-heap C++ object")
4142
            else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4143
                error(arg.pos, "Deletion of non-Python, non-C++ object")
4144
            #arg.release_target_temp(env)
4145

4146
    def nogil_check(self, env):
4147 4148
        for arg in self.args:
            if arg.type.is_pyobject:
4149
                self.gil_error()
4150

4151 4152
    gil_message = "Deleting Python object"

William Stein's avatar
William Stein committed
4153 4154 4155 4156
    def generate_execution_code(self, code):
        for arg in self.args:
            if arg.type.is_pyobject:
                arg.generate_deletion_code(code)
4157
            elif arg.type.is_ptr and arg.type.base_type.is_cpp_class:
Robert Bradshaw's avatar
Robert Bradshaw committed
4158
                arg.generate_result_code(code)
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
4159
                code.putln("delete %s;" % arg.result())
William Stein's avatar
William Stein committed
4160 4161
            # else error reported earlier

4162 4163 4164 4165
    def annotate(self, code):
        for arg in self.args:
            arg.annotate(code)

William Stein's avatar
William Stein committed
4166 4167 4168

class PassStatNode(StatNode):
    #  pass statement
4169 4170

    child_attrs = []
4171

William Stein's avatar
William Stein committed
4172 4173
    def analyse_expressions(self, env):
        pass
4174

William Stein's avatar
William Stein committed
4175 4176 4177 4178 4179 4180
    def generate_execution_code(self, code):
        pass


class BreakStatNode(StatNode):

4181
    child_attrs = []
4182
    is_terminator = True
4183

William Stein's avatar
William Stein committed
4184 4185
    def analyse_expressions(self, env):
        pass
4186

William Stein's avatar
William Stein committed
4187 4188 4189 4190
    def generate_execution_code(self, code):
        if not code.break_label:
            error(self.pos, "break statement not inside loop")
        else:
4191
            code.put_goto(code.break_label)
William Stein's avatar
William Stein committed
4192 4193 4194 4195


class ContinueStatNode(StatNode):

4196
    child_attrs = []
4197
    is_terminator = True
4198

William Stein's avatar
William Stein committed
4199 4200
    def analyse_expressions(self, env):
        pass
4201

William Stein's avatar
William Stein committed
4202
    def generate_execution_code(self, code):
4203
        if code.funcstate.in_try_finally:
William Stein's avatar
William Stein committed
4204 4205 4206 4207
            error(self.pos, "continue statement inside try of try...finally")
        elif not code.continue_label:
            error(self.pos, "continue statement not inside loop")
        else:
4208
            code.put_goto(code.continue_label)
William Stein's avatar
William Stein committed
4209 4210 4211 4212 4213 4214 4215


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

4217
    child_attrs = ["value"]
4218
    is_terminator = True
4219

4220 4221 4222
    # Whether we are in a parallel section
    in_parallel = False

William Stein's avatar
William Stein committed
4223 4224 4225 4226 4227 4228 4229 4230 4231
    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:
4232
                error(self.value.pos,
William Stein's avatar
William Stein committed
4233 4234 4235 4236 4237 4238 4239 4240
                    "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")
4241

4242
    def nogil_check(self, env):
4243
        if self.return_type.is_pyobject:
4244
            self.gil_error()
4245 4246 4247

    gil_message = "Returning Python object"

William Stein's avatar
William Stein committed
4248
    def generate_execution_code(self, code):
4249
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
4250 4251 4252
        if not self.return_type:
            # error reported earlier
            return
4253 4254 4255
        if self.return_type.is_pyobject:
            code.put_xdecref(Naming.retval_cname,
                             self.return_type)
William Stein's avatar
William Stein committed
4256 4257 4258
        if self.value:
            self.value.generate_evaluation_code(code)
            self.value.make_owned_reference(code)
4259
            self.put_return(code, self.value.result_as(self.return_type))
William Stein's avatar
William Stein committed
4260
            self.value.generate_post_assignment_code(code)
4261
            self.value.free_temps(code)
William Stein's avatar
William Stein committed
4262 4263 4264 4265
        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:
4266 4267
                self.put_return(code, self.return_type.default_value)

4268
        for cname, type in code.funcstate.temps_holding_reference():
4269
            code.put_decref_clear(cname, type)
4270

4271
        code.put_goto(code.return_label)
4272

4273 4274 4275 4276 4277
    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))

4278 4279 4280
    def generate_function_definitions(self, env, code):
        if self.value is not None:
            self.value.generate_function_definitions(env, code)
4281

4282 4283 4284
    def annotate(self, code):
        if self.value:
            self.value.annotate(code)
William Stein's avatar
William Stein committed
4285 4286 4287 4288 4289 4290 4291 4292


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
4293
    #  cause       ExprNode or None
4294

Haoyu Bai's avatar
Haoyu Bai committed
4295
    child_attrs = ["exc_type", "exc_value", "exc_tb", "cause"]
4296
    is_terminator = True
4297

William Stein's avatar
William Stein committed
4298 4299 4300 4301 4302 4303 4304 4305 4306 4307
    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
4308 4309 4310
        if self.cause:
            self.cause.analyse_types(env)
            self.cause = self.cause.coerce_to_pyobject(env)
4311 4312 4313 4314 4315
        # 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
4316 4317
            if (isinstance(exc, ExprNodes.SimpleCallNode) and
                not (exc.args or (exc.arg_tuple is not None and
4318
                                  exc.arg_tuple.args))):
4319 4320 4321 4322 4323
                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
4324

4325
    nogil_check = Node.gil_error
4326 4327
    gil_message = "Raising exception"

William Stein's avatar
William Stein committed
4328
    def generate_execution_code(self, code):
4329 4330 4331 4332
        if self.builtin_exc_name == 'MemoryError':
            code.putln('PyErr_NoMemory(); %s' % code.error_goto(self.pos))
            return

William Stein's avatar
William Stein committed
4333 4334 4335 4336
        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
4337
            type_code = "0"
William Stein's avatar
William Stein committed
4338 4339 4340 4341 4342 4343 4344 4345 4346 4347
        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
4348 4349 4350 4351 4352
        if self.cause:
            self.cause.generate_evaluation_code(code)
            cause_code = self.cause.py_result()
        else:
            cause_code = "0"
4353
        code.globalstate.use_utility_code(raise_utility_code)
4354
        code.putln(
Haoyu Bai's avatar
Haoyu Bai committed
4355
            "__Pyx_Raise(%s, %s, %s, %s);" % (
4356 4357
                type_code,
                value_code,
Haoyu Bai's avatar
Haoyu Bai committed
4358 4359 4360
                tb_code,
                cause_code))
        for obj in (self.exc_type, self.exc_value, self.exc_tb, self.cause):
4361 4362 4363
            if obj:
                obj.generate_disposal_code(code)
                obj.free_temps(code)
William Stein's avatar
William Stein committed
4364 4365 4366
        code.putln(
            code.error_goto(self.pos))

4367 4368 4369 4370 4371 4372 4373
    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
4374 4375
        if self.cause is not None:
            self.cause.generate_function_definitions(env, code)
4376

4377 4378 4379 4380 4381 4382 4383
    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
4384 4385
        if self.cause:
            self.cause.annotate(code)
4386

William Stein's avatar
William Stein committed
4387

4388 4389
class ReraiseStatNode(StatNode):

4390
    child_attrs = []
4391
    is_terminator = True
4392

4393
    def analyse_expressions(self, env):
4394
        env.use_utility_code(restore_exception_utility_code)
4395

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

4399
    def generate_execution_code(self, code):
4400
        vars = code.funcstate.exc_vars
4401
        if vars:
4402 4403 4404 4405 4406 4407
            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()
4408 4409 4410
            code.putln(code.error_goto(self.pos))
        else:
            error(self.pos, "Reraise not inside except clause")
4411

4412

William Stein's avatar
William Stein committed
4413 4414 4415 4416 4417
class AssertStatNode(StatNode):
    #  assert statement
    #
    #  cond    ExprNode
    #  value   ExprNode or None
4418

4419 4420
    child_attrs = ["cond", "value"]

William Stein's avatar
William Stein committed
4421 4422 4423 4424 4425
    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)
4426

4427
    nogil_check = Node.gil_error
4428
    gil_message = "Raising exception"
4429

William Stein's avatar
William Stein committed
4430
    def generate_execution_code(self, code):
4431
        code.putln("#ifndef CYTHON_WITHOUT_ASSERTIONS")
William Stein's avatar
William Stein committed
4432 4433
        self.cond.generate_evaluation_code(code)
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
4434
            "if (unlikely(!%s)) {" %
4435
                self.cond.result())
William Stein's avatar
William Stein committed
4436
        if self.value:
4437
            self.value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
4438 4439 4440
            code.putln(
                "PyErr_SetObject(PyExc_AssertionError, %s);" %
                    self.value.py_result())
4441
            self.value.generate_disposal_code(code)
4442
            self.value.free_temps(code)
William Stein's avatar
William Stein committed
4443 4444 4445 4446 4447 4448 4449 4450
        else:
            code.putln(
                "PyErr_SetNone(PyExc_AssertionError);")
        code.putln(
                code.error_goto(self.pos))
        code.putln(
            "}")
        self.cond.generate_disposal_code(code)
4451
        self.cond.free_temps(code)
4452
        code.putln("#endif")
William Stein's avatar
William Stein committed
4453

4454 4455 4456 4457 4458
    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)

4459 4460 4461 4462 4463 4464
    def annotate(self, code):
        self.cond.annotate(code)
        if self.value:
            self.value.annotate(code)


William Stein's avatar
William Stein committed
4465 4466 4467 4468 4469
class IfStatNode(StatNode):
    #  if statement
    #
    #  if_clauses   [IfClauseNode]
    #  else_clause  StatNode or None
4470 4471

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

William Stein's avatar
William Stein committed
4473 4474 4475 4476 4477
    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)
4478

William Stein's avatar
William Stein committed
4479 4480 4481 4482 4483
    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)
4484

William Stein's avatar
William Stein committed
4485
    def generate_execution_code(self, code):
4486
        code.mark_pos(self.pos)
4487 4488 4489 4490 4491
        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
4492
            self.else_clause.generate_execution_code(code)
4493 4494
            code.putln("}")
        code.put_label(end_label)
4495

4496 4497 4498 4499 4500
    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)
4501

4502 4503 4504 4505 4506
    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
4507 4508 4509 4510 4511 4512 4513


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

4515 4516
    child_attrs = ["condition", "body"]

William Stein's avatar
William Stein committed
4517 4518
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
4519

William Stein's avatar
William Stein committed
4520 4521 4522 4523
    def analyse_expressions(self, env):
        self.condition = \
            self.condition.analyse_temp_boolean_expression(env)
        self.body.analyse_expressions(env)
4524 4525 4526

    def get_constant_condition_result(self):
        if self.condition.has_constant_result():
4527
            return bool(self.condition.constant_result)
4528 4529 4530
        else:
            return None

William Stein's avatar
William Stein committed
4531 4532 4533 4534
    def generate_execution_code(self, code, end_label):
        self.condition.generate_evaluation_code(code)
        code.putln(
            "if (%s) {" %
4535
                self.condition.result())
4536 4537
        self.condition.generate_disposal_code(code)
        self.condition.free_temps(code)
William Stein's avatar
William Stein committed
4538
        self.body.generate_execution_code(code)
4539
        code.put_goto(end_label)
William Stein's avatar
William Stein committed
4540
        code.putln("}")
4541

4542 4543 4544 4545
    def generate_function_definitions(self, env, code):
        self.condition.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)

4546 4547 4548
    def annotate(self, code):
        self.condition.annotate(code)
        self.body.annotate(code)
4549

4550 4551 4552 4553 4554 4555

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

4557
    child_attrs = ['conditions', 'body']
4558

4559 4560
    def generate_execution_code(self, code):
        for cond in self.conditions:
4561
            code.mark_pos(cond.pos)
4562 4563
            cond.generate_evaluation_code(code)
            code.putln("case %s:" % cond.result())
4564 4565
        self.body.generate_execution_code(code)
        code.putln("break;")
4566 4567 4568 4569 4570

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

4572 4573 4574
    def annotate(self, code):
        for cond in self.conditions:
            cond.annotate(code)
4575
        self.body.annotate(code)
4576 4577 4578 4579 4580 4581 4582

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

4584
    child_attrs = ['test', 'cases', 'else_clause']
4585

4586
    def generate_execution_code(self, code):
4587
        self.test.generate_evaluation_code(code)
4588
        code.putln("switch (%s) {" % self.test.result())
4589 4590 4591 4592 4593
        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)
4594
            code.putln("break;")
4595 4596
        code.putln("}")

4597 4598 4599 4600 4601 4602 4603
    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)

4604 4605 4606 4607
    def annotate(self, code):
        self.test.annotate(code)
        for case in self.cases:
            case.annotate(code)
4608 4609
        if self.else_clause is not None:
            self.else_clause.annotate(code)
4610

4611
class LoopNode(object):
4612
    pass
4613

4614

4615
class WhileStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
4616 4617 4618 4619 4620
    #  while statement
    #
    #  condition    ExprNode
    #  body         StatNode
    #  else_clause  StatNode
4621 4622

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

William Stein's avatar
William Stein committed
4624 4625 4626 4627
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
4628

William Stein's avatar
William Stein committed
4629
    def analyse_expressions(self, env):
4630 4631
        if self.condition:
            self.condition = self.condition.analyse_temp_boolean_expression(env)
William Stein's avatar
William Stein committed
4632 4633 4634
        self.body.analyse_expressions(env)
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
4635

William Stein's avatar
William Stein committed
4636 4637 4638 4639
    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
        code.putln(
            "while (1) {")
4640 4641 4642 4643 4644 4645 4646
        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
4647
        self.body.generate_execution_code(code)
4648
        code.put_label(code.continue_label)
William Stein's avatar
William Stein committed
4649 4650 4651 4652 4653 4654 4655 4656 4657
        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)

4658
    def generate_function_definitions(self, env, code):
4659 4660
        if self.condition:
            self.condition.generate_function_definitions(env, code)
4661 4662 4663 4664
        self.body.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)

4665
    def annotate(self, code):
4666 4667
        if self.condition:
            self.condition.annotate(code)
4668 4669 4670 4671
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)

William Stein's avatar
William Stein committed
4672

4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716
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
4717
def ForStatNode(pos, **kw):
4718
    if 'iterator' in kw:
Robert Bradshaw's avatar
Robert Bradshaw committed
4719 4720 4721 4722
        return ForInStatNode(pos, **kw)
    else:
        return ForFromStatNode(pos, **kw)

4723
class ForInStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
4724 4725 4726 4727 4728 4729 4730
    #  for statement
    #
    #  target        ExprNode
    #  iterator      IteratorNode
    #  body          StatNode
    #  else_clause   StatNode
    #  item          NextNode       used internally
4731

4732
    child_attrs = ["target", "iterator", "body", "else_clause"]
4733
    item = None
4734

William Stein's avatar
William Stein committed
4735 4736 4737 4738 4739
    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)
4740

William Stein's avatar
William Stein committed
4741 4742 4743
    def analyse_expressions(self, env):
        import ExprNodes
        self.target.analyse_target_types(env)
4744
        self.iterator.analyse_expressions(env)
4745
        self.item = ExprNodes.NextNode(self.iterator)
4746 4747 4748 4749 4750 4751
        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
4752 4753 4754 4755 4756 4757 4758
        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
4759
        code.putln("for (;;) {")
William Stein's avatar
William Stein committed
4760 4761 4762
        self.item.generate_evaluation_code(code)
        self.target.generate_assignment_code(self.item, code)
        self.body.generate_execution_code(code)
4763
        code.put_label(code.continue_label)
Mark Florisson's avatar
Mark Florisson committed
4764
        code.putln("}")
William Stein's avatar
William Stein committed
4765 4766
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
4767

William Stein's avatar
William Stein committed
4768
        if self.else_clause:
4769 4770 4771 4772 4773 4774 4775
            # 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
4776 4777 4778
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
4779 4780 4781 4782 4783 4784 4785 4786 4787 4788

            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
4789
        self.iterator.generate_disposal_code(code)
4790
        self.iterator.free_temps(code)
William Stein's avatar
William Stein committed
4791

4792 4793 4794 4795 4796 4797 4798
    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)

4799 4800 4801 4802 4803 4804 4805 4806
    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
4807

4808
class ForFromStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
4809 4810 4811 4812 4813 4814 4815
    #  for name from expr rel name rel expr
    #
    #  target        NameNode
    #  bound1        ExprNode
    #  relation1     string
    #  relation2     string
    #  bound2        ExprNode
4816
    #  step          ExprNode or None
William Stein's avatar
William Stein committed
4817 4818 4819 4820 4821
    #  body          StatNode
    #  else_clause   StatNode or None
    #
    #  Used internally:
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
4822
    #  from_range         bool
4823
    #  is_py_target       bool
4824
    #  loopvar_node       ExprNode (usually a NameNode or temp node)
William Stein's avatar
William Stein committed
4825
    #  py_loopvar_node    PyTempNode or None
4826
    child_attrs = ["target", "bound1", "bound2", "step", "body", "else_clause"]
4827 4828

    is_py_target = False
4829
    loopvar_node = None
4830
    py_loopvar_node = None
Robert Bradshaw's avatar
Robert Bradshaw committed
4831
    from_range = False
4832

4833 4834 4835 4836 4837 4838 4839
    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
4840 4841 4842 4843 4844
    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)
4845

William Stein's avatar
William Stein committed
4846 4847 4848 4849 4850
    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
4851 4852 4853 4854
        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)
4855

Robert Bradshaw's avatar
Robert Bradshaw committed
4856
        target_type = self.target.type
4857
        if self.target.type.is_numeric:
Robert Bradshaw's avatar
Robert Bradshaw committed
4858
            loop_type = self.target.type
4859
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4860 4861 4862 4863 4864 4865 4866 4867 4868
            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
4869 4870
        if not self.bound2.is_literal:
            self.bound2 = self.bound2.coerce_to_temp(env)
4871
        if self.step is not None:
4872
            self.step = self.step.coerce_to(loop_type, env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4873 4874
            if not self.step.is_literal:
                self.step = self.step.coerce_to_temp(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4875

William Stein's avatar
William Stein committed
4876
        target_type = self.target.type
4877
        if not (target_type.is_pyobject or target_type.is_numeric):
4878
            error(self.target.pos,
Robert Bradshaw's avatar
Robert Bradshaw committed
4879
                "for-from loop variable must be c numeric type or Python object")
4880
        if target_type.is_numeric:
Robert Bradshaw's avatar
Robert Bradshaw committed
4881
            self.is_py_target = False
4882 4883
            if isinstance(self.target, ExprNodes.IndexNode) and self.target.is_buffer_access:
                raise error(self.pos, "Buffer indexing not allowed as for loop target.")
4884
            self.loopvar_node = self.target
William Stein's avatar
William Stein committed
4885 4886
            self.py_loopvar_node = None
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4887 4888
            self.is_py_target = True
            c_loopvar_node = ExprNodes.TempNode(self.pos, loop_type, env)
4889
            self.loopvar_node = c_loopvar_node
William Stein's avatar
William Stein committed
4890 4891 4892 4893 4894
            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)
4895

William Stein's avatar
William Stein committed
4896 4897
    def generate_execution_code(self, code):
        old_loop_labels = code.new_loop_labels()
Robert Bradshaw's avatar
Robert Bradshaw committed
4898
        from_range = self.from_range
William Stein's avatar
William Stein committed
4899 4900 4901
        self.bound1.generate_evaluation_code(code)
        self.bound2.generate_evaluation_code(code)
        offset, incop = self.relation_table[self.relation1]
4902 4903
        if self.step is not None:
            self.step.generate_evaluation_code(code)
Magnus Lie Hetland's avatar
Magnus Lie Hetland committed
4904 4905
            step = self.step.result()
            incop = "%s=%s" % (incop[0], step)
4906 4907 4908 4909 4910
        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)
4911
        if from_range:
Robert Bradshaw's avatar
Robert Bradshaw committed
4912
            loopvar_name = code.funcstate.allocate_temp(self.target.type, False)
4913
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4914
            loopvar_name = self.loopvar_node.result()
William Stein's avatar
William Stein committed
4915 4916
        code.putln(
            "for (%s = %s%s; %s %s %s; %s%s) {" % (
4917
                loopvar_name,
4918
                self.bound1.result(), offset,
Robert Bradshaw's avatar
Robert Bradshaw committed
4919
                loopvar_name, self.relation2, self.bound2.result(),
4920
                loopvar_name, incop))
William Stein's avatar
William Stein committed
4921 4922 4923
        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
4924 4925 4926
        elif from_range:
            code.putln("%s = %s;" % (
                            self.target.result(), loopvar_name))
William Stein's avatar
William Stein committed
4927 4928
        self.body.generate_execution_code(code)
        code.put_label(code.continue_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
4929
        if self.py_loopvar_node:
4930 4931 4932
            # 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.
4933
            import ExprNodes
4934
            if self.target.entry.is_pyglobal:
4935
                # We know target is a NameNode, this is the only ugly case.
4936
                target_node = ExprNodes.PyTempNode(self.target.pos, None)
4937 4938
                target_node.allocate(code)
                interned_cname = code.intern_identifier(self.target.entry.name)
4939
                code.globalstate.use_utility_code(ExprNodes.get_name_interned_utility_code)
4940
                code.putln("%s = __Pyx_GetName(%s, %s); %s" % (
4941
                                target_node.result(),
4942
                                Naming.module_cname,
4943 4944 4945
                                interned_cname,
                                code.error_goto_if_null(target_node.result(), self.target.pos)))
                code.put_gotref(target_node.result())
4946 4947 4948
            else:
                target_node = self.target
            from_py_node = ExprNodes.CoerceFromPyTypeNode(self.loopvar_node.type, target_node, None)
4949 4950
            from_py_node.temp_code = loopvar_name
            from_py_node.generate_result_code(code)
4951
            if self.target.entry.is_pyglobal:
4952 4953
                code.put_decref(target_node.result(), target_node.type)
                target_node.release(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
4954
        code.putln("}")
4955
        if self.py_loopvar_node:
4956 4957
            # This is potentially wasteful, but we don't want the semantics to
            # depend on whether or not the loop is a python type.
4958 4959
            self.py_loopvar_node.generate_evaluation_code(code)
            self.target.generate_assignment_code(self.py_loopvar_node, code)
4960 4961
        if from_range:
            code.funcstate.release_temp(loopvar_name)
William Stein's avatar
William Stein committed
4962 4963 4964 4965 4966 4967 4968 4969
        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)
4970
        self.bound1.free_temps(code)
William Stein's avatar
William Stein committed
4971
        self.bound2.generate_disposal_code(code)
4972
        self.bound2.free_temps(code)
4973 4974 4975 4976
        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)
4977 4978
        if self.step is not None:
            self.step.generate_disposal_code(code)
4979
            self.step.free_temps(code)
4980

William Stein's avatar
William Stein committed
4981 4982 4983 4984 4985 4986 4987
    relation_table = {
        # {relop : (initial offset, increment op)}
        '<=': ("",   "++"),
        '<' : ("+1", "++"),
        '>=': ("",   "--"),
        '>' : ("-1", "--")
    }
4988 4989 4990 4991 4992 4993 4994 4995 4996 4997

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

4999 5000 5001 5002 5003
    def annotate(self, code):
        self.target.annotate(code)
        self.bound1.annotate(code)
        self.bound2.annotate(code)
        if self.step:
5004
            self.step.annotate(code)
5005 5006 5007
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)
William Stein's avatar
William Stein committed
5008 5009


5010 5011 5012
class WithStatNode(StatNode):
    """
    Represents a Python with statement.
5013

5014
    Implemented by the WithTransform as follows:
5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031

        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
5032 5033
    """
    #  manager          The with statement manager object
5034
    #  target           ExprNode  the target lhs of the __enter__() call
5035
    #  body             StatNode
5036

5037
    child_attrs = ["manager", "target", "body"]
5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048

    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)

5049 5050 5051 5052
    def generate_function_definitions(self, env, code):
        self.manager.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)

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 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140
    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)

5141

William Stein's avatar
William Stein committed
5142 5143 5144 5145 5146 5147
class TryExceptStatNode(StatNode):
    #  try .. except statement
    #
    #  body             StatNode
    #  except_clauses   [ExceptClauseNode]
    #  else_clause      StatNode or None
5148

5149
    child_attrs = ["body", "except_clauses", "else_clause"]
5150

William Stein's avatar
William Stein committed
5151 5152 5153 5154 5155 5156
    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)
5157
        env.use_utility_code(reset_exception_utility_code)
5158

William Stein's avatar
William Stein committed
5159 5160
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
5161
        default_clause_seen = 0
William Stein's avatar
William Stein committed
5162 5163
        for except_clause in self.except_clauses:
            except_clause.analyse_expressions(env)
5164 5165 5166 5167 5168
            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
5169 5170
        if self.else_clause:
            self.else_clause.analyse_expressions(env)
5171

5172
    nogil_check = Node.gil_error
5173 5174
    gil_message = "Try-except statement"

William Stein's avatar
William Stein committed
5175
    def generate_execution_code(self, code):
5176
        old_return_label = code.return_label
5177
        old_break_label = code.break_label
5178
        old_continue_label = code.continue_label
William Stein's avatar
William Stein committed
5179 5180
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
5181 5182 5183
        except_end_label = code.new_label('exception_handled')
        except_error_label = code.new_label('except_error')
        except_return_label = code.new_label('except_return')
5184
        try_return_label = code.new_label('try_return')
5185
        try_break_label = code.new_label('try_break')
5186
        try_continue_label = code.new_label('try_continue')
5187
        try_end_label = code.new_label('try_end')
5188

5189 5190
        exc_save_vars = [code.funcstate.allocate_temp(py_object_type, False)
                         for i in xrange(3)]
5191 5192
        code.putln("{")
        code.putln("__Pyx_ExceptionSave(%s);" %
5193 5194
                   ', '.join(['&%s' % var for var in exc_save_vars]))
        for var in exc_save_vars:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
5195
            code.put_xgotref(var)
William Stein's avatar
William Stein committed
5196 5197
        code.putln(
            "/*try:*/ {")
5198
        code.return_label = try_return_label
5199
        code.break_label = try_break_label
5200
        code.continue_label = try_continue_label
William Stein's avatar
William Stein committed
5201 5202 5203
        self.body.generate_execution_code(code)
        code.putln(
            "}")
5204
        temps_to_clean_up = code.funcstate.all_free_managed_temps()
5205 5206
        code.error_label = except_error_label
        code.return_label = except_return_label
William Stein's avatar
William Stein committed
5207 5208 5209 5210 5211 5212
        if self.else_clause:
            code.putln(
                "/*else:*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln(
                "}")
5213
        for var in exc_save_vars:
5214
            code.put_xdecref_clear(var, py_object_type)
5215
        code.put_goto(try_end_label)
5216 5217
        if code.label_used(try_return_label):
            code.put_label(try_return_label)
Stefan Behnel's avatar
Stefan Behnel committed
5218 5219
            for var in exc_save_vars:
                code.put_xgiveref(var)
5220
            code.putln("__Pyx_ExceptionReset(%s);" %
5221
                       ', '.join(exc_save_vars))
5222
            code.put_goto(old_return_label)
William Stein's avatar
William Stein committed
5223
        code.put_label(our_error_label)
5224 5225
        for temp_name, type in temps_to_clean_up:
            code.put_xdecref_clear(temp_name, type)
William Stein's avatar
William Stein committed
5226
        for except_clause in self.except_clauses:
5227 5228
            except_clause.generate_handling_code(code, except_end_label)

5229 5230 5231 5232
        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
5233 5234
            for var in exc_save_vars:
                code.put_xgiveref(var)
Stefan Behnel's avatar
Stefan Behnel committed
5235
            code.putln("__Pyx_ExceptionReset(%s);" %
5236
                       ', '.join(exc_save_vars))
5237 5238
            code.put_goto(old_error_label)

5239 5240 5241 5242 5243 5244
        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
5245 5246
                for var in exc_save_vars:
                    code.put_xgiveref(var)
5247
                code.putln("__Pyx_ExceptionReset(%s);" %
5248
                           ', '.join(exc_save_vars))
5249
                code.put_goto(old_label)
5250 5251 5252

        if code.label_used(except_end_label):
            code.put_label(except_end_label)
Stefan Behnel's avatar
Stefan Behnel committed
5253 5254
            for var in exc_save_vars:
                code.put_xgiveref(var)
5255
            code.putln("__Pyx_ExceptionReset(%s);" %
5256
                       ', '.join(exc_save_vars))
5257 5258 5259
        code.put_label(try_end_label)
        code.putln("}")

5260 5261 5262
        for cname in exc_save_vars:
            code.funcstate.release_temp(cname)

5263
        code.return_label = old_return_label
5264
        code.break_label = old_break_label
5265
        code.continue_label = old_continue_label
5266
        code.error_label = old_error_label
William Stein's avatar
William Stein committed
5267

5268 5269 5270 5271 5272 5273 5274
    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)

5275 5276 5277 5278 5279 5280 5281
    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
5282 5283 5284 5285

class ExceptClauseNode(Node):
    #  Part of try ... except statement.
    #
5286
    #  pattern        [ExprNode]
William Stein's avatar
William Stein committed
5287 5288
    #  target         ExprNode or None
    #  body           StatNode
5289
    #  excinfo_target ResultRefNode or None   optional target for exception info
William Stein's avatar
William Stein committed
5290 5291 5292
    #  match_flag     string             result of exception match
    #  exc_value      ExcValueNode       used internally
    #  function_name  string             qualified name of enclosing function
5293
    #  exc_vars       (string * 3)       local exception variables
5294 5295 5296 5297

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

5299
    child_attrs = ["pattern", "target", "body", "exc_value", "excinfo_target"]
5300

5301
    exc_value = None
5302
    excinfo_target = None
5303

William Stein's avatar
William Stein committed
5304 5305 5306 5307
    def analyse_declarations(self, env):
        if self.target:
            self.target.analyse_target_declaration(env)
        self.body.analyse_declarations(env)
5308

William Stein's avatar
William Stein committed
5309 5310 5311 5312 5313
    def analyse_expressions(self, env):
        import ExprNodes
        genv = env.global_scope()
        self.function_name = env.qualified_name
        if self.pattern:
5314 5315 5316 5317
            # 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)
5318

William Stein's avatar
William Stein committed
5319
        if self.target:
5320
            self.exc_value = ExprNodes.ExcValueNode(self.pos, env)
5321
            self.target.analyse_target_expression(env, self.exc_value)
5322 5323 5324
        if self.excinfo_target is not None:
            import ExprNodes
            self.excinfo_tuple = ExprNodes.TupleNode(pos=self.pos, args=[
5325
                ExprNodes.ExcValueNode(pos=self.pos, env=env) for x in range(3)])
5326 5327
            self.excinfo_tuple.analyse_expressions(env)

William Stein's avatar
William Stein committed
5328
        self.body.analyse_expressions(env)
5329

William Stein's avatar
William Stein committed
5330 5331 5332
    def generate_handling_code(self, code, end_label):
        code.mark_pos(self.pos)
        if self.pattern:
5333 5334 5335 5336 5337
            exc_tests = []
            for pattern in self.pattern:
                pattern.generate_evaluation_code(code)
                exc_tests.append("PyErr_ExceptionMatches(%s)" % pattern.py_result())

5338
            match_flag = code.funcstate.allocate_temp(PyrexTypes.c_int_type, False)
William Stein's avatar
William Stein committed
5339
            code.putln(
5340 5341 5342 5343
                "%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
5344 5345
            code.putln(
                "if (%s) {" %
5346 5347
                    match_flag)
            code.funcstate.release_temp(match_flag)
William Stein's avatar
William Stein committed
5348
        else:
5349
            code.putln("/*except:*/ {")
5350

Stefan Behnel's avatar
fix  
Stefan Behnel committed
5351
        if not getattr(self.body, 'stats', True) and \
Stefan Behnel's avatar
Stefan Behnel committed
5352
                self.excinfo_target is None and self.target is None:
Stefan Behnel's avatar
Stefan Behnel committed
5353 5354
            # most simple case: no exception variable, empty body (pass)
            # => reset the exception state, done
5355 5356 5357 5358
            code.putln("PyErr_Restore(0,0,0);")
            code.put_goto(end_label)
            code.putln("}")
            return
5359

5360 5361 5362
        exc_vars = [code.funcstate.allocate_temp(py_object_type,
                                                 manage_ref=True)
                    for i in xrange(3)]
5363
        code.put_add_traceback(self.function_name)
William Stein's avatar
William Stein committed
5364
        # We always have to fetch the exception value even if
5365
        # there is no target, because this also normalises the
William Stein's avatar
William Stein committed
5366
        # exception and stores it in the thread state.
5367 5368
        code.globalstate.use_utility_code(get_exception_utility_code)
        exc_args = "&%s, &%s, &%s" % tuple(exc_vars)
5369 5370
        code.putln("if (__Pyx_GetException(%s) < 0) %s" % (exc_args,
            code.error_goto(self.pos)))
5371
        for x in exc_vars:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
5372
            code.put_gotref(x)
William Stein's avatar
William Stein committed
5373
        if self.target:
5374
            self.exc_value.set_var(exc_vars[1])
5375
            self.exc_value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
5376
            self.target.generate_assignment_code(self.exc_value, code)
5377
        if self.excinfo_target is not None:
5378 5379
            for tempvar, node in zip(exc_vars, self.excinfo_tuple.args):
                node.set_var(tempvar)
5380
            self.excinfo_tuple.generate_evaluation_code(code)
5381
            self.excinfo_target.result_code = self.excinfo_tuple.result()
5382

5383 5384 5385 5386
        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')

5387
        old_exc_vars = code.funcstate.exc_vars
5388
        code.funcstate.exc_vars = exc_vars
William Stein's avatar
William Stein committed
5389
        self.body.generate_execution_code(code)
5390
        code.funcstate.exc_vars = old_exc_vars
5391 5392
        if self.excinfo_target is not None:
            self.excinfo_tuple.generate_disposal_code(code)
5393
        for var in exc_vars:
5394
            code.put_decref_clear(var, py_object_type)
5395
        code.put_goto(end_label)
5396

Robert Bradshaw's avatar
Robert Bradshaw committed
5397 5398
        if code.label_used(code.break_label):
            code.put_label(code.break_label)
5399 5400
            if self.excinfo_target is not None:
                self.excinfo_tuple.generate_disposal_code(code)
5401
            for var in exc_vars:
5402
                code.put_decref_clear(var, py_object_type)
Robert Bradshaw's avatar
Robert Bradshaw committed
5403 5404
            code.put_goto(old_break_label)
        code.break_label = old_break_label
5405 5406 5407

        if code.label_used(code.continue_label):
            code.put_label(code.continue_label)
5408 5409
            if self.excinfo_target is not None:
                self.excinfo_tuple.generate_disposal_code(code)
5410
            for var in exc_vars:
5411
                code.put_decref_clear(var, py_object_type)
5412 5413
            code.put_goto(old_continue_label)
        code.continue_label = old_continue_label
5414

5415 5416
        if self.excinfo_target is not None:
            self.excinfo_tuple.free_temps(code)
5417 5418
        for temp in exc_vars:
            code.funcstate.release_temp(temp)
5419

William Stein's avatar
William Stein committed
5420 5421 5422
        code.putln(
            "}")

5423 5424 5425 5426
    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)
5427

5428
    def annotate(self, code):
5429
        if self.pattern:
5430 5431
            for pattern in self.pattern:
                pattern.annotate(code)
5432 5433 5434 5435
        if self.target:
            self.target.annotate(code)
        self.body.annotate(code)

William Stein's avatar
William Stein committed
5436 5437 5438 5439 5440 5441

class TryFinallyStatNode(StatNode):
    #  try ... finally statement
    #
    #  body             StatNode
    #  finally_clause   StatNode
5442
    #
William Stein's avatar
William Stein committed
5443 5444 5445 5446 5447 5448 5449 5450
    #  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.
5451

5452
    child_attrs = ["body", "finally_clause"]
5453

5454
    preserve_exception = 1
5455

5456 5457 5458
    # handle exception case, in addition to return/break/continue
    handle_error_case = True

William Stein's avatar
William Stein committed
5459 5460 5461 5462
    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.
5463

5464 5465
    is_try_finally_in_nogil = False

5466 5467 5468 5469
    def create_analysed(pos, env, body, finally_clause):
        node = TryFinallyStatNode(pos, body=body, finally_clause=finally_clause)
        return node
    create_analysed = staticmethod(create_analysed)
5470

William Stein's avatar
William Stein committed
5471 5472 5473
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        self.finally_clause.analyse_declarations(env)
5474

William Stein's avatar
William Stein committed
5475 5476 5477
    def analyse_expressions(self, env):
        self.body.analyse_expressions(env)
        self.finally_clause.analyse_expressions(env)
5478

5479
    nogil_check = Node.gil_error
5480 5481
    gil_message = "Try-finally statement"

William Stein's avatar
William Stein committed
5482 5483 5484 5485 5486
    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
5487 5488
        if not self.handle_error_case:
            code.error_label = old_error_label
William Stein's avatar
William Stein committed
5489
        catch_label = code.new_label()
5490 5491 5492

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

William Stein's avatar
William Stein committed
5493
        if self.disallow_continue_in_try_finally:
5494 5495
            was_in_try_finally = code.funcstate.in_try_finally
            code.funcstate.in_try_finally = 1
5496

William Stein's avatar
William Stein committed
5497
        self.body.generate_execution_code(code)
5498

William Stein's avatar
William Stein committed
5499
        if self.disallow_continue_in_try_finally:
5500
            code.funcstate.in_try_finally = was_in_try_finally
5501 5502 5503

        code.putln("}")

5504
        temps_to_clean_up = code.funcstate.all_free_managed_temps()
5505
        code.mark_pos(self.finally_clause.pos)
5506 5507
        code.putln("/*finally:*/ {")

5508 5509 5510 5511 5512 5513 5514 5515
        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
5516

5517
        if cases_used:
5518 5519
            code.putln("int __pyx_why;")

5520
            if error_label_used and self.preserve_exception:
5521 5522 5523
                if self.is_try_finally_in_nogil:
                    code.declare_gilstate()

5524 5525 5526 5527
                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])
5528 5529 5530 5531
                exc_var_init_zero += '%s = 0;' % Naming.exc_lineno_name
                code.putln(exc_var_init_zero)
            else:
                exc_var_init_zero = None
5532

5533
            code.use_label(catch_label)
5534
            code.putln("__pyx_why = 0; goto %s;" % catch_label)
5535 5536
            for i in cases_used:
                new_label = new_labels[i]
Stefan Behnel's avatar
Stefan Behnel committed
5537
                #if new_label and new_label != "<try>":
5538
                if new_label == new_error_label and self.preserve_exception:
5539
                    self.put_error_catcher(code,
5540
                        new_error_label, i+1, catch_label, temps_to_clean_up)
5541
                else:
5542 5543 5544
                    code.put('%s: ' % new_label)
                    if exc_var_init_zero:
                        code.putln(exc_var_init_zero)
5545
                    code.putln("__pyx_why = %s; goto %s;" % (i+1, catch_label))
5546
            code.put_label(catch_label)
5547

William Stein's avatar
William Stein committed
5548
        code.set_all_labels(old_labels)
5549 5550 5551
        if error_label_used:
            code.new_error_label()
            finally_error_label = code.error_label
5552

William Stein's avatar
William Stein committed
5553
        self.finally_clause.generate_execution_code(code)
5554

5555 5556 5557
        if error_label_used:
            if finally_error_label in code.labels_used and self.preserve_exception:
                over_label = code.new_label()
5558
                code.put_goto(over_label)
5559
                code.put_label(finally_error_label)
5560

5561
                code.putln("if (__pyx_why == %d) {" % (error_label_case + 1))
5562 5563
                if self.is_try_finally_in_nogil:
                    code.put_ensure_gil(declare_gilstate=False)
5564 5565
                for var in Naming.exc_vars:
                    code.putln("Py_XDECREF(%s);" % var)
5566 5567
                if self.is_try_finally_in_nogil:
                    code.put_release_ensured_gil()
5568
                code.putln("}")
5569

5570 5571
                code.put_goto(old_error_label)
                code.put_label(over_label)
5572

5573
            code.error_label = old_error_label
5574

5575 5576
        if cases_used:
            code.putln(
William Stein's avatar
William Stein committed
5577
                "switch (__pyx_why) {")
5578 5579 5580
            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
5581 5582
                    self.put_error_uncatcher(code, i+1, old_error_label)
                else:
5583
                    code.use_label(old_label)
5584 5585
                    code.putln("case %s: goto %s;" % (i+1, old_label))

5586
            # End the switch
5587
            code.putln(
5588
                "}")
5589 5590

        # End finally
William Stein's avatar
William Stein committed
5591 5592 5593
        code.putln(
            "}")

5594 5595 5596 5597
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
        self.finally_clause.generate_function_definitions(env, code)

5598 5599
    def put_error_catcher(self, code, error_label, i, catch_label,
                          temps_to_clean_up):
5600
        code.globalstate.use_utility_code(restore_exception_utility_code)
5601 5602 5603 5604 5605 5606
        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)

5607 5608
        for temp_name, type in temps_to_clean_up:
            code.put_xdecref_clear(temp_name, type)
5609 5610 5611 5612 5613 5614 5615

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

5616
        code.put_goto(catch_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
5617
        code.putln("}")
5618

William Stein's avatar
William Stein committed
5619
    def put_error_uncatcher(self, code, i, error_label):
5620
        code.globalstate.use_utility_code(restore_exception_utility_code)
William Stein's avatar
William Stein committed
5621
        code.putln(
5622
            "case %s: {" % i)
5623 5624 5625 5626 5627 5628 5629 5630 5631 5632

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

5633
        for var in Naming.exc_vars:
William Stein's avatar
William Stein committed
5634
            code.putln(
5635
                   "%s = 0;" % var)
5636

5637
        code.put_goto(error_label)
William Stein's avatar
William Stein committed
5638 5639 5640
        code.putln(
            "}")

5641 5642 5643 5644
    def annotate(self, code):
        self.body.annotate(code)
        self.finally_clause.annotate(code)

William Stein's avatar
William Stein committed
5645

5646 5647 5648 5649 5650 5651 5652 5653 5654 5655
class NogilTryFinallyStatNode(TryFinallyStatNode):
    """
    A try/finally statement that may be used in nogil code sections.
    """

    preserve_exception = False
    nogil_check = None


class GILStatNode(NogilTryFinallyStatNode):
5656 5657 5658
    #  'with gil' or 'with nogil' statement
    #
    #   state   string   'gil' or 'nogil'
5659

5660 5661 5662 5663 5664 5665
    def __init__(self, pos, state, body):
        self.state = state
        TryFinallyStatNode.__init__(self, pos,
            body = body,
            finally_clause = GILExitNode(pos, state = state))

5666 5667 5668 5669
    def analyse_declarations(self, env):
        env._in_with_gil_block = (self.state == 'gil')
        if self.state == 'gil':
            env.has_with_gil_block = True
5670

5671 5672
        return super(GILStatNode, self).analyse_declarations(env)

5673
    def analyse_expressions(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
5674
        env.use_utility_code(force_init_threads_utility_code)
5675
        was_nogil = env.nogil
5676
        env.nogil = self.state == 'nogil'
5677 5678 5679
        TryFinallyStatNode.analyse_expressions(self, env)
        env.nogil = was_nogil

5680
    def generate_execution_code(self, code):
Stefan Behnel's avatar
Stefan Behnel committed
5681
        code.mark_pos(self.pos)
5682
        code.begin_block()
5683

5684
        if self.state == 'gil':
5685
            code.put_ensure_gil()
5686
        else:
5687 5688
            code.put_release_gil()

5689
        TryFinallyStatNode.generate_execution_code(self, code)
5690
        code.end_block()
5691 5692 5693


class GILExitNode(StatNode):
5694 5695 5696 5697 5698
    """
    Used as the 'finally' block in a GILStatNode

    state   string   'gil' or 'nogil'
    """
5699

5700 5701
    child_attrs = []

5702 5703 5704 5705 5706
    def analyse_expressions(self, env):
        pass

    def generate_execution_code(self, code):
        if self.state == 'gil':
5707
            code.put_release_ensured_gil()
5708
        else:
5709
            code.put_acquire_gil()
5710 5711


5712 5713 5714 5715 5716 5717 5718
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)
5719 5720


William Stein's avatar
William Stein committed
5721 5722 5723 5724 5725
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
5726 5727

    child_attrs = []
5728

William Stein's avatar
William Stein committed
5729
    def analyse_declarations(self, env):
5730 5731 5732
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
William Stein's avatar
William Stein committed
5733 5734
        module_scope = env.find_module(self.module_name, self.pos)
        if "." in self.module_name:
5735
            names = [EncodedString(name) for name in self.module_name.split(".")]
William Stein's avatar
William Stein committed
5736 5737 5738 5739 5740 5741 5742 5743 5744 5745
            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:
5746
                env.add_imported_module(module_scope)
William Stein's avatar
William Stein committed
5747 5748 5749 5750 5751 5752 5753
                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
5754

William Stein's avatar
William Stein committed
5755 5756
    def generate_execution_code(self, code):
        pass
5757

William Stein's avatar
William Stein committed
5758 5759 5760 5761

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

5765 5766
    child_attrs = []

William Stein's avatar
William Stein committed
5767
    def analyse_declarations(self, env):
5768 5769 5770
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
William Stein's avatar
William Stein committed
5771 5772
        module_scope = env.find_module(self.module_name, self.pos)
        env.add_imported_module(module_scope)
5773
        for pos, name, as_name, kind in self.imported_names:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5774 5775 5776 5777
            if name == "*":
                for local_name, entry in module_scope.entries.items():
                    env.add_imported_entry(local_name, entry, pos)
            else:
5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789
                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:
5790 5791 5792 5793 5794 5795
                        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))
5796

Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5797 5798 5799
                if entry:
                    local_name = as_name or name
                    env.add_imported_entry(local_name, entry, pos)
5800

5801
    def declaration_matches(self, entry, kind):
5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813
        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
5814 5815 5816

    def analyse_expressions(self, env):
        pass
5817

William Stein's avatar
William Stein committed
5818 5819 5820 5821 5822 5823 5824 5825 5826
    def generate_execution_code(self, code):
        pass


class FromImportStatNode(StatNode):
    #  from ... import statement
    #
    #  module           ImportNode
    #  items            [(string, NameNode)]
5827
    #  interned_items   [(string, NameNode, ExprNode)]
William Stein's avatar
William Stein committed
5828
    #  item             PyTempNode            used internally
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5829
    #  import_star      boolean               used internally
5830 5831

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

William Stein's avatar
William Stein committed
5834
    def analyse_declarations(self, env):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5835 5836 5837 5838 5839 5840 5841 5842 5843
        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)
5844

William Stein's avatar
William Stein committed
5845 5846 5847
    def analyse_expressions(self, env):
        import ExprNodes
        self.module.analyse_expressions(env)
5848
        self.item = ExprNodes.RawCNameExprNode(self.pos, py_object_type)
William Stein's avatar
William Stein committed
5849 5850
        self.interned_items = []
        for name, target in self.items:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5851 5852 5853 5854 5855 5856
            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:
5857
                entry =  env.lookup(target.name)
5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870
                # 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:
5871
                        pass
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5872
                target.analyse_target_expression(env, None)
5873 5874 5875 5876
                if target.type is py_object_type:
                    coerced_item = None
                else:
                    coerced_item = self.item.coerce_to(target.type, env)
5877
                self.interned_items.append((name, target, coerced_item))
5878

William Stein's avatar
William Stein committed
5879 5880
    def generate_execution_code(self, code):
        self.module.generate_evaluation_code(code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
5881 5882 5883 5884 5885 5886
        if self.import_star:
            code.putln(
                'if (%s(%s) < 0) %s;' % (
                    Naming.import_star,
                    self.module.py_result(),
                    code.error_goto(self.pos)))
5887 5888
        item_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        self.item.set_cname(item_temp)
5889 5890
        for name, target, coerced_item in self.interned_items:
            cname = code.intern_identifier(name)
5891 5892
            code.putln(
                '%s = PyObject_GetAttr(%s, %s); %s' % (
5893
                    item_temp,
5894 5895
                    self.module.py_result(),
                    cname,
5896 5897
                    code.error_goto_if_null(item_temp, self.pos)))
            code.put_gotref(item_temp)
5898 5899 5900 5901 5902 5903
            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)
5904 5905
            code.put_decref_clear(item_temp, py_object_type)
        code.funcstate.release_temp(item_temp)
William Stein's avatar
William Stein committed
5906
        self.module.generate_disposal_code(code)
5907
        self.module.free_temps(code)
William Stein's avatar
William Stein committed
5908

5909

Mark Florisson's avatar
Mark Florisson committed
5910 5911 5912 5913 5914 5915 5916 5917 5918 5919
class ParallelNode(Node):
    """
    Base class for cython.parallel constructs.
    """

    nogil_check = None


class ParallelStatNode(StatNode, ParallelNode):
    """
5920
    Base class for 'with cython.parallel.parallel():' and 'for i in prange():'.
Mark Florisson's avatar
Mark Florisson committed
5921 5922 5923 5924 5925

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

    parent          parent ParallelStatNode or None
5926 5927 5928
    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
5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939

    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.
5940 5941 5942

    privatization_insertion_point   a code insertion point used to make temps
                                    private (esp. the "nsteps" temp)
5943 5944 5945 5946

    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
5947 5948
    """

5949
    child_attrs = ['body', 'num_threads']
Mark Florisson's avatar
Mark Florisson committed
5950 5951 5952 5953 5954

    body = None

    is_prange = False

5955
    error_label_used = False
5956

5957 5958
    num_threads = None

5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975
    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,
    )
5976

5977 5978
    critical_section_counter = 0

Mark Florisson's avatar
Mark Florisson committed
5979 5980
    def __init__(self, pos, **kwargs):
        super(ParallelStatNode, self).__init__(pos, **kwargs)
5981 5982

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

5985 5986 5987 5988
        # All seen closure cnames and their temporary cnames
        self.seen_closure_vars = set()

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

Mark Florisson's avatar
Mark Florisson committed
5993 5994 5995
        # [NameNode]
        self.assigned_nodes = []

Mark Florisson's avatar
Mark Florisson committed
5996 5997 5998
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)

5999 6000
        self.num_threads = None

6001
        if self.kwargs:
6002 6003 6004 6005 6006 6007
            for idx, dictitem in enumerate(self.kwargs.key_value_pairs[:]):
                if dictitem.key.value == 'num_threads':
                    self.num_threads = dictitem.value
                    del self.kwargs.key_value_pairs[idx]
                    break

6008 6009 6010 6011 6012
            try:
                self.kwargs = self.kwargs.compile_time_value(env)
            except Exception, e:
                error(self.kwargs.pos, "Only compile-time values may be "
                                       "supplied as keyword arguments")
6013 6014 6015 6016 6017 6018 6019 6020 6021
        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)

6022
    def analyse_expressions(self, env):
6023 6024
        if self.num_threads:
            self.num_threads.analyse_expressions(env)
6025
        self.body.analyse_expressions(env)
6026
        self.analyse_sharing_attributes(env)
6027

6028 6029 6030 6031
        if self.num_threads is not None:
            if self.parent and self.parent.num_threads is not None:
                error(self.pos,
                      "num_threads already declared in outer section")
6032
            elif self.parent:
6033
                error(self.pos,
6034 6035 6036 6037
                      "num_threads must be declared in the parent parallel section")
            elif (self.num_threads.type.is_int and
                  self.num_threads.is_literal and
                  self.num_threads.compile_time_value(env) <= 0):
6038 6039 6040
                error(self.pos,
                      "argument to num_threads must be greater than 0")

6041 6042 6043
            self.num_threads = self.num_threads.coerce_to(
                                PyrexTypes.c_int_type, env).coerce_to_temp(env)

6044
    def analyse_sharing_attributes(self, env):
Mark Florisson's avatar
Mark Florisson committed
6045
        """
6046 6047 6048
        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
6049
        """
6050
        for entry, (pos, op) in self.assignments.iteritems():
6051 6052 6053 6054 6055 6056 6057

            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
6058
                          "Cannot assign to private of outer parallel block")
6059 6060 6061 6062 6063 6064 6065
                    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
6066 6067 6068 6069
            # By default all variables should have the same values as if
            # executed sequentially
            lastprivate = True
            self.propagate_var_privatization(entry, op, lastprivate)
6070

6071
    def propagate_var_privatization(self, entry, op, lastprivate):
6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099
        """
        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
6100 6101
        Nested with parallel blocks are disallowed, because they wouldn't
        allow you to propagate lastprivates or reductions:
6102 6103 6104 6105

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

Mark Florisson's avatar
Mark Florisson committed
6106 6107
                sum = 0

6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123
                #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
        """
6124
        self.privates[entry] = (op, lastprivate)
6125 6126 6127 6128 6129 6130
        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
6131

6132 6133 6134 6135
            # 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
6136 6137 6138 6139 6140 6141 6142 6143 6144

    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)

6145 6146 6147
        if entry.cname in self.seen_closure_vars:
            return entry.cname

6148
        cname = code.funcstate.allocate_temp(entry.type, True)
6149 6150 6151 6152 6153 6154

        # 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
6155 6156 6157 6158
        self.modified_entries.append((entry, entry.cname))
        code.putln("%s = %s;" % (cname, entry.cname))
        entry.cname = cname

6159
    def initialize_privates_to_nan(self, code, exclude=None):
6160
        first = True
6161

6162
        for entry, (op, lastprivate) in self.privates.iteritems():
6163
            if not op and (not exclude or entry != exclude):
6164
                invalid_value = entry.type.invalid_value()
6165

6166
                if invalid_value:
6167 6168 6169 6170
                    if first:
                        code.putln("/* Initialize private variables to "
                                   "invalid values */")
                        code.globalstate.use_utility_code(
6171
                                invalid_values_utility_code)
6172 6173 6174
                        first = False

                    have_invalid_values = True
6175
                    code.putln("%s = %s;" % (entry.cname,
6176
                                             entry.type.cast_code(invalid_value)))
6177

6178 6179 6180 6181 6182
    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:
6183 6184 6185 6186 6187 6188 6189 6190 6191 6192
            c = self.begin_of_parallel_control_block_point
            # we need to set the owner to ourselves temporarily, as
            # allocate_temp may generate a comment in the middle of our pragma
            # otherwise when DebugFlags.debug_temp_code_comments is in effect
            owner = c.funcstate.owner
            c.funcstate.owner = c
            self.num_threads.generate_evaluation_code(c)
            c.funcstate.owner = owner

            code.put(" num_threads(%s)" % (self.num_threads.result(),))
6193

6194

Mark Florisson's avatar
Mark Florisson committed
6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205
    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:
6206
                self._allocate_closure_temp(code, entry)
Mark Florisson's avatar
Mark Florisson committed
6207 6208

    def release_closure_privates(self, code):
6209 6210 6211
        """
        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
6212
        self.seen_closure_vars.
6213
        """
Mark Florisson's avatar
Mark Florisson committed
6214 6215 6216 6217 6218
        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

6219 6220 6221 6222 6223 6224
    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:
6225
            c = self.privatization_insertion_point
6226

6227 6228 6229 6230 6231 6232 6233
            temps = code.funcstate.stop_collecting_temps()
            privates, firstprivates = [], []
            for temp, type in temps:
                if type.is_pyobject:
                    firstprivates.append(temp)
                else:
                    privates.append(temp)
6234

6235 6236 6237 6238
            if privates:
                c.put(" private(%s)" % ", ".join(privates))
            if firstprivates:
                c.put(" firstprivate(%s)" % ", ".join(firstprivates))
6239 6240 6241 6242 6243 6244 6245 6246

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

6248
    def setup_parallel_control_flow_block(self, code):
6249
        """
6250 6251
        Sets up a block that surrounds the parallel block to determine
        how the parallel section was exited. Any kind of return is
6252 6253 6254
        trapped (break, continue, return, exceptions). This is the idea:

        {
6255
            int why = 0;
6256 6257 6258 6259 6260 6261 6262

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

            new_return_label:
6263
                why = 3;
6264
                goto end_parallel;
6265

6266
            end_parallel:;
6267
                #pragma omp flush(why) # we need to flush for every iteration
6268 6269
            }

6270
            if (why == 3)
6271 6272 6273 6274 6275 6276 6277 6278
                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")

6279 6280
        code.begin_block() # parallel control flow block
        self.begin_of_parallel_control_block_point = code.insertion_point()
6281

6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304
    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()

6305 6306 6307 6308
    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
6309 6310 6311 6312 6313 6314 6315 6316 6317
        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
6318
        """
6319
        save_lastprivates_label = code.new_label()
6320
        dont_return_label = code.new_label()
6321 6322 6323 6324
        insertion_point = code.insertion_point()

        self.any_label_used = False
        self.breaking_label_used = False
6325
        self.error_label_used = False
6326

6327 6328 6329 6330 6331 6332
        self.parallel_private_temps = []

        all_labels = code.get_all_labels()

        # Figure this out before starting to generate any code
        for label in all_labels:
6333 6334
            if code.label_used(label):
                self.breaking_label_used = (self.breaking_label_used or
6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345
                                            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
6346

6347
            code.put_label(label)
6348

6349 6350 6351 6352
            if not (should_flush and is_continue_label):
                if label == code.error_label:
                    self.error_label_used = True
                    self.fetch_parallel_exception(code)
6353

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

6356 6357 6358 6359
            if (self.breaking_label_used and self.is_prange and not
                    is_continue_label):
                code.put_goto(save_lastprivates_label)
            else:
6360 6361
                code.put_goto(dont_return_label)

6362
        if self.any_label_used:
6363 6364 6365 6366 6367
            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)

6368 6369 6370
            code.put_label(dont_return_label)

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

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 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411
    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

6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468
    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()
6469 6470

    def restore_labels(self, code):
6471 6472 6473 6474 6475 6476
        """
        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))
6477

6478 6479 6480 6481 6482 6483 6484
    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:
6485

6486 6487 6488 6489 6490 6491 6492
            for i in prange(...):
                with cython.parallel.parallel():
                    continue

        Here break should be trapped in the parallel block, and propagated to
        the for loop.
        """
6493 6494 6495 6496
        c = self.begin_of_parallel_control_block_point

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

6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510
            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(
                "}")

6511 6512 6513 6514 6515 6516 6517
        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
6518 6519
            c.putln("int %s;" % Naming.parallel_why)
            c.putln("%s = 0;" % Naming.parallel_why)
6520

6521 6522 6523 6524 6525 6526
            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))

6527
            code.putln("switch (%s) {" % Naming.parallel_why)
6528 6529 6530 6531 6532 6533 6534 6535 6536 6537
            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)
6538 6539

            if self.error_label_used:
6540
                code.globalstate.use_utility_code(restore_exception_utility_code)
6541 6542 6543
                code.putln("    case 4:")
                self.restore_parallel_exception(code)
                code.put_goto(code.error_label)
6544

6545 6546 6547
            code.putln("}") # end switch
            code.putln(
                "}") # end if
6548 6549

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

Mark Florisson's avatar
Mark Florisson committed
6551 6552 6553

class ParallelWithBlockNode(ParallelStatNode):
    """
6554
    This node represents a 'with cython.parallel.parallel():' block
Mark Florisson's avatar
Mark Florisson committed
6555 6556
    """

6557 6558 6559 6560 6561 6562 6563 6564 6565 6566
    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
6567 6568
    def generate_execution_code(self, code):
        self.declare_closure_privates(code)
6569
        self.setup_parallel_control_flow_block(code)
Mark Florisson's avatar
Mark Florisson committed
6570 6571 6572

        code.putln("#ifdef _OPENMP")
        code.put("#pragma omp parallel ")
6573 6574

        if self.privates:
6575 6576
            privates = [e.cname for e in self.privates
                                    if not e.type.is_pyobject]
6577
            code.put('private(%s)' % ', '.join(privates))
6578

6579
        self.privatization_insertion_point = code.insertion_point()
6580
        self.put_num_threads(code)
6581
        code.putln("")
6582

6583 6584
        code.putln("#endif /* _OPENMP */")

6585
        code.begin_block() # parallel block
6586
        self.begin_parallel_block(code)
6587
        self.initialize_privates_to_nan(code)
6588
        code.funcstate.start_collecting_temps()
Mark Florisson's avatar
Mark Florisson committed
6589
        self.body.generate_execution_code(code)
6590
        self.trap_parallel_exit(code)
6591
        self.privatize_temps(code)
6592 6593
        self.end_parallel_block(code)
        code.end_block() # end parallel block
6594

6595 6596
        continue_ = code.label_used(code.continue_label)
        break_ = code.label_used(code.break_label)
6597

6598 6599 6600
        self.restore_labels(code)
        self.end_parallel_control_flow_block(code, break_=break_,
                                             continue_=continue_)
Mark Florisson's avatar
Mark Florisson committed
6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618
        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
6619

6620
    nogil = None
6621 6622 6623 6624
    schedule = None
    num_threads = None

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

6626 6627 6628 6629 6630
    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
6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647
    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
6648 6649 6650
        if hasattr(self.schedule, 'decode'):
            self.schedule = self.schedule.decode('ascii')

Mark Florisson's avatar
Mark Florisson committed
6651 6652
        if self.schedule not in (None, 'static', 'dynamic', 'guided',
                                 'runtime'):
Mark Florisson's avatar
Mark Florisson committed
6653
            error(self.pos, "Invalid schedule argument to prange: %s" %
Mark Florisson's avatar
Mark Florisson committed
6654 6655 6656
                                                        (self.schedule,))

    def analyse_expressions(self, env):
6657 6658 6659 6660
        if self.nogil:
            was_nogil = env.nogil
            env.nogil = True

6661 6662 6663
        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
6664

6665
        self.target.analyse_target_types(env)
Mark Florisson's avatar
Mark Florisson committed
6666

6667 6668 6669 6670 6671 6672 6673 6674
        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)

6675
            self.index_type = PyrexTypes.c_py_ssize_t_type
6676 6677
        else:
            self.index_type = self.target.type
Mark Florisson's avatar
Mark Florisson committed
6678 6679 6680 6681 6682 6683 6684 6685 6686

        # 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:
6687 6688
                    error(node.pos, "%s argument must be numeric" % name)
                    continue
Mark Florisson's avatar
Mark Florisson committed
6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701

                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)

6702 6703 6704 6705 6706 6707 6708 6709
        # 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

6710
        super(ParallelRangeNode, self).analyse_expressions(env)
6711

6712 6713 6714
        if self.nogil:
            env.nogil = was_nogil

Mark Florisson's avatar
Mark Florisson committed
6715 6716
    def nogil_check(self, env):
        names = 'start', 'stop', 'step', 'target'
6717
        nodes = self.start, self.stop, self.step, self.target
Mark Florisson's avatar
Mark Florisson committed
6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762
        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
        """
6763
        self.declare_closure_privates(code)
Mark Florisson's avatar
Mark Florisson committed
6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794

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

6795
        self.setup_parallel_control_flow_block(code) # parallel control flow block
6796

6797
        self.control_flow_var_code_point = code.insertion_point()
6798

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

6802 6803 6804 6805 6806 6807 6808
        # 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)
6809
        code.begin_block() # if block
6810
        code.putln("%(target)s = 0;" % fmt_dict)
Mark Florisson's avatar
Mark Florisson committed
6811
        self.generate_loop(code, fmt_dict)
6812
        code.end_block() # end if block
Mark Florisson's avatar
Mark Florisson committed
6813

6814 6815 6816
        self.restore_labels(code)

        if self.else_clause:
6817
            if self.breaking_label_used:
6818
                code.put("if (%s < 2)" % Naming.parallel_why)
6819 6820 6821 6822 6823 6824 6825

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

        # ------ cleanup ------
6826
        self.end_parallel_control_flow_block(code) # end parallel control flow block
6827

Mark Florisson's avatar
Mark Florisson committed
6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844
        # 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")
6845
            self.privatization_insertion_point = code.insertion_point()
6846
            reduction_codepoint = self.parent.privatization_insertion_point
Mark Florisson's avatar
Mark Florisson committed
6847
        else:
6848 6849
            code.put("#pragma omp parallel")
            self.privatization_insertion_point = code.insertion_point()
6850
            reduction_codepoint = self.privatization_insertion_point
6851 6852 6853 6854 6855 6856 6857 6858 6859 6860
            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
6861

6862
        for entry, (op, lastprivate) in self.privates.iteritems():
Mark Florisson's avatar
Mark Florisson committed
6863
            # Don't declare the index variable as a reduction
6864
            if op and op in "+*-&^|" and entry != self.target.entry:
6865 6866 6867
                if entry.type.is_pyobject:
                    error(self.pos, "Python objects cannot be reductions")
                else:
6868 6869 6870 6871
                    #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))
6872
            else:
6873 6874
                if entry == self.target.entry:
                    code.put(" firstprivate(%s)" % entry.cname)
6875 6876
                    code.put(" lastprivate(%s)" % entry.cname)
                    continue
6877 6878

                if not entry.type.is_pyobject:
6879 6880 6881 6882 6883 6884
                    if lastprivate:
                        private = 'lastprivate'
                    else:
                        private = 'private'

                    code.put(" %s(%s)" % (private, entry.cname))
Mark Florisson's avatar
Mark Florisson committed
6885 6886 6887 6888

        if self.schedule:
            code.put(" schedule(%s)" % self.schedule)

6889
        self.put_num_threads(reduction_codepoint)
6890

6891 6892
        code.putln("")
        code.putln("#endif /* _OPENMP */")
Mark Florisson's avatar
Mark Florisson committed
6893 6894

        code.put("for (%(i)s = 0; %(i)s < %(nsteps)s; %(i)s++)" % fmt_dict)
6895
        code.begin_block() # for loop block
6896

6897
        guard_around_body_codepoint = code.insertion_point()
6898

6899 6900 6901 6902
        # Start if guard block around the body. This may be unnecessary, but
        # at least it doesn't spoil indentation
        code.begin_block()

6903 6904
        code.putln("%(target)s = %(start)s + %(step)s * %(i)s;" % fmt_dict)
        self.initialize_privates_to_nan(code, exclude=self.target.entry)
6905 6906 6907 6908

        if self.is_parallel:
            code.funcstate.start_collecting_temps()

Mark Florisson's avatar
Mark Florisson committed
6909
        self.body.generate_execution_code(code)
6910
        self.trap_parallel_exit(code, should_flush=True)
6911 6912
        self.privatize_temps(code)

6913 6914 6915
        if self.breaking_label_used:
            # Put a guard around the loop body in case return, break or
            # exceptions might be used
6916
            guard_around_body_codepoint.putln("if (%s < 2)" % Naming.parallel_why)
6917

6918
        code.end_block() # end guard around loop body
6919
        code.end_block() # end for loop block
Mark Florisson's avatar
Mark Florisson committed
6920

6921 6922 6923 6924 6925
        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

6926

6927 6928 6929 6930 6931 6932 6933 6934
class CnameDecoratorNode(StatNode):
    """
    This node is for the cname decorator in CythonUtilityCode:

        @cname('the_cname')
        cdef func(...):
            ...

6935 6936
    In case of a cdef class the cname specifies the objstruct_cname.

6937 6938 6939 6940 6941 6942 6943 6944
    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)
6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996

        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)
6997 6998


William Stein's avatar
William Stein committed
6999 7000 7001 7002 7003 7004 7005 7006
#------------------------------------------------------------------------------------
#
#  Runtime support code
#
#------------------------------------------------------------------------------------

utility_function_predeclarations = \
"""
7007
/* inline attribute */
7008
#ifndef CYTHON_INLINE
7009
  #if defined(__GNUC__)
7010
    #define CYTHON_INLINE __inline__
7011
  #elif defined(_MSC_VER)
7012
    #define CYTHON_INLINE __inline
Robert Bradshaw's avatar
Robert Bradshaw committed
7013 7014
  #elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
    #define CYTHON_INLINE inline
7015
  #else
7016
    #define CYTHON_INLINE
7017
  #endif
7018 7019
#endif

7020 7021 7022 7023
/* unused attribute */
#ifndef CYTHON_UNUSED
# if defined(__GNUC__)
#   if !(defined(__cplusplus)) || (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4))
7024
#     define CYTHON_UNUSED __attribute__ ((__unused__))
7025 7026 7027
#   else
#     define CYTHON_UNUSED
#   endif
7028
# elif defined(__ICC) || (defined(__INTEL_COMPILER) && !defined(_MSC_VER))
7029
#   define CYTHON_UNUSED __attribute__ ((__unused__))
7030
# else
7031
#   define CYTHON_UNUSED
7032 7033 7034
# endif
#endif

7035
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*/
7036

Robert Bradshaw's avatar
Robert Bradshaw committed
7037
"""
Robert Bradshaw's avatar
Robert Bradshaw committed
7038 7039 7040 7041

if Options.gcc_branch_hints:
    branch_prediction_macros = \
    """
7042
#ifdef __GNUC__
7043 7044 7045 7046 7047 7048 7049 7050
  /* 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 ... */
7051
#else /* __GNUC__ */
7052 7053
  #define likely(x)   (x)
  #define unlikely(x) (x)
7054
#endif /* __GNUC__ */
Robert Bradshaw's avatar
Robert Bradshaw committed
7055 7056 7057 7058 7059 7060 7061
    """
else:
    branch_prediction_macros = \
    """
#define likely(x)   (x)
#define unlikely(x) (x)
    """
William Stein's avatar
William Stein committed
7062

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

7066 7067
#get_name_interned_predeclaration = \
#"static PyObject *__Pyx_GetName(PyObject *dict, PyObject *name); /*proto*/"
William Stein's avatar
William Stein committed
7068 7069 7070

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

7071 7072
printing_utility_code = UtilityCode(
proto = """
7073
static int __Pyx_Print(PyObject*, PyObject *, int); /*proto*/
7074
#if PY_MAJOR_VERSION >= 3
7075 7076 7077
static PyObject* %s = 0;
static PyObject* %s = 0;
#endif
7078
""" % (Naming.print_function, Naming.print_function_kwargs),
7079 7080 7081 7082 7083 7084
cleanup = """
#if PY_MAJOR_VERSION >= 3
Py_CLEAR(%s);
Py_CLEAR(%s);
#endif
""" % (Naming.print_function, Naming.print_function_kwargs),
7085
impl = r"""
7086
#if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
7087
static PyObject *__Pyx_GetStdout(void) {
7088
    PyObject *f = PySys_GetObject((char *)"stdout");
William Stein's avatar
William Stein committed
7089 7090 7091 7092 7093 7094
    if (!f) {
        PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
    }
    return f;
}

7095
static int __Pyx_Print(PyObject* f, PyObject *arg_tuple, int newline) {
7096 7097
    PyObject* v;
    int i;
7098

7099 7100 7101 7102
    if (!f) {
        if (!(f = __Pyx_GetStdout()))
            return -1;
    }
7103 7104 7105 7106 7107 7108 7109
    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
7110
            return -1;
7111 7112 7113 7114 7115 7116 7117 7118
        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
7119
    }
7120 7121 7122 7123
    if (newline) {
        if (PyFile_WriteString("\n", f) < 0)
            return -1;
        PyFile_SoftSpace(f, 0);
William Stein's avatar
William Stein committed
7124 7125 7126 7127
    }
    return 0;
}

7128
#else /* Python 3 has a print function */
7129

7130
static int __Pyx_Print(PyObject* stream, PyObject *arg_tuple, int newline) {
7131 7132 7133
    PyObject* kwargs = 0;
    PyObject* result = 0;
    PyObject* end_string;
7134
    if (unlikely(!%(PRINT_FUNCTION)s)) {
7135
        %(PRINT_FUNCTION)s = __Pyx_GetAttrString(%(BUILTINS)s, "print");
7136
        if (!%(PRINT_FUNCTION)s)
7137
            return -1;
7138
    }
7139 7140 7141 7142 7143 7144
    if (stream) {
        kwargs = PyDict_New();
        if (unlikely(!kwargs))
            return -1;
        if (unlikely(PyDict_SetItemString(kwargs, "file", stream) < 0))
            goto bad;
7145 7146 7147 7148 7149 7150 7151 7152 7153
        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);
7154
        }
7155 7156
    } else if (!newline) {
        if (unlikely(!%(PRINT_KWARGS)s)) {
7157
            %(PRINT_KWARGS)s = PyDict_New();
7158
            if (unlikely(!%(PRINT_KWARGS)s))
7159
                return -1;
7160 7161
            end_string = PyUnicode_FromStringAndSize(" ", 1);
            if (unlikely(!end_string))
Stefan Behnel's avatar
Stefan Behnel committed
7162
                return -1;
7163 7164
            if (PyDict_SetItemString(%(PRINT_KWARGS)s, "end", end_string) < 0) {
                Py_DECREF(end_string);
Stefan Behnel's avatar
Stefan Behnel committed
7165
                return -1;
7166
            }
7167 7168
            Py_DECREF(end_string);
        }
7169
        kwargs = %(PRINT_KWARGS)s;
7170 7171
    }
    result = PyObject_Call(%(PRINT_FUNCTION)s, arg_tuple, kwargs);
7172
    if (unlikely(kwargs) && (kwargs != %(PRINT_KWARGS)s))
7173
        Py_DECREF(kwargs);
7174
    if (!result)
William Stein's avatar
William Stein committed
7175
        return -1;
7176
    Py_DECREF(result);
William Stein's avatar
William Stein committed
7177
    return 0;
7178
bad:
7179
    if (kwargs != %(PRINT_KWARGS)s)
7180 7181
        Py_XDECREF(kwargs);
    return -1;
William Stein's avatar
William Stein committed
7182
}
7183

7184 7185 7186 7187 7188 7189 7190 7191 7192
#endif
""" % {'BUILTINS'       : Naming.builtins_cname,
       'PRINT_FUNCTION' : Naming.print_function,
       'PRINT_KWARGS'   : Naming.print_function_kwargs}
)


printing_one_utility_code = UtilityCode(
proto = """
7193
static int __Pyx_PrintOne(PyObject* stream, PyObject *o); /*proto*/
7194 7195 7196 7197
""",
impl = r"""
#if PY_MAJOR_VERSION < 3

7198 7199 7200 7201 7202
static int __Pyx_PrintOne(PyObject* f, PyObject *o) {
    if (!f) {
        if (!(f = __Pyx_GetStdout()))
            return -1;
    }
7203 7204 7205 7206 7207 7208 7209 7210 7211
    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;
7212 7213
    /* the line below is just to avoid compiler
     * compiler warnings about unused functions */
7214
    return __Pyx_Print(f, NULL, 0);
7215 7216 7217 7218
}

#else /* Python 3 has a print function */

7219
static int __Pyx_PrintOne(PyObject* stream, PyObject *o) {
7220 7221 7222 7223 7224 7225
    int res;
    PyObject* arg_tuple = PyTuple_New(1);
    if (unlikely(!arg_tuple))
        return -1;
    Py_INCREF(o);
    PyTuple_SET_ITEM(arg_tuple, 0, o);
7226
    res = __Pyx_Print(stream, arg_tuple, 1);
7227 7228 7229 7230
    Py_DECREF(arg_tuple);
    return res;
}

7231
#endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7232 7233
""",
requires=[printing_utility_code])
7234 7235


William Stein's avatar
William Stein committed
7236 7237 7238

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

7239 7240 7241 7242 7243 7244 7245 7246 7247
# 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 = """
7248 7249
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*/
7250 7251
""",
impl = """
7252
static CYTHON_INLINE void __Pyx_ErrRestore(PyObject *type, PyObject *value, PyObject *tb) {
7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266
    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);
}

7267
static CYTHON_INLINE void __Pyx_ErrFetch(PyObject **type, PyObject **value, PyObject **tb) {
7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282
    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
7283

7284 7285
raise_utility_code = UtilityCode(
proto = """
Haoyu Bai's avatar
Haoyu Bai committed
7286
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb, PyObject *cause); /*proto*/
7287 7288
""",
impl = """
7289
#if PY_MAJOR_VERSION < 3
Haoyu Bai's avatar
Haoyu Bai committed
7290 7291
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb, PyObject *cause) {
    /* cause is unused */
William Stein's avatar
William Stein committed
7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309
    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);
    }
7310 7311 7312 7313 7314 7315
    #if PY_VERSION_HEX < 0x02050000
    if (!PyClass_Check(type))
    #else
    if (!PyType_Check(type))
    #endif
    {
William Stein's avatar
William Stein committed
7316 7317 7318
        /* Raising an instance.  The value should be a dummy. */
        if (value != Py_None) {
            PyErr_SetString(PyExc_TypeError,
7319
                "instance exception may not have a separate value");
William Stein's avatar
William Stein committed
7320 7321
            goto raise_error;
        }
7322 7323 7324
        /* Normalize to raise <class>, <instance> */
        Py_DECREF(value);
        value = type;
7325 7326 7327 7328 7329 7330
        #if PY_VERSION_HEX < 0x02050000
            if (PyInstance_Check(type)) {
                type = (PyObject*) ((PyInstanceObject*)type)->in_class;
                Py_INCREF(type);
            }
            else {
7331
                type = 0;
7332 7333 7334 7335 7336
                PyErr_SetString(PyExc_TypeError,
                    "raise: exception must be an old-style class or instance");
                goto raise_error;
            }
        #else
7337
            type = (PyObject*) Py_TYPE(type);
7338 7339 7340 7341 7342 7343 7344
            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
7345
    }
7346

7347
    __Pyx_ErrRestore(type, value, tb);
7348 7349 7350
    return;
raise_error:
    Py_XDECREF(value);
William Stein's avatar
William Stein committed
7351 7352 7353 7354
    Py_XDECREF(type);
    Py_XDECREF(tb);
    return;
}
7355

7356
#else /* Python 3+ */
7357

Haoyu Bai's avatar
Haoyu Bai committed
7358
static void __Pyx_Raise(PyObject *type, PyObject *value, PyObject *tb, PyObject *cause) {
7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382
    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
7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405
    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);
    }

7406 7407 7408 7409
    PyErr_SetObject(type, value);

    if (tb) {
        PyThreadState *tstate = PyThreadState_GET();
7410 7411 7412 7413 7414
        PyObject* tmp_tb = tstate->curexc_traceback;
        if (tb != tmp_tb) {
            Py_INCREF(tb);
            tstate->curexc_traceback = tb;
            Py_XDECREF(tmp_tb);
7415 7416
        }
    }
7417

7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442
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);
7443 7444 7445 7446
    if (unlikely(tstate->curexc_type))
        goto bad;
    #if PY_MAJOR_VERSION >= 3
    if (unlikely(PyException_SetTraceback(local_value, local_tb) < 0))
7447
        goto bad;
7448
    #endif
7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483
    *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*/
""",
7484 7485 7486
# 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.
7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510
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 = """
7511
static CYTHON_INLINE void __Pyx_ExceptionSave(PyObject **type, PyObject **value, PyObject **tb); /*proto*/
7512 7513 7514
static void __Pyx_ExceptionReset(PyObject *type, PyObject *value, PyObject *tb); /*proto*/
""",
impl = """
7515
static CYTHON_INLINE void __Pyx_ExceptionSave(PyObject **type, PyObject **value, PyObject **tb) {
7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537
    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);
}
7538
""")
William Stein's avatar
William Stein committed
7539 7540 7541

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

7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566
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;
}
""")

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

7567 7568
arg_type_test_utility_code = UtilityCode(
proto = """
7569 7570
static int __Pyx_ArgTypeTest(PyObject *obj, PyTypeObject *type, int none_allowed,
    const char *name, int exact); /*proto*/
7571 7572
""",
impl = """
7573 7574 7575
static int __Pyx_ArgTypeTest(PyObject *obj, PyTypeObject *type, int none_allowed,
    const char *name, int exact)
{
William Stein's avatar
William Stein committed
7576 7577 7578 7579
    if (!type) {
        PyErr_Format(PyExc_SystemError, "Missing type object");
        return 0;
    }
Robert Bradshaw's avatar
Robert Bradshaw committed
7580 7581
    if (none_allowed && obj == Py_None) return 1;
    else if (exact) {
7582
        if (Py_TYPE(obj) == type) return 1;
Robert Bradshaw's avatar
Robert Bradshaw committed
7583 7584
    }
    else {
Robert Bradshaw's avatar
Robert Bradshaw committed
7585
        if (PyObject_TypeCheck(obj, type)) return 1;
Robert Bradshaw's avatar
Robert Bradshaw committed
7586
    }
William Stein's avatar
William Stein committed
7587 7588
    PyErr_Format(PyExc_TypeError,
        "Argument '%s' has incorrect type (expected %s, got %s)",
7589
        name, type->tp_name, Py_TYPE(obj)->tp_name);
William Stein's avatar
William Stein committed
7590 7591
    return 0;
}
7592
""")
William Stein's avatar
William Stein committed
7593 7594 7595

#------------------------------------------------------------------------------------
#
7596 7597 7598
#  __Pyx_RaiseArgtupleInvalid raises the correct exception when too
#  many or too few positional arguments were found.  This handles
#  Py_ssize_t formatting correctly.
7599

7600 7601
raise_argtuple_invalid_utility_code = UtilityCode(
proto = """
7602
static void __Pyx_RaiseArgtupleInvalid(const char* func_name, int exact,
7603
    Py_ssize_t num_min, Py_ssize_t num_max, Py_ssize_t num_found); /*proto*/
7604 7605
""",
impl = """
7606
static void __Pyx_RaiseArgtupleInvalid(
7607
    const char* func_name,
7608
    int exact,
7609 7610
    Py_ssize_t num_min,
    Py_ssize_t num_max,
7611
    Py_ssize_t num_found)
William Stein's avatar
William Stein committed
7612
{
7613
    Py_ssize_t num_expected;
7614
    const char *more_or_less;
7615 7616 7617 7618

    if (num_found < num_min) {
        num_expected = num_min;
        more_or_less = "at least";
7619
    } else {
7620
        num_expected = num_max;
7621
        more_or_less = "at most";
7622
    }
7623 7624
    if (exact) {
        more_or_less = "exactly";
7625
    }
Stefan Behnel's avatar
Stefan Behnel committed
7626
    PyErr_Format(PyExc_TypeError,
7627 7628 7629
                 "%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);
7630
}
7631
""")
7632

7633 7634
raise_keyword_required_utility_code = UtilityCode(
proto = """
7635
static CYTHON_INLINE void __Pyx_RaiseKeywordRequired(const char* func_name, PyObject* kw_name); /*proto*/
7636 7637
""",
impl = """
7638
static CYTHON_INLINE void __Pyx_RaiseKeywordRequired(
7639
    const char* func_name,
7640
    PyObject* kw_name)
7641 7642
{
    PyErr_Format(PyExc_TypeError,
7643 7644 7645 7646 7647 7648
        #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
7649
}
7650
""")
7651

7652 7653
raise_double_keywords_utility_code = UtilityCode(
proto = """
7654
static void __Pyx_RaiseDoubleKeywordsError(
7655
    const char* func_name, PyObject* kw_name); /*proto*/
7656 7657
""",
impl = """
7658
static void __Pyx_RaiseDoubleKeywordsError(
7659
    const char* func_name,
7660
    PyObject* kw_name)
7661
{
7662
    PyErr_Format(PyExc_TypeError,
7663 7664 7665 7666 7667 7668
        #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
7669
}
7670
""")
7671

7672 7673
#------------------------------------------------------------------------------------
#
7674 7675 7676
#  __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.
7677

7678 7679
keyword_string_check_utility_code = UtilityCode(
proto = """
7680
static CYTHON_INLINE int __Pyx_CheckKeywordStrings(PyObject *kwdict,
7681
    const char* function_name, int kw_allowed); /*proto*/
7682 7683
""",
impl = """
7684
static CYTHON_INLINE int __Pyx_CheckKeywordStrings(
7685 7686 7687 7688
    PyObject *kwdict,
    const char* function_name,
    int kw_allowed)
{
7689 7690
    PyObject* key = 0;
    Py_ssize_t pos = 0;
7691
    while (PyDict_Next(kwdict, &pos, &key, 0)) {
7692
        #if PY_MAJOR_VERSION < 3
7693
        if (unlikely(!PyString_CheckExact(key)) && unlikely(!PyString_Check(key)))
7694
        #else
7695
        if (unlikely(!PyUnicode_CheckExact(key)) && unlikely(!PyUnicode_Check(key)))
7696
        #endif
7697
            goto invalid_keyword_type;
7698
    }
7699 7700
    if ((!kw_allowed) && unlikely(key))
        goto invalid_keyword;
7701
    return 1;
7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715
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;
7716
}
7717
""")
7718

7719 7720
#------------------------------------------------------------------------------------
#
7721 7722 7723
#  __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.
7724
#
Stefan Behnel's avatar
Stefan Behnel committed
7725 7726
#  Three kinds of errors are checked: 1) non-string keywords, 2)
#  unexpected keywords and 3) overlap with positional arguments.
7727
#
Stefan Behnel's avatar
Stefan Behnel committed
7728 7729 7730 7731 7732
#  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.
7733 7734
#

7735
parse_keywords_utility_code = UtilityCode(
7736
proto = """
7737
static int __Pyx_ParseOptionalKeywords(PyObject *kwds, PyObject **argnames[], \
7738 7739
    PyObject *kwds2, PyObject *values[], Py_ssize_t num_pos_args, \
    const char* function_name); /*proto*/
7740 7741
""",
impl = """
7742
static int __Pyx_ParseOptionalKeywords(
7743
    PyObject *kwds,
Stefan Behnel's avatar
Stefan Behnel committed
7744 7745
    PyObject **argnames[],
    PyObject *kwds2,
7746
    PyObject *values[],
Stefan Behnel's avatar
Stefan Behnel committed
7747
    Py_ssize_t num_pos_args,
7748
    const char* function_name)
7749
{
7750
    PyObject *key = 0, *value = 0;
7751
    Py_ssize_t pos = 0;
7752
    PyObject*** name;
7753
    PyObject*** first_kw_arg = argnames + num_pos_args;
7754

Stefan Behnel's avatar
Stefan Behnel committed
7755
    while (PyDict_Next(kwds, &pos, &key, &value)) {
7756 7757
        name = first_kw_arg;
        while (*name && (**name != key)) name++;
7758
        if (*name) {
7759
            values[name-argnames] = value;
Stefan Behnel's avatar
Stefan Behnel committed
7760
        } else {
7761 7762 7763 7764 7765 7766
            #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;
7767 7768
            } else {
                for (name = first_kw_arg; *name; name++) {
7769
                    #if PY_MAJOR_VERSION >= 3
Stefan Behnel's avatar
Stefan Behnel committed
7770
                    if (PyUnicode_GET_SIZE(**name) == PyUnicode_GET_SIZE(key) &&
7771
                        PyUnicode_Compare(**name, key) == 0) break;
7772
                    #else
7773
                    if (PyString_GET_SIZE(**name) == PyString_GET_SIZE(key) &&
7774
                        _PyString_Eq(**name, key)) break;
7775 7776
                    #endif
                }
7777
                if (*name) {
7778 7779 7780 7781 7782 7783 7784 7785 7786 7787
                    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) &&
7788
                            _PyString_Eq(**name, key)) goto arg_passed_twice;
7789 7790
                        #endif
                    }
Stefan Behnel's avatar
Stefan Behnel committed
7791 7792 7793
                    if (kwds2) {
                        if (unlikely(PyDict_SetItem(kwds2, key, value))) goto bad;
                    } else {
7794
                        goto invalid_keyword;
Stefan Behnel's avatar
Stefan Behnel committed
7795 7796
                    }
                }
7797
            }
7798
        }
7799
    }
7800
    return 0;
7801
arg_passed_twice:
Stefan Behnel's avatar
Stefan Behnel committed
7802 7803
    __Pyx_RaiseDoubleKeywordsError(function_name, **name);
    goto bad;
7804 7805 7806 7807 7808
invalid_keyword_type:
    PyErr_Format(PyExc_TypeError,
        "%s() keywords must be strings", function_name);
    goto bad;
invalid_keyword:
7809
    PyErr_Format(PyExc_TypeError,
7810
    #if PY_MAJOR_VERSION < 3
7811 7812
        "%s() got an unexpected keyword argument '%s'",
        function_name, PyString_AsString(key));
7813
    #else
7814 7815
        "%s() got an unexpected keyword argument '%U'",
        function_name, key);
7816
    #endif
William Stein's avatar
William Stein committed
7817 7818 7819
bad:
    return -1;
}
7820 7821
""",
requires=[raise_double_keywords_utility_code])
William Stein's avatar
William Stein committed
7822 7823 7824

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

7825
traceback_utility_code = UtilityCode(
7826 7827 7828 7829 7830 7831 7832 7833 7834 7835
    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
7836 7837 7838 7839
#include "compile.h"
#include "frameobject.h"
#include "traceback.h"

7840 7841
static void __Pyx_AddTraceback(const char *funcname, int %(CLINENO)s,
                               int %(LINENO)s, const char *%(FILENAME)s) {
William Stein's avatar
William Stein committed
7842 7843 7844 7845 7846
    PyObject *py_srcfile = 0;
    PyObject *py_funcname = 0;
    PyObject *py_globals = 0;
    PyCodeObject *py_code = 0;
    PyFrameObject *py_frame = 0;
7847 7848

    #if PY_MAJOR_VERSION < 3
William Stein's avatar
William Stein committed
7849
    py_srcfile = PyString_FromString(%(FILENAME)s);
7850 7851 7852
    #else
    py_srcfile = PyUnicode_FromString(%(FILENAME)s);
    #endif
William Stein's avatar
William Stein committed
7853
    if (!py_srcfile) goto bad;
Robert Bradshaw's avatar
Robert Bradshaw committed
7854
    if (%(CLINENO)s) {
7855
        #if PY_MAJOR_VERSION < 3
7856
        py_funcname = PyString_FromFormat( "%%s (%%s:%%d)", funcname, %(CFILENAME)s, %(CLINENO)s);
7857
        #else
7858
        py_funcname = PyUnicode_FromFormat( "%%s (%%s:%%d)", funcname, %(CFILENAME)s, %(CLINENO)s);
7859
        #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7860 7861
    }
    else {
7862
        #if PY_MAJOR_VERSION < 3
Robert Bradshaw's avatar
Robert Bradshaw committed
7863
        py_funcname = PyString_FromString(funcname);
7864 7865 7866
        #else
        py_funcname = PyUnicode_FromString(funcname);
        #endif
Robert Bradshaw's avatar
Robert Bradshaw committed
7867
    }
William Stein's avatar
William Stein committed
7868 7869 7870
    if (!py_funcname) goto bad;
    py_globals = PyModule_GetDict(%(GLOBALS)s);
    if (!py_globals) goto bad;
7871
    py_code = __Pyx_PyCode_New(
William Stein's avatar
William Stein committed
7872
        0,            /*int argcount,*/
7873
        0,            /*int kwonlyargcount,*/
William Stein's avatar
William Stein committed
7874 7875 7876
        0,            /*int nlocals,*/
        0,            /*int stacksize,*/
        0,            /*int flags,*/
Robert Bradshaw's avatar
Robert Bradshaw committed
7877
        %(EMPTY_BYTES)s, /*PyObject *code,*/
Stefan Behnel's avatar
Stefan Behnel committed
7878 7879 7880 7881 7882
        %(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
7883 7884 7885
        py_srcfile,   /*PyObject *filename,*/
        py_funcname,  /*PyObject *name,*/
        %(LINENO)s,   /*int firstlineno,*/
Robert Bradshaw's avatar
Robert Bradshaw committed
7886
        %(EMPTY_BYTES)s  /*PyObject *lnotab*/
William Stein's avatar
William Stein committed
7887 7888 7889
    );
    if (!py_code) goto bad;
    py_frame = PyFrame_New(
7890
        PyThreadState_GET(), /*PyThreadState *tstate,*/
William Stein's avatar
William Stein committed
7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906
        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
7907 7908
    'CFILENAME': Naming.cfilenm_cname,
    'CLINENO':  Naming.clineno_cname,
Stefan Behnel's avatar
Stefan Behnel committed
7909 7910
    'GLOBALS': Naming.module_cname,
    'EMPTY_TUPLE' : Naming.empty_tuple,
Robert Bradshaw's avatar
Robert Bradshaw committed
7911
    'EMPTY_BYTES' : Naming.empty_bytes,
7912
})
William Stein's avatar
William Stein committed
7913

7914 7915 7916 7917
#------------------------------------------------------------------------------------

unraisable_exception_utility_code = UtilityCode(
proto = """
7918 7919
static void __Pyx_WriteUnraisable(const char *name, int clineno,
                                  int lineno, const char *filename); /*proto*/
7920 7921
""",
impl = """
7922 7923
static void __Pyx_WriteUnraisable(const char *name, int clineno,
                                  int lineno, const char *filename) {
7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941
    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])
7942

William Stein's avatar
William Stein committed
7943 7944
#------------------------------------------------------------------------------------

7945 7946
set_vtable_utility_code = UtilityCode(
proto = """
7947
static int __Pyx_SetVtable(PyObject *dict, void *vtable); /*proto*/
7948 7949
""",
impl = """
William Stein's avatar
William Stein committed
7950
static int __Pyx_SetVtable(PyObject *dict, void *vtable) {
7951
#if PY_VERSION_HEX >= 0x02070000 && !(PY_MAJOR_VERSION==3&&PY_MINOR_VERSION==0)
7952
    PyObject *ob = PyCapsule_New(vtable, 0, 0);
7953 7954
#else
    PyObject *ob = PyCObject_FromVoidPtr(vtable, 0);
7955 7956
#endif
    if (!ob)
William Stein's avatar
William Stein committed
7957
        goto bad;
7958
    if (PyDict_SetItemString(dict, "__pyx_vtable__", ob) < 0)
William Stein's avatar
William Stein committed
7959
        goto bad;
7960 7961
    Py_DECREF(ob);
    return 0;
William Stein's avatar
William Stein committed
7962
bad:
7963 7964
    Py_XDECREF(ob);
    return -1;
William Stein's avatar
William Stein committed
7965
}
7966
""")
William Stein's avatar
William Stein committed
7967 7968 7969

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

7970 7971
get_vtable_utility_code = UtilityCode(
proto = """
7972
static void* __Pyx_GetVtable(PyObject *dict); /*proto*/
7973 7974
""",
impl = r"""
7975 7976
static void* __Pyx_GetVtable(PyObject *dict) {
    void* ptr;
7977 7978
    PyObject *ob = PyMapping_GetItemString(dict, (char *)"__pyx_vtable__");
    if (!ob)
William Stein's avatar
William Stein committed
7979
        goto bad;
7980
#if PY_VERSION_HEX >= 0x02070000 && !(PY_MAJOR_VERSION==3&&PY_MINOR_VERSION==0)
7981
    ptr = PyCapsule_GetPointer(ob, 0);
7982
#else
7983
    ptr = PyCObject_AsVoidPtr(ob);
7984
#endif
7985 7986
    if (!ptr && !PyErr_Occurred())
        PyErr_SetString(PyExc_RuntimeError, "invalid vtable found for imported type");
7987
    Py_DECREF(ob);
7988
    return ptr;
William Stein's avatar
William Stein committed
7989
bad:
7990
    Py_XDECREF(ob);
7991
    return NULL;
William Stein's avatar
William Stein committed
7992
}
7993
""")
William Stein's avatar
William Stein committed
7994 7995 7996

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

7997 7998
init_string_tab_utility_code = UtilityCode(
proto = """
7999
static int __Pyx_InitStrings(__Pyx_StringTabEntry *t); /*proto*/
8000 8001
""",
impl = """
William Stein's avatar
William Stein committed
8002 8003
static int __Pyx_InitStrings(__Pyx_StringTabEntry *t) {
    while (t->p) {
8004
        #if PY_MAJOR_VERSION < 3
8005
        if (t->is_unicode) {
8006
            *t->p = PyUnicode_DecodeUTF8(t->s, t->n - 1, NULL);
8007 8008
        } else if (t->intern) {
            *t->p = PyString_InternFromString(t->s);
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
8009 8010
        } else {
            *t->p = PyString_FromStringAndSize(t->s, t->n - 1);
Stefan Behnel's avatar
Stefan Behnel committed
8011
        }
8012
        #else  /* Python 3+ has unicode identifiers */
8013 8014 8015 8016 8017 8018 8019 8020
        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
8021 8022
        } else {
            *t->p = PyBytes_FromStringAndSize(t->s, t->n - 1);
Stefan Behnel's avatar
Stefan Behnel committed
8023
        }
8024
        #endif
William Stein's avatar
William Stein committed
8025 8026 8027 8028 8029 8030
        if (!*t->p)
            return -1;
        ++t;
    }
    return 0;
}
8031
""")
William Stein's avatar
William Stein committed
8032 8033

#------------------------------------------------------------------------------------
8034

Stefan Behnel's avatar
Stefan Behnel committed
8035
force_init_threads_utility_code = UtilityCode(
8036 8037
proto="""
#ifndef __PYX_FORCE_INIT_THREADS
Robert Bradshaw's avatar
Robert Bradshaw committed
8038
  #define __PYX_FORCE_INIT_THREADS 0
8039 8040 8041
#endif
""")

8042 8043 8044 8045
init_threads = UtilityCode(
    init="PyEval_InitThreads();\n",
)

8046
#------------------------------------------------------------------------------------
Robert Bradshaw's avatar
Robert Bradshaw committed
8047

8048 8049
# Note that cPython ignores PyTrace_EXCEPTION,
# but maybe some other profilers don't.
Robert Bradshaw's avatar
Robert Bradshaw committed
8050

8051 8052
profile_utility_code = UtilityCode(proto="""
#ifndef CYTHON_PROFILE
8053
  #define CYTHON_PROFILE 1
8054 8055
#endif

8056
#ifndef CYTHON_PROFILE_REUSE_FRAME
8057
  #define CYTHON_PROFILE_REUSE_FRAME 0
8058
#endif
Robert Bradshaw's avatar
Robert Bradshaw committed
8059

8060
#if CYTHON_PROFILE
Robert Bradshaw's avatar
Robert Bradshaw committed
8061

8062 8063 8064
  #include "compile.h"
  #include "frameobject.h"
  #include "traceback.h"
8065

8066 8067 8068 8069 8070 8071 8072
  #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
8073

8074 8075 8076
  #define __Pyx_TraceDeclarations                                  \\
  static PyCodeObject *%(FRAME_CODE)s = NULL;                      \\
  CYTHON_FRAME_MODIFIER PyFrameObject *%(FRAME)s = NULL;           \\
8077
  int __Pyx_use_tracing = 0;
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

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

8104
#else
Robert Bradshaw's avatar
Robert Bradshaw committed
8105

8106
  #define __Pyx_TraceDeclarations
8107 8108 8109
  #define __Pyx_TraceCall(funcname, srcfile, firstlineno)
  #define __Pyx_TraceException()
  #define __Pyx_TraceReturn(result)
Robert Bradshaw's avatar
Robert Bradshaw committed
8110

8111
#endif /* CYTHON_PROFILE */
8112
"""
Robert Bradshaw's avatar
Robert Bradshaw committed
8113 8114 8115 8116 8117 8118
% {
    "FRAME": Naming.frame_cname,
    "FRAME_CODE": Naming.frame_code_cname,
},
impl = """

8119
#if CYTHON_PROFILE
Robert Bradshaw's avatar
Robert Bradshaw committed
8120 8121 8122 8123 8124 8125

static int __Pyx_TraceSetupAndCall(PyCodeObject** code,
                                   PyFrameObject** frame,
                                   const char *funcname,
                                   const char *srcfile,
                                   int firstlineno) {
8126
    if (*frame == NULL || !CYTHON_PROFILE_REUSE_FRAME) {
Robert Bradshaw's avatar
Robert Bradshaw committed
8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178
        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*/
    );

8179
bad:
Robert Bradshaw's avatar
Robert Bradshaw committed
8180 8181
    Py_XDECREF(py_srcfile);
    Py_XDECREF(py_funcname);
8182

Robert Bradshaw's avatar
Robert Bradshaw committed
8183 8184 8185
    return py_code;
}

8186
#endif /* CYTHON_PROFILE */
Robert Bradshaw's avatar
Robert Bradshaw committed
8187 8188 8189 8190 8191
""" % {
    'EMPTY_TUPLE' : Naming.empty_tuple,
    'EMPTY_BYTES' : Naming.empty_bytes,
    "MODULE": Naming.module_cname,
})
8192 8193 8194

################ Utility code for cython.parallel stuff ################

8195 8196 8197
invalid_values_utility_code = UtilityCode(
proto="""\
#include <string.h>
8198

8199
void __pyx_init_nan(void);
8200

8201 8202 8203 8204 8205 8206
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
8207
   a quiet NaN. */
8208 8209
    memset(&%(PYX_NAN)s, 0xFF, sizeof(%(PYX_NAN)s));
""" % vars(Naming))
8210