Nodes.py 351 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
from __future__ import absolute_import

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

15
import sys, os, copy
Stefan Behnel's avatar
Stefan Behnel committed
16
from itertools import chain
Robert Bradshaw's avatar
Robert Bradshaw committed
17

18 19 20 21 22
if sys.version_info[0] >= 3:
    _py_int_types = int
else:
    _py_int_types = (int, long)

23 24 25 26 27 28 29
from . import Builtin
from .Errors import error, warning, InternalError, CompileError
from . import Naming
from . import PyrexTypes
from . import TypeSlots
from .PyrexTypes import py_object_type, error_type
from .Symtab import (ModuleScope, LocalScope, ClosureScope,
30
    StructOrUnionScope, PyClassScope, CppClassScope, TemplateScope)
31
from .Code import UtilityCode
32
from .StringEncoding import EncodedString
33
from . import Future
34 35
from . import Options
from . import DebugFlags
36
from ..Utils import add_metaclass
William Stein's avatar
William Stein committed
37

Gary Furnish's avatar
Gary Furnish committed
38
absolute_path_length = 0
39

40

41 42 43
def relative_position(pos):
    """
    We embed the relative filename in the generated C file, since we
Stefan Behnel's avatar
Stefan Behnel committed
44
    don't want to have to regenerate and compile all the source code
45 46
    whenever the Python install directory moves (which could happen,
    e.g,. when distributing binaries.)
47

48 49 50 51 52 53 54 55 56
    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
57 58
    global absolute_path_length
    if absolute_path_length==0:
59
        absolute_path_length = len(os.path.abspath(os.getcwd()))
60
    return (pos[0].get_filenametable_entry()[absolute_path_length+1:], pos[1])
61 62 63 64

def embed_position(pos, docstring):
    if not Options.embed_pos_in_docstring:
        return docstring
65
    pos_line = u'File: %s (starting at line %s)' % relative_position(pos)
66 67
    if docstring is None:
        # unicode string
68
        return EncodedString(pos_line)
69 70 71 72 73 74

    # 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:
Stefan Behnel's avatar
Stefan Behnel committed
75
            pos_line.encode(encoding)
76 77 78 79 80
        except UnicodeEncodeError:
            encoding = None

    if not docstring:
        # reuse the string encoding of the original docstring
81
        doc = EncodedString(pos_line)
82
    else:
83
        doc = EncodedString(pos_line + u'\n' + docstring)
84 85
    doc.encoding = encoding
    return doc
86

87

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
def _analyse_signature_annotation(annotation, env):
    base_type = None
    explicit_pytype = explicit_ctype = False
    if annotation.is_dict_literal:
        for name, value in annotation.key_value_pairs:
            if not name.is_string_literal:
                continue
            if name.value in ('type', b'type'):
                explicit_pytype = True
                if not explicit_ctype:
                    annotation = value
            elif name.value in ('ctype', b'ctype'):
                explicit_ctype = True
                annotation = value
        if explicit_pytype and explicit_ctype:
            warning(annotation.pos, "Duplicate type declarations found in signature annotation")
    arg_type = annotation.analyse_as_type(env)
    if arg_type is not None:
        if explicit_pytype and not explicit_ctype and not arg_type.is_pyobject:
            warning(annotation.pos,
                    "Python type declaration in signature annotation does not refer to a Python type")
        base_type = CAnalysedBaseTypeNode(
            annotation.pos, type=arg_type, is_arg=True)
    else:
        warning(annotation.pos, "Unknown type declaration found in signature annotation")
    return base_type, arg_type


116
def write_func_call(func, codewriter_class):
117
    def f(*args, **kwds):
118
        if len(args) > 1 and isinstance(args[1], codewriter_class):
Robert Bradshaw's avatar
Robert Bradshaw committed
119 120
            # here we annotate the code with this function call
            # but only if new code is generated
121
            node, code = args[:2]
Robert Bradshaw's avatar
Robert Bradshaw committed
122
            marker = '                    /* %s -> %s.%s %s */' % (
Stefan Behnel's avatar
Stefan Behnel committed
123 124 125 126
                ' ' * code.call_level,
                node.__class__.__name__,
                func.__name__,
                node.pos[1:])
Robert Bradshaw's avatar
Robert Bradshaw committed
127 128 129 130 131 132 133
            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():
134 135
                # no code written => undo writing marker
                code.buffer.stream.truncate(pristine)
Robert Bradshaw's avatar
Robert Bradshaw committed
136
            else:
137
                marker = marker.replace('->', '<-', 1)
Robert Bradshaw's avatar
Robert Bradshaw committed
138 139 140 141
                code.putln(marker)
            return res
        else:
            return func(*args, **kwds)
142 143
    return f

144

145 146
class VerboseCodeWriter(type):
    # Set this as a metaclass to trace function calls in code.
147
    # This slows down code generation and makes much larger files.
148
    def __new__(cls, name, bases, attrs):
149
        from types import FunctionType
150
        from .Code import CCodeWriter
151 152 153
        attrs = dict(attrs)
        for mname, m in attrs.items():
            if isinstance(m, FunctionType):
154
                attrs[mname] = write_func_call(m, CCodeWriter)
155 156 157
        return super(VerboseCodeWriter, cls).__new__(cls, name, bases, attrs)


158 159 160 161 162 163 164 165 166 167 168 169 170
class CheckAnalysers(type):
    """Metaclass to check that type analysis functions return a node.
    """
    methods = set(['analyse_types',
                   'analyse_expressions',
                   'analyse_target_types'])

    def __new__(cls, name, bases, attrs):
        from types import FunctionType
        def check(name, func):
            def call(*args, **kwargs):
                retval = func(*args, **kwargs)
                if retval is None:
171
                    print('%s %s %s' % (name, args, kwargs))
172 173 174 175 176 177 178 179 180 181
                return retval
            return call

        attrs = dict(attrs)
        for mname, m in attrs.items():
            if isinstance(m, FunctionType) and mname in cls.methods:
                attrs[mname] = check(mname, m)
        return super(CheckAnalysers, cls).__new__(cls, name, bases, attrs)


182 183 184 185 186 187 188 189
def _with_metaclass(cls):
    if DebugFlags.debug_trace_code_generation:
        return add_metaclass(VerboseCodeWriter)(cls)
    #return add_metaclass(CheckAnalysers)(cls)
    return cls


@_with_metaclass
Stefan Behnel's avatar
Stefan Behnel committed
190
class Node(object):
William Stein's avatar
William Stein committed
191 192 193
    #  pos         (string, int, int)   Source file position
    #  is_name     boolean              Is a NameNode
    #  is_literal  boolean              Is a ConstNode
194

William Stein's avatar
William Stein committed
195
    is_name = 0
196
    is_none = 0
197
    is_nonecheck = 0
William Stein's avatar
William Stein committed
198
    is_literal = 0
199
    is_terminator = 0
200
    temps = None
201

Stefan Behnel's avatar
Stefan Behnel committed
202
    # All descendants should set child_attrs to a list of the attributes
203 204
    # containing nodes considered "children" in the tree. Each such attribute
    # can either contain a single node or a list of nodes. See Visitor.py.
205
    child_attrs = None
206

207 208
    cf_state = None

209 210 211 212 213
    # This may be an additional (or 'actual') type that will be checked when
    # this node is coerced to another type. This could be useful to set when
    # the actual type to which it can coerce is known, but you want to leave
    # the type a py_object_type
    coercion_type = None
214

William Stein's avatar
William Stein committed
215 216 217
    def __init__(self, pos, **kw):
        self.pos = pos
        self.__dict__.update(kw)
218

219 220
    gil_message = "Operation"

221
    nogil_check = None
222

223
    def gil_error(self, env=None):
224
        error(self.pos, "%s not allowed without gil" % self.gil_message)
225

Robert Bradshaw's avatar
Robert Bradshaw committed
226
    cpp_message = "Operation"
227

Robert Bradshaw's avatar
Robert Bradshaw committed
228 229 230 231 232 233
    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)
234

235 236 237 238
    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
Stefan Behnel's avatar
Stefan Behnel committed
239
           to hold multiple children directly; the list is not treated as a separate
240
           level in the tree."""
241 242 243
        result = copy.copy(self)
        for attrname in result.child_attrs:
            value = getattr(result, attrname)
244
            if isinstance(value, list):
245
                setattr(result, attrname, [x for x in value])
246
        return result
247 248


William Stein's avatar
William Stein committed
249
    #
250
    #  There are 3 phases of parse tree processing, applied in order to
William Stein's avatar
William Stein committed
251 252
    #  all the statements in a given scope-block:
    #
253
    #  (0) analyse_declarations
William Stein's avatar
William Stein committed
254 255 256 257
    #        Make symbol table entries for all declarations at the current
    #        level, both explicit (def, cdef, etc.) and implicit (assignment
    #        to an otherwise undeclared name).
    #
258
    #  (1) analyse_expressions
William Stein's avatar
William Stein committed
259 260
    #         Determine the result types of expressions and fill in the
    #         'type' attribute of each ExprNode. Insert coercion nodes into the
261
    #         tree where needed to convert to and from Python objects.
William Stein's avatar
William Stein committed
262 263 264 265
    #         Allocate temporary locals for intermediate results. Fill
    #         in the 'result_code' attribute of each ExprNode with a C code
    #         fragment.
    #
266
    #  (2) generate_code
William Stein's avatar
William Stein committed
267 268 269 270
    #         Emit C code for all declarations, statements and expressions.
    #         Recursively applies the 3 processing phases to the bodies of
    #         functions.
    #
271

William Stein's avatar
William Stein committed
272 273
    def analyse_declarations(self, env):
        pass
274

William Stein's avatar
William Stein committed
275 276 277
    def analyse_expressions(self, env):
        raise InternalError("analyse_expressions not implemented for %s" % \
            self.__class__.__name__)
278

William Stein's avatar
William Stein committed
279 280 281
    def generate_code(self, code):
        raise InternalError("generate_code not implemented for %s" % \
            self.__class__.__name__)
282

283 284 285 286
    def annotate(self, code):
        # mro does the wrong thing
        if isinstance(self, BlockNode):
            self.body.annotate(code)
287

288 289 290 291
    def end_pos(self):
        try:
            return self._end_pos
        except AttributeError:
Stefan Behnel's avatar
Stefan Behnel committed
292
            pos = self.pos
293 294 295
            if not self.child_attrs:
                self._end_pos = pos
                return pos
296
            for attr in self.child_attrs:
297
                child = getattr(self, attr)
298
                # Sometimes lists, sometimes nodes
299 300 301
                if child is None:
                    pass
                elif isinstance(child, list):
Stefan Behnel's avatar
Stefan Behnel committed
302 303
                    for c in child:
                        pos = max(pos, c.end_pos())
304
                else:
Stefan Behnel's avatar
Stefan Behnel committed
305 306 307
                    pos = max(pos, child.end_pos())
            self._end_pos = pos
            return pos
William Stein's avatar
William Stein committed
308

309
    def dump(self, level=0, filter_out=("pos",), cutoff=100, encountered=None):
310 311
        """Debug helper method that returns a recursive string representation of this node.
        """
312 313
        if cutoff == 0:
            return "<...nesting level cutoff...>"
314 315 316
        if encountered is None:
            encountered = set()
        if id(self) in encountered:
317
            return "<%s (0x%x) -- already output>" % (self.__class__.__name__, id(self))
318
        encountered.add(id(self))
319

320 321
        def dump_child(x, level):
            if isinstance(x, Node):
322
                return x.dump(level, filter_out, cutoff-1, encountered)
323
            elif isinstance(x, list):
Robert Bradshaw's avatar
Robert Bradshaw committed
324
                return "[%s]" % ", ".join([dump_child(item, level) for item in x])
325 326
            else:
                return repr(x)
327

328
        attrs = [(key, value) for key, value in self.__dict__.items() if key not in filter_out]
329
        if len(attrs) == 0:
330
            return "<%s (0x%x)>" % (self.__class__.__name__, id(self))
331 332
        else:
            indent = "  " * level
333
            res = "<%s (0x%x)\n" % (self.__class__.__name__, id(self))
334 335 336 337
            for key, value in attrs:
                res += "%s  %s: %s\n" % (indent, key, dump_child(value, level + 1))
            res += "%s>" % indent
            return res
338

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
    def dump_pos(self, mark_column=False, marker='(#)'):
        """Debug helper method that returns the source code context of this node as a string.
        """
        if not self.pos:
            return u''
        source_desc, line, col = self.pos
        contents = source_desc.get_lines(encoding='ASCII',
                                         error_handling='ignore')
        # line numbers start at 1
        lines = contents[max(0,line-3):line]
        current = lines[-1]
        if mark_column:
            current = current[:col] + marker + current[col:]
        lines[-1] = current.rstrip() + u'             # <<<<<<<<<<<<<<\n'
        lines += contents[line:line+2]
        return u'"%s":%d:%d\n%s\n' % (
            source_desc.get_escaped_description(), line, col, u''.join(lines))

357 358 359 360 361 362 363 364 365 366 367 368 369 370
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
371

372 373 374
    def analyse_expressions(self, env):
        old = env.directives
        env.directives = self.directives
375
        self.body = self.body.analyse_expressions(env)
376
        env.directives = old
377
        return self
378 379 380 381 382 383 384 385

    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
386

387 388 389 390 391
    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
392

393 394 395 396 397
    def annotate(self, code):
        old = code.globalstate.directives
        code.globalstate.directives = self.directives
        self.body.annotate(code)
        code.globalstate.directives = old
398

Stefan Behnel's avatar
Stefan Behnel committed
399
class BlockNode(object):
William Stein's avatar
William Stein committed
400 401
    #  Mixin class for nodes representing a declaration block.

402
    def generate_cached_builtins_decls(self, env, code):
403
        entries = env.global_scope().undeclared_cached_builtins
404
        for entry in entries:
405
            code.globalstate.add_cached_builtin_decl(entry)
406
        del entries[:]
407 408 409 410

    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
411 412 413

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

415
    child_attrs = ["stats"]
416

417
    @staticmethod
418 419
    def create_analysed(pos, env, *args, **kw):
        node = StatListNode(pos, *args, **kw)
420
        return node  # No node-specific analysis needed
421

William Stein's avatar
William Stein committed
422 423
    def analyse_declarations(self, env):
        #print "StatListNode.analyse_declarations" ###
424
        for stat in self.stats:
William Stein's avatar
William Stein committed
425
            stat.analyse_declarations(env)
426

William Stein's avatar
William Stein committed
427 428
    def analyse_expressions(self, env):
        #print "StatListNode.analyse_expressions" ###
429 430 431
        self.stats = [ stat.analyse_expressions(env)
                       for stat in self.stats ]
        return self
432

433
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
434 435
        #print "StatListNode.generate_function_definitions" ###
        for stat in self.stats:
436
            stat.generate_function_definitions(env, code)
437

William Stein's avatar
William Stein committed
438 439 440 441 442
    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)
443

444 445 446
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)
447

William Stein's avatar
William Stein committed
448 449 450 451 452 453 454 455 456 457 458 459 460

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

462
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
463
        pass
464

William Stein's avatar
William Stein committed
465 466 467 468 469 470 471 472
    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
473

474
    child_attrs = ["body"]
475

William Stein's avatar
William Stein committed
476 477 478 479 480 481 482
    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
483

William Stein's avatar
William Stein committed
484
    def analyse_expressions(self, env):
485
        return self
486

William Stein's avatar
William Stein committed
487 488
    def generate_execution_code(self, code):
        pass
489 490 491

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

William Stein's avatar
William Stein committed
493 494 495 496 497 498 499 500

class CDeclaratorNode(Node):
    # Part of a C declaration.
    #
    # Processing during analyse_declarations phase:
    #
    #   analyse
    #      Returns (name, type) pair where name is the
501
    #      CNameDeclaratorNode of the name being declared
William Stein's avatar
William Stein committed
502 503
    #      and type is the type it is being declared as.
    #
504
    #  calling_convention  string   Calling convention of CFuncDeclaratorNode
505
    #                               for which this is a base
506

507 508
    child_attrs = []

509 510
    calling_convention = ""

511 512 513
    def analyse_templates(self):
        # Only C++ functions have templates.
        return None
William Stein's avatar
William Stein committed
514 515

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

Robert Bradshaw's avatar
Robert Bradshaw committed
520
    child_attrs = ['default']
521

522
    default = None
523

524 525
    def analyse(self, base_type, env, nonempty = 0):
        if nonempty and self.name == '':
526
            # May have mistaken the name for the type.
527
            if base_type.is_ptr or base_type.is_array or base_type.is_buffer:
528
                error(self.pos, "Missing argument name")
529 530
            elif base_type.is_void:
                error(self.pos, "Use spam() rather than spam(void) to declare a function with no arguments.")
531 532 533
            else:
                self.name = base_type.declaration_code("", for_display=1, pyrex=1)
                base_type = py_object_type
534 535 536 537

        if base_type.is_fused and env.fused_to_specific:
            base_type = base_type.specialize(env.fused_to_specific)

538
        self.type = base_type
William Stein's avatar
William Stein committed
539
        return self, base_type
540

William Stein's avatar
William Stein committed
541 542
class CPtrDeclaratorNode(CDeclaratorNode):
    # base     CDeclaratorNode
543

544 545
    child_attrs = ["base"]

546
    def analyse(self, base_type, env, nonempty = 0):
William Stein's avatar
William Stein committed
547 548 549 550
        if base_type.is_pyobject:
            error(self.pos,
                "Pointer base type cannot be a Python object")
        ptr_type = PyrexTypes.c_ptr_type(base_type)
551
        return self.base.analyse(ptr_type, env, nonempty = nonempty)
Danilo Freitas's avatar
Danilo Freitas committed
552 553 554 555 556 557 558 559 560 561

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")
562
        ref_type = PyrexTypes.c_ref_type(base_type)
Danilo Freitas's avatar
Danilo Freitas committed
563 564
        return self.base.analyse(ref_type, env, nonempty = nonempty)

William Stein's avatar
William Stein committed
565 566 567
class CArrayDeclaratorNode(CDeclaratorNode):
    # base        CDeclaratorNode
    # dimension   ExprNode
568 569

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

571
    def analyse(self, base_type, env, nonempty = 0):
572
        if (base_type.is_cpp_class and base_type.is_template_type()) or base_type.is_cfunction:
573
            from .ExprNodes import TupleNode
Robert Bradshaw's avatar
Robert Bradshaw committed
574 575 576 577 578 579 580
            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)
581 582 583 584
                error(args[ix].pos, "Template parameter not a type")
                base_type = error_type
            else:
                base_type = base_type.specialize_here(self.pos, values)
Robert Bradshaw's avatar
Robert Bradshaw committed
585
            return self.base.analyse(base_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
586
        if self.dimension:
587
            self.dimension = self.dimension.analyse_const_expression(env)
William Stein's avatar
William Stein committed
588 589
            if not self.dimension.type.is_int:
                error(self.dimension.pos, "Array dimension not integer")
590 591 592 593 594 595 596
            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
597 598 599 600 601 602 603 604
        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")
605 606 607
        if base_type.is_cfunction:
            error(self.pos,
                "Array element cannot be a function")
William Stein's avatar
William Stein committed
608
        array_type = PyrexTypes.c_array_type(base_type, size)
609
        return self.base.analyse(array_type, env, nonempty = nonempty)
William Stein's avatar
William Stein committed
610 611 612 613 614


class CFuncDeclaratorNode(CDeclaratorNode):
    # base             CDeclaratorNode
    # args             [CArgDeclNode]
615
    # templates        [TemplatePlaceholderType]
William Stein's avatar
William Stein committed
616 617 618
    # has_varargs      boolean
    # exception_value  ConstNode
    # exception_check  boolean    True if PyErr_Occurred check needed
619 620
    # nogil            boolean    Can be called without gil
    # with_gil         boolean    Acquire gil around function body
621
    # is_const_method  boolean    Whether this is a const method
622

623 624
    child_attrs = ["base", "args", "exception_value"]

625
    overridable = 0
626
    optional_arg_count = 0
627
    is_const_method = 0
628 629 630 631
    templates = None

    def analyse_templates(self):
        if isinstance(self.base, CArrayDeclaratorNode):
632
            from .ExprNodes import TupleNode, NameNode
633 634 635 636 637 638 639
            template_node = self.base.dimension
            if isinstance(template_node, TupleNode):
                template_nodes = template_node.args
            elif isinstance(template_node, NameNode):
                template_nodes = [template_node]
            else:
                error(template_node.pos, "Template arguments must be a list of names")
640
                return None
641 642 643 644 645 646 647 648 649 650
            self.templates = []
            for template in template_nodes:
                if isinstance(template, NameNode):
                    self.templates.append(PyrexTypes.TemplatePlaceholderType(template.name))
                else:
                    error(template.pos, "Template arguments must be a list of names")
            self.base = self.base.base
            return self.templates
        else:
            return None
William Stein's avatar
William Stein committed
651

652
    def analyse(self, return_type, env, nonempty = 0, directive_locals = {}):
653 654
        if nonempty:
            nonempty -= 1
William Stein's avatar
William Stein committed
655
        func_type_args = []
656
        for i, arg_node in enumerate(self.args):
657
            name_declarator, type = arg_node.analyse(
Robert Bradshaw's avatar
Robert Bradshaw committed
658
                env, nonempty=nonempty, is_self_arg=(i == 0 and env.is_c_class_scope and 'staticmethod' not in env.directives))
William Stein's avatar
William Stein committed
659
            name = name_declarator.name
660 661 662 663 664
            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
665
                elif (type is not PyrexTypes.py_object_type
666 667 668 669 670
                      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
671
            if name_declarator.cname:
672
                error(self.pos,
William Stein's avatar
William Stein committed
673
                    "Function argument cannot have C name specification")
674 675 676
            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
677 678 679 680 681
            # 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
682
                error(arg_node.pos, "Use spam() rather than spam(void) to declare a function with no arguments.")
William Stein's avatar
William Stein committed
683 684 685
            func_type_args.append(
                PyrexTypes.CFuncTypeArg(name, type, arg_node.pos))
            if arg_node.default:
686
                self.optional_arg_count += 1
687 688
            elif self.optional_arg_count:
                error(self.pos, "Non-default argument follows default argument")
689

William Stein's avatar
William Stein committed
690 691
        exc_val = None
        exc_check = 0
692
        if self.exception_check == '+':
693
            env.add_include_file('ios')         # for std::ios_base::failure
694
            env.add_include_file('new')         # for std::bad_alloc
695
            env.add_include_file('stdexcept')
696
            env.add_include_file('typeinfo')    # for std::bad_cast
697 698 699 700 701
        if (return_type.is_pyobject
                and (self.exception_value or self.exception_check)
                and self.exception_check != '+'):
            error(self.pos,
                "Exception clause not allowed for function returning Python object")
William Stein's avatar
William Stein committed
702 703
        else:
            if self.exception_value:
704
                self.exception_value = self.exception_value.analyse_const_expression(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
705 706
                if self.exception_check == '+':
                    exc_val_type = self.exception_value.type
707 708 709 710 711
                    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 not exc_val_type.args)):
Robert Bradshaw's avatar
Robert Bradshaw committed
712
                        error(self.exception_value.pos,
713
                              "Exception value must be a Python exception or cdef function with no arguments.")
714
                    exc_val = self.exception_value
Robert Bradshaw's avatar
Robert Bradshaw committed
715
                else:
716 717 718 719 720 721 722 723 724 725
                    self.exception_value = self.exception_value.coerce_to(
                        return_type, env).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
726
            exc_check = self.exception_check
727 728 729
        if return_type.is_cfunction:
            error(self.pos,
                "Function cannot return a function")
William Stein's avatar
William Stein committed
730
        func_type = PyrexTypes.CFuncType(
731
            return_type, func_type_args, self.has_varargs,
732
            optional_arg_count = self.optional_arg_count,
733
            exception_value = exc_val, exception_check = exc_check,
734
            calling_convention = self.base.calling_convention,
735
            nogil = self.nogil, with_gil = self.with_gil, is_overridable = self.overridable,
736
            is_const_method = self.is_const_method,
737
            templates = self.templates)
738

739
        if self.optional_arg_count:
740 741 742 743 744 745 746 747 748 749 750
            if func_type.is_fused:
                # This is a bit of a hack... When we need to create specialized CFuncTypes
                # on the fly because the cdef is defined in a pxd, we need to declare the specialized optional arg
                # struct
                def declare_opt_arg_struct(func_type, fused_cname):
                    self.declare_optional_arg_struct(func_type, env, fused_cname)

                func_type.declare_opt_arg_struct = declare_opt_arg_struct
            else:
                self.declare_optional_arg_struct(func_type, env)

751 752 753 754 755 756 757
        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
758 759
        return self.base.analyse(func_type, env)

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
    def declare_optional_arg_struct(self, func_type, env, fused_cname=None):
        """
        Declares the optional argument struct (the struct used to hold the
        values for optional arguments). For fused cdef functions, this is
        deferred as analyse_declarations is called only once (on the fused
        cdef function).
        """
        scope = StructOrUnionScope()
        arg_count_member = '%sn' % Naming.pyrex_prefix
        scope.declare_var(arg_count_member, PyrexTypes.c_int_type, self.pos)

        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)

        struct_cname = env.mangle(Naming.opt_arg_prefix, self.base.name)

        if fused_cname is not None:
            struct_cname = PyrexTypes.get_fused_cname(fused_cname, struct_cname)

        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)

        op_args_struct.defined_in_pxd = 1
        op_args_struct.used = 1

        func_type.op_arg_struct = PyrexTypes.c_ptr_type(op_args_struct.type)

William Stein's avatar
William Stein committed
792

793 794 795 796 797 798 799 800 801 802 803 804 805
class CConstDeclaratorNode(CDeclaratorNode):
    # base     CDeclaratorNode

    child_attrs = ["base"]

    def analyse(self, base_type, env, nonempty = 0):
        if base_type.is_pyobject:
            error(self.pos,
                  "Const base type cannot be a Python object")
        const = PyrexTypes.c_const_type(base_type)
        return self.base.analyse(const, env, nonempty = nonempty)


William Stein's avatar
William Stein committed
806 807 808 809 810 811
class CArgDeclNode(Node):
    # Item in a function declaration argument list.
    #
    # base_type      CBaseTypeNode
    # declarator     CDeclaratorNode
    # not_none       boolean            Tagged with 'not None'
812 813
    # or_none        boolean            Tagged with 'or None'
    # accept_none    boolean            Resolved boolean for not_none/or_none
William Stein's avatar
William Stein committed
814
    # default        ExprNode or None
815
    # default_value  PyObjectConst      constant for default value
816
    # annotation     ExprNode or None   Py3 function arg annotation
William Stein's avatar
William Stein committed
817
    # is_self_arg    boolean            Is the "self" arg of an extension type method
818
    # is_type_arg    boolean            Is the "class" arg of an extension type classmethod
819
    # is_kw_only     boolean            Is a keyword-only argument
820
    # is_dynamic     boolean            Non-literal arg stored inside CyFunction
821

822
    child_attrs = ["base_type", "declarator", "default", "annotation"]
823

William Stein's avatar
William Stein committed
824
    is_self_arg = 0
825
    is_type_arg = 0
826
    is_generic = 1
827 828 829
    kw_only = 0
    not_none = 0
    or_none = 0
830 831
    type = None
    name_declarator = None
832
    default_value = None
833
    annotation = None
834
    is_dynamic = 0
835

836 837 838
    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
839
        if self.type is None:
Stefan Behnel's avatar
Stefan Behnel committed
840
            # The parser may misinterpret names as types. We fix that here.
841 842
            if isinstance(self.declarator, CNameDeclaratorNode) and self.declarator.name == '':
                if nonempty:
843 844
                    if self.base_type.is_basic_c_type:
                        # char, short, long called "int"
845
                        type = self.base_type.analyse(env, could_be_name=True)
846
                        arg_name = type.empty_declaration_code()
847 848 849
                    else:
                        arg_name = self.base_type.name
                    self.declarator.name = EncodedString(arg_name)
850 851 852 853 854
                    self.base_type.name = None
                    self.base_type.is_basic_c_type = False
                could_be_name = True
            else:
                could_be_name = False
855
            self.base_type.is_arg = True
856
            base_type = self.base_type.analyse(env, could_be_name=could_be_name)
Robert Bradshaw's avatar
Robert Bradshaw committed
857
            if hasattr(self.base_type, 'arg_name') and self.base_type.arg_name:
858
                self.declarator.name = self.base_type.arg_name
859

860 861
            # The parser is unable to resolve the ambiguity of [] as part of the
            # type (e.g. in buffers) or empty declarator (as with arrays).
862
            # This is only arises for empty multi-dimensional arrays.
863 864
            if (base_type.is_array
                    and isinstance(self.base_type, TemplatedTypeNode)
865 866 867 868 869 870
                    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
871 872 873 874 875 876 877

            # inject type declaration from annotations
            if self.annotation and env.directives['annotation_typing'] and self.base_type.name is None:
                arg_type = self.inject_type_from_annotations(env)
                if arg_type is not None:
                    base_type = arg_type
            return self.declarator.analyse(base_type, env, nonempty=nonempty)
878
        else:
879
            return self.name_declarator, self.type
William Stein's avatar
William Stein committed
880

881 882 883
    def inject_type_from_annotations(self, env):
        annotation = self.annotation
        if not annotation:
884
            return None
885 886 887
        base_type, arg_type = _analyse_signature_annotation(annotation, env)
        if base_type is not None:
            self.base_type = base_type
888 889
        return arg_type

890 891 892 893 894 895 896 897 898
    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
899

900 901 902 903
    def annotate(self, code):
        if self.default:
            self.default.annotate(code)

904
    def generate_assignment_code(self, code, target=None, overloaded_assignment=False):
905 906 907 908 909 910 911
        default = self.default
        if default is None or default.is_literal:
            return
        if target is None:
            target = self.calculate_default_value_code(code)
        default.generate_evaluation_code(code)
        default.make_owned_reference(code)
912
        result = default.result() if overloaded_assignment else default.result_as(self.type)
913 914 915 916 917 918
        code.putln("%s = %s;" % (target, result))
        if self.type.is_pyobject:
            code.put_giveref(default.result())
        default.generate_post_assignment_code(code)
        default.free_temps(code)

William Stein's avatar
William Stein committed
919 920 921 922 923 924 925 926

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

928 929
    def analyse_as_type(self, env):
        return self.analyse(env)
930

Stefan Behnel's avatar
Stefan Behnel committed
931

932 933
class CAnalysedBaseTypeNode(Node):
    # type            type
934

935
    child_attrs = []
936

937 938
    def analyse(self, env, could_be_name = False):
        return self.type
William Stein's avatar
William Stein committed
939

Stefan Behnel's avatar
Stefan Behnel committed
940

William Stein's avatar
William Stein committed
941 942 943 944 945 946
class CSimpleBaseTypeNode(CBaseTypeNode):
    # name             string
    # module_path      [string]     Qualifying name components
    # is_basic_c_type  boolean
    # signed           boolean
    # longness         integer
947
    # complex          boolean
William Stein's avatar
William Stein committed
948
    # is_self_arg      boolean      Is self argument of C method
949
    # ##is_type_arg      boolean      Is type argument of class method
William Stein's avatar
William Stein committed
950

951
    child_attrs = []
952
    arg_name = None   # in case the argument name was interpreted as a type
953 954 955
    module_path = []
    is_basic_c_type = False
    complex = False
956

957
    def analyse(self, env, could_be_name = False):
William Stein's avatar
William Stein committed
958
        # Return type descriptor.
959
        #print "CSimpleBaseTypeNode.analyse: is_self_arg =", self.is_self_arg ###
William Stein's avatar
William Stein committed
960 961 962 963 964 965 966 967 968
        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:
969
                #print "CSimpleBaseTypeNode.analyse: defaulting to parent type" ###
William Stein's avatar
William Stein committed
970
                type = env.parent_type
971 972
            ## elif self.is_type_arg and env.is_c_class_scope:
            ##     type = Builtin.type_type
William Stein's avatar
William Stein committed
973 974 975
            else:
                type = py_object_type
        else:
976
            if self.module_path:
977 978 979 980
                # Maybe it's a nested C++ class.
                scope = env
                for item in self.module_path:
                    entry = scope.lookup(item)
Robert Bradshaw's avatar
Robert Bradshaw committed
981
                    if entry is not None and entry.is_cpp_class:
982 983 984 985
                        scope = entry.type.scope
                    else:
                        scope = None
                        break
986

987 988 989 990 991
                if scope is None:
                    # Maybe it's a cimport.
                    scope = env.find_imported_module(self.module_path, self.pos)
                    if scope:
                        scope.fused_to_specific = env.fused_to_specific
992 993
            else:
                scope = env
994

William Stein's avatar
William Stein committed
995
            if scope:
996 997
                if scope.is_c_class_scope:
                    scope = scope.global_scope()
998 999 1000 1001

                type = scope.lookup_type(self.name)
                if type is not None:
                    pass
1002 1003 1004
                elif could_be_name:
                    if self.is_self_arg and env.is_c_class_scope:
                        type = env.parent_type
1005 1006
                    ## elif self.is_type_arg and env.is_c_class_scope:
                    ##     type = Builtin.type_type
1007 1008
                    else:
                        type = py_object_type
1009
                    self.arg_name = EncodedString(self.name)
William Stein's avatar
William Stein committed
1010
                else:
Danilo Freitas's avatar
Danilo Freitas committed
1011 1012 1013
                    if self.templates:
                        if not self.name in self.templates:
                            error(self.pos, "'%s' is not a type identifier" % self.name)
1014
                        type = PyrexTypes.TemplatePlaceholderType(self.name)
Danilo Freitas's avatar
Danilo Freitas committed
1015 1016
                    else:
                        error(self.pos, "'%s' is not a type identifier" % self.name)
1017
        if self.complex:
1018 1019 1020
            if not type.is_numeric or type.is_complex:
                error(self.pos, "can only complexify c numeric types")
            type = PyrexTypes.CComplexType(type)
1021
            type.create_declaration_utility_code(env)
1022 1023 1024 1025 1026 1027 1028 1029
        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
1030 1031 1032 1033 1034
        if type:
            return type
        else:
            return PyrexTypes.error_type

1035
class MemoryViewSliceTypeNode(CBaseTypeNode):
1036

1037
    name = 'memoryview'
1038 1039 1040 1041 1042 1043 1044
    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

1045
        from . import MemoryView
1046 1047 1048

        try:
            axes_specs = MemoryView.get_axes_specs(env, self.axes)
1049
        except CompileError as e:
1050 1051 1052 1053
            error(e.position, e.message_only)
            self.type = PyrexTypes.ErrorType()
            return self.type

1054 1055 1056 1057
        if not MemoryView.validate_axes(self.pos, axes_specs):
            self.type = error_type
        else:
            self.type = PyrexTypes.MemoryViewSliceType(base_type, axes_specs)
1058
            self.type.validate_memslice_dtype(self.pos)
1059
            self.use_memview_utilities(env)
1060

1061
        return self.type
1062

1063
    def use_memview_utilities(self, env):
1064
        from . import MemoryView
1065 1066 1067
        env.use_utility_code(MemoryView.view_utility_code)


Robert Bradshaw's avatar
Robert Bradshaw committed
1068
class CNestedBaseTypeNode(CBaseTypeNode):
1069
    # For C++ classes that live inside other C++ classes.
Robert Bradshaw's avatar
Robert Bradshaw committed
1070 1071 1072

    # name             string
    # base_type        CBaseTypeNode
Stefan Behnel's avatar
Stefan Behnel committed
1073

Robert Bradshaw's avatar
Robert Bradshaw committed
1074
    child_attrs = ['base_type']
Stefan Behnel's avatar
Stefan Behnel committed
1075

Robert Bradshaw's avatar
Robert Bradshaw committed
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
    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

1089

Danilo Freitas's avatar
Danilo Freitas committed
1090
class TemplatedTypeNode(CBaseTypeNode):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1091
    #  After parsing:
1092 1093
    #  positional_args  [ExprNode]        List of positional arguments
    #  keyword_args     DictNode          Keyword arguments
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1094 1095 1096
    #  base_type_node   CBaseTypeNode

    #  After analysis:
1097
    #  type             PyrexTypes.BufferType or PyrexTypes.CppClassType  ...containing the right options
1098 1099 1100

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

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1102
    dtype_node = None
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1103 1104

    name = None
1105

1106 1107 1108
    def analyse(self, env, could_be_name = False, base_type = None):
        if base_type is None:
            base_type = self.base_type_node.analyse(env)
1109
        if base_type.is_error: return base_type
1110

1111
        if base_type.is_cpp_class and base_type.is_template_type():
1112
            # Templated class
1113
            if self.keyword_args and self.keyword_args.key_value_pairs:
Stefan Behnel's avatar
Stefan Behnel committed
1114
                error(self.pos, "c++ templates cannot take keyword arguments")
1115 1116 1117 1118
                self.type = PyrexTypes.error_type
            else:
                template_types = []
                for template_node in self.positional_args:
1119 1120 1121 1122 1123
                    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)
1124
                self.type = base_type.specialize_here(self.pos, template_types)
1125

1126 1127
        elif base_type.is_pyobject:
            # Buffer
1128
            from . import Buffer
1129

1130 1131 1132 1133 1134 1135
            options = Buffer.analyse_buffer_options(
                self.pos,
                env,
                self.positional_args,
                self.keyword_args,
                base_type.buffer_defaults)
1136

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

1142
            self.type = PyrexTypes.BufferType(base_type, **options)
1143

1144 1145
        else:
            # Array
1146
            empty_declarator = CNameDeclaratorNode(self.pos, name="", cname=None)
1147 1148 1149 1150
            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:
1151
                # It would be nice to merge this class with CArrayDeclaratorNode,
1152 1153 1154 1155 1156
                # but arrays are part of the declaration, not the type...
                if not self.positional_args:
                    dimension = None
                else:
                    dimension = self.positional_args[0]
1157 1158
                self.array_declarator = CArrayDeclaratorNode(self.pos,
                    base = empty_declarator,
1159 1160
                    dimension = dimension)
                self.type = self.array_declarator.analyse(base_type, env)[1]
1161

1162 1163 1164
        if self.type.is_fused and env.fused_to_specific:
            self.type = self.type.specialize(env.fused_to_specific)

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1165
        return self.type
William Stein's avatar
William Stein committed
1166 1167 1168 1169

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

1171 1172
    child_attrs = ["base_type", "declarator"]

1173 1174
    def analyse(self, env, could_be_name = False):
        base = self.base_type.analyse(env, could_be_name)
William Stein's avatar
William Stein committed
1175 1176 1177 1178
        _, type = self.declarator.analyse(base, env)
        return type


1179 1180 1181 1182 1183
class CTupleBaseTypeNode(CBaseTypeNode):
    # components [CBaseTypeNode]

    child_attrs = ["components"]

Robert Bradshaw's avatar
Robert Bradshaw committed
1184
    def analyse(self, env, could_be_name=False):
1185 1186 1187 1188
        component_types = []
        for c in self.components:
            type = c.analyse(env)
            if type.is_pyobject:
1189 1190
                error(c.pos, "Tuple types can't (yet) contain Python objects.")
                return error_type
1191
            component_types.append(type)
1192
        entry = env.declare_tuple_type(self.pos, component_types)
Robert Bradshaw's avatar
Robert Bradshaw committed
1193
        entry.used = True
1194
        return entry.type
1195 1196


1197 1198 1199 1200 1201 1202
class FusedTypeNode(CBaseTypeNode):
    """
    Represents a fused type in a ctypedef statement:

        ctypedef cython.fused_type(int, long, long long) integral

Mark Florisson's avatar
Mark Florisson committed
1203
    name            str                     name of this fused type
1204 1205 1206 1207 1208
    types           [CSimpleBaseTypeNode]   is the list of types to be fused
    """

    child_attrs = []

Mark Florisson's avatar
Mark Florisson committed
1209 1210 1211 1212 1213 1214 1215
    def analyse_declarations(self, env):
        type = self.analyse(env)
        entry = env.declare_typedef(self.name, type, self.pos)

        # Omit the typedef declaration that self.declarator would produce
        entry.in_cinclude = True

Robert Bradshaw's avatar
Robert Bradshaw committed
1216
    def analyse(self, env, could_be_name = False):
Mark Florisson's avatar
Mark Florisson committed
1217 1218 1219
        types = []
        for type_node in self.types:
            type = type_node.analyse_as_type(env)
1220

Mark Florisson's avatar
Mark Florisson committed
1221 1222 1223
            if not type:
                error(type_node.pos, "Not a type")
                continue
1224

Mark Florisson's avatar
Mark Florisson committed
1225
            if type in types:
1226 1227
                error(type_node.pos, "Type specified multiple times")
            else:
Mark Florisson's avatar
Mark Florisson committed
1228
                types.append(type)
1229

1230 1231
        # if len(self.types) == 1:
        #     return types[0]
Mark Florisson's avatar
Mark Florisson committed
1232 1233

        return PyrexTypes.FusedType(types, name=self.name)
1234

1235

Robert Bradshaw's avatar
Robert Bradshaw committed
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
class CConstTypeNode(CBaseTypeNode):
    # base_type     CBaseTypeNode

    child_attrs = ["base_type"]

    def analyse(self, env, could_be_name = False):
        base = self.base_type.analyse(env, could_be_name)
        if base.is_pyobject:
            error(self.pos,
                  "Const base type cannot be a Python object")
        return PyrexTypes.c_const_type(base)


William Stein's avatar
William Stein committed
1249 1250 1251 1252 1253 1254
class CVarDefNode(StatNode):
    #  C variable definition or forward/extern function declaration.
    #
    #  visibility    'private' or 'public' or 'extern'
    #  base_type     CBaseTypeNode
    #  declarators   [CDeclaratorNode]
1255
    #  in_pxd        boolean
Stefan Behnel's avatar
Stefan Behnel committed
1256
    #  api           boolean
1257
    #  overridable   boolean        whether it is a cpdef
1258
    #  modifiers     ['inline']
1259

1260
    #  decorators    [cython.locals(...)] or None
1261
    #  directive_locals { string : NameNode } locals defined by cython.locals(...)
1262 1263

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

Robert Bradshaw's avatar
Robert Bradshaw committed
1265
    decorators = None
1266
    directive_locals = None
1267

William Stein's avatar
William Stein committed
1268
    def analyse_declarations(self, env, dest_scope = None):
1269 1270
        if self.directive_locals is None:
            self.directive_locals = {}
William Stein's avatar
William Stein committed
1271 1272
        if not dest_scope:
            dest_scope = env
1273
        self.dest_scope = dest_scope
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288

        if self.declarators:
            templates = self.declarators[0].analyse_templates()
        else:
            templates = None
        if templates is not None:
            if self.visibility != 'extern':
                error(self.pos, "Only extern functions allowed")
            if len(self.declarators) > 1:
                error(self.declarators[1].pos, "Can't multiply declare template types")
            env = TemplateScope('func_template', env)
            env.directives = env.outer_scope.directives
            for template_param in templates:
                env.declare_type(template_param.name, template_param, self.pos)

William Stein's avatar
William Stein committed
1289
        base_type = self.base_type.analyse(env)
1290

1291 1292
        if base_type.is_fused and not self.in_pxd and (env.is_c_class_scope or
                                                       env.is_module_scope):
1293 1294 1295
            error(self.pos, "Fused types not allowed here")
            return error_type

1296
        self.entry = None
1297
        visibility = self.visibility
1298

William Stein's avatar
William Stein committed
1299
        for declarator in self.declarators:
1300

1301 1302 1303
            if (len(self.declarators) > 1
                and not isinstance(declarator, CNameDeclaratorNode)
                and env.directives['warn.multiple_declarators']):
1304 1305 1306
                warning(declarator.pos,
                    "Non-trivial type declarators in shared declaration (e.g. mix of pointers and values). " +
                    "Each pointer declaration should be on its own line.", 1)
1307

1308 1309 1310 1311 1312
            create_extern_wrapper = (self.overridable
                                        and self.visibility == 'extern'
                                        and env.is_module_scope)
            if create_extern_wrapper:
                declarator.overridable = False
1313 1314 1315 1316
            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
1317
            if not type.is_complete():
1318
                if not (self.visibility == 'extern' and type.is_array or type.is_memoryviewslice):
William Stein's avatar
William Stein committed
1319 1320 1321 1322 1323 1324 1325
                    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
1326 1327 1328
            if name == '':
                error(declarator.pos, "Missing name in declaration.")
                return
William Stein's avatar
William Stein committed
1329
            if type.is_cfunction:
1330 1331
                if 'staticmethod' in env.directives:
                    type.is_static_method = True
1332
                self.entry = dest_scope.declare_cfunction(name, type, declarator.pos,
1333 1334
                    cname=cname, visibility=self.visibility, in_pxd=self.in_pxd,
                    api=self.api, modifiers=self.modifiers, overridable=self.overridable)
1335 1336
                if self.entry is not None:
                    self.entry.directive_locals = copy.copy(self.directive_locals)
1337
                if create_extern_wrapper:
1338
                    self.entry.type.create_to_py_utility_code(env)
1339
                    self.entry.create_wrapper = True
William Stein's avatar
William Stein committed
1340
            else:
1341
                if self.directive_locals:
1342
                    error(self.pos, "Decorators can only be followed by functions")
1343
                self.entry = dest_scope.declare_var(name, type, declarator.pos,
1344 1345
                            cname=cname, visibility=visibility, in_pxd=self.in_pxd,
                            api=self.api, is_cdef=1)
1346 1347
                if Options.docstrings:
                    self.entry.doc = embed_position(self.pos, self.doc)
1348

William Stein's avatar
William Stein committed
1349 1350 1351 1352 1353 1354

class CStructOrUnionDefNode(StatNode):
    #  name          string
    #  cname         string or None
    #  kind          "struct" or "union"
    #  typedef_flag  boolean
1355
    #  visibility    "public" or "private"
1356
    #  api           boolean
Stefan Behnel's avatar
Stefan Behnel committed
1357
    #  in_pxd        boolean
William Stein's avatar
William Stein committed
1358 1359
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
1360
    #  packed        boolean
1361

1362
    child_attrs = ["attributes"]
Vitja Makarov's avatar
Vitja Makarov committed
1363

1364
    def declare(self, env, scope=None):
William Stein's avatar
William Stein committed
1365 1366
        self.entry = env.declare_struct_or_union(
            self.name, self.kind, scope, self.typedef_flag, self.pos,
1367 1368
            self.cname, visibility = self.visibility, api = self.api,
            packed = self.packed)
1369 1370 1371 1372 1373 1374

    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
1375
        if self.attributes is not None:
Stefan Behnel's avatar
Stefan Behnel committed
1376 1377
            if self.in_pxd and not env.in_cinclude:
                self.entry.defined_in_pxd = 1
William Stein's avatar
William Stein committed
1378 1379
            for attr in self.attributes:
                attr.analyse_declarations(env, scope)
1380 1381 1382 1383
            if self.visibility != 'extern':
                for attr in scope.var_entries:
                    type = attr.type
                    while type.is_array:
1384 1385
                        type = type.base_type
                    if type == self.entry.type:
1386
                        error(attr.pos, "Struct cannot contain itself as a member.")
1387

William Stein's avatar
William Stein committed
1388
    def analyse_expressions(self, env):
1389
        return self
1390

William Stein's avatar
William Stein committed
1391 1392 1393 1394
    def generate_execution_code(self, code):
        pass


1395
class CppClassNode(CStructOrUnionDefNode, BlockNode):
Robert Bradshaw's avatar
Robert Bradshaw committed
1396 1397 1398

    #  name          string
    #  cname         string or None
1399
    #  visibility    "extern"
Robert Bradshaw's avatar
Robert Bradshaw committed
1400 1401 1402
    #  in_pxd        boolean
    #  attributes    [CVarDefNode] or None
    #  entry         Entry
1403
    #  base_classes  [CBaseTypeNode]
Danilo Freitas's avatar
Danilo Freitas committed
1404
    #  templates     [string] or None
1405 1406 1407
    #  decorators    [DecoratorNode] or None

    decorators = None
Robert Bradshaw's avatar
Robert Bradshaw committed
1408

1409 1410 1411 1412 1413 1414 1415 1416 1417
    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
1418 1419
    def analyse_declarations(self, env):
        scope = None
1420
        if self.attributes is not None:
1421
            scope = CppClassScope(self.name, env, templates = self.templates)
1422 1423 1424 1425 1426 1427
        def base_ok(base_class):
            if base_class.is_cpp_class or base_class.is_struct:
                return True
            else:
                error(self.pos, "Base class '%s' not a struct or class." % base_class)
        base_class_types = filter(base_ok, [b.analyse(scope or env) for b in self.base_classes])
1428 1429 1430 1431
        if self.templates is None:
            template_types = None
        else:
            template_types = [PyrexTypes.TemplatePlaceholderType(template_name) for template_name in self.templates]
1432
        self.entry = env.declare_cpp_class(
1433
            self.name, scope, self.pos,
1434
            self.cname, base_class_types, visibility = self.visibility, templates = template_types)
1435 1436
        if self.entry is None:
            return
Danilo Freitas's avatar
Danilo Freitas committed
1437
        self.entry.is_cpp_class = 1
Stefan Behnel's avatar
Stefan Behnel committed
1438 1439
        if scope is not None:
            scope.type = self.entry.type
1440
        defined_funcs = []
1441 1442 1443 1444 1445 1446 1447
        def func_attributes(attributes):
            for attr in attributes:
                if isinstance(attr, CFuncDefNode):
                    yield attr
                elif isinstance(attr, CompilerDirectivesNode):
                    for sub_attr in func_attributes(attr.body.stats):
                        yield sub_attr
Robert Bradshaw's avatar
Robert Bradshaw committed
1448 1449 1450 1451
        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
1452
                attr.analyse_declarations(scope)
1453 1454 1455 1456
            for func in func_attributes(self.attributes):
                defined_funcs.append(func)
                if self.templates is not None:
                    func.template_declaration = "template <typename %s>" % ", typename ".join(self.templates)
1457 1458 1459 1460
        self.body = StatListNode(self.pos, stats=defined_funcs)
        self.scope = scope

    def analyse_expressions(self, env):
1461 1462
        self.body = self.body.analyse_expressions(self.entry.type.scope)
        return self
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472

    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(self.entry.type.scope, code)

    def generate_execution_code(self, code):
        self.body.generate_execution_code(code)

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

Robert Bradshaw's avatar
Robert Bradshaw committed
1473

William Stein's avatar
William Stein committed
1474 1475 1476 1477 1478
class CEnumDefNode(StatNode):
    #  name           string or None
    #  cname          string or None
    #  items          [CEnumDefItemNode]
    #  typedef_flag   boolean
1479
    #  visibility     "public" or "private" or "extern"
1480
    #  api            boolean
Stefan Behnel's avatar
Stefan Behnel committed
1481
    #  in_pxd         boolean
1482
    #  create_wrapper boolean
William Stein's avatar
William Stein committed
1483
    #  entry          Entry
Robert Bradshaw's avatar
Robert Bradshaw committed
1484

1485
    child_attrs = ["items"]
1486

1487 1488 1489
    def declare(self, env):
         self.entry = env.declare_enum(self.name, self.pos,
             cname = self.cname, typedef_flag = self.typedef_flag,
1490
             visibility = self.visibility, api = self.api,
1491
             create_wrapper = self.create_wrapper and self.name is None)
1492

William Stein's avatar
William Stein committed
1493
    def analyse_declarations(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
1494 1495 1496 1497 1498
        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)
1499 1500 1501
        if self.name is not None:
            self.entry.type.values = set(
                (item.name) for item in self.items)
1502 1503 1504 1505
        if self.create_wrapper and self.name is not None:
            from .UtilityCode import CythonUtilityCode
            env.use_utility_code(CythonUtilityCode.load(
              "EnumType", "CpdefEnums.pyx",
1506 1507
              context={"name": self.name,
                       "items": tuple(item.name for item in self.items)},
1508
              outer_module_scope=env.global_scope()))
William Stein's avatar
William Stein committed
1509

1510
    def analyse_expressions(self, env):
1511
        return self
1512

William Stein's avatar
William Stein committed
1513
    def generate_execution_code(self, code):
1514
        if self.visibility == 'public' or self.api:
1515
            code.mark_pos(self.pos)
1516
            temp = code.funcstate.allocate_temp(PyrexTypes.py_object_type, manage_ref=True)
Robert Bradshaw's avatar
Robert Bradshaw committed
1517 1518
            for item in self.entry.enum_values:
                code.putln("%s = PyInt_FromLong(%s); %s" % (
1519
                        temp,
Robert Bradshaw's avatar
Robert Bradshaw committed
1520
                        item.cname,
1521
                        code.error_goto_if_null(temp, item.pos)))
Stefan Behnel's avatar
merge  
Stefan Behnel committed
1522
                code.put_gotref(temp)
1523 1524
                code.putln('if (PyDict_SetItemString(%s, "%s", %s) < 0) %s' % (
                        Naming.moddict_cname,
1525
                        item.name,
1526
                        temp,
Robert Bradshaw's avatar
Robert Bradshaw committed
1527
                        code.error_goto(item.pos)))
Stefan Behnel's avatar
merge  
Stefan Behnel committed
1528
                code.put_decref_clear(temp, PyrexTypes.py_object_type)
1529
            code.funcstate.release_temp(temp)
William Stein's avatar
William Stein committed
1530 1531 1532 1533 1534 1535


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

1537 1538
    child_attrs = ["value"]

William Stein's avatar
William Stein committed
1539 1540
    def analyse_declarations(self, env, enum_entry):
        if self.value:
1541
            self.value = self.value.analyse_const_expression(env)
1542 1543
            if not self.value.type.is_int:
                self.value = self.value.coerce_to(PyrexTypes.c_int_type, env)
1544
                self.value = self.value.analyse_const_expression(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
1545
        entry = env.declare_const(self.name, enum_entry.type,
1546
            self.value, self.pos, cname = self.cname,
1547
            visibility = enum_entry.visibility, api = enum_entry.api,
1548
            create_wrapper = enum_entry.create_wrapper and enum_entry.name is None)
William Stein's avatar
William Stein committed
1549
        enum_entry.enum_values.append(entry)
1550 1551
        if enum_entry.name:
            enum_entry.type.values.append(entry.cname)
William Stein's avatar
William Stein committed
1552 1553 1554


class CTypeDefNode(StatNode):
Stefan Behnel's avatar
Stefan Behnel committed
1555 1556 1557
    #  base_type    CBaseTypeNode
    #  declarator   CDeclaratorNode
    #  visibility   "public" or "private"
1558
    #  api          boolean
Stefan Behnel's avatar
Stefan Behnel committed
1559
    #  in_pxd       boolean
1560 1561

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

William Stein's avatar
William Stein committed
1563 1564 1565 1566 1567
    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
1568

Stefan Behnel's avatar
Stefan Behnel committed
1569
        entry = env.declare_typedef(name, type, self.pos,
1570
            cname = cname, visibility = self.visibility, api = self.api)
1571

Mark Florisson's avatar
Mark Florisson committed
1572
        if type.is_fused:
1573 1574
            entry.in_cinclude = True

Mark Florisson's avatar
Mark Florisson committed
1575 1576
        if self.in_pxd and not env.in_cinclude:
            entry.defined_in_pxd = 1
1577

William Stein's avatar
William Stein committed
1578
    def analyse_expressions(self, env):
1579 1580
        return self

William Stein's avatar
William Stein committed
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
    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
1591
    #  needs_closure   boolean        Whether or not this function has inner functions/classes/yield
Vitja Makarov's avatar
Vitja Makarov committed
1592
    #  needs_outer_scope boolean      Whether or not this function requires outer scope
1593
    #  pymethdef_required boolean     Force Python method struct generation
1594 1595
    #  directive_locals { string : ExprNode } locals defined by cython.locals(...)
    #  directive_returns [ExprNode] type defined by cython.returns(...)
1596 1597 1598 1599 1600
    #  star_arg      PyArgDeclNode or None  * argument
    #  starstar_arg  PyArgDeclNode or None  ** argument
    #
    #  is_async_def  boolean          is a Coroutine function
    #
1601 1602 1603 1604 1605
    #  has_fused_arguments  boolean
    #       Whether this cdef function has fused parameters. This is needed
    #       by AnalyseDeclarationsTransform, so it can replace CFuncDefNodes
    #       with fused argument types with a FusedCFuncDefNode

1606
    py_func = None
1607
    needs_closure = False
Vitja Makarov's avatar
Vitja Makarov committed
1608
    needs_outer_scope = False
1609
    pymethdef_required = False
1610
    is_generator = False
1611
    is_generator_body = False
1612
    is_async_def = False
Robert Bradshaw's avatar
Robert Bradshaw committed
1613
    modifiers = []
1614
    has_fused_arguments = False
1615 1616
    star_arg = None
    starstar_arg = None
1617
    is_cyfunction = False
1618
    code_object = None
1619

1620
    def analyse_default_values(self, env):
1621
        default_seen = 0
1622 1623
        for arg in self.args:
            if arg.default:
1624
                default_seen = 1
1625
                if arg.is_generic:
1626
                    arg.default = arg.default.analyse_types(env)
1627
                    arg.default = arg.default.coerce_to(arg.type, env)
1628 1629 1630 1631
                else:
                    error(arg.pos,
                        "This argument cannot have a default value")
                    arg.default = None
1632 1633 1634 1635
            elif arg.kw_only:
                default_seen = 1
            elif default_seen:
                error(arg.pos, "Non-default argument following default argument")
1636

1637 1638 1639 1640 1641
    def analyse_annotations(self, env):
        for arg in self.args:
            if arg.annotation:
                arg.annotation = arg.annotation.analyse_types(env)

1642
    def align_argument_type(self, env, arg):
1643
        # @cython.locals()
1644
        directive_locals = self.directive_locals
1645
        orig_type = arg.type
1646 1647 1648
        if arg.name in directive_locals:
            type_node = directive_locals[arg.name]
            other_type = type_node.analyse_as_type(env)
1649
        elif isinstance(arg, CArgDeclNode) and arg.annotation and env.directives['annotation_typing']:
1650 1651
            type_node = arg.annotation
            other_type = arg.inject_type_from_annotations(env)
1652 1653
            if other_type is None:
                return arg
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
        else:
            return arg
        if other_type is None:
            error(type_node.pos, "Not a type")
        elif (orig_type is not PyrexTypes.py_object_type
                and not orig_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
1664 1665
        return arg

1666 1667
    def need_gil_acquisition(self, lenv):
        return 0
1668

1669 1670
    def create_local_scope(self, env):
        genv = env
1671
        while genv.is_py_class_scope or genv.is_c_class_scope:
1672
            genv = genv.outer_scope
1673
        if self.needs_closure:
1674 1675
            lenv = ClosureScope(name=self.entry.name,
                                outer_scope = genv,
1676
                                parent_scope = env,
1677
                                scope_name=self.entry.cname)
1678
        else:
1679 1680 1681
            lenv = LocalScope(name=self.entry.name,
                              outer_scope=genv,
                              parent_scope=env)
William Stein's avatar
William Stein committed
1682
        lenv.return_type = self.return_type
1683 1684 1685
        type = self.entry.type
        if type.is_cfunction:
            lenv.nogil = type.nogil and not type.with_gil
1686
        self.local_scope = lenv
1687
        lenv.directives = env.directives
1688
        return lenv
1689

1690 1691 1692
    def generate_function_body(self, env, code):
        self.body.generate_execution_code(code)

1693
    def generate_function_definitions(self, env, code):
1694
        from . import Buffer
1695
        if self.return_type.is_memoryviewslice:
1696
            from . import MemoryView
1697 1698

        lenv = self.local_scope
Vitja Makarov's avatar
Vitja Makarov committed
1699
        if lenv.is_closure_scope and not lenv.is_passthrough:
1700 1701 1702 1703 1704
            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
1705 1706
        # Generate closure function definitions
        self.body.generate_function_definitions(lenv, code)
Stefan Behnel's avatar
Stefan Behnel committed
1707
        # generate lambda function definitions
1708
        self.generate_lambda_definitions(lenv, code)
1709

1710 1711
        is_getbuffer_slot = (self.entry.name == "__getbuffer__" and
                             self.entry.scope.is_c_class_scope)
1712 1713 1714
        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
1715
        if is_buffer_slot:
1716 1717
            if 'cython_unused' not in self.modifiers:
                self.modifiers = self.modifiers + ['cython_unused']
1718

1719
        preprocessor_guard = self.get_preprocessor_guard()
1720

1721
        profile = code.globalstate.directives['profile']
1722 1723
        linetrace = code.globalstate.directives['linetrace']
        if profile or linetrace:
1724 1725
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("Profile", "Profile.c"))
1726

1727
        # Generate C code for header and body of function
1728
        code.enter_cfunc_scope()
1729
        code.return_from_error_cleanup_label = code.new_label()
1730
        code.funcstate.gil_owned = not lenv.nogil
1731

William Stein's avatar
William Stein committed
1732
        # ----- Top-level constants used by this function
1733
        code.mark_pos(self.pos)
1734
        self.generate_cached_builtins_decls(lenv, code)
William Stein's avatar
William Stein committed
1735 1736
        # ----- Function header
        code.putln("")
1737 1738 1739 1740

        if preprocessor_guard:
            code.putln(preprocessor_guard)

1741 1742
        with_pymethdef = (self.needs_assignment_synthesis(env, code) or
                          self.pymethdef_required)
1743
        if self.py_func:
1744
            self.py_func.generate_function_header(code,
Stefan Behnel's avatar
Stefan Behnel committed
1745
                with_pymethdef = with_pymethdef,
1746
                proto_only=True)
William Stein's avatar
William Stein committed
1747
        self.generate_function_header(code,
Stefan Behnel's avatar
Stefan Behnel committed
1748
            with_pymethdef = with_pymethdef)
William Stein's avatar
William Stein committed
1749
        # ----- Local variable declarations
1750 1751 1752 1753
        # 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
1754
        if self.needs_closure:
1755
            code.put(lenv.scope_class.type.declaration_code(Naming.cur_scope_cname))
Robert Bradshaw's avatar
Robert Bradshaw committed
1756
            code.putln(";")
Vitja Makarov's avatar
Vitja Makarov committed
1757 1758 1759 1760
        elif self.needs_outer_scope:
            if lenv.is_passthrough:
                code.put(lenv.scope_class.type.declaration_code(Naming.cur_scope_cname))
                code.putln(";")
1761
            code.put(cenv.scope_class.type.declaration_code(Naming.outer_scope_cname))
1762
            code.putln(";")
William Stein's avatar
William Stein committed
1763
        self.generate_argument_declarations(lenv, code)
1764

1765
        for entry in lenv.var_entries:
1766
            if not (entry.in_closure or entry.is_arg):
1767
                code.put_var_declaration(entry)
1768

1769
        # Initialize the return variable __pyx_r
William Stein's avatar
William Stein committed
1770 1771
        init = ""
        if not self.return_type.is_void:
1772 1773
            if self.return_type.is_pyobject:
                init = " = NULL"
1774
            elif self.return_type.is_memoryviewslice:
1775
                init = ' = ' + MemoryView.memslice_entry_init
1776

William Stein's avatar
William Stein committed
1777
            code.putln(
1778
                "%s%s;" %
1779 1780
                    (self.return_type.declaration_code(Naming.retval_cname),
                     init))
1781

1782
        tempvardecl_code = code.insertion_point()
William Stein's avatar
William Stein committed
1783
        self.generate_keyword_list(code)
1784

William Stein's avatar
William Stein committed
1785 1786
        # ----- Extern library function declarations
        lenv.generate_library_function_declarations(code)
1787

1788
        # ----- GIL acquisition
1789
        acquire_gil = self.acquire_gil
1790

Mark Florisson's avatar
Mark Florisson committed
1791 1792
        # See if we need to acquire the GIL for variable declarations, or for
        # refnanny only
1793

1794 1795 1796
        # Closures are not currently possible for cdef nogil functions,
        # but check them anyway
        have_object_args = self.needs_closure or self.needs_outer_scope
Mark Florisson's avatar
Mark Florisson committed
1797 1798 1799 1800 1801
        for arg in lenv.arg_entries:
            if arg.type.is_pyobject:
                have_object_args = True
                break

1802 1803
        used_buffer_entries = [entry for entry in lenv.buffer_entries if entry.used]

Mark Florisson's avatar
Mark Florisson committed
1804 1805
        acquire_gil_for_var_decls_only = (
                lenv.nogil and lenv.has_with_gil_block and
1806
                (have_object_args or used_buffer_entries))
Mark Florisson's avatar
Mark Florisson committed
1807 1808 1809 1810 1811 1812

        acquire_gil_for_refnanny_only = (
                lenv.nogil and lenv.has_with_gil_block and not
                acquire_gil_for_var_decls_only)

        use_refnanny = not lenv.nogil or lenv.has_with_gil_block
1813 1814 1815

        if acquire_gil or acquire_gil_for_var_decls_only:
            code.put_ensure_gil()
1816
            code.funcstate.gil_owned = True
1817 1818
        elif lenv.nogil and lenv.has_with_gil_block:
            code.declare_gilstate()
1819

1820 1821 1822 1823 1824
        if profile or linetrace:
            tempvardecl_code.put_trace_declarations()
            code_object = self.code_object.calculate_result_code(code) if self.code_object else None
            code.put_trace_frame_init(code_object)

1825
        # ----- set up refnanny
1826
        if use_refnanny:
1827
            tempvardecl_code.put_declare_refcount_context()
1828 1829
            code.put_setup_refcount_context(
                self.entry.name, acquire_gil=acquire_gil_for_refnanny_only)
Mark Florisson's avatar
Mark Florisson committed
1830

1831
        # ----- Automatic lead-ins for certain special functions
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1832 1833
        if is_getbuffer_slot:
            self.getbuffer_init(code)
1834
        # ----- Create closure scope object
Robert Bradshaw's avatar
Robert Bradshaw committed
1835
        if self.needs_closure:
1836
            tp_slot = TypeSlots.ConstructorSlot("tp_new", '__new__')
1837 1838 1839 1840
            slot_func_cname = TypeSlots.get_slot_function(lenv.scope_class.type.scope, tp_slot)
            if not slot_func_cname:
                slot_func_cname = '%s->tp_new' % lenv.scope_class.type.typeptr_cname
            code.putln("%s = (%s)%s(%s, %s, NULL);" % (
1841
                Naming.cur_scope_cname,
1842
                lenv.scope_class.type.empty_declaration_code(),
1843
                slot_func_cname,
1844
                lenv.scope_class.type.typeptr_cname,
1845 1846 1847 1848
                Naming.empty_tuple))
            code.putln("if (unlikely(!%s)) {" % Naming.cur_scope_cname)
            if is_getbuffer_slot:
                self.getbuffer_error_cleanup(code)
1849 1850

            if use_refnanny:
1851
                code.put_finish_refcount_context()
Mark Florisson's avatar
Mark Florisson committed
1852
                if acquire_gil or acquire_gil_for_var_decls_only:
1853 1854
                    code.put_release_ensured_gil()

1855
            # FIXME: what if the error return value is a Python value?
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
            err_val = self.error_value()
            if err_val is None:
                if not self.caller_will_check_exceptions():
                    warning(self.entry.pos,
                            "Unraisable exception in function '%s'." %
                            self.entry.qualified_name, 0)
                    code.put_unraisable(self.entry.qualified_name, lenv.nogil)
                #if self.return_type.is_void:
                code.putln("return;")
            else:
                code.putln("return %s;" % err_val)
1867
            code.putln("}")
Robert Bradshaw's avatar
Robert Bradshaw committed
1868
            code.put_gotref(Naming.cur_scope_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
1869
            # Note that it is unsafe to decref the scope at this point.
Vitja Makarov's avatar
Vitja Makarov committed
1870
        if self.needs_outer_scope:
1871 1872 1873
            if self.is_cyfunction:
                code.putln("%s = (%s) __Pyx_CyFunction_GetClosure(%s);" % (
                    outer_scope_cname,
1874
                    cenv.scope_class.type.empty_declaration_code(),
1875 1876 1877 1878
                    Naming.self_cname))
            else:
                code.putln("%s = (%s) %s;" % (
                    outer_scope_cname,
1879
                    cenv.scope_class.type.empty_declaration_code(),
1880
                    Naming.self_cname))
Vitja Makarov's avatar
Vitja Makarov committed
1881
            if lenv.is_passthrough:
Stefan Behnel's avatar
Stefan Behnel committed
1882
                code.putln("%s = %s;" % (Naming.cur_scope_cname, outer_scope_cname))
Vitja Makarov's avatar
Vitja Makarov committed
1883
            elif self.needs_closure:
1884
                # inner closures own a reference to their outer parent
1885
                code.put_incref(outer_scope_cname, cenv.scope_class.type)
1886
                code.put_giveref(outer_scope_cname)
1887
        # ----- Trace function call
1888
        if profile or linetrace:
1889 1890
            # 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
1891
            code.put_trace_call(self.entry.name, self.pos, nogil=not code.funcstate.gil_owned)
1892
            code.funcstate.can_trace = True
William Stein's avatar
William Stein committed
1893
        # ----- Fetch arguments
1894
        self.generate_argument_parsing_code(env, code)
1895
        # If an argument is assigned to in the body, we must
Robert Bradshaw's avatar
Robert Bradshaw committed
1896
        # incref it to properly keep track of refcounts.
1897
        is_cdef = isinstance(self, CFuncDefNode)
Robert Bradshaw's avatar
Robert Bradshaw committed
1898
        for entry in lenv.arg_entries:
1899
            if entry.type.is_pyobject:
1900
                if (acquire_gil or len(entry.cf_assignments) > 1) and not entry.in_closure:
1901
                    code.put_var_incref(entry)
1902

1903
            # Note: defaults are always incref-ed. For def functions, we
1904 1905 1906
            #       we aquire arguments from object converstion, so we have
            #       new references. If we are a cdef function, we need to
            #       incref our arguments
1907
            elif is_cdef and entry.type.is_memoryviewslice and len(entry.cf_assignments) > 1:
1908
                code.put_incref_memoryviewslice(entry.cname, have_gil=code.funcstate.gil_owned)
1909 1910
        for entry in lenv.var_entries:
            if entry.is_arg and len(entry.cf_assignments) > 1:
1911 1912 1913 1914
                if entry.xdecref_cleanup:
                    code.put_var_xincref(entry)
                else:
                    code.put_var_incref(entry)
1915

1916 1917
        # ----- Initialise local buffer auxiliary variables
        for entry in lenv.var_entries + lenv.arg_entries:
1918 1919
            if entry.type.is_buffer and entry.buffer_aux.buflocal_nd_var.used:
                Buffer.put_init_vars(entry, code)
1920

1921
        # ----- Check and convert arguments
William Stein's avatar
William Stein committed
1922
        self.generate_argument_type_tests(code)
1923 1924 1925
        # ----- Acquire buffer arguments
        for entry in lenv.arg_entries:
            if entry.type.is_buffer:
1926 1927
                Buffer.put_acquire_arg_buffer(entry, code, self.pos)

1928 1929
        if acquire_gil_for_var_decls_only:
            code.put_release_ensured_gil()
1930
            code.funcstate.gil_owned = False
1931

1932 1933 1934
        # -------------------------
        # ----- Function body -----
        # -------------------------
1935
        self.generate_function_body(env, code)
1936

1937
        code.mark_pos(self.pos, trace=False)
William Stein's avatar
William Stein committed
1938
        code.putln("")
1939 1940 1941
        code.putln("/* function exit code */")

        # ----- Default return value
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
        if not self.body.is_terminator:
            if self.return_type.is_pyobject:
                #if self.return_type.is_extension_type:
                #    lhs = "(PyObject *)%s" % Naming.retval_cname
                #else:
                lhs = Naming.retval_cname
                code.put_init_to_py_none(lhs, self.return_type)
            else:
                val = self.return_type.default_value
                if val:
                    code.putln("%s = %s;" % (Naming.retval_cname, val))
William Stein's avatar
William Stein committed
1953
        # ----- Error cleanup
1954
        if code.error_label in code.labels_used:
1955 1956
            if not self.body.is_terminator:
                code.put_goto(code.return_label)
1957
            code.put_label(code.error_label)
1958
            for cname, type in code.funcstate.all_managed_temps():
1959
                code.put_xdecref(cname, type, have_gil=not lenv.nogil)
1960 1961 1962

            # Clean up buffers -- this calls a Python function
            # so need to save and restore error state
1963
            buffers_present = len(used_buffer_entries) > 0
1964
            #memslice_entries = [e for e in lenv.entries.values() if e.type.is_memoryviewslice]
1965
            if buffers_present:
1966
                code.globalstate.use_utility_code(restore_exception_utility_code)
1967
                code.putln("{ PyObject *__pyx_type, *__pyx_value, *__pyx_tb;")
1968 1969
                code.putln("__Pyx_PyThreadState_declare")
                code.putln("__Pyx_PyThreadState_assign")
1970
                code.putln("__Pyx_ErrFetch(&__pyx_type, &__pyx_value, &__pyx_tb);")
1971 1972
                for entry in used_buffer_entries:
                    Buffer.put_release_buffer_code(code, entry)
1973
                    #code.putln("%s = 0;" % entry.cname)
1974
                code.putln("__Pyx_ErrRestore(__pyx_type, __pyx_value, __pyx_tb);}")
1975

1976 1977 1978 1979 1980 1981
            if self.return_type.is_memoryviewslice:
                MemoryView.put_init_entry(Naming.retval_cname, code)
                err_val = Naming.retval_cname
            else:
                err_val = self.error_value()

1982 1983
            exc_check = self.caller_will_check_exceptions()
            if err_val is not None or exc_check:
1984
                # TODO: Fix exception tracing (though currently unused by cProfile).
Robert Bradshaw's avatar
Robert Bradshaw committed
1985 1986
                # code.globalstate.use_utility_code(get_exception_tuple_utility_code)
                # code.put_trace_exception()
1987

Mark Florisson's avatar
Mark Florisson committed
1988
                if lenv.nogil and not lenv.has_with_gil_block:
1989 1990 1991
                    code.putln("{")
                    code.put_ensure_gil()

1992
                code.put_add_traceback(self.entry.qualified_name)
1993

Mark Florisson's avatar
Mark Florisson committed
1994
                if lenv.nogil and not lenv.has_with_gil_block:
1995 1996
                    code.put_release_ensured_gil()
                    code.putln("}")
1997
            else:
1998 1999 2000
                warning(self.entry.pos,
                        "Unraisable exception in function '%s'." %
                        self.entry.qualified_name, 0)
2001
                code.put_unraisable(self.entry.qualified_name, lenv.nogil)
2002 2003 2004 2005
            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:
2006
                code.putln("%s = %s;" % (Naming.retval_cname, err_val))
2007 2008 2009 2010 2011 2012 2013

            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.
2014
            if buffers_present or is_getbuffer_slot or self.return_type.is_memoryviewslice:
2015 2016 2017
                code.put_goto(code.return_from_error_cleanup_label)

        # ----- Non-error return cleanup
William Stein's avatar
William Stein committed
2018
        code.put_label(code.return_label)
2019 2020
        for entry in used_buffer_entries:
            Buffer.put_release_buffer_code(code, entry)
2021 2022
        if is_getbuffer_slot:
            self.getbuffer_normal_cleanup(code)
2023 2024 2025

        if self.return_type.is_memoryviewslice:
            # See if our return value is uninitialized on non-error return
2026
            # from . import MemoryView
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
            # MemoryView.err_if_nogil_initialized_check(self.pos, env)
            cond = code.unlikely(self.return_type.error_condition(
                                                    Naming.retval_cname))
            code.putln(
                'if (%s) {' % cond)
            if env.nogil:
                code.put_ensure_gil()
            code.putln(
                    'PyErr_SetString('
                        'PyExc_TypeError,'
                        '"Memoryview return value is not initialized");')
            if env.nogil:
                code.put_release_ensured_gil()
            code.putln(
                '}')

2043 2044
        # ----- Return cleanup for both error and no-error return
        code.put_label(code.return_from_error_cleanup_label)
2045

2046
        for entry in lenv.var_entries:
2047 2048
            if not entry.used or entry.in_closure:
                continue
2049

2050
            if entry.type.is_memoryviewslice:
2051 2052
                code.put_xdecref_memoryviewslice(entry.cname,
                                                 have_gil=not lenv.nogil)
2053
            elif entry.type.is_pyobject:
2054
                if not entry.is_arg or len(entry.cf_assignments) > 1:
2055 2056 2057 2058
                    if entry.xdecref_cleanup:
                        code.put_var_xdecref(entry)
                    else:
                        code.put_var_decref(entry)
2059

Robert Bradshaw's avatar
Robert Bradshaw committed
2060
        # Decref any increfed args
2061
        for entry in lenv.arg_entries:
2062
            if entry.type.is_pyobject:
2063 2064
                if ((acquire_gil or len(entry.cf_assignments) > 1) and
                    not entry.in_closure):
2065
                    code.put_var_decref(entry)
2066 2067 2068 2069
            elif (entry.type.is_memoryviewslice and
                  (not is_cdef or len(entry.cf_assignments) > 1)):
                # decref slices of def functions and acquired slices from cdef
                # functions, but not borrowed slices from cdef functions.
2070 2071
                code.put_xdecref_memoryviewslice(entry.cname,
                                                 have_gil=not lenv.nogil)
Robert Bradshaw's avatar
Robert Bradshaw committed
2072 2073
        if self.needs_closure:
            code.put_decref(Naming.cur_scope_cname, lenv.scope_class.type)
2074

2075
        # ----- Return
2076
        # This code is duplicated in ModuleNode.generate_module_init_func
2077 2078 2079 2080
        if not lenv.nogil:
            default_retval = self.return_type.default_value
            err_val = self.error_value()
            if err_val is None and default_retval:
Stefan Behnel's avatar
Stefan Behnel committed
2081
                err_val = default_retval  # FIXME: why is err_val not used?
2082 2083
            if self.return_type.is_pyobject:
                code.put_xgiveref(self.return_type.as_pyobject(Naming.retval_cname))
2084

2085 2086
        if self.entry.is_special and self.entry.name == "__hash__":
            # Returning -1 for __hash__ is supposed to signal an error
2087
            # We do as Python instances and coerce -1 into -2.
2088 2089
            code.putln("if (unlikely(%s == -1) && !PyErr_Occurred()) %s = -2;" % (
                    Naming.retval_cname, Naming.retval_cname))
2090

2091 2092
        if profile or linetrace:
            code.funcstate.can_trace = False
Robert Bradshaw's avatar
Robert Bradshaw committed
2093
            if self.return_type.is_pyobject:
2094
                code.put_trace_return(Naming.retval_cname, nogil=not code.funcstate.gil_owned)
Robert Bradshaw's avatar
Robert Bradshaw committed
2095
            else:
2096
                code.put_trace_return("Py_None", nogil=not code.funcstate.gil_owned)
2097

2098
        if not lenv.nogil:
Stefan Behnel's avatar
Stefan Behnel committed
2099
            # GIL holding function
2100
            code.put_finish_refcount_context()
2101

2102 2103
        if acquire_gil or (lenv.nogil and lenv.has_with_gil_block):
            # release the GIL (note that with-gil blocks acquire it on exit in their EnsureGILNode)
2104
            code.put_release_ensured_gil()
2105
            code.funcstate.gil_owned = False
2106

William Stein's avatar
William Stein committed
2107
        if not self.return_type.is_void:
2108
            code.putln("return %s;" % Naming.retval_cname)
2109

William Stein's avatar
William Stein committed
2110
        code.putln("}")
2111 2112 2113 2114

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

2115
        # ----- Go back and insert temp variable declarations
2116
        tempvardecl_code.put_temp_declarations(code.funcstate)
2117

2118
        # ----- Python version
2119
        code.exit_cfunc_scope()
2120
        if self.py_func:
2121
            self.py_func.generate_function_definitions(env, code)
2122
        self.generate_wrapper_functions(code)
William Stein's avatar
William Stein committed
2123 2124 2125 2126

    def declare_argument(self, env, arg):
        if arg.type.is_void:
            error(arg.pos, "Invalid use of 'void'")
2127
        elif not arg.type.is_complete() and not (arg.type.is_array or arg.type.is_memoryviewslice):
William Stein's avatar
William Stein committed
2128 2129 2130
            error(arg.pos,
                "Argument type '%s' is incomplete" % arg.type)
        return env.declare_arg(arg.name, arg.type, arg.pos)
2131

2132 2133 2134
    def generate_arg_type_test(self, arg, code):
        # Generate type test for one argument.
        if arg.type.typeobj_is_available():
2135 2136
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("ArgTypeTest", "FunctionArguments.c"))
2137 2138 2139 2140
            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' % (
2141
                    arg_code,
2142 2143 2144 2145 2146 2147 2148 2149
                    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")
2150 2151 2152

    def generate_arg_none_check(self, arg, code):
        # Generate None check for one argument.
2153 2154 2155 2156 2157 2158
        if arg.type.is_memoryviewslice:
            cname = "%s.memview" % arg.entry.cname
        else:
            cname = arg.entry.cname

        code.putln('if (unlikely(((PyObject *)%s) == Py_None)) {' % cname)
2159 2160
        code.putln('''PyErr_Format(PyExc_TypeError, "Argument '%%.%ds' must not be None", "%s"); %s''' % (
            max(200, len(arg.name)), arg.name,
2161 2162
            code.error_goto(arg.pos)))
        code.putln('}')
2163

2164
    def generate_wrapper_functions(self, code):
William Stein's avatar
William Stein committed
2165 2166 2167
        pass

    def generate_execution_code(self, code):
2168
        code.mark_pos(self.pos)
2169 2170
        # Evaluate and store argument default values
        for arg in self.args:
2171 2172
            if not arg.is_dynamic:
                arg.generate_assignment_code(code)
William Stein's avatar
William Stein committed
2173

2174
    #
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
2175
    # Special code for the __getbuffer__ function
2176 2177 2178 2179 2180
    #
    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;
2181 2182
        # the following block should be removed when this bug is fixed.
        code.putln("if (%s != NULL) {" % info)
2183
        code.putln("%s->obj = Py_None; __Pyx_INCREF(Py_None);" % info)
2184
        code.put_giveref("%s->obj" % info) # Do not refnanny object within structs
2185
        code.putln("}")
2186 2187 2188

    def getbuffer_error_cleanup(self, code):
        info = self.local_scope.arg_entries[1].cname
2189 2190
        code.putln("if (%s != NULL && %s->obj != NULL) {"
                   % (info, info))
2191
        code.put_gotref("%s->obj" % info)
2192 2193 2194
        code.putln("__Pyx_DECREF(%s->obj); %s->obj = NULL;"
                   % (info, info))
        code.putln("}")
2195 2196 2197

    def getbuffer_normal_cleanup(self, code):
        info = self.local_scope.arg_entries[1].cname
2198
        code.putln("if (%s != NULL && %s->obj == Py_None) {" % (info, info))
2199 2200 2201
        code.put_gotref("Py_None")
        code.putln("__Pyx_DECREF(Py_None); %s->obj = NULL;" % info)
        code.putln("}")
William Stein's avatar
William Stein committed
2202

2203
    def get_preprocessor_guard(self):
2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
        if not self.entry.is_special:
            return None
        name = self.entry.name
        slot = TypeSlots.method_name_to_slot.get(name)
        if not slot:
            return None
        if name == '__long__' and not self.entry.scope.lookup_here('__int__'):
            return None
        if name in ("__getbuffer__", "__releasebuffer__") and self.entry.scope.is_c_class_scope:
            return None
        return slot.preprocessor_guard_code()
2215 2216


William Stein's avatar
William Stein committed
2217 2218 2219
class CFuncDefNode(FuncDefNode):
    #  C function definition.
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
2220
    #  modifiers     ['inline']
William Stein's avatar
William Stein committed
2221 2222 2223
    #  visibility    'private' or 'public' or 'extern'
    #  base_type     CBaseTypeNode
    #  declarator    CDeclaratorNode
2224 2225 2226
    #  cfunc_declarator  the CFuncDeclarator of this function
    #                    (this is also available through declarator or a
    #                     base thereof)
William Stein's avatar
William Stein committed
2227
    #  body          StatListNode
2228
    #  api           boolean
2229
    #  decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
2230
    #
2231
    #  with_gil      boolean    Acquire GIL around body
William Stein's avatar
William Stein committed
2232
    #  type          CFuncType
2233
    #  py_func       wrapper for calling from Python
2234
    #  overridable   whether or not this is a cpdef function
2235
    #  inline_in_pxd whether this is an inline function in a pxd file
2236
    #  template_declaration  String or None   Used for c++ class methods
Robert Bradshaw's avatar
Robert Bradshaw committed
2237
    #  is_const_method whether this is a const method
Robert Bradshaw's avatar
Robert Bradshaw committed
2238
    #  is_static_method whether this is a static method
2239
    #  is_c_class_method whether this is a cclass method
2240

2241
    child_attrs = ["base_type", "declarator", "body", "py_func_stat"]
2242 2243

    inline_in_pxd = False
2244
    decorators = None
2245
    directive_locals = None
2246
    directive_returns = None
2247
    override = None
2248
    template_declaration = None
Robert Bradshaw's avatar
Robert Bradshaw committed
2249
    is_const_method = False
2250
    py_func_stat = None
2251

William Stein's avatar
William Stein committed
2252 2253
    def unqualified_name(self):
        return self.entry.name
2254

William Stein's avatar
William Stein committed
2255
    def analyse_declarations(self, env):
2256
        self.is_c_class_method = env.is_c_class_scope
2257 2258
        if self.directive_locals is None:
            self.directive_locals = {}
2259
        self.directive_locals.update(env.directives['locals'])
2260 2261 2262 2263 2264 2265 2266
        if self.directive_returns is not None:
            base_type = self.directive_returns.analyse_as_type(env)
            if base_type is None:
                error(self.directive_returns.pos, "Not a type")
                base_type = PyrexTypes.error_type
        else:
            base_type = self.base_type.analyse(env)
2267
        self.is_static_method = 'staticmethod' in env.directives and not env.lookup_here('staticmethod')
2268
        # The 2 here is because we need both function and argument names.
2269 2270 2271 2272 2273 2274
        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))
2275
        if not type.is_cfunction:
2276
            error(self.pos,
2277
                "Suite attached to non-function declaration")
William Stein's avatar
William Stein committed
2278 2279 2280 2281 2282
        # 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
2283
        type.is_overridable = self.overridable
2284 2285 2286
        declarator = self.declarator
        while not hasattr(declarator, 'args'):
            declarator = declarator.base
2287 2288

        self.cfunc_declarator = declarator
2289
        self.args = declarator.args
2290

2291 2292 2293 2294 2295 2296
        opt_arg_count = self.cfunc_declarator.optional_arg_count
        if (self.visibility == 'public' or self.api) and opt_arg_count:
            error(self.cfunc_declarator.pos,
                  "Function with optional arguments may not be declared "
                  "public or api")

2297 2298 2299 2300
        if (type.exception_check == '+' and self.visibility != 'extern'):
            warning(self.cfunc_declarator.pos,
                    "Only extern functions can throw C++ exceptions.")

2301
        for formal_arg, type_arg in zip(self.args, type.args):
2302
            self.align_argument_type(env, type_arg)
2303
            formal_arg.type = type_arg.type
2304
            formal_arg.name = type_arg.name
2305
            formal_arg.cname = type_arg.cname
2306

2307 2308
            self._validate_type_visibility(type_arg.type, type_arg.pos, env)

2309 2310 2311
            if type_arg.type.is_fused:
                self.has_fused_arguments = True

2312 2313
            if type_arg.type.is_buffer and 'inline' in self.modifiers:
                warning(formal_arg.pos, "Buffer unpacking not optimized away.", 1)
2314

2315 2316 2317 2318 2319 2320 2321 2322
            if type_arg.type.is_buffer:
                if self.type.nogil:
                    error(formal_arg.pos,
                          "Buffer may not be acquired without the GIL. "
                          "Consider using memoryview slices instead.")
                elif 'inline' in self.modifiers:
                    warning(formal_arg.pos, "Buffer unpacking not optimized away.", 1)

2323 2324
        self._validate_type_visibility(type.return_type, self.pos, env)

William Stein's avatar
William Stein committed
2325 2326
        name = name_declarator.name
        cname = name_declarator.cname
2327

Robert Bradshaw's avatar
Robert Bradshaw committed
2328
        type.is_const_method = self.is_const_method
Robert Bradshaw's avatar
Robert Bradshaw committed
2329
        type.is_static_method = self.is_static_method
William Stein's avatar
William Stein committed
2330
        self.entry = env.declare_cfunction(
2331
            name, type, self.pos,
2332 2333 2334
            cname=cname, visibility=self.visibility, api=self.api,
            defining=self.body is not None, modifiers=self.modifiers,
            overridable=self.overridable)
2335
        self.entry.inline_func_in_pxd = self.inline_in_pxd
William Stein's avatar
William Stein committed
2336
        self.return_type = type.return_type
2337
        if self.return_type.is_array and self.visibility != 'extern':
2338 2339
            error(self.pos,
                "Function cannot return an array")
2340 2341
        if self.return_type.is_cpp_class:
            self.return_type.check_nullary_constructor(self.pos, "used as a return value")
2342

Robert Bradshaw's avatar
Robert Bradshaw committed
2343
        if self.overridable and not env.is_module_scope and not self.is_static_method:
2344 2345 2346
            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
2347

2348 2349 2350 2351
        self.declare_cpdef_wrapper(env)
        self.create_local_scope(env)

    def declare_cpdef_wrapper(self, env):
2352
        if self.overridable:
2353 2354 2355
            if self.is_static_method:
                # TODO(robertwb): Finish this up, perhaps via more function refactoring.
                error(self.pos, "static cpdef methods not yet supported")
2356
            name = self.entry.name
2357
            py_func_body = self.call_self_node(is_module_scope = env.is_module_scope)
2358 2359 2360 2361 2362 2363
            if self.is_static_method:
                from .ExprNodes import NameNode
                decorators = [DecoratorNode(self.pos, decorator=NameNode(self.pos, name='staticmethod'))]
                decorators[0].decorator.analyse_types(env)
            else:
                decorators = []
2364
            self.py_func = DefNode(pos = self.pos,
2365 2366
                                   name = self.entry.name,
                                   args = self.args,
2367 2368
                                   star_arg = None,
                                   starstar_arg = None,
2369
                                   doc = self.doc,
2370
                                   body = py_func_body,
2371
                                   decorators = decorators,
2372
                                   is_wrapper = 1)
2373
            self.py_func.is_module_scope = env.is_module_scope
2374
            self.py_func.analyse_declarations(env)
2375 2376
            self.py_func_stat = StatListNode(pos = self.pos, stats = [self.py_func])
            self.py_func.type = PyrexTypes.py_object_type
2377
            self.entry.as_variable = self.py_func.entry
2378
            self.entry.used = self.entry.as_variable.used = True
2379 2380
            # Reset scope entry the above cfunction
            env.entries[name] = self.entry
2381 2382
            if (not self.entry.is_final_cmethod and
                (not env.is_module_scope or Options.lookup_module_cpdef)):
2383 2384
                self.override = OverrideCheckNode(self.pos, py_func = self.py_func)
                self.body = StatListNode(self.pos, stats=[self.override, self.body])
2385

2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
    def _validate_type_visibility(self, type, pos, env):
        """
        Ensure that types used in cdef functions are public or api, or
        defined in a C header.
        """
        public_or_api = (self.visibility == 'public' or self.api)
        entry = getattr(type, 'entry', None)
        if public_or_api and entry and env.is_module_scope:
            if not (entry.visibility in ('public', 'extern') or
                    entry.api or entry.in_cinclude):
                error(pos, "Function declared public or api may not have "
                           "private types")

2399
    def call_self_node(self, omit_optional_args=0, is_module_scope=0):
2400
        from . import ExprNodes
2401 2402 2403 2404
        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]
2405
        if is_module_scope:
2406
            cfunc = ExprNodes.NameNode(self.pos, name=self.entry.name)
2407 2408 2409 2410
            call_arg_names = arg_names
            skip_dispatch = Options.lookup_module_cpdef
        elif self.type.is_static_method:
            class_entry = self.entry.scope.parent_type.entry
2411 2412 2413
            class_node = ExprNodes.NameNode(self.pos, name=class_entry.name)
            class_node.entry = class_entry
            cfunc = ExprNodes.AttributeNode(self.pos, obj=class_node, attribute=self.entry.name)
2414 2415 2416
            # Calling static c(p)def methods on an instance disallowed.
            # TODO(robertwb): Support by passing self to check for override?
            skip_dispatch = True
2417
        else:
2418 2419 2420 2421
            type_entry = self.type.args[0].type.entry
            type_arg = ExprNodes.NameNode(self.pos, name=type_entry.name)
            type_arg.entry = type_entry
            cfunc = ExprNodes.AttributeNode(self.pos, obj=type_arg, attribute=self.entry.name)
2422
        skip_dispatch = not is_module_scope or Options.lookup_module_cpdef
2423 2424 2425 2426 2427
        c_call = ExprNodes.SimpleCallNode(
            self.pos,
            function=cfunc,
            args=[ExprNodes.NameNode(self.pos, name=n) for n in arg_names],
            wrapper_call=skip_dispatch)
2428 2429
        return ReturnStatNode(pos=self.pos, return_type=PyrexTypes.py_object_type, value=c_call)

William Stein's avatar
William Stein committed
2430 2431 2432 2433 2434
    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)
2435

2436
    def need_gil_acquisition(self, lenv):
2437 2438
        return self.type.with_gil

2439
    def nogil_check(self, env):
2440
        type = self.type
2441
        with_gil = type.with_gil
2442 2443 2444 2445
        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")
2446
            for entry in self.local_scope.var_entries:
2447
                if entry.type.is_pyobject and not entry.in_with_gil_block:
2448 2449
                    error(self.pos, "Function declared nogil has Python locals or temporaries")

2450
    def analyse_expressions(self, env):
2451
        self.local_scope.directives = env.directives
2452
        if self.py_func is not None:
2453
            # this will also analyse the default values
2454
            self.py_func = self.py_func.analyse_expressions(env)
2455 2456
        else:
            self.analyse_default_values(env)
2457
            self.analyse_annotations(env)
2458
        self.acquire_gil = self.need_gil_acquisition(self.local_scope)
2459
        return self
2460

Robert Bradshaw's avatar
Robert Bradshaw committed
2461 2462 2463
    def needs_assignment_synthesis(self, env, code=None):
        return False

2464
    def generate_function_header(self, code, with_pymethdef, with_opt_args = 1, with_dispatch = 1, cname = None):
2465
        scope = self.local_scope
William Stein's avatar
William Stein committed
2466 2467
        arg_decls = []
        type = self.type
2468
        for arg in type.args[:len(type.args)-type.optional_arg_count]:
2469 2470 2471 2472 2473
            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)
2474
        if with_dispatch and self.overridable:
2475 2476 2477 2478 2479 2480
            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)
2481 2482
        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
2483 2484 2485 2486
        if type.has_varargs:
            arg_decls.append("...")
        if not arg_decls:
            arg_decls = ["void"]
2487 2488
        if cname is None:
            cname = self.entry.func_cname
2489
        entity = type.function_header_code(cname, ', '.join(arg_decls))
2490
        if self.entry.visibility == 'private' and '::' not in cname:
2491
            storage_class = "static "
William Stein's avatar
William Stein committed
2492
        else:
2493
            storage_class = ""
2494
        dll_linkage = None
2495
        modifiers = code.build_function_modifiers(self.entry.func_modifiers)
Robert Bradshaw's avatar
Robert Bradshaw committed
2496

2497 2498
        header = self.return_type.declaration_code(entity, dll_linkage=dll_linkage)
        #print (storage_class, modifiers, header)
2499
        needs_proto = self.is_c_class_method
2500
        if self.template_declaration:
2501 2502
            if needs_proto:
                code.globalstate.parts['module_declarations'].putln(self.template_declaration)
2503
            code.putln(self.template_declaration)
2504 2505
        if needs_proto:
            code.globalstate.parts['module_declarations'].putln("%s%s%s; /* proto*/" % (storage_class, modifiers, header))
2506
        code.putln("%s%s%s {" % (storage_class, modifiers, header))
William Stein's avatar
William Stein committed
2507 2508

    def generate_argument_declarations(self, env, code):
2509
        scope = self.local_scope
2510
        for arg in self.args:
2511
            if arg.default:
2512
                entry = scope.lookup(arg.name)
2513
                if self.override or entry.cf_used:
2514 2515 2516
                    result = arg.calculate_default_value_code(code)
                    code.putln('%s = %s;' % (
                        arg.type.declaration_code(arg.cname), result))
2517

William Stein's avatar
William Stein committed
2518 2519
    def generate_keyword_list(self, code):
        pass
2520

2521
    def generate_argument_parsing_code(self, env, code):
2522
        i = 0
2523
        used = 0
2524
        scope = self.local_scope
2525 2526
        if self.type.optional_arg_count:
            code.putln('if (%s) {' % Naming.optional_args_cname)
2527
            for arg in self.args:
2528
                if arg.default:
2529
                    entry = scope.lookup(arg.name)
2530
                    if self.override or entry.cf_used:
2531 2532 2533 2534 2535 2536 2537 2538 2539 2540
                        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
2541
                    i += 1
2542
            for _ in range(used):
2543
                code.putln('}')
2544
            code.putln('}')
2545

2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
        # Move arguments into closure if required
        def put_into_closure(entry):
            if entry.in_closure and not arg.default:
                code.putln('%s = %s;' % (entry.cname, entry.original_cname))
                code.put_var_incref(entry)
                code.put_var_giveref(entry)
        for arg in self.args:
            put_into_closure(scope.lookup_here(arg.name))


William Stein's avatar
William Stein committed
2556 2557
    def generate_argument_conversion_code(self, code):
        pass
2558

William Stein's avatar
William Stein committed
2559
    def generate_argument_type_tests(self, code):
2560 2561 2562 2563 2564
        # 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)
2565 2566
            elif arg.type.is_pyobject and not arg.accept_none:
                self.generate_arg_none_check(arg, code)
2567

2568 2569 2570 2571 2572
    def generate_execution_code(self, code):
        super(CFuncDefNode, self).generate_execution_code(code)
        if self.py_func_stat:
            self.py_func_stat.generate_execution_code(code)

William Stein's avatar
William Stein committed
2573 2574 2575 2576
    def error_value(self):
        if self.return_type.is_pyobject:
            return "0"
        else:
2577 2578
            #return None
            return self.entry.type.exception_value
2579

William Stein's avatar
William Stein committed
2580
    def caller_will_check_exceptions(self):
2581
        return self.entry.type.exception_check
2582

2583 2584
    def generate_wrapper_functions(self, code):
        # If the C signature of a function has changed, we need to generate
2585
        # wrappers to put in the slots here.
2586 2587 2588 2589 2590 2591 2592
        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)
2593
            code.putln()
2594
            self.generate_function_header(code,
2595
                                          0,
2596 2597
                                          with_dispatch = entry.type.is_overridable,
                                          with_opt_args = entry.type.optional_arg_count,
2598
                                          cname = entry.func_cname)
2599 2600 2601 2602
            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]]
2603 2604 2605 2606 2607 2608 2609 2610
            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')
2611 2612
            code.putln('%s(%s);' % (self.entry.func_cname, ', '.join(arglist)))
            code.putln('}')
2613

William Stein's avatar
William Stein committed
2614 2615 2616 2617 2618

class PyArgDeclNode(Node):
    # Argument which must be a Python object (used
    # for * and ** arguments).
    #
2619 2620 2621
    # name        string
    # entry       Symtab.Entry
    # annotation  ExprNode or None   Py3 argument annotation
2622
    child_attrs = []
2623 2624
    is_self_arg = False
    is_type_arg = False
2625 2626 2627

    def generate_function_definitions(self, env, code):
        self.entry.generate_function_definitions(env, code)
2628 2629 2630 2631

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

William Stein's avatar
William Stein committed
2635 2636 2637 2638 2639

class DefNode(FuncDefNode):
    # A Python function definition.
    #
    # name          string                 the Python name of the function
Stefan Behnel's avatar
Stefan Behnel committed
2640
    # lambda_name   string                 the internal name of a lambda 'function'
2641
    # decorators    [DecoratorNode]        list of decorators
William Stein's avatar
William Stein committed
2642
    # args          [CArgDeclNode]         formal arguments
2643
    # doc           EncodedString or None
William Stein's avatar
William Stein committed
2644
    # body          StatListNode
2645 2646
    # return_type_annotation
    #               ExprNode or None       the Py3 return type annotation
William Stein's avatar
William Stein committed
2647 2648 2649 2650
    #
    #  The following subnode is constructed internally
    #  when the def statement is inside a Python class definition.
    #
2651 2652 2653
    #  fused_py_func        DefNode     The original fused cpdef DefNode
    #                                   (in case this is a specialization)
    #  specialized_cpdefs   [DefNode]   list of specialized cpdef DefNodes
2654
    #  py_cfunc_node  PyCFunctionNode/InnerFunctionNode   The PyCFunction to create and assign
2655 2656
    #
    # decorator_indirection IndirectionNode Used to remove __Pyx_Method_ClassMethod for fused functions
2657

2658
    child_attrs = ["args", "star_arg", "starstar_arg", "body", "decorators", "return_type_annotation"]
2659

Stefan Behnel's avatar
Stefan Behnel committed
2660
    lambda_name = None
2661
    reqd_kw_flags_cname = "0"
2662
    is_wrapper = 0
2663
    no_assignment_synthesis = 0
2664
    decorators = None
2665
    return_type_annotation = None
2666
    entry = None
Robert Bradshaw's avatar
Robert Bradshaw committed
2667
    acquire_gil = 0
2668
    self_in_stararg = 0
2669
    py_cfunc_node = None
2670
    requires_classobj = False
2671
    defaults_struct = None # Dynamic kwrds structure name
2672
    doc = None
2673

2674 2675
    fused_py_func = False
    specialized_cpdefs = None
2676 2677 2678
    py_wrapper = None
    py_wrapper_required = True
    func_cname = None
2679

2680 2681
    defaults_getter = None

2682 2683
    def __init__(self, pos, **kwds):
        FuncDefNode.__init__(self, pos, **kwds)
2684
        k = rk = r = 0
2685 2686
        for arg in self.args:
            if arg.kw_only:
2687
                k += 1
2688
                if not arg.default:
2689 2690 2691 2692 2693 2694
                    rk += 1
            if not arg.default:
                r += 1
        self.num_kwonly_args = k
        self.num_required_kw_args = rk
        self.num_required_args = r
2695

2696
    def as_cfunction(self, cfunc=None, scope=None, overridable=True, returns=None, modifiers=None):
2697 2698 2699 2700
        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")
2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715
        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
2716
                                              is_overridable = overridable)
2717
            cfunc = CVarDefNode(self.pos, type=cfunc_type)
2718
        else:
2719 2720
            if scope is None:
                scope = cfunc.scope
2721 2722 2723
            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
2724
                error(cfunc.pos, "previous declaration here")
2725 2726 2727
            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
2728
                if type is None or type is PyrexTypes.py_object_type:
2729 2730
                    formal_arg.type = type_arg.type
                    formal_arg.name_declarator = name_declarator
2731
        from . import ExprNodes
2732
        if cfunc_type.exception_value is None:
2733 2734
            exception_value = None
        else:
2735
            exception_value = ExprNodes.ConstNode(self.pos, value=cfunc_type.exception_value, type=cfunc_type.return_type)
2736
        declarator = CFuncDeclaratorNode(self.pos,
2737 2738 2739
                                         base = CNameDeclaratorNode(self.pos, name=self.name, cname=None),
                                         args = self.args,
                                         has_varargs = False,
2740
                                         exception_check = cfunc_type.exception_check,
2741
                                         exception_value = exception_value,
2742 2743
                                         with_gil = cfunc_type.with_gil,
                                         nogil = cfunc_type.nogil)
2744
        return CFuncDefNode(self.pos,
2745
                            modifiers = modifiers or [],
2746
                            base_type = CAnalysedBaseTypeNode(self.pos, type=cfunc_type.return_type),
2747 2748 2749
                            declarator = declarator,
                            body = self.body,
                            doc = self.doc,
2750 2751 2752 2753
                            overridable = cfunc_type.is_overridable,
                            type = cfunc_type,
                            with_gil = cfunc_type.with_gil,
                            nogil = cfunc_type.nogil,
2754
                            visibility = 'private',
2755
                            api = False,
2756 2757
                            directive_locals = getattr(cfunc, 'directive_locals', {}),
                            directive_returns = returns)
2758

2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
    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
2770
    def analyse_declarations(self, env):
2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785
        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

2786
        if self.name == '__new__' and env.is_py_class_scope:
Vitja Makarov's avatar
Vitja Makarov committed
2787 2788
            self.is_staticmethod = 1

2789
        self.analyse_argument_types(env)
2790 2791 2792 2793
        if self.name == '<lambda>':
            self.declare_lambda_function(env)
        else:
            self.declare_pyfunction(env)
2794

2795 2796
        self.analyse_signature(env)
        self.return_type = self.entry.signature.return_type()
2797 2798 2799 2800 2801 2802 2803
        # if a signature annotation provides a more specific return object type, use it
        if self.return_type is py_object_type and self.return_type_annotation:
            if env.directives['annotation_typing'] and not self.entry.is_special:
                _, return_type = _analyse_signature_annotation(self.return_type_annotation, env)
                if return_type and return_type.is_pyobject:
                    self.return_type = return_type

2804 2805
        self.create_local_scope(env)

2806 2807 2808 2809 2810 2811 2812 2813 2814 2815
        self.py_wrapper = DefNodeWrapper(
            self.pos,
            target=self,
            name=self.entry.name,
            args=self.args,
            star_arg=self.star_arg,
            starstar_arg=self.starstar_arg,
            return_type=self.return_type)
        self.py_wrapper.analyse_declarations(env)

2816
    def analyse_argument_types(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
2817
        self.directive_locals = env.directives['locals']
2818
        allow_none_for_extension_args = env.directives['allow_none_for_extension_args']
2819 2820 2821 2822

        f2s = env.fused_to_specific
        env.fused_to_specific = None

William Stein's avatar
William Stein committed
2823
        for arg in self.args:
2824 2825 2826 2827 2828 2829 2830
            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
2831
                arg.type = type
2832 2833 2834 2835

                if type.is_fused:
                    self.has_fused_arguments = True

2836
            self.align_argument_type(env, arg)
2837
            if name_declarator and name_declarator.cname:
William Stein's avatar
William Stein committed
2838 2839
                error(self.pos,
                    "Python function argument cannot have C name specification")
2840
            arg.type = arg.type.as_argument_type()
William Stein's avatar
William Stein committed
2841 2842 2843 2844
            arg.hdr_type = None
            arg.needs_conversion = 0
            arg.needs_type_test = 0
            arg.is_generic = 1
2845
            if arg.type.is_pyobject or arg.type.is_buffer or arg.type.is_memoryviewslice:
2846 2847 2848 2849
                if arg.or_none:
                    arg.accept_none = True
                elif arg.not_none:
                    arg.accept_none = False
2850
                elif (arg.type.is_extension_type or arg.type.is_builtin_type
2851
                      or arg.type.is_buffer or arg.type.is_memoryviewslice):
2852 2853 2854 2855 2856 2857
                    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
2858 2859 2860
                else:
                    # probably just a plain 'object'
                    arg.accept_none = True
2861
            else:
2862
                arg.accept_none = True # won't be used, but must be there
2863
                if arg.not_none:
2864
                    error(arg.pos, "Only Python type arguments can have 'not None'")
2865
                if arg.or_none:
2866
                    error(arg.pos, "Only Python type arguments can have 'or None'")
2867 2868
        env.fused_to_specific = f2s

William Stein's avatar
William Stein committed
2869
    def analyse_signature(self, env):
2870
        if self.entry.is_special:
2871
            if self.decorators:
2872
                error(self.pos, "special functions of cdef classes cannot have decorators")
2873 2874 2875 2876
            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:
2877 2878
                if len(self.args) == 0:
                    self.entry.signature = TypeSlots.pyfunction_noargs
2879 2880 2881
                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
2882 2883 2884
            elif self.entry.signature is TypeSlots.pymethod_signature:
                if len(self.args) == 1:
                    self.entry.signature = TypeSlots.unaryfunc
2885 2886 2887
                elif len(self.args) == 2:
                    if self.args[1].default is None and not self.args[1].kw_only:
                        self.entry.signature = TypeSlots.ibinaryfunc
2888

William Stein's avatar
William Stein committed
2889 2890
        sig = self.entry.signature
        nfixed = sig.num_fixed_args()
2891 2892 2893 2894 2895 2896 2897 2898 2899
        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

2900 2901
        if self.is_staticmethod and env.is_c_class_scope:
            nfixed = 0
2902
            self.self_in_stararg = True  # FIXME: why for staticmethods?
2903 2904 2905 2906 2907 2908

            self.entry.signature = sig = copy.copy(sig)
            sig.fixed_arg_format = "*"
            sig.is_staticmethod = True
            sig.has_generic_args = True

2909 2910
        if ((self.is_classmethod or self.is_staticmethod) and
            self.has_fused_arguments and env.is_c_class_scope):
2911 2912
            del self.decorator_indirection.stats[:]

2913 2914 2915 2916 2917 2918 2919
        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
2920
                else:
2921 2922 2923
                    arg.is_self_arg = 1
                    arg.hdr_type = arg.type = env.parent_type
                arg.needs_conversion = 0
William Stein's avatar
William Stein committed
2924
            else:
2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939
                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
2940 2941 2942
            if not sig.has_generic_args:
                self.bad_signature()
            for arg in self.args:
Robert Bradshaw's avatar
Robert Bradshaw committed
2943 2944
                if arg.is_generic and \
                        (arg.type.is_extension_type or arg.type.is_builtin_type):
William Stein's avatar
William Stein committed
2945
                    arg.needs_type_test = 1
2946

William Stein's avatar
William Stein committed
2947 2948 2949 2950
    def bad_signature(self):
        sig = self.entry.signature
        expected_str = "%d" % sig.num_fixed_args()
        if sig.has_generic_args:
Stefan Behnel's avatar
Stefan Behnel committed
2951
            expected_str += " or more"
William Stein's avatar
William Stein committed
2952 2953 2954 2955 2956 2957 2958 2959 2960
        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))
2961

William Stein's avatar
William Stein committed
2962
    def declare_pyfunction(self, env):
2963 2964
        #print "DefNode.declare_pyfunction:", self.name, "in", env ###
        name = self.name
Stefan Behnel's avatar
Stefan Behnel committed
2965
        entry = env.lookup_here(name)
2966 2967
        if entry:
            if entry.is_final_cmethod and not env.parent_type.is_final_type:
Stefan Behnel's avatar
Stefan Behnel committed
2968
                error(self.pos, "Only final types can have final Python (def/cpdef) methods")
2969 2970 2971
            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)
2972
        entry = env.declare_pyfunction(name, self.pos, allow_redefine=not self.is_wrapper)
2973
        self.entry = entry
2974
        prefix = env.next_id(env.scope_prefix)
2975
        self.entry.pyfunc_cname = Naming.pyfunc_prefix + prefix + name
2976 2977
        if Options.docstrings:
            entry.doc = embed_position(self.pos, self.doc)
2978
            entry.doc_cname = Naming.funcdoc_prefix + prefix + name
2979
            if entry.is_special:
2980
                if entry.name in TypeSlots.invisible or not entry.doc or (entry.name in '__getattr__' and env.directives['fast_getattr']):
2981 2982 2983
                    entry.wrapperbase_cname = None
                else:
                    entry.wrapperbase_cname = Naming.wrapperbase_prefix + prefix + name
2984 2985
        else:
            entry.doc = None
2986

Stefan Behnel's avatar
Stefan Behnel committed
2987
    def declare_lambda_function(self, env):
2988
        entry = env.declare_lambda_function(self.lambda_name, self.pos)
Stefan Behnel's avatar
Stefan Behnel committed
2989 2990
        entry.doc = None
        self.entry = entry
2991
        self.entry.pyfunc_cname = entry.cname
Stefan Behnel's avatar
Stefan Behnel committed
2992

William Stein's avatar
William Stein committed
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002
    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)
3003
            arg.entry.is_arg = 1
3004
            arg.entry.used = 1
William Stein's avatar
William Stein committed
3005 3006 3007 3008 3009 3010
            arg.entry.is_self_arg = arg.is_self_arg
        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:
3011
            if env.directives['infer_types'] != False:
3012 3013 3014 3015
                type = PyrexTypes.unspecified_type
            else:
                type = py_object_type
            entry = env.declare_var(arg.name, type, arg.pos)
3016
            entry.is_arg = 1
3017 3018 3019 3020
            entry.used = 1
            entry.init = "0"
            entry.xdecref_cleanup = 1
            arg.entry = entry
3021

William Stein's avatar
William Stein committed
3022
    def analyse_expressions(self, env):
3023
        self.local_scope.directives = env.directives
William Stein's avatar
William Stein committed
3024
        self.analyse_default_values(env)
3025 3026 3027
        self.analyse_annotations(env)
        if self.return_type_annotation:
            self.return_type_annotation = self.return_type_annotation.analyse_types(env)
3028

3029
        if not self.needs_assignment_synthesis(env) and self.decorators:
3030
            for decorator in self.decorators[::-1]:
3031
                decorator.decorator = decorator.decorator.analyse_expressions(env)
3032

3033
        self.py_wrapper.prepare_argument_coercion(env)
3034
        return self
3035

3036
    def needs_assignment_synthesis(self, env, code=None):
3037
        if self.is_staticmethod:
3038
            return True
3039 3040
        if self.is_wrapper or self.specialized_cpdefs or self.entry.is_fused_specialized:
            return False
3041 3042
        if self.no_assignment_synthesis:
            return False
3043
        # Should enable for module level as well, that will require more testing...
3044
        if self.entry.is_anonymous:
3045
            return True
3046 3047 3048 3049 3050 3051 3052
        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

3053 3054 3055 3056
    def error_value(self):
        return self.entry.signature.error_value

    def caller_will_check_exceptions(self):
3057
        return self.entry.signature.exception_check
3058 3059

    def generate_function_definitions(self, env, code):
3060 3061 3062
        if self.defaults_getter:
            self.defaults_getter.generate_function_definitions(env, code)

3063 3064 3065 3066 3067 3068 3069
        # Before closure cnames are mangled
        if self.py_wrapper_required:
            # func_cname might be modified by @cname
            self.py_wrapper.func_cname = self.entry.func_cname
            self.py_wrapper.generate_function_definitions(env, code)
        FuncDefNode.generate_function_definitions(self, env, code)

3070
    def generate_function_header(self, code, with_pymethdef, proto_only=0):
3071 3072 3073 3074 3075
        if proto_only:
            if self.py_wrapper_required:
                self.py_wrapper.generate_function_header(
                    code, with_pymethdef, True)
            return
William Stein's avatar
William Stein committed
3076
        arg_code_list = []
3077
        if self.entry.signature.has_dummy_arg:
Stefan Behnel's avatar
Stefan Behnel committed
3078 3079 3080
            self_arg = 'PyObject *%s' % Naming.self_cname
            if not self.needs_outer_scope:
                self_arg = 'CYTHON_UNUSED ' + self_arg
3081 3082 3083 3084 3085 3086 3087 3088
            arg_code_list.append(self_arg)

        def arg_decl_code(arg):
            entry = arg.entry
            if entry.in_closure:
                cname = entry.original_cname
            else:
                cname = entry.cname
3089
            decl = entry.type.declaration_code(cname)
Stefan Behnel's avatar
Stefan Behnel committed
3090 3091 3092
            if not entry.cf_used:
                decl = 'CYTHON_UNUSED ' + decl
            return decl
3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 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 3157 3158

        for arg in self.args:
            arg_code_list.append(arg_decl_code(arg))
        if self.star_arg:
            arg_code_list.append(arg_decl_code(self.star_arg))
        if self.starstar_arg:
            arg_code_list.append(arg_decl_code(self.starstar_arg))
        arg_code = ', '.join(arg_code_list)
        dc = self.return_type.declaration_code(self.entry.pyfunc_cname)

        decls_code = code.globalstate['decls']
        preprocessor_guard = self.get_preprocessor_guard()
        if preprocessor_guard:
            decls_code.putln(preprocessor_guard)
        decls_code.putln(
            "static %s(%s); /* proto */" % (dc, arg_code))
        if preprocessor_guard:
            decls_code.putln("#endif")
        code.putln("static %s(%s) {" % (dc, arg_code))

    def generate_argument_declarations(self, env, code):
        pass

    def generate_keyword_list(self, code):
        pass

    def generate_argument_parsing_code(self, env, code):
        # Move arguments into closure if required
        def put_into_closure(entry):
            if entry.in_closure:
                code.putln('%s = %s;' % (entry.cname, entry.original_cname))
                code.put_var_incref(entry)
                code.put_var_giveref(entry)
        for arg in self.args:
            put_into_closure(arg.entry)
        for arg in self.star_arg, self.starstar_arg:
            if arg:
                put_into_closure(arg.entry)

    def generate_argument_type_tests(self, code):
        pass


class DefNodeWrapper(FuncDefNode):
    # DefNode python wrapper code generator

    defnode = None
    target = None # Target DefNode

    def __init__(self, *args, **kwargs):
        FuncDefNode.__init__(self, *args, **kwargs)
        self.num_kwonly_args = self.target.num_kwonly_args
        self.num_required_kw_args = self.target.num_required_kw_args
        self.num_required_args = self.target.num_required_args
        self.self_in_stararg = self.target.self_in_stararg
        self.signature = None

    def analyse_declarations(self, env):
        target_entry = self.target.entry
        name = self.name
        prefix = env.next_id(env.scope_prefix)
        target_entry.func_cname = Naming.pywrap_prefix + prefix + name
        target_entry.pymethdef_cname = Naming.pymethdef_prefix + prefix + name

        self.signature = target_entry.signature

3159
    def prepare_argument_coercion(self, env):
3160 3161 3162 3163 3164 3165 3166 3167
        # This is only really required for Cython utility code at this time,
        # everything else can be done during code generation.  But we expand
        # all utility code here, simply because we cannot easily distinguish
        # different code types.
        for arg in self.args:
            if not arg.type.is_pyobject:
                if not arg.type.create_from_py_utility_code(env):
                    pass # will fail later
Robert Bradshaw's avatar
Robert Bradshaw committed
3168
            elif arg.hdr_type and not arg.hdr_type.is_pyobject:
3169 3170
                if not arg.hdr_type.create_to_py_utility_code(env):
                    pass # will fail later
3171

3172 3173 3174 3175 3176 3177 3178 3179 3180
        if self.starstar_arg and not self.starstar_arg.entry.cf_used:
            # we will set the kwargs argument to NULL instead of a new dict
            # and must therefore correct the control flow state
            entry = self.starstar_arg.entry
            entry.xdecref_cleanup = 1
            for ass in entry.cf_assignments:
                if not ass.is_arg and ass.lhs.is_name:
                    ass.lhs.cf_maybe_null = True

3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196
    def signature_has_nongeneric_args(self):
        argcount = len(self.args)
        if argcount == 0 or (
                argcount == 1 and (self.args[0].is_self_arg or
                                   self.args[0].is_type_arg)):
            return 0
        return 1

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

    def generate_function_body(self, code):
        args = []
        if self.signature.has_dummy_arg:
            args.append(Naming.self_cname)
        for arg in self.args:
3197 3198 3199
            if arg.hdr_type and not (arg.type.is_memoryviewslice or
                                     arg.type.is_struct or
                                     arg.type.is_complex):
3200 3201 3202
                args.append(arg.type.cast_code(arg.entry.cname))
            else:
                args.append(arg.entry.cname)
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
        if self.star_arg:
            args.append(self.star_arg.entry.cname)
        if self.starstar_arg:
            args.append(self.starstar_arg.entry.cname)
        args = ', '.join(args)
        if not self.return_type.is_void:
            code.put('%s = ' % Naming.retval_cname)
        code.putln('%s(%s);' % (
            self.target.entry.pyfunc_cname, args))

    def generate_function_definitions(self, env, code):
        lenv = self.target.local_scope
        # Generate C code for header and body of function
3216
        code.mark_pos(self.pos)
3217 3218 3219 3220 3221 3222 3223 3224 3225
        code.putln("")
        code.putln("/* Python wrapper */")
        preprocessor_guard = self.target.get_preprocessor_guard()
        if preprocessor_guard:
            code.putln(preprocessor_guard)

        code.enter_cfunc_scope()
        code.return_from_error_cleanup_label = code.new_label()

Vitja Makarov's avatar
Vitja Makarov committed
3226
        with_pymethdef = (self.target.needs_assignment_synthesis(env, code) or
3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249
                          self.target.pymethdef_required)
        self.generate_function_header(code, with_pymethdef)
        self.generate_argument_declarations(lenv, code)
        tempvardecl_code = code.insertion_point()

        if self.return_type.is_pyobject:
            retval_init = ' = 0'
        else:
            retval_init = ''
        if not self.return_type.is_void:
            code.putln('%s%s;' % (
                self.return_type.declaration_code(Naming.retval_cname),
                retval_init))
        code.put_declare_refcount_context()
        code.put_setup_refcount_context('%s (wrapper)' % self.name)

        self.generate_argument_parsing_code(lenv, code)
        self.generate_argument_type_tests(code)
        self.generate_function_body(code)

        # ----- Go back and insert temp variable declarations
        tempvardecl_code.put_temp_declarations(code.funcstate)

3250 3251 3252 3253
        code.mark_pos(self.pos)
        code.putln("")
        code.putln("/* function exit code */")

3254 3255 3256 3257 3258 3259
        # ----- 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)
3260 3261 3262
            err_val = self.error_value()
            if err_val is not None:
                code.putln("%s = %s;" % (Naming.retval_cname, err_val))
3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281

        # ----- Non-error return cleanup
        code.put_label(code.return_label)
        for entry in lenv.var_entries:
            if entry.is_arg and entry.type.is_pyobject:
                code.put_var_decref(entry)

        code.put_finish_refcount_context()
        if not self.return_type.is_void:
            code.putln("return %s;" % Naming.retval_cname)
        code.putln('}')
        code.exit_cfunc_scope()
        if preprocessor_guard:
            code.putln("#endif /*!(%s)*/" % preprocessor_guard)

    def generate_function_header(self, code, with_pymethdef, proto_only=0):
        arg_code_list = []
        sig = self.signature

3282
        if sig.has_dummy_arg or self.self_in_stararg:
3283 3284 3285 3286
            arg_code = "PyObject *%s" % Naming.self_cname
            if not sig.has_dummy_arg:
                arg_code = 'CYTHON_UNUSED ' + arg_code
            arg_code_list.append(arg_code)
3287

William Stein's avatar
William Stein committed
3288 3289
        for arg in self.args:
            if not arg.is_generic:
3290
                if arg.is_self_arg or arg.is_type_arg:
William Stein's avatar
William Stein committed
3291 3292
                    arg_code_list.append("PyObject *%s" % arg.hdr_cname)
                else:
3293 3294 3295 3296
                    arg_code_list.append(
                        arg.hdr_type.declaration_code(arg.hdr_cname))
        entry = self.target.entry
        if not entry.is_special and sig.method_flags() == [TypeSlots.method_noargs]:
3297
            arg_code_list.append("CYTHON_UNUSED PyObject *unused")
3298
        if entry.scope.is_c_class_scope and entry.name == "__ipow__":
Lisandro Dalcin's avatar
Lisandro Dalcin committed
3299
            arg_code_list.append("CYTHON_UNUSED PyObject *unused")
William Stein's avatar
William Stein committed
3300 3301 3302 3303 3304
        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)
3305 3306 3307 3308 3309 3310

        # Prevent warning: unused function '__pyx_pw_5numpy_7ndarray_1__getbuffer__'
        mf = ""
        if (entry.name in ("__getbuffer__", "__releasebuffer__")
            and entry.scope.is_c_class_scope):
            mf = "CYTHON_UNUSED "
3311
            with_pymethdef = False
3312

3313
        dc = self.return_type.declaration_code(entry.func_cname)
3314
        header = "static %s%s(%s)" % (mf, dc, arg_code)
William Stein's avatar
William Stein committed
3315
        code.putln("%s; /*proto*/" % header)
3316

3317
        if proto_only:
3318
            if self.target.fused_py_func:
3319 3320 3321
                # If we are the specialized version of the cpdef, we still
                # want the prototype for the "fused cpdef", in case we're
                # checking to see if our method was overridden in Python
3322
                self.target.fused_py_func.generate_function_header(
3323
                                    code, with_pymethdef, proto_only=True)
3324
            return
3325

3326 3327 3328 3329
        if (Options.docstrings and entry.doc and
                not self.target.fused_py_func and
                not entry.scope.is_property_scope and
                (not entry.is_special or entry.wrapperbase_cname)):
3330
            # h_code = code.globalstate['h_code']
3331
            docstr = entry.doc
3332

Stefan Behnel's avatar
Stefan Behnel committed
3333
            if docstr.is_unicode:
3334
                docstr = docstr.as_utf8_string()
3335

William Stein's avatar
William Stein committed
3336
            code.putln(
3337
                'static char %s[] = %s;' % (
3338
                    entry.doc_cname,
3339
                    docstr.as_c_string_literal()))
3340

3341
            if entry.is_special:
3342
                code.putln('#if CYTHON_COMPILING_IN_CPYTHON')
3343
                code.putln(
3344
                    "struct wrapperbase %s;" % entry.wrapperbase_cname)
3345
                code.putln('#endif')
3346

3347
        if with_pymethdef or self.target.fused_py_func:
William Stein's avatar
William Stein committed
3348
            code.put(
3349
                "static PyMethodDef %s = " %
3350 3351
                    entry.pymethdef_cname)
            code.put_pymethoddef(self.target.entry, ";", allow_skip=False)
William Stein's avatar
William Stein committed
3352 3353 3354 3355
        code.putln("%s {" % header)

    def generate_argument_declarations(self, env, code):
        for arg in self.args:
3356
            if arg.is_generic:
3357 3358
                if arg.needs_conversion:
                    code.putln("PyObject *%s = 0;" % arg.hdr_cname)
3359
                else:
3360
                    code.put_var_declaration(arg.entry)
3361 3362 3363
        for entry in env.var_entries:
            if entry.is_arg:
                code.put_var_declaration(entry)
3364

3365
    def generate_argument_parsing_code(self, env, code):
Stefan Behnel's avatar
Stefan Behnel committed
3366 3367
        # Generate fast equivalent of PyArg_ParseTuple call for
        # generic arguments, if any, including args/kwargs
3368 3369
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
Stefan Behnel's avatar
Stefan Behnel committed
3370
        end_label = code.new_label("argument_unpacking_done")
3371

3372 3373 3374
        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
3375

3376
        for arg in self.args:
3377
            if not arg.type.is_pyobject:
3378 3379
                if not arg.type.create_from_py_utility_code(env):
                    pass # will fail later
3380

3381
        if not self.signature_has_generic_args():
3382 3383
            if has_star_or_kw_args:
                error(self.pos, "This method cannot have * or keyword arguments")
3384
            self.generate_argument_conversion_code(code)
3385

3386 3387
        elif not self.signature_has_nongeneric_args():
            # func(*args) or func(**kw) or func(*args, **kw)
3388
            self.generate_stararg_copy_code(code)
3389

3390
        else:
3391
            self.generate_tuple_and_keyword_parsing_code(self.args, end_label, code)
3392

3393 3394
        code.error_label = old_error_label
        if code.label_used(our_error_label):
3395 3396
            if not code.label_used(end_label):
                code.put_goto(end_label)
3397 3398 3399 3400 3401
            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:
3402
                        code.put_var_xdecref_clear(self.starstar_arg.entry)
3403
                    else:
3404
                        code.put_var_decref_clear(self.starstar_arg.entry)
3405
            code.put_add_traceback(self.target.entry.qualified_name)
3406
            code.put_finish_refcount_context()
3407
            code.putln("return %s;" % self.error_value())
3408
        if code.label_used(end_label):
3409 3410
            code.put_label(end_label)

William Stein's avatar
William Stein committed
3411 3412
    def generate_arg_xdecref(self, arg, code):
        if arg:
3413
            code.put_var_xdecref_clear(arg.entry)
3414

3415 3416
    def generate_arg_decref(self, arg, code):
        if arg:
3417
            code.put_var_decref_clear(arg.entry)
William Stein's avatar
William Stein committed
3418

3419 3420
    def generate_stararg_copy_code(self, code):
        if not self.star_arg:
3421 3422
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("RaiseArgTupleInvalid", "FunctionArguments.c"))
3423 3424 3425
            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
3426
                    self.name, Naming.args_cname, self.error_value()))
3427
            code.putln("}")
3428

3429
        if self.starstar_arg:
3430
            if self.star_arg or not self.starstar_arg.entry.cf_used:
3431 3432 3433 3434 3435 3436
                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)
3437 3438
        code.globalstate.use_utility_code(
            UtilityCode.load_cached("KeywordStringCheck", "FunctionArguments.c"))
3439
        code.putln(
3440 3441
            "if (%s && unlikely(!__Pyx_CheckKeywordStrings(%s, \"%s\", %d))) return %s;" % (
                kwarg_check, Naming.kwds_cname, self.name,
3442
                bool(self.starstar_arg), self.error_value()))
3443

3444 3445
        if self.starstar_arg and self.starstar_arg.entry.cf_used:
            if all(ref.node.allow_null for ref in self.starstar_arg.entry.cf_references):
3446 3447 3448 3449 3450 3451 3452 3453
                code.putln("if (%s) {" % kwarg_check)
                code.putln("%s = PyDict_Copy(%s); if (unlikely(!%s)) return %s;" % (
                        self.starstar_arg.entry.cname,
                        Naming.kwds_cname,
                        self.starstar_arg.entry.cname,
                        self.error_value()))
                code.put_gotref(self.starstar_arg.entry.cname)
                code.putln("} else {")
3454
                code.putln("%s = NULL;" % (self.starstar_arg.entry.cname,))
3455 3456 3457
                code.putln("}")
                self.starstar_arg.entry.xdecref_cleanup = 1
            else:
3458
                code.put("%s = (%s) ? PyDict_Copy(%s) : PyDict_New(); " % (
3459 3460 3461 3462 3463 3464 3465
                        self.starstar_arg.entry.cname,
                        Naming.kwds_cname,
                        Naming.kwds_cname))
                code.putln("if (unlikely(!%s)) return %s;" % (
                        self.starstar_arg.entry.cname, self.error_value()))
                self.starstar_arg.entry.xdecref_cleanup = 0
                code.put_gotref(self.starstar_arg.entry.cname)
3466

3467
        if self.self_in_stararg and not self.target.is_staticmethod:
3468 3469 3470 3471 3472
            # 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))
3473
            if self.starstar_arg and self.starstar_arg.entry.cf_used:
3474
                code.putln("{")
3475
                code.put_xdecref_clear(self.starstar_arg.entry.cname, py_object_type)
3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497
                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:
3498 3499 3500 3501 3502 3503
            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

3504
    def generate_tuple_and_keyword_parsing_code(self, args, success_label, code):
3505
        argtuple_error_label = code.new_label("argtuple_error")
3506

3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526
        positional_args = []
        required_kw_only_args = []
        optional_kw_only_args = []
        for arg in args:
            if arg.is_generic:
                if arg.default:
                    if not arg.is_self_arg and not arg.is_type_arg:
                        if arg.kw_only:
                            optional_kw_only_args.append(arg)
                        else:
                            positional_args.append(arg)
                elif arg.kw_only:
                    required_kw_only_args.append(arg)
                elif not arg.is_self_arg and not arg.is_type_arg:
                    positional_args.append(arg)

        # sort required kw-only args before optional ones to avoid special
        # cases in the unpacking code
        kw_only_args = required_kw_only_args + optional_kw_only_args

3527
        min_positional_args = self.num_required_args - self.num_required_kw_args
3528
        if len(args) > 0 and (args[0].is_self_arg or args[0].is_type_arg):
3529 3530
            min_positional_args -= 1
        max_positional_args = len(positional_args)
3531 3532
        has_fixed_positional_count = not self.star_arg and \
            min_positional_args == max_positional_args
3533
        has_kw_only_args = bool(kw_only_args)
3534

Stefan Behnel's avatar
Stefan Behnel committed
3535
        if self.num_required_kw_args:
3536 3537
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("RaiseKeywordRequired", "FunctionArguments.c"))
Stefan Behnel's avatar
Stefan Behnel committed
3538

3539 3540 3541
        if self.starstar_arg or self.star_arg:
            self.generate_stararg_init_code(max_positional_args, code)

3542 3543
        code.putln('{')
        all_args = tuple(positional_args) + tuple(kw_only_args)
3544 3545 3546 3547
        code.putln("static PyObject **%s[] = {%s,0};" % (
            Naming.pykwdlist_cname,
            ','.join([ '&%s' % code.intern_identifier(arg.name)
                        for arg in all_args ])))
3548 3549 3550 3551 3552 3553 3554 3555 3556 3557

        # Before being converted and assigned to the target variables,
        # borrowed references to all unpacked argument values are
        # collected into a local PyObject* array called "values",
        # regardless if they were taken from default arguments,
        # positional arguments or keyword arguments.  Note that
        # C-typed default arguments are handled at conversion time,
        # so their array value is NULL in the end if no argument
        # was passed for them.
        self.generate_argument_values_setup_code(all_args, code)
3558

3559
        # --- optimised code when we receive keyword arguments
3560 3561 3562
        code.putln("if (%s(%s)) {" % (
            (self.num_required_kw_args > 0) and "likely" or "unlikely",
            Naming.kwds_cname))
3563 3564
        self.generate_keyword_unpacking_code(
            min_positional_args, max_positional_args,
3565 3566
            has_fixed_positional_count, has_kw_only_args,
            all_args, argtuple_error_label, code)
3567 3568

        # --- optimised code when we do not receive any keyword arguments
3569
        if (self.num_required_kw_args and min_positional_args > 0) or min_positional_args == max_positional_args:
3570 3571 3572 3573 3574 3575 3576 3577 3578
            # 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)
3579

3580 3581 3582 3583 3584 3585 3586 3587 3588
        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:
3589
                    pystring_cname = code.intern_identifier(arg.name)
3590
                    # required keyword-only argument missing
3591
                    code.put('__Pyx_RaiseKeywordRequired("%s", %s); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
3592
                            self.name,
3593
                            pystring_cname))
3594 3595
                    code.putln(code.error_goto(self.pos))
                    break
3596

3597
        else:
3598
            # optimised tuple unpacking code
3599
            code.putln('} else {')
3600 3601 3602 3603 3604
            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))
3605
            else:
3606 3607 3608 3609 3610 3611 3612 3613
                # 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:
3614
                        code.put('case %2d: ' % (i+1))
3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625
                    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: ')
3626
                    code.put_goto(argtuple_error_label)
3627 3628
                code.putln('}')

3629
        code.putln('}') # end of the conditional unpacking blocks
3630

3631 3632 3633
        # Convert arg values to their final type and assign them.
        # Also inject non-Python default arguments, which do cannot
        # live in the values[] array.
3634 3635
        for i, arg in enumerate(all_args):
            self.generate_arg_assignment(arg, "values[%d]" % i, code)
3636

3637
        code.putln('}') # end of the whole argument unpacking block
3638 3639 3640 3641

        if code.label_used(argtuple_error_label):
            code.put_goto(success_label)
            code.put_label(argtuple_error_label)
3642 3643
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("RaiseArgTupleInvalid", "FunctionArguments.c"))
3644
            code.put('__Pyx_RaiseArgtupleInvalid("%s", %d, %d, %d, PyTuple_GET_SIZE(%s)); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
3645
                    self.name, has_fixed_positional_count,
3646 3647 3648 3649
                    min_positional_args, max_positional_args,
                    Naming.args_cname))
            code.putln(code.error_goto(self.pos))

3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681
    def generate_arg_assignment(self, arg, item, code):
        if arg.type.is_pyobject:
            # Python default arguments were already stored in 'item' at the very beginning
            if arg.is_generic:
                item = PyrexTypes.typecast(arg.type, PyrexTypes.py_object_type, item)
            entry = arg.entry
            code.putln("%s = %s;" % (entry.cname, item))
        else:
            func = arg.type.from_py_function
            if func:
                if arg.default:
                    # C-typed default arguments must be handled here
                    code.putln('if (%s) {' % item)
                rhs = "%s(%s)" % (func, item)
                if arg.type.is_enum:
                    rhs = arg.type.cast_code(rhs)
                code.putln("%s = %s; %s" % (
                    arg.entry.cname,
                    rhs,
                    code.error_goto_if(arg.type.error_condition(arg.entry.cname), arg.pos)))
                if arg.default:
                    code.putln('} else {')
                    code.putln(
                        "%s = %s;" % (
                            arg.entry.cname,
                            arg.calculate_default_value_code(code)))
                    if arg.type.is_memoryviewslice:
                        code.put_incref_memoryviewslice(arg.entry.cname,
                                                        have_gil=True)
                    code.putln('}')
            else:
                error(arg.pos, "Cannot convert Python object argument to type '%s'" % arg.type)
3682

3683
    def generate_stararg_init_code(self, max_positional_args, code):
3684
        if self.starstar_arg:
3685
            self.starstar_arg.entry.xdecref_cleanup = 0
Stefan Behnel's avatar
Stefan Behnel committed
3686 3687 3688 3689
            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
3690
            code.put_gotref(self.starstar_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
3691 3692 3693 3694 3695
        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))
3696
            code.putln('%s = PyTuple_GetSlice(%s, %d, PyTuple_GET_SIZE(%s));' % (
Stefan Behnel's avatar
Stefan Behnel committed
3697 3698
                    self.star_arg.entry.cname, Naming.args_cname,
                    max_positional_args, Naming.args_cname))
3699
            code.putln("if (unlikely(!%s)) {" % self.star_arg.entry.cname)
Stefan Behnel's avatar
Stefan Behnel committed
3700
            if self.starstar_arg:
3701
                code.put_decref_clear(self.starstar_arg.entry.cname, py_object_type)
3702 3703 3704 3705
            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
3706 3707 3708 3709
            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('}')
3710

3711
    def generate_argument_values_setup_code(self, args, code):
3712
        max_args = len(args)
Stefan Behnel's avatar
Stefan Behnel committed
3713 3714
        # the 'values' array collects borrowed references to arguments
        # before doing any type coercion etc.
3715
        code.putln("PyObject* values[%d] = {%s};" % (
Stefan Behnel's avatar
Stefan Behnel committed
3716
            max_args, ','.join('0'*max_args)))
3717

3718
        if self.target.defaults_struct:
3719
            code.putln('%s *%s = __Pyx_CyFunction_Defaults(%s, %s);' % (
3720 3721
                self.target.defaults_struct, Naming.dynamic_args_cname,
                self.target.defaults_struct, Naming.self_cname))
3722

3723 3724
        # assign borrowed Python default values to the values array,
        # so that they can be overwritten by received arguments below
3725
        for i, arg in enumerate(args):
3726 3727 3728 3729
            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)))

3730 3731 3732 3733
    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;')
3734
        code.putln('const Py_ssize_t pos_args = PyTuple_GET_SIZE(%s);' % Naming.args_cname)
3735
        # copy the values from the args tuple and check that it's not too long
3736
        code.putln('switch (pos_args) {')
Stefan Behnel's avatar
Stefan Behnel committed
3737 3738
        if self.star_arg:
            code.putln('default:')
3739
        for i in range(max_positional_args-1, -1, -1):
3740
            code.put('case %2d: ' % (i+1))
3741 3742
            code.putln("values[%d] = PyTuple_GET_ITEM(%s, %d);" % (
                    i, Naming.args_cname, i))
3743
        code.putln('case  0: break;')
3744
        if not self.star_arg:
Stefan Behnel's avatar
Stefan Behnel committed
3745
            code.put('default: ') # more arguments than allowed
3746
            code.put_goto(argtuple_error_label)
3747 3748
        code.putln('}')

3749 3750 3751 3752 3753 3754 3755 3756 3757
        # 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
3758
        code.putln('kw_args = PyDict_Size(%s);' % Naming.kwds_cname)
3759
        if self.num_required_args or max_positional_args > 0:
Stefan Behnel's avatar
Stefan Behnel committed
3760 3761 3762 3763
            last_required_arg = -1
            for i, arg in enumerate(all_args):
                if not arg.default:
                    last_required_arg = i
3764 3765
            if last_required_arg < max_positional_args:
                last_required_arg = max_positional_args-1
Stefan Behnel's avatar
Stefan Behnel committed
3766
            if max_positional_args > 0:
3767
                code.putln('switch (pos_args) {')
3768
            for i, arg in enumerate(all_args[:last_required_arg+1]):
Stefan Behnel's avatar
Stefan Behnel committed
3769
                if max_positional_args > 0 and i <= max_positional_args:
3770 3771 3772 3773
                    if self.star_arg and i == max_positional_args:
                        code.putln('default:')
                    else:
                        code.putln('case %2d:' % i)
3774
                pystring_cname = code.intern_identifier(arg.name)
3775
                if arg.default:
3776
                    if arg.kw_only:
3777
                        # optional kw-only args are handled separately below
3778
                        continue
3779
                    code.putln('if (kw_args > 0) {')
3780
                    # don't overwrite default argument
3781
                    code.putln('PyObject* value = PyDict_GetItem(%s, %s);' % (
3782
                        Naming.kwds_cname, pystring_cname))
3783
                    code.putln('if (value) { values[%d] = value; kw_args--; }' % i)
3784 3785
                    code.putln('}')
                else:
3786
                    code.putln('if (likely((values[%d] = PyDict_GetItem(%s, %s)) != 0)) kw_args--;' % (
3787
                        i, Naming.kwds_cname, pystring_cname))
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797
                    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 {')
3798 3799
                            code.globalstate.use_utility_code(
                                UtilityCode.load_cached("RaiseArgTupleInvalid", "FunctionArguments.c"))
3800
                            code.put('__Pyx_RaiseArgtupleInvalid("%s", %d, %d, %d, %d); ' % (
Stefan Behnel's avatar
Stefan Behnel committed
3801
                                    self.name, has_fixed_positional_count,
3802 3803 3804 3805
                                    min_positional_args, max_positional_args, i))
                            code.putln(code.error_goto(self.pos))
                            code.putln('}')
                    elif arg.kw_only:
3806
                        code.putln('else {')
3807
                        code.put('__Pyx_RaiseKeywordRequired("%s", %s); ' %(
Stefan Behnel's avatar
Stefan Behnel committed
3808
                                self.name, pystring_cname))
3809 3810
                        code.putln(code.error_goto(self.pos))
                        code.putln('}')
Stefan Behnel's avatar
Stefan Behnel committed
3811 3812
            if max_positional_args > 0:
                code.putln('}')
3813

3814
        if has_kw_only_args:
3815
            # unpack optional keyword-only arguments separately because
3816
            # checking for interned strings in a dict is faster than iterating
3817
            self.generate_optional_kwonly_args_unpacking_code(all_args, code)
3818

3819
        code.putln('if (unlikely(kw_args > 0)) {')
3820 3821
        # non-positional/-required kw args left in dict: default args,
        # kw-only args, **kwargs or error
Stefan Behnel's avatar
Stefan Behnel committed
3822 3823 3824 3825 3826
        #
        # 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.
3827 3828 3829
        if max_positional_args == 0:
            pos_arg_count = "0"
        elif self.star_arg:
3830 3831
            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
3832 3833
            pos_arg_count = "used_pos_args"
        else:
3834
            pos_arg_count = "pos_args"
3835 3836
        code.globalstate.use_utility_code(
            UtilityCode.load_cached("ParseKeywords", "FunctionArguments.c"))
Stefan Behnel's avatar
Stefan Behnel committed
3837 3838
        code.putln(
            'if (unlikely(__Pyx_ParseOptionalKeywords(%s, %s, %s, values, %s, "%s") < 0)) %s' % (
Stefan Behnel's avatar
Stefan Behnel committed
3839 3840 3841 3842
                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
3843 3844
                self.name,
                code.error_goto(self.pos)))
3845
        code.putln('}')
3846

3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877
    def generate_optional_kwonly_args_unpacking_code(self, all_args, code):
        optional_args = []
        first_optional_arg = -1
        for i, arg in enumerate(all_args):
            if not arg.kw_only or not arg.default:
                continue
            if not optional_args:
                first_optional_arg = i
            optional_args.append(arg.name)
        if optional_args:
            if len(optional_args) > 1:
                # if we receive more than the named kwargs, we either have **kwargs
                # (in which case we must iterate anyway) or it's an error (which we
                # also handle during iteration) => skip this part if there are more
                code.putln('if (kw_args > 0 && %s(kw_args <= %d)) {' % (
                    not self.starstar_arg and 'likely' or '',
                    len(optional_args)))
                code.putln('Py_ssize_t index;')
                # not unrolling the loop here reduces the C code overhead
                code.putln('for (index = %d; index < %d && kw_args > 0; index++) {' % (
                    first_optional_arg, first_optional_arg + len(optional_args)))
            else:
                code.putln('if (kw_args == 1) {')
                code.putln('const Py_ssize_t index = %d;' % first_optional_arg)
            code.putln('PyObject* value = PyDict_GetItem(%s, *%s[index]);' % (
                Naming.kwds_cname, Naming.pykwdlist_cname))
            code.putln('if (value) { values[index] = value; kw_args--; }')
            if len(optional_args) > 1:
                code.putln('}')
            code.putln('}')

William Stein's avatar
William Stein committed
3878
    def generate_argument_conversion_code(self, code):
3879 3880 3881
        # 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
3882 3883 3884 3885 3886 3887 3888 3889 3890
        for arg in self.args:
            if arg.needs_conversion:
                self.generate_arg_conversion(arg, code)

    def generate_arg_conversion(self, arg, code):
        # Generate conversion code for one argument.
        old_type = arg.hdr_type
        new_type = arg.type
        if old_type.is_pyobject:
Robert Bradshaw's avatar
Robert Bradshaw committed
3891 3892 3893 3894
            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
3895
            self.generate_arg_conversion_from_pyobject(arg, code)
Robert Bradshaw's avatar
Robert Bradshaw committed
3896
            code.putln("}")
William Stein's avatar
William Stein committed
3897 3898 3899 3900 3901 3902 3903 3904
        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,
3905
                    "Cannot convert 1 argument from '%s' to '%s'" %
William Stein's avatar
William Stein committed
3906
                        (old_type, new_type))
3907

William Stein's avatar
William Stein committed
3908 3909 3910
    def generate_arg_conversion_from_pyobject(self, arg, code):
        new_type = arg.type
        func = new_type.from_py_function
3911
        # copied from CoerceFromPyTypeNode
William Stein's avatar
William Stein committed
3912
        if func:
3913 3914 3915 3916 3917
            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" % (
3918
                lhs,
3919
                rhs,
3920
                code.error_goto_if(new_type.error_condition(arg.entry.cname), arg.pos)))
William Stein's avatar
William Stein committed
3921
        else:
3922 3923
            error(arg.pos,
                "Cannot convert Python object argument to type '%s'"
William Stein's avatar
William Stein committed
3924
                    % new_type)
3925

William Stein's avatar
William Stein committed
3926 3927 3928 3929
    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
3930
            code.putln("%s = %s(%s); %s" % (
William Stein's avatar
William Stein committed
3931 3932 3933
                arg.entry.cname,
                func,
                arg.hdr_cname,
Robert Bradshaw's avatar
Robert Bradshaw committed
3934
                code.error_goto_if_null(arg.entry.cname, arg.pos)))
3935
            code.put_var_gotref(arg.entry)
William Stein's avatar
William Stein committed
3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947
        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)
3948 3949 3950
            elif not arg.accept_none and (arg.type.is_pyobject or
                                          arg.type.is_buffer or
                                          arg.type.is_memoryviewslice):
3951 3952
                self.generate_arg_none_check(arg, code)

William Stein's avatar
William Stein committed
3953
    def error_value(self):
3954
        return self.signature.error_value
3955

3956 3957

class GeneratorDefNode(DefNode):
Stefan Behnel's avatar
Stefan Behnel committed
3958
    # Generator function node that creates a new generator instance when called.
3959
    #
Stefan Behnel's avatar
Stefan Behnel committed
3960
    # gbody          GeneratorBodyDefNode   the function implementing the generator
3961 3962 3963
    #

    is_generator = True
3964
    is_coroutine = False
3965 3966
    needs_closure = True

Stefan Behnel's avatar
Stefan Behnel committed
3967
    child_attrs = DefNode.child_attrs + ["gbody"]
3968

3969
    def __init__(self, pos, **kwargs):
3970
        # XXX: don't actually needs a body
3971 3972
        kwargs['body'] = StatListNode(pos, stats=[], is_terminator=True)
        super(GeneratorDefNode, self).__init__(pos, **kwargs)
3973 3974 3975 3976 3977 3978 3979 3980

    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
3981 3982
        name = code.intern_identifier(self.name)
        qualname = code.intern_identifier(self.qualname)
3983

3984
        code.putln('{')
3985
        code.putln('__pyx_CoroutineObject *gen = __Pyx_%s_New('
3986
                   '(__pyx_coroutine_body_t) %s, (PyObject *) %s, %s, %s); %s' % (
3987
                       'Coroutine' if self.is_coroutine else 'Generator',
3988
                       body_cname, Naming.cur_scope_cname, name, qualname,
3989 3990
                       code.error_goto_if_null('gen', self.pos)))
        code.put_decref(Naming.cur_scope_cname, py_object_type)
3991
        if self.requires_classobj:
3992
            classobj_cname = 'gen->classobj'
3993 3994 3995 3996
            code.putln('%s = __Pyx_CyFunction_GetClassObj(%s);' % (
                classobj_cname, Naming.self_cname))
            code.put_incref(classobj_cname, py_object_type)
            code.put_giveref(classobj_cname)
3997
        code.put_finish_refcount_context()
Stefan Behnel's avatar
Stefan Behnel committed
3998
        code.putln('return (PyObject *) gen;')
3999
        code.putln('}')
4000 4001

    def generate_function_definitions(self, env, code):
4002 4003
        env.use_utility_code(UtilityCode.load_cached(
            'Coroutine' if self.is_coroutine else 'Generator', "Coroutine.c"))
4004

4005 4006 4007 4008 4009
        self.gbody.generate_function_header(code, proto=True)
        super(GeneratorDefNode, self).generate_function_definitions(env, code)
        self.gbody.generate_function_definitions(env, code)


4010 4011 4012 4013
class AsyncDefNode(GeneratorDefNode):
    is_coroutine = True


4014
class GeneratorBodyDefNode(DefNode):
Stefan Behnel's avatar
Stefan Behnel committed
4015
    # Main code body of a generator implemented as a DefNode.
4016 4017 4018
    #

    is_generator_body = True
4019
    is_inlined = False
4020
    inlined_comprehension_type = None  # container type for inlined comprehensions
4021

4022
    def __init__(self, pos=None, name=None, body=None):
4023 4024 4025
        super(GeneratorBodyDefNode, self).__init__(
            pos=pos, body=body, name=name, doc=None,
            args=[], star_arg=None, starstar_arg=None)
4026

4027 4028
    def declare_generator_body(self, env):
        prefix = env.next_id(env.scope_prefix)
Vitja Makarov's avatar
Vitja Makarov committed
4029
        name = env.next_id('generator')
4030 4031 4032 4033
        cname = Naming.genbody_prefix + prefix + name
        entry = env.declare_var(None, py_object_type, self.pos,
                                cname=cname, visibility='private')
        entry.func_cname = cname
4034 4035 4036 4037 4038 4039
        entry.qualified_name = EncodedString(self.name)
        self.entry = entry

    def analyse_declarations(self, env):
        self.analyse_argument_types(env)
        self.declare_generator_body(env)
4040 4041

    def generate_function_header(self, code, proto=False):
4042
        header = "static PyObject *%s(__pyx_CoroutineObject *%s, PyObject *%s)" % (
4043
            self.entry.func_cname,
4044
            Naming.generator_cname,
4045 4046 4047 4048
            Naming.sent_value_cname)
        if proto:
            code.putln('%s; /* proto */' % header)
        else:
Stefan Behnel's avatar
Stefan Behnel committed
4049
            code.putln('%s /* generator body */\n{' % header)
4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066

    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)
4067
        closure_init_code = code.insertion_point()
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082
        # ----- 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)))

4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099
        # ----- prepare target container for inlined comprehension
        if self.is_inlined and self.inlined_comprehension_type is not None:
            target_type = self.inlined_comprehension_type
            if target_type is Builtin.list_type:
                comp_init = 'PyList_New(0)'
            elif target_type is Builtin.set_type:
                comp_init = 'PySet_New(NULL)'
            elif target_type is Builtin.dict_type:
                comp_init = 'PyDict_New()'
            else:
                raise InternalError(
                    "invalid type of inlined comprehension: %s" % target_type)
            code.putln("%s = %s; %s" % (
                Naming.retval_cname, comp_init,
                code.error_goto_if_null(Naming.retval_cname, self.pos)))
            code.put_gotref(Naming.retval_cname)

4100 4101
        # ----- Function body
        self.generate_function_body(env, code)
4102 4103 4104 4105 4106 4107
        # ----- Closure initialization
        if lenv.scope_class.type.scope.entries:
            closure_init_code.putln('%s = %s;' % (
                lenv.scope_class.type.declaration_code(Naming.cur_scope_cname),
                lenv.scope_class.type.cast_code('%s->closure' %
                                                Naming.generator_cname)))
4108 4109 4110 4111 4112

        code.mark_pos(self.pos)
        code.putln("")
        code.putln("/* function exit code */")

Stefan Behnel's avatar
Stefan Behnel committed
4113 4114
        # on normal generator termination, we do not take the exception propagation
        # path: no traceback info is required and not creating it is much faster
4115
        if not self.is_inlined and not self.body.is_terminator:
4116
            code.putln('PyErr_SetNone(PyExc_StopIteration);')
4117 4118
        # ----- Error cleanup
        if code.error_label in code.labels_used:
4119 4120
            if not self.body.is_terminator:
                code.put_goto(code.return_label)
4121
            code.put_label(code.error_label)
4122 4123
            if self.is_inlined and self.inlined_comprehension_type is not None:
                code.put_xdecref_clear(Naming.retval_cname, py_object_type)
4124 4125
            if Future.generator_stop in env.global_scope().context.future_directives:
                # PEP 479: turn accidental StopIteration exceptions into a RuntimeError
4126
                code.globalstate.use_utility_code(UtilityCode.load_cached("pep479", "Coroutine.c"))
4127
                code.putln("if (unlikely(PyErr_ExceptionMatches(PyExc_StopIteration))) "
4128
                           "__Pyx_Generator_Replace_StopIteration();")
4129 4130
            for cname, type in code.funcstate.all_managed_temps():
                code.put_xdecref(cname, type)
4131
            code.put_add_traceback(self.entry.qualified_name)
4132 4133 4134

        # ----- Non-error return cleanup
        code.put_label(code.return_label)
4135 4136 4137 4138
        if self.is_inlined:
            code.put_xgiveref(Naming.retval_cname)
        else:
            code.put_xdecref_clear(Naming.retval_cname, py_object_type)
4139
        code.putln('%s->resume_label = -1;' % Naming.generator_cname)
4140
        # clean up as early as possible to help breaking any reference cycles
4141
        code.putln('__Pyx_Coroutine_clear((PyObject*)%s);' % Naming.generator_cname)
4142
        code.put_finish_refcount_context()
4143
        code.putln("return %s;" % Naming.retval_cname)
4144 4145 4146 4147 4148
        code.putln("}")

        # ----- Go back and insert temp variable declarations
        tempvardecl_code.put_temp_declarations(code.funcstate)
        # ----- Generator resume code
4149
        resume_code.putln("switch (%s->resume_label) {" % (
Stefan Behnel's avatar
Stefan Behnel committed
4150
                       Naming.generator_cname))
4151
        resume_code.putln("case 0: goto %s;" % first_run_label)
4152

4153 4154
        for i, label in code.yield_labels:
            resume_code.putln("case %d: goto %s;" % (i, label))
Stefan Behnel's avatar
Stefan Behnel committed
4155
        resume_code.putln("default: /* CPython raises the right error here */")
4156
        resume_code.put_finish_refcount_context()
Stefan Behnel's avatar
Stefan Behnel committed
4157 4158
        resume_code.putln("return NULL;")
        resume_code.putln("}")
4159 4160 4161 4162

        code.exit_cfunc_scope()


4163 4164
class OverrideCheckNode(StatNode):
    # A Node for dispatching to the def method if it
4165
    # is overriden.
4166 4167 4168 4169 4170 4171
    #
    #  py_func
    #
    #  args
    #  func_temp
    #  body
4172

Robert Bradshaw's avatar
Robert Bradshaw committed
4173
    child_attrs = ['body']
4174

4175
    body = None
Robert Bradshaw's avatar
Robert Bradshaw committed
4176

4177 4178
    def analyse_expressions(self, env):
        self.args = env.arg_entries
4179 4180 4181 4182
        if self.py_func.is_module_scope:
            first_arg = 0
        else:
            first_arg = 1
4183
        from . import ExprNodes
4184
        self.func_node = ExprNodes.RawCNameExprNode(self.pos, py_object_type)
Stefan Behnel's avatar
Stefan Behnel committed
4185 4186
        call_node = ExprNodes.SimpleCallNode(
            self.pos, function=self.func_node,
4187 4188
            args=[ ExprNodes.NameNode(self.pos, name=arg.name)
                   for arg in self.args[first_arg:] ])
4189 4190 4191 4192 4193 4194
        if env.return_type.is_void or env.return_type.is_returncode:
            self.body = StatListNode(self.pos, stats=[
                            ExprStatNode(self.pos, expr=call_node),
                            ReturnStatNode(self.pos, value=None)])
        else:
            self.body = ReturnStatNode(self.pos, value=call_node)
4195 4196
        self.body = self.body.analyse_expressions(env)
        return self
4197

4198
    def generate_execution_code(self, code):
4199
        interned_attr_cname = code.intern_identifier(self.py_func.entry.name)
4200
        # Check to see if we are an extension type
4201 4202 4203 4204
        if self.py_func.is_module_scope:
            self_arg = "((PyObject *)%s)" % Naming.module_cname
        else:
            self_arg = "((PyObject *)%s)" % self.args[0].cname
4205
        code.putln("/* Check if called by wrapper */")
4206
        code.putln("if (unlikely(%s)) ;" % Naming.skip_dispatch_cname)
Stefan Behnel's avatar
Stefan Behnel committed
4207
        code.putln("/* Check if overridden in Python */")
4208 4209 4210
        if self.py_func.is_module_scope:
            code.putln("else {")
        else:
4211
            code.putln("else if (unlikely(Py_TYPE(%s)->tp_dictoffset != 0)) {" % self_arg)
4212 4213
        func_node_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        self.func_node.set_cname(func_node_temp)
4214
        # need to get attribute manually--scope would return cdef method
4215 4216
        code.globalstate.use_utility_code(
            UtilityCode.load_cached("PyObjectGetAttrStr", "ObjectHandling.c"))
4217
        err = code.error_goto_if_null(func_node_temp, self.pos)
4218
        code.putln("%s = __Pyx_PyObject_GetAttrStr(%s, %s); %s" % (
4219 4220 4221
            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
4222
        is_overridden = "(PyCFunction_GET_FUNCTION(%s) != (PyCFunction)%s)" % (
4223
            func_node_temp, self.py_func.entry.func_cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
4224
        code.putln("if (!%s || %s) {" % (is_builtin_function_or_method, is_overridden))
4225 4226
        self.body.generate_execution_code(code)
        code.putln("}")
4227 4228
        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
4229
        code.putln("}")
4230

4231

Robert Bradshaw's avatar
Robert Bradshaw committed
4232 4233
class ClassDefNode(StatNode, BlockNode):
    pass
4234

4235

Robert Bradshaw's avatar
Robert Bradshaw committed
4236
class PyClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
4237 4238
    #  A Python class definition.
    #
Stefan Behnel's avatar
Stefan Behnel committed
4239
    #  name     EncodedString   Name of the class
William Stein's avatar
William Stein committed
4240 4241 4242 4243
    #  doc      string or None
    #  body     StatNode        Attribute definition code
    #  entry    Symtab.Entry
    #  scope    PyClassScope
4244
    #  decorators    [DecoratorNode]        list of decorators or None
William Stein's avatar
William Stein committed
4245 4246 4247
    #
    #  The following subnodes are constructed internally:
    #
4248
    #  dict     DictNode   Class dictionary or Py3 namespace
William Stein's avatar
William Stein committed
4249 4250
    #  classobj ClassNode  Class object
    #  target   NameNode   Variable to assign class object to
4251

4252
    child_attrs = ["body", "dict", "metaclass", "mkw", "bases", "class_result",
4253
                   "target", "class_cell", "decorators"]
4254
    decorators = None
4255
    class_result = None
4256 4257 4258
    is_py3_style_class = False  # Python3 style class (kwargs)
    metaclass = None
    mkw = None
4259

4260
    def __init__(self, pos, name, bases, doc, body, decorators=None,
4261
                 keyword_args=None, force_py3_semantics=False):
William Stein's avatar
William Stein committed
4262 4263 4264 4265
        StatNode.__init__(self, pos)
        self.name = name
        self.doc = doc
        self.body = body
4266
        self.decorators = decorators
4267
        self.bases = bases
4268
        from . import ExprNodes
4269
        if self.doc and Options.docstrings:
4270
            doc = embed_position(self.pos, self.doc)
4271
            doc_node = ExprNodes.StringNode(pos, value=doc)
William Stein's avatar
William Stein committed
4272 4273
        else:
            doc_node = None
4274 4275

        allow_py2_metaclass = not force_py3_semantics
4276
        if keyword_args:
4277 4278
            allow_py2_metaclass = False
            self.is_py3_style_class = True
4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292
            if keyword_args.is_dict_literal:
                if keyword_args.key_value_pairs:
                    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]
                    self.mkw = keyword_args
                else:
                    assert self.metaclass is not None
4293
            else:
4294
                # MergedDictNode
4295
                self.mkw = ExprNodes.ProxyNode(keyword_args)
4296 4297

        if force_py3_semantics or self.bases or self.mkw or self.metaclass:
4298
            if self.metaclass is None:
4299
                if keyword_args and not keyword_args.is_dict_literal:
4300 4301 4302 4303
                    # **kwargs may contain 'metaclass' arg
                    mkdict = self.mkw
                else:
                    mkdict = None
4304 4305 4306 4307 4308 4309 4310
                if (not mkdict and
                        self.bases.is_sequence_constructor and
                        not self.bases.args):
                    pass  # no base classes => no inherited metaclass
                else:
                    self.metaclass = ExprNodes.PyClassMetaclassNode(
                        pos, mkw=mkdict, bases=self.bases)
4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323
                needs_metaclass_calculation = False
            else:
                needs_metaclass_calculation = True

            self.dict = ExprNodes.PyClassNamespaceNode(
                pos, name=name, doc=doc_node,
                metaclass=self.metaclass, bases=self.bases, mkw=self.mkw)
            self.classobj = ExprNodes.Py3ClassNode(
                pos, name=name,
                bases=self.bases, dict=self.dict, doc=doc_node,
                metaclass=self.metaclass, mkw=self.mkw,
                calculate_metaclass=needs_metaclass_calculation,
                allow_py2_metaclass=allow_py2_metaclass)
4324
        else:
4325 4326 4327 4328 4329 4330 4331
            # no bases, no metaclass => old style class creation
            self.dict = ExprNodes.DictNode(pos, key_value_pairs=[])
            self.classobj = ExprNodes.ClassNode(
                pos, name=name,
                bases=bases, dict=self.dict, doc=doc_node)

        self.target = ExprNodes.NameNode(pos, name=name)
4332
        self.class_cell = ExprNodes.ClassCellInjectorNode(self.pos)
4333

4334 4335
    def as_cclass(self):
        """
4336
        Return this node as if it were declared as an extension class
4337
        """
4338
        if self.is_py3_style_class:
4339 4340
            error(self.classobj.pos, "Python3 style class could not be represented as C class")
            return
4341 4342 4343 4344 4345 4346 4347
        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 = []
4348
            from .ExprNodes import AttributeNode, NameNode
4349
            while isinstance(base, AttributeNode):
4350 4351
                path.insert(0, base.attribute)
                base = base.obj
4352
            if isinstance(base, NameNode):
4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
                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
4364 4365

        return CClassDefNode(self.pos,
4366 4367 4368 4369 4370
                             visibility = 'private',
                             module_name = None,
                             class_name = self.name,
                             base_class_module = base_class_module,
                             base_class_name = base_class_name,
4371
                             decorators = self.decorators,
4372 4373 4374
                             body = self.body,
                             in_pxd = False,
                             doc = self.doc)
4375

4376 4377
    def create_scope(self, env):
        genv = env
4378 4379
        while genv.is_py_class_scope or genv.is_c_class_scope:
            genv = genv.outer_scope
4380 4381
        cenv = self.scope = PyClassScope(name = self.name, outer_scope = genv)
        return cenv
4382

William Stein's avatar
William Stein committed
4383
    def analyse_declarations(self, env):
4384 4385
        class_result = self.classobj
        if self.decorators:
4386
            from .ExprNodes import SimpleCallNode
4387 4388 4389 4390 4391
            for decorator in self.decorators[::-1]:
                class_result = SimpleCallNode(
                    decorator.pos,
                    function = decorator.decorator,
                    args = [class_result])
4392
            self.decorators = None
4393 4394
        self.class_result = class_result
        self.class_result.analyse_declarations(env)
William Stein's avatar
William Stein committed
4395
        self.target.analyse_target_declaration(env)
4396
        cenv = self.create_scope(env)
4397
        cenv.directives = env.directives
4398 4399
        cenv.class_obj_cname = self.target.entry.cname
        self.body.analyse_declarations(cenv)
4400

William Stein's avatar
William Stein committed
4401
    def analyse_expressions(self, env):
4402
        if self.bases:
4403
            self.bases = self.bases.analyse_expressions(env)
4404
        if self.metaclass:
4405
            self.metaclass = self.metaclass.analyse_expressions(env)
4406
        if self.mkw:
4407 4408 4409
            self.mkw = self.mkw.analyse_expressions(env)
        self.dict = self.dict.analyse_expressions(env)
        self.class_result = self.class_result.analyse_expressions(env)
William Stein's avatar
William Stein committed
4410
        genv = env.global_scope()
4411
        cenv = self.scope
4412
        self.body = self.body.analyse_expressions(cenv)
4413
        self.target.analyse_target_expression(env, self.classobj)
4414 4415
        self.class_cell = self.class_cell.analyse_expressions(cenv)
        return self
4416

4417
    def generate_function_definitions(self, env, code):
4418
        self.generate_lambda_definitions(self.scope, code)
4419
        self.body.generate_function_definitions(self.scope, code)
4420

William Stein's avatar
William Stein committed
4421
    def generate_execution_code(self, code):
4422
        code.mark_pos(self.pos)
4423 4424
        code.pyclass_stack.append(self)
        cenv = self.scope
4425
        if self.bases:
4426
            self.bases.generate_evaluation_code(code)
4427
        if self.mkw:
4428
            self.mkw.generate_evaluation_code(code)
4429
        if self.metaclass:
4430
            self.metaclass.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
4431
        self.dict.generate_evaluation_code(code)
Vitja Makarov's avatar
Vitja Makarov committed
4432
        cenv.namespace_cname = cenv.class_obj_cname = self.dict.result()
4433
        self.class_cell.generate_evaluation_code(code)
Vitja Makarov's avatar
Vitja Makarov committed
4434
        self.body.generate_execution_code(code)
4435
        self.class_result.generate_evaluation_code(code)
4436 4437 4438
        self.class_cell.generate_injection_code(
            code, self.class_result.result())
        self.class_cell.generate_disposal_code(code)
4439
        cenv.namespace_cname = cenv.class_obj_cname = self.classobj.result()
4440
        self.target.generate_assignment_code(self.class_result, code)
William Stein's avatar
William Stein committed
4441
        self.dict.generate_disposal_code(code)
4442
        self.dict.free_temps(code)
4443
        if self.metaclass:
4444 4445
            self.metaclass.generate_disposal_code(code)
            self.metaclass.free_temps(code)
4446 4447 4448 4449
        if self.mkw:
            self.mkw.generate_disposal_code(code)
            self.mkw.free_temps(code)
        if self.bases:
4450 4451
            self.bases.generate_disposal_code(code)
            self.bases.free_temps(code)
4452
        code.pyclass_stack.pop()
William Stein's avatar
William Stein committed
4453

Robert Bradshaw's avatar
Robert Bradshaw committed
4454
class CClassDefNode(ClassDefNode):
William Stein's avatar
William Stein committed
4455 4456 4457 4458
    #  An extension type definition.
    #
    #  visibility         'private' or 'public' or 'extern'
    #  typedef_flag       boolean
Stefan Behnel's avatar
Stefan Behnel committed
4459
    #  api                boolean
William Stein's avatar
William Stein committed
4460 4461 4462 4463 4464 4465 4466 4467
    #  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
4468
    #  decorators         [DecoratorNode]   list of decorators or None
William Stein's avatar
William Stein committed
4469 4470 4471 4472
    #  doc                string or None
    #  body               StatNode or None
    #  entry              Symtab.Entry
    #  base_type          PyExtensionType or None
4473 4474
    #  buffer_defaults_node DictNode or None Declares defaults for a buffer
    #  buffer_defaults_pos
4475

4476
    child_attrs = ["body"]
4477 4478
    buffer_defaults_node = None
    buffer_defaults_pos = None
4479 4480 4481 4482
    typedef_flag = False
    api = False
    objstruct_name = None
    typeobj_name = None
4483
    decorators = None
4484
    shadow = False
4485

Robert Bradshaw's avatar
Robert Bradshaw committed
4486 4487
    def buffer_defaults(self, env):
        if not hasattr(self, '_buffer_defaults'):
4488
            from . import Buffer
Robert Bradshaw's avatar
Robert Bradshaw committed
4489 4490 4491 4492 4493 4494 4495 4496 4497
            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

4498 4499 4500 4501 4502 4503 4504 4505
    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
4506

4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518
        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
4519
            buffer_defaults = self.buffer_defaults(env),
4520 4521
            shadow = self.shadow)

William Stein's avatar
William Stein committed
4522 4523 4524 4525
    def analyse_declarations(self, env):
        #print "CClassDefNode.analyse_declarations:", self.class_name
        #print "...visibility =", self.visibility
        #print "...module_name =", self.module_name
4526

William Stein's avatar
William Stein committed
4527 4528 4529
        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")
4530 4531 4532
        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
4533
        self.base_type = None
4534 4535
        # Now that module imports are cached, we need to
        # import the modules for extern classes.
4536 4537 4538 4539 4540 4541 4542
        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)
4543
                self.module.has_extern_class = 1
Robert Bradshaw's avatar
Robert Bradshaw committed
4544
                env.add_imported_module(self.module)
4545

William Stein's avatar
William Stein committed
4546 4547 4548 4549 4550
        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
4551 4552 4553 4554 4555 4556
            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
4557 4558 4559 4560 4561
            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)
4562
                    elif not base_class_entry.type.is_extension_type and \
Stefan Behnel's avatar
Stefan Behnel committed
4563
                             not (base_class_entry.type.is_builtin_type and
4564
                                  base_class_entry.type.objstruct_cname):
William Stein's avatar
William Stein committed
4565 4566
                        error(self.pos, "'%s' is not an extension type" % self.base_class_name)
                    elif not base_class_entry.type.is_complete():
4567 4568 4569
                        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 \
4570
                             base_class_entry.type.is_final_type:
4571 4572
                        error(self.pos, "Base class '%s' of type '%s' is final" % (
                            self.base_class_name, self.class_name))
4573 4574 4575 4576
                    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
4577 4578
                    else:
                        self.base_type = base_class_entry.type
4579
                if env.directives.get('freelist', 0) > 0:
Stefan Behnel's avatar
Stefan Behnel committed
4580
                    warning(self.pos, "freelists cannot be used on subtypes, only the base class can manage them", 1)
4581

William Stein's avatar
William Stein committed
4582
        has_body = self.body is not None
4583 4584 4585 4586 4587 4588
        if has_body and self.base_type and not self.base_type.scope:
            # To properly initialize inherited attributes, the base type must
            # be analysed before this type.
            self.base_type.defered_declarations.append(lambda : self.analyse_declarations(env))
            return

4589
        if self.module_name and self.visibility != 'extern':
4590 4591 4592 4593 4594 4595
            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
4596 4597

        if self.visibility == 'extern':
4598 4599 4600
            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
4601
                warning(self.pos, "%s already a builtin Cython type" % self.class_name, 1)
4602

4603
        self.entry = home_scope.declare_c_class(
4604
            name = self.class_name,
William Stein's avatar
William Stein committed
4605 4606 4607 4608 4609 4610 4611 4612
            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
4613
            typedef_flag = self.typedef_flag,
4614
            api = self.api,
Robert Bradshaw's avatar
Robert Bradshaw committed
4615
            buffer_defaults = self.buffer_defaults(env),
4616
            shadow = self.shadow)
4617

4618 4619
        if self.shadow:
            home_scope.lookup(self.class_name).as_variable = self.entry
4620
        if home_scope is not env and self.visibility == 'extern':
4621
            env.add_imported_entry(self.class_name, self.entry, self.pos)
4622
        self.scope = scope = self.entry.type.scope
4623 4624
        if scope is not None:
            scope.directives = env.directives
4625

4626
        if self.doc and Options.docstrings:
4627
            scope.doc = embed_position(self.pos, self.doc)
4628

William Stein's avatar
William Stein committed
4629 4630 4631 4632 4633 4634 4635
        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)
4636

4637 4638 4639
        for thunk in self.entry.type.defered_declarations:
            thunk()

William Stein's avatar
William Stein committed
4640 4641
    def analyse_expressions(self, env):
        if self.body:
Robert Bradshaw's avatar
Robert Bradshaw committed
4642
            scope = self.entry.type.scope
4643 4644
            self.body = self.body.analyse_expressions(scope)
        return self
4645

4646
    def generate_function_definitions(self, env, code):
William Stein's avatar
William Stein committed
4647
        if self.body:
4648 4649
            self.generate_lambda_definitions(self.scope, code)
            self.body.generate_function_definitions(self.scope, code)
4650

William Stein's avatar
William Stein committed
4651 4652 4653
    def generate_execution_code(self, code):
        # This is needed to generate evaluation code for
        # default values of method arguments.
4654
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
4655 4656
        if self.body:
            self.body.generate_execution_code(code)
4657

4658 4659 4660
    def annotate(self, code):
        if self.body:
            self.body.annotate(code)
William Stein's avatar
William Stein committed
4661 4662 4663 4664 4665 4666


class PropertyNode(StatNode):
    #  Definition of a property in an extension type.
    #
    #  name   string
4667
    #  doc    EncodedString or None    Doc string
4668
    #  entry  Symtab.Entry
William Stein's avatar
William Stein committed
4669
    #  body   StatListNode
4670

4671 4672
    child_attrs = ["body"]

William Stein's avatar
William Stein committed
4673
    def analyse_declarations(self, env):
4674 4675 4676
        self.entry = env.declare_property(self.name, self.doc, self.pos)
        self.entry.scope.directives = env.directives
        self.body.analyse_declarations(self.entry.scope)
4677

William Stein's avatar
William Stein committed
4678
    def analyse_expressions(self, env):
4679 4680
        self.body = self.body.analyse_expressions(env)
        return self
4681

4682 4683
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
William Stein's avatar
William Stein committed
4684 4685 4686 4687

    def generate_execution_code(self, code):
        pass

4688 4689 4690
    def annotate(self, code):
        self.body.annotate(code)

William Stein's avatar
William Stein committed
4691 4692 4693 4694 4695

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

4697 4698
    child_attrs = []

William Stein's avatar
William Stein committed
4699 4700 4701 4702 4703
    def analyse_declarations(self, env):
        for name in self.names:
            env.declare_global(name, self.pos)

    def analyse_expressions(self, env):
4704
        return self
4705

William Stein's avatar
William Stein committed
4706 4707 4708 4709
    def generate_execution_code(self, code):
        pass


4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721
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):
4722
        return self
4723 4724 4725 4726 4727

    def generate_execution_code(self, code):
        pass


William Stein's avatar
William Stein committed
4728 4729 4730 4731
class ExprStatNode(StatNode):
    #  Expression used as a statement.
    #
    #  expr   ExprNode
4732 4733

    child_attrs = ["expr"]
4734

Robert Bradshaw's avatar
Robert Bradshaw committed
4735
    def analyse_declarations(self, env):
4736
        from . import ExprNodes
Robert Bradshaw's avatar
Robert Bradshaw committed
4737
        if isinstance(self.expr, ExprNodes.GeneralCallNode):
4738
            func = self.expr.function.as_cython_attribute()
Robert Bradshaw's avatar
Robert Bradshaw committed
4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749
            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
4750

William Stein's avatar
William Stein committed
4751
    def analyse_expressions(self, env):
4752
        self.expr.result_is_used = False # hint that .result() may safely be left empty
4753 4754
        self.expr = self.expr.analyse_expressions(env)
        return self
4755

4756
    def nogil_check(self, env):
4757
        if self.expr.type.is_pyobject and self.expr.is_temp:
4758 4759 4760 4761
            self.gil_error()

    gil_message = "Discarding owned Python object"

William Stein's avatar
William Stein committed
4762
    def generate_execution_code(self, code):
4763
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
4764
        self.expr.generate_evaluation_code(code)
4765 4766
        if not self.expr.is_temp and self.expr.result():
            code.putln("%s;" % self.expr.result())
William Stein's avatar
William Stein committed
4767
        self.expr.generate_disposal_code(code)
4768
        self.expr.free_temps(code)
William Stein's avatar
William Stein committed
4769

4770 4771 4772
    def generate_function_definitions(self, env, code):
        self.expr.generate_function_definitions(env, code)

4773 4774 4775
    def annotate(self, code):
        self.expr.annotate(code)

William Stein's avatar
William Stein committed
4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786

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):
4787
        node = self.analyse_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4788
        if isinstance(node, AssignmentNode) and not isinstance(node, ParallelAssignmentNode):
4789
            if node.rhs.type.is_ptr and node.rhs.is_ephemeral():
4790 4791
                error(self.pos, "Storing unsafe C derivative of temporary Python reference")
        return node
4792

4793 4794 4795
#       def analyse_expressions(self, env):
#           self.analyse_expressions_1(env)
#           self.analyse_expressions_2(env)
William Stein's avatar
William Stein committed
4796 4797

    def generate_execution_code(self, code):
4798
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
4799 4800
        self.generate_rhs_evaluation_code(code)
        self.generate_assignment_code(code)
4801

William Stein's avatar
William Stein committed
4802 4803 4804 4805 4806 4807

class SingleAssignmentNode(AssignmentNode):
    #  The simplest case:
    #
    #    a = b
    #
4808 4809 4810 4811
    #  lhs                      ExprNode      Left hand side
    #  rhs                      ExprNode      Right hand side
    #  first                    bool          Is this guaranteed the first assignment to lhs?
    #  is_overloaded_assignment bool          Is this assignment done via an overloaded operator=
4812 4813
    #  exception_check
    #  exception_value
4814

4815
    child_attrs = ["lhs", "rhs"]
4816
    first = False
4817
    is_overloaded_assignment = False
4818
    declaration_only = False
William Stein's avatar
William Stein committed
4819 4820

    def analyse_declarations(self, env):
4821
        from . import ExprNodes
4822

4823 4824
        # handle declarations of the form x = cython.foo()
        if isinstance(self.rhs, ExprNodes.CallNode):
4825
            func_name = self.rhs.function.as_cython_attribute()
4826 4827
            if func_name:
                args, kwds = self.rhs.explicit_args_kwds()
4828

4829
                if func_name in ['declare', 'typedef']:
Robert Bradshaw's avatar
Robert Bradshaw committed
4830
                    if len(args) > 2 or kwds is not None:
4831
                        error(self.rhs.pos, "Can only declare one type at a time.")
4832
                        return
4833

4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848
                    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
4849 4850 4851 4852 4853
                        if len(args) == 2:
                            # we have a value
                            self.rhs = args[1]
                        else:
                            self.declaration_only = True
4854
                    else:
Robert Bradshaw's avatar
Robert Bradshaw committed
4855
                        self.declaration_only = True
4856 4857
                        if not isinstance(lhs, ExprNodes.NameNode):
                            error(lhs.pos, "Invalid declaration.")
4858
                        env.declare_typedef(lhs.name, type, self.pos, visibility='private')
4859

4860 4861 4862
                elif func_name in ['struct', 'union']:
                    self.declaration_only = True
                    if len(args) > 0 or kwds is None:
4863
                        error(self.rhs.pos, "Struct or union members must be given by name.")
4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880
                        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)
4881

Mark Florisson's avatar
Mark Florisson committed
4882 4883 4884 4885 4886 4887 4888 4889
                elif func_name == 'fused_type':
                    # dtype = cython.fused_type(...)
                    self.declaration_only = True
                    if kwds:
                        error(self.rhs.function.pos,
                              "fused_type does not take keyword arguments")

                    fusednode = FusedTypeNode(self.rhs.pos,
4890
                                              name=self.lhs.name, types=args)
Mark Florisson's avatar
Mark Florisson committed
4891 4892
                    fusednode.analyse_declarations(env)

4893 4894 4895 4896
        if self.declaration_only:
            return
        else:
            self.lhs.analyse_target_declaration(env)
4897

4898 4899
    def analyse_types(self, env, use_temp=0):
        from . import ExprNodes
4900

4901
        self.rhs = self.rhs.analyse_types(env)
4902

4903 4904 4905
        unrolled_assignment = self.unroll_rhs(env)
        if unrolled_assignment:
            return unrolled_assignment
Robert Bradshaw's avatar
Robert Bradshaw committed
4906

4907
        self.lhs = self.lhs.analyse_target_types(env)
4908
        self.lhs.gil_assignment_check(env)
4909 4910 4911
        unrolled_assignment = self.unroll_lhs(env)
        if unrolled_assignment:
            return unrolled_assignment
4912

4913 4914 4915
        if isinstance(self.lhs, ExprNodes.MemoryViewIndexNode):
            self.lhs.analyse_broadcast_operation(self.rhs)
            self.lhs = self.lhs.analyse_as_memview_scalar_assignment(self.rhs)
4916
        elif self.lhs.type.is_array:
4917
            if not isinstance(self.lhs, ExprNodes.SliceIndexNode):
4918
                # cannot assign to C array, only to its full slice
4919
                self.lhs = ExprNodes.SliceIndexNode(self.lhs.pos, base=self.lhs, start=None, stop=None)
4920
                self.lhs = self.lhs.analyse_target_types(env)
4921

4922 4923 4924 4925
        if self.lhs.type.is_cpp_class:
            op = env.lookup_operator_for_types(self.pos, '=', [self.lhs.type, self.rhs.type])
            if op:
                rhs = self.rhs
4926
                self.is_overloaded_assignment = True
4927 4928 4929 4930
                self.exception_check = op.type.exception_check
                self.exception_value = op.type.exception_value
                if self.exception_check == '+' and self.exception_value is None:
                    env.use_utility_code(UtilityCode.load_cached("CppExceptionConversion", "CppSupport.cpp"))
4931
            else:
4932
                rhs = self.rhs.coerce_to(self.lhs.type, env)
4933
        else:
4934 4935
            rhs = self.rhs.coerce_to(self.lhs.type, env)

4936 4937 4938
        if use_temp or rhs.is_attribute or (
                not rhs.is_name and not rhs.is_literal and
                rhs.type.is_pyobject):
4939
            # things like (cdef) attribute access are not safe (traverses pointers)
4940 4941 4942 4943
            rhs = rhs.coerce_to_temp(env)
        elif rhs.type.is_pyobject:
            rhs = rhs.coerce_to_simple(env)
        self.rhs = rhs
4944
        return self
4945

4946 4947
    def unroll(self, node, target_size, env):
        from . import ExprNodes, UtilNodes
4948 4949 4950 4951

        base = node
        start_node = stop_node = step_node = check_node = None

4952
        if node.type.is_ctuple:
4953
            slice_size = node.type.size
4954

4955 4956 4957
        elif node.type.is_ptr or node.type.is_array:
            while isinstance(node, ExprNodes.SliceIndexNode) and not (node.start or node.stop):
                base = node = node.base
4958 4959 4960
            if isinstance(node, ExprNodes.SliceIndexNode):
                base = node.base
                start_node = node.start
4961 4962
                if start_node:
                    start_node = start_node.coerce_to(PyrexTypes.c_py_ssize_t_type, env)
4963
                stop_node = node.stop
4964 4965 4966
                if stop_node:
                    stop_node = stop_node.coerce_to(PyrexTypes.c_py_ssize_t_type, env)
                else:
4967
                    if node.type.is_array and node.type.size:
4968 4969
                        stop_node = ExprNodes.IntNode(
                            self.pos, value=str(node.type.size),
4970
                            constant_result=(node.type.size if isinstance(node.type.size, _py_int_types)
4971
                                             else ExprNodes.constant_value_not_set))
4972 4973 4974
                    else:
                        error(self.pos, "C array iteration requires known end index")
                        return
4975
                step_node = None  #node.step
4976 4977
                if step_node:
                    step_node = step_node.coerce_to(PyrexTypes.c_py_ssize_t_type, env)
4978

4979 4980 4981 4982
                # TODO: Factor out SliceIndexNode.generate_slice_guard_code() for use here.
                def get_const(node, none_value):
                    if node is None:
                        return none_value
4983
                    elif node.has_constant_result():
4984 4985
                        return node.constant_result
                    else:
4986 4987
                        raise ValueError("Not a constant.")

4988 4989 4990 4991 4992
                try:
                    slice_size = (get_const(stop_node, None) - get_const(start_node, 0)) / get_const(step_node, 1)
                except ValueError:
                    error(self.pos, "C array assignment currently requires known endpoints")
                    return
4993 4994 4995

            elif node.type.is_array:
                slice_size = node.type.size
4996
                if not isinstance(slice_size, _py_int_types):
4997
                    return  # might still work when coercing to Python
4998 4999 5000 5001 5002 5003
            else:
                return

        else:
            return

5004 5005 5006 5007 5008
        if slice_size != target_size:
            error(self.pos, "Assignment to/from slice of wrong length, expected %s, got %s" % (
                slice_size, target_size))
            return

5009
        items = []
5010 5011 5012
        base = UtilNodes.LetRefNode(base)
        refs = [base]
        if start_node and not start_node.is_literal:
5013 5014
            start_node = UtilNodes.LetRefNode(start_node)
            refs.append(start_node)
5015
        if stop_node and not stop_node.is_literal:
5016 5017
            stop_node = UtilNodes.LetRefNode(stop_node)
            refs.append(stop_node)
5018
        if step_node and not step_node.is_literal:
5019 5020
            step_node = UtilNodes.LetRefNode(step_node)
            refs.append(step_node)
5021

5022
        for ix in range(target_size):
5023
            ix_node = ExprNodes.IntNode(self.pos, value=str(ix), constant_result=ix, type=PyrexTypes.c_py_ssize_t_type)
5024
            if step_node is not None:
5025 5026 5027 5028 5029
                if step_node.has_constant_result():
                    step_value = ix_node.constant_result * step_node.constant_result
                    ix_node = ExprNodes.IntNode(self.pos, value=str(step_value), constant_result=step_value)
                else:
                    ix_node = ExprNodes.MulNode(self.pos, operator='*', operand1=step_node, operand2=ix_node)
5030
            if start_node is not None:
5031 5032 5033 5034 5035 5036 5037
                if start_node.has_constant_result() and ix_node.has_constant_result():
                    index_value = ix_node.constant_result + start_node.constant_result
                    ix_node = ExprNodes.IntNode(self.pos, value=str(index_value), constant_result=index_value)
                else:
                    ix_node = ExprNodes.AddNode(
                        self.pos, operator='+', operand1=start_node, operand2=ix_node)
            items.append(ExprNodes.IndexNode(self.pos, base=base, index=ix_node.analyse_types(env)))
5038 5039
        return check_node, refs, items

5040
    def unroll_assignments(self, refs, check_node, lhs_list, rhs_list, env):
5041
        from . import UtilNodes
5042
        assignments = []
5043
        for lhs, rhs in zip(lhs_list, rhs_list):
5044
            assignments.append(SingleAssignmentNode(self.pos, lhs=lhs, rhs=rhs, first=self.first))
5045
        node = ParallelAssignmentNode(pos=self.pos, stats=assignments).analyse_expressions(env)
5046
        if check_node:
5047
            node = StatListNode(pos=self.pos, stats=[check_node, node])
5048
        for ref in refs[::-1]:
5049 5050
            node = UtilNodes.LetNode(ref, node)
        return node
5051

5052
    def unroll_rhs(self, env):
5053
        from . import ExprNodes
5054 5055
        if not isinstance(self.lhs, ExprNodes.TupleNode):
            return
5056 5057
        if any(arg.is_starred for arg in self.lhs.args):
            return
5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068

        unrolled = self.unroll(self.rhs, len(self.lhs.args), env)
        if not unrolled:
            return
        check_node, refs, rhs = unrolled
        return self.unroll_assignments(refs, check_node, self.lhs.args, rhs, env)

    def unroll_lhs(self, env):
        if self.lhs.type.is_ctuple:
            # Handled directly.
            return
5069
        from . import ExprNodes
5070 5071 5072 5073 5074 5075 5076 5077 5078
        if not isinstance(self.rhs, ExprNodes.TupleNode):
            return

        unrolled = self.unroll(self.lhs, len(self.rhs.args), env)
        if not unrolled:
            return
        check_node, refs, lhs = unrolled
        return self.unroll_assignments(refs, check_node, lhs, self.rhs.args, env)

William Stein's avatar
William Stein committed
5079 5080
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
5081

5082
    def generate_assignment_code(self, code, overloaded_assignment=False):
5083 5084 5085 5086 5087 5088 5089 5090 5091
        if self.is_overloaded_assignment:
            self.lhs.generate_assignment_code(
                self.rhs,
                code,
                overloaded_assignment=self.is_overloaded_assignment,
                exception_check=self.exception_check,
                exception_value=self.exception_value)
        else:
            self.lhs.generate_assignment_code(self.rhs, code)
William Stein's avatar
William Stein committed
5092

5093 5094 5095
    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

5096 5097 5098 5099
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)

William Stein's avatar
William Stein committed
5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110

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:
    #
5111 5112 5113
    #  coerced_values       [ExprNode]   RHS coerced to all distinct LHS types
    #  cloned_values        [ExprNode]   cloned RHS value for each LHS
    #  assignment_overloads [Bool]       If each assignment uses a C++ operator=
5114

5115 5116
    child_attrs = ["lhs_list", "rhs", "coerced_values", "cloned_values"]
    cloned_values = None
5117
    coerced_values = None
5118
    assignment_overloads = None
5119

William Stein's avatar
William Stein committed
5120 5121 5122
    def analyse_declarations(self, env):
        for lhs in self.lhs_list:
            lhs.analyse_target_declaration(env)
5123

5124
    def analyse_types(self, env, use_temp=0):
5125
        from .ExprNodes import CloneNode, ProxyNode
5126

5127
        # collect distinct types used on the LHS
5128
        lhs_types = set()
5129 5130
        for i, lhs in enumerate(self.lhs_list):
            lhs = self.lhs_list[i] = lhs.analyse_target_types(env)
5131 5132 5133
            lhs.gil_assignment_check(env)
            lhs_types.add(lhs.type)

5134
        rhs = self.rhs.analyse_types(env)
5135
        # common special case: only one type needed on the LHS => coerce only once
5136
        if len(lhs_types) == 1:
5137 5138 5139 5140 5141 5142 5143
            # Avoid coercion for overloaded assignment operators.
            if next(iter(lhs_types)).is_cpp_class:
                op = env.lookup_operator('=', [lhs, self.rhs])
                if not op:
                    rhs = rhs.coerce_to(lhs_types.pop(), env)
            else:
                rhs = rhs.coerce_to(lhs_types.pop(), env)
5144 5145 5146

        if not rhs.is_name and not rhs.is_literal and (
                use_temp or rhs.is_attribute or rhs.type.is_pyobject):
5147
            rhs = rhs.coerce_to_temp(env)
5148
        else:
5149
            rhs = rhs.coerce_to_simple(env)
5150 5151
        self.rhs = ProxyNode(rhs) if rhs.is_temp else rhs

5152
        # clone RHS and coerce it to all distinct LHS types
5153 5154
        self.coerced_values = []
        coerced_values = {}
5155
        self.assignment_overloads = []
5156
        for lhs in self.lhs_list:
5157 5158
            overloaded = lhs.type.is_cpp_class and env.lookup_operator('=', [lhs, self.rhs])
            self.assignment_overloads.append(overloaded)
5159
            if lhs.type not in coerced_values and lhs.type != rhs.type:
5160
                rhs = CloneNode(self.rhs)
5161
                if not overloaded:
5162
                    rhs = rhs.coerce_to(lhs.type, env)
5163 5164
                self.coerced_values.append(rhs)
                coerced_values[lhs.type] = rhs
5165

5166 5167
        # clone coerced values for all LHS assignments
        self.cloned_values = []
William Stein's avatar
William Stein committed
5168
        for lhs in self.lhs_list:
5169
            rhs = coerced_values.get(lhs.type, self.rhs)
5170
            self.cloned_values.append(CloneNode(rhs))
5171
        return self
5172

William Stein's avatar
William Stein committed
5173 5174
    def generate_rhs_evaluation_code(self, code):
        self.rhs.generate_evaluation_code(code)
5175

5176
    def generate_assignment_code(self, code, overloaded_assignment=False):
5177
        # prepare all coercions
5178 5179
        for rhs in self.coerced_values:
            rhs.generate_evaluation_code(code)
5180
        # assign clones to LHS
5181
        for lhs, rhs, overload in zip(self.lhs_list, self.cloned_values, self.assignment_overloads):
William Stein's avatar
William Stein committed
5182
            rhs.generate_evaluation_code(code)
5183
            lhs.generate_assignment_code(rhs, code, overloaded_assignment=overload)
5184 5185 5186 5187
        # dispose of coerced values and original RHS
        for rhs_value in self.coerced_values:
            rhs_value.generate_disposal_code(code)
            rhs_value.free_temps(code)
William Stein's avatar
William Stein committed
5188
        self.rhs.generate_disposal_code(code)
5189
        self.rhs.free_temps(code)
William Stein's avatar
William Stein committed
5190

5191 5192 5193
    def generate_function_definitions(self, env, code):
        self.rhs.generate_function_definitions(env, code)

5194
    def annotate(self, code):
5195 5196
        for rhs in self.coerced_values:
            rhs.annotate(code)
5197
        for lhs, rhs in zip(self.lhs_list, self.cloned_values):
5198 5199
            lhs.annotate(code)
            rhs.annotate(code)
5200
        self.rhs.annotate(code)
5201

5202

William Stein's avatar
William Stein committed
5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215
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
5216

5217 5218
    child_attrs = ["stats"]

William Stein's avatar
William Stein committed
5219 5220 5221
    def analyse_declarations(self, env):
        for stat in self.stats:
            stat.analyse_declarations(env)
5222

William Stein's avatar
William Stein committed
5223
    def analyse_expressions(self, env):
5224 5225 5226
        self.stats = [ stat.analyse_types(env, use_temp = 1)
                       for stat in self.stats ]
        return self
5227

Robert Bradshaw's avatar
Robert Bradshaw committed
5228 5229 5230 5231 5232
#    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)
5233

William Stein's avatar
William Stein committed
5234
    def generate_execution_code(self, code):
5235
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
5236 5237 5238 5239 5240
        for stat in self.stats:
            stat.generate_rhs_evaluation_code(code)
        for stat in self.stats:
            stat.generate_assignment_code(code)

5241 5242 5243 5244
    def generate_function_definitions(self, env, code):
        for stat in self.stats:
            stat.generate_function_definitions(env, code)

5245 5246 5247 5248 5249
    def annotate(self, code):
        for stat in self.stats:
            stat.annotate(code)


5250
class InPlaceAssignmentNode(AssignmentNode):
Craig Citro's avatar
Craig Citro committed
5251
    #  An in place arithmetic operand:
5252 5253 5254 5255 5256 5257 5258
    #
    #    a += b
    #    a -= b
    #    ...
    #
    #  lhs      ExprNode      Left hand side
    #  rhs      ExprNode      Right hand side
Stefan Behnel's avatar
Stefan Behnel committed
5259
    #  operator char          one of "+-*/%^&|"
5260
    #
5261 5262 5263 5264 5265 5266 5267
    #  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).

5268
    child_attrs = ["lhs", "rhs"]
5269

5270 5271
    def analyse_declarations(self, env):
        self.lhs.analyse_target_declaration(env)
5272

5273
    def analyse_types(self, env):
5274 5275
        self.rhs = self.rhs.analyse_types(env)
        self.lhs = self.lhs.analyse_target_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
5276

5277
        # When assigning to a fully indexed buffer or memoryview, coerce the rhs
5278
        if self.lhs.is_memview_index or self.lhs.is_buffer_access:
5279
            self.rhs = self.rhs.coerce_to(self.lhs.type, env)
5280 5281 5282
        elif self.lhs.type.is_string and self.operator in '+-':
            # use pointer arithmetic for char* LHS instead of string concat
            self.rhs = self.rhs.coerce_to(PyrexTypes.c_py_ssize_t_type, env)
5283
        return self
5284

5285
    def generate_execution_code(self, code):
5286
        code.mark_pos(self.pos)
5287 5288 5289
        lhs, rhs = self.lhs, self.rhs
        rhs.generate_evaluation_code(code)
        lhs.generate_subexpr_evaluation_code(code)
5290 5291 5292 5293 5294
        c_op = self.operator
        if c_op == "//":
            c_op = "/"
        elif c_op == "**":
            error(self.pos, "No C inplace power operator")
5295 5296
        if lhs.is_buffer_access or lhs.is_memview_index:
            if lhs.type.is_pyobject:
5297
                error(self.pos, "In-place operators not allowed on object buffers in this release.")
5298
            if c_op in ('/', '%') and lhs.type.is_int and not code.globalstate.directives['cdivision']:
Robert Bradshaw's avatar
Robert Bradshaw committed
5299
                error(self.pos, "In-place non-c divide operators not allowed on int buffers.")
5300 5301 5302
            lhs.generate_buffer_setitem_code(rhs, code, c_op)
        elif lhs.is_memview_slice:
            error(self.pos, "Inplace operators not supported on memoryview slices")
5303 5304 5305
        else:
            # C++
            # TODO: make sure overload is declared
5306 5307 5308 5309 5310
            code.putln("%s %s= %s;" % (lhs.result(), c_op, rhs.result()))
        lhs.generate_subexpr_disposal_code(code)
        lhs.free_subexpr_temps(code)
        rhs.generate_disposal_code(code)
        rhs.free_temps(code)
5311

5312 5313 5314
    def annotate(self, code):
        self.lhs.annotate(code)
        self.rhs.annotate(code)
5315

5316
    def create_binop_node(self):
5317
        from . import ExprNodes
5318
        return ExprNodes.binop_node(self.pos, self.operator, self.lhs, self.rhs)
5319

William Stein's avatar
William Stein committed
5320 5321 5322 5323

class PrintStatNode(StatNode):
    #  print statement
    #
5324
    #  arg_tuple         TupleNode
5325
    #  stream            ExprNode or None (stdout)
5326
    #  append_newline    boolean
5327

5328
    child_attrs = ["arg_tuple", "stream"]
5329

William Stein's avatar
William Stein committed
5330
    def analyse_expressions(self, env):
5331
        if self.stream:
5332 5333 5334 5335
            stream = self.stream.analyse_expressions(env)
            self.stream = stream.coerce_to_pyobject(env)
        arg_tuple = self.arg_tuple.analyse_expressions(env)
        self.arg_tuple = arg_tuple.coerce_to_pyobject(env)
5336
        env.use_utility_code(printing_utility_code)
5337 5338
        if len(self.arg_tuple.args) == 1 and self.append_newline:
            env.use_utility_code(printing_one_utility_code)
5339
        return self
5340

5341
    nogil_check = Node.gil_error
5342
    gil_message = "Python print statement"
5343

William Stein's avatar
William Stein committed
5344
    def generate_execution_code(self, code):
5345
        code.mark_pos(self.pos)
5346 5347 5348 5349 5350
        if self.stream:
            self.stream.generate_evaluation_code(code)
            stream_result = self.stream.py_result()
        else:
            stream_result = '0'
5351 5352 5353
        if len(self.arg_tuple.args) == 1 and self.append_newline:
            arg = self.arg_tuple.args[0]
            arg.generate_evaluation_code(code)
5354

5355
            code.putln(
5356 5357
                "if (__Pyx_PrintOne(%s, %s) < 0) %s" % (
                    stream_result,
5358 5359 5360 5361 5362 5363 5364
                    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(
5365 5366
                "if (__Pyx_Print(%s, %s, %d) < 0) %s" % (
                    stream_result,
5367 5368 5369 5370 5371
                    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)
5372

5373 5374 5375 5376
        if self.stream:
            self.stream.generate_disposal_code(code)
            self.stream.free_temps(code)

5377
    def generate_function_definitions(self, env, code):
5378 5379
        if self.stream:
            self.stream.generate_function_definitions(env, code)
5380
        self.arg_tuple.generate_function_definitions(env, code)
5381

5382
    def annotate(self, code):
5383 5384
        if self.stream:
            self.stream.annotate(code)
5385
        self.arg_tuple.annotate(code)
William Stein's avatar
William Stein committed
5386 5387


5388 5389 5390 5391 5392 5393 5394 5395 5396
class ExecStatNode(StatNode):
    #  exec statement
    #
    #  args     [ExprNode]

    child_attrs = ["args"]

    def analyse_expressions(self, env):
        for i, arg in enumerate(self.args):
5397
            arg = arg.analyse_expressions(env)
5398 5399 5400
            arg = arg.coerce_to_pyobject(env)
            self.args[i] = arg
        env.use_utility_code(Builtin.pyexec_utility_code)
5401
        return self
5402

5403
    nogil_check = Node.gil_error
5404 5405 5406
    gil_message = "Python exec statement"

    def generate_execution_code(self, code):
5407
        code.mark_pos(self.pos)
5408 5409 5410 5411 5412
        args = []
        for arg in self.args:
            arg.generate_evaluation_code(code)
            args.append( arg.py_result() )
        args = tuple(args + ['0', '0'][:3-len(args)])
5413
        temp_result = code.funcstate.allocate_temp(PyrexTypes.py_object_type, manage_ref=True)
Stefan Behnel's avatar
Stefan Behnel committed
5414
        code.putln("%s = __Pyx_PyExec3(%s, %s, %s);" % (
5415
                (temp_result,) + args))
5416 5417
        for arg in self.args:
            arg.generate_disposal_code(code)
5418
            arg.free_temps(code)
5419
        code.putln(
5420 5421 5422 5423
            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)
5424 5425 5426 5427 5428 5429

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


William Stein's avatar
William Stein committed
5430 5431 5432 5433
class DelStatNode(StatNode):
    #  del statement
    #
    #  args     [ExprNode]
5434

5435
    child_attrs = ["args"]
5436
    ignore_nonexisting = False
5437

William Stein's avatar
William Stein committed
5438 5439 5440
    def analyse_declarations(self, env):
        for arg in self.args:
            arg.analyse_target_declaration(env)
5441

William Stein's avatar
William Stein committed
5442
    def analyse_expressions(self, env):
5443 5444
        for i, arg in enumerate(self.args):
            arg = self.args[i] = arg.analyse_target_expression(env, None)
5445 5446
            if arg.type.is_pyobject or (arg.is_name and
                                        arg.type.is_memoryviewslice):
5447 5448
                if arg.is_name and arg.entry.is_cglobal:
                    error(arg.pos, "Deletion of global C variable")
Robert Bradshaw's avatar
Robert Bradshaw committed
5449
            elif arg.type.is_ptr and arg.type.base_type.is_cpp_class:
Robert Bradshaw's avatar
Robert Bradshaw committed
5450
                self.cpp_check(env)
5451
            elif arg.type.is_cpp_class:
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
5452
                error(arg.pos, "Deletion of non-heap C++ object")
5453 5454
            elif arg.is_subscript and arg.base.type is Builtin.bytearray_type:
                pass  # del ba[i]
5455
            else:
Robert Bradshaw's avatar
Robert Bradshaw committed
5456
                error(arg.pos, "Deletion of non-Python, non-C++ object")
5457
            #arg.release_target_temp(env)
5458
        return self
5459

5460
    def nogil_check(self, env):
5461 5462
        for arg in self.args:
            if arg.type.is_pyobject:
5463
                self.gil_error()
5464

5465 5466
    gil_message = "Deleting Python object"

William Stein's avatar
William Stein committed
5467
    def generate_execution_code(self, code):
5468
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
5469
        for arg in self.args:
5470 5471 5472
            if (arg.type.is_pyobject or
                    arg.type.is_memoryviewslice or
                    arg.is_subscript and arg.base.type is Builtin.bytearray_type):
5473 5474
                arg.generate_deletion_code(
                    code, ignore_nonexisting=self.ignore_nonexisting)
5475
            elif arg.type.is_ptr and arg.type.base_type.is_cpp_class:
Robert Bradshaw's avatar
Robert Bradshaw committed
5476
                arg.generate_result_code(code)
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
5477
                code.putln("delete %s;" % arg.result())
William Stein's avatar
William Stein committed
5478 5479
            # else error reported earlier

5480 5481 5482 5483
    def annotate(self, code):
        for arg in self.args:
            arg.annotate(code)

William Stein's avatar
William Stein committed
5484 5485 5486

class PassStatNode(StatNode):
    #  pass statement
5487 5488

    child_attrs = []
5489

William Stein's avatar
William Stein committed
5490
    def analyse_expressions(self, env):
5491
        return self
5492

William Stein's avatar
William Stein committed
5493 5494 5495 5496
    def generate_execution_code(self, code):
        pass


5497 5498 5499 5500 5501 5502 5503 5504 5505
class IndirectionNode(StatListNode):
    """
    This adds an indirection so that the node can be shared and a subtree can
    be removed at any time by clearing self.stats.
    """

    def __init__(self, stats):
        super(IndirectionNode, self).__init__(stats[0].pos, stats=stats)

William Stein's avatar
William Stein committed
5506 5507
class BreakStatNode(StatNode):

5508
    child_attrs = []
5509
    is_terminator = True
5510

William Stein's avatar
William Stein committed
5511
    def analyse_expressions(self, env):
5512
        return self
5513

William Stein's avatar
William Stein committed
5514
    def generate_execution_code(self, code):
5515
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
5516 5517 5518
        if not code.break_label:
            error(self.pos, "break statement not inside loop")
        else:
5519
            code.put_goto(code.break_label)
William Stein's avatar
William Stein committed
5520 5521 5522 5523


class ContinueStatNode(StatNode):

5524
    child_attrs = []
5525
    is_terminator = True
5526

William Stein's avatar
William Stein committed
5527
    def analyse_expressions(self, env):
5528
        return self
5529

William Stein's avatar
William Stein committed
5530
    def generate_execution_code(self, code):
Stefan Behnel's avatar
Stefan Behnel committed
5531
        if not code.continue_label:
William Stein's avatar
William Stein committed
5532
            error(self.pos, "continue statement not inside loop")
Stefan Behnel's avatar
Stefan Behnel committed
5533 5534 5535
            return
        code.mark_pos(self.pos)
        code.put_goto(code.continue_label)
William Stein's avatar
William Stein committed
5536 5537 5538 5539 5540 5541 5542


class ReturnStatNode(StatNode):
    #  return statement
    #
    #  value         ExprNode or None
    #  return_type   PyrexType
5543
    #  in_generator  return inside of generator => raise StopIteration
5544

5545
    child_attrs = ["value"]
5546
    is_terminator = True
5547
    in_generator = False
5548

5549 5550 5551
    # Whether we are in a parallel section
    in_parallel = False

William Stein's avatar
William Stein committed
5552 5553 5554 5555 5556
    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")
5557
            return self
William Stein's avatar
William Stein committed
5558
        if self.value:
5559
            self.value = self.value.analyse_types(env)
William Stein's avatar
William Stein committed
5560
            if return_type.is_void or return_type.is_returncode:
5561
                error(self.value.pos,
William Stein's avatar
William Stein committed
5562 5563 5564 5565 5566 5567 5568 5569
                    "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")
5570
        return self
5571

5572
    def nogil_check(self, env):
5573
        if self.return_type.is_pyobject:
5574
            self.gil_error()
5575 5576 5577

    gil_message = "Returning Python object"

William Stein's avatar
William Stein committed
5578
    def generate_execution_code(self, code):
5579
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
5580 5581 5582
        if not self.return_type:
            # error reported earlier
            return
5583 5584 5585
        if self.return_type.is_pyobject:
            code.put_xdecref(Naming.retval_cname,
                             self.return_type)
5586

William Stein's avatar
William Stein committed
5587 5588
        if self.value:
            self.value.generate_evaluation_code(code)
5589
            if self.return_type.is_memoryviewslice:
5590
                from . import MemoryView
5591 5592 5593 5594 5595
                MemoryView.put_acquire_memoryviewslice(
                        lhs_cname=Naming.retval_cname,
                        lhs_type=self.return_type,
                        lhs_pos=self.value.pos,
                        rhs=self.value,
5596 5597
                        code=code,
                        have_gil=self.in_nogil_context)
5598 5599
            elif self.in_generator:
                # return value == raise StopIteration(value), but uncatchable
5600
                code.globalstate.use_utility_code(
5601
                    UtilityCode.load_cached("ReturnWithStopIteration", "Coroutine.c"))
5602 5603 5604
                code.putln("%s = NULL; __Pyx_ReturnWithStopIteration(%s);" % (
                    Naming.retval_cname,
                    self.value.py_result()))
5605
                self.value.generate_disposal_code(code)
5606 5607 5608 5609 5610 5611
            else:
                self.value.make_owned_reference(code)
                code.putln(
                    "%s = %s;" % (
                        Naming.retval_cname,
                        self.value.result_as(self.return_type)))
5612
            self.value.generate_post_assignment_code(code)
5613
            self.value.free_temps(code)
William Stein's avatar
William Stein committed
5614 5615
        else:
            if self.return_type.is_pyobject:
5616 5617 5618 5619
                if self.in_generator:
                    code.putln("%s = NULL;" % Naming.retval_cname)
                else:
                    code.put_init_to_py_none(Naming.retval_cname, self.return_type)
William Stein's avatar
William Stein committed
5620
            elif self.return_type.is_returncode:
5621 5622
                self.put_return(code, self.return_type.default_value)

5623
        for cname, type in code.funcstate.temps_holding_reference():
5624
            code.put_decref_clear(cname, type)
5625

5626
        code.put_goto(code.return_label)
5627

5628 5629 5630 5631 5632
    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))

5633 5634 5635
    def generate_function_definitions(self, env, code):
        if self.value is not None:
            self.value.generate_function_definitions(env, code)
5636

5637 5638 5639
    def annotate(self, code):
        if self.value:
            self.value.annotate(code)
William Stein's avatar
William Stein committed
5640 5641 5642 5643 5644 5645 5646 5647


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
5648
    #  cause       ExprNode or None
5649

Haoyu Bai's avatar
Haoyu Bai committed
5650
    child_attrs = ["exc_type", "exc_value", "exc_tb", "cause"]
5651
    is_terminator = True
5652

William Stein's avatar
William Stein committed
5653 5654
    def analyse_expressions(self, env):
        if self.exc_type:
5655 5656
            exc_type = self.exc_type.analyse_types(env)
            self.exc_type = exc_type.coerce_to_pyobject(env)
William Stein's avatar
William Stein committed
5657
        if self.exc_value:
5658 5659
            exc_value = self.exc_value.analyse_types(env)
            self.exc_value = exc_value.coerce_to_pyobject(env)
William Stein's avatar
William Stein committed
5660
        if self.exc_tb:
5661 5662
            exc_tb = self.exc_tb.analyse_types(env)
            self.exc_tb = exc_tb.coerce_to_pyobject(env)
Haoyu Bai's avatar
Haoyu Bai committed
5663
        if self.cause:
5664 5665
            cause = self.cause.analyse_types(env)
            self.cause = cause.coerce_to_pyobject(env)
5666 5667 5668 5669
        # 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
5670
            from . import ExprNodes
Robert Bradshaw's avatar
Robert Bradshaw committed
5671 5672
            if (isinstance(exc, ExprNodes.SimpleCallNode) and
                not (exc.args or (exc.arg_tuple is not None and
5673
                                  exc.arg_tuple.args))):
5674 5675 5676 5677 5678
                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
5679
        return self
5680

5681
    nogil_check = Node.gil_error
5682 5683
    gil_message = "Raising exception"

William Stein's avatar
William Stein committed
5684
    def generate_execution_code(self, code):
5685
        code.mark_pos(self.pos)
5686 5687 5688 5689
        if self.builtin_exc_name == 'MemoryError':
            code.putln('PyErr_NoMemory(); %s' % code.error_goto(self.pos))
            return

William Stein's avatar
William Stein committed
5690 5691 5692 5693
        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
5694
            type_code = "0"
William Stein's avatar
William Stein committed
5695 5696 5697 5698 5699 5700 5701 5702 5703 5704
        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
5705 5706 5707 5708 5709
        if self.cause:
            self.cause.generate_evaluation_code(code)
            cause_code = self.cause.py_result()
        else:
            cause_code = "0"
5710
        code.globalstate.use_utility_code(raise_utility_code)
5711
        code.putln(
Haoyu Bai's avatar
Haoyu Bai committed
5712
            "__Pyx_Raise(%s, %s, %s, %s);" % (
5713 5714
                type_code,
                value_code,
Haoyu Bai's avatar
Haoyu Bai committed
5715 5716 5717
                tb_code,
                cause_code))
        for obj in (self.exc_type, self.exc_value, self.exc_tb, self.cause):
5718 5719 5720
            if obj:
                obj.generate_disposal_code(code)
                obj.free_temps(code)
William Stein's avatar
William Stein committed
5721 5722 5723
        code.putln(
            code.error_goto(self.pos))

5724 5725 5726 5727 5728 5729 5730
    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
5731 5732
        if self.cause is not None:
            self.cause.generate_function_definitions(env, code)
5733

5734 5735 5736 5737 5738 5739 5740
    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
5741 5742
        if self.cause:
            self.cause.annotate(code)
5743

William Stein's avatar
William Stein committed
5744

5745 5746
class ReraiseStatNode(StatNode):

5747
    child_attrs = []
5748
    is_terminator = True
5749

5750
    def analyse_expressions(self, env):
5751
        return self
5752

5753
    nogil_check = Node.gil_error
5754 5755
    gil_message = "Raising exception"

5756
    def generate_execution_code(self, code):
5757
        code.mark_pos(self.pos)
5758
        vars = code.funcstate.exc_vars
5759
        if vars:
5760
            code.globalstate.use_utility_code(restore_exception_utility_code)
5761 5762 5763 5764
            code.put_giveref(vars[0])
            code.put_giveref(vars[1])
            # fresh exceptions may not have a traceback yet (-> finally!)
            code.put_xgiveref(vars[2])
5765
            code.putln("__Pyx_ErrRestoreWithState(%s, %s, %s);" % tuple(vars))
5766 5767 5768
            for varname in vars:
                code.put("%s = 0; " % varname)
            code.putln()
5769 5770
            code.putln(code.error_goto(self.pos))
        else:
5771 5772 5773
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("ReRaiseException", "Exceptions.c"))
            code.putln("__Pyx_ReraiseException(); %s" % code.error_goto(self.pos))
5774

William Stein's avatar
William Stein committed
5775 5776 5777 5778 5779
class AssertStatNode(StatNode):
    #  assert statement
    #
    #  cond    ExprNode
    #  value   ExprNode or None
5780

5781 5782
    child_attrs = ["cond", "value"]

William Stein's avatar
William Stein committed
5783 5784 5785
    def analyse_expressions(self, env):
        self.cond = self.cond.analyse_boolean_expression(env)
        if self.value:
5786
            value = self.value.analyse_types(env)
5787 5788
            if value.type is Builtin.tuple_type or not value.type.is_builtin_type:
                # prevent tuple values from being interpreted as argument value tuples
5789
                from .ExprNodes import TupleNode
5790
                value = TupleNode(value.pos, args=[value], slow=True)
Robert Bradshaw's avatar
Robert Bradshaw committed
5791
                self.value = value.analyse_types(env, skip_children=True).coerce_to_pyobject(env)
5792 5793
            else:
                self.value = value.coerce_to_pyobject(env)
5794
        return self
5795

5796
    nogil_check = Node.gil_error
5797
    gil_message = "Raising exception"
5798

William Stein's avatar
William Stein committed
5799
    def generate_execution_code(self, code):
5800
        code.putln("#ifndef CYTHON_WITHOUT_ASSERTIONS")
5801
        code.putln("if (unlikely(!Py_OptimizeFlag)) {")
5802
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
5803 5804
        self.cond.generate_evaluation_code(code)
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
5805
            "if (unlikely(!%s)) {" %
5806
                self.cond.result())
William Stein's avatar
William Stein committed
5807
        if self.value:
5808
            self.value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
5809 5810 5811
            code.putln(
                "PyErr_SetObject(PyExc_AssertionError, %s);" %
                    self.value.py_result())
5812
            self.value.generate_disposal_code(code)
5813
            self.value.free_temps(code)
William Stein's avatar
William Stein committed
5814 5815 5816 5817 5818 5819 5820 5821
        else:
            code.putln(
                "PyErr_SetNone(PyExc_AssertionError);")
        code.putln(
                code.error_goto(self.pos))
        code.putln(
            "}")
        self.cond.generate_disposal_code(code)
5822
        self.cond.free_temps(code)
5823 5824
        code.putln(
            "}")
5825
        code.putln("#endif")
William Stein's avatar
William Stein committed
5826

5827 5828 5829 5830 5831
    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)

5832 5833 5834 5835 5836 5837
    def annotate(self, code):
        self.cond.annotate(code)
        if self.value:
            self.value.annotate(code)


William Stein's avatar
William Stein committed
5838 5839 5840 5841 5842
class IfStatNode(StatNode):
    #  if statement
    #
    #  if_clauses   [IfClauseNode]
    #  else_clause  StatNode or None
5843 5844

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

William Stein's avatar
William Stein committed
5846 5847 5848 5849 5850
    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)
5851

William Stein's avatar
William Stein committed
5852
    def analyse_expressions(self, env):
5853
        self.if_clauses = [if_clause.analyse_expressions(env) for if_clause in self.if_clauses]
William Stein's avatar
William Stein committed
5854
        if self.else_clause:
5855 5856
            self.else_clause = self.else_clause.analyse_expressions(env)
        return self
5857

William Stein's avatar
William Stein committed
5858
    def generate_execution_code(self, code):
5859
        code.mark_pos(self.pos)
5860
        end_label = code.new_label()
5861 5862 5863
        last = len(self.if_clauses)
        if not self.else_clause:
            last -= 1  # avoid redundant goto at end of last if-clause
5864 5865
        for i, if_clause in enumerate(self.if_clauses):
            if_clause.generate_execution_code(code, end_label, is_last=i == last)
5866
        if self.else_clause:
5867
            code.mark_pos(self.else_clause.pos)
5868
            code.putln("/*else*/ {")
William Stein's avatar
William Stein committed
5869
            self.else_clause.generate_execution_code(code)
5870 5871
            code.putln("}")
        code.put_label(end_label)
5872

5873 5874 5875 5876 5877
    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)
5878

5879 5880 5881 5882 5883
    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
5884 5885 5886 5887 5888 5889 5890


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

5892 5893
    child_attrs = ["condition", "body"]

William Stein's avatar
William Stein committed
5894 5895
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
5896

William Stein's avatar
William Stein committed
5897
    def analyse_expressions(self, env):
5898
        self.condition = self.condition.analyse_temp_boolean_expression(env)
5899 5900
        self.body = self.body.analyse_expressions(env)
        return self
5901

5902
    def generate_execution_code(self, code, end_label, is_last):
William Stein's avatar
William Stein committed
5903
        self.condition.generate_evaluation_code(code)
5904 5905
        code.mark_pos(self.pos)
        code.putln("if (%s) {" % self.condition.result())
5906 5907
        self.condition.generate_disposal_code(code)
        self.condition.free_temps(code)
William Stein's avatar
William Stein committed
5908
        self.body.generate_execution_code(code)
5909 5910
        code.mark_pos(self.pos, trace=False)
        if not (is_last or self.body.is_terminator):
5911
            code.put_goto(end_label)
William Stein's avatar
William Stein committed
5912
        code.putln("}")
5913

5914 5915 5916 5917
    def generate_function_definitions(self, env, code):
        self.condition.generate_function_definitions(env, code)
        self.body.generate_function_definitions(env, code)

5918 5919 5920
    def annotate(self, code):
        self.condition.annotate(code)
        self.body.annotate(code)
5921

5922 5923 5924 5925 5926 5927

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

5929
    child_attrs = ['conditions', 'body']
5930

5931 5932
    def generate_execution_code(self, code):
        for cond in self.conditions:
5933
            code.mark_pos(cond.pos)
5934 5935
            cond.generate_evaluation_code(code)
            code.putln("case %s:" % cond.result())
5936
        self.body.generate_execution_code(code)
5937
        code.mark_pos(self.pos, trace=False)
5938
        code.putln("break;")
5939 5940 5941 5942 5943

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

5945 5946 5947
    def annotate(self, code):
        for cond in self.conditions:
            cond.annotate(code)
5948
        self.body.annotate(code)
5949

5950

5951 5952 5953 5954 5955 5956
class SwitchStatNode(StatNode):
    # Generated in the optimization of an if-elif-else node
    #
    # test          ExprNode
    # cases         [SwitchCaseNode]
    # else_clause   StatNode or None
5957

5958
    child_attrs = ['test', 'cases', 'else_clause']
5959

5960
    def generate_execution_code(self, code):
5961
        self.test.generate_evaluation_code(code)
5962
        code.mark_pos(self.pos)
5963
        code.putln("switch (%s) {" % self.test.result())
5964 5965 5966 5967 5968
        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)
5969
            code.putln("break;")
5970 5971 5972 5973 5974
        else:
            # Always generate a default clause to prevent C compiler warnings
            # about unmatched enum values (it was not the user who decided to
            # generate the switch statement, so shouldn't be bothered).
            code.putln("default: break;")
5975 5976
        code.putln("}")

5977 5978 5979 5980 5981 5982 5983
    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)

5984 5985 5986 5987
    def annotate(self, code):
        self.test.annotate(code)
        for case in self.cases:
            case.annotate(code)
5988 5989
        if self.else_clause is not None:
            self.else_clause.annotate(code)
5990

5991

5992
class LoopNode(object):
5993
    pass
5994

5995

5996
class WhileStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
5997 5998 5999 6000 6001
    #  while statement
    #
    #  condition    ExprNode
    #  body         StatNode
    #  else_clause  StatNode
6002 6003

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

William Stein's avatar
William Stein committed
6005 6006 6007 6008
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
        if self.else_clause:
            self.else_clause.analyse_declarations(env)
6009

William Stein's avatar
William Stein committed
6010
    def analyse_expressions(self, env):
6011 6012
        if self.condition:
            self.condition = self.condition.analyse_temp_boolean_expression(env)
6013
        self.body = self.body.analyse_expressions(env)
William Stein's avatar
William Stein committed
6014
        if self.else_clause:
6015 6016
            self.else_clause = self.else_clause.analyse_expressions(env)
        return self
6017

William Stein's avatar
William Stein committed
6018
    def generate_execution_code(self, code):
6019
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
6020 6021 6022
        old_loop_labels = code.new_loop_labels()
        code.putln(
            "while (1) {")
6023 6024 6025 6026 6027 6028 6029
        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
6030
        self.body.generate_execution_code(code)
6031
        code.put_label(code.continue_label)
William Stein's avatar
William Stein committed
6032 6033 6034 6035
        code.putln("}")
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
        if self.else_clause:
6036
            code.mark_pos(self.else_clause.pos)
William Stein's avatar
William Stein committed
6037 6038 6039 6040 6041
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
        code.put_label(break_label)

6042
    def generate_function_definitions(self, env, code):
6043 6044
        if self.condition:
            self.condition.generate_function_definitions(env, code)
6045 6046 6047 6048
        self.body.generate_function_definitions(env, code)
        if self.else_clause is not None:
            self.else_clause.generate_function_definitions(env, code)

6049
    def annotate(self, code):
6050 6051
        if self.condition:
            self.condition.annotate(code)
6052 6053 6054 6055
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)

William Stein's avatar
William Stein committed
6056

6057 6058 6059 6060
class DictIterationNextNode(Node):
    # Helper node for calling PyDict_Next() inside of a WhileStatNode
    # and checking the dictionary size for changes.  Created in
    # Optimize.py.
6061 6062 6063
    child_attrs = ['dict_obj', 'expected_size', 'pos_index_var',
                   'coerced_key_var', 'coerced_value_var', 'coerced_tuple_var',
                   'key_target', 'value_target', 'tuple_target', 'is_dict_flag']
6064

6065 6066 6067 6068 6069 6070
    coerced_key_var = key_ref = None
    coerced_value_var = value_ref = None
    coerced_tuple_var = tuple_ref = None

    def __init__(self, dict_obj, expected_size, pos_index_var,
                 key_target, value_target, tuple_target, is_dict_flag):
6071 6072 6073 6074
        Node.__init__(
            self, dict_obj.pos,
            dict_obj = dict_obj,
            expected_size = expected_size,
6075 6076 6077 6078 6079 6080
            pos_index_var = pos_index_var,
            key_target = key_target,
            value_target = value_target,
            tuple_target = tuple_target,
            is_dict_flag = is_dict_flag,
            is_temp = True,
6081 6082 6083
            type = PyrexTypes.c_bint_type)

    def analyse_expressions(self, env):
6084
        from . import ExprNodes
6085 6086 6087 6088
        self.dict_obj = self.dict_obj.analyse_types(env)
        self.expected_size = self.expected_size.analyse_types(env)
        if self.pos_index_var:
            self.pos_index_var = self.pos_index_var.analyse_types(env)
6089
        if self.key_target:
6090
            self.key_target = self.key_target.analyse_target_types(env)
6091
            self.key_ref = ExprNodes.TempNode(self.key_target.pos, PyrexTypes.py_object_type)
6092 6093
            self.coerced_key_var = self.key_ref.coerce_to(self.key_target.type, env)
        if self.value_target:
6094
            self.value_target = self.value_target.analyse_target_types(env)
6095
            self.value_ref = ExprNodes.TempNode(self.value_target.pos, type=PyrexTypes.py_object_type)
6096 6097
            self.coerced_value_var = self.value_ref.coerce_to(self.value_target.type, env)
        if self.tuple_target:
6098
            self.tuple_target = self.tuple_target.analyse_target_types(env)
6099
            self.tuple_ref = ExprNodes.TempNode(self.tuple_target.pos, PyrexTypes.py_object_type)
6100
            self.coerced_tuple_var = self.tuple_ref.coerce_to(self.tuple_target.type, env)
6101 6102
        self.is_dict_flag = self.is_dict_flag.analyse_types(env)
        return self
6103 6104 6105 6106 6107

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

    def generate_execution_code(self, code):
6108
        code.globalstate.use_utility_code(UtilityCode.load_cached("dict_iter", "Optimize.c"))
6109 6110
        self.dict_obj.generate_evaluation_code(code)

6111 6112 6113 6114 6115 6116 6117 6118
        assignments = []
        temp_addresses = []
        for var, result, target in [(self.key_ref, self.coerced_key_var, self.key_target),
                                    (self.value_ref, self.coerced_value_var, self.value_target),
                                    (self.tuple_ref, self.coerced_tuple_var, self.tuple_target)]:
            if target is None:
                addr = 'NULL'
            else:
6119 6120 6121
                assignments.append((var, result, target))
                var.allocate(code)
                addr = '&%s' % var.result()
6122 6123 6124 6125 6126
            temp_addresses.append(addr)

        result_temp = code.funcstate.allocate_temp(PyrexTypes.c_int_type, False)
        code.putln("%s = __Pyx_dict_iter_next(%s, %s, &%s, %s, %s, %s, %s);" % (
            result_temp,
6127
            self.dict_obj.py_result(),
6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139
            self.expected_size.result(),
            self.pos_index_var.result(),
            temp_addresses[0],
            temp_addresses[1],
            temp_addresses[2],
            self.is_dict_flag.result()
        ))
        code.putln("if (unlikely(%s == 0)) break;" % result_temp)
        code.putln(code.error_goto_if("%s == -1" % result_temp, self.pos))
        code.funcstate.release_temp(result_temp)

        # evaluate all coercions before the assignments
6140 6141
        for var, result, target in assignments:
            code.put_gotref(var.result())
6142
        for var, result, target in assignments:
6143
            result.generate_evaluation_code(code)
6144
        for var, result, target in assignments:
6145
            target.generate_assignment_code(result, code)
6146
            var.release(code)
6147

6148

Robert Bradshaw's avatar
Robert Bradshaw committed
6149
def ForStatNode(pos, **kw):
6150
    if 'iterator' in kw:
6151 6152 6153 6154
        if kw['iterator'].is_async:
            return AsyncForStatNode(pos, **kw)
        else:
            return ForInStatNode(pos, **kw)
Robert Bradshaw's avatar
Robert Bradshaw committed
6155 6156 6157
    else:
        return ForFromStatNode(pos, **kw)

6158 6159 6160

class _ForInStatNode(LoopNode, StatNode):
    #  Base class of 'for-in' statements.
William Stein's avatar
William Stein committed
6161 6162
    #
    #  target        ExprNode
6163
    #  iterator      IteratorNode | AwaitExprNode(AsyncIteratorNode)
William Stein's avatar
William Stein committed
6164 6165
    #  body          StatNode
    #  else_clause   StatNode
6166 6167
    #  item          NextNode | AwaitExprNode(AsyncNextNode)
    #  is_async      boolean        true for 'async for' statements
6168

6169
    child_attrs = ["target", "item", "iterator", "body", "else_clause"]
6170
    item = None
6171 6172 6173 6174
    is_async = False

    def _create_item_node(self):
        raise NotImplementedError("must be implemented by subclasses")
6175

William Stein's avatar
William Stein committed
6176 6177 6178 6179 6180
    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)
6181
        self._create_item_node()
6182

William Stein's avatar
William Stein committed
6183
    def analyse_expressions(self, env):
6184
        self.target = self.target.analyse_target_types(env)
6185
        self.iterator = self.iterator.analyse_expressions(env)
6186
        self._create_item_node()  # must rewrap self.item after analysis
6187
        self.item = self.item.analyse_expressions(env)
6188 6189 6190
        if (not self.is_async and
                (self.iterator.type.is_ptr or self.iterator.type.is_array) and
                self.target.type.assignable_from(self.iterator.type)):
6191 6192 6193 6194
            # C array slice optimization.
            pass
        else:
            self.item = self.item.coerce_to(self.target.type, env)
6195
        self.body = self.body.analyse_expressions(env)
William Stein's avatar
William Stein committed
6196
        if self.else_clause:
6197 6198
            self.else_clause = self.else_clause.analyse_expressions(env)
        return self
William Stein's avatar
William Stein committed
6199 6200

    def generate_execution_code(self, code):
6201
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
6202 6203
        old_loop_labels = code.new_loop_labels()
        self.iterator.generate_evaluation_code(code)
Mark Florisson's avatar
Mark Florisson committed
6204
        code.putln("for (;;) {")
William Stein's avatar
William Stein committed
6205 6206 6207
        self.item.generate_evaluation_code(code)
        self.target.generate_assignment_code(self.item, code)
        self.body.generate_execution_code(code)
6208
        code.mark_pos(self.pos)
6209
        code.put_label(code.continue_label)
Mark Florisson's avatar
Mark Florisson committed
6210
        code.putln("}")
William Stein's avatar
William Stein committed
6211 6212
        break_label = code.break_label
        code.set_loop_labels(old_loop_labels)
6213

William Stein's avatar
William Stein committed
6214
        if self.else_clause:
6215 6216 6217 6218 6219 6220 6221
            # 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
6222 6223 6224
            code.putln("/*else*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln("}")
6225 6226 6227

            if code.label_used(code.continue_label):
                code.put_goto(break_label)
6228
                code.mark_pos(self.pos)
6229 6230 6231 6232 6233
                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)

6234
        code.mark_pos(self.pos)
6235 6236
        if code.label_used(break_label):
            code.put_label(break_label)
William Stein's avatar
William Stein committed
6237
        self.iterator.generate_disposal_code(code)
6238
        self.iterator.free_temps(code)
William Stein's avatar
William Stein committed
6239

6240 6241 6242 6243 6244 6245 6246
    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)

6247 6248 6249 6250 6251 6252 6253 6254
    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
6255

6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286
class ForInStatNode(_ForInStatNode):
    #  'for' statement

    is_async = False

    def _create_item_node(self):
        from .ExprNodes import NextNode
        self.item = NextNode(self.iterator)


class AsyncForStatNode(_ForInStatNode):
    #  'async for' statement
    #
    #  iterator      AwaitExprNode(AsyncIteratorNode)
    #  item          AwaitIterNextExprNode(AsyncIteratorNode)

    is_async = True

    def __init__(self, pos, iterator, **kw):
        assert 'item' not in kw
        from . import ExprNodes
        # AwaitExprNodes must appear before running MarkClosureVisitor
        kw['iterator'] = ExprNodes.AwaitExprNode(iterator.pos, arg=iterator)
        kw['item'] = ExprNodes.AwaitIterNextExprNode(iterator.pos, arg=None)
        _ForInStatNode.__init__(self, pos, **kw)

    def _create_item_node(self):
        from . import ExprNodes
        self.item.arg = ExprNodes.AsyncNextNode(self.iterator)


6287
class ForFromStatNode(LoopNode, StatNode):
William Stein's avatar
William Stein committed
6288 6289 6290 6291 6292 6293 6294
    #  for name from expr rel name rel expr
    #
    #  target        NameNode
    #  bound1        ExprNode
    #  relation1     string
    #  relation2     string
    #  bound2        ExprNode
6295
    #  step          ExprNode or None
William Stein's avatar
William Stein committed
6296 6297 6298 6299 6300
    #  body          StatNode
    #  else_clause   StatNode or None
    #
    #  Used internally:
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
6301
    #  from_range         bool
6302
    #  is_py_target       bool
6303
    #  loopvar_node       ExprNode (usually a NameNode or temp node)
William Stein's avatar
William Stein committed
6304
    #  py_loopvar_node    PyTempNode or None
6305
    child_attrs = ["target", "bound1", "bound2", "step", "body", "else_clause"]
6306 6307

    is_py_target = False
6308
    loopvar_node = None
6309
    py_loopvar_node = None
Robert Bradshaw's avatar
Robert Bradshaw committed
6310
    from_range = False
6311

6312 6313 6314 6315 6316 6317 6318
    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
6319 6320 6321 6322 6323
    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)
6324

William Stein's avatar
William Stein committed
6325
    def analyse_expressions(self, env):
6326
        from . import ExprNodes
6327 6328 6329
        self.target = self.target.analyse_target_types(env)
        self.bound1 = self.bound1.analyse_types(env)
        self.bound2 = self.bound2.analyse_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
6330 6331
        if self.step is not None:
            if isinstance(self.step, ExprNodes.UnaryMinusNode):
Stefan Behnel's avatar
Stefan Behnel committed
6332
                warning(self.step.pos, "Probable infinite loop in for-from-by statement. Consider switching the directions of the relations.", 2)
6333
            self.step = self.step.analyse_types(env)
6334

6335
        if self.target.type.is_numeric:
Robert Bradshaw's avatar
Robert Bradshaw committed
6336
            loop_type = self.target.type
6337
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
6338 6339 6340 6341 6342 6343 6344 6345 6346
            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
6347 6348
        if not self.bound2.is_literal:
            self.bound2 = self.bound2.coerce_to_temp(env)
6349
        if self.step is not None:
6350
            self.step = self.step.coerce_to(loop_type, env)
Robert Bradshaw's avatar
Robert Bradshaw committed
6351 6352
            if not self.step.is_literal:
                self.step = self.step.coerce_to_temp(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
6353

William Stein's avatar
William Stein committed
6354
        target_type = self.target.type
6355
        if not (target_type.is_pyobject or target_type.is_numeric):
6356
            error(self.target.pos,
Robert Bradshaw's avatar
Robert Bradshaw committed
6357
                "for-from loop variable must be c numeric type or Python object")
6358
        if target_type.is_numeric:
Robert Bradshaw's avatar
Robert Bradshaw committed
6359
            self.is_py_target = False
6360 6361
            if isinstance(self.target, ExprNodes.BufferIndexNode):
                raise error(self.pos, "Buffer or memoryview slicing/indexing not allowed as for-loop target.")
6362
            self.loopvar_node = self.target
William Stein's avatar
William Stein committed
6363 6364
            self.py_loopvar_node = None
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
6365 6366
            self.is_py_target = True
            c_loopvar_node = ExprNodes.TempNode(self.pos, loop_type, env)
6367
            self.loopvar_node = c_loopvar_node
William Stein's avatar
William Stein committed
6368 6369
            self.py_loopvar_node = \
                ExprNodes.CloneNode(c_loopvar_node).coerce_to_pyobject(env)
6370
        self.body = self.body.analyse_expressions(env)
William Stein's avatar
William Stein committed
6371
        if self.else_clause:
6372 6373
            self.else_clause = self.else_clause.analyse_expressions(env)
        return self
6374

William Stein's avatar
William Stein committed
6375
    def generate_execution_code(self, code):
6376
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
6377
        old_loop_labels = code.new_loop_labels()
Robert Bradshaw's avatar
Robert Bradshaw committed
6378
        from_range = self.from_range
William Stein's avatar
William Stein committed
6379 6380 6381
        self.bound1.generate_evaluation_code(code)
        self.bound2.generate_evaluation_code(code)
        offset, incop = self.relation_table[self.relation1]
6382 6383
        if self.step is not None:
            self.step.generate_evaluation_code(code)
Magnus Lie Hetland's avatar
Magnus Lie Hetland committed
6384 6385
            step = self.step.result()
            incop = "%s=%s" % (incop[0], step)
6386
        from . import ExprNodes
6387 6388 6389 6390
        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)
6391
        if from_range:
Robert Bradshaw's avatar
Robert Bradshaw committed
6392
            loopvar_name = code.funcstate.allocate_temp(self.target.type, False)
6393
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
6394
            loopvar_name = self.loopvar_node.result()
6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412
        if self.target.type.is_int and not self.target.type.signed and self.relation2[0] == '>':
            # Handle the case where the endpoint of an unsigned int iteration
            # is within step of 0.
            if not self.step:
                step = 1
            code.putln(
                "for (%s = %s%s + %s; %s %s %s + %s; ) { %s%s;" % (
                    loopvar_name,
                    self.bound1.result(), offset, step,
                    loopvar_name, self.relation2, self.bound2.result(), step,
                    loopvar_name, incop))
        else:
            code.putln(
                "for (%s = %s%s; %s %s %s; %s%s) {" % (
                    loopvar_name,
                    self.bound1.result(), offset,
                    loopvar_name, self.relation2, self.bound2.result(),
                    loopvar_name, incop))
William Stein's avatar
William Stein committed
6413 6414 6415
        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
6416 6417 6418
        elif from_range:
            code.putln("%s = %s;" % (
                            self.target.result(), loopvar_name))
William Stein's avatar
William Stein committed
6419 6420
        self.body.generate_execution_code(code)
        code.put_label(code.continue_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
6421
        if self.py_loopvar_node:
6422 6423 6424
            # 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.
6425
            if self.target.entry.is_pyglobal:
6426
                # We know target is a NameNode, this is the only ugly case.
6427
                target_node = ExprNodes.PyTempNode(self.target.pos, None)
6428 6429
                target_node.allocate(code)
                interned_cname = code.intern_identifier(self.target.entry.name)
6430 6431 6432 6433 6434 6435 6436 6437 6438 6439
                if self.target.entry.scope.is_module_scope:
                    code.globalstate.use_utility_code(
                        UtilityCode.load_cached("GetModuleGlobalName", "ObjectHandling.c"))
                    lookup_func = '__Pyx_GetModuleGlobalName(%s)'
                else:
                    code.globalstate.use_utility_code(
                        UtilityCode.load_cached("GetNameInClass", "ObjectHandling.c"))
                    lookup_func = '__Pyx_GetNameInClass(%s, %%s)' % (
                        self.target.entry.scope.namespace_cname)
                code.putln("%s = %s; %s" % (
6440
                    target_node.result(),
6441
                    lookup_func % interned_cname,
6442
                    code.error_goto_if_null(target_node.result(), self.target.pos)))
6443
                code.put_gotref(target_node.result())
6444 6445
            else:
                target_node = self.target
6446 6447
            from_py_node = ExprNodes.CoerceFromPyTypeNode(
                self.loopvar_node.type, target_node, self.target.entry.scope)
6448 6449
            from_py_node.temp_code = loopvar_name
            from_py_node.generate_result_code(code)
6450
            if self.target.entry.is_pyglobal:
6451 6452
                code.put_decref(target_node.result(), target_node.type)
                target_node.release(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
6453
        code.putln("}")
6454
        if self.py_loopvar_node:
6455 6456
            # This is potentially wasteful, but we don't want the semantics to
            # depend on whether or not the loop is a python type.
6457 6458
            self.py_loopvar_node.generate_evaluation_code(code)
            self.target.generate_assignment_code(self.py_loopvar_node, code)
6459 6460
        if from_range:
            code.funcstate.release_temp(loopvar_name)
William Stein's avatar
William Stein committed
6461 6462 6463 6464 6465 6466 6467 6468
        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)
6469
        self.bound1.free_temps(code)
William Stein's avatar
William Stein committed
6470
        self.bound2.generate_disposal_code(code)
6471
        self.bound2.free_temps(code)
6472 6473 6474 6475
        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)
6476 6477
        if self.step is not None:
            self.step.generate_disposal_code(code)
6478
            self.step.free_temps(code)
6479

William Stein's avatar
William Stein committed
6480 6481 6482 6483 6484 6485 6486
    relation_table = {
        # {relop : (initial offset, increment op)}
        '<=': ("",   "++"),
        '<' : ("+1", "++"),
        '>=': ("",   "--"),
        '>' : ("-1", "--")
    }
6487 6488 6489 6490 6491 6492 6493 6494 6495 6496

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

6498 6499 6500 6501 6502
    def annotate(self, code):
        self.target.annotate(code)
        self.bound1.annotate(code)
        self.bound2.annotate(code)
        if self.step:
6503
            self.step.annotate(code)
6504 6505 6506
        self.body.annotate(code)
        if self.else_clause:
            self.else_clause.annotate(code)
William Stein's avatar
William Stein committed
6507 6508


6509 6510 6511
class WithStatNode(StatNode):
    """
    Represents a Python with statement.
6512

6513
    Implemented by the WithTransform as follows:
6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530

        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
6531 6532
    """
    #  manager          The with statement manager object
6533
    #  target           ExprNode  the target lhs of the __enter__() call
6534
    #  body             StatNode
6535
    #  enter_call       ExprNode  the call to the __enter__() method
6536
    #  exit_var         String    the cname of the __exit__() method reference
6537

6538
    child_attrs = ["manager", "enter_call", "target", "body"]
6539

6540
    enter_call = None
6541
    target_temp = None
6542 6543 6544

    def analyse_declarations(self, env):
        self.manager.analyse_declarations(env)
6545
        self.enter_call.analyse_declarations(env)
6546 6547 6548
        self.body.analyse_declarations(env)

    def analyse_expressions(self, env):
6549 6550
        self.manager = self.manager.analyse_types(env)
        self.enter_call = self.enter_call.analyse_types(env)
6551 6552 6553 6554
        if self.target:
            # set up target_temp before descending into body (which uses it)
            from .ExprNodes import TempNode
            self.target_temp = TempNode(self.enter_call.pos, self.enter_call.type)
6555 6556
        self.body = self.body.analyse_expressions(env)
        return self
6557

6558 6559
    def generate_function_definitions(self, env, code):
        self.manager.generate_function_definitions(env, code)
6560
        self.enter_call.generate_function_definitions(env, code)
6561 6562
        self.body.generate_function_definitions(env, code)

6563
    def generate_execution_code(self, code):
6564
        code.mark_pos(self.pos)
6565 6566 6567
        code.putln("/*with:*/ {")
        self.manager.generate_evaluation_code(code)
        self.exit_var = code.funcstate.allocate_temp(py_object_type, manage_ref=False)
6568
        code.globalstate.use_utility_code(
6569 6570
            UtilityCode.load_cached("PyObjectLookupSpecial", "ObjectHandling.c"))
        code.putln("%s = __Pyx_PyObject_LookupSpecial(%s, %s); %s" % (
6571 6572
            self.exit_var,
            self.manager.py_result(),
6573
            code.intern_identifier(EncodedString('__aexit__' if self.is_async else '__exit__')),
6574 6575 6576 6577 6578 6579 6580 6581
            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

6582
        self.enter_call.generate_evaluation_code(code)
6583 6584 6585 6586 6587 6588 6589
        if self.target:
            # The temp result will be cleaned up by the WithTargetAssignmentStatNode
            # after assigning its result to the target of the 'with' statement.
            self.target_temp.allocate(code)
            self.enter_call.make_owned_reference(code)
            code.putln("%s = %s;" % (self.target_temp.result(), self.enter_call.result()))
            self.enter_call.generate_post_assignment_code(code)
6590
        else:
6591 6592 6593
            self.enter_call.generate_disposal_code(code)
        self.enter_call.free_temps(code)

6594 6595 6596 6597 6598 6599
        self.manager.generate_disposal_code(code)
        self.manager.free_temps(code)

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

6600 6601 6602 6603 6604 6605 6606
        if code.label_used(intermediate_error_label):
            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)
6607 6608 6609 6610

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

6611

6612 6613 6614 6615
class WithTargetAssignmentStatNode(AssignmentNode):
    # The target assignment of the 'with' statement value (return
    # value of the __enter__() call).
    #
6616
    # This is a special cased assignment that properly cleans up the RHS.
6617
    #
6618 6619 6620
    # lhs       ExprNode      the assignment target
    # rhs       ExprNode      a (coerced) TempNode for the rhs (from WithStatNode)
    # with_node WithStatNode  the surrounding with-statement
6621

6622 6623 6624
    child_attrs = ["rhs", "lhs"]
    with_node = None
    rhs = None
6625 6626 6627 6628

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

6629
    def analyse_expressions(self, env):
6630
        self.lhs = self.lhs.analyse_target_types(env)
6631
        self.lhs.gil_assignment_check(env)
6632
        self.rhs = self.with_node.target_temp.coerce_to(self.lhs.type, env)
6633
        return self
6634 6635 6636 6637

    def generate_execution_code(self, code):
        self.rhs.generate_evaluation_code(code)
        self.lhs.generate_assignment_code(self.rhs, code)
6638
        self.with_node.target_temp.release(code)
6639 6640 6641 6642 6643

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

6644

William Stein's avatar
William Stein committed
6645 6646 6647 6648 6649 6650
class TryExceptStatNode(StatNode):
    #  try .. except statement
    #
    #  body             StatNode
    #  except_clauses   [ExceptClauseNode]
    #  else_clause      StatNode or None
6651

6652
    child_attrs = ["body", "except_clauses", "else_clause"]
6653

William Stein's avatar
William Stein committed
6654 6655 6656 6657 6658 6659
    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)
6660

William Stein's avatar
William Stein committed
6661
    def analyse_expressions(self, env):
6662
        self.body = self.body.analyse_expressions(env)
6663
        default_clause_seen = 0
6664 6665
        for i, except_clause in enumerate(self.except_clauses):
            except_clause = self.except_clauses[i] = except_clause.analyse_expressions(env)
6666 6667 6668 6669 6670
            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
6671
        if self.else_clause:
6672 6673
            self.else_clause = self.else_clause.analyse_expressions(env)
        return self
6674

6675
    nogil_check = Node.gil_error
6676 6677
    gil_message = "Try-except statement"

William Stein's avatar
William Stein committed
6678
    def generate_execution_code(self, code):
6679
        old_return_label = code.return_label
6680
        old_break_label = code.break_label
6681
        old_continue_label = code.continue_label
William Stein's avatar
William Stein committed
6682 6683
        old_error_label = code.new_error_label()
        our_error_label = code.error_label
6684 6685 6686
        except_end_label = code.new_label('exception_handled')
        except_error_label = code.new_label('except_error')
        except_return_label = code.new_label('except_return')
6687
        try_return_label = code.new_label('try_return')
6688
        try_break_label = code.new_label('try_break')
6689
        try_continue_label = code.new_label('try_continue')
6690
        try_end_label = code.new_label('try_end')
6691

6692
        exc_save_vars = [code.funcstate.allocate_temp(py_object_type, False)
6693
                         for _ in range(3)]
6694
        code.mark_pos(self.pos)
6695
        code.putln("{")
6696
        save_exc = code.insertion_point()
William Stein's avatar
William Stein committed
6697 6698
        code.putln(
            "/*try:*/ {")
6699
        code.return_label = try_return_label
6700
        code.break_label = try_break_label
6701
        code.continue_label = try_continue_label
William Stein's avatar
William Stein committed
6702
        self.body.generate_execution_code(code)
6703
        code.mark_pos(self.pos, trace=False)
William Stein's avatar
William Stein committed
6704 6705
        code.putln(
            "}")
6706
        temps_to_clean_up = code.funcstate.all_free_managed_temps()
6707 6708 6709 6710
        can_raise = code.label_used(our_error_label)

        if can_raise:
            # inject code before the try block to save away the exception state
6711
            code.globalstate.use_utility_code(reset_exception_utility_code)
6712 6713 6714 6715
            save_exc.putln("__Pyx_PyThreadState_declare")
            save_exc.putln("__Pyx_PyThreadState_assign")
            save_exc.putln("__Pyx_ExceptionSave(%s);" % (
                ', '.join(['&%s' % var for var in exc_save_vars])))
6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726
            for var in exc_save_vars:
                save_exc.put_xgotref(var)

            def restore_saved_exception():
                for name in exc_save_vars:
                    code.put_xgiveref(name)
                code.putln("__Pyx_ExceptionReset(%s);" %
                           ', '.join(exc_save_vars))
        else:
            # try block cannot raise exceptions, but we had to allocate the temps above,
            # so just keep the C compiler from complaining about them being unused
6727
            save_exc.putln("if (%s); else {/*mark used*/}" % '||'.join(exc_save_vars))
6728 6729 6730 6731

            def restore_saved_exception():
                pass

6732 6733
        code.error_label = except_error_label
        code.return_label = except_return_label
6734
        normal_case_terminates = self.body.is_terminator
William Stein's avatar
William Stein committed
6735
        if self.else_clause:
6736
            code.mark_pos(self.else_clause.pos)
William Stein's avatar
William Stein committed
6737 6738 6739 6740 6741
            code.putln(
                "/*else:*/ {")
            self.else_clause.generate_execution_code(code)
            code.putln(
                "}")
6742 6743
            if not normal_case_terminates:
                normal_case_terminates = self.else_clause.is_terminator
6744

6745
        if can_raise:
6746 6747 6748 6749
            if not normal_case_terminates:
                for var in exc_save_vars:
                    code.put_xdecref_clear(var, py_object_type)
                code.put_goto(try_end_label)
6750
            code.put_label(our_error_label)
6751
            code.putln("__Pyx_PyThreadState_assign")  # re-assign in case a generator yielded
6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763
            for temp_name, temp_type in temps_to_clean_up:
                code.put_xdecref_clear(temp_name, temp_type)
            for except_clause in self.except_clauses:
                except_clause.generate_handling_code(code, except_end_label)
            if not self.has_default_clause:
                code.put_goto(except_error_label)

        for exit_label, old_label in [(except_error_label, old_error_label),
                                      (try_break_label, old_break_label),
                                      (try_continue_label, old_continue_label),
                                      (try_return_label, old_return_label),
                                      (except_return_label, old_return_label)]:
6764
            if code.label_used(exit_label):
6765
                if not normal_case_terminates and not code.label_used(try_end_label):
6766
                    code.put_goto(try_end_label)
6767
                code.put_label(exit_label)
6768
                code.mark_pos(self.pos, trace=False)
6769 6770 6771
                if can_raise:
                    code.putln("__Pyx_PyThreadState_assign")  # re-assign in case a generator yielded
                    restore_saved_exception()
6772
                code.put_goto(old_label)
6773 6774

        if code.label_used(except_end_label):
6775
            if not normal_case_terminates and not code.label_used(try_end_label):
6776
                code.put_goto(try_end_label)
6777
            code.put_label(except_end_label)
6778 6779 6780
            if can_raise:
                code.putln("__Pyx_PyThreadState_assign")  # re-assign in case a generator yielded
                restore_saved_exception()
6781 6782
        if code.label_used(try_end_label):
            code.put_label(try_end_label)
6783 6784
        code.putln("}")

6785 6786 6787
        for cname in exc_save_vars:
            code.funcstate.release_temp(cname)

6788
        code.return_label = old_return_label
6789
        code.break_label = old_break_label
6790
        code.continue_label = old_continue_label
6791
        code.error_label = old_error_label
William Stein's avatar
William Stein committed
6792

6793 6794 6795 6796 6797 6798 6799
    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)

6800 6801 6802 6803 6804 6805 6806
    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
6807 6808 6809 6810

class ExceptClauseNode(Node):
    #  Part of try ... except statement.
    #
6811
    #  pattern        [ExprNode]
William Stein's avatar
William Stein committed
6812 6813
    #  target         ExprNode or None
    #  body           StatNode
6814
    #  excinfo_target TupleNode(3*ResultRefNode) or None   optional target for exception info (not owned here!)
William Stein's avatar
William Stein committed
6815 6816 6817
    #  match_flag     string             result of exception match
    #  exc_value      ExcValueNode       used internally
    #  function_name  string             qualified name of enclosing function
6818
    #  exc_vars       (string * 3)       local exception variables
6819
    #  is_except_as   bool               Py3-style "except ... as xyz"
6820 6821 6822 6823

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

6825
    child_attrs = ["pattern", "target", "body", "exc_value"]
6826

6827
    exc_value = None
6828
    excinfo_target = None
6829
    is_except_as = False
6830

William Stein's avatar
William Stein committed
6831 6832 6833 6834
    def analyse_declarations(self, env):
        if self.target:
            self.target.analyse_target_declaration(env)
        self.body.analyse_declarations(env)
6835

William Stein's avatar
William Stein committed
6836 6837 6838
    def analyse_expressions(self, env):
        self.function_name = env.qualified_name
        if self.pattern:
6839 6840
            # normalise/unpack self.pattern into a list
            for i, pattern in enumerate(self.pattern):
6841
                pattern = pattern.analyse_expressions(env)
6842
                self.pattern[i] = pattern.coerce_to_pyobject(env)
6843

William Stein's avatar
William Stein committed
6844
        if self.target:
6845
            from . import ExprNodes
6846
            self.exc_value = ExprNodes.ExcValueNode(self.pos)
6847
            self.target = self.target.analyse_target_expression(env, self.exc_value)
6848

6849 6850
        self.body = self.body.analyse_expressions(env)
        return self
6851

William Stein's avatar
William Stein committed
6852 6853 6854
    def generate_handling_code(self, code, end_label):
        code.mark_pos(self.pos)
        if self.pattern:
6855
            code.globalstate.use_utility_code(UtilityCode.load_cached("PyErrExceptionMatches", "Exceptions.c"))
6856 6857 6858
            exc_tests = []
            for pattern in self.pattern:
                pattern.generate_evaluation_code(code)
6859
                exc_tests.append("__Pyx_PyErr_ExceptionMatches(%s)" % pattern.py_result())
6860

6861
            match_flag = code.funcstate.allocate_temp(PyrexTypes.c_int_type, False)
William Stein's avatar
William Stein committed
6862
            code.putln(
6863 6864 6865 6866
                "%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
6867 6868
            code.putln(
                "if (%s) {" %
6869 6870
                    match_flag)
            code.funcstate.release_temp(match_flag)
William Stein's avatar
William Stein committed
6871
        else:
6872
            code.putln("/*except:*/ {")
6873

6874 6875
        if (not getattr(self.body, 'stats', True)
                and self.excinfo_target is None
6876
                and self.target is None):
Stefan Behnel's avatar
Stefan Behnel committed
6877 6878
            # most simple case: no exception variable, empty body (pass)
            # => reset the exception state, done
6879 6880
            code.globalstate.use_utility_code(UtilityCode.load_cached("PyErrFetchRestore", "Exceptions.c"))
            code.putln("__Pyx_ErrRestore(0,0,0);")
6881 6882 6883
            code.put_goto(end_label)
            code.putln("}")
            return
6884

6885 6886
        exc_vars = [code.funcstate.allocate_temp(py_object_type,
                                                 manage_ref=True)
6887
                    for _ in range(3)]
6888
        code.put_add_traceback(self.function_name)
William Stein's avatar
William Stein committed
6889
        # We always have to fetch the exception value even if
6890
        # there is no target, because this also normalises the
William Stein's avatar
William Stein committed
6891
        # exception and stores it in the thread state.
6892 6893
        code.globalstate.use_utility_code(get_exception_utility_code)
        exc_args = "&%s, &%s, &%s" % tuple(exc_vars)
6894 6895
        code.putln("if (__Pyx_GetException(%s) < 0) %s" % (exc_args,
            code.error_goto(self.pos)))
6896
        for x in exc_vars:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
6897
            code.put_gotref(x)
William Stein's avatar
William Stein committed
6898
        if self.target:
6899
            self.exc_value.set_var(exc_vars[1])
6900
            self.exc_value.generate_evaluation_code(code)
William Stein's avatar
William Stein committed
6901
            self.target.generate_assignment_code(self.exc_value, code)
6902
        if self.excinfo_target is not None:
6903
            for tempvar, node in zip(exc_vars, self.excinfo_target.args):
6904
                node.set_var(tempvar)
6905

6906 6907 6908 6909
        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')

6910
        old_exc_vars = code.funcstate.exc_vars
6911
        code.funcstate.exc_vars = exc_vars
William Stein's avatar
William Stein committed
6912
        self.body.generate_execution_code(code)
6913
        code.funcstate.exc_vars = old_exc_vars
6914 6915 6916 6917
        if not self.body.is_terminator:
            for var in exc_vars:
                code.put_decref_clear(var, py_object_type)
            code.put_goto(end_label)
6918

Stefan Behnel's avatar
Stefan Behnel committed
6919 6920 6921 6922 6923 6924 6925
        for new_label, old_label in [(code.break_label, old_break_label),
                                     (code.continue_label, old_continue_label)]:
            if code.label_used(new_label):
                code.put_label(new_label)
                for var in exc_vars:
                    code.put_decref_clear(var, py_object_type)
                code.put_goto(old_label)
Robert Bradshaw's avatar
Robert Bradshaw committed
6926
        code.break_label = old_break_label
6927
        code.continue_label = old_continue_label
6928

6929 6930
        for temp in exc_vars:
            code.funcstate.release_temp(temp)
6931

William Stein's avatar
William Stein committed
6932 6933 6934
        code.putln(
            "}")

6935 6936 6937 6938
    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)
6939

6940
    def annotate(self, code):
6941
        if self.pattern:
6942 6943
            for pattern in self.pattern:
                pattern.annotate(code)
6944 6945 6946 6947
        if self.target:
            self.target.annotate(code)
        self.body.annotate(code)

William Stein's avatar
William Stein committed
6948 6949 6950 6951 6952 6953

class TryFinallyStatNode(StatNode):
    #  try ... finally statement
    #
    #  body             StatNode
    #  finally_clause   StatNode
6954
    #  finally_except_clause  deep-copy of finally_clause for exception case
6955
    #
Stefan Behnel's avatar
Stefan Behnel committed
6956 6957
    #  Each of the continue, break, return and error gotos runs
    #  into its own deep-copy of the finally block code.
William Stein's avatar
William Stein committed
6958 6959 6960
    #  In addition, if we're doing an error, we save the
    #  exception on entry to the finally block and restore
    #  it on exit.
6961

6962
    child_attrs = ["body", "finally_clause", "finally_except_clause"]
6963

6964
    preserve_exception = 1
6965

6966 6967
    # handle exception case, in addition to return/break/continue
    handle_error_case = True
6968
    func_return_type = None
6969
    finally_except_clause = None
6970

6971 6972
    is_try_finally_in_nogil = False

6973
    @staticmethod
6974 6975 6976
    def create_analysed(pos, env, body, finally_clause):
        node = TryFinallyStatNode(pos, body=body, finally_clause=finally_clause)
        return node
6977

William Stein's avatar
William Stein committed
6978 6979
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)
6980 6981
        self.finally_except_clause = copy.deepcopy(self.finally_clause)
        self.finally_except_clause.analyse_declarations(env)
William Stein's avatar
William Stein committed
6982
        self.finally_clause.analyse_declarations(env)
6983

William Stein's avatar
William Stein committed
6984
    def analyse_expressions(self, env):
6985 6986
        self.body = self.body.analyse_expressions(env)
        self.finally_clause = self.finally_clause.analyse_expressions(env)
6987
        self.finally_except_clause = self.finally_except_clause.analyse_expressions(env)
Stefan Behnel's avatar
Stefan Behnel committed
6988 6989
        if env.return_type and not env.return_type.is_void:
            self.func_return_type = env.return_type
6990
        return self
6991

6992
    nogil_check = Node.gil_error
6993 6994
    gil_message = "Try-finally statement"

William Stein's avatar
William Stein committed
6995
    def generate_execution_code(self, code):
6996
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
6997 6998 6999 7000
        old_error_label = code.error_label
        old_labels = code.all_new_labels()
        new_labels = code.get_all_labels()
        new_error_label = code.error_label
7001 7002
        if not self.handle_error_case:
            code.error_label = old_error_label
William Stein's avatar
William Stein committed
7003
        catch_label = code.new_label()
7004 7005

        code.putln("/*try:*/ {")
Stefan Behnel's avatar
Stefan Behnel committed
7006 7007
        was_in_try_finally = code.funcstate.in_try_finally
        code.funcstate.in_try_finally = 1
7008

William Stein's avatar
William Stein committed
7009
        self.body.generate_execution_code(code)
7010

Stefan Behnel's avatar
Stefan Behnel committed
7011
        code.funcstate.in_try_finally = was_in_try_finally
7012
        code.putln("}")
7013
        code.set_all_labels(old_labels)
7014

7015
        temps_to_clean_up = code.funcstate.all_free_managed_temps()
7016
        code.mark_pos(self.finally_clause.pos)
7017 7018
        code.putln("/*finally:*/ {")

7019 7020 7021 7022 7023 7024 7025 7026 7027
        def fresh_finally_clause(_next=[self.finally_clause]):
            # generate the original subtree once and always keep a fresh copy
            node = _next[0]
            node_copy = copy.deepcopy(node)
            if node is self.finally_clause:
                _next[0] = node_copy
            else:
                node = node_copy
            return node
7028 7029

        preserve_error = self.preserve_exception and code.label_used(new_error_label)
7030
        needs_success_cleanup = not self.finally_clause.is_terminator
7031 7032 7033

        if not self.body.is_terminator:
            code.putln('/*normal exit:*/{')
7034 7035
            fresh_finally_clause().generate_execution_code(code)
            if not self.finally_clause.is_terminator:
7036
                code.put_goto(catch_label)
7037
            code.putln('}')
7038

7039 7040
        if preserve_error:
            code.putln('/*exception exit:*/{')
7041
            code.putln("__Pyx_PyThreadState_declare")
7042 7043
            if self.is_try_finally_in_nogil:
                code.declare_gilstate()
7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054
            if needs_success_cleanup:
                exc_lineno_cnames = tuple([
                    code.funcstate.allocate_temp(PyrexTypes.c_int_type, manage_ref=False)
                    for _ in range(2)])
                exc_filename_cname = code.funcstate.allocate_temp(
                    PyrexTypes.CPtrType(PyrexTypes.c_const_type(PyrexTypes.c_char_type)),
                    manage_ref=False)
            else:
                exc_lineno_cnames = exc_filename_cname = None
            exc_vars = tuple([
                code.funcstate.allocate_temp(py_object_type, manage_ref=False)
7055
                for _ in range(6)])
7056
            code.put_label(new_error_label)
7057
            self.put_error_catcher(
7058
                code, temps_to_clean_up, exc_vars, exc_lineno_cnames, exc_filename_cname)
7059
            finally_old_labels = code.all_new_labels()
7060

7061
            code.putln('{')
7062 7063
            old_exc_vars = code.funcstate.exc_vars
            code.funcstate.exc_vars = exc_vars[:3]
7064
            self.finally_except_clause.generate_execution_code(code)
7065
            code.funcstate.exc_vars = old_exc_vars
7066 7067
            code.putln('}')

7068
            if needs_success_cleanup:
7069 7070 7071 7072 7073 7074
                self.put_error_uncatcher(code, exc_vars, exc_lineno_cnames, exc_filename_cname)
                if exc_lineno_cnames:
                    for cname in exc_lineno_cnames:
                        code.funcstate.release_temp(cname)
                if exc_filename_cname:
                    code.funcstate.release_temp(exc_filename_cname)
7075
                code.put_goto(old_error_label)
7076

7077 7078 7079 7080
            for new_label, old_label in zip(code.get_all_labels(), finally_old_labels):
                if not code.label_used(new_label):
                    continue
                code.put_label(new_label)
7081
                self.put_error_cleaner(code, exc_vars)
7082
                code.put_goto(old_label)
7083 7084 7085

            for cname in exc_vars:
                code.funcstate.release_temp(cname)
7086
            code.putln('}')
7087

7088
        code.set_all_labels(old_labels)
7089
        return_label = code.return_label
7090 7091 7092 7093 7094
        for i, (new_label, old_label) in enumerate(zip(new_labels, old_labels)):
            if not code.label_used(new_label):
                continue
            if new_label == new_error_label and preserve_error:
                continue  # handled above
7095

7096 7097
            code.put('%s: ' % new_label)
            code.putln('{')
7098 7099 7100
            ret_temp = None
            if old_label == return_label and not self.finally_clause.is_terminator:
                # store away return value for later reuse
7101 7102 7103
                if (self.func_return_type and
                        not self.is_try_finally_in_nogil and
                        not isinstance(self.finally_clause, GILExitNode)):
7104 7105 7106 7107 7108
                    ret_temp = code.funcstate.allocate_temp(
                        self.func_return_type, manage_ref=False)
                    code.putln("%s = %s;" % (ret_temp, Naming.retval_cname))
                    if self.func_return_type.is_pyobject:
                        code.putln("%s = 0;" % Naming.retval_cname)
7109
            fresh_finally_clause().generate_execution_code(code)
7110 7111 7112 7113 7114 7115
            if ret_temp:
                code.putln("%s = %s;" % (Naming.retval_cname, ret_temp))
                if self.func_return_type.is_pyobject:
                    code.putln("%s = 0;" % ret_temp)
                code.funcstate.release_temp(ret_temp)
                ret_temp = None
7116
            if not self.finally_clause.is_terminator:
7117 7118
                code.put_goto(old_label)
            code.putln('}')
7119 7120

        # End finally
7121
        code.put_label(catch_label)
William Stein's avatar
William Stein committed
7122 7123 7124
        code.putln(
            "}")

7125 7126 7127 7128
    def generate_function_definitions(self, env, code):
        self.body.generate_function_definitions(env, code)
        self.finally_clause.generate_function_definitions(env, code)

7129 7130
    def put_error_catcher(self, code, temps_to_clean_up, exc_vars,
                          exc_lineno_cnames, exc_filename_cname):
7131
        code.globalstate.use_utility_code(restore_exception_utility_code)
7132 7133
        code.globalstate.use_utility_code(get_exception_utility_code)
        code.globalstate.use_utility_code(swap_exception_utility_code)
7134

7135
        code.putln(' '.join(["%s = 0;"]*len(exc_vars)) % exc_vars)
7136 7137
        if self.is_try_finally_in_nogil:
            code.put_ensure_gil(declare_gilstate=False)
7138
        code.putln("__Pyx_PyThreadState_assign")
7139

7140 7141
        for temp_name, type in temps_to_clean_up:
            code.put_xdecref_clear(temp_name, type)
7142

7143 7144 7145 7146 7147 7148 7149 7150 7151
        # not using preprocessor here to avoid warnings about
        # unused utility functions and/or temps
        code.putln("if (PY_MAJOR_VERSION >= 3)"
                   " __Pyx_ExceptionSwap(&%s, &%s, &%s);" % exc_vars[3:])
        code.putln("if ((PY_MAJOR_VERSION < 3) ||"
                   # if __Pyx_GetException() fails in Py3,
                   # store the newly raised exception instead
                   " unlikely(__Pyx_GetException(&%s, &%s, &%s) < 0)) "
                   "__Pyx_ErrFetch(&%s, &%s, &%s);" % (exc_vars[:3] * 2))
7152 7153 7154 7155 7156 7157 7158
        for var in exc_vars:
            code.put_xgotref(var)
        if exc_lineno_cnames:
            code.putln("%s = %s; %s = %s; %s = %s;" % (
                exc_lineno_cnames[0], Naming.lineno_cname,
                exc_lineno_cnames[1], Naming.clineno_cname,
                exc_filename_cname, Naming.filename_cname))
7159 7160 7161 7162

        if self.is_try_finally_in_nogil:
            code.put_release_ensured_gil()

7163
    def put_error_uncatcher(self, code, exc_vars, exc_lineno_cnames, exc_filename_cname):
7164
        code.globalstate.use_utility_code(restore_exception_utility_code)
7165
        code.globalstate.use_utility_code(reset_exception_utility_code)
7166 7167 7168

        if self.is_try_finally_in_nogil:
            code.put_ensure_gil(declare_gilstate=False)
7169
        code.putln("__Pyx_PyThreadState_assign")  # re-assign in case a generator yielded
7170

7171 7172 7173
        # not using preprocessor here to avoid warnings about
        # unused utility functions and/or temps
        code.putln("if (PY_MAJOR_VERSION >= 3) {")
7174 7175 7176
        for var in exc_vars[3:]:
            code.put_xgiveref(var)
        code.putln("__Pyx_ExceptionReset(%s, %s, %s);" % exc_vars[3:])
7177
        code.putln("}")
7178
        for var in exc_vars[:3]:
7179
            code.put_xgiveref(var)
7180
        code.putln("__Pyx_ErrRestore(%s, %s, %s);" % exc_vars[:3])
7181 7182 7183 7184

        if self.is_try_finally_in_nogil:
            code.put_release_ensured_gil()

7185
        code.putln(' '.join(["%s = 0;"]*len(exc_vars)) % exc_vars)
7186 7187 7188 7189 7190
        if exc_lineno_cnames:
            code.putln("%s = %s; %s = %s; %s = %s;" % (
                Naming.lineno_cname, exc_lineno_cnames[0],
                Naming.clineno_cname, exc_lineno_cnames[1],
                Naming.filename_cname, exc_filename_cname))
7191

7192
    def put_error_cleaner(self, code, exc_vars):
7193
        code.globalstate.use_utility_code(reset_exception_utility_code)
7194 7195
        if self.is_try_finally_in_nogil:
            code.put_ensure_gil(declare_gilstate=False)
7196 7197
        code.putln("__Pyx_PyThreadState_assign")  # re-assign in case a generator yielded

7198 7199 7200
        # not using preprocessor here to avoid warnings about
        # unused utility functions and/or temps
        code.putln("if (PY_MAJOR_VERSION >= 3) {")
7201 7202 7203
        for var in exc_vars[3:]:
            code.put_xgiveref(var)
        code.putln("__Pyx_ExceptionReset(%s, %s, %s);" % exc_vars[3:])
7204
        code.putln("}")
7205
        for var in exc_vars[:3]:
7206
            code.put_xdecref_clear(var, py_object_type)
7207 7208
        if self.is_try_finally_in_nogil:
            code.put_release_ensured_gil()
7209
        code.putln(' '.join(["%s = 0;"]*3) % exc_vars[3:])
William Stein's avatar
William Stein committed
7210

7211 7212 7213 7214
    def annotate(self, code):
        self.body.annotate(code)
        self.finally_clause.annotate(code)

William Stein's avatar
William Stein committed
7215

7216 7217 7218 7219 7220 7221 7222 7223 7224 7225
class NogilTryFinallyStatNode(TryFinallyStatNode):
    """
    A try/finally statement that may be used in nogil code sections.
    """

    preserve_exception = False
    nogil_check = None


class GILStatNode(NogilTryFinallyStatNode):
7226 7227 7228
    #  'with gil' or 'with nogil' statement
    #
    #   state   string   'gil' or 'nogil'
7229

7230 7231
    state_temp = None

7232 7233
    def __init__(self, pos, state, body):
        self.state = state
7234 7235 7236 7237 7238 7239 7240
        self.create_state_temp_if_needed(pos, state, body)
        TryFinallyStatNode.__init__(self, pos,
            body=body,
            finally_clause=GILExitNode(
                pos, state=state, state_temp=self.state_temp))

    def create_state_temp_if_needed(self, pos, state, body):
7241
        from .ParseTreeTransforms import YieldNodeCollector
7242 7243
        collector = YieldNodeCollector()
        collector.visitchildren(body)
7244
        if not collector.yields and not collector.awaits:
7245 7246
            return

7247 7248 7249 7250
        if state == 'gil':
            temp_type = PyrexTypes.c_gilstate_type
        else:
            temp_type = PyrexTypes.c_threadstate_ptr_type
7251
        from . import ExprNodes
7252
        self.state_temp = ExprNodes.TempNode(pos, temp_type)
7253

7254 7255 7256 7257
    def analyse_declarations(self, env):
        env._in_with_gil_block = (self.state == 'gil')
        if self.state == 'gil':
            env.has_with_gil_block = True
7258

7259 7260
        return super(GILStatNode, self).analyse_declarations(env)

7261
    def analyse_expressions(self, env):
7262 7263
        env.use_utility_code(
            UtilityCode.load_cached("ForceInitThreads", "ModuleSetupCode.c"))
7264
        was_nogil = env.nogil
7265
        env.nogil = self.state == 'nogil'
7266
        node = TryFinallyStatNode.analyse_expressions(self, env)
7267
        env.nogil = was_nogil
7268
        return node
7269

7270
    def generate_execution_code(self, code):
Stefan Behnel's avatar
Stefan Behnel committed
7271
        code.mark_pos(self.pos)
7272
        code.begin_block()
7273 7274 7275 7276 7277
        if self.state_temp:
            self.state_temp.allocate(code)
            variable = self.state_temp.result()
        else:
            variable = None
7278

7279
        old_gil_config = code.funcstate.gil_owned
7280
        if self.state == 'gil':
7281
            code.put_ensure_gil(variable=variable)
7282
            code.funcstate.gil_owned = True
7283
        else:
7284
            code.put_release_gil(variable=variable)
7285
            code.funcstate.gil_owned = False
7286

7287
        TryFinallyStatNode.generate_execution_code(self, code)
7288

7289 7290
        if self.state_temp:
            self.state_temp.release(code)
7291

7292
        code.funcstate.gil_owned = old_gil_config
7293
        code.end_block()
7294 7295 7296


class GILExitNode(StatNode):
7297 7298 7299 7300 7301
    """
    Used as the 'finally' block in a GILStatNode

    state   string   'gil' or 'nogil'
    """
7302

7303
    child_attrs = []
7304
    state_temp = None
7305

7306
    def analyse_expressions(self, env):
7307
        return self
7308 7309

    def generate_execution_code(self, code):
7310 7311 7312 7313 7314
        if self.state_temp:
            variable = self.state_temp.result()
        else:
            variable = None

7315
        if self.state == 'gil':
7316
            code.put_release_ensured_gil(variable)
7317
        else:
7318
            code.put_acquire_gil(variable)
7319 7320


7321 7322 7323 7324 7325 7326 7327
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)
7328

7329

7330 7331 7332 7333 7334 7335
utility_code_for_cimports = {
    # utility code (or inlining c) in a pxd (or pyx) file.
    # TODO: Consider a generic user-level mechanism for importing
    'cpython.array'         : ("ArrayAPI", "arrayarray.h"),
    'cpython.array.array'   : ("ArrayAPI", "arrayarray.h"),
}
7336

7337

7338 7339 7340
utility_code_for_imports = {
    # utility code used when special modules are imported.
    # TODO: Consider a generic user-level mechanism for importing
7341 7342
    'asyncio': ("__Pyx_patch_asyncio", "PatchAsyncIO", "Coroutine.c"),
    'inspect': ("__Pyx_patch_inspect", "PatchInspect", "Coroutine.c"),
7343 7344 7345
}


William Stein's avatar
William Stein committed
7346 7347 7348 7349 7350
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
7351
    #  is_absolute   bool             True for absolute imports, False otherwise
7352 7353

    child_attrs = []
7354
    is_absolute = False
7355

William Stein's avatar
William Stein committed
7356
    def analyse_declarations(self, env):
7357 7358 7359
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
7360 7361
        module_scope = env.find_module(
            self.module_name, self.pos, relative_level=0 if self.is_absolute else -1)
William Stein's avatar
William Stein committed
7362
        if "." in self.module_name:
7363
            names = [EncodedString(name) for name in self.module_name.split(".")]
William Stein's avatar
William Stein committed
7364 7365 7366 7367 7368 7369 7370 7371 7372 7373
            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:
7374
                env.add_imported_module(module_scope)
William Stein's avatar
William Stein committed
7375 7376 7377 7378
                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)
7379 7380 7381
        if self.module_name in utility_code_for_cimports:
            env.use_utility_code(UtilityCode.load_cached(
                *utility_code_for_cimports[self.module_name]))
William Stein's avatar
William Stein committed
7382 7383

    def analyse_expressions(self, env):
7384
        return self
7385

William Stein's avatar
William Stein committed
7386 7387
    def generate_execution_code(self, code):
        pass
7388

William Stein's avatar
William Stein committed
7389 7390 7391 7392

class FromCImportStatNode(StatNode):
    #  from ... cimport statement
    #
7393
    #  module_name     string                        Qualified name of module
7394
    #  relative_level  int or None                   Relative import: number of dots before module_name
7395
    #  imported_names  [(pos, name, as_name, kind)]  Names to be imported
7396

7397
    child_attrs = []
7398 7399 7400
    module_name = None
    relative_level = None
    imported_names = None
7401

William Stein's avatar
William Stein committed
7402
    def analyse_declarations(self, env):
7403 7404 7405
        if not env.is_module_scope:
            error(self.pos, "cimport only allowed at module level")
            return
7406 7407
        if self.relative_level and self.relative_level > env.qualified_name.count('.'):
            error(self.pos, "relative cimport beyond main package is not allowed")
7408
            return
7409 7410
        module_scope = env.find_module(self.module_name, self.pos, relative_level=self.relative_level)
        module_name = module_scope.qualified_name
William Stein's avatar
William Stein committed
7411
        env.add_imported_module(module_scope)
7412
        for pos, name, as_name, kind in self.imported_names:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7413
            if name == "*":
7414
                for local_name, entry in list(module_scope.entries.items()):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7415 7416
                    env.add_imported_entry(local_name, entry, pos)
            else:
7417 7418 7419 7420
                entry = module_scope.lookup(name)
                if entry:
                    if kind and not self.declaration_matches(entry, kind):
                        entry.redeclared(pos)
7421
                    entry.used = 1
7422 7423
                else:
                    if kind == 'struct' or kind == 'union':
7424 7425
                        entry = module_scope.declare_struct_or_union(
                            name, kind=kind, scope=None, typedef_flag=0, pos=pos)
7426
                    elif kind == 'class':
7427
                        entry = module_scope.declare_c_class(name, pos=pos, module_name=module_name)
7428
                    else:
7429 7430
                        submodule_scope = env.context.find_module(
                            name, relative_to=module_scope, pos=self.pos, absolute_fallback=False)
7431 7432 7433
                        if submodule_scope.parent_module is module_scope:
                            env.declare_module(as_name or name, submodule_scope, self.pos)
                        else:
7434
                            error(pos, "Name '%s' not declared in module '%s'" % (name, module_name))
7435

Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7436 7437 7438
                if entry:
                    local_name = as_name or name
                    env.add_imported_entry(local_name, entry, pos)
7439

7440 7441
        if module_name.startswith('cpython'): # enough for now
            if module_name in utility_code_for_cimports:
7442
                env.use_utility_code(UtilityCode.load_cached(
7443
                    *utility_code_for_cimports[module_name]))
7444
            for _, name, _, _ in self.imported_names:
7445
                fqname = '%s.%s' % (module_name, name)
7446 7447 7448
                if fqname in utility_code_for_cimports:
                    env.use_utility_code(UtilityCode.load_cached(
                        *utility_code_for_cimports[fqname]))
7449

7450
    def declaration_matches(self, entry, kind):
7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462
        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
7463 7464

    def analyse_expressions(self, env):
7465
        return self
7466

William Stein's avatar
William Stein committed
7467 7468 7469 7470 7471 7472 7473 7474 7475
    def generate_execution_code(self, code):
        pass


class FromImportStatNode(StatNode):
    #  from ... import statement
    #
    #  module           ImportNode
    #  items            [(string, NameNode)]
7476
    #  interned_items   [(string, NameNode, ExprNode)]
William Stein's avatar
William Stein committed
7477
    #  item             PyTempNode            used internally
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7478
    #  import_star      boolean               used internally
7479 7480

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

William Stein's avatar
William Stein committed
7483
    def analyse_declarations(self, env):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7484 7485 7486 7487 7488 7489 7490 7491 7492
        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)
7493

William Stein's avatar
William Stein committed
7494
    def analyse_expressions(self, env):
7495
        from . import ExprNodes
7496
        self.module = self.module.analyse_expressions(env)
7497
        self.item = ExprNodes.RawCNameExprNode(self.pos, py_object_type)
William Stein's avatar
William Stein committed
7498 7499
        self.interned_items = []
        for name, target in self.items:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7500 7501 7502
            if name == '*':
                for _, entry in env.entries.items():
                    if not entry.is_type and entry.type.is_extension_type:
7503
                        env.use_utility_code(UtilityCode.load_cached("ExtTypeTest", "ObjectHandling.c"))
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7504 7505
                        break
            else:
7506
                entry = env.lookup(target.name)
7507 7508
                # check whether or not entry is already cimported
                if (entry.is_type and entry.type.name == name
Stefan Behnel's avatar
Stefan Behnel committed
7509
                        and hasattr(entry.type, 'module_name')):
7510 7511 7512 7513 7514
                    if entry.type.module_name == self.module.module_name.value:
                        # cimported with absolute name
                        continue
                    try:
                        # cimported with relative name
7515 7516
                        module = env.find_module(self.module.module_name.value, pos=self.pos,
                                                 relative_level=self.module.level)
7517 7518 7519
                        if entry.type.module_name == module.qualified_name:
                            continue
                    except AttributeError:
7520
                        pass
7521
                target = target.analyse_target_expression(env, None)  # FIXME?
7522 7523 7524 7525
                if target.type is py_object_type:
                    coerced_item = None
                else:
                    coerced_item = self.item.coerce_to(target.type, env)
7526
                self.interned_items.append((name, target, coerced_item))
7527
        return self
7528

William Stein's avatar
William Stein committed
7529
    def generate_execution_code(self, code):
7530
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
7531
        self.module.generate_evaluation_code(code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
7532 7533 7534 7535 7536 7537
        if self.import_star:
            code.putln(
                'if (%s(%s) < 0) %s;' % (
                    Naming.import_star,
                    self.module.py_result(),
                    code.error_goto(self.pos)))
7538 7539
        item_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        self.item.set_cname(item_temp)
7540 7541 7542
        if self.interned_items:
            code.globalstate.use_utility_code(
                UtilityCode.load_cached("ImportFrom", "ImportExport.c"))
7543
        for name, target, coerced_item in self.interned_items:
7544
            code.putln(
7545
                '%s = __Pyx_ImportFrom(%s, %s); %s' % (
7546
                    item_temp,
7547
                    self.module.py_result(),
7548 7549
                    code.intern_identifier(name),
                    code.error_goto_if_null(item_temp, self.pos)))
7550
            code.put_gotref(item_temp)
7551 7552 7553 7554 7555 7556
            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)
7557 7558
            code.put_decref_clear(item_temp, py_object_type)
        code.funcstate.release_temp(item_temp)
William Stein's avatar
William Stein committed
7559
        self.module.generate_disposal_code(code)
7560
        self.module.free_temps(code)
William Stein's avatar
William Stein committed
7561

7562

Mark Florisson's avatar
Mark Florisson committed
7563 7564 7565 7566 7567 7568 7569 7570 7571 7572
class ParallelNode(Node):
    """
    Base class for cython.parallel constructs.
    """

    nogil_check = None


class ParallelStatNode(StatNode, ParallelNode):
    """
7573
    Base class for 'with cython.parallel.parallel():' and 'for i in prange():'.
Mark Florisson's avatar
Mark Florisson committed
7574 7575 7576 7577 7578

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

    parent          parent ParallelStatNode or None
7579 7580 7581
    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
7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592

    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.
7593 7594 7595

    privatization_insertion_point   a code insertion point used to make temps
                                    private (esp. the "nsteps" temp)
7596 7597 7598 7599

    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
7600 7601
    """

7602
    child_attrs = ['body', 'num_threads']
Mark Florisson's avatar
Mark Florisson committed
7603 7604 7605 7606

    body = None

    is_prange = False
7607
    is_nested_prange = False
Mark Florisson's avatar
Mark Florisson committed
7608

7609
    error_label_used = False
7610

7611
    num_threads = None
7612
    chunksize = None
7613

7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630
    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,
    )
7631

7632 7633
    critical_section_counter = 0

Mark Florisson's avatar
Mark Florisson committed
7634 7635
    def __init__(self, pos, **kwargs):
        super(ParallelStatNode, self).__init__(pos, **kwargs)
7636 7637

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

7640 7641 7642 7643
        # All seen closure cnames and their temporary cnames
        self.seen_closure_vars = set()

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

Mark Florisson's avatar
Mark Florisson committed
7648 7649 7650
        # [NameNode]
        self.assigned_nodes = []

Mark Florisson's avatar
Mark Florisson committed
7651 7652 7653
    def analyse_declarations(self, env):
        self.body.analyse_declarations(env)

7654 7655
        self.num_threads = None

7656
        if self.kwargs:
7657 7658 7659
            # Try to find num_threads and chunksize keyword arguments
            pairs = []
            for dictitem in self.kwargs.key_value_pairs:
7660 7661
                if dictitem.key.value == 'num_threads':
                    self.num_threads = dictitem.value
7662 7663 7664 7665 7666 7667
                elif self.is_prange and dictitem.key.value == 'chunksize':
                    self.chunksize = dictitem.value
                else:
                    pairs.append(dictitem)

            self.kwargs.key_value_pairs = pairs
7668

7669 7670
            try:
                self.kwargs = self.kwargs.compile_time_value(env)
7671
            except Exception as e:
7672 7673
                error(self.kwargs.pos, "Only compile-time values may be "
                                       "supplied as keyword arguments")
7674 7675 7676
        else:
            self.kwargs = {}

7677
        for kw, val in self.kwargs.items():
7678 7679 7680 7681 7682
            if kw not in self.valid_keyword_arguments:
                error(self.pos, "Invalid keyword argument: %s" % kw)
            else:
                setattr(self, kw, val)

7683
    def analyse_expressions(self, env):
7684
        if self.num_threads:
7685
            self.num_threads = self.num_threads.analyse_expressions(env)
7686 7687

        if self.chunksize:
7688
            self.chunksize = self.chunksize.analyse_expressions(env)
7689

7690
        self.body = self.body.analyse_expressions(env)
7691
        self.analyse_sharing_attributes(env)
7692

7693
        if self.num_threads is not None:
7694 7695
            if (self.parent and self.parent.num_threads is not None and not
                                                    self.parent.is_prange):
7696 7697
                error(self.pos,
                      "num_threads already declared in outer section")
7698
            elif self.parent and not self.parent.is_prange:
7699
                error(self.pos,
7700 7701 7702 7703
                      "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):
7704 7705 7706
                error(self.pos,
                      "argument to num_threads must be greater than 0")

Mark Florisson's avatar
Mark Florisson committed
7707 7708
            if not self.num_threads.is_simple():
                self.num_threads = self.num_threads.coerce_to(
7709 7710
                    PyrexTypes.c_int_type, env).coerce_to_temp(env)
        return self
7711 7712

    def analyse_sharing_attributes(self, env):
Mark Florisson's avatar
Mark Florisson committed
7713
        """
7714 7715 7716
        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
7717
        """
7718
        for entry, (pos, op) in self.assignments.items():
Mark Florisson's avatar
Mark Florisson committed
7719

7720 7721 7722 7723 7724 7725
            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
7726
                          "Cannot assign to private of outer parallel block")
7727 7728 7729 7730 7731 7732 7733
                    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
7734 7735 7736
            # By default all variables should have the same values as if
            # executed sequentially
            lastprivate = True
7737
            self.propagate_var_privatization(entry, pos, op, lastprivate)
7738

7739
    def propagate_var_privatization(self, entry, pos, op, lastprivate):
7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767
        """
        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
7768 7769
        Nested with parallel blocks are disallowed, because they wouldn't
        allow you to propagate lastprivates or reductions:
7770 7771 7772 7773

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

Mark Florisson's avatar
Mark Florisson committed
7774 7775
                sum = 0

7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791
                #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
        """
7792
        self.privates[entry] = (op, lastprivate)
7793 7794 7795 7796 7797

        if entry.type.is_memoryviewslice:
            error(pos, "Memoryview slices can only be shared in parallel sections")
            return

7798 7799 7800 7801 7802 7803
        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
7804

7805 7806 7807
            # We don't need to propagate privates, only reductions and
            # lastprivates
            if parent and (op or lastprivate):
7808
                parent.propagate_var_privatization(entry, pos, op, lastprivate)
Mark Florisson's avatar
Mark Florisson committed
7809 7810 7811 7812 7813 7814 7815 7816 7817

    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)

7818 7819 7820
        if entry.cname in self.seen_closure_vars:
            return entry.cname

7821
        cname = code.funcstate.allocate_temp(entry.type, True)
7822 7823 7824 7825 7826 7827

        # 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
7828 7829 7830 7831
        self.modified_entries.append((entry, entry.cname))
        code.putln("%s = %s;" % (cname, entry.cname))
        entry.cname = cname

7832
    def initialize_privates_to_nan(self, code, exclude=None):
7833
        first = True
7834

7835
        for entry, (op, lastprivate) in self.privates.items():
7836
            if not op and (not exclude or entry != exclude):
7837
                invalid_value = entry.type.invalid_value()
7838

7839
                if invalid_value:
7840 7841 7842 7843
                    if first:
                        code.putln("/* Initialize private variables to "
                                   "invalid values */")
                        first = False
7844
                    code.putln("%s = %s;" % (entry.cname,
7845
                                             entry.type.cast_code(invalid_value)))
7846

7847
    def evaluate_before_block(self, code, expr):
Mark Florisson's avatar
Mark Florisson committed
7848
        c = self.begin_of_parallel_control_block_point_after_decls
7849 7850 7851 7852 7853 7854 7855 7856 7857 7858
        # 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
        expr.generate_evaluation_code(c)
        c.funcstate.owner = owner

        return expr.result()

7859 7860 7861 7862 7863
    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:
7864 7865
            code.put(" num_threads(%s)" % self.evaluate_before_block(code,
                                                        self.num_threads))
7866

7867

Mark Florisson's avatar
Mark Florisson committed
7868 7869 7870 7871 7872 7873 7874 7875 7876
    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 = []

Stefan Behnel's avatar
Stefan Behnel committed
7877
        for entry in self.assignments:
Mark Florisson's avatar
Mark Florisson committed
7878
            if entry.from_closure or entry.in_closure:
7879
                self._allocate_closure_temp(code, entry)
Mark Florisson's avatar
Mark Florisson committed
7880 7881

    def release_closure_privates(self, code):
7882 7883 7884
        """
        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
7885
        self.seen_closure_vars.
7886
        """
Mark Florisson's avatar
Mark Florisson committed
7887 7888 7889 7890 7891
        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

7892 7893 7894 7895 7896 7897
    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:
7898
            c = self.privatization_insertion_point
7899

7900
            self.temps = temps = code.funcstate.stop_collecting_temps()
7901 7902
            privates, firstprivates = [], []
            for temp, type in temps:
7903
                if type.is_pyobject or type.is_memoryviewslice:
7904 7905 7906
                    firstprivates.append(temp)
                else:
                    privates.append(temp)
7907

7908 7909 7910 7911
            if privates:
                c.put(" private(%s)" % ", ".join(privates))
            if firstprivates:
                c.put(" firstprivate(%s)" % ", ".join(firstprivates))
7912 7913 7914 7915 7916 7917 7918 7919

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

7921 7922 7923 7924 7925 7926 7927 7928 7929 7930
    def cleanup_temps(self, code):
        # Now clean up any memoryview slice and object temporaries
        if self.is_parallel and not self.is_nested_prange:
            code.putln("/* Clean up any temporaries */")
            for temp, type in self.temps:
                if type.is_memoryviewslice:
                    code.put_xdecref_memoryviewslice(temp, have_gil=False)
                elif type.is_pyobject:
                    code.put_xdecref(temp, type)
                    code.putln("%s = NULL;" % temp)
7931

7932
    def setup_parallel_control_flow_block(self, code):
7933
        """
7934 7935
        Sets up a block that surrounds the parallel block to determine
        how the parallel section was exited. Any kind of return is
7936 7937 7938
        trapped (break, continue, return, exceptions). This is the idea:

        {
7939
            int why = 0;
7940 7941 7942 7943 7944 7945 7946

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

            new_return_label:
7947
                why = 3;
7948
                goto end_parallel;
7949

7950
            end_parallel:;
7951
                #pragma omp flush(why) # we need to flush for every iteration
7952 7953
            }

7954
            if (why == 3)
7955 7956 7957 7958 7959 7960 7961 7962
                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")

7963 7964
        code.begin_block() # parallel control flow block
        self.begin_of_parallel_control_block_point = code.insertion_point()
Mark Florisson's avatar
Mark Florisson committed
7965
        self.begin_of_parallel_control_block_point_after_decls = code.insertion_point()
7966

7967 7968
        self.undef_builtin_expect_apple_gcc_bug(code)

7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980
    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):
7981 7982 7983 7984 7985 7986 7987 7988 7989
        """
        To ensure all OpenMP threads have thread states, we ensure the GIL
        in each thread (which creates a thread state if it doesn't exist),
        after which we release the GIL.
        On exit, reacquire the GIL and release the thread state.

        If compiled without OpenMP support (at the C level), then we still have
        to acquire the GIL to decref any object temporaries.
        """
7990 7991 7992 7993
        if self.error_label_used:
            begin_code = self.begin_of_parallel_block
            end_code = code

7994
            begin_code.putln("#ifdef _OPENMP")
7995 7996
            begin_code.put_ensure_gil(declare_gilstate=True)
            begin_code.putln("Py_BEGIN_ALLOW_THREADS")
7997
            begin_code.putln("#endif /* _OPENMP */")
7998

7999
            end_code.putln("#ifdef _OPENMP")
8000
            end_code.putln("Py_END_ALLOW_THREADS")
8001 8002 8003 8004 8005
            end_code.putln("#else")
            end_code.put_safe("{\n")
            end_code.put_ensure_gil()
            end_code.putln("#endif /* _OPENMP */")
            self.cleanup_temps(end_code)
8006
            end_code.put_release_ensured_gil()
8007 8008
            end_code.putln("#ifndef _OPENMP")
            end_code.put_safe("}\n")
8009
            end_code.putln("#endif /* _OPENMP */")
8010

8011 8012 8013 8014
    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
8015 8016 8017 8018 8019 8020 8021 8022 8023
        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
8024
        """
8025
        save_lastprivates_label = code.new_label()
8026
        dont_return_label = code.new_label()
8027 8028 8029

        self.any_label_used = False
        self.breaking_label_used = False
8030
        self.error_label_used = False
8031

8032 8033 8034 8035 8036 8037
        self.parallel_private_temps = []

        all_labels = code.get_all_labels()

        # Figure this out before starting to generate any code
        for label in all_labels:
8038 8039
            if code.label_used(label):
                self.breaking_label_used = (self.breaking_label_used or
8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050
                                            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
8051

8052
            code.put_label(label)
8053

8054 8055 8056 8057
            if not (should_flush and is_continue_label):
                if label == code.error_label:
                    self.error_label_used = True
                    self.fetch_parallel_exception(code)
8058

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

8061 8062 8063 8064
            if (self.breaking_label_used and self.is_prange and not
                    is_continue_label):
                code.put_goto(save_lastprivates_label)
            else:
8065 8066
                code.put_goto(dont_return_label)

8067
        if self.any_label_used:
8068 8069 8070 8071 8072
            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)

8073 8074 8075
            code.put_label(dont_return_label)

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

8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096
    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
8097
        for entry, (op, lastprivate) in self.privates.items():
8098 8099 8100
            if not lastprivate or entry.type.is_pyobject:
                continue

8101
            type_decl = entry.type.empty_declaration_code()
8102 8103 8104 8105 8106
            temp_cname = "__pyx_parallel_temp%d" % temp_count
            private_cname = entry.cname

            temp_count += 1

8107 8108 8109 8110 8111
            invalid_value = entry.type.invalid_value()
            if invalid_value:
                init = ' = ' + invalid_value
            else:
                init = ''
8112
            # Declare the parallel private in the outer block
8113
            c.putln("%s %s%s;" % (type_decl, temp_cname, init))
8114 8115 8116 8117 8118 8119 8120 8121

            # 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

8122 8123 8124 8125 8126 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
    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)

8156
        code.putln("__Pyx_ErrFetchWithState(&%s, &%s, &%s);" % self.parallel_exc)
8157
        pos_info = chain(*zip(self.parallel_pos_info, self.pos_info))
8158
        code.funcstate.uses_error_indicator = True
8159
        code.putln("%s = %s; %s = %s; %s = %s;" % tuple(pos_info))
8160
        code.put_gotref(Naming.parallel_exc_type)
8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172

        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)

8173
        code.put_giveref(Naming.parallel_exc_type)
8174
        code.putln("__Pyx_ErrRestoreWithState(%s, %s, %s);" % self.parallel_exc)
8175 8176 8177 8178 8179
        pos_info = chain(*zip(self.pos_info, self.parallel_pos_info))
        code.putln("%s = %s; %s = %s; %s = %s;" % tuple(pos_info))

        code.put_release_ensured_gil()
        code.end_block()
8180 8181

    def restore_labels(self, code):
8182 8183 8184 8185 8186 8187
        """
        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))
8188

8189 8190 8191 8192 8193 8194 8195
    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:
8196

8197 8198 8199 8200 8201 8202 8203
            for i in prange(...):
                with cython.parallel.parallel():
                    continue

        Here break should be trapped in the parallel block, and propagated to
        the for loop.
        """
8204 8205 8206 8207
        c = self.begin_of_parallel_control_block_point

        # Firstly, always prefer errors over returning, continue or break
        if self.error_label_used:
Mark Florisson's avatar
Mark Florisson committed
8208 8209
            c.putln("const char *%s = NULL; int %s = 0, %s = 0;" %
                                                self.parallel_pos_info)
8210

8211
            c.putln("PyObject *%s = NULL, *%s = NULL, *%s = NULL;" %
Mark Florisson's avatar
Mark Florisson committed
8212
                                                        self.parallel_exc)
8213 8214 8215 8216 8217 8218 8219 8220 8221

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

8222 8223 8224 8225 8226 8227 8228
        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
8229 8230
            c.putln("int %s;" % Naming.parallel_why)
            c.putln("%s = 0;" % Naming.parallel_why)
8231

8232 8233 8234 8235 8236 8237
            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))

8238
            code.putln("switch (%s) {" % Naming.parallel_why)
8239 8240 8241 8242 8243 8244 8245 8246 8247 8248
            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)
8249 8250

            if self.error_label_used:
8251
                code.globalstate.use_utility_code(restore_exception_utility_code)
8252 8253 8254
                code.putln("    case 4:")
                self.restore_parallel_exception(code)
                code.put_goto(code.error_label)
8255

8256 8257 8258
            code.putln("}") # end switch
            code.putln(
                "}") # end if
8259 8260

        code.end_block() # end parallel control flow block
8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272
        self.redef_builtin_expect_apple_gcc_bug(code)

    # FIXME: improve with version number for OS X Lion
    buggy_platform_macro_condition = "(defined(__APPLE__) || defined(__OSX__))"
    have_expect_condition = "(defined(__GNUC__) && " \
                             "(__GNUC__ > 2 || (__GNUC__ == 2 && (__GNUC_MINOR__ > 95))))"
    redef_condition = "(%s && %s)" % (buggy_platform_macro_condition, have_expect_condition)

    def undef_builtin_expect_apple_gcc_bug(self, code):
        """
        A bug on OS X Lion disallows __builtin_expect macros. This code avoids them
        """
8273
        if not self.parent:
8274
            code.undef_builtin_expect(self.redef_condition)
8275 8276

    def redef_builtin_expect_apple_gcc_bug(self, code):
8277
        if not self.parent:
8278
            code.redef_builtin_expect(self.redef_condition)
8279

Mark Florisson's avatar
Mark Florisson committed
8280 8281 8282

class ParallelWithBlockNode(ParallelStatNode):
    """
8283
    This node represents a 'with cython.parallel.parallel():' block
Mark Florisson's avatar
Mark Florisson committed
8284 8285
    """

8286 8287 8288 8289 8290 8291 8292 8293 8294
    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")
8295

Mark Florisson's avatar
Mark Florisson committed
8296 8297
    def generate_execution_code(self, code):
        self.declare_closure_privates(code)
8298
        self.setup_parallel_control_flow_block(code)
Mark Florisson's avatar
Mark Florisson committed
8299 8300 8301

        code.putln("#ifdef _OPENMP")
        code.put("#pragma omp parallel ")
8302 8303

        if self.privates:
8304 8305
            privates = [e.cname for e in self.privates
                                    if not e.type.is_pyobject]
8306
            code.put('private(%s)' % ', '.join(privates))
8307

8308
        self.privatization_insertion_point = code.insertion_point()
8309
        self.put_num_threads(code)
8310
        code.putln("")
8311

8312 8313
        code.putln("#endif /* _OPENMP */")

8314
        code.begin_block() # parallel block
8315
        self.begin_parallel_block(code)
8316
        self.initialize_privates_to_nan(code)
8317
        code.funcstate.start_collecting_temps()
Mark Florisson's avatar
Mark Florisson committed
8318
        self.body.generate_execution_code(code)
8319
        self.trap_parallel_exit(code)
8320
        self.privatize_temps(code)
8321 8322
        self.end_parallel_block(code)
        code.end_block() # end parallel block
8323

8324 8325
        continue_ = code.label_used(code.continue_label)
        break_ = code.label_used(code.break_label)
Mark Florisson's avatar
Mark Florisson committed
8326

8327 8328 8329
        self.restore_labels(code)
        self.end_parallel_control_flow_block(code, break_=break_,
                                             continue_=continue_)
Mark Florisson's avatar
Mark Florisson committed
8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340
        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
    """

8341 8342
    child_attrs = ['body', 'target', 'else_clause', 'args', 'num_threads',
                   'chunksize']
Mark Florisson's avatar
Mark Florisson committed
8343 8344 8345 8346 8347 8348

    body = target = else_clause = args = None

    start = stop = step = None

    is_prange = True
8349

8350
    nogil = None
8351 8352
    schedule = None

8353
    valid_keyword_arguments = ['schedule', 'nogil', 'num_threads', 'chunksize']
Mark Florisson's avatar
Mark Florisson committed
8354

8355 8356 8357 8358 8359
    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
8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376
    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
8377 8378 8379
        if hasattr(self.schedule, 'decode'):
            self.schedule = self.schedule.decode('ascii')

Mark Florisson's avatar
Mark Florisson committed
8380 8381
        if self.schedule not in (None, 'static', 'dynamic', 'guided',
                                 'runtime'):
Mark Florisson's avatar
Mark Florisson committed
8382
            error(self.pos, "Invalid schedule argument to prange: %s" %
Mark Florisson's avatar
Mark Florisson committed
8383 8384 8385
                                                        (self.schedule,))

    def analyse_expressions(self, env):
Stefan Behnel's avatar
Stefan Behnel committed
8386
        was_nogil = env.nogil
8387 8388 8389
        if self.nogil:
            env.nogil = True

8390 8391
        if self.target is None:
            error(self.pos, "prange() can only be used as part of a for loop")
8392
            return self
Mark Florisson's avatar
Mark Florisson committed
8393

8394
        self.target = self.target.analyse_target_types(env)
Mark Florisson's avatar
Mark Florisson committed
8395

8396 8397 8398 8399 8400 8401 8402 8403
        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)

8404
            self.index_type = PyrexTypes.c_py_ssize_t_type
8405 8406
        else:
            self.index_type = self.target.type
8407 8408 8409 8410
            if not self.index_type.signed:
                warning(self.target.pos,
                        "Unsigned index type not allowed before OpenMP 3.0",
                        level=2)
Mark Florisson's avatar
Mark Florisson committed
8411 8412 8413 8414 8415 8416 8417 8418 8419

        # 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:
8420 8421
                    error(node.pos, "%s argument must be numeric" % name)
                    continue
Mark Florisson's avatar
Mark Florisson committed
8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432

                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:
8433
            self.else_clause = self.else_clause.analyse_expressions(env)
Mark Florisson's avatar
Mark Florisson committed
8434

8435 8436 8437 8438 8439 8440 8441 8442
        # 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

8443
        node = super(ParallelRangeNode, self).analyse_expressions(env)
8444

8445 8446 8447
        if node.chunksize:
            if not node.schedule:
                error(node.chunksize.pos,
8448
                      "Must provide schedule with chunksize")
8449 8450
            elif node.schedule == 'runtime':
                error(node.chunksize.pos,
8451
                      "Chunksize not valid for the schedule runtime")
8452 8453 8454 8455
            elif (node.chunksize.type.is_int and
                  node.chunksize.is_literal and
                  node.chunksize.compile_time_value(env) <= 0):
                error(node.chunksize.pos, "Chunksize must not be negative")
8456

8457 8458
            node.chunksize = node.chunksize.coerce_to(
                PyrexTypes.c_int_type, env).coerce_to_temp(env)
8459

8460
        if node.nogil:
8461 8462
            env.nogil = was_nogil

8463 8464 8465
        node.is_nested_prange = node.parent and node.parent.is_prange
        if node.is_nested_prange:
            parent = node
8466 8467 8468
            while parent.parent and parent.parent.is_prange:
                parent = parent.parent

8469 8470 8471 8472
            parent.assignments.update(node.assignments)
            parent.privates.update(node.privates)
            parent.assigned_nodes.extend(node.assigned_nodes)
        return node
8473

Mark Florisson's avatar
Mark Florisson committed
8474 8475
    def nogil_check(self, env):
        names = 'start', 'stop', 'step', 'target'
8476
        nodes = self.start, self.stop, self.step, self.target
Mark Florisson's avatar
Mark Florisson committed
8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521
        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
        """
8522
        self.declare_closure_privates(code)
Mark Florisson's avatar
Mark Florisson committed
8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553

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

8554
        self.setup_parallel_control_flow_block(code) # parallel control flow block
8555

8556
        self.control_flow_var_code_point = code.insertion_point()
8557

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

8561 8562 8563 8564 8565 8566 8567
        # 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)
8568
        code.begin_block() # if block
Mark Florisson's avatar
Mark Florisson committed
8569
        self.generate_loop(code, fmt_dict)
8570
        code.end_block() # end if block
Mark Florisson's avatar
Mark Florisson committed
8571

8572 8573 8574
        self.restore_labels(code)

        if self.else_clause:
8575
            if self.breaking_label_used:
8576
                code.put("if (%s < 2)" % Naming.parallel_why)
8577 8578 8579 8580 8581 8582 8583

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

        # ------ cleanup ------
8584
        self.end_parallel_control_flow_block(code) # end parallel control flow block
8585

Mark Florisson's avatar
Mark Florisson committed
8586 8587
        # And finally, release our privates and write back any closure
        # variables
8588
        for temp in start_stop_step + (self.chunksize, self.num_threads):
Mark Florisson's avatar
Mark Florisson committed
8589 8590 8591 8592 8593 8594 8595 8596 8597 8598
            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):
8599 8600 8601 8602
        if self.is_nested_prange:
            code.putln("#if 0")
        else:
            code.putln("#ifdef _OPENMP")
Mark Florisson's avatar
Mark Florisson committed
8603 8604 8605

        if not self.is_parallel:
            code.put("#pragma omp for")
8606
            self.privatization_insertion_point = code.insertion_point()
8607
            reduction_codepoint = self.parent.privatization_insertion_point
Mark Florisson's avatar
Mark Florisson committed
8608
        else:
8609 8610
            code.put("#pragma omp parallel")
            self.privatization_insertion_point = code.insertion_point()
8611
            reduction_codepoint = self.privatization_insertion_point
8612 8613 8614 8615 8616 8617 8618 8619
            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)

8620 8621 8622 8623
            if self.is_nested_prange:
                code.putln("#if 0")
            else:
                code.putln("#ifdef _OPENMP")
8624
            code.put("#pragma omp for")
Mark Florisson's avatar
Mark Florisson committed
8625

8626
        for entry, (op, lastprivate) in self.privates.items():
Mark Florisson's avatar
Mark Florisson committed
8627
            # Don't declare the index variable as a reduction
8628
            if op and op in "+*-&^|" and entry != self.target.entry:
8629 8630 8631
                if entry.type.is_pyobject:
                    error(self.pos, "Python objects cannot be reductions")
                else:
8632 8633 8634 8635
                    #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))
8636
            else:
8637 8638
                if entry == self.target.entry:
                    code.put(" firstprivate(%s)" % entry.cname)
8639 8640
                    code.put(" lastprivate(%s)" % entry.cname)
                    continue
Mark Florisson's avatar
Mark Florisson committed
8641

8642
                if not entry.type.is_pyobject:
8643 8644 8645 8646
                    if lastprivate:
                        private = 'lastprivate'
                    else:
                        private = 'private'
Mark Florisson's avatar
Mark Florisson committed
8647

8648
                    code.put(" %s(%s)" % (private, entry.cname))
8649

Mark Florisson's avatar
Mark Florisson committed
8650
        if self.schedule:
8651 8652 8653 8654 8655 8656 8657
            if self.chunksize:
                chunksize = ", %s" % self.evaluate_before_block(code,
                                                                self.chunksize)
            else:
                chunksize = ""

            code.put(" schedule(%s%s)" % (self.schedule, chunksize))
8658

8659
        self.put_num_threads(reduction_codepoint)
8660

8661 8662
        code.putln("")
        code.putln("#endif /* _OPENMP */")
Mark Florisson's avatar
Mark Florisson committed
8663 8664

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

8667
        guard_around_body_codepoint = code.insertion_point()
8668

8669 8670
        # Start if guard block around the body. This may be unnecessary, but
        # at least it doesn't spoil indentation
Mark Florisson's avatar
Mark Florisson committed
8671
        code.begin_block()
8672

8673
        code.putln("%(target)s = %(start)s + %(step)s * %(i)s;" % fmt_dict)
8674 8675
        self.initialize_privates_to_nan(code, exclude=self.target.entry)

8676 8677 8678
        if self.is_parallel:
            code.funcstate.start_collecting_temps()

Mark Florisson's avatar
Mark Florisson committed
8679
        self.body.generate_execution_code(code)
8680
        self.trap_parallel_exit(code, should_flush=True)
8681 8682
        self.privatize_temps(code)

8683 8684 8685
        if self.breaking_label_used:
            # Put a guard around the loop body in case return, break or
            # exceptions might be used
8686
            guard_around_body_codepoint.putln("if (%s < 2)" % Naming.parallel_why)
8687

8688
        code.end_block() # end guard around loop body
8689
        code.end_block() # end for loop block
Mark Florisson's avatar
Mark Florisson committed
8690

8691 8692 8693 8694 8695
        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

8696

8697 8698 8699 8700 8701 8702 8703 8704
class CnameDecoratorNode(StatNode):
    """
    This node is for the cname decorator in CythonUtilityCode:

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

8705 8706
    In case of a cdef class the cname specifies the objstruct_cname.

8707 8708 8709 8710 8711 8712 8713 8714
    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)
8715

8716 8717 8718 8719 8720 8721
        node = self.node
        if isinstance(node, CompilerDirectivesNode):
            node = node.body.stats[0]

        self.is_function = isinstance(node, FuncDefNode)
        is_struct_or_enum = isinstance(node, (CStructOrUnionDefNode,
8722
                                                   CEnumDefNode))
8723
        e = node.entry
8724 8725 8726 8727

        if self.is_function:
            e.cname = self.cname
            e.func_cname = self.cname
8728
            e.used = True
8729 8730
            if e.pyfunc_cname and '.' in e.pyfunc_cname:
                e.pyfunc_cname = self.mangle(e.pyfunc_cname)
8731 8732
        elif is_struct_or_enum:
            e.cname = e.type.cname = self.cname
8733
        else:
8734
            scope = node.scope
8735 8736

            e.cname = self.cname
8737
            e.type.objstruct_cname = self.cname + '_obj'
8738
            e.type.typeobj_cname = Naming.typeobj_prefix + self.cname
8739
            e.type.typeptr_cname = self.cname + '_type'
8740
            e.type.scope.namespace_cname = e.type.typeptr_cname
8741

8742
            e.as_variable.cname = e.type.typeptr_cname
8743 8744 8745

            scope.scope_prefix = self.cname + "_"

8746
            for name, entry in scope.entries.items():
8747
                if entry.func_cname:
8748 8749 8750 8751 8752 8753 8754 8755 8756
                    entry.func_cname = self.mangle(entry.cname)
                if entry.pyfunc_cname:
                    entry.pyfunc_cname = self.mangle(entry.pyfunc_cname)

    def mangle(self, cname):
        if '.' in cname:
            # remove __pyx_base from func_cname
            cname = cname.split('.')[-1]
        return '%s_%s' % (self.cname, cname)
8757 8758

    def analyse_expressions(self, env):
8759 8760
        self.node = self.node.analyse_expressions(env)
        return self
8761 8762

    def generate_function_definitions(self, env, code):
8763
        "Ensure a prototype for every @cname method in the right place"
8764 8765 8766 8767 8768 8769 8770 8771
        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:
8772
                from . import ModuleNode
8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788
                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)
Mark Florisson's avatar
Mark Florisson committed
8789

8790

William Stein's avatar
William Stein committed
8791 8792 8793 8794 8795 8796
#------------------------------------------------------------------------------------
#
#  Runtime support code
#
#------------------------------------------------------------------------------------

Robert Bradshaw's avatar
Robert Bradshaw committed
8797
if Options.gcc_branch_hints:
Stefan Behnel's avatar
Stefan Behnel committed
8798
    branch_prediction_macros = """
8799 8800 8801 8802 8803 8804
/* Test for GCC > 2.95 */
#if defined(__GNUC__) \
    && (__GNUC__ > 2 || (__GNUC__ == 2 && (__GNUC_MINOR__ > 95)))
  #define likely(x)   __builtin_expect(!!(x), 1)
  #define unlikely(x) __builtin_expect(!!(x), 0)
#else /* !__GNUC__ or GCC < 2.95 */
8805 8806
  #define likely(x)   (x)
  #define unlikely(x) (x)
8807
#endif /* __GNUC__ */
Stefan Behnel's avatar
Stefan Behnel committed
8808
"""
Robert Bradshaw's avatar
Robert Bradshaw committed
8809
else:
Stefan Behnel's avatar
Stefan Behnel committed
8810
    branch_prediction_macros = """
Robert Bradshaw's avatar
Robert Bradshaw committed
8811 8812
#define likely(x)   (x)
#define unlikely(x) (x)
Stefan Behnel's avatar
Stefan Behnel committed
8813
"""
William Stein's avatar
William Stein committed
8814 8815 8816

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

8817 8818
printing_utility_code = UtilityCode.load_cached("Print", "Printing.c")
printing_one_utility_code = UtilityCode.load_cached("PrintOne", "Printing.c")
8819

William Stein's avatar
William Stein committed
8820 8821
#------------------------------------------------------------------------------------

8822 8823 8824 8825 8826 8827 8828
# 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()

8829 8830 8831 8832 8833
restore_exception_utility_code = UtilityCode.load_cached("PyErrFetchRestore", "Exceptions.c")
raise_utility_code = UtilityCode.load_cached("RaiseException", "Exceptions.c")
get_exception_utility_code = UtilityCode.load_cached("GetException", "Exceptions.c")
swap_exception_utility_code = UtilityCode.load_cached("SwapException", "Exceptions.c")
reset_exception_utility_code = UtilityCode.load_cached("SaveResetException", "Exceptions.c")
8834
traceback_utility_code = UtilityCode.load_cached("AddTraceback", "Exceptions.c")
8835 8836 8837 8838

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

get_exception_tuple_utility_code = UtilityCode(proto="""
8839
static PyObject *__Pyx_GetExceptionTuple(PyThreadState *__pyx_tstate); /*proto*/
8840
""",
8841 8842 8843
# 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.
8844
# NOTE: "__pyx_tstate" may be used by __Pyx_GetException() macro
8845
impl = """
8846
static PyObject *__Pyx_GetExceptionTuple(CYTHON_UNUSED PyThreadState *__pyx_tstate) {
8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863
    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])