ExprNodes.py 365 KB
Newer Older
William Stein's avatar
William Stein committed
1
#
2
#   Parse tree nodes for expressions
William Stein's avatar
William Stein committed
3 4
#

5 6 7 8 9 10 11 12 13
import cython
cython.declare(error=object, warning=object, warn_once=object, InternalError=object,
               CompileError=object, UtilityCode=object, StringEncoding=object, operator=object,
               Naming=object, Nodes=object, PyrexTypes=object, py_object_type=object,
               list_type=object, tuple_type=object, set_type=object, dict_type=object, \
               unicode_type=object, str_type=object, bytes_type=object, type_type=object,
               Builtin=object, Symtab=object, Utils=object, find_coercion_error=object,
               debug_disposal_code=object, debug_temp_alloc=object, debug_coercion=object)

14
import operator
William Stein's avatar
William Stein committed
15

16
from Errors import error, warning, warn_once, InternalError, CompileError
17
from Errors import hold_errors, release_errors, held_errors, report_error
18
from Code import UtilityCode
19
import StringEncoding
William Stein's avatar
William Stein committed
20
import Naming
Robert Bradshaw's avatar
Robert Bradshaw committed
21
import Nodes
William Stein's avatar
William Stein committed
22 23
from Nodes import Node
import PyrexTypes
24
from PyrexTypes import py_object_type, c_long_type, typecast, error_type, \
25
     unspecified_type, cython_memoryview_ptr_type
26
import TypeSlots
27 28
from Builtin import list_type, tuple_type, set_type, dict_type, \
     unicode_type, str_type, bytes_type, type_type
29
import Builtin
William Stein's avatar
William Stein committed
30 31
import Symtab
import Options
32
from Cython import Utils
33
from Annotate import AnnotationItem
William Stein's avatar
William Stein committed
34

William Stein's avatar
William Stein committed
35
from Cython.Debugging import print_call_chain
William Stein's avatar
William Stein committed
36 37 38
from DebugFlags import debug_disposal_code, debug_temp_alloc, \
    debug_coercion

39 40 41 42 43
try:
    from __builtin__ import basestring
except ImportError:
    basestring = str # Python 3

Stefan Behnel's avatar
Stefan Behnel committed
44
class NotConstant(object):
45 46 47 48 49 50 51 52
    _obj = None

    def __new__(cls):
        if NotConstant._obj is None:
            NotConstant._obj = super(NotConstant, cls).__new__(cls)

        return NotConstant._obj

Stefan Behnel's avatar
Stefan Behnel committed
53 54 55
    def __repr__(self):
        return "<NOT CONSTANT>"

56
not_a_constant = NotConstant()
57
constant_value_not_set = object()
58

59 60 61 62 63 64 65 66 67 68
# error messages when coercing from key[0] to key[1]
find_coercion_error = {
    # string related errors
    (Builtin.unicode_type, Builtin.bytes_type) : "Cannot convert Unicode string to 'bytes' implicitly, encoding required.",
    (Builtin.unicode_type, Builtin.str_type)   : "Cannot convert Unicode string to 'str' implicitly. This is not portable and requires explicit encoding.",
    (Builtin.unicode_type, PyrexTypes.c_char_ptr_type) : "Unicode objects do not support coercion to C types.",
    (Builtin.bytes_type, Builtin.unicode_type) : "Cannot convert 'bytes' object to unicode implicitly, decoding required",
    (Builtin.bytes_type, Builtin.str_type) : "Cannot convert 'bytes' object to str implicitly. This is not portable to Py3.",
    (Builtin.str_type, Builtin.unicode_type) : "str objects do not support coercion to unicode, use a unicode string literal instead (u'')",
    (Builtin.str_type, Builtin.bytes_type) : "Cannot convert 'str' to 'bytes' implicitly. This is not portable.",
69
    (Builtin.str_type, PyrexTypes.c_char_ptr_type) : "'str' objects do not support coercion to C types (use 'bytes'?).",
70 71 72 73 74
    (PyrexTypes.c_char_ptr_type, Builtin.unicode_type) : "Cannot convert 'char*' to unicode implicitly, decoding required",
    (PyrexTypes.c_uchar_ptr_type, Builtin.unicode_type) : "Cannot convert 'char*' to unicode implicitly, decoding required",
    }.get


William Stein's avatar
William Stein committed
75 76 77 78 79 80
class ExprNode(Node):
    #  subexprs     [string]     Class var holding names of subexpr node attrs
    #  type         PyrexType    Type of the result
    #  result_code  string       Code fragment
    #  result_ctype string       C type of result_code if different from type
    #  is_temp      boolean      Result is in a temporary variable
81
    #  is_sequence_constructor
William Stein's avatar
William Stein committed
82
    #               boolean      Is a list or tuple constructor expression
83
    #  is_starred   boolean      Is a starred expression (e.g. '*a')
William Stein's avatar
William Stein committed
84 85 86
    #  saved_subexpr_nodes
    #               [ExprNode or [ExprNode or None] or None]
    #                            Cached result of subexpr_nodes()
87
    #  use_managed_ref boolean   use ref-counted temps/assignments/etc.
88 89 90
    #  result_is_used  boolean   indicates that the result will be dropped and the
    #                            result_code/temp_result can safely be set to None

William Stein's avatar
William Stein committed
91
    result_ctype = None
92
    type = None
93 94
    temp_code = None
    old_temp = None # error checker for multiple frees etc.
95
    use_managed_ref = True # can be set by optimisation transforms
96
    result_is_used = True
William Stein's avatar
William Stein committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

    #  The Analyse Expressions phase for expressions is split
    #  into two sub-phases:
    #
    #    Analyse Types
    #      Determines the result type of the expression based
    #      on the types of its sub-expressions, and inserts
    #      coercion nodes into the expression tree where needed.
    #      Marks nodes which will need to have temporary variables
    #      allocated.
    #
    #    Allocate Temps
    #      Allocates temporary variables where needed, and fills
    #      in the result_code field of each node.
    #
    #  ExprNode provides some convenience routines which
    #  perform both of the above phases. These should only
    #  be called from statement nodes, and only when no
    #  coercion nodes need to be added around the expression
    #  being analysed. In that case, the above two phases
    #  should be invoked separately.
    #
    #  Framework code in ExprNode provides much of the common
    #  processing for the various phases. It makes use of the
    #  'subexprs' class attribute of ExprNodes, which should
    #  contain a list of the names of attributes which can
    #  hold sub-nodes or sequences of sub-nodes.
124 125
    #
    #  The framework makes use of a number of abstract methods.
William Stein's avatar
William Stein committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
    #  Their responsibilities are as follows.
    #
    #    Declaration Analysis phase
    #
    #      analyse_target_declaration
    #        Called during the Analyse Declarations phase to analyse
    #        the LHS of an assignment or argument of a del statement.
    #        Nodes which cannot be the LHS of an assignment need not
    #        implement it.
    #
    #    Expression Analysis phase
    #
    #      analyse_types
    #        - Call analyse_types on all sub-expressions.
    #        - Check operand types, and wrap coercion nodes around
    #          sub-expressions where needed.
    #        - Set the type of this node.
    #        - If a temporary variable will be required for the
    #          result, set the is_temp flag of this node.
    #
    #      analyse_target_types
    #        Called during the Analyse Types phase to analyse
148
    #        the LHS of an assignment or argument of a del
William Stein's avatar
William Stein committed
149 150
    #        statement. Similar responsibilities to analyse_types.
    #
151 152 153 154
    #      target_code
    #        Called by the default implementation of allocate_target_temps.
    #        Should return a C lvalue for assigning to the node. The default
    #        implementation calls calculate_result_code.
William Stein's avatar
William Stein committed
155 156 157 158
    #
    #      check_const
    #        - Check that this node and its subnodes form a
    #          legal constant expression. If so, do nothing,
159
    #          otherwise call not_const.
William Stein's avatar
William Stein committed
160
    #
161
    #        The default implementation of check_const
William Stein's avatar
William Stein committed
162 163 164 165 166 167 168 169
    #        assumes that the expression is not constant.
    #
    #      check_const_addr
    #        - Same as check_const, except check that the
    #          expression is a C lvalue whose address is
    #          constant. Otherwise, call addr_not_const.
    #
    #        The default implementation of calc_const_addr
170
    #        assumes that the expression is not a constant
William Stein's avatar
William Stein committed
171 172 173 174 175 176 177 178 179 180 181 182
    #        lvalue.
    #
    #   Code Generation phase
    #
    #      generate_evaluation_code
    #        - Call generate_evaluation_code for sub-expressions.
    #        - Perform the functions of generate_result_code
    #          (see below).
    #        - If result is temporary, call generate_disposal_code
    #          on all sub-expressions.
    #
    #        A default implementation of generate_evaluation_code
183
    #        is provided which uses the following abstract methods:
William Stein's avatar
William Stein committed
184 185 186 187 188 189
    #
    #          generate_result_code
    #            - Generate any C statements necessary to calculate
    #              the result of this node from the results of its
    #              sub-expressions.
    #
190
    #          calculate_result_code
191 192
    #            - Should return a C code fragment evaluating to the
    #              result. This is only called when the result is not
193 194
    #              a temporary.
    #
William Stein's avatar
William Stein committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    #      generate_assignment_code
    #        Called on the LHS of an assignment.
    #        - Call generate_evaluation_code for sub-expressions.
    #        - Generate code to perform the assignment.
    #        - If the assignment absorbed a reference, call
    #          generate_post_assignment_code on the RHS,
    #          otherwise call generate_disposal_code on it.
    #
    #      generate_deletion_code
    #        Called on an argument of a del statement.
    #        - Call generate_evaluation_code for sub-expressions.
    #        - Generate code to perform the deletion.
    #        - Call generate_disposal_code on all sub-expressions.
    #
    #
210

William Stein's avatar
William Stein committed
211
    is_sequence_constructor = 0
212
    is_string_literal = 0
William Stein's avatar
William Stein committed
213
    is_attribute = 0
214

William Stein's avatar
William Stein committed
215 216
    saved_subexpr_nodes = None
    is_temp = 0
217
    is_target = 0
218
    is_starred = 0
William Stein's avatar
William Stein committed
219

220 221
    constant_result = constant_value_not_set

222 223 224 225
    try:
        _get_child_attrs = operator.attrgetter('subexprs')
    except AttributeError:
        # Python 2.3
226
        def __get_child_attrs(self):
227
            return self.subexprs
228
        _get_child_attrs = __get_child_attrs
229
    child_attrs = property(fget=_get_child_attrs)
230

William Stein's avatar
William Stein committed
231 232 233 234
    def not_implemented(self, method_name):
        print_call_chain(method_name, "not implemented") ###
        raise InternalError(
            "%s.%s not implemented" %
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
235
                (self.__class__.__name__, method_name))
236

William Stein's avatar
William Stein committed
237 238
    def is_lvalue(self):
        return 0
239

William Stein's avatar
William Stein committed
240 241 242 243 244 245 246 247 248 249 250
    def is_ephemeral(self):
        #  An ephemeral node is one whose result is in
        #  a Python temporary and we suspect there are no
        #  other references to it. Certain operations are
        #  disallowed on such values, since they are
        #  likely to result in a dangling pointer.
        return self.type.is_pyobject and self.is_temp

    def subexpr_nodes(self):
        #  Extract a list of subexpression nodes based
        #  on the contents of the subexprs class attribute.
251 252 253
        nodes = []
        for name in self.subexprs:
            item = getattr(self, name)
Stefan Behnel's avatar
Stefan Behnel committed
254 255
            if item is not None:
                if type(item) is list:
256
                    nodes.extend(item)
Stefan Behnel's avatar
Stefan Behnel committed
257 258
                else:
                    nodes.append(item)
259
        return nodes
260

261
    def result(self):
262 263 264
        if self.is_temp:
            return self.temp_code
        else:
265
            return self.calculate_result_code()
266

William Stein's avatar
William Stein committed
267 268
    def result_as(self, type = None):
        #  Return the result code cast to the specified C type.
269
        return typecast(type, self.ctype(), self.result())
270

William Stein's avatar
William Stein committed
271 272 273
    def py_result(self):
        #  Return the result code cast to PyObject *.
        return self.result_as(py_object_type)
274

William Stein's avatar
William Stein committed
275 276 277 278
    def ctype(self):
        #  Return the native C type of the result (i.e. the
        #  C type of the result_code expression).
        return self.result_ctype or self.type
279

280
    def get_constant_c_result_code(self):
281
        # Return the constant value of this node as a result code
282 283 284 285 286 287 288
        # string, or None if the node is not constant.  This method
        # can be called when the constant result code is required
        # before the code generation phase.
        #
        # The return value is a string that can represent a simple C
        # value, a constant C name or a constant C expression.  If the
        # node type depends on Python code, this must return None.
289 290
        return None

291
    def calculate_constant_result(self):
292 293 294 295 296
        # Calculate the constant compile time result value of this
        # expression and store it in ``self.constant_result``.  Does
        # nothing by default, thus leaving ``self.constant_result``
        # unknown.  If valid, the result can be an arbitrary Python
        # value.
297 298 299 300 301 302
        #
        # This must only be called when it is assured that all
        # sub-expressions have a valid constant_result value.  The
        # ConstantFolding transform will do this.
        pass

303 304 305 306
    def has_constant_result(self):
        return self.constant_result is not constant_value_not_set and \
               self.constant_result is not not_a_constant

307 308 309
    def compile_time_value(self, denv):
        #  Return value of compile-time expression, or report error.
        error(self.pos, "Invalid compile-time expression")
310

311 312 313
    def compile_time_value_error(self, e):
        error(self.pos, "Error in compile-time expression: %s: %s" % (
            e.__class__.__name__, e))
314

William Stein's avatar
William Stein committed
315
    # ------------- Declaration Analysis ----------------
316

William Stein's avatar
William Stein committed
317 318
    def analyse_target_declaration(self, env):
        error(self.pos, "Cannot assign to or delete this")
319

William Stein's avatar
William Stein committed
320
    # ------------- Expression Analysis ----------------
321

William Stein's avatar
William Stein committed
322 323 324 325 326 327
    def analyse_const_expression(self, env):
        #  Called during the analyse_declarations phase of a
        #  constant expression. Analyses the expression's type,
        #  checks whether it is a legal const expression,
        #  and determines its value.
        self.analyse_types(env)
328
        return self.check_const()
329

William Stein's avatar
William Stein committed
330 331
    def analyse_expressions(self, env):
        #  Convenience routine performing both the Type
332
        #  Analysis and Temp Allocation phases for a whole
William Stein's avatar
William Stein committed
333 334
        #  expression.
        self.analyse_types(env)
335

336
    def analyse_target_expression(self, env, rhs):
William Stein's avatar
William Stein committed
337 338 339 340
        #  Convenience routine performing both the Type
        #  Analysis and Temp Allocation phases for the LHS of
        #  an assignment.
        self.analyse_target_types(env)
341

William Stein's avatar
William Stein committed
342 343 344 345 346
    def analyse_boolean_expression(self, env):
        #  Analyse expression and coerce to a boolean.
        self.analyse_types(env)
        bool = self.coerce_to_boolean(env)
        return bool
347

William Stein's avatar
William Stein committed
348 349 350 351 352 353 354 355 356
    def analyse_temp_boolean_expression(self, env):
        #  Analyse boolean expression and coerce result into
        #  a temporary. This is used when a branch is to be
        #  performed on the result and we won't have an
        #  opportunity to ensure disposal code is executed
        #  afterwards. By forcing the result into a temporary,
        #  we ensure that all disposal has been done by the
        #  time we get the result.
        self.analyse_types(env)
Stefan Behnel's avatar
Stefan Behnel committed
357 358
        return self.coerce_to_boolean(env).coerce_to_simple(env)

359
    # --------------- Type Inference -----------------
360

Robert Bradshaw's avatar
Robert Bradshaw committed
361
    def type_dependencies(self, env):
362 363 364 365
        # Returns the list of entries whose types must be determined
        # before the type of self can be infered.
        if hasattr(self, 'type') and self.type is not None:
            return ()
Robert Bradshaw's avatar
Robert Bradshaw committed
366
        return sum([node.type_dependencies(env) for node in self.subexpr_nodes()], ())
367

368
    def infer_type(self, env):
369 370
        # Attempt to deduce the type of self.
        # Differs from analyse_types as it avoids unnecessary
371 372 373 374 375 376 377 378
        # analysis of subexpressions, but can assume everything
        # in self.type_dependencies() has been resolved.
        if hasattr(self, 'type') and self.type is not None:
            return self.type
        elif hasattr(self, 'entry') and self.entry is not None:
            return self.entry.type
        else:
            self.not_implemented("infer_type")
379

380 381 382
    def nonlocally_immutable(self):
        # Returns whether this variable is a safe reference, i.e.
        # can't be modified as part of globals or closures.
383
        return self.is_temp or self.type.is_array or self.type.is_cfunction
384

William Stein's avatar
William Stein committed
385
    # --------------- Type Analysis ------------------
386

William Stein's avatar
William Stein committed
387 388 389 390
    def analyse_as_module(self, env):
        # If this node can be interpreted as a reference to a
        # cimported module, return its scope, else None.
        return None
391

392 393 394 395
    def analyse_as_type(self, env):
        # If this node can be interpreted as a reference to a
        # type, return that type, else None.
        return None
396

William Stein's avatar
William Stein committed
397 398 399 400
    def analyse_as_extension_type(self, env):
        # If this node can be interpreted as a reference to an
        # extension type, return its type, else None.
        return None
401

William Stein's avatar
William Stein committed
402 403
    def analyse_types(self, env):
        self.not_implemented("analyse_types")
404

William Stein's avatar
William Stein committed
405 406
    def analyse_target_types(self, env):
        self.analyse_types(env)
407

408
    def nogil_check(self, env):
409 410 411
        # By default, any expression based on Python objects is
        # prevented in nogil environments.  Subtypes must override
        # this if they can work without the GIL.
412
        if self.type and self.type.is_pyobject:
413
            self.gil_error()
414

415 416 417 418
    def gil_assignment_check(self, env):
        if env.nogil and self.type.is_pyobject:
            error(self.pos, "Assignment of Python object not allowed without gil")

William Stein's avatar
William Stein committed
419 420
    def check_const(self):
        self.not_const()
421
        return False
422

William Stein's avatar
William Stein committed
423 424
    def not_const(self):
        error(self.pos, "Not allowed in a constant expression")
425

William Stein's avatar
William Stein committed
426 427
    def check_const_addr(self):
        self.addr_not_const()
428
        return False
429

William Stein's avatar
William Stein committed
430 431
    def addr_not_const(self):
        error(self.pos, "Address is not constant")
432

William Stein's avatar
William Stein committed
433
    # ----------------- Result Allocation -----------------
434

William Stein's avatar
William Stein committed
435 436 437 438 439 440
    def result_in_temp(self):
        #  Return true if result is in a temporary owned by
        #  this node or one of its subexpressions. Overridden
        #  by certain nodes which can share the result of
        #  a subnode.
        return self.is_temp
441

William Stein's avatar
William Stein committed
442 443 444
    def target_code(self):
        #  Return code fragment for use as LHS of a C assignment.
        return self.calculate_result_code()
445

William Stein's avatar
William Stein committed
446 447
    def calculate_result_code(self):
        self.not_implemented("calculate_result_code")
448

Robert Bradshaw's avatar
Robert Bradshaw committed
449 450 451
#    def release_target_temp(self, env):
#        #  Release temporaries used by LHS of an assignment.
#        self.release_subexpr_temps(env)
William Stein's avatar
William Stein committed
452

453 454
    def allocate_temp_result(self, code):
        if self.temp_code:
455
            raise RuntimeError("Temp allocated multiple times in %r: %r" % (self.__class__.__name__, self.pos))
456 457 458 459 460
        type = self.type
        if not type.is_void:
            if type.is_pyobject:
                type = PyrexTypes.py_object_type
            self.temp_code = code.funcstate.allocate_temp(
461
                type, manage_ref=self.use_managed_ref)
462 463 464 465 466
        else:
            self.temp_code = None

    def release_temp_result(self, code):
        if not self.temp_code:
467 468 469
            if not self.result_is_used:
                # not used anyway, so ignore if not set up
                return
470 471 472 473 474 475 476 477 478 479
            if self.old_temp:
                raise RuntimeError("temp %s released multiple times in %s" % (
                        self.old_temp, self.__class__.__name__))
            else:
                raise RuntimeError("no temp, but release requested in %s" % (
                        self.__class__.__name__))
        code.funcstate.release_temp(self.temp_code)
        self.old_temp = self.temp_code
        self.temp_code = None

William Stein's avatar
William Stein committed
480
    # ---------------- Code Generation -----------------
481

William Stein's avatar
William Stein committed
482 483 484 485
    def make_owned_reference(self, code):
        #  If result is a pyobject, make sure we own
        #  a reference to it.
        if self.type.is_pyobject and not self.result_in_temp():
486
            code.put_incref(self.result(), self.ctype())
487

William Stein's avatar
William Stein committed
488
    def generate_evaluation_code(self, code):
489
        code.mark_pos(self.pos)
490

William Stein's avatar
William Stein committed
491 492 493 494
        #  Generate code to evaluate this node and
        #  its sub-expressions, and dispose of any
        #  temporary results of its sub-expressions.
        self.generate_subexpr_evaluation_code(code)
495 496 497 498

        if self.is_temp:
            self.allocate_temp_result(code)

William Stein's avatar
William Stein committed
499 500
        self.generate_result_code(code)
        if self.is_temp:
501 502
            # If we are temp we do not need to wait until this node is disposed
            # before disposing children.
William Stein's avatar
William Stein committed
503
            self.generate_subexpr_disposal_code(code)
504
            self.free_subexpr_temps(code)
505

William Stein's avatar
William Stein committed
506 507 508
    def generate_subexpr_evaluation_code(self, code):
        for node in self.subexpr_nodes():
            node.generate_evaluation_code(code)
509

William Stein's avatar
William Stein committed
510 511
    def generate_result_code(self, code):
        self.not_implemented("generate_result_code")
512

513 514
    def generate_disposal_code(self, code):
        if self.is_temp:
515 516 517 518 519 520
            if self.result():
                if self.type.is_pyobject:
                    code.put_decref_clear(self.result(), self.ctype())
                elif self.type.is_memoryviewslice:
                    code.put_xdecref_memoryviewslice(
                            self.result(), have_gil=not self.in_nogil_context)
William Stein's avatar
William Stein committed
521
        else:
522
            # Already done if self.is_temp
523
            self.generate_subexpr_disposal_code(code)
524

William Stein's avatar
William Stein committed
525 526 527 528 529
    def generate_subexpr_disposal_code(self, code):
        #  Generate code to dispose of temporary results
        #  of all sub-expressions.
        for node in self.subexpr_nodes():
            node.generate_disposal_code(code)
530

William Stein's avatar
William Stein committed
531 532 533
    def generate_post_assignment_code(self, code):
        if self.is_temp:
            if self.type.is_pyobject:
534
                code.putln("%s = 0;" % self.result())
535 536 537
            elif self.type.is_memoryviewslice:
                code.putln("%s.memview = NULL;" % self.result())
                code.putln("%s.data = NULL;" % self.result())
William Stein's avatar
William Stein committed
538 539
        else:
            self.generate_subexpr_disposal_code(code)
540

William Stein's avatar
William Stein committed
541 542
    def generate_assignment_code(self, rhs, code):
        #  Stub method for nodes which are not legal as
543
        #  the LHS of an assignment. An error will have
William Stein's avatar
William Stein committed
544 545
        #  been reported earlier.
        pass
546

William Stein's avatar
William Stein committed
547 548 549 550 551
    def generate_deletion_code(self, code):
        #  Stub method for nodes that are not legal as
        #  the argument of a del statement. An error
        #  will have been reported earlier.
        pass
552 553

    def free_temps(self, code):
554 555 556 557
        if self.is_temp:
            if not self.type.is_void:
                self.release_temp_result(code)
        else:
558
            self.free_subexpr_temps(code)
559

560 561 562 563
    def free_subexpr_temps(self, code):
        for sub in self.subexpr_nodes():
            sub.free_temps(code)

564 565 566
    def generate_function_definitions(self, env, code):
        pass

567
    # ---------------- Annotation ---------------------
568

569 570 571
    def annotate(self, code):
        for node in self.subexpr_nodes():
            node.annotate(code)
572

William Stein's avatar
William Stein committed
573
    # ----------------- Coercion ----------------------
574

William Stein's avatar
William Stein committed
575 576 577 578 579 580 581 582
    def coerce_to(self, dst_type, env):
        #   Coerce the result so that it can be assigned to
        #   something of type dst_type. If processing is necessary,
        #   wraps this node in a coercion node and returns that.
        #   Otherwise, returns this node unchanged.
        #
        #   This method is called during the analyse_expressions
        #   phase of the src_node's processing.
583 584 585 586 587 588 589 590
        #
        #   Note that subclasses that override this (especially
        #   ConstNodes) must not (re-)set their own .type attribute
        #   here.  Since expression nodes may turn up in different
        #   places in the tree (e.g. inside of CloneNodes in cascaded
        #   assignments), this method must return a new node instance
        #   if it changes the type.
        #
William Stein's avatar
William Stein committed
591 592 593 594
        src = self
        src_type = self.type
        src_is_py_type = src_type.is_pyobject
        dst_is_py_type = dst_type.is_pyobject
595

596 597 598
        if self.check_for_coercion_error(dst_type):
            return self

599 600
        if dst_type.is_reference:
            dst_type = dst_type.ref_base_type
601

602
        if src_type.is_fused or dst_type.is_fused:
603 604 605 606 607 608 609 610 611
            # See if we are coercing a fused function to a pointer to a
            # specialized function
            if (src_type.is_cfunction and not dst_type.is_fused and
                    dst_type.is_ptr and dst_type.base_type.is_cfunction):

                dst_type = dst_type.base_type

                for signature in src_type.get_all_specific_function_types():
                    if signature.same_as(dst_type):
Mark Florisson's avatar
Mark Florisson committed
612 613 614 615
                        src.type = signature
                        src.entry = src.type.entry
                        src.entry.used = True
                        return self
616

617 618 619 620
            error(self.pos, "Type is not specific")
            self.type = error_type
            return self

621 622 623 624 625
        if self.coercion_type is not None:
            # This is purely for error checking purposes!
            node = NameNode(self.pos, name='', type=self.coercion_type)
            node.coerce_to(dst_type, env)

626
        if dst_type.is_memoryviewslice:
627
            import MemoryView
628
            if not src.type.is_memoryviewslice:
629 630 631 632 633 634
                if src.type.is_pyobject:
                    src = CoerceToMemViewSliceNode(src, dst_type, env)
                else:
                    error(self.pos,
                          "Cannot convert '%s' to memoryviewslice" %
                                                                (src_type,))
635
            elif not MemoryView.src_conforms_to_dst(src.type, dst_type):
636 637 638 639 640 641 642 643
                if src.type.dtype.same_as(dst_type.dtype):
                    msg = "Memoryview '%s' not conformable to memoryview '%s'."
                    tup = src.type, dst_type
                else:
                    msg = "Different base types for memoryviews (%s, %s)"
                    tup = src.type.dtype, dst_type.dtype

                error(self.pos, msg % tup)
644

645
        elif dst_type.is_pyobject:
William Stein's avatar
William Stein committed
646
            if not src.type.is_pyobject:
647 648 649 650
                if dst_type is bytes_type and src.type.is_int:
                    src = CoerceIntToBytesNode(src, env)
                else:
                    src = CoerceToPyTypeNode(src, env)
William Stein's avatar
William Stein committed
651
            if not src.type.subtype_of(dst_type):
652 653
                if not isinstance(src, NoneNode):
                    src = PyTypeTestNode(src, dst_type, env)
William Stein's avatar
William Stein committed
654 655
        elif src.type.is_pyobject:
            src = CoerceFromPyTypeNode(dst_type, src, env)
656
        elif (dst_type.is_complex
657 658
              and src_type != dst_type
              and dst_type.assignable_from(src_type)):
659
            src = CoerceToComplexNode(src, dst_type, env)
William Stein's avatar
William Stein committed
660
        else: # neither src nor dst are py types
661
            # Added the string comparison, since for c types that
662
            # is enough, but Cython gets confused when the types are
663
            # in different pxi files.
664
            if not (str(src.type) == str(dst_type) or dst_type.assignable_from(src_type)):
665
                self.fail_assignment(dst_type)
William Stein's avatar
William Stein committed
666 667
        return src

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    def fail_assignment(self, dst_type):
        error(self.pos, "Cannot assign type '%s' to '%s'" % (self.type, dst_type))

    def check_for_coercion_error(self, dst_type, fail=False, default=None):
        if fail and not default:
            default = "Cannot assign type '%(FROM)s' to '%(TO)s'"
        message = find_coercion_error((self.type, dst_type), default)
        if message is not None:
            error(self.pos, message % {'FROM': self.type, 'TO': dst_type})
            return True
        if fail:
            self.fail_assignment(dst_type)
            return True
        return False

William Stein's avatar
William Stein committed
683 684 685 686 687 688
    def coerce_to_pyobject(self, env):
        return self.coerce_to(PyrexTypes.py_object_type, env)

    def coerce_to_boolean(self, env):
        #  Coerce result to something acceptable as
        #  a boolean value.
689 690 691 692 693 694 695

        # if it's constant, calculate the result now
        if self.has_constant_result():
            bool_value = bool(self.constant_result)
            return BoolNode(self.pos, value=bool_value,
                            constant_result=bool_value)

William Stein's avatar
William Stein committed
696 697 698 699
        type = self.type
        if type.is_pyobject or type.is_ptr or type.is_float:
            return CoerceToBooleanNode(self, env)
        else:
700
            if not (type.is_int or type.is_enum or type.is_error):
701
                error(self.pos,
William Stein's avatar
William Stein committed
702 703
                    "Type '%s' not acceptable as a boolean" % type)
            return self
704

William Stein's avatar
William Stein committed
705 706 707 708 709 710
    def coerce_to_integer(self, env):
        # If not already some C integer type, coerce to longint.
        if self.type.is_int:
            return self
        else:
            return self.coerce_to(PyrexTypes.c_long_type, env)
711

William Stein's avatar
William Stein committed
712 713 714 715 716 717
    def coerce_to_temp(self, env):
        #  Ensure that the result is in a temporary.
        if self.result_in_temp():
            return self
        else:
            return CoerceToTempNode(self, env)
718

William Stein's avatar
William Stein committed
719 720 721 722 723 724
    def coerce_to_simple(self, env):
        #  Ensure that the result is simple (see is_simple).
        if self.is_simple():
            return self
        else:
            return self.coerce_to_temp(env)
725

William Stein's avatar
William Stein committed
726 727 728 729 730 731
    def is_simple(self):
        #  A node is simple if its result is something that can
        #  be referred to without performing any operations, e.g.
        #  a constant, local var, C global var, struct member
        #  reference, or temporary.
        return self.result_in_temp()
732 733

    def may_be_none(self):
734
        if self.type and not self.type.is_pyobject:
735 736 737 738
            return False
        if self.constant_result not in (not_a_constant, constant_value_not_set):
            return self.constant_result is not None
        return True
739

740
    def as_cython_attribute(self):
741
        return None
William Stein's avatar
William Stein committed
742

743
    def as_none_safe_node(self, message, error="PyExc_TypeError", format_args=()):
744 745 746
        # Wraps the node in a NoneCheckNode if it is not known to be
        # not-None (e.g. because it is a Python literal).
        if self.may_be_none():
747
            return NoneCheckNode(self, error, message, format_args)
748 749 750 751
        else:
            return self


William Stein's avatar
William Stein committed
752
class AtomicExprNode(ExprNode):
753 754
    #  Abstract base class for expression nodes which have
    #  no sub-expressions.
755

756 757 758
    subexprs = []

    # Override to optimize -- we know we have no children
759 760 761 762
    def generate_subexpr_evaluation_code(self, code):
        pass
    def generate_subexpr_disposal_code(self, code):
        pass
763

764
class PyConstNode(AtomicExprNode):
William Stein's avatar
William Stein committed
765
    #  Abstract base class for constant Python values.
766

767
    is_literal = 1
768
    type = py_object_type
769

William Stein's avatar
William Stein committed
770 771
    def is_simple(self):
        return 1
772 773 774 775

    def may_be_none(self):
        return False

William Stein's avatar
William Stein committed
776
    def analyse_types(self, env):
777
        pass
778

William Stein's avatar
William Stein committed
779 780 781 782 783 784 785 786 787
    def calculate_result_code(self):
        return self.value

    def generate_result_code(self, code):
        pass


class NoneNode(PyConstNode):
    #  The constant value None
788

789
    is_none = 1
William Stein's avatar
William Stein committed
790
    value = "Py_None"
791 792

    constant_result = None
793

794
    nogil_check = None
795

796 797
    def compile_time_value(self, denv):
        return None
798 799 800 801 802

    def may_be_none(self):
        return True


William Stein's avatar
William Stein committed
803 804
class EllipsisNode(PyConstNode):
    #  '...' in a subscript list.
805

William Stein's avatar
William Stein committed
806 807
    value = "Py_Ellipsis"

808 809
    constant_result = Ellipsis

810 811 812
    def compile_time_value(self, denv):
        return Ellipsis

William Stein's avatar
William Stein committed
813

814
class ConstNode(AtomicExprNode):
William Stein's avatar
William Stein committed
815 816 817
    # Abstract base type for literal constant nodes.
    #
    # value     string      C code fragment
818

William Stein's avatar
William Stein committed
819
    is_literal = 1
820
    nogil_check = None
821

William Stein's avatar
William Stein committed
822 823
    def is_simple(self):
        return 1
824

825 826 827
    def nonlocally_immutable(self):
        return 1

828 829 830
    def may_be_none(self):
        return False

William Stein's avatar
William Stein committed
831 832
    def analyse_types(self, env):
        pass # Types are held in class variables
833

William Stein's avatar
William Stein committed
834
    def check_const(self):
835
        return True
836

837
    def get_constant_c_result_code(self):
838 839
        return self.calculate_result_code()

William Stein's avatar
William Stein committed
840 841 842 843 844 845 846
    def calculate_result_code(self):
        return str(self.value)

    def generate_result_code(self, code):
        pass


847 848 849
class BoolNode(ConstNode):
    type = PyrexTypes.c_bint_type
    #  The constant value True or False
850 851 852 853

    def calculate_constant_result(self):
        self.constant_result = self.value

854 855
    def compile_time_value(self, denv):
        return self.value
856

857
    def calculate_result_code(self):
858
        return str(int(self.value))
859

860

William Stein's avatar
William Stein committed
861 862
class NullNode(ConstNode):
    type = PyrexTypes.c_null_ptr_type
863
    value = "NULL"
864
    constant_result = 0
William Stein's avatar
William Stein committed
865

866
    def get_constant_c_result_code(self):
867 868
        return self.value

William Stein's avatar
William Stein committed
869 870 871

class CharNode(ConstNode):
    type = PyrexTypes.c_char_type
872 873 874

    def calculate_constant_result(self):
        self.constant_result = ord(self.value)
875

876
    def compile_time_value(self, denv):
877
        return ord(self.value)
878

William Stein's avatar
William Stein committed
879
    def calculate_result_code(self):
880
        return "'%s'" % StringEncoding.escape_char(self.value)
William Stein's avatar
William Stein committed
881 882 883


class IntNode(ConstNode):
884 885 886

    # unsigned     "" or "U"
    # longness     "" or "L" or "LL"
887
    # is_c_literal   True/False/None   creator considers this a C integer literal
888 889 890

    unsigned = ""
    longness = ""
891
    is_c_literal = None # unknown
892 893 894

    def __init__(self, pos, **kwds):
        ExprNode.__init__(self, pos, **kwds)
Robert Bradshaw's avatar
Robert Bradshaw committed
895
        if 'type' not in kwds:
896 897 898 899 900 901 902 903
            self.type = self.find_suitable_type_for_value()

    def find_suitable_type_for_value(self):
        if self.constant_result is constant_value_not_set:
            try:
                self.calculate_constant_result()
            except ValueError:
                pass
904 905 906 907
        # we ignore 'is_c_literal = True' and instead map signed 32bit
        # integers as C long values
        if self.is_c_literal or \
               self.constant_result in (constant_value_not_set, not_a_constant) or \
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
               self.unsigned or self.longness == 'LL':
            # clearly a C literal
            rank = (self.longness == 'LL') and 2 or 1
            suitable_type = PyrexTypes.modifiers_and_name_to_type[not self.unsigned, rank, "int"]
            if self.type:
                suitable_type = PyrexTypes.widest_numeric_type(suitable_type, self.type)
        else:
            # C literal or Python literal - split at 32bit boundary
            if self.constant_result >= -2**31 and self.constant_result < 2**31:
                if self.type and self.type.is_int:
                    suitable_type = self.type
                else:
                    suitable_type = PyrexTypes.c_long_type
            else:
                suitable_type = PyrexTypes.py_object_type
        return suitable_type
William Stein's avatar
William Stein committed
924

925
    def coerce_to(self, dst_type, env):
926
        if self.type is dst_type:
927
            return self
928
        elif dst_type.is_float:
929
            if self.constant_result is not not_a_constant:
930 931
                return FloatNode(self.pos, value='%d.0' % int(self.constant_result), type=dst_type,
                                 constant_result=float(self.constant_result))
932 933 934
            else:
                return FloatNode(self.pos, value=self.value, type=dst_type,
                                 constant_result=not_a_constant)
935
        if dst_type.is_numeric and not dst_type.is_complex:
936
            node = IntNode(self.pos, value=self.value, constant_result=self.constant_result,
937 938
                           type = dst_type, is_c_literal = True,
                           unsigned=self.unsigned, longness=self.longness)
939
            return node
940 941
        elif dst_type.is_pyobject:
            node = IntNode(self.pos, value=self.value, constant_result=self.constant_result,
942 943
                           type = PyrexTypes.py_object_type, is_c_literal = False,
                           unsigned=self.unsigned, longness=self.longness)
944
        else:
945 946
            # FIXME: not setting the type here to keep it working with
            # complex numbers. Should they be special cased?
947 948
            node = IntNode(self.pos, value=self.value, constant_result=self.constant_result,
                           unsigned=self.unsigned, longness=self.longness)
949 950 951
        # We still need to perform normal coerce_to processing on the
        # result, because we might be coercing to an extension type,
        # in which case a type test node will be needed.
952 953
        return ConstNode.coerce_to(node, dst_type, env)

954
    def coerce_to_boolean(self, env):
955 956 957 958
        return IntNode(
            self.pos, value=self.value,
            type = PyrexTypes.c_bint_type,
            unsigned=self.unsigned, longness=self.longness)
959

960
    def generate_evaluation_code(self, code):
961
        if self.type.is_pyobject:
962
            # pre-allocate a Python version of the number
963 964
            plain_integer_string = self.value_as_c_integer_string(plain_digits=True)
            self.result_code = code.get_py_num(plain_integer_string, self.longness)
965
        else:
966
            self.result_code = self.get_constant_c_result_code()
967

968
    def get_constant_c_result_code(self):
969 970 971
        return self.value_as_c_integer_string() + self.unsigned + self.longness

    def value_as_c_integer_string(self, plain_digits=False):
972 973 974 975
        value = self.value
        if isinstance(value, basestring) and len(value) > 2:
            # must convert C-incompatible Py3 oct/bin notations
            if value[1] in 'oO':
976 977 978 979
                if plain_digits:
                    value = int(value[2:], 8)
                else:
                    value = value[0] + value[2:] # '0o123' => '0123'
980 981
            elif value[1] in 'bB':
                value = int(value[2:], 2)
982 983 984
            elif plain_digits and value[1] in 'xX':
                value = int(value[2:], 16)
        return str(value)
985 986 987

    def calculate_result_code(self):
        return self.result_code
William Stein's avatar
William Stein committed
988

989
    def calculate_constant_result(self):
990
        self.constant_result = Utils.str_to_number(self.value)
991

992
    def compile_time_value(self, denv):
993
        return Utils.str_to_number(self.value)
994 995


William Stein's avatar
William Stein committed
996 997 998
class FloatNode(ConstNode):
    type = PyrexTypes.c_double_type

999
    def calculate_constant_result(self):
1000
        self.constant_result = float(self.value)
1001

1002 1003
    def compile_time_value(self, denv):
        return float(self.value)
1004

Stefan Behnel's avatar
Stefan Behnel committed
1005
    def calculate_result_code(self):
1006 1007 1008 1009
        strval = self.value
        assert isinstance(strval, (str, unicode))
        cmpval = repr(float(strval))
        if cmpval == 'nan':
1010
            return "(Py_HUGE_VAL * 0)"
1011
        elif cmpval == 'inf':
1012
            return "Py_HUGE_VAL"
1013
        elif cmpval == '-inf':
1014
            return "(-Py_HUGE_VAL)"
Stefan Behnel's avatar
Stefan Behnel committed
1015 1016
        else:
            return strval
1017

William Stein's avatar
William Stein committed
1018

1019
class BytesNode(ConstNode):
1020 1021 1022 1023
    # A char* or bytes literal
    #
    # value      BytesLiteral

1024
    is_string_literal = True
1025 1026
    # start off as Python 'bytes' to support len() in O(1)
    type = bytes_type
1027 1028

    def compile_time_value(self, denv):
1029
        return self.value
1030

1031
    def analyse_as_type(self, env):
1032
        type = PyrexTypes.parse_basic_type(self.value)
1033
        if type is not None:
1034
            return type
1035 1036 1037 1038 1039 1040 1041
        from TreeFragment import TreeFragment
        pos = (self.pos[0], self.pos[1], self.pos[2]-7)
        declaration = TreeFragment(u"sizeof(%s)" % self.value, name=pos[0].filename, initial_pos=pos)
        sizeof_node = declaration.root.stats[0].expr
        sizeof_node.analyse_types(env)
        if isinstance(sizeof_node, SizeofTypeNode):
            return sizeof_node.arg_type
1042

1043 1044 1045
    def can_coerce_to_char_literal(self):
        return len(self.value) == 1

1046
    def coerce_to_boolean(self, env):
1047 1048
        # This is special because testing a C char* for truth directly
        # would yield the wrong result.
1049 1050
        bool_value = bool(self.value)
        return BoolNode(self.pos, value=bool_value, constant_result=bool_value)
1051

William Stein's avatar
William Stein committed
1052
    def coerce_to(self, dst_type, env):
1053 1054
        if self.type == dst_type:
            return self
1055
        if dst_type.is_int:
1056
            if not self.can_coerce_to_char_literal():
1057 1058
                error(self.pos, "Only single-character string literals can be coerced into ints.")
                return self
Stefan Behnel's avatar
Stefan Behnel committed
1059 1060
            if dst_type.is_unicode_char:
                error(self.pos, "Bytes literals cannot coerce to Py_UNICODE/Py_UCS4, use a unicode literal instead.")
1061
                return self
1062 1063
            return CharNode(self.pos, value=self.value)

1064
        node = BytesNode(self.pos, value=self.value)
1065 1066 1067 1068 1069 1070 1071 1072
        if dst_type.is_pyobject:
            if dst_type in (py_object_type, Builtin.bytes_type):
                node.type = Builtin.bytes_type
            else:
                self.check_for_coercion_error(dst_type, fail=True)
                return node
        elif dst_type == PyrexTypes.c_char_ptr_type:
            node.type = dst_type
1073 1074 1075 1076
            return node
        elif dst_type == PyrexTypes.c_uchar_ptr_type:
            node.type = PyrexTypes.c_char_ptr_type
            return CastNode(node, PyrexTypes.c_uchar_ptr_type)
1077 1078
        elif dst_type.assignable_from(PyrexTypes.c_char_ptr_type):
            node.type = dst_type
1079
            return node
1080

William Stein's avatar
William Stein committed
1081 1082 1083 1084 1085
        # We still need to perform normal coerce_to processing on the
        # result, because we might be coercing to an extension type,
        # in which case a type test node will be needed.
        return ConstNode.coerce_to(node, dst_type, env)

1086
    def generate_evaluation_code(self, code):
William Stein's avatar
William Stein committed
1087
        if self.type.is_pyobject:
1088
            self.result_code = code.get_py_string_const(self.value)
William Stein's avatar
William Stein committed
1089
        else:
1090
            self.result_code = code.get_string_const(self.value)
1091

1092
    def get_constant_c_result_code(self):
1093
        return None # FIXME
1094

1095 1096
    def calculate_result_code(self):
        return self.result_code
William Stein's avatar
William Stein committed
1097 1098


1099
class UnicodeNode(PyConstNode):
1100 1101
    # A Python unicode object
    #
1102 1103
    # value        EncodedString
    # bytes_value  BytesLiteral    the literal parsed as bytes string ('-3' unicode literals only)
Robert Bradshaw's avatar
Robert Bradshaw committed
1104

1105
    is_string_literal = True
1106
    bytes_value = None
1107
    type = unicode_type
1108

1109
    def coerce_to(self, dst_type, env):
1110 1111
        if dst_type is self.type:
            pass
Stefan Behnel's avatar
Stefan Behnel committed
1112
        elif dst_type.is_unicode_char:
1113
            if not self.can_coerce_to_char_literal():
Stefan Behnel's avatar
Stefan Behnel committed
1114
                error(self.pos, "Only single-character Unicode string literals or surrogate pairs can be coerced into Py_UCS4/Py_UNICODE.")
1115 1116
                return self
            int_value = ord(self.value)
Stefan Behnel's avatar
Stefan Behnel committed
1117
            return IntNode(self.pos, type=dst_type, value=str(int_value), constant_result=int_value)
1118
        elif not dst_type.is_pyobject:
1119 1120 1121
            if dst_type.is_string and self.bytes_value is not None:
                # special case: '-3' enforced unicode literal used in a C char* context
                return BytesNode(self.pos, value=self.bytes_value).coerce_to(dst_type, env)
Stefan Behnel's avatar
Stefan Behnel committed
1122
            error(self.pos, "Unicode literals do not support coercion to C types other than Py_UNICODE or Py_UCS4.")
1123 1124 1125 1126
        elif dst_type is not py_object_type:
            if not self.check_for_coercion_error(dst_type):
                self.fail_assignment(dst_type)
        return self
1127

1128 1129
    def can_coerce_to_char_literal(self):
        return len(self.value) == 1
Stefan Behnel's avatar
Stefan Behnel committed
1130 1131 1132
            ## or (len(self.value) == 2
            ##     and (0xD800 <= self.value[0] <= 0xDBFF)
            ##     and (0xDC00 <= self.value[1] <= 0xDFFF))
1133

1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
    def contains_surrogates(self):
        # Check if the unicode string contains surrogate code points
        # on a CPython platform with wide (UCS-4) or narrow (UTF-16)
        # Unicode, i.e. characters that would be spelled as two
        # separate code units on a narrow platform.
        for c in map(ord, self.value):
            if c > 65535: # can only happen on wide platforms
                return True
            # We only look for the first code unit (D800-DBFF) of a
            # surrogate pair - if we find one, the other one
            # (DC00-DFFF) is likely there, too.  If we don't find it,
            # any second code unit cannot make for a surrogate pair by
            # itself.
            if c >= 0xD800 and c <= 0xDBFF:
                return True
        return False

1151
    def generate_evaluation_code(self, code):
1152
        self.result_code = code.get_py_string_const(self.value)
1153 1154 1155

    def calculate_result_code(self):
        return self.result_code
1156

1157 1158
    def compile_time_value(self, env):
        return self.value
1159 1160


1161 1162 1163 1164
class StringNode(PyConstNode):
    # A Python str object, i.e. a byte string in Python 2.x and a
    # unicode string in Python 3.x
    #
1165 1166
    # value          BytesLiteral (or EncodedString with ASCII content)
    # unicode_value  EncodedString or None
1167
    # is_identifier  boolean
1168

1169
    type = str_type
1170
    is_string_literal = True
1171
    is_identifier = None
1172
    unicode_value = None
1173

1174
    def coerce_to(self, dst_type, env):
1175
        if dst_type is not py_object_type and not str_type.subtype_of(dst_type):
1176 1177 1178 1179 1180
#            if dst_type is Builtin.bytes_type:
#                # special case: bytes = 'str literal'
#                return BytesNode(self.pos, value=self.value)
            if not dst_type.is_pyobject:
                return BytesNode(self.pos, value=self.value).coerce_to(dst_type, env)
1181
            self.check_for_coercion_error(dst_type, fail=True)
1182
        return self
1183

1184 1185
    def can_coerce_to_char_literal(self):
        return not self.is_identifier and len(self.value) == 1
1186

1187
    def generate_evaluation_code(self, code):
1188
        self.result_code = code.get_py_string_const(
1189 1190
            self.value, identifier=self.is_identifier, is_str=True,
            unicode_value=self.unicode_value)
1191

1192
    def get_constant_c_result_code(self):
1193 1194
        return None

1195
    def calculate_result_code(self):
1196
        return self.result_code
1197

1198 1199
    def compile_time_value(self, env):
        return self.value
1200 1201


1202 1203 1204 1205
class IdentifierStringNode(StringNode):
    # A special str value that represents an identifier (bytes in Py2,
    # unicode in Py3).
    is_identifier = True
1206 1207


1208
class LongNode(AtomicExprNode):
William Stein's avatar
William Stein committed
1209 1210 1211
    #  Python long integer literal
    #
    #  value   string
1212

1213 1214
    type = py_object_type

1215
    def calculate_constant_result(self):
1216
        self.constant_result = Utils.str_to_number(self.value)
1217

1218
    def compile_time_value(self, denv):
1219
        return Utils.str_to_number(self.value)
1220

William Stein's avatar
William Stein committed
1221 1222
    def analyse_types(self, env):
        self.is_temp = 1
1223

1224 1225 1226
    def may_be_none(self):
        return False

1227 1228
    gil_message = "Constructing Python long int"

1229
    def generate_result_code(self, code):
William Stein's avatar
William Stein committed
1230
        code.putln(
1231
            '%s = PyLong_FromString((char *)"%s", 0, 0); %s' % (
1232
                self.result(),
William Stein's avatar
William Stein committed
1233
                self.value,
1234
                code.error_goto_if_null(self.result(), self.pos)))
1235
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
1236 1237


1238
class ImagNode(AtomicExprNode):
William Stein's avatar
William Stein committed
1239 1240 1241
    #  Imaginary number literal
    #
    #  value   float    imaginary part
1242

1243
    type = PyrexTypes.c_double_complex_type
1244 1245 1246

    def calculate_constant_result(self):
        self.constant_result = complex(0.0, self.value)
1247

1248 1249
    def compile_time_value(self, denv):
        return complex(0.0, self.value)
1250

William Stein's avatar
William Stein committed
1251
    def analyse_types(self, env):
1252 1253
        self.type.create_declaration_utility_code(env)

1254 1255 1256
    def may_be_none(self):
        return False

1257
    def coerce_to(self, dst_type, env):
1258 1259 1260
        if self.type is dst_type:
            return self
        node = ImagNode(self.pos, value=self.value)
1261
        if dst_type.is_pyobject:
1262 1263
            node.is_temp = 1
            node.type = PyrexTypes.py_object_type
1264 1265 1266
        # We still need to perform normal coerce_to processing on the
        # result, because we might be coercing to an extension type,
        # in which case a type test node will be needed.
1267
        return AtomicExprNode.coerce_to(node, dst_type, env)
1268 1269 1270

    gil_message = "Constructing complex number"

1271 1272 1273 1274 1275 1276
    def calculate_result_code(self):
        if self.type.is_pyobject:
            return self.result()
        else:
            return "%s(0, %r)" % (self.type.from_parts, float(self.value))

1277
    def generate_result_code(self, code):
1278 1279 1280 1281 1282 1283 1284
        if self.type.is_pyobject:
            code.putln(
                "%s = PyComplex_FromDoubles(0.0, %r); %s" % (
                    self.result(),
                    float(self.value),
                    code.error_goto_if_null(self.result(), self.pos)))
            code.put_gotref(self.py_result())
1285

William Stein's avatar
William Stein committed
1286

Danilo Freitas's avatar
Danilo Freitas committed
1287
class NewExprNode(AtomicExprNode):
1288 1289 1290

    # C++ new statement
    #
Robert Bradshaw's avatar
Robert Bradshaw committed
1291
    # cppclass              node                 c++ class to create
1292

Robert Bradshaw's avatar
Robert Bradshaw committed
1293
    type = None
1294

1295
    def infer_type(self, env):
Robert Bradshaw's avatar
Robert Bradshaw committed
1296 1297
        type = self.cppclass.analyse_as_type(env)
        if type is None or not type.is_cpp_class:
Danilo Freitas's avatar
Danilo Freitas committed
1298
            error(self.pos, "new operator can only be applied to a C++ class")
Robert Bradshaw's avatar
Robert Bradshaw committed
1299
            self.type = error_type
Danilo Freitas's avatar
Danilo Freitas committed
1300
            return
Robert Bradshaw's avatar
Robert Bradshaw committed
1301
        self.cpp_check(env)
1302
        constructor = type.scope.lookup(u'<init>')
Danilo Freitas's avatar
Danilo Freitas committed
1303
        if constructor is None:
1304 1305
            return_type = PyrexTypes.CFuncType(type, [])
            return_type = PyrexTypes.CPtrType(return_type)
1306 1307
            type.scope.declare_cfunction(u'<init>', return_type, self.pos)
            constructor = type.scope.lookup(u'<init>')
1308
        self.class_type = type
DaniloFreitas's avatar
DaniloFreitas committed
1309
        self.entry = constructor
Robert Bradshaw's avatar
Robert Bradshaw committed
1310
        self.type = constructor.type
1311
        return self.type
1312

1313
    def analyse_types(self, env):
Robert Bradshaw's avatar
Robert Bradshaw committed
1314 1315
        if self.type is None:
            self.infer_type(env)
1316 1317 1318 1319

    def may_be_none(self):
        return False

Danilo Freitas's avatar
Danilo Freitas committed
1320 1321
    def generate_result_code(self, code):
        pass
1322

Danilo Freitas's avatar
Danilo Freitas committed
1323
    def calculate_result_code(self):
1324
        return "new " + self.class_type.declaration_code("")
Danilo Freitas's avatar
Danilo Freitas committed
1325

William Stein's avatar
William Stein committed
1326

1327
class NameNode(AtomicExprNode):
William Stein's avatar
William Stein committed
1328 1329 1330 1331
    #  Reference to a local or global variable name.
    #
    #  name            string    Python name of the variable
    #  entry           Entry     Symbol table entry
1332
    #  type_entry      Entry     For extension type names, the original type entry
1333 1334
    #  cf_is_null      boolean   Is uninitialized before this node
    #  cf_maybe_null   boolean   Maybe uninitialized before this node
Vitja Makarov's avatar
Vitja Makarov committed
1335
    #  allow_null      boolean   Don't raise UnboundLocalError
1336
    #  nogil           boolean   Whether it is used in a nogil context
1337

1338 1339
    is_name = True
    is_cython_module = False
Robert Bradshaw's avatar
Robert Bradshaw committed
1340
    cython_attribute = None
1341
    lhs_of_first_assignment = False # TODO: remove me
1342
    is_used_as_rvalue = 0
1343
    entry = None
1344
    type_entry = None
1345 1346
    cf_maybe_null = True
    cf_is_null = False
Vitja Makarov's avatar
Vitja Makarov committed
1347
    allow_null = False
1348
    nogil = False
1349 1350 1351 1352 1353

    def create_analysed_rvalue(pos, env, entry):
        node = NameNode(pos)
        node.analyse_types(env, entry=entry)
        return node
1354

1355
    def as_cython_attribute(self):
Robert Bradshaw's avatar
Robert Bradshaw committed
1356
        return self.cython_attribute
1357

1358
    create_analysed_rvalue = staticmethod(create_analysed_rvalue)
1359

Robert Bradshaw's avatar
Robert Bradshaw committed
1360 1361 1362 1363 1364 1365 1366
    def type_dependencies(self, env):
        if self.entry is None:
            self.entry = env.lookup(self.name)
        if self.entry is not None and self.entry.type.is_unspecified:
            return (self.entry,)
        else:
            return ()
1367

Robert Bradshaw's avatar
Robert Bradshaw committed
1368 1369 1370 1371 1372
    def infer_type(self, env):
        if self.entry is None:
            self.entry = env.lookup(self.name)
        if self.entry is None:
            return py_object_type
Robert Bradshaw's avatar
Robert Bradshaw committed
1373 1374 1375
        elif (self.entry.type.is_extension_type or self.entry.type.is_builtin_type) and \
                self.name == self.entry.type.name:
            # Unfortunately the type attribute of type objects
1376
            # is used for the pointer to the type they represent.
Robert Bradshaw's avatar
Robert Bradshaw committed
1377
            return type_type
1378
        elif self.entry.type.is_cfunction:
1379 1380 1381 1382 1383 1384
            if self.entry.scope.is_builtin_scope:
                # special case: optimised builtin functions must be treated as Python objects
                return py_object_type
            else:
                # special case: referring to a C function must return its pointer
                return PyrexTypes.CPtrType(self.entry.type)
Robert Bradshaw's avatar
Robert Bradshaw committed
1385 1386
        else:
            return self.entry.type
1387

1388 1389 1390 1391
    def compile_time_value(self, denv):
        try:
            return denv.lookup(self.name)
        except KeyError:
Stefan Behnel's avatar
Stefan Behnel committed
1392
            error(self.pos, "Compile-time name '%s' not defined" % self.name)
1393 1394 1395 1396 1397

    def get_constant_c_result_code(self):
        if not self.entry or self.entry.type.is_pyobject:
            return None
        return self.entry.cname
1398

1399 1400 1401 1402 1403 1404 1405
    def coerce_to(self, dst_type, env):
        #  If coercing to a generic pyobject and this is a builtin
        #  C function with a Python equivalent, manufacture a NameNode
        #  referring to the Python builtin.
        #print "NameNode.coerce_to:", self.name, dst_type ###
        if dst_type is py_object_type:
            entry = self.entry
1406
            if entry and entry.is_cfunction:
1407 1408
                var_entry = entry.as_variable
                if var_entry:
1409
                    if var_entry.is_builtin and var_entry.is_const:
1410
                        var_entry = env.declare_builtin(var_entry.name, self.pos)
1411 1412 1413 1414
                    node = NameNode(self.pos, name = self.name)
                    node.entry = var_entry
                    node.analyse_rvalue_entry(env)
                    return node
1415

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1416
        return super(NameNode, self).coerce_to(dst_type, env)
1417

William Stein's avatar
William Stein committed
1418 1419 1420
    def analyse_as_module(self, env):
        # Try to interpret this as a reference to a cimported module.
        # Returns the module scope, or None.
1421 1422 1423
        entry = self.entry
        if not entry:
            entry = env.lookup(self.name)
William Stein's avatar
William Stein committed
1424 1425 1426
        if entry and entry.as_module:
            return entry.as_module
        return None
1427

1428
    def analyse_as_type(self, env):
1429 1430 1431 1432
        if self.cython_attribute:
            type = PyrexTypes.parse_basic_type(self.cython_attribute)
        else:
            type = PyrexTypes.parse_basic_type(self.name)
1433 1434
        if type:
            return type
1435 1436 1437 1438 1439 1440 1441
        entry = self.entry
        if not entry:
            entry = env.lookup(self.name)
        if entry and entry.is_type:
            return entry.type
        else:
            return None
1442

William Stein's avatar
William Stein committed
1443 1444 1445
    def analyse_as_extension_type(self, env):
        # Try to interpret this as a reference to an extension type.
        # Returns the extension type, or None.
1446 1447 1448
        entry = self.entry
        if not entry:
            entry = env.lookup(self.name)
William Stein's avatar
William Stein committed
1449
        if entry and entry.is_type and entry.type.is_extension_type:
1450 1451 1452
            return entry.type
        else:
            return None
1453

William Stein's avatar
William Stein committed
1454
    def analyse_target_declaration(self, env):
1455 1456
        if not self.entry:
            self.entry = env.lookup_here(self.name)
William Stein's avatar
William Stein committed
1457
        if not self.entry:
1458 1459
            if env.directives['warn.undeclared']:
                warning(self.pos, "implicit declaration of '%s'" % self.name, 1)
1460
            if env.directives['infer_types'] != False:
1461 1462 1463 1464
                type = unspecified_type
            else:
                type = py_object_type
            self.entry = env.declare_var(self.name, type, self.pos)
1465 1466
        if self.entry.is_declared_generic:
            self.result_ctype = py_object_type
1467

1468
    def analyse_types(self, env):
1469
        self.initialized_check = env.directives['initializedcheck']
1470 1471
        if self.entry is None:
            self.entry = env.lookup(self.name)
William Stein's avatar
William Stein committed
1472 1473
        if not self.entry:
            self.entry = env.declare_builtin(self.name, self.pos)
1474 1475 1476
        if not self.entry:
            self.type = PyrexTypes.error_type
            return
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1477 1478 1479 1480 1481 1482 1483 1484
        entry = self.entry
        if entry:
            entry.used = 1
            if entry.type.is_buffer:
                import Buffer
                Buffer.used_buffer_aux_vars(entry)
            if entry.utility_code:
                env.use_utility_code(entry.utility_code)
1485
        self.analyse_rvalue_entry(env)
1486

1487
    def analyse_target_types(self, env):
William Stein's avatar
William Stein committed
1488
        self.analyse_entry(env)
1489 1490 1491

        if (not self.is_lvalue() and self.entry.is_cfunction and
                self.entry.fused_cfunction and self.entry.as_variable):
1492
            # We need this for the fused 'def' TreeFragment
1493 1494 1495
            self.entry = self.entry.as_variable
            self.type = self.entry.type

1496 1497 1498 1499
        if not self.is_lvalue():
            error(self.pos, "Assignment to non-lvalue '%s'"
                % self.name)
            self.type = PyrexTypes.error_type
Stefan Behnel's avatar
Stefan Behnel committed
1500
        self.entry.used = 1
1501
        if self.entry.type.is_buffer:
1502 1503
            import Buffer
            Buffer.used_buffer_aux_vars(self.entry)
1504

1505 1506 1507 1508
    def analyse_rvalue_entry(self, env):
        #print "NameNode.analyse_rvalue_entry:", self.name ###
        #print "Entry:", self.entry.__dict__ ###
        self.analyse_entry(env)
1509
        entry = self.entry
1510

1511
        if entry.is_declared_generic:
William Stein's avatar
William Stein committed
1512
            self.result_ctype = py_object_type
1513

1514
        if entry.is_pyglobal or entry.is_builtin:
1515
            if entry.is_builtin and entry.is_const:
1516 1517 1518
                self.is_temp = 0
            else:
                self.is_temp = 1
1519
                env.use_utility_code(get_name_interned_utility_code)
1520

1521
            self.is_used_as_rvalue = 1
1522 1523 1524
        elif entry.type.is_memoryviewslice:
            self.is_temp = False
            self.is_used_as_rvalue = True
1525
            self.use_managed_ref = True
1526

1527
    def nogil_check(self, env):
1528
        self.nogil = True
1529 1530 1531
        if self.is_used_as_rvalue:
            entry = self.entry
            if entry.is_builtin:
1532
                if not entry.is_const: # cached builtins are ok
1533
                    self.gil_error()
1534
            elif entry.is_pyglobal:
1535
                self.gil_error()
1536 1537 1538 1539
            elif self.entry.type.is_memoryviewslice:
                if self.cf_is_null or self.cf_maybe_null:
                    import MemoryView
                    MemoryView.err_if_nogil_initialized_check(self.pos, env)
1540 1541 1542

    gil_message = "Accessing Python global or builtin"

1543 1544
    def analyse_entry(self, env):
        #print "NameNode.analyse_entry:", self.name ###
William Stein's avatar
William Stein committed
1545
        self.check_identifier_kind()
1546 1547 1548 1549
        entry = self.entry
        type = entry.type
        self.type = type

William Stein's avatar
William Stein committed
1550
    def check_identifier_kind(self):
1551 1552 1553
        # Check that this is an appropriate kind of name for use in an
        # expression.  Also finds the variable entry associated with
        # an extension type.
William Stein's avatar
William Stein committed
1554
        entry = self.entry
1555 1556
        if entry.is_type and entry.type.is_extension_type:
            self.type_entry = entry
1557
        if not (entry.is_const or entry.is_variable
Danilo Freitas's avatar
Danilo Freitas committed
1558 1559
            or entry.is_builtin or entry.is_cfunction
            or entry.is_cpp_class):
William Stein's avatar
William Stein committed
1560 1561 1562
                if self.entry.as_variable:
                    self.entry = self.entry.as_variable
                else:
1563
                    error(self.pos,
1564 1565
                          "'%s' is not a constant, variable or function identifier" % self.name)

William Stein's avatar
William Stein committed
1566 1567 1568
    def is_simple(self):
        #  If it's not a C variable, it'll be in a temp.
        return 1
1569

1570
    def may_be_none(self):
1571
        if self.cf_state and self.type and self.type.is_pyobject:
1572 1573 1574 1575 1576 1577 1578
            # gard against infinite recursion on self-dependencies
            if getattr(self, '_none_checking', False):
                # self-dependency - either this node receives a None
                # value from *another* node, or it can not reference
                # None at this point => safe to assume "not None"
                return False
            self._none_checking = True
1579 1580
            # evaluate control flow state to see if there were any
            # potential None values assigned to the node so far
1581
            may_be_none = False
1582 1583
            for assignment in self.cf_state:
                if assignment.rhs.may_be_none():
1584 1585 1586 1587
                    may_be_none = True
                    break
            del self._none_checking
            return may_be_none
1588 1589
        return super(NameNode, self).may_be_none()

1590
    def nonlocally_immutable(self):
1591 1592
        if ExprNode.nonlocally_immutable(self):
            return True
1593 1594 1595
        entry = self.entry
        return entry and (entry.is_local or entry.is_arg) and not entry.in_closure

William Stein's avatar
William Stein committed
1596 1597
    def calculate_target_results(self, env):
        pass
1598

William Stein's avatar
William Stein committed
1599 1600
    def check_const(self):
        entry = self.entry
Robert Bradshaw's avatar
Robert Bradshaw committed
1601
        if entry is not None and not (entry.is_const or entry.is_cfunction or entry.is_builtin):
William Stein's avatar
William Stein committed
1602
            self.not_const()
1603 1604
            return False
        return True
1605

William Stein's avatar
William Stein committed
1606 1607
    def check_const_addr(self):
        entry = self.entry
1608
        if not (entry.is_cglobal or entry.is_cfunction or entry.is_builtin):
William Stein's avatar
William Stein committed
1609
            self.addr_not_const()
1610 1611
            return False
        return True
William Stein's avatar
William Stein committed
1612 1613 1614 1615 1616

    def is_lvalue(self):
        return self.entry.is_variable and \
            not self.entry.type.is_array and \
            not self.entry.is_readonly
1617

William Stein's avatar
William Stein committed
1618 1619 1620 1621
    def is_ephemeral(self):
        #  Name nodes are never ephemeral, even if the
        #  result is in a temporary.
        return 0
1622

William Stein's avatar
William Stein committed
1623
    def calculate_result_code(self):
Stefan Behnel's avatar
Stefan Behnel committed
1624 1625
        entry = self.entry
        if not entry:
William Stein's avatar
William Stein committed
1626
            return "<error>" # There was an error earlier
Stefan Behnel's avatar
Stefan Behnel committed
1627
        return entry.cname
1628

William Stein's avatar
William Stein committed
1629
    def generate_result_code(self, code):
1630
        assert hasattr(self, 'entry')
William Stein's avatar
William Stein committed
1631 1632 1633
        entry = self.entry
        if entry is None:
            return # There was an error earlier
1634
        if entry.is_builtin and entry.is_const:
1635
            return # Lookup already cached
Stefan Behnel's avatar
Stefan Behnel committed
1636
        elif entry.is_pyclass_attr:
Vitja Makarov's avatar
Vitja Makarov committed
1637 1638 1639 1640 1641 1642
            assert entry.type.is_pyobject, "Python global or builtin not a Python object"
            interned_cname = code.intern_identifier(self.entry.name)
            if entry.is_builtin:
                namespace = Naming.builtins_cname
            else: # entry.is_pyglobal
                namespace = entry.scope.namespace_cname
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
            if not self.cf_is_null:
                code.putln(
                    '%s = PyObject_GetItem(%s, %s);' % (
                        self.result(),
                        namespace,
                        interned_cname))
            if self.cf_maybe_null:
                if not self.cf_is_null:
                    code.putln('if (unlikely(!%s)) {' % self.result())
                    code.putln('PyErr_Clear();')
                code.putln(
                    '%s = __Pyx_GetName(%s, %s);' % (
                    self.result(),
                    Naming.module_cname,
                    interned_cname))
                if not self.cf_is_null:
                    code.putln("}");
            code.putln(code.error_goto_if_null(self.result(), self.pos))
Vitja Makarov's avatar
Vitja Makarov committed
1661
            code.put_gotref(self.py_result())
1662

1663
        elif entry.is_pyglobal or entry.is_builtin:
1664 1665
            assert entry.type.is_pyobject, "Python global or builtin not a Python object"
            interned_cname = code.intern_identifier(self.entry.name)
William Stein's avatar
William Stein committed
1666 1667 1668
            if entry.is_builtin:
                namespace = Naming.builtins_cname
            else: # entry.is_pyglobal
1669
                namespace = entry.scope.namespace_cname
1670
            code.globalstate.use_utility_code(get_name_interned_utility_code)
1671 1672
            code.putln(
                '%s = __Pyx_GetName(%s, %s); %s' % (
1673
                self.result(),
1674
                namespace,
1675
                interned_cname,
1676
                code.error_goto_if_null(self.result(), self.pos)))
1677
            code.put_gotref(self.py_result())
1678

1679
        elif entry.is_local or entry.in_closure or entry.from_closure:
1680 1681 1682 1683
            # Raise UnboundLocalError for objects and memoryviewslices
            raise_unbound = (
                (self.cf_maybe_null or self.cf_is_null) and not self.allow_null)
            null_code = entry.type.check_for_null_code(entry.cname)
1684

1685 1686 1687 1688
            memslice_check = entry.type.is_memoryviewslice and self.initialized_check

            if null_code and raise_unbound and (entry.type.is_pyobject or memslice_check):
                code.put_error_if_unbound(self.pos, entry)
William Stein's avatar
William Stein committed
1689 1690

    def generate_assignment_code(self, rhs, code):
1691
        #print "NameNode.generate_assignment_code:", self.name ###
William Stein's avatar
William Stein committed
1692 1693 1694
        entry = self.entry
        if entry is None:
            return # There was an error earlier
1695 1696 1697 1698

        if (self.entry.type.is_ptr and isinstance(rhs, ListNode)
            and not self.lhs_of_first_assignment):
            error(self.pos, "Literal list must be assigned to pointer at time of declaration")
1699

1700 1701
        # is_pyglobal seems to be True for module level-globals only.
        # We use this to access class->tp_dict if necessary.
William Stein's avatar
William Stein committed
1702
        if entry.is_pyglobal:
1703 1704
            assert entry.type.is_pyobject, "Python global or builtin not a Python object"
            interned_cname = code.intern_identifier(self.entry.name)
1705
            namespace = self.entry.scope.namespace_cname
1706
            if entry.is_member:
Stefan Behnel's avatar
Stefan Behnel committed
1707
                # if the entry is a member we have to cheat: SetAttr does not work
1708
                # on types, so we create a descriptor which is then added to tp_dict
1709 1710 1711
                code.put_error_if_neg(self.pos,
                    'PyDict_SetItem(%s->tp_dict, %s, %s)' % (
                        namespace,
1712
                        interned_cname,
1713
                        rhs.py_result()))
1714 1715
                rhs.generate_disposal_code(code)
                rhs.free_temps(code)
1716
                # in Py2.6+, we need to invalidate the method cache
1717
                code.putln("PyType_Modified(%s);" %
Vitja Makarov's avatar
Vitja Makarov committed
1718
                            entry.scope.parent_type.typeptr_cname)
Stefan Behnel's avatar
Stefan Behnel committed
1719
            elif entry.is_pyclass_attr:
Vitja Makarov's avatar
Vitja Makarov committed
1720
                code.put_error_if_neg(self.pos,
Stefan Behnel's avatar
Stefan Behnel committed
1721
                    'PyObject_SetItem(%s, %s, %s)' % (
Vitja Makarov's avatar
Vitja Makarov committed
1722 1723 1724 1725 1726 1727
                        namespace,
                        interned_cname,
                        rhs.py_result()))
                rhs.generate_disposal_code(code)
                rhs.free_temps(code)
            else:
1728 1729 1730
                code.put_error_if_neg(self.pos,
                    'PyObject_SetAttr(%s, %s, %s)' % (
                        namespace,
1731
                        interned_cname,
1732
                        rhs.py_result()))
1733
                if debug_disposal_code:
Stefan Behnel's avatar
Stefan Behnel committed
1734 1735
                    print("NameNode.generate_assignment_code:")
                    print("...generating disposal code for %s" % rhs)
1736
                rhs.generate_disposal_code(code)
1737
                rhs.free_temps(code)
William Stein's avatar
William Stein committed
1738
        else:
1739
            if self.type.is_memoryviewslice:
1740
                self.generate_acquire_memoryviewslice(rhs, code)
1741

1742
            elif self.type.is_buffer:
1743 1744 1745 1746 1747 1748 1749 1750 1751
                # Generate code for doing the buffer release/acquisition.
                # This might raise an exception in which case the assignment (done
                # below) will not happen.
                #
                # The reason this is not in a typetest-like node is because the
                # variables that the acquired buffer info is stored to is allocated
                # per entry and coupled with it.
                self.generate_acquire_buffer(rhs, code)

1752
            if self.type.is_pyobject:
William Stein's avatar
William Stein committed
1753 1754 1755 1756
                #print "NameNode.generate_assignment_code: to", self.name ###
                #print "...from", rhs ###
                #print "...LHS type", self.type, "ctype", self.ctype() ###
                #print "...RHS type", rhs.type, "ctype", rhs.ctype() ###
1757 1758
                if self.use_managed_ref:
                    rhs.make_owned_reference(code)
1759
                    is_external_ref = entry.is_cglobal or self.entry.in_closure or self.entry.from_closure
1760 1761 1762 1763 1764 1765
                    if is_external_ref:
                        if not self.cf_is_null:
                            if self.cf_maybe_null:
                                code.put_xgotref(self.py_result())
                            else:
                                code.put_gotref(self.py_result())
1766 1767 1768
                    if entry.is_cglobal:
                        code.put_decref(self.result(), self.ctype())
                    else:
1769 1770
                        if not self.cf_is_null:
                            if self.cf_maybe_null:
1771
                                code.put_xdecref(self.result(), self.ctype())
1772 1773
                            else:
                                code.put_decref(self.result(), self.ctype())
1774
                    if is_external_ref:
1775
                        code.put_giveref(rhs.py_result())
1776
            if not self.type.is_memoryviewslice:
1777
                code.putln('%s = %s;' % (self.result(), rhs.result_as(self.ctype())))
1778 1779 1780 1781
                if debug_disposal_code:
                    print("NameNode.generate_assignment_code:")
                    print("...generating post-assignment code for %s" % rhs)
                rhs.generate_post_assignment_code(code)
1782 1783
            elif rhs.result_in_temp():
                rhs.generate_post_assignment_code(code)
1784

1785
            rhs.free_temps(code)
1786

1787 1788
    def generate_acquire_memoryviewslice(self, rhs, code):
        """
1789 1790
        Slices, coercions from objects, return values etc are new references.
        We have a borrowed reference in case of dst = src
1791 1792 1793 1794 1795 1796 1797 1798 1799
        """
        import MemoryView

        MemoryView.put_acquire_memoryviewslice(
            lhs_cname=self.result(),
            lhs_type=self.type,
            lhs_pos=self.pos,
            rhs=rhs,
            code=code,
1800
            incref_rhs=rhs.is_name,
Mark Florisson's avatar
Mark Florisson committed
1801
            have_gil=not self.in_nogil_context)
1802

1803
    def generate_acquire_buffer(self, rhs, code):
1804 1805 1806
        # rhstmp is only used in case the rhs is a complicated expression leading to
        # the object, to avoid repeating the same C expression for every reference
        # to the rhs. It does NOT hold a reference.
1807 1808 1809 1810 1811 1812 1813
        pretty_rhs = isinstance(rhs, NameNode) or rhs.is_temp
        if pretty_rhs:
            rhstmp = rhs.result_as(self.ctype())
        else:
            rhstmp = code.funcstate.allocate_temp(self.entry.type, manage_ref=False)
            code.putln('%s = %s;' % (rhstmp, rhs.result_as(self.ctype())))

1814
        import Buffer
1815
        Buffer.put_assign_to_buffer(self.result(), rhstmp, self.entry,
1816
                                    is_initialized=not self.lhs_of_first_assignment,
1817
                                    pos=self.pos, code=code)
1818

1819 1820 1821
        if not pretty_rhs:
            code.putln("%s = 0;" % rhstmp)
            code.funcstate.release_temp(rhstmp)
1822

William Stein's avatar
William Stein committed
1823 1824 1825
    def generate_deletion_code(self, code):
        if self.entry is None:
            return # There was an error earlier
1826
        elif self.entry.is_pyclass_attr:
Vitja Makarov's avatar
Vitja Makarov committed
1827
            namespace = self.entry.scope.namespace_cname
1828
            interned_cname = code.intern_identifier(self.entry.name)
Vitja Makarov's avatar
Vitja Makarov committed
1829
            code.put_error_if_neg(self.pos,
1830
                'PyMapping_DelItem(%s, %s)' % (
Vitja Makarov's avatar
Vitja Makarov committed
1831
                    namespace,
1832
                    interned_cname))
1833 1834 1835 1836 1837
        elif self.entry.is_pyglobal:
            code.put_error_if_neg(self.pos,
                '__Pyx_DelAttrString(%s, "%s")' % (
                    Naming.module_cname,
                    self.entry.name))
1838
        elif self.entry.type.is_pyobject or self.entry.type.is_memoryviewslice:
1839 1840
            if not self.cf_is_null:
                if self.cf_maybe_null:
1841
                    code.put_error_if_unbound(self.pos, self.entry)
1842 1843 1844 1845 1846 1847 1848

                if self.entry.type.is_pyobject:
                    code.put_decref(self.result(), self.ctype())
                    code.putln('%s = NULL;' % self.result())
                else:
                    code.put_xdecref_memoryviewslice(self.entry.cname,
                                                     have_gil=not self.nogil)
Vitja Makarov's avatar
Vitja Makarov committed
1849
        else:
1850
            error(self.pos, "Deletion of C names not supported")
1851

1852 1853 1854 1855 1856 1857 1858
    def annotate(self, code):
        if hasattr(self, 'is_called') and self.is_called:
            pos = (self.pos[0], self.pos[1], self.pos[2] - len(self.name) - 1)
            if self.type.is_pyobject:
                code.annotate(pos, AnnotationItem('py_call', 'python function', size=len(self.name)))
            else:
                code.annotate(pos, AnnotationItem('c_call', 'c function', size=len(self.name)))
1859

1860
class BackquoteNode(ExprNode):
William Stein's avatar
William Stein committed
1861 1862 1863
    #  `expr`
    #
    #  arg    ExprNode
1864

1865
    type = py_object_type
1866

William Stein's avatar
William Stein committed
1867
    subexprs = ['arg']
1868

William Stein's avatar
William Stein committed
1869 1870 1871 1872
    def analyse_types(self, env):
        self.arg.analyse_types(env)
        self.arg = self.arg.coerce_to_pyobject(env)
        self.is_temp = 1
1873 1874 1875

    gil_message = "Backquote expression"

1876 1877 1878
    def calculate_constant_result(self):
        self.constant_result = repr(self.arg.constant_result)

William Stein's avatar
William Stein committed
1879 1880
    def generate_result_code(self, code):
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
1881
            "%s = PyObject_Repr(%s); %s" % (
1882
                self.result(),
William Stein's avatar
William Stein committed
1883
                self.arg.py_result(),
1884
                code.error_goto_if_null(self.result(), self.pos)))
1885
        code.put_gotref(self.py_result())
1886

William Stein's avatar
William Stein committed
1887

1888
class ImportNode(ExprNode):
William Stein's avatar
William Stein committed
1889
    #  Used as part of import statement implementation.
1890
    #  Implements result =
Haoyu Bai's avatar
Haoyu Bai committed
1891
    #    __import__(module_name, globals(), None, name_list, level)
William Stein's avatar
William Stein committed
1892
    #
Haoyu Bai's avatar
Haoyu Bai committed
1893 1894 1895
    #  module_name   StringNode            dotted name of module. Empty module
    #                       name means importing the parent package accourding
    #                       to level
1896
    #  name_list     ListNode or None      list of names to be imported
Haoyu Bai's avatar
Haoyu Bai committed
1897 1898 1899 1900 1901
    #  level         int                   relative import level:
    #                       -1: attempt both relative import and absolute import;
    #                        0: absolute import;
    #                       >0: the number of parent directories to search
    #                           relative to the current module.
1902 1903
    #                     None: decide the level according to language level and
    #                           directives
1904

1905
    type = py_object_type
1906

William Stein's avatar
William Stein committed
1907
    subexprs = ['module_name', 'name_list']
1908

William Stein's avatar
William Stein committed
1909
    def analyse_types(self, env):
1910 1911 1912 1913 1914
        if self.level is None:
            if env.directives['language_level'] < 3 or env.directives['py2_import']:
                self.level = -1
            else:
                self.level = 0
William Stein's avatar
William Stein committed
1915 1916 1917 1918
        self.module_name.analyse_types(env)
        self.module_name = self.module_name.coerce_to_pyobject(env)
        if self.name_list:
            self.name_list.analyse_types(env)
1919
            self.name_list.coerce_to_pyobject(env)
William Stein's avatar
William Stein committed
1920 1921
        self.is_temp = 1
        env.use_utility_code(import_utility_code)
1922 1923 1924

    gil_message = "Python import"

William Stein's avatar
William Stein committed
1925 1926 1927 1928 1929 1930
    def generate_result_code(self, code):
        if self.name_list:
            name_list_code = self.name_list.py_result()
        else:
            name_list_code = "0"
        code.putln(
Haoyu Bai's avatar
Haoyu Bai committed
1931
            "%s = __Pyx_Import(%s, %s, %d); %s" % (
1932
                self.result(),
William Stein's avatar
William Stein committed
1933 1934
                self.module_name.py_result(),
                name_list_code,
Haoyu Bai's avatar
Haoyu Bai committed
1935
                self.level,
1936
                code.error_goto_if_null(self.result(), self.pos)))
1937
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
1938 1939


1940
class IteratorNode(ExprNode):
William Stein's avatar
William Stein committed
1941
    #  Used as part of for statement implementation.
1942
    #
William Stein's avatar
William Stein committed
1943 1944 1945
    #  Implements result = iter(sequence)
    #
    #  sequence   ExprNode
1946

1947
    type = py_object_type
1948
    iter_func_ptr = None
1949
    counter_cname = None
1950
    reversed = False      # currently only used for list/tuple types (see Optimize.py)
1951

William Stein's avatar
William Stein committed
1952
    subexprs = ['sequence']
1953

William Stein's avatar
William Stein committed
1954 1955
    def analyse_types(self, env):
        self.sequence.analyse_types(env)
1956 1957
        if (self.sequence.type.is_array or self.sequence.type.is_ptr) and \
                not self.sequence.type.is_string:
1958
            # C array iteration will be transformed later on
1959
            self.type = self.sequence.type
1960 1961
        else:
            self.sequence = self.sequence.coerce_to_pyobject(env)
1962 1963 1964
            if self.sequence.type is list_type or \
                   self.sequence.type is tuple_type:
                self.sequence = self.sequence.as_none_safe_node("'NoneType' object is not iterable")
William Stein's avatar
William Stein committed
1965
        self.is_temp = 1
1966 1967 1968

    gil_message = "Iterating over Python object"

1969 1970 1971 1972
    _func_iternext_type = PyrexTypes.CPtrType(PyrexTypes.CFuncType(
        PyrexTypes.py_object_type, [
            PyrexTypes.CFuncTypeArg("it", PyrexTypes.py_object_type, None),
            ]))
1973

William Stein's avatar
William Stein committed
1974
    def generate_result_code(self, code):
Stefan Behnel's avatar
Stefan Behnel committed
1975 1976
        sequence_type = self.sequence.type
        if sequence_type.is_array or sequence_type.is_ptr:
1977
            raise InternalError("for in carray slice not transformed")
Stefan Behnel's avatar
Stefan Behnel committed
1978 1979
        is_builtin_sequence = sequence_type is list_type or \
                              sequence_type is tuple_type
1980 1981 1982
        if not is_builtin_sequence:
            # reversed() not currently optimised (see Optimize.py)
            assert not self.reversed, "internal error: reversed() only implemented for list/tuple objects"
Stefan Behnel's avatar
Stefan Behnel committed
1983 1984
        self.may_be_a_sequence = not sequence_type.is_builtin_type
        if self.may_be_a_sequence:
1985 1986 1987 1988
            code.putln(
                "if (PyList_CheckExact(%s) || PyTuple_CheckExact(%s)) {" % (
                    self.sequence.py_result(),
                    self.sequence.py_result()))
Stefan Behnel's avatar
Stefan Behnel committed
1989
        if is_builtin_sequence or self.may_be_a_sequence:
1990 1991
            self.counter_cname = code.funcstate.allocate_temp(
                PyrexTypes.c_py_ssize_t_type, manage_ref=False)
1992 1993 1994 1995 1996 1997 1998
            if self.reversed:
                if sequence_type is list_type:
                    init_value = 'PyList_GET_SIZE(%s) - 1' % self.result()
                else:
                    init_value = 'PyTuple_GET_SIZE(%s) - 1' % self.result()
            else:
                init_value = '0'
1999
            code.putln(
2000
                "%s = %s; __Pyx_INCREF(%s); %s = %s;" % (
2001 2002
                    self.result(),
                    self.sequence.py_result(),
2003 2004 2005 2006
                    self.result(),
                    self.counter_cname,
                    init_value
                    ))
2007
        if not is_builtin_sequence:
Stefan Behnel's avatar
Stefan Behnel committed
2008
            self.iter_func_ptr = code.funcstate.allocate_temp(self._func_iternext_type, manage_ref=False)
Stefan Behnel's avatar
Stefan Behnel committed
2009
            if self.may_be_a_sequence:
Stefan Behnel's avatar
Stefan Behnel committed
2010
                code.putln("%s = NULL;" % self.iter_func_ptr)
2011
                code.putln("} else {")
2012 2013
                code.put("%s = -1; " % self.counter_cname)
            code.putln("%s = PyObject_GetIter(%s); %s" % (
2014 2015 2016
                    self.result(),
                    self.sequence.py_result(),
                    code.error_goto_if_null(self.result(), self.pos)))
2017
            code.put_gotref(self.py_result())
2018
            code.putln("%s = Py_TYPE(%s)->tp_iternext;" % (self.iter_func_ptr, self.py_result()))
Stefan Behnel's avatar
Stefan Behnel committed
2019 2020 2021 2022
        if self.may_be_a_sequence:
            code.putln("}")

    def generate_next_sequence_item(self, test_name, result_name, code):
2023
        assert self.counter_cname, "internal error: counter_cname temp not prepared"
Stefan Behnel's avatar
Stefan Behnel committed
2024 2025 2026 2027 2028
        code.putln(
            "if (%s >= Py%s_GET_SIZE(%s)) break;" % (
                self.counter_cname,
                test_name,
                self.py_result()))
2029 2030 2031 2032
        if self.reversed:
            inc_dec = '--'
        else:
            inc_dec = '++'
Stefan Behnel's avatar
Stefan Behnel committed
2033
        code.putln(
2034
            "%s = Py%s_GET_ITEM(%s, %s); __Pyx_INCREF(%s); %s%s;" % (
Stefan Behnel's avatar
Stefan Behnel committed
2035 2036 2037 2038 2039
                result_name,
                test_name,
                self.py_result(),
                self.counter_cname,
                result_name,
2040 2041
                self.counter_cname,
                inc_dec))
Stefan Behnel's avatar
Stefan Behnel committed
2042 2043 2044

    def generate_iter_next_result_code(self, result_name, code):
        sequence_type = self.sequence.type
2045 2046
        if self.reversed:
            code.putln("if (%s < 0) break;" % self.counter_cname)
Stefan Behnel's avatar
Stefan Behnel committed
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074
        if sequence_type is list_type:
            self.generate_next_sequence_item('List', result_name, code)
            return
        elif sequence_type is tuple_type:
            self.generate_next_sequence_item('Tuple', result_name, code)
            return

        if self.may_be_a_sequence:
            for test_name in ('List', 'Tuple'):
                code.putln("if (Py%s_CheckExact(%s)) {" % (test_name, self.py_result()))
                self.generate_next_sequence_item(test_name, result_name, code)
                code.put("} else ")

        code.putln("{")
        code.putln(
            "%s = %s(%s);" % (
                result_name,
                self.iter_func_ptr,
                self.py_result()))
        code.putln("if (unlikely(!%s)) {" % result_name)
        code.putln("if (PyErr_Occurred()) {")
        code.putln("if (likely(PyErr_ExceptionMatches(PyExc_StopIteration))) PyErr_Clear();")
        code.putln("else %s" % code.error_goto(self.pos))
        code.putln("}")
        code.putln("break;")
        code.putln("}")
        code.put_gotref(result_name)
        code.putln("}")
William Stein's avatar
William Stein committed
2075

2076
    def free_temps(self, code):
2077 2078
        if self.counter_cname:
            code.funcstate.release_temp(self.counter_cname)
2079 2080 2081 2082
        if self.iter_func_ptr:
            code.funcstate.release_temp(self.iter_func_ptr)
            self.iter_func_ptr = None
        ExprNode.free_temps(self, code)
William Stein's avatar
William Stein committed
2083 2084


2085
class NextNode(AtomicExprNode):
William Stein's avatar
William Stein committed
2086 2087 2088 2089 2090
    #  Used as part of for statement implementation.
    #  Implements result = iterator.next()
    #  Created during analyse_types phase.
    #  The iterator is not owned by this node.
    #
2091
    #  iterator   IteratorNode
2092

2093
    type = py_object_type
2094

2095
    def __init__(self, iterator):
William Stein's avatar
William Stein committed
2096 2097
        self.pos = iterator.pos
        self.iterator = iterator
2098 2099
        if iterator.type.is_ptr or iterator.type.is_array:
            self.type = iterator.type.base_type
William Stein's avatar
William Stein committed
2100
        self.is_temp = 1
2101

William Stein's avatar
William Stein committed
2102
    def generate_result_code(self, code):
Stefan Behnel's avatar
Stefan Behnel committed
2103
        self.iterator.generate_iter_next_result_code(self.result(), code)
2104

William Stein's avatar
William Stein committed
2105

2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
class WithExitCallNode(ExprNode):
    # The __exit__() call of a 'with' statement.  Used in both the
    # except and finally clauses.

    # with_stat  WithStatNode                the surrounding 'with' statement
    # args       TupleNode or ResultStatNode the exception info tuple

    subexprs = ['args']

    def analyse_types(self, env):
        self.args.analyse_types(env)
        self.type = PyrexTypes.c_bint_type
        self.is_temp = True

    def generate_result_code(self, code):
        if isinstance(self.args, TupleNode):
            # call only if it was not already called (and decref-cleared)
            code.putln("if (%s) {" % self.with_stat.exit_var)
        result_var = code.funcstate.allocate_temp(py_object_type, manage_ref=False)
        code.putln("%s = PyObject_Call(%s, %s, NULL);" % (
            result_var,
            self.with_stat.exit_var,
            self.args.result()))
        code.put_decref_clear(self.with_stat.exit_var, type=py_object_type)
        code.putln(code.error_goto_if_null(result_var, self.pos))
        code.put_gotref(result_var)
        code.putln("%s = __Pyx_PyObject_IsTrue(%s);" % (self.result(), result_var))
        code.put_decref_clear(result_var, type=py_object_type)
        code.putln(code.error_goto_if_neg(self.result(), self.pos))
        code.funcstate.release_temp(result_var)
        if isinstance(self.args, TupleNode):
            code.putln("}")


2140
class ExcValueNode(AtomicExprNode):
William Stein's avatar
William Stein committed
2141 2142 2143
    #  Node created during analyse_types phase
    #  of an ExceptClauseNode to fetch the current
    #  exception value.
2144

2145
    type = py_object_type
2146

2147
    def __init__(self, pos, env):
William Stein's avatar
William Stein committed
2148
        ExprNode.__init__(self, pos)
2149 2150

    def set_var(self, var):
2151
        self.var = var
2152

2153 2154 2155
    def calculate_result_code(self):
        return self.var

William Stein's avatar
William Stein committed
2156
    def generate_result_code(self, code):
2157
        pass
William Stein's avatar
William Stein committed
2158

2159 2160 2161
    def analyse_types(self, env):
        pass

William Stein's avatar
William Stein committed
2162

2163
class TempNode(ExprNode):
2164 2165 2166 2167 2168 2169 2170
    # Node created during analyse_types phase
    # of some nodes to hold a temporary value.
    #
    # Note: One must call "allocate" and "release" on
    # the node during code generation to get/release the temp.
    # This is because the temp result is often used outside of
    # the regular cycle.
2171 2172

    subexprs = []
2173

2174
    def __init__(self, pos, type, env=None):
William Stein's avatar
William Stein committed
2175 2176 2177 2178 2179
        ExprNode.__init__(self, pos)
        self.type = type
        if type.is_pyobject:
            self.result_ctype = py_object_type
        self.is_temp = 1
2180

2181 2182
    def analyse_types(self, env):
        return self.type
2183

2184 2185 2186
    def analyse_target_declaration(self, env):
        pass

William Stein's avatar
William Stein committed
2187 2188 2189
    def generate_result_code(self, code):
        pass

2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206
    def allocate(self, code):
        self.temp_cname = code.funcstate.allocate_temp(self.type, manage_ref=True)

    def release(self, code):
        code.funcstate.release_temp(self.temp_cname)
        self.temp_cname = None

    def result(self):
        try:
            return self.temp_cname
        except:
            assert False, "Remember to call allocate/release on TempNode"
            raise

    # Do not participate in normal temp alloc/dealloc:
    def allocate_temp_result(self, code):
        pass
2207

2208 2209
    def release_temp_result(self, code):
        pass
William Stein's avatar
William Stein committed
2210 2211 2212

class PyTempNode(TempNode):
    #  TempNode holding a Python value.
2213

William Stein's avatar
William Stein committed
2214 2215 2216
    def __init__(self, pos, env):
        TempNode.__init__(self, pos, PyrexTypes.py_object_type, env)

2217 2218
class RawCNameExprNode(ExprNode):
    subexprs = []
2219

2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235
    def __init__(self, pos, type=None):
        self.pos = pos
        self.type = type

    def analyse_types(self, env):
        return self.type

    def set_cname(self, cname):
        self.cname = cname

    def result(self):
        return self.cname

    def generate_result_code(self, code):
        pass

William Stein's avatar
William Stein committed
2236

Mark Florisson's avatar
Mark Florisson committed
2237 2238 2239 2240 2241 2242 2243 2244
#-------------------------------------------------------------------
#
#  Parallel nodes (cython.parallel.thread(savailable|id))
#
#-------------------------------------------------------------------

class ParallelThreadsAvailableNode(AtomicExprNode):
    """
Mark Florisson's avatar
Mark Florisson committed
2245 2246
    Note: this is disabled and not a valid directive at this moment

Mark Florisson's avatar
Mark Florisson committed
2247 2248 2249 2250 2251 2252 2253 2254 2255
    Implements cython.parallel.threadsavailable(). If we are called from the
    sequential part of the application, we need to call omp_get_max_threads(),
    and in the parallel part we can just call omp_get_num_threads()
    """

    type = PyrexTypes.c_int_type

    def analyse_types(self, env):
        self.is_temp = True
2256
        # env.add_include_file("omp.h")
Mark Florisson's avatar
Mark Florisson committed
2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
        return self.type

    def generate_result_code(self, code):
        code.putln("#ifdef _OPENMP")
        code.putln("if (omp_in_parallel()) %s = omp_get_max_threads();" %
                                                            self.temp_code)
        code.putln("else %s = omp_get_num_threads();" % self.temp_code)
        code.putln("#else")
        code.putln("%s = 1;" % self.temp_code)
        code.putln("#endif")

    def result(self):
        return self.temp_code


class ParallelThreadIdNode(AtomicExprNode): #, Nodes.ParallelNode):
    """
    Implements cython.parallel.threadid()
    """

    type = PyrexTypes.c_int_type

    def analyse_types(self, env):
        self.is_temp = True
2281
        # env.add_include_file("omp.h")
Mark Florisson's avatar
Mark Florisson committed
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294
        return self.type

    def generate_result_code(self, code):
        code.putln("#ifdef _OPENMP")
        code.putln("%s = omp_get_thread_num();" % self.temp_code)
        code.putln("#else")
        code.putln("%s = 0;" % self.temp_code)
        code.putln("#endif")

    def result(self):
        return self.temp_code


William Stein's avatar
William Stein committed
2295 2296 2297 2298 2299 2300
#-------------------------------------------------------------------
#
#  Trailer nodes
#
#-------------------------------------------------------------------

2301
class IndexNode(ExprNode):
William Stein's avatar
William Stein committed
2302 2303 2304 2305
    #  Sequence indexing.
    #
    #  base     ExprNode
    #  index    ExprNode
2306 2307 2308 2309 2310 2311
    #  indices  [ExprNode]
    #  is_buffer_access boolean Whether this is a buffer access.
    #
    #  indices is used on buffer access, index on non-buffer access.
    #  The former contains a clean list of index parameters, the
    #  latter whatever Python object is needed for index access.
2312 2313 2314
    #
    #  is_fused_index boolean   Whether the index is used to specialize a
    #                           c(p)def function
2315

2316 2317 2318
    subexprs = ['base', 'index', 'indices']
    indices = None

2319 2320
    is_fused_index = False

2321 2322 2323 2324
    # Whether we're assigning to a buffer (in that case it needs to be
    # writable)
    writable_needed = False

2325 2326 2327 2328
    # Whether we are indexing or slicing a memoryviewslice
    memslice_index = False
    memslice_slice = False

2329 2330 2331
    def __init__(self, pos, index, *args, **kw):
        ExprNode.__init__(self, pos, index=index, *args, **kw)
        self._index = index
2332 2333 2334 2335 2336

    def calculate_constant_result(self):
        self.constant_result = \
            self.base.constant_result[self.index.constant_result]

2337 2338 2339 2340 2341 2342 2343
    def compile_time_value(self, denv):
        base = self.base.compile_time_value(denv)
        index = self.index.compile_time_value(denv)
        try:
            return base[index]
        except Exception, e:
            self.compile_time_value_error(e)
2344

William Stein's avatar
William Stein committed
2345 2346
    def is_ephemeral(self):
        return self.base.is_ephemeral()
2347

2348
    def is_simple(self):
2349
        if self.is_buffer_access or self.memslice_index:
2350
            return False
2351 2352 2353
        elif self.memslice_slice:
            return True

2354 2355 2356 2357
        base = self.base
        return (base.is_simple() and self.index.is_simple()
                and base.type and (base.type.is_ptr or base.type.is_array))

William Stein's avatar
William Stein committed
2358 2359
    def analyse_target_declaration(self, env):
        pass
2360

2361 2362 2363
    def analyse_as_type(self, env):
        base_type = self.base.analyse_as_type(env)
        if base_type and not base_type.is_pyobject:
2364
            if base_type.is_cpp_class:
2365
                if isinstance(self.index, TupleNode):
2366 2367 2368 2369 2370
                    template_values = self.index.args
                else:
                    template_values = [self.index]
                import Nodes
                type_node = Nodes.TemplatedTypeNode(
2371 2372
                    pos = self.pos,
                    positional_args = template_values,
2373 2374 2375 2376
                    keyword_args = None)
                return type_node.analyse(env, base_type = base_type)
            else:
                return PyrexTypes.CArrayType(base_type, int(self.index.compile_time_value(env)))
2377
        return None
2378

Robert Bradshaw's avatar
Robert Bradshaw committed
2379
    def type_dependencies(self, env):
2380
        return self.base.type_dependencies(env) + self.index.type_dependencies(env)
2381

2382
    def infer_type(self, env):
2383 2384 2385 2386
        base_type = self.base.infer_type(env)
        if isinstance(self.index, SliceNode):
            # slicing!
            if base_type.is_string:
2387
                # sliced C strings must coerce to Python
2388
                return bytes_type
2389 2390 2391
            elif base_type in (unicode_type, bytes_type, str_type, list_type, tuple_type):
                # slicing these returns the same type
                return base_type
2392
            else:
2393 2394 2395
                # TODO: Handle buffers (hopefully without too much redundancy).
                return py_object_type

2396 2397
        index_type = self.index.infer_type(env)
        if index_type and index_type.is_int or isinstance(self.index, (IntNode, LongNode)):
2398 2399
            # indexing!
            if base_type is unicode_type:
2400 2401 2402
                # Py_UCS4 will automatically coerce to a unicode string
                # if required, so this is safe.  We only infer Py_UCS4
                # when the index is a C integer type.  Otherwise, we may
2403 2404 2405 2406
                # need to use normal Python item access, in which case
                # it's faster to return the one-char unicode string than
                # to receive it, throw it away, and potentially rebuild it
                # on a subsequent PyObject coercion.
2407
                return PyrexTypes.c_py_ucs4_type
2408 2409 2410
            elif base_type is str_type:
                # always returns str - Py2: bytes, Py3: unicode
                return base_type
2411 2412 2413 2414 2415 2416
            elif isinstance(self.base, BytesNode):
                #if env.global_scope().context.language_level >= 3:
                #    # infering 'char' can be made to work in Python 3 mode
                #    return PyrexTypes.c_char_type
                # Py2/3 return different types on indexing bytes objects
                return py_object_type
2417 2418
            elif base_type.is_ptr or base_type.is_array:
                return base_type.base_type
2419

2420
        # may be slicing or indexing, we don't know
2421 2422
        if base_type in (unicode_type, str_type):
            # these types always returns their own type on Python indexing/slicing
2423
            return base_type
2424 2425 2426
        else:
            # TODO: Handle buffers (hopefully without too much redundancy).
            return py_object_type
2427

William Stein's avatar
William Stein committed
2428
    def analyse_types(self, env):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2429
        self.analyse_base_and_index_types(env, getting = 1)
2430

Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2431 2432
    def analyse_target_types(self, env):
        self.analyse_base_and_index_types(env, setting = 1)
2433

2434
    def analyse_base_and_index_types(self, env, getting = 0, setting = 0, analyse_base = True):
2435 2436 2437
        # Note: This might be cleaned up by having IndexNode
        # parsed in a saner way and only construct the tuple if
        # needed.
2438 2439 2440 2441

        # Note that this function must leave IndexNode in a cloneable state.
        # For buffers, self.index is packed out on the initial analysis, and
        # when cloning self.indices is copied.
2442 2443
        self.is_buffer_access = False

2444
        # a[...] = b
2445
        self.is_memoryviewslice_access = False
2446 2447 2448 2449
        # incomplete indexing, Ellipsis indexing or slicing
        self.memslice_slice = False
        # integer indexing
        self.memslice_index = False
2450

2451 2452 2453
        if analyse_base:
            self.base.analyse_types(env)

2454 2455 2456 2457 2458
        if self.base.type.is_error:
            # Do not visit child tree if base is undeclared to avoid confusing
            # error messages
            self.type = PyrexTypes.error_type
            return
2459

2460
        is_slice = isinstance(self.index, SliceNode)
2461

2462
        # Potentially overflowing index value.
2463
        if not is_slice and isinstance(self.index, IntNode) and Utils.long_literal(self.index.value):
2464
            self.index = self.index.coerce_to_pyobject(env)
2465

2466 2467
        is_memslice = self.base.type.is_memoryviewslice

2468
        # Handle the case where base is a literal char* (and we expect a string, not an int)
2469
        if not is_memslice and (isinstance(self.base, BytesNode) or is_slice):
Robert Bradshaw's avatar
Robert Bradshaw committed
2470
            if self.base.type.is_string or not (self.base.type.is_ptr or self.base.type.is_array):
2471
                self.base = self.base.coerce_to_pyobject(env)
2472 2473 2474

        skip_child_analysis = False
        buffer_access = False
Mark Florisson's avatar
Mark Florisson committed
2475 2476
        memoryviewslice_access = False

2477 2478 2479 2480 2481 2482 2483
        if self.indices:
            indices = self.indices
        elif isinstance(self.index, TupleNode):
            indices = self.index.args
        else:
            indices = [self.index]

2484
        if (is_memslice and not self.indices and
Mark Florisson's avatar
Mark Florisson committed
2485
                isinstance(self.index, EllipsisNode)):
2486
            # Memoryviewslice copying
Mark Florisson's avatar
Mark Florisson committed
2487
            memoryviewslice_access = True
2488 2489 2490 2491 2492 2493

        elif is_memslice:
            # memoryviewslice indexing or slicing
            import MemoryView

            skip_child_analysis = True
2494 2495
            have_slices, indices = MemoryView.unellipsify(indices,
                                                          self.base.type.ndim)
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
            self.memslice_index = len(indices) == self.base.type.ndim
            axes = []

            index_type = PyrexTypes.c_py_ssize_t_type
            new_indices = []

            if len(indices) > self.base.type.ndim:
                self.type = error_type
                return error(indices[self.base.type.ndim].pos,
                             "Too many indices specified for type %s" %
                                                        self.base.type)

            suboffsets_dim = -1
            for i, index in enumerate(indices[:]):
                index.analyse_types(env)
                access, packing = self.base.type.axes[i]
                if isinstance(index, SliceNode):
                    suboffsets_dim = i
                    self.memslice_slice = True
2515 2516
                    if index.step.is_none:
                        axes.append((access, packing))
2517 2518
                    else:
                        axes.append((access, 'strided'))
2519 2520 2521 2522 2523 2524

                    # Coerce start, stop and step to temps of the right type
                    for attr in ('start', 'stop', 'step'):
                        value = getattr(index, attr)
                        if not value.is_none:
                            value = value.coerce_to(index_type, env)
2525
                            #value = value.coerce_to_temp(env)
2526 2527 2528 2529 2530
                            setattr(index, attr, value)
                            new_indices.append(value)

                elif index.type.is_int:
                    self.memslice_index = True
2531
                    index = index.coerce_to(index_type, env)
2532 2533 2534
                    indices[i] = index
                    new_indices.append(index)

2535
                    if access in ('ptr', 'generic') and i != 0 and have_slices:
2536 2537 2538 2539 2540 2541
                        self.type = error_type
                        return error(index.pos,
                                     "Indexing of non-leading indirect or generic "
                                     "dimensions not supported yet, "
                                     "try slicing with i:i+1")

2542
                else:
2543 2544
                    self.type = error_type
                    return error(index.pos, "Invalid index for memoryview specified")
2545

2546 2547
            self.memslice_index = self.memslice_index and not self.memslice_slice
            self.original_indices = indices
2548 2549
            # All indices with all start/stop/step for slices.
            # We need to keep this around
2550 2551
            self.indices = new_indices

2552 2553
            self.env = env

2554 2555
        elif self.base.type.is_buffer:
            # Buffer indexing
2556
            if len(indices) == self.base.type.ndim:
2557 2558 2559 2560 2561 2562
                buffer_access = True
                skip_child_analysis = True
                for x in indices:
                    x.analyse_types(env)
                    if not x.type.is_int:
                        buffer_access = False
2563

2564
            if buffer_access and not self.base.type.is_memoryviewslice:
Robert Bradshaw's avatar
Robert Bradshaw committed
2565
                assert hasattr(self.base, "entry") # Must be a NameNode-like node
2566

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
2567 2568 2569
        # On cloning, indices is cloned. Otherwise, unpack index into indices
        assert not (buffer_access and isinstance(self.index, CloneNode))

2570 2571
        self.nogil = env.nogil

2572
        if buffer_access or self.memslice_index:
2573 2574 2575
            if self.base.type.is_memoryviewslice and not self.base.is_name:
                self.base = self.base.coerce_to_temp(env)

2576
            self.indices = indices
2577
            self.index = None
2578 2579
            self.type = self.base.type.dtype
            self.is_buffer_access = True
2580
            self.buffer_type = self.base.type #self.base.entry.type
2581 2582

            if getting and self.type.is_pyobject:
2583
                self.is_temp = True
2584 2585

            if setting and self.base.type.is_memoryviewslice:
2586
                self.base.type.writable_needed = True
2587
            elif setting:
2588 2589 2590
                if not self.base.entry.type.writable:
                    error(self.pos, "Writing to readonly buffer")
                else:
2591
                    self.writable_needed = True
2592
                    if self.base.type.is_buffer:
2593
                        self.base.entry.buffer_aux.writable_needed = True
2594

Mark Florisson's avatar
Mark Florisson committed
2595 2596 2597 2598 2599
        elif memoryviewslice_access:
            self.type = self.base.type
            self.is_memoryviewslice_access = True
            if getting:
                error(self.pos, "memoryviews currently support setting only.")
2600

2601
        elif self.memslice_slice:
2602
            self.index = None
2603
            self.is_temp = True
2604
            self.use_managed_ref = True
2605 2606 2607
            self.type = PyrexTypes.MemoryViewSliceType(
                            self.base.type.dtype, axes)

2608
        else:
2609
            base_type = self.base.type
2610 2611 2612 2613 2614 2615 2616 2617 2618

            fused_index_operation = base_type.is_cfunction and base_type.is_fused
            if not fused_index_operation:
                if isinstance(self.index, TupleNode):
                    self.index.analyse_types(env, skip_children=skip_child_analysis)
                elif not skip_child_analysis:
                    self.index.analyse_types(env)
                self.original_index_type = self.index.type

Stefan Behnel's avatar
Stefan Behnel committed
2619 2620
            if base_type.is_unicode_char:
                # we infer Py_UNICODE/Py_UCS4 for unicode strings in some
2621 2622 2623 2624 2625 2626 2627
                # cases, but indexing must still work for them
                if self.index.constant_result in (0, -1):
                    # FIXME: we know that this node is redundant -
                    # currently, this needs to get handled in Optimize.py
                    pass
                self.base = self.base.coerce_to_pyobject(env)
                base_type = self.base.type
2628
            if base_type.is_pyobject:
2629
                if self.index.type.is_int:
2630
                    if (not setting
2631
                        and (base_type in (list_type, tuple_type, unicode_type))
2632 2633 2634
                        and (not self.index.type.signed
                             or not env.directives['wraparound']
                             or isinstance(self.index, IntNode) and int(self.index.value) >= 0)
2635 2636 2637 2638
                        and not env.directives['boundscheck']):
                        self.is_temp = 0
                    else:
                        self.is_temp = 1
2639 2640 2641
                    self.index = self.index.coerce_to(PyrexTypes.c_py_ssize_t_type, env).coerce_to_simple(env)
                else:
                    self.index = self.index.coerce_to_pyobject(env)
2642
                    self.is_temp = 1
2643
                if self.index.type.is_int and base_type is unicode_type:
Stefan Behnel's avatar
Stefan Behnel committed
2644
                    # Py_UNICODE/Py_UCS4 will automatically coerce to a unicode string
2645
                    # if required, so this is fast and safe
2646
                    self.type = PyrexTypes.c_py_ucs4_type
2647 2648
                elif is_slice and base_type in (bytes_type, str_type, unicode_type, list_type, tuple_type):
                    self.type = base_type
2649 2650
                else:
                    self.type = py_object_type
William Stein's avatar
William Stein committed
2651
            else:
2652 2653
                if base_type.is_ptr or base_type.is_array:
                    self.type = base_type.base_type
2654 2655 2656
                    if is_slice:
                        self.type = base_type
                    elif self.index.type.is_pyobject:
Robert Bradshaw's avatar
Robert Bradshaw committed
2657 2658
                        self.index = self.index.coerce_to(
                            PyrexTypes.c_py_ssize_t_type, env)
2659
                    elif not self.index.type.is_int:
Robert Bradshaw's avatar
Robert Bradshaw committed
2660 2661 2662
                        error(self.pos,
                            "Invalid index type '%s'" %
                                self.index.type)
2663
                elif base_type.is_cpp_class:
2664
                    function = env.lookup_operator("[]", [self.base, self.index])
Robert Bradshaw's avatar
Robert Bradshaw committed
2665
                    if function is None:
2666
                        error(self.pos, "Indexing '%s' not supported for index type '%s'" % (base_type, self.index.type))
Robert Bradshaw's avatar
Robert Bradshaw committed
2667 2668 2669 2670 2671 2672 2673 2674 2675
                        self.type = PyrexTypes.error_type
                        self.result_code = "<error>"
                        return
                    func_type = function.type
                    if func_type.is_ptr:
                        func_type = func_type.base_type
                    self.index = self.index.coerce_to(func_type.args[0].type, env)
                    self.type = func_type.return_type
                    if setting and not func_type.return_type.is_reference:
Robert Bradshaw's avatar
Robert Bradshaw committed
2676
                        error(self.pos, "Can't set non-reference result '%s'" % self.type)
2677 2678
                elif fused_index_operation:
                    self.parse_indexed_fused_cdef(env)
2679 2680 2681
                else:
                    error(self.pos,
                        "Attempting to index non-array type '%s'" %
2682
                            base_type)
2683
                    self.type = PyrexTypes.error_type
Stefan Behnel's avatar
Stefan Behnel committed
2684

2685 2686 2687 2688 2689 2690 2691 2692 2693
    def parse_indexed_fused_cdef(self, env):
        """
        Interpret fused_cdef_func[specific_type1, ...]

        Note that if this method is called, we are an indexed cdef function
        with fused argument types, and this IndexNode will be replaced by the
        NameNode with specific entry just after analysis of expressions by
        AnalyseExpressionsTransform.
        """
2694
        self.type = PyrexTypes.error_type
2695

2696 2697
        self.is_fused_index = True

Mark Florisson's avatar
Mark Florisson committed
2698
        base_type = self.base.type
2699 2700 2701 2702 2703 2704 2705 2706 2707
        specific_types = []
        positions = []

        if self.index.is_name:
            positions.append(self.index.pos)
            specific_types.append(self.index.analyse_as_type(env))
        elif isinstance(self.index, TupleNode):
            for arg in self.index.args:
                positions.append(arg.pos)
2708 2709
                specific_type = arg.analyse_as_type(env)
                specific_types.append(specific_type)
2710
        else:
2711
            specific_types = [False]
2712

2713 2714 2715 2716
        if not Utils.all(specific_types):
            self.index.analyse_types(env)

            if not self.base.entry.as_variable:
2717
                error(self.pos, "Can only index fused functions with types")
2718 2719
            else:
                # A cpdef function indexed with Python objects
2720 2721
                self.base.entry = self.entry = self.base.entry.as_variable
                self.base.type = self.type = self.entry.type
2722

2723 2724 2725 2726 2727 2728
                self.base.is_temp = True
                self.is_temp = True

                self.entry.used = True

            self.is_fused_index = False
2729 2730
            return

2731 2732
        fused_types = base_type.get_fused_types()
        if len(specific_types) > len(fused_types):
2733 2734 2735 2736 2737
            return error(self.pos, "Too many types specified")
        elif len(specific_types) < len(fused_types):
            t = fused_types[len(specific_types)]
            return error(self.pos, "Not enough types specified to specialize "
                                   "the function, %s is still fused" % t)
2738 2739 2740 2741 2742 2743 2744

        # See if our index types form valid specializations
        for pos, specific_type, fused_type in zip(positions,
                                                  specific_types,
                                                  fused_types):
            if not Utils.any([specific_type.same_as(t)
                                  for t in fused_type.types]):
2745
                return error(pos, "Type not in fused type")
2746 2747 2748 2749 2750 2751 2752

            if specific_type is None or specific_type.is_error:
                return

        fused_to_specific = dict(zip(fused_types, specific_types))
        type = base_type.specialize(fused_to_specific)

2753 2754 2755 2756 2757
        if type.is_fused:
            # Only partially specific, this is invalid
            error(self.pos,
                  "Index operation makes function only partially specific")
        else:
2758 2759 2760 2761
            # Fully specific, find the signature with the specialized entry
            for signature in self.base.type.get_all_specific_function_types():
                if type.same_as(signature):
                    self.type = signature
Mark Florisson's avatar
Mark Florisson committed
2762 2763 2764 2765 2766

                    if self.base.is_attribute:
                        # Pretend to be a normal attribute, for cdef extension
                        # methods
                        self.entry = signature.entry
2767
                        self.is_attribute = True
Mark Florisson's avatar
Mark Florisson committed
2768
                        self.obj = self.base.obj
2769 2770 2771 2772

                    self.type.entry.used = True
                    self.base.type = signature
                    self.base.entry = signature.entry
Mark Florisson's avatar
Mark Florisson committed
2773

2774 2775
                    break
            else:
Mark Florisson's avatar
Mark Florisson committed
2776 2777
                # This is a bug
                raise InternalError("Couldn't find the right signature")
2778

2779 2780
    gil_message = "Indexing Python object"

2781
    def nogil_check(self, env):
2782 2783
        if self.is_buffer_access or self.memslice_index or self.memslice_slice:
            if not self.memslice_slice and env.directives['boundscheck']:
2784 2785 2786 2787 2788
                error(self.pos, "Cannot check buffer index bounds without gil; use boundscheck(False) directive")
                return
            elif self.type.is_pyobject:
                error(self.pos, "Cannot access buffer with object dtype without gil")
                return
2789
        super(IndexNode, self).nogil_check(env)
2790 2791


William Stein's avatar
William Stein committed
2792
    def check_const_addr(self):
2793
        return self.base.check_const_addr() and self.index.check_const()
2794

William Stein's avatar
William Stein committed
2795 2796
    def is_lvalue(self):
        return 1
Dag Sverre Seljebotn's avatar
merge  
Dag Sverre Seljebotn committed
2797

William Stein's avatar
William Stein committed
2798
    def calculate_result_code(self):
2799
        if self.is_buffer_access:
2800
            return "(*%s)" % self.buffer_ptr_code
2801 2802 2803 2804
        elif self.base.type is list_type:
            return "PyList_GET_ITEM(%s, %s)" % (self.base.result(), self.index.result())
        elif self.base.type is tuple_type:
            return "PyTuple_GET_ITEM(%s, %s)" % (self.base.result(), self.index.result())
Stefan Behnel's avatar
Stefan Behnel committed
2805
        elif self.base.type is unicode_type and self.type.is_unicode_char:
2806
            return "__Pyx_PyUnicode_READ_CHAR(%s, %s)" % (self.base.result(), self.index.result())
2807 2808
        elif (self.type.is_ptr or self.type.is_array) and self.type == self.base.type:
            error(self.pos, "Invalid use of pointer slice")
2809 2810
        else:
            return "(%s[%s])" % (
2811
                self.base.result(), self.index.result())
2812

2813
    def extra_index_params(self):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2814 2815
        if self.index.type.is_int:
            if self.original_index_type.signed:
2816
                size_adjustment = ""
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2817
            else:
2818 2819
                size_adjustment = "+1"
            return ", sizeof(%s)%s, %s" % (self.original_index_type.declaration_code(""), size_adjustment, self.original_index_type.to_py_function)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2820 2821
        else:
            return ""
2822 2823 2824

    def generate_subexpr_evaluation_code(self, code):
        self.base.generate_evaluation_code(code)
2825
        if not self.indices:
2826 2827
            self.index.generate_evaluation_code(code)
        else:
2828 2829
            for i in self.indices:
                i.generate_evaluation_code(code)
2830

2831 2832
    def generate_subexpr_disposal_code(self, code):
        self.base.generate_disposal_code(code)
2833
        if not self.indices:
2834 2835
            self.index.generate_disposal_code(code)
        else:
2836 2837
            for i in self.indices:
                i.generate_disposal_code(code)
2838

2839 2840 2841 2842 2843 2844 2845 2846
    def free_subexpr_temps(self, code):
        self.base.free_temps(code)
        if not self.indices:
            self.index.free_temps(code)
        else:
            for i in self.indices:
                i.free_temps(code)

William Stein's avatar
William Stein committed
2847
    def generate_result_code(self, code):
2848
        if self.is_buffer_access or self.memslice_index:
2849 2850
            if code.globalstate.directives['nonecheck']:
                self.put_nonecheck(code)
2851
            buffer_entry, self.buffer_ptr_code = self.buffer_lookup_code(code)
2852 2853 2854
            if self.type.is_pyobject:
                # is_temp is True, so must pull out value and incref it.
                code.putln("%s = *%s;" % (self.result(), self.buffer_ptr_code))
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
2855
                code.putln("__Pyx_INCREF((PyObject*)%s);" % self.result())
2856 2857 2858 2859

        elif self.memslice_slice:
            self.put_memoryviewslice_slice_code(code)

2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
        elif self.is_temp:
            if self.type.is_pyobject:
                if self.index.type.is_int:
                    index_code = self.index.result()
                    if self.base.type is list_type:
                        function = "__Pyx_GetItemInt_List"
                    elif self.base.type is tuple_type:
                        function = "__Pyx_GetItemInt_Tuple"
                    else:
                        function = "__Pyx_GetItemInt"
                    code.globalstate.use_utility_code(getitem_int_utility_code)
2871
                else:
2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887
                    index_code = self.index.py_result()
                    if self.base.type is dict_type:
                        function = "__Pyx_PyDict_GetItem"
                        code.globalstate.use_utility_code(getitem_dict_utility_code)
                    else:
                        function = "PyObject_GetItem"
                code.putln(
                    "%s = %s(%s, %s%s); if (!%s) %s" % (
                        self.result(),
                        function,
                        self.base.py_result(),
                        index_code,
                        self.extra_index_params(),
                        self.result(),
                        code.error_goto(self.pos)))
                code.put_gotref(self.py_result())
Stefan Behnel's avatar
Stefan Behnel committed
2888
            elif self.type.is_unicode_char and self.base.type is unicode_type:
2889 2890 2891
                assert self.index.type.is_int
                index_code = self.index.result()
                function = "__Pyx_GetItemInt_Unicode"
2892 2893
                code.globalstate.use_utility_code(getitem_int_pyunicode_utility_code)
                code.putln(
2894
                    "%s = %s(%s, %s%s); if (unlikely(%s == (Py_UCS4)-1)) %s;" % (
2895 2896 2897 2898 2899 2900 2901
                        self.result(),
                        function,
                        self.base.py_result(),
                        index_code,
                        self.extra_index_params(),
                        self.result(),
                        code.error_goto(self.pos)))
2902

Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2903 2904 2905
    def generate_setitem_code(self, value_code, code):
        if self.index.type.is_int:
            function = "__Pyx_SetItemInt"
2906
            index_code = self.index.result()
2907
            code.globalstate.use_utility_code(setitem_int_utility_code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2908 2909
        else:
            index_code = self.index.py_result()
2910 2911
            if self.base.type is dict_type:
                function = "PyDict_SetItem"
Craig Citro's avatar
Craig Citro committed
2912
            # It would seem that we could specialized lists/tuples, but that
2913 2914 2915 2916 2917 2918
            # shouldn't happen here.
            # Both PyList_SetItem PyTuple_SetItem and a Py_ssize_t as input,
            # not a PyObject*, and bad conversion here would give the wrong
            # exception. Also, tuples are supposed to be immutable, and raise
            # TypeErrors when trying to set their entries (PyTuple_SetItem
            # is for creating new tuples from).
2919 2920
            else:
                function = "PyObject_SetItem"
2921
        code.putln(
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2922 2923
            "if (%s(%s, %s, %s%s) < 0) %s" % (
                function,
2924
                self.base.py_result(),
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2925 2926
                index_code,
                value_code,
2927
                self.extra_index_params(),
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2928
                code.error_goto(self.pos)))
2929

2930
    def generate_memoryviewslice_copy_code(self, rhs, code, op=""):
2931 2932 2933 2934 2935 2936 2937
        assert isinstance(self.index, EllipsisNode)
        import MemoryView
        util_code = MemoryView.CopyContentsFuncUtilCode(rhs.type, self.type)
        func_name = util_code.copy_contents_name
        code.putln(code.error_goto_if_neg("%s(&%s, &%s)" % (func_name, rhs.result(), self.base.result()), self.pos))
        code.globalstate.use_utility_code(util_code)

2938 2939
    def generate_buffer_setitem_code(self, rhs, code, op=""):
        # Used from generate_assignment_code and InPlaceAssignmentNode
2940
        if code.globalstate.directives['nonecheck'] and not self.memslice_index:
2941
            self.put_nonecheck(code)
2942 2943 2944

        buffer_entry, ptrexpr = self.buffer_lookup_code(code)

2945 2946 2947
        if self.buffer_type.dtype.is_pyobject:
            # Must manage refcounts. Decref what is already there
            # and incref what we put in.
2948 2949
            ptr = code.funcstate.allocate_temp(buffer_entry.buf_ptr_type,
                                               manage_ref=False)
2950
            rhs_code = rhs.result()
2951
            code.putln("%s = %s;" % (ptr, ptrexpr))
2952
            code.put_gotref("*%s" % ptr)
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
2953
            code.putln("__Pyx_DECREF(*%s); __Pyx_INCREF(%s);" % (
2954 2955 2956
                ptr, rhs_code
                ))
            code.putln("*%s %s= %s;" % (ptr, op, rhs_code))
2957
            code.put_giveref("*%s" % ptr)
2958
            code.funcstate.release_temp(ptr)
2959
        else:
2960
            # Simple case
2961
            code.putln("*%s %s= %s;" % (ptrexpr, op, rhs.result()))
2962

William Stein's avatar
William Stein committed
2963 2964
    def generate_assignment_code(self, rhs, code):
        self.generate_subexpr_evaluation_code(code)
2965
        if self.is_buffer_access or self.memslice_index:
2966
            self.generate_buffer_setitem_code(rhs, code)
2967 2968 2969
        elif self.memslice_slice:
            error(rhs.pos, "Slice assignment not supported yet")
            #self.generate_memoryviewslice_setslice_code(rhs, code)
2970
        elif self.is_memoryviewslice_access:
2971
            self.generate_memoryviewslice_copy_code(rhs, code)
2972
        elif self.type.is_pyobject:
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2973
            self.generate_setitem_code(rhs.py_result(), code)
William Stein's avatar
William Stein committed
2974 2975 2976
        else:
            code.putln(
                "%s = %s;" % (
2977
                    self.result(), rhs.result()))
2978
        self.generate_subexpr_disposal_code(code)
2979
        self.free_subexpr_temps(code)
William Stein's avatar
William Stein committed
2980
        rhs.generate_disposal_code(code)
2981
        rhs.free_temps(code)
2982

William Stein's avatar
William Stein committed
2983 2984
    def generate_deletion_code(self, code):
        self.generate_subexpr_evaluation_code(code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2985 2986
        #if self.type.is_pyobject:
        if self.index.type.is_int:
2987
            function = "__Pyx_DelItemInt"
2988
            index_code = self.index.result()
2989
            code.globalstate.use_utility_code(delitem_int_utility_code)
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2990 2991
        else:
            index_code = self.index.py_result()
2992 2993 2994 2995
            if self.base.type is dict_type:
                function = "PyDict_DelItem"
            else:
                function = "PyObject_DelItem"
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2996
        code.putln(
2997
            "if (%s(%s, %s%s) < 0) %s" % (
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
2998
                function,
William Stein's avatar
William Stein committed
2999
                self.base.py_result(),
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3000
                index_code,
3001
                self.extra_index_params(),
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
3002
                code.error_goto(self.pos)))
William Stein's avatar
William Stein committed
3003
        self.generate_subexpr_disposal_code(code)
3004
        self.free_subexpr_temps(code)
3005

3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
    def buffer_entry(self):
        import Buffer, MemoryView

        if self.base.is_name:
            entry = self.base.entry
        else:
            assert self.base.is_temp
            cname = self.base.result()
            entry = Symtab.Entry(cname, cname, self.base.type, self.base.pos)

        if entry.type.is_buffer:
            buffer_entry = Buffer.BufferEntry(entry)
        else:
            buffer_entry = MemoryView.MemoryViewSliceBufferEntry(entry)

        return buffer_entry

3023
    def buffer_lookup_code(self, code):
3024
        # Assign indices to temps
3025 3026 3027
        index_temps = [code.funcstate.allocate_temp(i.type, manage_ref=False)
                           for i in self.indices]

3028
        for temp, index in zip(index_temps, self.indices):
3029
            code.putln("%s = %s;" % (temp, index.result()))
3030

3031
        # Generate buffer access code using these temps
3032
        import Buffer, MemoryView
3033

3034
        buffer_entry = self.buffer_entry()
3035

3036
        if buffer_entry.type.is_buffer:
3037
            negative_indices = buffer_entry.type.negative_indices
3038 3039 3040
        else:
            negative_indices = Buffer.buffer_defaults['negative_indices']

3041 3042 3043 3044 3045 3046 3047
        return buffer_entry, Buffer.put_buffer_lookup_code(
               entry=buffer_entry,
               index_signeds=[i.type.signed for i in self.indices],
               index_cnames=index_temps,
               directives=code.globalstate.directives,
               pos=self.pos, code=code,
               negative_indices=negative_indices)
William Stein's avatar
William Stein committed
3048

3049 3050
    def put_memoryviewslice_slice_code(self, code):
        buffer_entry = self.buffer_entry()
3051
        have_gil = not self.in_nogil_context
3052 3053
        buffer_entry.generate_buffer_slice_code(code,
                                                self.original_indices,
3054
                                                self.result(),
3055
                                                have_gil=have_gil)
William Stein's avatar
William Stein committed
3056

3057 3058 3059 3060 3061 3062 3063
    def put_nonecheck(self, code):
        code.globalstate.use_utility_code(raise_noneindex_error_utility_code)
        code.putln("if (%s) {" % code.unlikely("%s == Py_None") % self.base.result_as(PyrexTypes.py_object_type))
        code.putln("__Pyx_RaiseNoneIndexingError();")
        code.putln(code.error_goto(self.pos))
        code.putln("}")

3064

3065
class SliceIndexNode(ExprNode):
William Stein's avatar
William Stein committed
3066 3067 3068 3069 3070
    #  2-element slice indexing
    #
    #  base      ExprNode
    #  start     ExprNode or None
    #  stop      ExprNode or None
3071

William Stein's avatar
William Stein committed
3072
    subexprs = ['base', 'start', 'stop']
3073

3074 3075 3076 3077 3078 3079 3080
    def infer_type(self, env):
        base_type = self.base.infer_type(env)
        if base_type.is_string:
            return bytes_type
        elif base_type in (bytes_type, str_type, unicode_type,
                           list_type, tuple_type):
            return base_type
3081 3082
        elif base_type.is_ptr or base_type.is_array:
            return PyrexTypes.c_array_type(base_type.base_type, None)
3083 3084
        return py_object_type

3085 3086 3087 3088
    def calculate_constant_result(self):
        self.constant_result = self.base.constant_result[
            self.start.constant_result : self.stop.constant_result]

3089 3090
    def compile_time_value(self, denv):
        base = self.base.compile_time_value(denv)
3091 3092 3093 3094 3095 3096 3097 3098
        if self.start is None:
            start = 0
        else:
            start = self.start.compile_time_value(denv)
        if self.stop is None:
            stop = None
        else:
            stop = self.stop.compile_time_value(denv)
3099 3100 3101 3102
        try:
            return base[start:stop]
        except Exception, e:
            self.compile_time_value_error(e)
3103

William Stein's avatar
William Stein committed
3104 3105
    def analyse_target_declaration(self, env):
        pass
3106

3107
    def analyse_target_types(self, env):
3108
        self.analyse_types(env, getting=False)
3109
        # when assigning, we must accept any Python type
3110 3111
        if self.type.is_pyobject:
            self.type = py_object_type
William Stein's avatar
William Stein committed
3112

3113
    def analyse_types(self, env, getting=True):
William Stein's avatar
William Stein committed
3114
        self.base.analyse_types(env)
3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134

        if self.base.type.is_memoryviewslice:
            # Gross hack here! But we do not know the type until this point,
            # and we cannot create and return a new node. So we change the
            # type...
            none_node = NoneNode(self.pos)
            index = SliceNode(self.pos,
                              start=self.start or none_node,
                              stop=self.stop or none_node,
                              step=none_node)
            del self.start
            del self.stop
            self.index = index
            self.__class__ = IndexNode
            self.analyse_base_and_index_types(env,
                                              getting=getting,
                                              setting=not getting,
                                              analyse_base=False)
            return

William Stein's avatar
William Stein committed
3135 3136 3137 3138
        if self.start:
            self.start.analyse_types(env)
        if self.stop:
            self.stop.analyse_types(env)
3139 3140 3141
        base_type = self.base.type
        if base_type.is_string:
            self.type = bytes_type
3142 3143 3144
        elif base_type.is_ptr:
            self.type = base_type
        elif base_type.is_array:
3145 3146 3147
            # we need a ptr type here instead of an array type, as
            # array types can result in invalid type casts in the C
            # code
3148
            self.type = PyrexTypes.CPtrType(base_type.base_type)
3149 3150 3151
        else:
            self.base = self.base.coerce_to_pyobject(env)
            self.type = py_object_type
3152 3153 3154
        if base_type.is_builtin_type:
            # slicing builtin types returns something of the same type
            self.type = base_type
3155
        c_int = PyrexTypes.c_py_ssize_t_type
William Stein's avatar
William Stein committed
3156 3157 3158 3159 3160
        if self.start:
            self.start = self.start.coerce_to(c_int, env)
        if self.stop:
            self.stop = self.stop.coerce_to(c_int, env)
        self.is_temp = 1
3161

3162
    nogil_check = Node.gil_error
3163 3164
    gil_message = "Slicing Python object"

William Stein's avatar
William Stein committed
3165
    def generate_result_code(self, code):
3166 3167 3168 3169
        if not self.type.is_pyobject:
            error(self.pos,
                  "Slicing is not currently supported for '%s'." % self.type)
            return
Robert Bradshaw's avatar
Robert Bradshaw committed
3170 3171 3172
        if self.base.type.is_string:
            if self.stop is None:
                code.putln(
3173
                    "%s = PyBytes_FromString(%s + %s); %s" % (
Robert Bradshaw's avatar
Robert Bradshaw committed
3174 3175 3176 3177 3178 3179
                        self.result(),
                        self.base.result(),
                        self.start_code(),
                        code.error_goto_if_null(self.result(), self.pos)))
            else:
                code.putln(
3180
                    "%s = PyBytes_FromStringAndSize(%s + %s, %s - %s); %s" % (
Robert Bradshaw's avatar
Robert Bradshaw committed
3181 3182 3183 3184 3185 3186 3187 3188
                        self.result(),
                        self.base.result(),
                        self.start_code(),
                        self.stop_code(),
                        self.start_code(),
                        code.error_goto_if_null(self.result(), self.pos)))
        else:
            code.putln(
3189
                "%s = __Pyx_PySequence_GetSlice(%s, %s, %s); %s" % (
Robert Bradshaw's avatar
Robert Bradshaw committed
3190 3191 3192 3193 3194
                    self.result(),
                    self.base.py_result(),
                    self.start_code(),
                    self.stop_code(),
                    code.error_goto_if_null(self.result(), self.pos)))
3195
        code.put_gotref(self.py_result())
3196

William Stein's avatar
William Stein committed
3197 3198
    def generate_assignment_code(self, rhs, code):
        self.generate_subexpr_evaluation_code(code)
3199
        if self.type.is_pyobject:
3200
            code.put_error_if_neg(self.pos,
3201
                "__Pyx_PySequence_SetSlice(%s, %s, %s, %s)" % (
3202 3203 3204
                    self.base.py_result(),
                    self.start_code(),
                    self.stop_code(),
Lisandro Dalcin's avatar
Lisandro Dalcin committed
3205
                    rhs.py_result()))
3206 3207 3208 3209 3210 3211 3212 3213
        else:
            start_offset = ''
            if self.start:
                start_offset = self.start_code()
                if start_offset == '0':
                    start_offset = ''
                else:
                    start_offset += '+'
Stefan Behnel's avatar
Stefan Behnel committed
3214 3215
            if rhs.type.is_array:
                array_length = rhs.type.size
3216
                self.generate_slice_guard_code(code, array_length)
Stefan Behnel's avatar
Stefan Behnel committed
3217
            else:
Stefan Behnel's avatar
Stefan Behnel committed
3218 3219
                error(self.pos,
                      "Slice assignments from pointers are not yet supported.")
Stefan Behnel's avatar
Stefan Behnel committed
3220 3221
                # FIXME: fix the array size according to start/stop
                array_length = self.base.type.size
3222 3223 3224 3225
            for i in range(array_length):
                code.putln("%s[%s%s] = %s[%d];" % (
                        self.base.result(), start_offset, i,
                        rhs.result(), i))
William Stein's avatar
William Stein committed
3226
        self.generate_subexpr_disposal_code(code)
3227
        self.free_subexpr_temps(code)
William Stein's avatar
William Stein committed
3228
        rhs.generate_disposal_code(code)
3229
        rhs.free_temps(code)
William Stein's avatar
William Stein committed
3230 3231

    def generate_deletion_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
3232
        if not self.base.type.is_pyobject:
3233 3234 3235
            error(self.pos,
                  "Deleting slices is only supported for Python types, not '%s'." % self.type)
            return
William Stein's avatar
William Stein committed
3236
        self.generate_subexpr_evaluation_code(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
3237
        code.put_error_if_neg(self.pos,
3238
            "__Pyx_PySequence_DelSlice(%s, %s, %s)" % (
William Stein's avatar
William Stein committed
3239 3240
                self.base.py_result(),
                self.start_code(),
Robert Bradshaw's avatar
Robert Bradshaw committed
3241
                self.stop_code()))
William Stein's avatar
William Stein committed
3242
        self.generate_subexpr_disposal_code(code)
3243
        self.free_subexpr_temps(code)
3244 3245 3246 3247 3248 3249 3250 3251 3252 3253

    def generate_slice_guard_code(self, code, target_size):
        if not self.base.type.is_array:
            return
        slice_size = self.base.type.size
        start = stop = None
        if self.stop:
            stop = self.stop.result()
            try:
                stop = int(stop)
Stefan Behnel's avatar
Stefan Behnel committed
3254
                if stop < 0:
3255
                    slice_size = self.base.type.size + stop
Stefan Behnel's avatar
Stefan Behnel committed
3256 3257
                else:
                    slice_size = stop
3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287
                stop = None
            except ValueError:
                pass
        if self.start:
            start = self.start.result()
            try:
                start = int(start)
                if start < 0:
                    start = self.base.type.size + start
                slice_size -= start
                start = None
            except ValueError:
                pass
        check = None
        if slice_size < 0:
            if target_size > 0:
                error(self.pos, "Assignment to empty slice.")
        elif start is None and stop is None:
            # we know the exact slice length
            if target_size != slice_size:
                error(self.pos, "Assignment to slice of wrong length, expected %d, got %d" % (
                        slice_size, target_size))
        elif start is not None:
            if stop is None:
                stop = slice_size
            check = "(%s)-(%s)" % (stop, start)
        else: # stop is not None:
            check = stop
        if check:
            code.putln("if (unlikely((%s) != %d)) {" % (check, target_size))
3288
            code.putln('PyErr_Format(PyExc_ValueError, "Assignment to slice of wrong length, expected %%"PY_FORMAT_SIZE_T"d, got %%"PY_FORMAT_SIZE_T"d", (Py_ssize_t)%d, (Py_ssize_t)(%s));' % (
3289 3290 3291
                        target_size, check))
            code.putln(code.error_goto(self.pos))
            code.putln("}")
3292

William Stein's avatar
William Stein committed
3293 3294
    def start_code(self):
        if self.start:
3295
            return self.start.result()
William Stein's avatar
William Stein committed
3296 3297
        else:
            return "0"
3298

William Stein's avatar
William Stein committed
3299 3300
    def stop_code(self):
        if self.stop:
3301
            return self.stop.result()
3302 3303
        elif self.base.type.is_array:
            return self.base.type.size
William Stein's avatar
William Stein committed
3304
        else:
3305
            return "PY_SSIZE_T_MAX"
3306

William Stein's avatar
William Stein committed
3307
    def calculate_result_code(self):
3308
        # self.result() is not used, but this method must exist
William Stein's avatar
William Stein committed
3309
        return "<unused>"
3310

William Stein's avatar
William Stein committed
3311

3312
class SliceNode(ExprNode):
William Stein's avatar
William Stein committed
3313 3314 3315 3316 3317
    #  start:stop:step in subscript list
    #
    #  start     ExprNode
    #  stop      ExprNode
    #  step      ExprNode
3318

3319 3320
    subexprs = ['start', 'stop', 'step']

3321 3322
    type = py_object_type
    is_temp = 1
3323 3324

    def calculate_constant_result(self):
3325 3326 3327 3328
        self.constant_result = slice(
            self.start.constant_result,
            self.stop.constant_result,
            self.step.constant_result)
3329

3330 3331
    def compile_time_value(self, denv):
        start = self.start.compile_time_value(denv)
Stefan Behnel's avatar
Stefan Behnel committed
3332 3333
        stop = self.stop.compile_time_value(denv)
        step = self.step.compile_time_value(denv)
3334 3335 3336 3337 3338
        try:
            return slice(start, stop, step)
        except Exception, e:
            self.compile_time_value_error(e)

William Stein's avatar
William Stein committed
3339 3340 3341 3342 3343 3344 3345
    def analyse_types(self, env):
        self.start.analyse_types(env)
        self.stop.analyse_types(env)
        self.step.analyse_types(env)
        self.start = self.start.coerce_to_pyobject(env)
        self.stop = self.stop.coerce_to_pyobject(env)
        self.step = self.step.coerce_to_pyobject(env)
3346 3347 3348
        if self.start.is_literal and self.stop.is_literal and self.step.is_literal:
            self.is_literal = True
            self.is_temp = False
3349 3350 3351

    gil_message = "Constructing Python slice object"

3352 3353 3354
    def calculate_result_code(self):
        return self.result_code

William Stein's avatar
William Stein committed
3355
    def generate_result_code(self, code):
3356 3357 3358 3359 3360
        if self.is_literal:
            self.result_code = code.get_py_const(py_object_type, 'slice_', cleanup_level=2)
            code = code.get_cached_constants_writer()
            code.mark_pos(self.pos)

William Stein's avatar
William Stein committed
3361
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
3362
            "%s = PySlice_New(%s, %s, %s); %s" % (
3363
                self.result(),
3364 3365
                self.start.py_result(),
                self.stop.py_result(),
William Stein's avatar
William Stein committed
3366
                self.step.py_result(),
3367
                code.error_goto_if_null(self.result(), self.pos)))
3368
        code.put_gotref(self.py_result())
3369 3370
        if self.is_literal:
            code.put_giveref(self.py_result())
William Stein's avatar
William Stein committed
3371

3372

3373
class CallNode(ExprNode):
3374

Stefan Behnel's avatar
Stefan Behnel committed
3375 3376 3377
    # allow overriding the default 'may_be_none' behaviour
    may_return_none = None

3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398
    def infer_type(self, env):
        function = self.function
        func_type = function.infer_type(env)
        if isinstance(self.function, NewExprNode):
            return PyrexTypes.CPtrType(self.function.class_type)
        if func_type.is_ptr:
            func_type = func_type.base_type
        if func_type.is_cfunction:
            return func_type.return_type
        elif func_type is type_type:
            if function.is_name and function.entry and function.entry.type:
                result_type = function.entry.type
                if result_type.is_extension_type:
                    return result_type
                elif result_type.is_builtin_type:
                    if function.entry.name == 'float':
                        return PyrexTypes.c_double_type
                    elif function.entry.name in Builtin.types_that_construct_their_instance:
                        return result_type
        return py_object_type

Robert Bradshaw's avatar
Robert Bradshaw committed
3399 3400 3401 3402 3403
    def type_dependencies(self, env):
        # TODO: Update when Danilo's C++ code merged in to handle the
        # the case of function overloading.
        return self.function.type_dependencies(env)

Stefan Behnel's avatar
Stefan Behnel committed
3404 3405 3406 3407 3408
    def may_be_none(self):
        if self.may_return_none is not None:
            return self.may_return_none
        return ExprNode.may_be_none(self)

Robert Bradshaw's avatar
Robert Bradshaw committed
3409 3410 3411 3412 3413 3414
    def analyse_as_type_constructor(self, env):
        type = self.function.analyse_as_type(env)
        if type and type.is_struct_or_union:
            args, kwds = self.explicit_args_kwds()
            items = []
            for arg, member in zip(args, type.scope.var_entries):
3415
                items.append(DictItemNode(pos=arg.pos, key=StringNode(pos=arg.pos, value=member.name), value=arg))
Robert Bradshaw's avatar
Robert Bradshaw committed
3416 3417 3418 3419 3420 3421 3422
            if kwds:
                items += kwds.key_value_pairs
            self.key_value_pairs = items
            self.__class__ = DictNode
            self.analyse_types(env)
            self.coerce_to(type, env)
            return True
3423 3424 3425 3426 3427 3428 3429 3430 3431
        elif type and type.is_cpp_class:
            for arg in self.args:
                arg.analyse_types(env)
            constructor = type.scope.lookup("<init>")
            self.function = RawCNameExprNode(self.function.pos, constructor.type)
            self.function.entry = constructor
            self.function.set_cname(type.declaration_code(""))
            self.analyse_c_function_call(env)
            return True
3432

3433 3434
    def is_lvalue(self):
        return self.type.is_reference
3435

3436
    def nogil_check(self, env):
3437 3438
        func_type = self.function_type()
        if func_type.is_pyobject:
3439
            self.gil_error()
3440
        elif not getattr(func_type, 'nogil', False):
3441
            self.gil_error()
3442 3443 3444

    gil_message = "Calling gil-requiring function"

3445 3446

class SimpleCallNode(CallNode):
William Stein's avatar
William Stein committed
3447 3448 3449 3450 3451 3452 3453
    #  Function call without keyword, * or ** args.
    #
    #  function       ExprNode
    #  args           [ExprNode]
    #  arg_tuple      ExprNode or None     used internally
    #  self           ExprNode or None     used internally
    #  coerced_self   ExprNode or None     used internally
3454
    #  wrapper_call   bool                 used internally
3455
    #  has_optional_args   bool            used internally
3456
    #  nogil          bool                 used internally
3457

William Stein's avatar
William Stein committed
3458
    subexprs = ['self', 'coerced_self', 'function', 'args', 'arg_tuple']
3459

William Stein's avatar
William Stein committed
3460 3461 3462
    self = None
    coerced_self = None
    arg_tuple = None
3463
    wrapper_call = False
3464
    has_optional_args = False
3465
    nogil = False
3466
    analysed = False
3467

3468 3469 3470 3471 3472 3473 3474
    def compile_time_value(self, denv):
        function = self.function.compile_time_value(denv)
        args = [arg.compile_time_value(denv) for arg in self.args]
        try:
            return function(*args)
        except Exception, e:
            self.compile_time_value_error(e)
3475

3476
    def analyse_as_type(self, env):
3477
        attr = self.function.as_cython_attribute()
3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489
        if attr == 'pointer':
            if len(self.args) != 1:
                error(self.args.pos, "only one type allowed.")
            else:
                type = self.args[0].analyse_as_type(env)
                if not type:
                    error(self.args[0].pos, "Unknown type")
                else:
                    return PyrexTypes.CPtrType(type)

    def explicit_args_kwds(self):
        return self.args, None
3490

William Stein's avatar
William Stein committed
3491
    def analyse_types(self, env):
Robert Bradshaw's avatar
Robert Bradshaw committed
3492 3493
        if self.analyse_as_type_constructor(env):
            return
3494 3495 3496
        if self.analysed:
            return
        self.analysed = True
William Stein's avatar
William Stein committed
3497 3498 3499
        function = self.function
        function.is_called = 1
        self.function.analyse_types(env)
Mark Florisson's avatar
Mark Florisson committed
3500

William Stein's avatar
William Stein committed
3501 3502 3503 3504 3505
        if function.is_attribute and function.entry and function.entry.is_cmethod:
            # Take ownership of the object from which the attribute
            # was obtained, because we need to pass it as 'self'.
            self.self = function.obj
            function.obj = CloneNode(self.self)
Mark Florisson's avatar
Mark Florisson committed
3506

William Stein's avatar
William Stein committed
3507 3508
        func_type = self.function_type()
        if func_type.is_pyobject:
3509 3510
            self.arg_tuple = TupleNode(self.pos, args = self.args)
            self.arg_tuple.analyse_types(env)
William Stein's avatar
William Stein committed
3511
            self.args = None
3512 3513 3514
            if func_type is Builtin.type_type and function.is_name and \
                   function.entry and \
                   function.entry.is_builtin and \
3515 3516 3517 3518 3519 3520 3521 3522 3523
                   function.entry.name in Builtin.types_that_construct_their_instance:
                # calling a builtin type that returns a specific object type
                if function.entry.name == 'float':
                    # the following will come true later on in a transform
                    self.type = PyrexTypes.c_double_type
                    self.result_ctype = PyrexTypes.c_double_type
                else:
                    self.type = Builtin.builtin_types[function.entry.name]
                    self.result_ctype = py_object_type
Stefan Behnel's avatar
Stefan Behnel committed
3524
                self.may_return_none = False
3525
            elif function.is_name and function.type_entry:
3526 3527 3528 3529 3530
                # We are calling an extension type constructor.  As
                # long as we do not support __new__(), the result type
                # is clear
                self.type = function.type_entry.type
                self.result_ctype = py_object_type
Stefan Behnel's avatar
Stefan Behnel committed
3531
                self.may_return_none = False
3532 3533
            else:
                self.type = py_object_type
William Stein's avatar
William Stein committed
3534 3535 3536 3537
            self.is_temp = 1
        else:
            for arg in self.args:
                arg.analyse_types(env)
3538

William Stein's avatar
William Stein committed
3539 3540
            if self.self and func_type.args:
                # Coerce 'self' to the type expected by the method.
3541 3542 3543
                self_arg = func_type.args[0]
                if self_arg.not_none: # C methods must do the None test for self at *call* time
                    self.self = self.self.as_none_safe_node(
3544 3545 3546
                        "'NoneType' object has no attribute '%s'",
                        error = 'PyExc_AttributeError',
                        format_args = [self.function.entry.name])
3547
                expected_type = self_arg.type
Stefan Behnel's avatar
Stefan Behnel committed
3548 3549 3550 3551 3552
                if self_arg.accept_builtin_subtypes:
                    self.coerced_self = CMethodSelfCloneNode(self.self)
                else:
                    self.coerced_self = CloneNode(self.self)
                self.coerced_self = self.coerced_self.coerce_to(expected_type, env)
William Stein's avatar
William Stein committed
3553 3554 3555
                # Insert coerced 'self' argument into argument list.
                self.args.insert(0, self.coerced_self)
            self.analyse_c_function_call(env)
3556

William Stein's avatar
William Stein committed
3557 3558
    def function_type(self):
        # Return the type of the function being called, coercing a function
3559 3560
        # pointer to a function if necessary. If the function has fused
        # arguments, return the specific type.
William Stein's avatar
William Stein committed
3561
        func_type = self.function.type
3562

William Stein's avatar
William Stein committed
3563 3564
        if func_type.is_ptr:
            func_type = func_type.base_type
3565

William Stein's avatar
William Stein committed
3566
        return func_type
3567

3568 3569 3570 3571 3572 3573 3574
    def is_simple(self):
        # C function calls could be considered simple, but they may
        # have side-effects that may hit when multiple operations must
        # be effected in order, e.g. when constructing the argument
        # sequence for a function call or comparing values.
        return False

William Stein's avatar
William Stein committed
3575
    def analyse_c_function_call(self, env):
Robert Bradshaw's avatar
Robert Bradshaw committed
3576
        if self.function.type is error_type:
3577
            self.type = error_type
Robert Bradshaw's avatar
Robert Bradshaw committed
3578
            return
3579

Robert Bradshaw's avatar
Robert Bradshaw committed
3580
        if self.function.type.is_cpp_class:
3581 3582
            overloaded_entry = self.function.type.scope.lookup("operator()")
            if overloaded_entry is None:
Robert Bradshaw's avatar
Robert Bradshaw committed
3583 3584 3585
                self.type = PyrexTypes.error_type
                self.result_code = "<error>"
                return
3586 3587
        elif hasattr(self.function, 'entry'):
            overloaded_entry = self.function.entry
3588
        elif (isinstance(self.function, IndexNode) and
3589
              self.function.is_fused_index):
3590
            overloaded_entry = self.function.type.entry
Robert Bradshaw's avatar
Robert Bradshaw committed
3591
        else:
3592
            overloaded_entry = None
3593

3594
        if overloaded_entry:
3595
            if self.function.type.is_fused:
Mark Florisson's avatar
Mark Florisson committed
3596 3597
                functypes = self.function.type.get_all_specific_function_types()
                alternatives = [f.entry for f in functypes]
3598 3599 3600 3601 3602
            else:
                alternatives = overloaded_entry.all_alternatives()

            entry = PyrexTypes.best_match(self.args, alternatives, self.pos, env)

3603 3604 3605 3606
            if not entry:
                self.type = PyrexTypes.error_type
                self.result_code = "<error>"
                return
Mark Florisson's avatar
Mark Florisson committed
3607 3608

            entry.used = True
3609 3610
            self.function.entry = entry
            self.function.type = entry.type
3611 3612 3613 3614 3615 3616 3617 3618
            func_type = self.function_type()
        else:
            func_type = self.function_type()
            if not func_type.is_cfunction:
                error(self.pos, "Calling non-function type '%s'" % func_type)
                self.type = PyrexTypes.error_type
                self.result_code = "<error>"
                return
William Stein's avatar
William Stein committed
3619
        # Check no. of args
3620 3621
        max_nargs = len(func_type.args)
        expected_nargs = max_nargs - func_type.optional_arg_count
William Stein's avatar
William Stein committed
3622
        actual_nargs = len(self.args)
3623 3624 3625
        if func_type.optional_arg_count and expected_nargs != actual_nargs:
            self.has_optional_args = 1
            self.is_temp = 1
William Stein's avatar
William Stein committed
3626
        # Coerce arguments
3627
        some_args_in_temps = False
3628
        for i in xrange(min(max_nargs, actual_nargs)):
William Stein's avatar
William Stein committed
3629
            formal_type = func_type.args[i].type
3630
            arg = self.args[i].coerce_to(formal_type, env)
3631
            if arg.is_temp:
3632 3633
                if i > 0:
                    # first argument in temp doesn't impact subsequent arguments
3634
                    some_args_in_temps = True
3635
            elif arg.type.is_pyobject and not env.nogil:
3636 3637
                if i == 0 and self.self is not None:
                    # a method's cloned "self" argument is ok
3638
                    pass
3639
                elif arg.nonlocally_immutable():
3640 3641 3642
                    # plain local variables are ok
                    pass
                else:
3643 3644 3645 3646
                    # we do not safely own the argument's reference,
                    # but we must make sure it cannot be collected
                    # before we return from the function, so we create
                    # an owned temp reference to it
3647 3648
                    if i > 0: # first argument doesn't matter
                        some_args_in_temps = True
3649
                    arg = arg.coerce_to_temp(env)
3650
            self.args[i] = arg
3651
        # handle additional varargs parameters
3652
        for i in xrange(max_nargs, actual_nargs):
3653 3654 3655 3656 3657 3658 3659
            arg = self.args[i]
            if arg.type.is_pyobject:
                arg_ctype = arg.type.default_coerced_ctype()
                if arg_ctype is None:
                    error(self.args[i].pos,
                          "Python object cannot be passed as a varargs parameter")
                else:
3660
                    self.args[i] = arg = arg.coerce_to(arg_ctype, env)
3661 3662
            if arg.is_temp and i > 0:
                some_args_in_temps = True
3663 3664 3665
        if some_args_in_temps:
            # if some args are temps and others are not, they may get
            # constructed in the wrong order (temps first) => make
3666 3667 3668 3669
            # sure they are either all temps or all not temps (except
            # for the last argument, which is evaluated last in any
            # case)
            for i in xrange(actual_nargs-1):
3670 3671
                if i == 0 and self.self is not None:
                    continue # self is ok
3672
                arg = self.args[i]
3673 3674
                if arg.nonlocally_immutable():
                    # locals, C functions, unassignable types are safe.
3675
                    pass
3676 3677
                elif arg.type.is_cpp_class:
                    # Assignment has side effects, avoid.
3678 3679
                    pass
                elif env.nogil and arg.type.is_pyobject:
3680 3681 3682
                    # can't copy a Python reference into a temp in nogil
                    # env (this is safe: a construction would fail in
                    # nogil anyway)
3683 3684
                    pass
                else:
3685 3686 3687 3688 3689
                    #self.args[i] = arg.coerce_to_temp(env)
                    # instead: issue a warning
                    if i > 0 or i == 1 and self.self is not None: # skip first arg
                        warning(arg.pos, "Argument evaluation order in C function call is undefined and may not be as expected", 0)
                        break
3690

William Stein's avatar
William Stein committed
3691
        # Calc result type and code fragment
Robert Bradshaw's avatar
Robert Bradshaw committed
3692
        if isinstance(self.function, NewExprNode):
3693
            self.type = PyrexTypes.CPtrType(self.function.class_type)
Robert Bradshaw's avatar
Robert Bradshaw committed
3694 3695
        else:
            self.type = func_type.return_type
3696

3697 3698 3699
        if self.function.is_name or self.function.is_attribute:
            if self.function.entry and self.function.entry.utility_code:
                self.is_temp = 1 # currently doesn't work for self.calculate_result_code()
3700

Stefan Behnel's avatar
Stefan Behnel committed
3701 3702 3703 3704 3705 3706
        if self.type.is_pyobject:
            self.result_ctype = py_object_type
            self.is_temp = 1
        elif func_type.exception_value is not None \
                 or func_type.exception_check:
            self.is_temp = 1
3707 3708 3709 3710
        elif self.type.is_memoryviewslice:
            self.is_temp = 1
            # func_type.exception_check = True

3711
        # Called in 'nogil' context?
3712
        self.nogil = env.nogil
3713 3714 3715 3716 3717
        if (self.nogil and
            func_type.exception_check and
            func_type.exception_check != '+'):
            env.use_utility_code(pyerr_occurred_withgil_utility_code)
        # C++ exception handler
Robert Bradshaw's avatar
Robert Bradshaw committed
3718 3719 3720 3721
        if func_type.exception_check == '+':
            if func_type.exception_value is None:
                env.use_utility_code(cpp_exception_utility_code)

William Stein's avatar
William Stein committed
3722 3723
    def calculate_result_code(self):
        return self.c_call_code()
3724

William Stein's avatar
William Stein committed
3725 3726
    def c_call_code(self):
        func_type = self.function_type()
3727
        if self.type is PyrexTypes.error_type or not func_type.is_cfunction:
William Stein's avatar
William Stein committed
3728 3729 3730
            return "<error>"
        formal_args = func_type.args
        arg_list_code = []
3731
        args = list(zip(formal_args, self.args))
3732 3733 3734 3735
        max_nargs = len(func_type.args)
        expected_nargs = max_nargs - func_type.optional_arg_count
        actual_nargs = len(self.args)
        for formal_arg, actual_arg in args[:expected_nargs]:
William Stein's avatar
William Stein committed
3736 3737
                arg_code = actual_arg.result_as(formal_arg.type)
                arg_list_code.append(arg_code)
3738

3739 3740
        if func_type.is_overridable:
            arg_list_code.append(str(int(self.wrapper_call or self.function.entry.is_unbound_cmethod)))
3741

3742
        if func_type.optional_arg_count:
3743
            if expected_nargs == actual_nargs:
3744
                optional_args = 'NULL'
3745
            else:
3746
                optional_args = "&%s" % self.opt_arg_struct
3747
            arg_list_code.append(optional_args)
3748

William Stein's avatar
William Stein committed
3749
        for actual_arg in self.args[len(formal_args):]:
3750
            arg_list_code.append(actual_arg.result())
3751 3752

        result = "%s(%s)" % (self.function.result(), ', '.join(arg_list_code))
William Stein's avatar
William Stein committed
3753
        return result
3754

William Stein's avatar
William Stein committed
3755 3756
    def generate_result_code(self, code):
        func_type = self.function_type()
3757 3758 3759
        if self.function.is_name or self.function.is_attribute:
            if self.function.entry and self.function.entry.utility_code:
                code.globalstate.use_utility_code(self.function.entry.utility_code)
William Stein's avatar
William Stein committed
3760
        if func_type.is_pyobject:
3761
            arg_code = self.arg_tuple.py_result()
William Stein's avatar
William Stein committed
3762
            code.putln(
3763
                "%s = PyObject_Call(%s, %s, NULL); %s" % (
3764
                    self.result(),
William Stein's avatar
William Stein committed
3765
                    self.function.py_result(),
3766
                    arg_code,
3767
                    code.error_goto_if_null(self.result(), self.pos)))
3768
            code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
3769
        elif func_type.is_cfunction:
3770 3771 3772
            if self.has_optional_args:
                actual_nargs = len(self.args)
                expected_nargs = len(func_type.args) - func_type.optional_arg_count
3773 3774
                self.opt_arg_struct = code.funcstate.allocate_temp(
                    func_type.op_arg_struct.base_type, manage_ref=True)
3775 3776 3777 3778
                code.putln("%s.%s = %s;" % (
                        self.opt_arg_struct,
                        Naming.pyrex_prefix + "n",
                        len(self.args) - expected_nargs))
3779
                args = list(zip(func_type.args, self.args))
3780 3781 3782
                for formal_arg, actual_arg in args[expected_nargs:actual_nargs]:
                    code.putln("%s.%s = %s;" % (
                            self.opt_arg_struct,
3783
                            func_type.opt_arg_cname(formal_arg.name),
3784
                            actual_arg.result_as(formal_arg.type)))
William Stein's avatar
William Stein committed
3785
            exc_checks = []
3786
            if self.type.is_pyobject and self.is_temp:
3787
                exc_checks.append("!%s" % self.result())
3788 3789 3790
            elif self.type.is_memoryviewslice:
                assert self.is_temp
                exc_checks.append(self.type.error_condition(self.result()))
William Stein's avatar
William Stein committed
3791
            else:
3792 3793
                exc_val = func_type.exception_value
                exc_check = func_type.exception_check
William Stein's avatar
William Stein committed
3794
                if exc_val is not None:
3795
                    exc_checks.append("%s == %s" % (self.result(), exc_val))
William Stein's avatar
William Stein committed
3796
                if exc_check:
3797 3798
                    if self.nogil:
                        exc_checks.append("__Pyx_ErrOccurredWithGIL()")
3799
                    else:
3800
                        exc_checks.append("PyErr_Occurred()")
William Stein's avatar
William Stein committed
3801 3802
            if self.is_temp or exc_checks:
                rhs = self.c_call_code()
3803 3804
                if self.result():
                    lhs = "%s = " % self.result()
William Stein's avatar
William Stein committed
3805 3806 3807
                    if self.is_temp and self.type.is_pyobject:
                        #return_type = self.type # func_type.return_type
                        #print "SimpleCallNode.generate_result_code: casting", rhs, \
Robert Bradshaw's avatar
Robert Bradshaw committed
3808
                        #    "from", return_type, "to pyobject" ###
William Stein's avatar
William Stein committed
3809 3810 3811
                        rhs = typecast(py_object_type, self.type, rhs)
                else:
                    lhs = ""
Felix Wu's avatar
Felix Wu committed
3812
                if func_type.exception_check == '+':
Robert Bradshaw's avatar
Robert Bradshaw committed
3813 3814 3815
                    if func_type.exception_value is None:
                        raise_py_exception = "__Pyx_CppExn2PyErr()"
                    elif func_type.exception_value.type.is_pyobject:
3816 3817 3818
                        raise_py_exception = ' try { throw; } catch(const std::exception& exn) { PyErr_SetString(%s, exn.what()); } catch(...) { PyErr_SetNone(%s); }' % (
                            func_type.exception_value.entry.cname,
                            func_type.exception_value.entry.cname)
Robert Bradshaw's avatar
Robert Bradshaw committed
3819 3820
                    else:
                        raise_py_exception = '%s(); if (!PyErr_Occurred()) PyErr_SetString(PyExc_RuntimeError , "Error converting c++ exception.")' % func_type.exception_value.entry.cname
3821 3822
                    if self.nogil:
                        raise_py_exception = 'Py_BLOCK_THREADS; %s; Py_UNBLOCK_THREADS' % raise_py_exception
Felix Wu's avatar
Felix Wu committed
3823
                    code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
3824
                    "try {%s%s;} catch(...) {%s; %s}" % (
Felix Wu's avatar
Felix Wu committed
3825 3826
                        lhs,
                        rhs,
Robert Bradshaw's avatar
Robert Bradshaw committed
3827
                        raise_py_exception,
Felix Wu's avatar
Felix Wu committed
3828
                        code.error_goto(self.pos)))
3829 3830 3831 3832 3833 3834
                else:
                    if exc_checks:
                        goto_error = code.error_goto_if(" && ".join(exc_checks), self.pos)
                    else:
                        goto_error = ""
                    code.putln("%s%s; %s" % (lhs, rhs, goto_error))
3835
                if self.type.is_pyobject and self.result():
3836
                    code.put_gotref(self.py_result())
3837 3838
            if self.has_optional_args:
                code.funcstate.release_temp(self.opt_arg_struct)
3839 3840 3841 3842


class PythonCapiFunctionNode(ExprNode):
    subexprs = []
3843
    def __init__(self, pos, py_name, cname, func_type, utility_code = None):
3844
        self.pos = pos
3845 3846
        self.name = py_name
        self.cname = cname
3847 3848 3849
        self.type = func_type
        self.utility_code = utility_code

3850 3851 3852
    def analyse_types(self, env):
        pass

3853 3854 3855 3856 3857
    def generate_result_code(self, code):
        if self.utility_code:
            code.globalstate.use_utility_code(self.utility_code)

    def calculate_result_code(self):
3858
        return self.cname
3859 3860 3861 3862

class PythonCapiCallNode(SimpleCallNode):
    # Python C-API Function call (only created in transforms)

Stefan Behnel's avatar
Stefan Behnel committed
3863 3864 3865 3866 3867 3868
    # By default, we assume that the call never returns None, as this
    # is true for most C-API functions in CPython.  If this does not
    # apply to a call, set the following to True (or None to inherit
    # the default behaviour).
    may_return_none = False

3869
    def __init__(self, pos, function_name, func_type,
3870
                 utility_code = None, py_name=None, **kwargs):
3871 3872 3873
        self.type = func_type.return_type
        self.result_ctype = self.type
        self.function = PythonCapiFunctionNode(
3874
            pos, py_name, function_name, func_type,
3875 3876 3877 3878 3879
            utility_code = utility_code)
        # call this last so that we can override the constructed
        # attributes above with explicit keyword arguments if required
        SimpleCallNode.__init__(self, pos, **kwargs)

William Stein's avatar
William Stein committed
3880

3881
class GeneralCallNode(CallNode):
William Stein's avatar
William Stein committed
3882 3883 3884 3885 3886 3887
    #  General Python function call, including keyword,
    #  * and ** arguments.
    #
    #  function         ExprNode
    #  positional_args  ExprNode          Tuple of positional arguments
    #  keyword_args     ExprNode or None  Dict of keyword arguments
3888

3889
    type = py_object_type
3890

3891
    subexprs = ['function', 'positional_args', 'keyword_args']
William Stein's avatar
William Stein committed
3892

3893
    nogil_check = Node.gil_error
3894

3895 3896 3897 3898 3899 3900 3901 3902
    def compile_time_value(self, denv):
        function = self.function.compile_time_value(denv)
        positional_args = self.positional_args.compile_time_value(denv)
        keyword_args = self.keyword_args.compile_time_value(denv)
        try:
            return function(*positional_args, **keyword_args)
        except Exception, e:
            self.compile_time_value_error(e)
3903

3904
    def explicit_args_kwds(self):
3905 3906
        if (self.keyword_args and not isinstance(self.keyword_args, DictNode) or
            not isinstance(self.positional_args, TupleNode)):
3907
            raise CompileError(self.pos,
3908 3909
                'Compile-time keyword arguments must be explicit.')
        return self.positional_args.args, self.keyword_args
3910

William Stein's avatar
William Stein committed
3911
    def analyse_types(self, env):
Robert Bradshaw's avatar
Robert Bradshaw committed
3912 3913
        if self.analyse_as_type_constructor(env):
            return
William Stein's avatar
William Stein committed
3914 3915 3916 3917
        self.function.analyse_types(env)
        self.positional_args.analyse_types(env)
        if self.keyword_args:
            self.keyword_args.analyse_types(env)
3918
        if not self.function.type.is_pyobject:
3919 3920
            if self.function.type.is_error:
                self.type = error_type
Stefan Behnel's avatar
Stefan Behnel committed
3921
                return
3922
            if hasattr(self.function, 'entry') and not self.function.entry.as_variable:
3923
                error(self.pos, "Keyword and starred arguments not allowed in cdef functions.")
3924 3925
            else:
                self.function = self.function.coerce_to_pyobject(env)
William Stein's avatar
William Stein committed
3926 3927
        self.positional_args = \
            self.positional_args.coerce_to_pyobject(env)
Stefan Behnel's avatar
Stefan Behnel committed
3928
        function = self.function
3929 3930 3931 3932 3933
        if function.is_name and function.type_entry:
            # We are calling an extension type constructor.  As long
            # as we do not support __new__(), the result type is clear
            self.type = function.type_entry.type
            self.result_ctype = py_object_type
Stefan Behnel's avatar
Stefan Behnel committed
3934
            self.may_return_none = False
3935 3936
        else:
            self.type = py_object_type
William Stein's avatar
William Stein committed
3937
        self.is_temp = 1
3938

William Stein's avatar
William Stein committed
3939
    def generate_result_code(self, code):
3940
        if self.type.is_error: return
3941 3942
        if self.keyword_args:
            kwargs = self.keyword_args.py_result()
William Stein's avatar
William Stein committed
3943
        else:
3944
            kwargs = 'NULL'
William Stein's avatar
William Stein committed
3945
        code.putln(
3946
            "%s = PyObject_Call(%s, %s, %s); %s" % (
3947
                self.result(),
3948 3949 3950
                self.function.py_result(),
                self.positional_args.py_result(),
                kwargs,
3951
                code.error_goto_if_null(self.result(), self.pos)))
3952
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
3953 3954


3955
class AsTupleNode(ExprNode):
William Stein's avatar
William Stein committed
3956 3957 3958 3959
    #  Convert argument to tuple. Used for normalising
    #  the * argument of a function call.
    #
    #  arg    ExprNode
3960

William Stein's avatar
William Stein committed
3961
    subexprs = ['arg']
3962 3963 3964

    def calculate_constant_result(self):
        self.constant_result = tuple(self.base.constant_result)
3965

3966 3967 3968 3969 3970 3971 3972
    def compile_time_value(self, denv):
        arg = self.arg.compile_time_value(denv)
        try:
            return tuple(arg)
        except Exception, e:
            self.compile_time_value_error(e)

William Stein's avatar
William Stein committed
3973 3974 3975
    def analyse_types(self, env):
        self.arg.analyse_types(env)
        self.arg = self.arg.coerce_to_pyobject(env)
3976
        self.type = tuple_type
William Stein's avatar
William Stein committed
3977
        self.is_temp = 1
3978

3979 3980 3981
    def may_be_none(self):
        return False

3982
    nogil_check = Node.gil_error
3983 3984
    gil_message = "Constructing Python tuple"

William Stein's avatar
William Stein committed
3985 3986
    def generate_result_code(self, code):
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
3987
            "%s = PySequence_Tuple(%s); %s" % (
3988
                self.result(),
William Stein's avatar
William Stein committed
3989
                self.arg.py_result(),
3990
                code.error_goto_if_null(self.result(), self.pos)))
3991
        code.put_gotref(self.py_result())
3992

William Stein's avatar
William Stein committed
3993

3994
class AttributeNode(ExprNode):
William Stein's avatar
William Stein committed
3995 3996 3997 3998
    #  obj.attribute
    #
    #  obj          ExprNode
    #  attribute    string
3999
    #  needs_none_check boolean        Used if obj is an extension type.
4000
    #                                  If set to True, it is known that the type is not None.
William Stein's avatar
William Stein committed
4001 4002 4003 4004 4005 4006 4007
    #
    #  Used internally:
    #
    #  is_py_attr           boolean   Is a Python getattr operation
    #  member               string    C name of struct member
    #  is_called            boolean   Function call is being done on result
    #  entry                Entry     Symbol table entry of attribute
4008

William Stein's avatar
William Stein committed
4009 4010
    is_attribute = 1
    subexprs = ['obj']
4011

William Stein's avatar
William Stein committed
4012 4013 4014
    type = PyrexTypes.error_type
    entry = None
    is_called = 0
4015
    needs_none_check = True
4016
    is_memslice_transpose = False
William Stein's avatar
William Stein committed
4017

4018
    def as_cython_attribute(self):
Mark Florisson's avatar
Mark Florisson committed
4019 4020 4021
        if (isinstance(self.obj, NameNode) and
                self.obj.is_cython_module and not
                self.attribute == u"parallel"):
4022
            return self.attribute
Mark Florisson's avatar
Mark Florisson committed
4023

4024 4025 4026
        cy = self.obj.as_cython_attribute()
        if cy:
            return "%s.%s" % (cy, self.attribute)
4027
        return None
4028

4029 4030 4031 4032 4033 4034 4035 4036 4037
    def coerce_to(self, dst_type, env):
        #  If coercing to a generic pyobject and this is a cpdef function
        #  we can create the corresponding attribute
        if dst_type is py_object_type:
            entry = self.entry
            if entry and entry.is_cfunction and entry.as_variable:
                # must be a cpdef function
                self.is_temp = 1
                self.entry = entry.as_variable
4038
                self.analyse_as_python_attribute(env)
4039
                return self
4040
        return ExprNode.coerce_to(self, dst_type, env)
4041 4042 4043

    def calculate_constant_result(self):
        attr = self.attribute
4044
        if attr.startswith("__") and attr.endswith("__"):
4045 4046 4047
            return
        self.constant_result = getattr(self.obj.constant_result, attr)

4048 4049
    def compile_time_value(self, denv):
        attr = self.attribute
4050
        if attr.startswith("__") and attr.endswith("__"):
Stefan Behnel's avatar
Stefan Behnel committed
4051 4052
            error(self.pos,
                  "Invalid attribute name '%s' in compile-time expression" % attr)
4053
            return None
4054
        obj = self.obj.compile_time_value(denv)
4055 4056 4057 4058
        try:
            return getattr(obj, attr)
        except Exception, e:
            self.compile_time_value_error(e)
4059

Robert Bradshaw's avatar
Robert Bradshaw committed
4060 4061
    def type_dependencies(self, env):
        return self.obj.type_dependencies(env)
4062

4063 4064 4065 4066 4067 4068
    def infer_type(self, env):
        if self.analyse_as_cimported_attribute(env, 0):
            return self.entry.type
        elif self.analyse_as_unbound_cmethod(env):
            return self.entry.type
        else:
4069 4070 4071 4072 4073 4074 4075 4076
            obj_type = self.obj.infer_type(env)
            self.analyse_attribute(env, obj_type = obj_type)
            if obj_type.is_builtin_type and self.type.is_cfunction:
                # special case: C-API replacements for C methods of
                # builtin types cannot be inferred as C functions as
                # that would prevent their use as bound methods
                self.type = py_object_type
                return py_object_type
4077
            return self.type
4078

William Stein's avatar
William Stein committed
4079 4080
    def analyse_target_declaration(self, env):
        pass
4081

William Stein's avatar
William Stein committed
4082 4083
    def analyse_target_types(self, env):
        self.analyse_types(env, target = 1)
4084

William Stein's avatar
William Stein committed
4085
    def analyse_types(self, env, target = 0):
4086
        self.initialized_check = env.directives['initializedcheck']
William Stein's avatar
William Stein committed
4087
        if self.analyse_as_cimported_attribute(env, target):
4088 4089 4090 4091 4092 4093 4094
            self.entry.used = True
        elif not target and self.analyse_as_unbound_cmethod(env):
            self.entry.used = True
        else:
            self.analyse_as_ordinary_attribute(env, target)
            if self.entry:
                self.entry.used = True
4095

William Stein's avatar
William Stein committed
4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107
    def analyse_as_cimported_attribute(self, env, target):
        # Try to interpret this as a reference to an imported
        # C const, type, var or function. If successful, mutates
        # this node into a NameNode and returns 1, otherwise
        # returns 0.
        module_scope = self.obj.analyse_as_module(env)
        if module_scope:
            entry = module_scope.lookup_here(self.attribute)
            if entry and (
                entry.is_cglobal or entry.is_cfunction
                or entry.is_type or entry.is_const):
                    self.mutate_into_name_node(env, entry, target)
4108
                    entry.used = 1
William Stein's avatar
William Stein committed
4109 4110
                    return 1
        return 0
4111

William Stein's avatar
William Stein committed
4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127
    def analyse_as_unbound_cmethod(self, env):
        # Try to interpret this as a reference to an unbound
        # C method of an extension type. If successful, mutates
        # this node into a NameNode and returns 1, otherwise
        # returns 0.
        type = self.obj.analyse_as_extension_type(env)
        if type:
            entry = type.scope.lookup_here(self.attribute)
            if entry and entry.is_cmethod:
                # Create a temporary entry describing the C method
                # as an ordinary function.
                ubcm_entry = Symtab.Entry(entry.name,
                    "%s->%s" % (type.vtabptr_cname, entry.cname),
                    entry.type)
                ubcm_entry.is_cfunction = 1
                ubcm_entry.func_cname = entry.func_cname
4128
                ubcm_entry.is_unbound_cmethod = 1
William Stein's avatar
William Stein committed
4129 4130 4131
                self.mutate_into_name_node(env, ubcm_entry, None)
                return 1
        return 0
4132

4133 4134 4135
    def analyse_as_type(self, env):
        module_scope = self.obj.analyse_as_module(env)
        if module_scope:
4136
            return module_scope.lookup_type(self.attribute)
4137
        if not self.obj.is_string_literal:
Robert Bradshaw's avatar
Robert Bradshaw committed
4138
            base_type = self.obj.analyse_as_type(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4139
            if base_type and hasattr(base_type, 'scope') and base_type.scope is not None:
Robert Bradshaw's avatar
Robert Bradshaw committed
4140
                return base_type.scope.lookup_type(self.attribute)
4141
        return None
4142

William Stein's avatar
William Stein committed
4143 4144 4145 4146 4147 4148 4149 4150 4151
    def analyse_as_extension_type(self, env):
        # Try to interpret this as a reference to an extension type
        # in a cimported module. Returns the extension type, or None.
        module_scope = self.obj.analyse_as_module(env)
        if module_scope:
            entry = module_scope.lookup_here(self.attribute)
            if entry and entry.is_type and entry.type.is_extension_type:
                return entry.type
        return None
4152

William Stein's avatar
William Stein committed
4153 4154 4155 4156 4157 4158 4159 4160 4161
    def analyse_as_module(self, env):
        # Try to interpret this as a reference to a cimported module
        # in another cimported module. Returns the module scope, or None.
        module_scope = self.obj.analyse_as_module(env)
        if module_scope:
            entry = module_scope.lookup_here(self.attribute)
            if entry and entry.as_module:
                return entry.as_module
        return None
4162

William Stein's avatar
William Stein committed
4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173
    def mutate_into_name_node(self, env, entry, target):
        # Mutate this node into a NameNode and complete the
        # analyse_types phase.
        self.__class__ = NameNode
        self.name = self.attribute
        self.entry = entry
        del self.obj
        del self.attribute
        if target:
            NameNode.analyse_target_types(self, env)
        else:
4174
            NameNode.analyse_rvalue_entry(self, env)
4175

William Stein's avatar
William Stein committed
4176 4177 4178 4179
    def analyse_as_ordinary_attribute(self, env, target):
        self.obj.analyse_types(env)
        self.analyse_attribute(env)
        if self.entry and self.entry.is_cmethod and not self.is_called:
4180 4181
#            error(self.pos, "C method can only be called")
            pass
4182 4183
        ## Reference to C array turns into pointer to first element.
        #while self.type.is_array:
Robert Bradshaw's avatar
Robert Bradshaw committed
4184
        #    self.type = self.type.element_ptr_type()
William Stein's avatar
William Stein committed
4185 4186 4187 4188
        if self.is_py_attr:
            if not target:
                self.is_temp = 1
                self.result_ctype = py_object_type
4189 4190
        elif target and self.obj.type.is_builtin_type:
            error(self.pos, "Assignment to an immutable object field")
4191 4192
        #elif self.type.is_memoryviewslice and not target:
        #    self.is_temp = True
4193

Robert Bradshaw's avatar
Robert Bradshaw committed
4194
    def analyse_attribute(self, env, obj_type = None):
William Stein's avatar
William Stein committed
4195 4196 4197
        # Look up attribute and set self.type and self.member.
        self.is_py_attr = 0
        self.member = self.attribute
Robert Bradshaw's avatar
Robert Bradshaw committed
4198 4199 4200 4201 4202 4203 4204
        if obj_type is None:
            if self.obj.type.is_string:
                self.obj = self.obj.coerce_to_pyobject(env)
            obj_type = self.obj.type
        else:
            if obj_type.is_string:
                obj_type = py_object_type
4205
        if obj_type.is_ptr or obj_type.is_array:
William Stein's avatar
William Stein committed
4206 4207
            obj_type = obj_type.base_type
            self.op = "->"
4208
        elif obj_type.is_extension_type or obj_type.is_builtin_type:
William Stein's avatar
William Stein committed
4209 4210 4211 4212 4213 4214
            self.op = "->"
        else:
            self.op = "."
        if obj_type.has_attributes:
            entry = None
            if obj_type.attributes_known():
4215 4216
                if (obj_type.is_memoryviewslice and not
                        obj_type.scope.lookup_here(self.attribute)):
4217 4218 4219 4220 4221 4222 4223
                    if self.attribute == 'T':
                        self.is_memslice_transpose = True
                        self.is_temp = True
                        self.use_managed_ref = True
                        self.type = self.obj.type
                        return
                    else:
4224
                        obj_type.declare_attribute(self.attribute, env)
William Stein's avatar
William Stein committed
4225
                entry = obj_type.scope.lookup_here(self.attribute)
Robert Bradshaw's avatar
Robert Bradshaw committed
4226 4227
                if entry and entry.is_member:
                    entry = None
William Stein's avatar
William Stein committed
4228
            else:
4229 4230
                error(self.pos,
                    "Cannot select attribute of incomplete type '%s'"
William Stein's avatar
William Stein committed
4231
                    % obj_type)
Robert Bradshaw's avatar
Robert Bradshaw committed
4232 4233
                self.type = PyrexTypes.error_type
                return
William Stein's avatar
William Stein committed
4234 4235
            self.entry = entry
            if entry:
4236 4237
                if obj_type.is_extension_type and entry.name == "__weakref__":
                    error(self.pos, "Illegal use of special attribute __weakref__")
4238 4239
                # methods need the normal attribute lookup
                # because they do not have struct entries
4240 4241 4242 4243
                if entry.is_variable or entry.is_cmethod:
                    self.type = entry.type
                    self.member = entry.cname
                    return
William Stein's avatar
William Stein committed
4244 4245 4246 4247 4248
                else:
                    # If it's not a variable or C method, it must be a Python
                    # method of an extension type, so we treat it like a Python
                    # attribute.
                    pass
4249
        # If we get here, the base object is not a struct/union/extension
William Stein's avatar
William Stein committed
4250 4251 4252
        # type, or it is an extension type and the attribute is either not
        # declared or is declared as a Python method. Treat it as a Python
        # attribute reference.
Robert Bradshaw's avatar
Robert Bradshaw committed
4253
        self.analyse_as_python_attribute(env, obj_type)
Stefan Behnel's avatar
Stefan Behnel committed
4254

Robert Bradshaw's avatar
Robert Bradshaw committed
4255 4256 4257
    def analyse_as_python_attribute(self, env, obj_type = None):
        if obj_type is None:
            obj_type = self.obj.type
4258 4259
        # mangle private '__*' Python attributes used inside of a class
        self.attribute = env.mangle_class_private_name(self.attribute)
4260
        self.member = self.attribute
4261 4262
        self.type = py_object_type
        self.is_py_attr = 1
4263
        if not obj_type.is_pyobject and not obj_type.is_error:
4264
            if obj_type.can_coerce_to_pyobject(env):
4265 4266 4267 4268 4269
                self.obj = self.obj.coerce_to_pyobject(env)
            else:
                error(self.pos,
                      "Object of type '%s' has no attribute '%s'" %
                      (obj_type, self.attribute))
4270

4271
    def nogil_check(self, env):
4272
        if self.is_py_attr:
4273
            self.gil_error()
4274 4275 4276
        elif self.type.is_memoryviewslice:
            import MemoryView
            MemoryView.err_if_nogil_initialized_check(self.pos, env, 'attribute')
4277

4278 4279
    gil_message = "Accessing Python attribute"

William Stein's avatar
William Stein committed
4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290
    def is_simple(self):
        if self.obj:
            return self.result_in_temp() or self.obj.is_simple()
        else:
            return NameNode.is_simple(self)

    def is_lvalue(self):
        if self.obj:
            return 1
        else:
            return NameNode.is_lvalue(self)
4291

William Stein's avatar
William Stein committed
4292 4293 4294 4295 4296
    def is_ephemeral(self):
        if self.obj:
            return self.obj.is_ephemeral()
        else:
            return NameNode.is_ephemeral(self)
4297

William Stein's avatar
William Stein committed
4298 4299
    def calculate_result_code(self):
        #print "AttributeNode.calculate_result_code:", self.member ###
4300
        #print "...obj node =", self.obj, "code", self.obj.result() ###
William Stein's avatar
William Stein committed
4301 4302 4303 4304 4305
        #print "...obj type", self.obj.type, "ctype", self.obj.ctype() ###
        obj = self.obj
        obj_code = obj.result_as(obj.type)
        #print "...obj_code =", obj_code ###
        if self.entry and self.entry.is_cmethod:
Stefan Behnel's avatar
Stefan Behnel committed
4306
            if obj.type.is_extension_type and not self.entry.is_builtin_cmethod:
4307 4308
                if self.entry.final_func_cname:
                    return self.entry.final_func_cname
4309

Mark Florisson's avatar
Mark Florisson committed
4310
                if self.type.from_fused:
4311 4312 4313 4314
                    # If the attribute was specialized through indexing, make
                    # sure to get the right fused name, as our entry was
                    # replaced by our parent index node
                    # (AnalyseExpressionsTransform)
Mark Florisson's avatar
Mark Florisson committed
4315 4316
                    self.member = self.entry.cname

Robert Bradshaw's avatar
Robert Bradshaw committed
4317
                return "((struct %s *)%s%s%s)->%s" % (
4318
                    obj.type.vtabstruct_cname, obj_code, self.op,
Robert Bradshaw's avatar
Robert Bradshaw committed
4319 4320 4321
                    obj.type.vtabslot_cname, self.member)
            else:
                return self.member
4322
        elif obj.type.is_complex:
4323
            return "__Pyx_C%s(%s)" % (self.member.upper(), obj_code)
William Stein's avatar
William Stein committed
4324
        else:
4325 4326 4327
            if obj.type.is_builtin_type and self.entry and self.entry.is_variable:
                # accessing a field of a builtin type, need to cast better than result_as() does
                obj_code = obj.type.cast_code(obj.result(), to_object_struct = True)
William Stein's avatar
William Stein committed
4328
            return "%s%s%s" % (obj_code, self.op, self.member)
4329

William Stein's avatar
William Stein committed
4330 4331
    def generate_result_code(self, code):
        if self.is_py_attr:
4332 4333
            code.putln(
                '%s = PyObject_GetAttr(%s, %s); %s' % (
4334
                    self.result(),
4335
                    self.obj.py_result(),
4336
                    code.intern_identifier(self.attribute),
4337
                    code.error_goto_if_null(self.result(), self.pos)))
4338
            code.put_gotref(self.py_result())
4339
        elif self.type.is_memoryviewslice:
4340 4341 4342 4343 4344 4345 4346 4347 4348
            if self.is_memslice_transpose:
                # transpose the slice
                for access, packing in self.type.axes:
                    if access == 'ptr':
                        error(self.pos, "Transposing not supported for slices "
                                        "with indirect dimensions")
                        return

                code.putln("%s = %s;" % (self.result(), self.obj.result()))
Mark Florisson's avatar
Mark Florisson committed
4349
                if self.obj.is_name or self.obj.is_attribute and self.obj.is_memslice_transpose:
4350 4351 4352 4353 4354
                    code.put_incref_memoryviewslice(self.result(), have_gil=True)

                T = "__pyx_memslice_transpose(&%s) == 0"
                code.putln(code.error_goto_if(T % self.result(), self.pos))
            elif self.initialized_check:
4355 4356 4357 4358 4359 4360
                code.putln(
                    'if (unlikely(!%s.memview)) {'
                        'PyErr_SetString(PyExc_AttributeError,'
                                        '"Memoryview is not initialized");'
                        '%s'
                    '}' % (self.result(), code.error_goto(self.pos)))
4361 4362 4363
        else:
            # result_code contains what is needed, but we may need to insert
            # a check and raise an exception
4364 4365 4366 4367 4368 4369
            if self.obj.type.is_extension_type:
                if self.needs_none_check and code.globalstate.directives['nonecheck']:
                    self.put_nonecheck(code)
            elif self.entry and self.entry.is_cmethod and self.entry.utility_code:
                # C method implemented as function call with utility code
                code.globalstate.use_utility_code(self.entry.utility_code)
4370

William Stein's avatar
William Stein committed
4371 4372 4373
    def generate_assignment_code(self, rhs, code):
        self.obj.generate_evaluation_code(code)
        if self.is_py_attr:
4374
            code.put_error_if_neg(self.pos,
4375 4376
                'PyObject_SetAttr(%s, %s, %s)' % (
                    self.obj.py_result(),
4377
                    code.intern_identifier(self.attribute),
4378
                    rhs.py_result()))
William Stein's avatar
William Stein committed
4379
            rhs.generate_disposal_code(code)
4380
            rhs.free_temps(code)
4381 4382 4383 4384 4385
        elif self.obj.type.is_complex:
            code.putln("__Pyx_SET_C%s(%s, %s);" % (
                self.member.upper(),
                self.obj.result_as(self.obj.type),
                rhs.result_as(self.ctype())))
William Stein's avatar
William Stein committed
4386
        else:
4387
            if (self.obj.type.needs_nonecheck()
4388 4389 4390 4391
                  and self.needs_none_check
                  and code.globalstate.directives['nonecheck']):
                self.put_nonecheck(code)

4392
            select_code = self.result()
4393
            if self.type.is_pyobject and self.use_managed_ref:
William Stein's avatar
William Stein committed
4394
                rhs.make_owned_reference(code)
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
4395
                code.put_giveref(rhs.py_result())
4396
                code.put_gotref(select_code)
William Stein's avatar
William Stein committed
4397
                code.put_decref(select_code, self.ctype())
4398
            elif self.type.is_memoryviewslice:
4399
                import MemoryView
4400
                MemoryView.put_assign_to_memviewslice(
Mark Florisson's avatar
Mark Florisson committed
4401 4402
                        select_code, rhs.result(), self.type, code,
                        incref_rhs=rhs.is_name)
4403

4404
            if not self.type.is_memoryviewslice:
4405 4406 4407 4408 4409
                code.putln(
                    "%s = %s;" % (
                        select_code,
                        rhs.result_as(self.ctype())))
                        #rhs.result()))
William Stein's avatar
William Stein committed
4410
            rhs.generate_post_assignment_code(code)
4411
            rhs.free_temps(code)
William Stein's avatar
William Stein committed
4412
        self.obj.generate_disposal_code(code)
4413
        self.obj.free_temps(code)
4414

William Stein's avatar
William Stein committed
4415 4416
    def generate_deletion_code(self, code):
        self.obj.generate_evaluation_code(code)
4417
        if self.is_py_attr or (isinstance(self.entry.scope, Symtab.PropertyScope)
4418
                               and u'__del__' in self.entry.scope.entries):
4419 4420 4421
            code.put_error_if_neg(self.pos,
                'PyObject_DelAttr(%s, %s)' % (
                    self.obj.py_result(),
4422
                    code.intern_identifier(self.attribute)))
William Stein's avatar
William Stein committed
4423 4424 4425
        else:
            error(self.pos, "Cannot delete C attribute of extension type")
        self.obj.generate_disposal_code(code)
4426
        self.obj.free_temps(code)
4427

4428 4429 4430 4431 4432
    def annotate(self, code):
        if self.is_py_attr:
            code.annotate(self.pos, AnnotationItem('py_attr', 'python attribute', size=len(self.attribute)))
        else:
            code.annotate(self.pos, AnnotationItem('c_attr', 'c attribute', size=len(self.attribute)))
William Stein's avatar
William Stein committed
4433

4434 4435
    def put_nonecheck(self, code):
        code.globalstate.use_utility_code(raise_noneattr_error_utility_code)
4436 4437 4438 4439 4440 4441 4442
        if self.obj.type.is_extension_type:
            test = "%s == Py_None" % self.obj.result_as(PyrexTypes.py_object_type)
        elif self.obj.type.is_memoryviewslice:
            test = "!%s.memview" % self.obj.result()
        else:
            assert False
        code.putln("if (%s) {" % code.unlikely(test))
Stefan Behnel's avatar
Stefan Behnel committed
4443
        code.putln("__Pyx_RaiseNoneAttributeError(\"%s\");" % self.attribute)
4444 4445 4446 4447
        code.putln(code.error_goto(self.pos))
        code.putln("}")


William Stein's avatar
William Stein committed
4448 4449 4450 4451 4452 4453
#-------------------------------------------------------------------
#
#  Constructor nodes
#
#-------------------------------------------------------------------

4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468
class StarredTargetNode(ExprNode):
    #  A starred expression like "*a"
    #
    #  This is only allowed in sequence assignment targets such as
    #
    #      a, *b = (1,2,3,4)    =>     a = 1 ; b = [2,3,4]
    #
    #  and will be removed during type analysis (or generate an error
    #  if it's found at unexpected places).
    #
    #  target          ExprNode

    subexprs = ['target']
    is_starred = 1
    type = py_object_type
Robert Bradshaw's avatar
Robert Bradshaw committed
4469
    is_temp = 1
4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497

    def __init__(self, pos, target):
        self.pos = pos
        self.target = target

    def analyse_declarations(self, env):
        error(self.pos, "can use starred expression only as assignment target")
        self.target.analyse_declarations(env)

    def analyse_types(self, env):
        error(self.pos, "can use starred expression only as assignment target")
        self.target.analyse_types(env)
        self.type = self.target.type

    def analyse_target_declaration(self, env):
        self.target.analyse_target_declaration(env)

    def analyse_target_types(self, env):
        self.target.analyse_target_types(env)
        self.type = self.target.type

    def calculate_result_code(self):
        return ""

    def generate_result_code(self, code):
        pass


4498
class SequenceNode(ExprNode):
William Stein's avatar
William Stein committed
4499 4500 4501 4502 4503 4504
    #  Base class for list and tuple constructor nodes.
    #  Contains common code for performing sequence unpacking.
    #
    #  args                    [ExprNode]
    #  unpacked_items          [ExprNode] or None
    #  coerced_unpacked_items  [ExprNode] or None
4505
    # mult_factor              ExprNode     the integer number of content repetitions ([1,2]*3)
4506

4507
    subexprs = ['args', 'mult_factor']
4508

William Stein's avatar
William Stein committed
4509 4510
    is_sequence_constructor = 1
    unpacked_items = None
4511
    mult_factor = None
4512

4513 4514 4515
    def compile_time_value_list(self, denv):
        return [arg.compile_time_value(denv) for arg in self.args]

4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529
    def replace_starred_target_node(self):
        # replace a starred node in the targets by the contained expression
        self.starred_assignment = False
        args = []
        for arg in self.args:
            if arg.is_starred:
                if self.starred_assignment:
                    error(arg.pos, "more than 1 starred expression in assignment")
                self.starred_assignment = True
                arg = arg.target
                arg.is_starred = True
            args.append(arg)
        self.args = args

William Stein's avatar
William Stein committed
4530
    def analyse_target_declaration(self, env):
4531
        self.replace_starred_target_node()
William Stein's avatar
William Stein committed
4532 4533 4534
        for arg in self.args:
            arg.analyse_target_declaration(env)

4535
    def analyse_types(self, env, skip_children=False):
William Stein's avatar
William Stein committed
4536 4537
        for i in range(len(self.args)):
            arg = self.args[i]
4538
            if not skip_children: arg.analyse_types(env)
William Stein's avatar
William Stein committed
4539
            self.args[i] = arg.coerce_to_pyobject(env)
4540 4541 4542
        if self.mult_factor:
            self.mult_factor.analyse_types(env)
            if not self.mult_factor.type.is_int:
4543
                self.mult_factor = self.mult_factor.coerce_to_pyobject(env)
William Stein's avatar
William Stein committed
4544
        self.is_temp = 1
Stefan Behnel's avatar
Stefan Behnel committed
4545
        # not setting self.type here, subtypes do this
4546

4547 4548 4549
    def may_be_none(self):
        return False

William Stein's avatar
William Stein committed
4550
    def analyse_target_types(self, env):
4551 4552
        if self.mult_factor:
            error(arg.pos, "can't assign to multiplied sequence")
4553
        self.unpacked_items = []
William Stein's avatar
William Stein committed
4554
        self.coerced_unpacked_items = []
4555
        self.any_coerced_items = False
William Stein's avatar
William Stein committed
4556 4557
        for arg in self.args:
            arg.analyse_target_types(env)
4558 4559 4560 4561 4562 4563
            if arg.is_starred:
                if not arg.type.assignable_from(Builtin.list_type):
                    error(arg.pos,
                          "starred target must have Python object (list) type")
                if arg.type is py_object_type:
                    arg.type = Builtin.list_type
William Stein's avatar
William Stein committed
4564 4565
            unpacked_item = PyTempNode(self.pos, env)
            coerced_unpacked_item = unpacked_item.coerce_to(arg.type, env)
4566 4567
            if unpacked_item is not coerced_unpacked_item:
                self.any_coerced_items = True
William Stein's avatar
William Stein committed
4568 4569 4570
            self.unpacked_items.append(unpacked_item)
            self.coerced_unpacked_items.append(coerced_unpacked_item)
        self.type = py_object_type
4571

William Stein's avatar
William Stein committed
4572 4573
    def generate_result_code(self, code):
        self.generate_operation_code(code)
4574

4575 4576 4577 4578 4579 4580
    def generate_sequence_packing_code(self, code, target=None, plain=False):
        if target is None:
            target = self.result()
        py_multiply = self.mult_factor and not self.mult_factor.type.is_int
        if plain or py_multiply:
            mult_factor = None
4581
        else:
4582 4583 4584 4585 4586 4587
            mult_factor = self.mult_factor
        if mult_factor:
            mult = mult_factor.result()
            if isinstance(mult_factor.constant_result, (int,long)) \
                   and mult_factor.constant_result > 0:
                size_factor = ' * %s' % mult_factor.constant_result
4588 4589 4590 4591 4592
            else:
                size_factor = ' * ((%s<0) ? 0:%s)' % (mult, mult)
        else:
            size_factor = ''
            mult = ''
4593 4594 4595 4596 4597 4598 4599

        if self.type is Builtin.list_type:
            create_func, set_item_func = 'PyList_New', 'PyList_SET_ITEM'
        elif self.type is Builtin.tuple_type:
            create_func, set_item_func = 'PyTuple_New', 'PyTuple_SET_ITEM'
        else:
            raise InternalError("sequence unpacking for unexpected type %s" % self.type)
4600 4601
        arg_count = len(self.args)
        code.putln("%s = %s(%s%s); %s" % (
4602 4603 4604 4605
            target, create_func, arg_count, size_factor,
            code.error_goto_if_null(target, self.pos)))
        code.put_gotref(target)

4606
        if mult:
4607 4608 4609 4610
            # FIXME: can't use a temp variable here as the code may
            # end up in the constant building function.  Temps
            # currently don't work there.

4611 4612
            #counter = code.funcstate.allocate_temp(mult_factor.type, manage_ref=False)
            counter = Naming.quick_temp_cname
4613 4614
            code.putln('{ Py_ssize_t %s;' % counter)
            if arg_count == 1:
Stefan Behnel's avatar
Stefan Behnel committed
4615
                offset = counter
4616
            else:
Stefan Behnel's avatar
Stefan Behnel committed
4617
                offset = '%s * %s' % (counter, arg_count)
4618 4619 4620 4621 4622 4623 4624 4625 4626
            code.putln('for (%s=0; %s < %s; %s++) {' % (
                counter, counter, mult, counter
                ))
        else:
            offset = ''
        for i in xrange(arg_count):
            arg = self.args[i]
            if mult or not arg.result_in_temp():
                code.put_incref(arg.result(), arg.ctype())
Stefan Behnel's avatar
Stefan Behnel committed
4627
            code.putln("%s(%s, %s, %s);" % (
4628
                set_item_func,
4629
                target,
Stefan Behnel's avatar
Stefan Behnel committed
4630
                (offset and i) and ('%s + %s' % (offset, i)) or (offset or i),
4631 4632 4633 4634
                arg.py_result()))
            code.put_giveref(arg.py_result())
        if mult:
            code.putln('}')
4635 4636
            #code.funcstate.release_temp(counter)
            code.putln('}')
4637
        elif py_multiply and not plain:
4638
            code.putln('{ PyObject* %s = PyNumber_InPlaceMultiply(%s, %s); %s' % (
4639 4640 4641 4642 4643 4644 4645
                Naming.quick_temp_cname, target, self.mult_factor.py_result(),
                code.error_goto_if_null(Naming.quick_temp_cname, self.pos)
                ))
            code.put_gotref(Naming.quick_temp_cname)
            code.put_decref(target, py_object_type)
            code.putln('%s = %s;' % (target, Naming.quick_temp_cname))
            code.putln('}')
4646 4647

    def generate_subexpr_disposal_code(self, code):
4648
        if self.mult_factor and self.mult_factor.type.is_int:
4649 4650 4651 4652 4653 4654 4655 4656 4657
            super(SequenceNode, self).generate_subexpr_disposal_code(code)
        else:
            # We call generate_post_assignment_code here instead
            # of generate_disposal_code, because values were stored
            # in the tuple using a reference-stealing operation.
            for arg in self.args:
                arg.generate_post_assignment_code(code)
                # Should NOT call free_temps -- this is invoked by the default
                # generate_evaluation_code which will do that.
4658 4659
            if self.mult_factor:
                self.mult_factor.generate_disposal_code(code)
4660

William Stein's avatar
William Stein committed
4661
    def generate_assignment_code(self, rhs, code):
4662 4663 4664
        if self.starred_assignment:
            self.generate_starred_assignment_code(rhs, code)
        else:
4665
            self.generate_parallel_assignment_code(rhs, code)
4666 4667 4668 4669 4670

        for item in self.unpacked_items:
            item.release(code)
        rhs.free_temps(code)

4671 4672 4673 4674 4675
    _func_iternext_type = PyrexTypes.CPtrType(PyrexTypes.CFuncType(
        PyrexTypes.py_object_type, [
            PyrexTypes.CFuncTypeArg("it", PyrexTypes.py_object_type, None),
            ]))

4676
    def generate_parallel_assignment_code(self, rhs, code):
4677 4678 4679
        # Need to work around the fact that generate_evaluation_code
        # allocates the temps in a rather hacky way -- the assignment
        # is evaluated twice, within each if-block.
4680 4681
        for item in self.unpacked_items:
            item.allocate(code)
4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709
        special_unpack = (rhs.type is py_object_type
                          or rhs.type in (tuple_type, list_type)
                          or not rhs.type.is_builtin_type)
        if special_unpack:
            tuple_check = 'likely(PyTuple_CheckExact(%s))' % rhs.py_result()
            list_check  = 'PyList_CheckExact(%s)' % rhs.py_result()
            if rhs.type is list_type:
                sequence_types = ['List']
                sequence_type_test = list_check
            elif rhs.type is tuple_type:
                sequence_types = ['Tuple']
                sequence_type_test = tuple_check
            else:
                sequence_types = ['Tuple', 'List']
                sequence_type_test = "(%s) || (%s)" % (tuple_check, list_check)
            code.putln("if (%s) {" % sequence_type_test)
            code.putln("PyObject* sequence = %s;" % rhs.py_result())
            if len(sequence_types) == 2:
                code.putln("if (likely(Py%s_CheckExact(sequence))) {" % sequence_types[0])
            self.generate_special_parallel_unpacking_code(code, sequence_types[0])
            if len(sequence_types) == 2:
                code.putln("} else {")
                self.generate_special_parallel_unpacking_code(code, sequence_types[1])
                code.putln("}")
            for item in self.unpacked_items:
                code.put_incref(item.result(), item.ctype())
            rhs.generate_disposal_code(code)
            code.putln("} else {")
4710 4711
        else:
            code.putln("{")
4712

4713
        if special_unpack and rhs.type is tuple_type:
4714 4715 4716 4717
            code.globalstate.use_utility_code(tuple_unpacking_error_code)
            code.putln("__Pyx_UnpackTupleError(%s, %s);" % (
                        rhs.py_result(), len(self.args)))
            code.putln(code.error_goto(self.pos))
4718
        else:
4719
            self.generate_generic_parallel_unpacking_code(code, rhs)
4720
        code.putln("}")
4721

4722 4723
        for value_node in self.coerced_unpacked_items:
            value_node.generate_evaluation_code(code)
4724 4725 4726
        for i in range(len(self.args)):
            self.args[i].generate_assignment_code(
                self.coerced_unpacked_items[i], code)
4727

4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739
    def generate_special_parallel_unpacking_code(self, code, sequence_type):
        code.globalstate.use_utility_code(raise_need_more_values_to_unpack)
        code.globalstate.use_utility_code(raise_too_many_values_to_unpack)
        code.putln("if (unlikely(Py%s_GET_SIZE(sequence) != %d)) {" % (
            sequence_type, len(self.args)))
        code.putln("if (Py%s_GET_SIZE(sequence) > %d) __Pyx_RaiseTooManyValuesError(%d);" % (
            sequence_type, len(self.args), len(self.args)))
        code.putln("else __Pyx_RaiseNeedMoreValuesError(Py%s_GET_SIZE(sequence));" % sequence_type)
        code.putln(code.error_goto(self.pos))
        code.putln("}")
        for i, item in enumerate(self.unpacked_items):
            code.putln("%s = Py%s_GET_ITEM(sequence, %d); " % (item.result(), sequence_type, i))
Robert Bradshaw's avatar
Robert Bradshaw committed
4740

4741 4742 4743
    def generate_generic_parallel_unpacking_code(self, code, rhs):
        code.globalstate.use_utility_code(iternext_unpacking_end_utility_code)
        code.globalstate.use_utility_code(raise_need_more_values_to_unpack)
4744
        code.putln("Py_ssize_t index = -1;") # must be at the start of a C block!
4745

4746 4747 4748 4749 4750 4751 4752 4753
        iterator_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
        code.putln(
            "%s = PyObject_GetIter(%s); %s" % (
                iterator_temp,
                rhs.py_result(),
                code.error_goto_if_null(iterator_temp, self.pos)))
        code.put_gotref(iterator_temp)
        rhs.generate_disposal_code(code)
4754

4755 4756 4757
        iternext_func = code.funcstate.allocate_temp(self._func_iternext_type, manage_ref=False)
        code.putln("%s = Py_TYPE(%s)->tp_iternext;" % (
            iternext_func, iterator_temp))
William Stein's avatar
William Stein committed
4758

4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787
        unpacking_error_label = code.new_label('unpacking_failed')
        code.use_label(unpacking_error_label)
        unpack_code = "%s(%s)" % (iternext_func, iterator_temp)
        for i in range(len(self.args)):
            item = self.unpacked_items[i]
            code.putln(
                "index = %d; %s = %s; if (unlikely(!%s)) goto %s;" % (
                    i,
                    item.result(),
                    typecast(item.ctype(), py_object_type, unpack_code),
                    item.result(),
                    unpacking_error_label))
            code.put_gotref(item.py_result())
        code.put_error_if_neg(self.pos, "__Pyx_IternextUnpackEndCheck(%s(%s), %d)" % (
            iternext_func,
            iterator_temp,
            len(self.args)))
        code.put_decref_clear(iterator_temp, py_object_type)
        code.funcstate.release_temp(iterator_temp)
        code.funcstate.release_temp(iternext_func)
        unpacking_done_label = code.new_label('unpacking_done')
        code.put_goto(unpacking_done_label)

        code.put_label(unpacking_error_label)
        code.put_decref_clear(iterator_temp, py_object_type)
        code.putln("if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_StopIteration)) PyErr_Clear();")
        code.putln("if (!PyErr_Occurred()) __Pyx_RaiseNeedMoreValuesError(index);")
        code.putln(code.error_goto(self.pos))
        code.put_label(unpacking_done_label)
4788 4789 4790 4791 4792 4793 4794 4795 4796

    def generate_starred_assignment_code(self, rhs, code):
        for i, arg in enumerate(self.args):
            if arg.is_starred:
                starred_target = self.unpacked_items[i]
                fixed_args_left  = self.args[:i]
                fixed_args_right = self.args[i+1:]
                break

4797
        iterator_temp = code.funcstate.allocate_temp(py_object_type, manage_ref=True)
4798 4799
        code.putln(
            "%s = PyObject_GetIter(%s); %s" % (
4800
                iterator_temp,
4801
                rhs.py_result(),
4802 4803
                code.error_goto_if_null(iterator_temp, self.pos)))
        code.put_gotref(iterator_temp)
4804 4805
        rhs.generate_disposal_code(code)

4806
        for item in self.unpacked_items:
4807
            item.allocate(code)
4808
        code.globalstate.use_utility_code(unpacking_utility_code)
4809 4810 4811
        for i in range(len(fixed_args_left)):
            item = self.unpacked_items[i]
            unpack_code = "__Pyx_UnpackItem(%s, %d)" % (
4812
                iterator_temp, i)
4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823
            code.putln(
                "%s = %s; %s" % (
                    item.result(),
                    typecast(item.ctype(), py_object_type, unpack_code),
                    code.error_goto_if_null(item.result(), self.pos)))
            code.put_gotref(item.py_result())
            value_node = self.coerced_unpacked_items[i]
            value_node.generate_evaluation_code(code)

        target_list = starred_target.result()
        code.putln("%s = PySequence_List(%s); %s" % (
4824
            target_list, iterator_temp,
4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842
            code.error_goto_if_null(target_list, self.pos)))
        code.put_gotref(target_list)
        if fixed_args_right:
            code.globalstate.use_utility_code(raise_need_more_values_to_unpack)
            unpacked_right_args = self.unpacked_items[-len(fixed_args_right):]
            code.putln("if (unlikely(PyList_GET_SIZE(%s) < %d)) {" % (
                (target_list, len(unpacked_right_args))))
            code.put("__Pyx_RaiseNeedMoreValuesError(%d+PyList_GET_SIZE(%s)); %s" % (
                     len(fixed_args_left), target_list,
                     code.error_goto(self.pos)))
            code.putln('}')
            for i, (arg, coerced_arg) in enumerate(zip(unpacked_right_args[::-1],
                                                       self.coerced_unpacked_items[::-1])):
                code.putln(
                    "%s = PyList_GET_ITEM(%s, PyList_GET_SIZE(%s)-1); " % (
                        arg.py_result(),
                        target_list, target_list))
                # resize the list the hard way
4843
                code.putln("((PyVarObject*)%s)->ob_size--;" % target_list)
4844 4845 4846
                code.put_gotref(arg.py_result())
                coerced_arg.generate_evaluation_code(code)

4847 4848
        code.put_decref_clear(iterator_temp, py_object_type)
        code.funcstate.release_temp(iterator_temp)
4849 4850 4851 4852 4853

        for i in range(len(self.args)):
            self.args[i].generate_assignment_code(
                self.coerced_unpacked_items[i], code)

4854 4855 4856 4857 4858 4859 4860 4861
    def annotate(self, code):
        for arg in self.args:
            arg.annotate(code)
        if self.unpacked_items:
            for arg in self.unpacked_items:
                arg.annotate(code)
            for arg in self.coerced_unpacked_items:
                arg.annotate(code)
William Stein's avatar
William Stein committed
4862 4863 4864 4865


class TupleNode(SequenceNode):
    #  Tuple constructor.
4866

4867
    type = tuple_type
4868
    is_partly_literal = False
4869 4870 4871

    gil_message = "Constructing Python tuple"

4872
    def analyse_types(self, env, skip_children=False):
Robert Bradshaw's avatar
Robert Bradshaw committed
4873
        if len(self.args) == 0:
4874 4875
            self.is_temp = False
            self.is_literal = True
Robert Bradshaw's avatar
Robert Bradshaw committed
4876
        else:
4877
            SequenceNode.analyse_types(self, env, skip_children)
4878 4879 4880 4881
            for child in self.args:
                if not child.is_literal:
                    break
            else:
4882 4883 4884 4885 4886 4887 4888
                if not self.mult_factor or self.mult_factor.is_literal and \
                       isinstance(self.mult_factor.constant_result, (int, long)):
                    self.is_temp = False
                    self.is_literal = True
                else:
                    self.is_temp = True
                    self.is_partly_literal = True
4889

Stefan Behnel's avatar
Stefan Behnel committed
4890 4891 4892 4893
    def is_simple(self):
        # either temp or constant => always simple
        return True

4894 4895 4896 4897
    def nonlocally_immutable(self):
        # either temp or constant => always safe
        return True

Robert Bradshaw's avatar
Robert Bradshaw committed
4898 4899
    def calculate_result_code(self):
        if len(self.args) > 0:
4900
            return self.result_code
Robert Bradshaw's avatar
Robert Bradshaw committed
4901 4902
        else:
            return Naming.empty_tuple
William Stein's avatar
William Stein committed
4903

4904 4905 4906 4907
    def calculate_constant_result(self):
        self.constant_result = tuple([
                arg.constant_result for arg in self.args])

4908 4909 4910 4911 4912 4913
    def compile_time_value(self, denv):
        values = self.compile_time_value_list(denv)
        try:
            return tuple(values)
        except Exception, e:
            self.compile_time_value_error(e)
4914

William Stein's avatar
William Stein committed
4915
    def generate_operation_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
4916 4917 4918
        if len(self.args) == 0:
            # result_code is Naming.empty_tuple
            return
4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931
        if self.is_partly_literal:
            # underlying tuple is const, but factor is not
            tuple_target = code.get_py_const(py_object_type, 'tuple_', cleanup_level=2)
            const_code = code.get_cached_constants_writer()
            const_code.mark_pos(self.pos)
            self.generate_sequence_packing_code(const_code, tuple_target, plain=True)
            const_code.put_giveref(tuple_target)
            code.putln('%s = PyNumber_Multiply(%s, %s); %s' % (
                self.result(), tuple_target, self.mult_factor.py_result(),
                code.error_goto_if_null(self.result(), self.pos)
                ))
            code.put_gotref(self.py_result())
        elif self.is_literal:
4932 4933
            # non-empty cached tuple => result is global constant,
            # creation code goes into separate code writer
4934
            self.result_code = code.get_py_const(py_object_type, 'tuple_', cleanup_level=2)
4935 4936
            code = code.get_cached_constants_writer()
            code.mark_pos(self.pos)
4937
            self.generate_sequence_packing_code(code)
4938
            code.put_giveref(self.py_result())
4939 4940
        else:
            self.generate_sequence_packing_code(code)
William Stein's avatar
William Stein committed
4941 4942 4943 4944


class ListNode(SequenceNode):
    #  List constructor.
4945

4946 4947
    # obj_conversion_errors    [PyrexError]   used internally
    # orignial_args            [ExprNode]     used internally
4948

4949
    obj_conversion_errors = []
Stefan Behnel's avatar
Stefan Behnel committed
4950
    type = list_type
4951

4952
    gil_message = "Constructing Python list"
4953

Robert Bradshaw's avatar
Robert Bradshaw committed
4954
    def type_dependencies(self, env):
4955
        return ()
4956

4957 4958 4959
    def infer_type(self, env):
        # TOOD: Infer non-object list arrays.
        return list_type
4960

4961
    def analyse_expressions(self, env):
4962
        SequenceNode.analyse_expressions(self, env)
4963 4964
        self.coerce_to_pyobject(env)

Robert Bradshaw's avatar
Robert Bradshaw committed
4965
    def analyse_types(self, env):
4966 4967 4968 4969 4970
        hold_errors()
        self.original_args = list(self.args)
        SequenceNode.analyse_types(self, env)
        self.obj_conversion_errors = held_errors()
        release_errors(ignore=True)
4971

Robert Bradshaw's avatar
Robert Bradshaw committed
4972 4973
    def coerce_to(self, dst_type, env):
        if dst_type.is_pyobject:
4974 4975 4976
            for err in self.obj_conversion_errors:
                report_error(err)
            self.obj_conversion_errors = []
Robert Bradshaw's avatar
Robert Bradshaw committed
4977 4978
            if not self.type.subtype_of(dst_type):
                error(self.pos, "Cannot coerce list to type '%s'" % dst_type)
4979 4980
        elif self.mult_factor:
            error(self.pos, "Cannot coerce multiplied list to '%s'" % dst_type)
4981
        elif dst_type.is_ptr and dst_type.base_type is not PyrexTypes.c_void_type:
Robert Bradshaw's avatar
Robert Bradshaw committed
4982
            base_type = dst_type.base_type
Robert Bradshaw's avatar
Robert Bradshaw committed
4983
            self.type = PyrexTypes.CArrayType(base_type, len(self.args))
4984
            for i in range(len(self.original_args)):
Robert Bradshaw's avatar
Robert Bradshaw committed
4985
                arg = self.args[i]
4986 4987
                if isinstance(arg, CoerceToPyTypeNode):
                    arg = arg.arg
Robert Bradshaw's avatar
Robert Bradshaw committed
4988
                self.args[i] = arg.coerce_to(base_type, env)
Robert Bradshaw's avatar
Robert Bradshaw committed
4989 4990 4991 4992 4993 4994
        elif dst_type.is_struct:
            if len(self.args) > len(dst_type.scope.var_entries):
                error(self.pos, "Too may members for '%s'" % dst_type)
            else:
                if len(self.args) < len(dst_type.scope.var_entries):
                    warning(self.pos, "Too few members for '%s'" % dst_type, 1)
4995 4996 4997
                for i, (arg, member) in enumerate(zip(self.original_args, dst_type.scope.var_entries)):
                    if isinstance(arg, CoerceToPyTypeNode):
                        arg = arg.arg
Robert Bradshaw's avatar
Robert Bradshaw committed
4998 4999
                    self.args[i] = arg.coerce_to(member.type, env)
            self.type = dst_type
Robert Bradshaw's avatar
Robert Bradshaw committed
5000 5001 5002 5003
        else:
            self.type = error_type
            error(self.pos, "Cannot coerce list to type '%s'" % dst_type)
        return self
5004

Robert Bradshaw's avatar
Robert Bradshaw committed
5005 5006
    def release_temp(self, env):
        if self.type.is_array:
5007 5008
            # To be valid C++, we must allocate the memory on the stack
            # manually and be sure not to reuse it for something else.
Robert Bradshaw's avatar
Robert Bradshaw committed
5009 5010 5011
            pass
        else:
            SequenceNode.release_temp(self, env)
Robert Bradshaw's avatar
Robert Bradshaw committed
5012

5013
    def calculate_constant_result(self):
5014 5015
        if self.mult_factor:
            raise ValueError() # may exceed the compile time memory
5016 5017 5018
        self.constant_result = [
            arg.constant_result for arg in self.args]

5019
    def compile_time_value(self, denv):
5020 5021 5022 5023
        l = self.compile_time_value_list(denv)
        if self.mult_factor:
            l *= self.mult_factor.compile_time_value(denv)
        return l
5024

William Stein's avatar
William Stein committed
5025
    def generate_operation_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
5026
        if self.type.is_pyobject:
5027 5028
            for err in self.obj_conversion_errors:
                report_error(err)
5029
            self.generate_sequence_packing_code(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
5030 5031 5032 5033 5034 5035
        elif self.type.is_array:
            for i, arg in enumerate(self.args):
                code.putln("%s[%s] = %s;" % (
                                self.result(),
                                i,
                                arg.result()))
Robert Bradshaw's avatar
Robert Bradshaw committed
5036
        elif self.type.is_struct:
Robert Bradshaw's avatar
Robert Bradshaw committed
5037 5038 5039 5040 5041
            for arg, member in zip(self.args, self.type.scope.var_entries):
                code.putln("%s.%s = %s;" % (
                        self.result(),
                        member.cname,
                        arg.result()))
5042 5043
        else:
            raise InternalError("List type never specified")
5044

Robert Bradshaw's avatar
Robert Bradshaw committed
5045

5046 5047 5048 5049 5050 5051 5052 5053 5054
class ScopedExprNode(ExprNode):
    # Abstract base class for ExprNodes that have their own local
    # scope, such as generator expressions.
    #
    # expr_scope    Scope  the inner scope of the expression

    subexprs = []
    expr_scope = None

5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073
    # does this node really have a local scope, e.g. does it leak loop
    # variables or not?  non-leaking Py3 behaviour is default, except
    # for list comprehensions where the behaviour differs in Py2 and
    # Py3 (set in Parsing.py based on parser context)
    has_local_scope = True

    def init_scope(self, outer_scope, expr_scope=None):
        if expr_scope is not None:
            self.expr_scope = expr_scope
        elif self.has_local_scope:
            self.expr_scope = Symtab.GeneratorExpressionScope(outer_scope)
        else:
            self.expr_scope = None

    def analyse_declarations(self, env):
        self.init_scope(env)

    def analyse_scoped_declarations(self, env):
        # this is called with the expr_scope as env
5074 5075
        pass

5076 5077
    def analyse_types(self, env):
        # no recursion here, the children will be analysed separately below
5078 5079 5080 5081 5082 5083
        pass

    def analyse_scoped_expressions(self, env):
        # this is called with the expr_scope as env
        pass

5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130
    def generate_evaluation_code(self, code):
        # set up local variables and free their references on exit
        generate_inner_evaluation_code = super(ScopedExprNode, self).generate_evaluation_code
        if not self.has_local_scope or not self.expr_scope.var_entries:
            # no local variables => delegate, done
            generate_inner_evaluation_code(code)
            return

        code.putln('{ /* enter inner scope */')
        py_entries = []
        for entry in self.expr_scope.var_entries:
            if not entry.in_closure:
                code.put_var_declaration(entry)
                if entry.type.is_pyobject and entry.used:
                    py_entries.append(entry)
        if not py_entries:
            # no local Python references => no cleanup required
            generate_inner_evaluation_code(code)
            code.putln('} /* exit inner scope */')
            return

        # must free all local Python references at each exit point
        old_loop_labels = tuple(code.new_loop_labels())
        old_error_label = code.new_error_label()

        generate_inner_evaluation_code(code)

        # normal (non-error) exit
        for entry in py_entries:
            code.put_var_decref(entry)

        # error/loop body exit points
        exit_scope = code.new_label('exit_scope')
        code.put_goto(exit_scope)
        for label, old_label in ([(code.error_label, old_error_label)] +
                                 list(zip(code.get_loop_labels(), old_loop_labels))):
            if code.label_used(label):
                code.put_label(label)
                for entry in py_entries:
                    code.put_var_decref(entry)
                code.put_goto(old_label)
        code.put_label(exit_scope)
        code.putln('} /* exit inner scope */')

        code.set_loop_labels(old_loop_labels)
        code.error_label = old_error_label

5131 5132

class ComprehensionNode(ScopedExprNode):
5133
    subexprs = ["target"]
5134
    child_attrs = ["loop"]
5135

5136 5137
    def infer_type(self, env):
        return self.target.infer_type(env)
5138 5139 5140

    def analyse_declarations(self, env):
        self.append.target = self # this is used in the PyList_Append of the inner loop
5141 5142
        self.init_scope(env)

5143 5144
    def analyse_scoped_declarations(self, env):
        self.loop.analyse_declarations(env)
5145

5146 5147 5148
    def analyse_types(self, env):
        self.target.analyse_expressions(env)
        self.type = self.target.type
5149 5150
        if not self.has_local_scope:
            self.loop.analyse_expressions(env)
5151

5152 5153 5154
    def analyse_scoped_expressions(self, env):
        if self.has_local_scope:
            self.loop.analyse_expressions(env)
5155

5156 5157 5158
    def may_be_none(self):
        return False

5159 5160
    def calculate_result_code(self):
        return self.target.result()
5161

5162 5163
    def generate_result_code(self, code):
        self.generate_operation_code(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
5164

5165 5166 5167
    def generate_operation_code(self, code):
        self.loop.generate_execution_code(code)

5168 5169
    def annotate(self, code):
        self.loop.annotate(code)
5170 5171


5172
class ComprehensionAppendNode(Node):
5173 5174
    # Need to be careful to avoid infinite recursion:
    # target must not be in child_attrs/subexprs
5175 5176

    child_attrs = ['expr']
5177 5178

    type = PyrexTypes.c_int_type
5179

5180 5181
    def analyse_expressions(self, env):
        self.expr.analyse_expressions(env)
5182
        if not self.expr.type.is_pyobject:
Robert Bradshaw's avatar
Robert Bradshaw committed
5183
            self.expr = self.expr.coerce_to_pyobject(env)
5184

5185
    def generate_execution_code(self, code):
5186 5187 5188 5189 5190 5191 5192
        if self.target.type is list_type:
            function = "PyList_Append"
        elif self.target.type is set_type:
            function = "PySet_Add"
        else:
            raise InternalError(
                "Invalid type for comprehension node: %s" % self.target.type)
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207

        self.expr.generate_evaluation_code(code)
        code.putln(code.error_goto_if("%s(%s, (PyObject*)%s)" % (
            function,
            self.target.result(),
            self.expr.result()
            ), self.pos))
        self.expr.generate_disposal_code(code)
        self.expr.free_temps(code)

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

    def annotate(self, code):
        self.expr.annotate(code)
5208 5209

class DictComprehensionAppendNode(ComprehensionAppendNode):
5210
    child_attrs = ['key_expr', 'value_expr']
5211

5212 5213
    def analyse_expressions(self, env):
        self.key_expr.analyse_expressions(env)
5214 5215
        if not self.key_expr.type.is_pyobject:
            self.key_expr = self.key_expr.coerce_to_pyobject(env)
5216
        self.value_expr.analyse_expressions(env)
5217 5218 5219
        if not self.value_expr.type.is_pyobject:
            self.value_expr = self.value_expr.coerce_to_pyobject(env)

5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239
    def generate_execution_code(self, code):
        self.key_expr.generate_evaluation_code(code)
        self.value_expr.generate_evaluation_code(code)
        code.putln(code.error_goto_if("PyDict_SetItem(%s, (PyObject*)%s, (PyObject*)%s)" % (
            self.target.result(),
            self.key_expr.result(),
            self.value_expr.result()
            ), self.pos))
        self.key_expr.generate_disposal_code(code)
        self.key_expr.free_temps(code)
        self.value_expr.generate_disposal_code(code)
        self.value_expr.free_temps(code)

    def generate_function_definitions(self, env, code):
        self.key_expr.generate_function_definitions(env, code)
        self.value_expr.generate_function_definitions(env, code)

    def annotate(self, code):
        self.key_expr.annotate(code)
        self.value_expr.annotate(code)
5240 5241


5242 5243 5244 5245 5246
class InlinedGeneratorExpressionNode(ScopedExprNode):
    # An inlined generator expression for which the result is
    # calculated inside of the loop.  This will only be created by
    # transforms when replacing builtin calls on generator
    # expressions.
5247
    #
5248 5249 5250
    # loop           ForStatNode      the for-loop, not containing any YieldExprNodes
    # result_node    ResultRefNode    the reference to the result value temp
    # orig_func      String           the name of the builtin function this node replaces
5251

5252
    child_attrs = ["loop"]
5253
    loop_analysed = False
5254 5255
    type = py_object_type

5256 5257
    def analyse_scoped_declarations(self, env):
        self.loop.analyse_declarations(env)
5258

5259 5260 5261 5262 5263 5264
    def may_be_none(self):
        return False

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

5265 5266
    def infer_type(self, env):
        return self.result_node.infer_type(env)
5267 5268

    def analyse_types(self, env):
5269 5270 5271
        if not self.has_local_scope:
            self.loop_analysed = True
            self.loop.analyse_expressions(env)
5272 5273 5274
        self.type = self.result_node.type
        self.is_temp = True

5275 5276
    def analyse_scoped_expressions(self, env):
        self.loop_analysed = True
5277 5278
        if self.has_local_scope:
            self.loop.analyse_expressions(env)
5279

5280
    def coerce_to(self, dst_type, env):
5281 5282 5283 5284 5285 5286
        if self.orig_func == 'sum' and dst_type.is_numeric and not self.loop_analysed:
            # We can optimise by dropping the aggregation variable and
            # the add operations into C.  This can only be done safely
            # before analysing the loop body, after that, the result
            # reference type will have infected expressions and
            # assignments.
5287 5288
            self.result_node.type = self.type = dst_type
            return self
5289
        return super(InlinedGeneratorExpressionNode, self).coerce_to(dst_type, env)
5290

5291 5292 5293 5294 5295
    def generate_result_code(self, code):
        self.result_node.result_code = self.result()
        self.loop.generate_execution_code(code)


5296
class SetNode(ExprNode):
5297 5298
    #  Set constructor.

5299 5300
    type = set_type

5301 5302 5303
    subexprs = ['args']

    gil_message = "Constructing Python set"
5304

5305 5306 5307 5308 5309 5310 5311 5312
    def analyse_types(self, env):
        for i in range(len(self.args)):
            arg = self.args[i]
            arg.analyse_types(env)
            self.args[i] = arg.coerce_to_pyobject(env)
        self.type = set_type
        self.is_temp = 1

5313 5314 5315
    def may_be_none(self):
        return False

5316 5317 5318 5319
    def calculate_constant_result(self):
        self.constant_result = set([
                arg.constant_result for arg in self.args])

5320 5321 5322 5323 5324 5325 5326 5327
    def compile_time_value(self, denv):
        values = [arg.compile_time_value(denv) for arg in self.args]
        try:
            return set(values)
        except Exception, e:
            self.compile_time_value_error(e)

    def generate_evaluation_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
5328
        code.globalstate.use_utility_code(Builtin.py_set_utility_code)
5329 5330 5331 5332 5333
        self.allocate_temp_result(code)
        code.putln(
            "%s = PySet_New(0); %s" % (
                self.result(),
                code.error_goto_if_null(self.result(), self.pos)))
5334
        code.put_gotref(self.py_result())
5335 5336 5337 5338 5339 5340 5341 5342
        for arg in self.args:
            arg.generate_evaluation_code(code)
            code.putln(
                code.error_goto_if_neg(
                    "PySet_Add(%s, %s)" % (self.result(), arg.py_result()),
                    self.pos))
            arg.generate_disposal_code(code)
            arg.free_temps(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
5343

William Stein's avatar
William Stein committed
5344

5345
class DictNode(ExprNode):
William Stein's avatar
William Stein committed
5346 5347
    #  Dictionary constructor.
    #
Vitja Makarov's avatar
Vitja Makarov committed
5348 5349
    #  key_value_pairs     [DictItemNode]
    #  exclude_null_values [boolean]          Do not add NULL values to dict
5350 5351
    #
    # obj_conversion_errors    [PyrexError]   used internally
5352

5353
    subexprs = ['key_value_pairs']
5354
    is_temp = 1
Vitja Makarov's avatar
Vitja Makarov committed
5355
    exclude_null_values = False
5356
    type = dict_type
5357

5358
    obj_conversion_errors = []
5359 5360 5361 5362

    def calculate_constant_result(self):
        self.constant_result = dict([
                item.constant_result for item in self.key_value_pairs])
5363

5364
    def compile_time_value(self, denv):
Robert Bradshaw's avatar
Robert Bradshaw committed
5365 5366
        pairs = [(item.key.compile_time_value(denv), item.value.compile_time_value(denv))
            for item in self.key_value_pairs]
5367 5368 5369 5370
        try:
            return dict(pairs)
        except Exception, e:
            self.compile_time_value_error(e)
5371

Robert Bradshaw's avatar
Robert Bradshaw committed
5372
    def type_dependencies(self, env):
5373
        return ()
5374

5375 5376 5377 5378
    def infer_type(self, env):
        # TOOD: Infer struct constructors.
        return dict_type

William Stein's avatar
William Stein committed
5379
    def analyse_types(self, env):
5380
        hold_errors()
Robert Bradshaw's avatar
Robert Bradshaw committed
5381 5382
        for item in self.key_value_pairs:
            item.analyse_types(env)
5383 5384
        self.obj_conversion_errors = held_errors()
        release_errors(ignore=True)
5385 5386 5387

    def may_be_none(self):
        return False
5388

5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402
    def coerce_to(self, dst_type, env):
        if dst_type.is_pyobject:
            self.release_errors()
            if not self.type.subtype_of(dst_type):
                error(self.pos, "Cannot interpret dict as type '%s'" % dst_type)
        elif dst_type.is_struct_or_union:
            self.type = dst_type
            if not dst_type.is_struct and len(self.key_value_pairs) != 1:
                error(self.pos, "Exactly one field must be specified to convert to union '%s'" % dst_type)
            elif dst_type.is_struct and len(self.key_value_pairs) < len(dst_type.scope.var_entries):
                warning(self.pos, "Not all members given for struct '%s'" % dst_type, 1)
            for item in self.key_value_pairs:
                if isinstance(item.key, CoerceToPyTypeNode):
                    item.key = item.key.arg
5403
                if not item.key.is_string_literal:
5404
                    error(item.key.pos, "Invalid struct field identifier")
5405
                    item.key = StringNode(item.key.pos, value="<error>")
5406
                else:
Stefan Behnel's avatar
Stefan Behnel committed
5407 5408
                    key = str(item.key.value) # converts string literals to unicode in Py3
                    member = dst_type.scope.lookup_here(key)
5409
                    if not member:
Stefan Behnel's avatar
Stefan Behnel committed
5410
                        error(item.key.pos, "struct '%s' has no field '%s'" % (dst_type, key))
5411 5412 5413 5414 5415 5416 5417 5418 5419
                    else:
                        value = item.value
                        if isinstance(value, CoerceToPyTypeNode):
                            value = value.arg
                        item.value = value.coerce_to(member.type, env)
        else:
            self.type = error_type
            error(self.pos, "Cannot interpret dict as type '%s'" % dst_type)
        return self
5420

5421 5422 5423 5424
    def release_errors(self):
        for err in self.obj_conversion_errors:
            report_error(err)
        self.obj_conversion_errors = []
5425 5426 5427

    gil_message = "Constructing Python dict"

William Stein's avatar
William Stein committed
5428 5429 5430
    def generate_evaluation_code(self, code):
        #  Custom method used here because key-value
        #  pairs are evaluated and used one at a time.
5431 5432
        code.mark_pos(self.pos)
        self.allocate_temp_result(code)
5433 5434 5435 5436 5437 5438
        if self.type.is_pyobject:
            self.release_errors()
            code.putln(
                "%s = PyDict_New(); %s" % (
                    self.result(),
                    code.error_goto_if_null(self.result(), self.pos)))
5439
            code.put_gotref(self.py_result())
Robert Bradshaw's avatar
Robert Bradshaw committed
5440 5441
        for item in self.key_value_pairs:
            item.generate_evaluation_code(code)
5442
            if self.type.is_pyobject:
Vitja Makarov's avatar
Vitja Makarov committed
5443 5444
                if self.exclude_null_values:
                    code.putln('if (%s) {' % item.value.py_result())
5445
                code.put_error_if_neg(self.pos,
5446 5447 5448 5449
                    "PyDict_SetItem(%s, %s, %s)" % (
                        self.result(),
                        item.key.py_result(),
                        item.value.py_result()))
Vitja Makarov's avatar
Vitja Makarov committed
5450 5451
                if self.exclude_null_values:
                    code.putln('}')
5452 5453 5454
            else:
                code.putln("%s.%s = %s;" % (
                        self.result(),
5455
                        item.key.value,
5456
                        item.value.result()))
Robert Bradshaw's avatar
Robert Bradshaw committed
5457
            item.generate_disposal_code(code)
5458
            item.free_temps(code)
5459

5460
    def annotate(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
5461 5462
        for item in self.key_value_pairs:
            item.annotate(code)
5463

5464
class DictItemNode(ExprNode):
Robert Bradshaw's avatar
Robert Bradshaw committed
5465 5466 5467 5468 5469
    # Represents a single item in a DictNode
    #
    # key          ExprNode
    # value        ExprNode
    subexprs = ['key', 'value']
5470

5471
    nogil_check = None # Parent DictNode takes care of it
5472

5473 5474 5475
    def calculate_constant_result(self):
        self.constant_result = (
            self.key.constant_result, self.value.constant_result)
5476

Robert Bradshaw's avatar
Robert Bradshaw committed
5477 5478 5479 5480 5481
    def analyse_types(self, env):
        self.key.analyse_types(env)
        self.value.analyse_types(env)
        self.key = self.key.coerce_to_pyobject(env)
        self.value = self.value.coerce_to_pyobject(env)
5482

Robert Bradshaw's avatar
Robert Bradshaw committed
5483 5484 5485
    def generate_evaluation_code(self, code):
        self.key.generate_evaluation_code(code)
        self.value.generate_evaluation_code(code)
Stefan Behnel's avatar
Stefan Behnel committed
5486

5487 5488 5489
    def generate_disposal_code(self, code):
        self.key.generate_disposal_code(code)
        self.value.generate_disposal_code(code)
5490 5491 5492 5493

    def free_temps(self, code):
        self.key.free_temps(code)
        self.value.free_temps(code)
5494

5495 5496
    def __iter__(self):
        return iter([self.key, self.value])
William Stein's avatar
William Stein committed
5497

5498

5499 5500 5501 5502 5503 5504 5505
class ModuleNameMixin(object):
    def set_mod_name(self, env):
        self.module_name = env.global_scope().qualified_name

    def get_py_mod_name(self, code):
        return code.get_py_string_const(
                 self.module_name, identifier=True)
Stefan Behnel's avatar
Stefan Behnel committed
5506

5507
class ClassNode(ExprNode, ModuleNameMixin):
William Stein's avatar
William Stein committed
5508 5509 5510 5511
    #  Helper class used in the implementation of Python
    #  class definitions. Constructs a class object given
    #  a name, tuple of bases and class dictionary.
    #
Stefan Behnel's avatar
Stefan Behnel committed
5512
    #  name         EncodedString      Name of the class
William Stein's avatar
William Stein committed
5513 5514 5515
    #  bases        ExprNode           Base class tuple
    #  dict         ExprNode           Class dict (not owned by this node)
    #  doc          ExprNode or None   Doc string
5516
    #  module_name  EncodedString      Name of defining module
5517

5518
    subexprs = ['bases', 'doc']
5519

William Stein's avatar
William Stein committed
5520 5521 5522 5523 5524 5525 5526 5527
    def analyse_types(self, env):
        self.bases.analyse_types(env)
        if self.doc:
            self.doc.analyse_types(env)
            self.doc = self.doc.coerce_to_pyobject(env)
        self.type = py_object_type
        self.is_temp = 1
        env.use_utility_code(create_class_utility_code);
5528 5529
        #TODO(craig,haoyu) This should be moved to a better place
        self.set_mod_name(env)
5530

5531
    def may_be_none(self):
Stefan Behnel's avatar
Stefan Behnel committed
5532
        return True
5533

5534 5535
    gil_message = "Constructing Python class"

William Stein's avatar
William Stein committed
5536
    def generate_result_code(self, code):
5537
        cname = code.intern_identifier(self.name)
5538

William Stein's avatar
William Stein committed
5539
        if self.doc:
5540
            code.put_error_if_neg(self.pos,
Robert Bradshaw's avatar
Robert Bradshaw committed
5541
                'PyDict_SetItemString(%s, "__doc__", %s)' % (
William Stein's avatar
William Stein committed
5542
                    self.dict.py_result(),
Robert Bradshaw's avatar
Robert Bradshaw committed
5543
                    self.doc.py_result()))
5544
        py_mod_name = self.get_py_mod_name(code)
William Stein's avatar
William Stein committed
5545
        code.putln(
5546
            '%s = __Pyx_CreateClass(%s, %s, %s, %s); %s' % (
5547
                self.result(),
William Stein's avatar
William Stein committed
5548 5549
                self.bases.py_result(),
                self.dict.py_result(),
5550
                cname,
5551
                py_mod_name,
5552
                code.error_goto_if_null(self.result(), self.pos)))
5553
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
5554

Stefan Behnel's avatar
Stefan Behnel committed
5555

5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573
class Py3ClassNode(ExprNode):
    #  Helper class used in the implementation of Python3+
    #  class definitions. Constructs a class object given
    #  a name, tuple of bases and class dictionary.
    #
    #  name         EncodedString      Name of the class
    #  dict         ExprNode           Class dict (not owned by this node)
    #  module_name  EncodedString      Name of defining module

    subexprs = []

    def analyse_types(self, env):
        self.type = py_object_type
        self.is_temp = 1

    def may_be_none(self):
        return True

5574
    gil_message = "Constructing Python class"
5575 5576

    def generate_result_code(self, code):
5577
        code.globalstate.use_utility_code(create_py3class_utility_code)
5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590
        cname = code.intern_identifier(self.name)
        code.putln(
            '%s = __Pyx_Py3ClassCreate(%s, %s, %s, %s, %s); %s' % (
                self.result(),
                self.metaclass.result(),
                cname,
                self.bases.py_result(),
                self.dict.py_result(),
                self.mkw.py_result(),
                code.error_goto_if_null(self.result(), self.pos)))
        code.put_gotref(self.py_result())

class KeywordArgsNode(ExprNode):
5591
    #  Helper class for keyword arguments.
5592
    #
5593 5594
    #  starstar_arg      DictNode
    #  keyword_args      [DictItemNode]
5595

5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621
    subexprs = ['starstar_arg', 'keyword_args']
    is_temp = 1
    type = dict_type

    def calculate_constant_result(self):
        result = dict(self.starstar_arg.constant_result)
        for item in self.keyword_args:
            key, value = item.constant_result
            if key in result:
                raise ValueError("duplicate keyword argument found: %s" % key)
            result[key] = value
        self.constant_result = result

    def compile_time_value(self, denv):
        result = self.starstar_arg.compile_time_value(denv)
        pairs = [ (item.key.compile_time_value(denv), item.value.compile_time_value(denv))
                  for item in self.keyword_args ]
        try:
            result = dict(result)
            for key, value in pairs:
                if key in result:
                    raise ValueError("duplicate keyword argument found: %s" % key)
                result[key] = value
        except Exception, e:
            self.compile_time_value_error(e)
        return result
5622

5623 5624 5625 5626 5627
    def type_dependencies(self, env):
        return ()

    def infer_type(self, env):
        return dict_type
5628 5629

    def analyse_types(self, env):
5630 5631 5632 5633 5634 5635
        self.starstar_arg.analyse_types(env)
        self.starstar_arg = self.starstar_arg.coerce_to_pyobject(env).as_none_safe_node(
            # FIXME: CPython's error message starts with the runtime function name
            'argument after ** must be a mapping, not NoneType')
        for item in self.keyword_args:
            item.analyse_types(env)
5636

5637 5638
    def may_be_none(self):
        return False
5639

5640 5641 5642 5643 5644 5645 5646 5647 5648 5649
    gil_message = "Constructing Python dict"

    def generate_evaluation_code(self, code):
        code.mark_pos(self.pos)
        self.allocate_temp_result(code)
        self.starstar_arg.generate_evaluation_code(code)
        if self.starstar_arg.type is not Builtin.dict_type:
            # CPython supports calling functions with non-dicts, so do we
            code.putln('if (likely(PyDict_Check(%s))) {' %
                       self.starstar_arg.py_result())
5650 5651 5652 5653 5654 5655
        if self.keyword_args:
            code.putln(
                "%s = PyDict_Copy(%s); %s" % (
                    self.result(),
                    self.starstar_arg.py_result(),
                    code.error_goto_if_null(self.result(), self.pos)))
5656
            code.put_gotref(self.py_result())
5657
        else:
5658 5659 5660 5661 5662 5663
            code.putln("%s = %s;" % (
                self.result(),
                self.starstar_arg.py_result()))
            code.put_incref(self.result(), py_object_type)
        if self.starstar_arg.type is not Builtin.dict_type:
            code.putln('} else {')
5664
            code.putln(
5665 5666
                "%s = PyObject_CallFunctionObjArgs("
                "(PyObject*)&PyDict_Type, %s, NULL); %s" % (
5667
                    self.result(),
5668
                    self.starstar_arg.py_result(),
5669
                    code.error_goto_if_null(self.result(), self.pos)))
5670
            code.put_gotref(self.py_result())
5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700
            code.putln('}')
        self.starstar_arg.generate_disposal_code(code)
        self.starstar_arg.free_temps(code)

        if not self.keyword_args:
            return

        code.globalstate.use_utility_code(Nodes.raise_double_keywords_utility_code)
        for item in self.keyword_args:
            item.generate_evaluation_code(code)
            code.putln("if (unlikely(PyDict_GetItem(%s, %s))) {" % (
                    self.result(),
                    item.key.py_result()))
            # FIXME: find out function name at runtime!
            code.putln('__Pyx_RaiseDoubleKeywordsError("function", %s); %s' % (
                item.key.py_result(),
                code.error_goto(self.pos)))
            code.putln("}")
            code.put_error_if_neg(self.pos,
                "PyDict_SetItem(%s, %s, %s)" % (
                    self.result(),
                    item.key.py_result(),
                    item.value.py_result()))
            item.generate_disposal_code(code)
            item.free_temps(code)

    def annotate(self, code):
        self.starstar_arg.annotate(code)
        for item in self.keyword_args:
            item.annotate(code)
5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768

class PyClassMetaclassNode(ExprNode):
    # Helper class holds Python3 metaclass object
    #
    #  bases        ExprNode           Base class tuple (not owned by this node)
    #  mkw          ExprNode           Class keyword arguments (not owned by this node)

    subexprs = []

    def analyse_types(self, env):
        self.type = py_object_type
        self.is_temp = True

    def may_be_none(self):
        return True

    def generate_result_code(self, code):
        code.putln(
            "%s = __Pyx_Py3MetaclassGet(%s, %s); %s" % (
                self.result(),
                self.bases.result(),
                self.mkw.result(),
                code.error_goto_if_null(self.result(), self.pos)))
        code.put_gotref(self.py_result())

class PyClassNamespaceNode(ExprNode, ModuleNameMixin):
    # Helper class holds Python3 namespace object
    #
    # All this are not owned by this node
    #  metaclass    ExprNode           Metaclass object
    #  bases        ExprNode           Base class tuple
    #  mkw          ExprNode           Class keyword arguments
    #  doc          ExprNode or None   Doc string (owned)

    subexprs = ['doc']

    def analyse_types(self, env):
        self.bases.analyse_types(env)
        if self.doc:
            self.doc.analyse_types(env)
            self.doc = self.doc.coerce_to_pyobject(env)
        self.type = py_object_type
        self.is_temp = 1
        #TODO(craig,haoyu) This should be moved to a better place
        self.set_mod_name(env)

    def may_be_none(self):
        return True

    def generate_result_code(self, code):
        cname = code.intern_identifier(self.name)
        py_mod_name = self.get_py_mod_name(code)
        if self.doc:
            doc_code = self.doc.result()
        else:
            doc_code = '(PyObject *) NULL'
        code.putln(
            "%s = __Pyx_Py3MetaclassPrepare(%s, %s, %s, %s, %s, %s); %s" % (
                self.result(),
                self.metaclass.result(),
                self.bases.result(),
                cname,
                self.mkw.result(),
                py_mod_name,
                doc_code,
                code.error_goto_if_null(self.result(), self.pos)))
        code.put_gotref(self.py_result())

Robert Bradshaw's avatar
Robert Bradshaw committed
5769 5770 5771 5772 5773 5774 5775
class BoundMethodNode(ExprNode):
    #  Helper class used in the implementation of Python
    #  class definitions. Constructs an bound method
    #  object from a class and a function.
    #
    #  function      ExprNode   Function object
    #  self_object   ExprNode   self object
5776

Robert Bradshaw's avatar
Robert Bradshaw committed
5777
    subexprs = ['function']
5778

Robert Bradshaw's avatar
Robert Bradshaw committed
5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794
    def analyse_types(self, env):
        self.function.analyse_types(env)
        self.type = py_object_type
        self.is_temp = 1

    gil_message = "Constructing an bound method"

    def generate_result_code(self, code):
        code.putln(
            "%s = PyMethod_New(%s, %s, (PyObject*)%s->ob_type); %s" % (
                self.result(),
                self.function.py_result(),
                self.self_object.py_result(),
                self.self_object.py_result(),
                code.error_goto_if_null(self.result(), self.pos)))
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
5795

5796
class UnboundMethodNode(ExprNode):
William Stein's avatar
William Stein committed
5797 5798 5799 5800 5801
    #  Helper class used in the implementation of Python
    #  class definitions. Constructs an unbound method
    #  object from a class and a function.
    #
    #  function      ExprNode   Function object
5802

5803 5804
    type = py_object_type
    is_temp = 1
5805

William Stein's avatar
William Stein committed
5806
    subexprs = ['function']
5807

William Stein's avatar
William Stein committed
5808 5809
    def analyse_types(self, env):
        self.function.analyse_types(env)
5810

5811 5812 5813
    def may_be_none(self):
        return False

5814 5815
    gil_message = "Constructing an unbound method"

William Stein's avatar
William Stein committed
5816
    def generate_result_code(self, code):
5817
        class_cname = code.pyclass_stack[-1].classobj.result()
William Stein's avatar
William Stein committed
5818
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
5819
            "%s = PyMethod_New(%s, 0, %s); %s" % (
5820
                self.result(),
William Stein's avatar
William Stein committed
5821
                self.function.py_result(),
5822
                class_cname,
5823
                code.error_goto_if_null(self.result(), self.pos)))
5824
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
5825

Robert Bradshaw's avatar
Robert Bradshaw committed
5826

5827
class PyCFunctionNode(ExprNode, ModuleNameMixin):
William Stein's avatar
William Stein committed
5828 5829 5830 5831
    #  Helper class used in the implementation of Python
    #  class definitions. Constructs a PyCFunction object
    #  from a PyMethodDef struct.
    #
5832
    #  pymethdef_cname   string             PyMethodDef structure
Robert Bradshaw's avatar
Robert Bradshaw committed
5833
    #  self_object       ExprNode or None
Robert Bradshaw's avatar
Robert Bradshaw committed
5834
    #  binding           bool
5835
    #  def_node          DefNode            the Python function node
5836
    #  module_name       EncodedString      Name of defining module
5837 5838 5839
    #  code_object       CodeObjectNode     the PyCodeObject creator node

    subexprs = ['code_object']
Stefan Behnel's avatar
Stefan Behnel committed
5840

Robert Bradshaw's avatar
Robert Bradshaw committed
5841
    self_object = None
5842
    code_object = None
Robert Bradshaw's avatar
Robert Bradshaw committed
5843
    binding = False
5844
    def_node = None
5845

5846 5847
    type = py_object_type
    is_temp = 1
5848

5849 5850
    specialized_cpdefs = None

William Stein's avatar
William Stein committed
5851
    def analyse_types(self, env):
5852 5853 5854
        if self.specialized_cpdefs:
            self.binding = True

Robert Bradshaw's avatar
Robert Bradshaw committed
5855
        if self.binding:
5856 5857 5858 5859
            if self.specialized_cpdefs:
                env.use_utility_code(fused_function_utility_code)
            else:
                env.use_utility_code(binding_cfunc_utility_code)
5860

5861 5862 5863
        #TODO(craig,haoyu) This should be moved to a better place
        self.set_mod_name(env)

5864 5865
    def may_be_none(self):
        return False
5866

5867 5868
    gil_message = "Constructing Python function"

Stefan Behnel's avatar
Stefan Behnel committed
5869
    def self_result_code(self):
Robert Bradshaw's avatar
Robert Bradshaw committed
5870 5871 5872 5873
        if self.self_object is None:
            self_result = "NULL"
        else:
            self_result = self.self_object.py_result()
Stefan Behnel's avatar
Stefan Behnel committed
5874 5875 5876
        return self_result

    def generate_result_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
5877
        if self.binding:
5878 5879 5880
            self.generate_cyfunction_code(code)
        else:
            self.generate_pycfunction_code(code)
5881

5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896
    def generate_pycfunction_code(self, code):
        py_mod_name = self.get_py_mod_name(code)
        code.putln(
            '%s = PyCFunction_NewEx(&%s, %s, %s); %s' % (
                self.result(),
                self.pymethdef_cname,
                self.self_result_code(),
                py_mod_name,
                code.error_goto_if_null(self.result(), self.pos)))

        code.put_gotref(self.py_result())

    def generate_cyfunction_code(self, code):
        if self.specialized_cpdefs:
            constructor = "__pyx_FusedFunction_NewEx"
Robert Bradshaw's avatar
Robert Bradshaw committed
5897
        else:
5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913
            constructor = "__Pyx_CyFunction_NewEx"

        if self.code_object:
            code_object_result = self.code_object.py_result()
        else:
            code_object_result = 'NULL'

        flags = []
        if self.def_node.is_staticmethod:
            flags.append('__Pyx_CYFUNCTION_STATICMETHOD')
        elif self.def_node.is_classmethod:
            flags.append('__Pyx_CYFUNCTION_CLASSMETHOD')
        if flags:
            flags = ' | '.join(flags)
        else:
            flags = '0'
5914

5915
        py_mod_name = self.get_py_mod_name(code)
William Stein's avatar
William Stein committed
5916
        code.putln(
5917
            '%s = %s(&%s, %s, %s, %s, %s); %s' % (
5918
                self.result(),
Robert Bradshaw's avatar
Robert Bradshaw committed
5919
                constructor,
William Stein's avatar
William Stein committed
5920
                self.pymethdef_cname,
5921
                flags,
Stefan Behnel's avatar
Stefan Behnel committed
5922
                self.self_result_code(),
5923
                py_mod_name,
5924
                code_object_result,
5925
                code.error_goto_if_null(self.result(), self.pos)))
5926

5927
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
5928

5929
        if self.specialized_cpdefs:
5930
            self.generate_fused_cpdef(code, code_object_result, flags)
5931

5932
    def generate_fused_cpdef(self, code, code_object_result, flags):
5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952
        """
        Generate binding function objects for all specialized cpdefs, and the
        original fused one. The fused function gets a dict __signatures__
        mapping the specialized signature to the specialized binding function.
        In Python space, the specialized versions can be obtained by indexing
        the fused function.

        For unsubscripted dispatch, we also need to remember the positions of
        the arguments with fused types.
        """
        def goto_err(string):
            string = "(%s)" % string
            code.putln(code.error_goto_if_null(string % fmt_dict, self.pos))

        # Set up an interpolation dict
        fmt_dict = dict(
            vars(Naming),
            result=self.result(),
            py_mod_name=self.get_py_mod_name(code),
            self=self.self_result_code(),
5953
            code=code_object_result,
5954
            flags=flags,
5955 5956 5957 5958 5959 5960 5961
            func=code.funcstate.allocate_temp(py_object_type,
                                              manage_ref=True),
            signature=code.funcstate.allocate_temp(py_object_type,
                                                   manage_ref=True),
        )

        fmt_dict['sigdict'] = \
5962
            "((__pyx_FusedFunctionObject *) %(result)s)->__signatures__" % fmt_dict
5963

5964
        # Initialize __signatures__
5965 5966 5967 5968 5969 5970 5971 5972 5973 5974
        goto_err("%(sigdict)s = PyDict_New()")

        # Now put all specialized cpdefs in __signatures__
        for cpdef in self.specialized_cpdefs:
            fmt_dict['signature_string'] = cpdef.specialized_signature_string
            fmt_dict['pymethdef_cname'] = cpdef.entry.pymethdef_cname

            goto_err('%(signature)s = PyUnicode_FromString('
                                    '"%(signature_string)s")')

5975
            goto_err("%(func)s = __pyx_FusedFunction_NewEx("
5976
                            "&%(pymethdef_cname)s, %(flags)s, %(self)s, %(py_mod_name)s, %(code)s)")
5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987

            s = "PyDict_SetItem(%(sigdict)s, %(signature)s, %(func)s)"
            code.put_error_if_neg(self.pos, s % fmt_dict)

            code.putln("Py_DECREF(%(signature)s); %(signature)s = NULL;" % fmt_dict)
            code.putln("Py_DECREF(%(func)s); %(func)s = NULL;" % fmt_dict)

        code.funcstate.release_temp(fmt_dict['func'])
        code.funcstate.release_temp(fmt_dict['signature'])


Stefan Behnel's avatar
Stefan Behnel committed
5988 5989 5990
class InnerFunctionNode(PyCFunctionNode):
    # Special PyCFunctionNode that depends on a closure class
    #
Vitja Makarov's avatar
Vitja Makarov committed
5991

Robert Bradshaw's avatar
Robert Bradshaw committed
5992
    binding = True
Vitja Makarov's avatar
Vitja Makarov committed
5993 5994
    needs_self_code = True

Stefan Behnel's avatar
Stefan Behnel committed
5995
    def self_result_code(self):
Vitja Makarov's avatar
Vitja Makarov committed
5996 5997 5998
        if self.needs_self_code:
            return "((PyObject*)%s)" % (Naming.cur_scope_cname)
        return "NULL"
Stefan Behnel's avatar
Stefan Behnel committed
5999

6000 6001 6002 6003
class CodeObjectNode(ExprNode):
    # Create a PyCodeObject for a CyFunction instance.
    #
    # def_node   DefNode    the Python function node
6004
    # varnames   TupleNode  a tuple with all local variable names
6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015

    subexprs = ['varnames']
    is_temp = False

    def __init__(self, def_node):
        ExprNode.__init__(self, def_node.pos, def_node=def_node)
        args = list(def_node.args)
        if def_node.star_arg:
            args.append(def_node.star_arg)
        if def_node.starstar_arg:
            args.append(def_node.starstar_arg)
6016
        local_vars = [ arg for arg in def_node.local_scope.var_entries
6017
                       if arg.name ]
6018 6019
        self.varnames = TupleNode(
            def_node.pos,
6020
            args = [ IdentifierStringNode(arg.pos, value=arg.name)
6021
                     for arg in args + local_vars ],
6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046
            is_temp = 0,
            is_literal = 1)

    def calculate_result_code(self):
        return self.result_code

    def generate_result_code(self, code):
        self.result_code = code.get_py_const(py_object_type, 'codeobj_', cleanup_level=2)

        code = code.get_cached_constants_writer()
        code.mark_pos(self.pos)
        func = self.def_node
        func_name = code.get_py_string_const(
            func.name, identifier=True, is_str=False, unicode_value=func.name)
        # FIXME: better way to get the module file path at module init time? Encoding to use?
        file_path = StringEncoding.BytesLiteral(func.pos[0].get_filenametable_entry().encode('utf8'))
        file_path_const = code.get_py_string_const(file_path, identifier=False, is_str=True)

        code.putln("%s = (PyObject*)__Pyx_PyCode_New(%d, %d, %d, 0, 0, %s, %s, %s, %s, %s, %s, %s, %s, %d, %s); %s" % (
            self.result_code,
            len(func.args),            # argcount
            func.num_kwonly_args,      # kwonlyargcount (Py3 only)
            len(self.varnames.args),   # nlocals
            Naming.empty_bytes,        # code
            Naming.empty_tuple,        # consts
6047 6048
            Naming.empty_tuple,        # names (FIXME)
            self.varnames.result(),    # varnames
6049 6050 6051 6052 6053 6054 6055 6056 6057 6058
            Naming.empty_tuple,        # freevars (FIXME)
            Naming.empty_tuple,        # cellvars (FIXME)
            file_path_const,           # filename
            func_name,                 # name
            self.pos[1],               # firstlineno
            Naming.empty_bytes,        # lnotab
            code.error_goto_if_null(self.result_code, self.pos),
            ))


Stefan Behnel's avatar
Stefan Behnel committed
6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073
class LambdaNode(InnerFunctionNode):
    # Lambda expression node (only used as a function reference)
    #
    # args          [CArgDeclNode]         formal arguments
    # star_arg      PyArgDeclNode or None  * argument
    # starstar_arg  PyArgDeclNode or None  ** argument
    # lambda_name   string                 a module-globally unique lambda name
    # result_expr   ExprNode
    # def_node      DefNode                the underlying function 'def' node

    child_attrs = ['def_node']

    name = StringEncoding.EncodedString('<lambda>')

    def analyse_declarations(self, env):
6074 6075
        self.def_node.no_assignment_synthesis = True
        self.def_node.pymethdef_required = True
Stefan Behnel's avatar
Stefan Behnel committed
6076 6077 6078 6079
        self.def_node.analyse_declarations(env)
        self.pymethdef_cname = self.def_node.entry.pymethdef_cname
        env.add_lambda_def(self.def_node)

6080 6081 6082 6083 6084 6085 6086 6087
    def analyse_types(self, env):
        self.def_node.analyse_expressions(env)
        super(LambdaNode, self).analyse_types(env)

    def generate_result_code(self, code):
        self.def_node.generate_execution_code(code)
        super(LambdaNode, self).generate_result_code(code)

6088

6089 6090 6091 6092 6093 6094 6095 6096
class GeneratorExpressionNode(LambdaNode):
    # A generator expression, e.g.  (i for i in range(10))
    #
    # Result is a generator.
    #
    # loop      ForStatNode   the for-loop, containing a YieldExprNode
    # def_node  DefNode       the underlying generator 'def' node

6097
    name = StringEncoding.EncodedString('genexpr')
6098 6099 6100
    binding = False

    def analyse_declarations(self, env):
6101 6102 6103
        super(GeneratorExpressionNode, self).analyse_declarations(env)
        # No pymethdef required
        self.def_node.pymethdef_required = False
6104 6105
        # Force genexpr signature
        self.def_node.entry.signature = TypeSlots.pyfunction_noargs
6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116

    def generate_result_code(self, code):
        code.putln(
            '%s = %s(%s, NULL); %s' % (
                self.result(),
                self.def_node.entry.func_cname,
                self.self_result_code(),
                code.error_goto_if_null(self.result(), self.pos)))
        code.put_gotref(self.py_result())


6117 6118 6119 6120 6121
class YieldExprNode(ExprNode):
    # Yield expression node
    #
    # arg         ExprNode   the value to return from the generator
    # label_name  string     name of the C label used for this yield
6122
    # label_num   integer    yield label number
6123 6124 6125

    subexprs = ['arg']
    type = py_object_type
6126
    label_num = 0
6127 6128

    def analyse_types(self, env):
6129 6130
        if not self.label_num:
            error(self.pos, "'yield' not supported here")
6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151
        self.is_temp = 1
        if self.arg is not None:
            self.arg.analyse_types(env)
            if not self.arg.type.is_pyobject:
                self.arg = self.arg.coerce_to_pyobject(env)

    def generate_evaluation_code(self, code):
        self.label_name = code.new_label('resume_from_yield')
        code.use_label(self.label_name)
        if self.arg:
            self.arg.generate_evaluation_code(code)
            self.arg.make_owned_reference(code)
            code.putln(
                "%s = %s;" % (
                    Naming.retval_cname,
                    self.arg.result_as(py_object_type)))
            self.arg.generate_post_assignment_code(code)
            #self.arg.generate_disposal_code(code)
            self.arg.free_temps(code)
        else:
            code.put_init_to_py_none(Naming.retval_cname, py_object_type)
6152
        saved = []
6153
        code.funcstate.closure_temps.reset()
6154
        for cname, type, manage_ref in code.funcstate.temps_in_use():
6155
            save_cname = code.funcstate.closure_temps.allocate_temp(type)
6156 6157 6158 6159
            saved.append((cname, save_cname, type))
            if type.is_pyobject:
                code.put_xgiveref(cname)
            code.putln('%s->%s = %s;' % (Naming.cur_scope_cname, save_cname, cname))
6160

6161
        code.put_xgiveref(Naming.retval_cname)
6162
        code.put_finish_refcount_context()
Stefan Behnel's avatar
Stefan Behnel committed
6163
        code.putln("/* return from generator, yielding value */")
6164 6165 6166
        code.putln("%s->%s.resume_label = %d;" % (Naming.cur_scope_cname, Naming.obj_base_cname, self.label_num))
        code.putln("return %s;" % Naming.retval_cname);
        code.put_label(self.label_name)
6167 6168 6169 6170 6171 6172
        for cname, save_cname, type in saved:
            code.putln('%s = %s->%s;' % (cname, Naming.cur_scope_cname, save_cname))
            if type.is_pyobject:
                code.putln('%s->%s = 0;' % (Naming.cur_scope_cname, save_cname))
            if type.is_pyobject:
                code.put_xgotref(cname)
6173 6174 6175 6176 6177 6178 6179 6180
        if self.result_is_used:
            self.allocate_temp_result(code)
            code.putln('%s = %s; %s' %
                       (self.result(), Naming.sent_value_cname,
                        code.error_goto_if_null(self.result(), self.pos)))
            code.put_incref(self.result(), py_object_type)
        else:
            code.putln(code.error_goto_if_null(Naming.sent_value_cname, self.pos))
6181

Vitja Makarov's avatar
Vitja Makarov committed
6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197

class GlobalsExprNode(AtomicExprNode):
    type = dict_type
    is_temp = 1

    def analyse_types(self, env):
        env.use_utility_code(Builtin.globals_utility_code)

    gil_message = "Constructing globals dict"

    def generate_result_code(self, code):
        code.putln('%s = __Pyx_Globals(); %s' % (
            self.result(),
            code.error_goto_if_null(self.result(), self.pos)))
        code.put_gotref(self.result())

Vitja Makarov's avatar
Vitja Makarov committed
6198

6199
class FuncLocalsExprNode(DictNode):
Vitja Makarov's avatar
Vitja Makarov committed
6200 6201 6202 6203 6204 6205 6206 6207
    def __init__(self, pos, env):
        local_vars = [var.name for var in env.entries.values() if var.name]
        items = [DictItemNode(pos, key=IdentifierStringNode(pos, value=var),
                              value=NameNode(pos, name=var, allow_null=True))
                 for var in local_vars]
        DictNode.__init__(self, pos, key_value_pairs=items,
                          exclude_null_values=True)

6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232

class PyClassLocalsExprNode(AtomicExprNode):
    def __init__(self, pos, pyclass_dict):
        AtomicExprNode.__init__(self, pos)
        self.pyclass_dict = pyclass_dict

    def analyse_types(self, env):
        self.type = self.pyclass_dict.type
        self.is_tmep = 0

    def result(self):
        return self.pyclass_dict.result()

    def generate_result_code(self, code):
        pass


def LocalsExprNode(pos, scope_node, env):
    if env.is_module_scope:
        return GlobalsExprNode(pos)
    if env.is_py_class_scope:
        return PyClassLocalsExprNode(pos, scope_node.dict)
    return FuncLocalsExprNode(pos, env)


William Stein's avatar
William Stein committed
6233 6234 6235 6236 6237 6238
#-------------------------------------------------------------------
#
#  Unary operator nodes
#
#-------------------------------------------------------------------

6239 6240 6241 6242 6243 6244 6245
compile_time_unary_operators = {
    'not': operator.not_,
    '~': operator.inv,
    '-': operator.neg,
    '+': operator.pos,
}

6246
class UnopNode(ExprNode):
William Stein's avatar
William Stein committed
6247 6248 6249 6250 6251 6252 6253 6254 6255 6256
    #  operator     string
    #  operand      ExprNode
    #
    #  Processing during analyse_expressions phase:
    #
    #    analyse_c_operation
    #      Called when the operand is not a pyobject.
    #      - Check operand type and coerce if needed.
    #      - Determine result type and result code fragment.
    #      - Allocate temporary for result if needed.
6257

William Stein's avatar
William Stein committed
6258
    subexprs = ['operand']
Robert Bradshaw's avatar
Robert Bradshaw committed
6259
    infix = True
6260 6261 6262 6263

    def calculate_constant_result(self):
        func = compile_time_unary_operators[self.operator]
        self.constant_result = func(self.operand.constant_result)
6264

6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275
    def compile_time_value(self, denv):
        func = compile_time_unary_operators.get(self.operator)
        if not func:
            error(self.pos,
                "Unary '%s' not supported in compile-time expression"
                    % self.operator)
        operand = self.operand.compile_time_value(denv)
        try:
            return func(operand)
        except Exception, e:
            self.compile_time_value_error(e)
6276

6277
    def infer_type(self, env):
6278 6279 6280 6281 6282
        operand_type = self.operand.infer_type(env)
        if operand_type.is_pyobject:
            return py_object_type
        else:
            return operand_type
6283

William Stein's avatar
William Stein committed
6284 6285 6286 6287 6288 6289
    def analyse_types(self, env):
        self.operand.analyse_types(env)
        if self.is_py_operation():
            self.coerce_operand_to_pyobject(env)
            self.type = py_object_type
            self.is_temp = 1
6290 6291
        elif self.is_cpp_operation():
            self.analyse_cpp_operation(env)
William Stein's avatar
William Stein committed
6292 6293
        else:
            self.analyse_c_operation(env)
6294

William Stein's avatar
William Stein committed
6295
    def check_const(self):
6296
        return self.operand.check_const()
6297

William Stein's avatar
William Stein committed
6298 6299
    def is_py_operation(self):
        return self.operand.type.is_pyobject
6300

6301
    def nogil_check(self, env):
6302
        if self.is_py_operation():
6303
            self.gil_error()
6304

Danilo Freitas's avatar
Danilo Freitas committed
6305
    def is_cpp_operation(self):
Robert Bradshaw's avatar
Robert Bradshaw committed
6306
        type = self.operand.type
Robert Bradshaw's avatar
Robert Bradshaw committed
6307
        return type.is_cpp_class
6308

William Stein's avatar
William Stein committed
6309 6310
    def coerce_operand_to_pyobject(self, env):
        self.operand = self.operand.coerce_to_pyobject(env)
6311

William Stein's avatar
William Stein committed
6312 6313 6314
    def generate_result_code(self, code):
        if self.operand.type.is_pyobject:
            self.generate_py_operation_code(code)
6315

William Stein's avatar
William Stein committed
6316 6317 6318
    def generate_py_operation_code(self, code):
        function = self.py_operation_function()
        code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
6319
            "%s = %s(%s); %s" % (
6320 6321
                self.result(),
                function,
William Stein's avatar
William Stein committed
6322
                self.operand.py_result(),
6323
                code.error_goto_if_null(self.result(), self.pos)))
6324
        code.put_gotref(self.py_result())
6325

William Stein's avatar
William Stein committed
6326 6327 6328 6329 6330 6331
    def type_error(self):
        if not self.operand.type.is_error:
            error(self.pos, "Invalid operand type for '%s' (%s)" %
                (self.operator, self.operand.type))
        self.type = PyrexTypes.error_type

Danilo Freitas's avatar
Danilo Freitas committed
6332
    def analyse_cpp_operation(self, env):
6333
        type = self.operand.type
Robert Bradshaw's avatar
Robert Bradshaw committed
6334
        if type.is_ptr:
Danilo Freitas's avatar
Danilo Freitas committed
6335
            type = type.base_type
Robert Bradshaw's avatar
Robert Bradshaw committed
6336
        function = type.scope.lookup("operator%s" % self.operator)
Danilo Freitas's avatar
Danilo Freitas committed
6337 6338
        if not function:
            error(self.pos, "'%s' operator not defined for %s"
6339
                % (self.operator, type))
Danilo Freitas's avatar
Danilo Freitas committed
6340 6341
            self.type_error()
            return
6342 6343 6344 6345
        func_type = function.type
        if func_type.is_ptr:
            func_type = func_type.base_type
        self.type = func_type.return_type
Danilo Freitas's avatar
Danilo Freitas committed
6346

William Stein's avatar
William Stein committed
6347

6348
class NotNode(ExprNode):
William Stein's avatar
William Stein committed
6349 6350 6351
    #  'not' operator
    #
    #  operand   ExprNode
6352

6353
    type = PyrexTypes.c_bint_type
6354

6355
    subexprs = ['operand']
6356

6357 6358 6359
    def calculate_constant_result(self):
        self.constant_result = not self.operand.constant_result

6360 6361 6362 6363 6364 6365 6366
    def compile_time_value(self, denv):
        operand = self.operand.compile_time_value(denv)
        try:
            return not operand
        except Exception, e:
            self.compile_time_value_error(e)

6367 6368
    def infer_type(self, env):
        return PyrexTypes.c_bint_type
6369

William Stein's avatar
William Stein committed
6370 6371 6372
    def analyse_types(self, env):
        self.operand.analyse_types(env)
        self.operand = self.operand.coerce_to_boolean(env)
6373

William Stein's avatar
William Stein committed
6374
    def calculate_result_code(self):
6375
        return "(!%s)" % self.operand.result()
6376

William Stein's avatar
William Stein committed
6377 6378 6379 6380 6381 6382
    def generate_result_code(self, code):
        pass


class UnaryPlusNode(UnopNode):
    #  unary '+' operator
6383

William Stein's avatar
William Stein committed
6384
    operator = '+'
6385

William Stein's avatar
William Stein committed
6386
    def analyse_c_operation(self, env):
Lisandro Dalcin's avatar
Lisandro Dalcin committed
6387
        self.type = PyrexTypes.widest_numeric_type(
Robert Bradshaw's avatar
Robert Bradshaw committed
6388
            self.operand.type, PyrexTypes.c_int_type)
6389

William Stein's avatar
William Stein committed
6390 6391
    def py_operation_function(self):
        return "PyNumber_Positive"
6392

William Stein's avatar
William Stein committed
6393
    def calculate_result_code(self):
6394 6395 6396 6397
        if self.is_cpp_operation():
            return "(+%s)" % self.operand.result()
        else:
            return self.operand.result()
William Stein's avatar
William Stein committed
6398 6399 6400 6401


class UnaryMinusNode(UnopNode):
    #  unary '-' operator
6402

William Stein's avatar
William Stein committed
6403
    operator = '-'
6404

William Stein's avatar
William Stein committed
6405 6406
    def analyse_c_operation(self, env):
        if self.operand.type.is_numeric:
6407 6408
            self.type = PyrexTypes.widest_numeric_type(
                self.operand.type, PyrexTypes.c_int_type)
6409 6410
        elif self.operand.type.is_enum:
            self.type = PyrexTypes.c_int_type
William Stein's avatar
William Stein committed
6411 6412
        else:
            self.type_error()
Robert Bradshaw's avatar
Robert Bradshaw committed
6413
        if self.type.is_complex:
6414
            self.infix = False
6415

William Stein's avatar
William Stein committed
6416 6417
    def py_operation_function(self):
        return "PyNumber_Negative"
6418

William Stein's avatar
William Stein committed
6419
    def calculate_result_code(self):
Robert Bradshaw's avatar
Robert Bradshaw committed
6420 6421 6422 6423
        if self.infix:
            return "(-%s)" % self.operand.result()
        else:
            return "%s(%s)" % (self.operand.type.unary_op('-'), self.operand.result())
William Stein's avatar
William Stein committed
6424

6425 6426 6427 6428 6429
    def get_constant_c_result_code(self):
        value = self.operand.get_constant_c_result_code()
        if value:
            return "(-%s)" % (value)

William Stein's avatar
William Stein committed
6430 6431 6432 6433 6434
class TildeNode(UnopNode):
    #  unary '~' operator

    def analyse_c_operation(self, env):
        if self.operand.type.is_int:
6435 6436
            self.type = PyrexTypes.widest_numeric_type(
                self.operand.type, PyrexTypes.c_int_type)
6437 6438
        elif self.operand.type.is_enum:
            self.type = PyrexTypes.c_int_type
William Stein's avatar
William Stein committed
6439 6440 6441 6442 6443
        else:
            self.type_error()

    def py_operation_function(self):
        return "PyNumber_Invert"
6444

William Stein's avatar
William Stein committed
6445
    def calculate_result_code(self):
6446
        return "(~%s)" % self.operand.result()
William Stein's avatar
William Stein committed
6447 6448


6449 6450
class CUnopNode(UnopNode):

Robert Bradshaw's avatar
Robert Bradshaw committed
6451 6452 6453
    def is_py_operation(self):
        return False

6454 6455
class DereferenceNode(CUnopNode):
    #  unary * operator
6456 6457

    operator = '*'
6458

Robert Bradshaw's avatar
Robert Bradshaw committed
6459 6460 6461 6462 6463 6464 6465 6466
    def analyse_c_operation(self, env):
        if self.operand.type.is_ptr:
            self.type = self.operand.type.base_type
        else:
            self.type_error()

    def calculate_result_code(self):
        return "(*%s)" % self.operand.result()
William Stein's avatar
William Stein committed
6467 6468


6469 6470
class DecrementIncrementNode(CUnopNode):
    #  unary ++/-- operator
6471

6472
    def analyse_c_operation(self, env):
6473 6474 6475 6476
        if self.operand.type.is_numeric:
            self.type = PyrexTypes.widest_numeric_type(
                self.operand.type, PyrexTypes.c_int_type)
        elif self.operand.type.is_ptr:
6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490
            self.type = self.operand.type
        else:
            self.type_error()

    def calculate_result_code(self):
        if self.is_prefix:
            return "(%s%s)" % (self.operator, self.operand.result())
        else:
            return "(%s%s)" % (self.operand.result(), self.operator)

def inc_dec_constructor(is_prefix, operator):
    return lambda pos, **kwds: DecrementIncrementNode(pos, is_prefix=is_prefix, operator=operator, **kwds)


6491
class AmpersandNode(ExprNode):
William Stein's avatar
William Stein committed
6492 6493 6494
    #  The C address-of operator.
    #
    #  operand  ExprNode
6495

William Stein's avatar
William Stein committed
6496
    subexprs = ['operand']
6497

6498 6499
    def infer_type(self, env):
        return PyrexTypes.c_ptr_type(self.operand.infer_type(env))
William Stein's avatar
William Stein committed
6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510

    def analyse_types(self, env):
        self.operand.analyse_types(env)
        argtype = self.operand.type
        if not (argtype.is_cfunction or self.operand.is_lvalue()):
            self.error("Taking address of non-lvalue")
            return
        if argtype.is_pyobject:
            self.error("Cannot take address of Python variable")
            return
        self.type = PyrexTypes.c_ptr_type(argtype)
6511

William Stein's avatar
William Stein committed
6512
    def check_const(self):
6513
        return self.operand.check_const_addr()
6514

William Stein's avatar
William Stein committed
6515 6516 6517 6518
    def error(self, mess):
        error(self.pos, mess)
        self.type = PyrexTypes.error_type
        self.result_code = "<error>"
6519

William Stein's avatar
William Stein committed
6520
    def calculate_result_code(self):
6521
        return "(&%s)" % self.operand.result()
William Stein's avatar
William Stein committed
6522 6523 6524

    def generate_result_code(self, code):
        pass
6525

William Stein's avatar
William Stein committed
6526 6527 6528 6529 6530 6531 6532 6533

unop_node_classes = {
    "+":  UnaryPlusNode,
    "-":  UnaryMinusNode,
    "~":  TildeNode,
}

def unop_node(pos, operator, operand):
6534
    # Construct unnop node of appropriate class for
William Stein's avatar
William Stein committed
6535
    # given operator.
6536
    if isinstance(operand, IntNode) and operator == '-':
6537
        return IntNode(pos = operand.pos, value = str(-Utils.str_to_number(operand.value)))
Robert Bradshaw's avatar
Robert Bradshaw committed
6538 6539
    elif isinstance(operand, UnopNode) and operand.operator == operator:
        warning(pos, "Python has no increment/decrement operator: %s%sx = %s(%sx) = x" % ((operator,)*4), 5)
6540 6541
    return unop_node_classes[operator](pos,
        operator = operator,
William Stein's avatar
William Stein committed
6542 6543 6544
        operand = operand)


6545
class TypecastNode(ExprNode):
William Stein's avatar
William Stein committed
6546 6547
    #  C type cast
    #
6548
    #  operand      ExprNode
William Stein's avatar
William Stein committed
6549 6550
    #  base_type    CBaseTypeNode
    #  declarator   CDeclaratorNode
6551 6552 6553
    #
    #  If used from a transform, one can if wanted specify the attribute
    #  "type" directly and leave base_type and declarator to None
6554

William Stein's avatar
William Stein committed
6555
    subexprs = ['operand']
6556
    base_type = declarator = type = None
6557

Robert Bradshaw's avatar
Robert Bradshaw committed
6558
    def type_dependencies(self, env):
6559
        return ()
6560

Robert Bradshaw's avatar
Robert Bradshaw committed
6561
    def infer_type(self, env):
6562 6563 6564 6565
        if self.type is None:
            base_type = self.base_type.analyse(env)
            _, self.type = self.declarator.analyse(base_type, env)
        return self.type
6566

William Stein's avatar
William Stein committed
6567
    def analyse_types(self, env):
6568 6569 6570
        if self.type is None:
            base_type = self.base_type.analyse(env)
            _, self.type = self.declarator.analyse(base_type, env)
6571 6572 6573 6574
        if self.type.is_cfunction:
            error(self.pos,
                "Cannot cast to a function type")
            self.type = PyrexTypes.error_type
William Stein's avatar
William Stein committed
6575 6576 6577
        self.operand.analyse_types(env)
        to_py = self.type.is_pyobject
        from_py = self.operand.type.is_pyobject
6578 6579
        if from_py and not to_py and self.operand.is_ephemeral() and not self.type.is_numeric:
            error(self.pos, "Casting temporary Python object to non-numeric non-Python type")
William Stein's avatar
William Stein committed
6580
        if to_py and not from_py:
6581 6582 6583 6584 6585 6586
            if self.type is bytes_type and self.operand.type.is_int:
                # FIXME: the type cast node isn't needed in this case
                # and can be dropped once analyse_types() can return a
                # different node
                self.operand = CoerceIntToBytesNode(self.operand, env)
            elif self.operand.type.can_coerce_to_pyobject(env):
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
6587
                self.result_ctype = py_object_type
6588
                self.operand = self.operand.coerce_to_pyobject(env)
6589
            else:
6590 6591 6592 6593
                if self.operand.type.is_ptr:
                    if not (self.operand.type.base_type.is_void or self.operand.type.base_type.is_struct):
                        error(self.pos, "Python objects cannot be cast from pointers of primitive types")
                else:
6594
                    # Should this be an error?
6595
                    warning(self.pos, "No conversion from %s to %s, python object pointer used." % (self.operand.type, self.type))
6596
                self.operand = self.operand.coerce_to_simple(env)
6597
        elif from_py and not to_py:
6598
            if self.type.create_from_py_utility_code(env):
6599
                self.operand = self.operand.coerce_to(self.type, env)
6600 6601 6602
            elif self.type.is_ptr:
                if not (self.type.base_type.is_void or self.type.base_type.is_struct):
                    error(self.pos, "Python objects cannot be cast to pointers of primitive types")
6603 6604
            else:
                warning(self.pos, "No conversion from %s to %s, python object pointer used." % (self.type, self.operand.type))
6605 6606
        elif from_py and to_py:
            if self.typecheck and self.type.is_extension_type:
6607
                self.operand = PyTypeTestNode(self.operand, self.type, env, notnone=True)
6608 6609
        elif self.type.is_complex and self.operand.type.is_complex:
            self.operand = self.operand.coerce_to_simple(env)
6610 6611
        elif self.operand.type.is_fused:
            self.operand = self.operand.coerce_to(self.type, env)
6612
            #self.type = self.operand.type
6613

Stefan Behnel's avatar
Stefan Behnel committed
6614
    def is_simple(self):
6615 6616
        # either temp or a C cast => no side effects other than the operand's
        return self.operand.is_simple()
Stefan Behnel's avatar
Stefan Behnel committed
6617

6618 6619 6620
    def nonlocally_immutable(self):
        return self.operand.nonlocally_immutable()

6621 6622 6623
    def nogil_check(self, env):
        if self.type and self.type.is_pyobject and self.is_temp:
            self.gil_error()
6624

William Stein's avatar
William Stein committed
6625
    def check_const(self):
6626
        return self.operand.check_const()
Stefan Behnel's avatar
Stefan Behnel committed
6627 6628

    def calculate_constant_result(self):
6629 6630 6631
        # we usually do not know the result of a type cast at code
        # generation time
        pass
6632

William Stein's avatar
William Stein committed
6633
    def calculate_result_code(self):
6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644
        if self.type.is_complex:
            operand_result = self.operand.result()
            if self.operand.type.is_complex:
                real_part = self.type.real_type.cast_code("__Pyx_CREAL(%s)" % operand_result)
                imag_part = self.type.real_type.cast_code("__Pyx_CIMAG(%s)" % operand_result)
            else:
                real_part = self.type.real_type.cast_code(operand_result)
                imag_part = "0"
            return "%s(%s, %s)" % (
                    self.type.from_parts,
                    real_part,
6645
                    imag_part)
6646 6647
        else:
            return self.type.cast_code(self.operand.result())
6648

6649 6650 6651 6652
    def get_constant_c_result_code(self):
        operand_result = self.operand.get_constant_c_result_code()
        if operand_result:
            return self.type.cast_code(operand_result)
6653

William Stein's avatar
William Stein committed
6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664
    def result_as(self, type):
        if self.type.is_pyobject and not self.is_temp:
            #  Optimise away some unnecessary casting
            return self.operand.result_as(type)
        else:
            return ExprNode.result_as(self, type)

    def generate_result_code(self, code):
        if self.is_temp:
            code.putln(
                "%s = (PyObject *)%s;" % (
6665 6666 6667
                    self.result(),
                    self.operand.result()))
            code.put_incref(self.result(), self.ctype())
William Stein's avatar
William Stein committed
6668 6669


6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
ERR_START = "Start may not be given"
ERR_NOT_STOP = "Stop must be provided to indicate shape"
ERR_STEPS = ("Strides may only be given to indicate contiguity. "
             "Consider slicing it after conversion")
ERR_NOT_POINTER = "Can only create cython.array from pointer"
ERR_BASE_TYPE = "Pointer base type does not match cython.array base type"

class CythonArrayNode(ExprNode):
    """
    Used when a pointer of base_type is cast to a memoryviewslice with that
    base type. i.e.

6682
        <int[:M:1, :N]> p
6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741

    creates a fortran-contiguous cython.array.

    We leave the type set to object so coercions to object are more efficient
    and less work. Acquiring a memoryviewslice from this will be just as
    efficient. ExprNode.coerce_to() will do the additional typecheck on
    self.compile_time_type
    """

    subexprs = ['operand', 'shapes']

    shapes = None
    is_temp = True
    mode = "c"

    shape_type = PyrexTypes.c_py_ssize_t_type

    def analyse_types(self, env):
        import MemoryView

        self.type = error_type
        self.shapes = []

        for axis_no, axis in enumerate(self.base_type_node.axes):
            if not axis.start.is_none:
                return error(axis.start.pos, ERR_START)

            if axis.stop.is_none:
                return error(axis.pos, ERR_NOT_STOP)

            axis.stop.analyse_types(env)
            shape = axis.stop.coerce_to(self.shape_type, env)
            if not shape.is_literal:
                shape.coerce_to_temp(env)

            self.shapes.append(shape)

            if not axis.stop.type.is_int:
                return error(axis.stop.pos, "Expected an integer type")

            first_or_last = axis_no in (0, len(self.base_type_node.axes) - 1)
            if not axis.step.is_none and first_or_last:
                axis.step.analyse_types(env)
                if (not axis.step.type.is_int and axis.step.is_literal and not
                        axis.step.type.is_error):
                    return error(axis.step.pos, "Expected an integer literal")

                if axis.step.compile_time_value(env) != 1:
                    return error(axis.step.pos, ERR_STEPS)

                if axis_no == 0:
                    self.mode = "fortran"

            elif axis.step and not first_or_last:
                return error(axis.step.pos, ERR_STEPS)

        self.operand.analyse_types(env)
        array_dtype = self.base_type_node.base_type_node.analyse(env)

6742 6743
        MemoryView.validate_memslice_dtype(self.pos, array_dtype)

6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760
        if not self.operand.type.is_ptr:
            return error(self.operand.pos, ERR_NOT_POINTER)

        elif not self.operand.type.base_type.same_as(array_dtype):
            return error(self.operand.pos, ERR_BASE_TYPE)

        if not self.operand.is_name:
            self.operand = self.operand.coerce_to_temp(env)

        axes = [('direct', 'follow')] * len(self.base_type_node.axes)
        if self.mode == "fortran":
            axes[0] = ('direct', 'contig')
        else:
            axes[-1] = ('direct', 'contig')

        self.coercion_type = PyrexTypes.MemoryViewSliceType(array_dtype, axes)
        #self.type = py_object_type
6761
        self.type = self.get_cython_array_type(env)
6762 6763
        assert self.type

6764
        MemoryView.use_cython_array_utility_code(env)
6765 6766 6767 6768 6769 6770 6771 6772
        env.use_utility_code(MemoryView.typeinfo_to_format_code)

    def allocate_temp_result(self, code):
        if self.temp_code:
            raise RuntimeError("temp allocated mulitple times")

        self.temp_code = code.funcstate.allocate_temp(self.type, True)

6773 6774 6775 6776 6777 6778
    def infer_type(self, env):
        return self.get_cython_array_type(env)

    def get_cython_array_type(self, env):
        return env.global_scope().context.cython_scope.lookup("array").type

6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813
    def generate_result_code(self, code):
        import Buffer

        shapes = [self.shape_type.cast_code(shape.result())
                      for shape in self.shapes]
        dtype = self.coercion_type.dtype

        shapes_temp = code.funcstate.allocate_temp(py_object_type, True)
        format_temp = code.funcstate.allocate_temp(py_object_type, True)

        itemsize = "sizeof(%s)" % dtype.declaration_code("")
        type_info = Buffer.get_type_information_cname(code, dtype)

        code.putln("if (!%s) {" % self.operand.result())
        code.putln(    'PyErr_SetString(PyExc_ValueError,'
                            '"Cannot create cython.array from NULL pointer");')
        code.putln(code.error_goto(self.operand.pos))
        code.putln("}")

        code.putln("%s = __pyx_format_from_typeinfo(&%s);" %
                                                (format_temp, type_info))
        code.putln('%s = Py_BuildValue("(%s)", %s);' % (shapes_temp,
                                                        "n" * len(shapes),
                                                        ", ".join(shapes)))

        err = "!%s || !%s || !PyBytes_Check(%s)" % (format_temp, shapes_temp,
                                                    format_temp)
        code.putln(code.error_goto_if(err, self.pos))
        code.put_gotref(format_temp)
        code.put_gotref(shapes_temp)

        tup = (self.result(), shapes_temp, itemsize, format_temp,
               self.mode, self.operand.result())
        code.putln('%s = __pyx_array_new('
                            '%s, %s, PyBytes_AS_STRING(%s), '
6814
                            '(char *) "%s", (char *) %s);' % tup)
6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825
        code.putln(code.error_goto_if_null(self.result(), self.pos))
        code.put_gotref(self.result())

        def dispose(temp):
            code.put_decref_clear(temp, py_object_type)
            code.funcstate.release_temp(temp)

        dispose(shapes_temp)
        dispose(format_temp)


6826
class SizeofNode(ExprNode):
William Stein's avatar
William Stein committed
6827
    #  Abstract base class for sizeof(x) expression nodes.
6828

6829
    type = PyrexTypes.c_size_t_type
William Stein's avatar
William Stein committed
6830 6831

    def check_const(self):
6832
        return True
William Stein's avatar
William Stein committed
6833 6834 6835 6836 6837 6838 6839 6840 6841 6842

    def generate_result_code(self, code):
        pass


class SizeofTypeNode(SizeofNode):
    #  C sizeof function applied to a type
    #
    #  base_type   CBaseTypeNode
    #  declarator  CDeclaratorNode
6843

William Stein's avatar
William Stein committed
6844
    subexprs = []
6845
    arg_type = None
6846

William Stein's avatar
William Stein committed
6847
    def analyse_types(self, env):
6848 6849
        # we may have incorrectly interpreted a dotted name as a type rather than an attribute
        # this could be better handled by more uniformly treating types as runtime-available objects
6850
        if 0 and self.base_type.module_path:
6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861
            path = self.base_type.module_path
            obj = env.lookup(path[0])
            if obj.as_module is None:
                operand = NameNode(pos=self.pos, name=path[0])
                for attr in path[1:]:
                    operand = AttributeNode(pos=self.pos, obj=operand, attribute=attr)
                operand = AttributeNode(pos=self.pos, obj=operand, attribute=self.base_type.name)
                self.operand = operand
                self.__class__ = SizeofVarNode
                self.analyse_types(env)
                return
6862 6863 6864 6865
        if self.arg_type is None:
            base_type = self.base_type.analyse(env)
            _, arg_type = self.declarator.analyse(base_type, env)
            self.arg_type = arg_type
6866
        self.check_type()
6867

6868 6869
    def check_type(self):
        arg_type = self.arg_type
6870
        if arg_type.is_pyobject and not arg_type.is_extension_type:
William Stein's avatar
William Stein committed
6871 6872 6873 6874 6875
            error(self.pos, "Cannot take sizeof Python object")
        elif arg_type.is_void:
            error(self.pos, "Cannot take sizeof void")
        elif not arg_type.is_complete():
            error(self.pos, "Cannot take sizeof incomplete type '%s'" % arg_type)
6876

William Stein's avatar
William Stein committed
6877
    def calculate_result_code(self):
6878 6879 6880 6881 6882 6883
        if self.arg_type.is_extension_type:
            # the size of the pointer is boring
            # we want the size of the actual struct
            arg_code = self.arg_type.declaration_code("", deref=1)
        else:
            arg_code = self.arg_type.declaration_code("")
William Stein's avatar
William Stein committed
6884
        return "(sizeof(%s))" % arg_code
6885

William Stein's avatar
William Stein committed
6886 6887 6888 6889 6890

class SizeofVarNode(SizeofNode):
    #  C sizeof function applied to a variable
    #
    #  operand   ExprNode
6891

William Stein's avatar
William Stein committed
6892
    subexprs = ['operand']
6893

William Stein's avatar
William Stein committed
6894
    def analyse_types(self, env):
6895 6896 6897 6898 6899 6900 6901 6902 6903
        # We may actually be looking at a type rather than a variable...
        # If we are, traditional analysis would fail...
        operand_as_type = self.operand.analyse_as_type(env)
        if operand_as_type:
            self.arg_type = operand_as_type
            self.__class__ = SizeofTypeNode
            self.check_type()
        else:
            self.operand.analyse_types(env)
6904

William Stein's avatar
William Stein committed
6905
    def calculate_result_code(self):
6906
        return "(sizeof(%s))" % self.operand.result()
6907

William Stein's avatar
William Stein committed
6908 6909 6910
    def generate_result_code(self, code):
        pass

Robert Bradshaw's avatar
Robert Bradshaw committed
6911
class TypeofNode(ExprNode):
6912 6913 6914
    #  Compile-time type of an expression, as a string.
    #
    #  operand   ExprNode
Robert Bradshaw's avatar
Robert Bradshaw committed
6915
    #  literal   StringNode # internal
6916

Robert Bradshaw's avatar
Robert Bradshaw committed
6917 6918
    literal = None
    type = py_object_type
6919

Stefan Behnel's avatar
Stefan Behnel committed
6920
    subexprs = ['literal'] # 'operand' will be ignored after type analysis!
6921

6922 6923
    def analyse_types(self, env):
        self.operand.analyse_types(env)
6924
        value = StringEncoding.EncodedString(str(self.operand.type)) #self.operand.type.typeof_name())
6925
        self.literal = StringNode(self.pos, value=value)
Robert Bradshaw's avatar
Robert Bradshaw committed
6926 6927
        self.literal.analyse_types(env)
        self.literal = self.literal.coerce_to_pyobject(env)
6928 6929 6930 6931

    def may_be_none(self):
        return False

6932
    def generate_evaluation_code(self, code):
Robert Bradshaw's avatar
Robert Bradshaw committed
6933
        self.literal.generate_evaluation_code(code)
6934

Robert Bradshaw's avatar
Robert Bradshaw committed
6935 6936
    def calculate_result_code(self):
        return self.literal.calculate_result_code()
William Stein's avatar
William Stein committed
6937 6938 6939 6940 6941 6942 6943

#-------------------------------------------------------------------
#
#  Binary operator nodes
#
#-------------------------------------------------------------------

Stefan Behnel's avatar
Stefan Behnel committed
6944 6945 6946
def _not_in(x, seq):
    return x not in seq

6947 6948 6949
compile_time_binary_operators = {
    '<': operator.lt,
    '<=': operator.le,
6950
    '==': operator.eq,
6951 6952 6953 6954 6955 6956 6957
    '!=': operator.ne,
    '>=': operator.ge,
    '>': operator.gt,
    'is': operator.is_,
    'is_not': operator.is_not,
    '+': operator.add,
    '&': operator.and_,
6958
    '/': operator.truediv,
6959 6960 6961 6962 6963 6964 6965 6966 6967
    '//': operator.floordiv,
    '<<': operator.lshift,
    '%': operator.mod,
    '*': operator.mul,
    '|': operator.or_,
    '**': operator.pow,
    '>>': operator.rshift,
    '-': operator.sub,
    '^': operator.xor,
Stefan Behnel's avatar
Stefan Behnel committed
6968 6969
    'in': operator.contains,
    'not_in': _not_in,
6970 6971 6972 6973 6974 6975 6976
}

def get_compile_time_binop(node):
    func = compile_time_binary_operators.get(node.operator)
    if not func:
        error(node.pos,
            "Binary '%s' not supported in compile-time expression"
6977
                % node.operator)
6978 6979
    return func

6980
class BinopNode(ExprNode):
William Stein's avatar
William Stein committed
6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991
    #  operator     string
    #  operand1     ExprNode
    #  operand2     ExprNode
    #
    #  Processing during analyse_expressions phase:
    #
    #    analyse_c_operation
    #      Called when neither operand is a pyobject.
    #      - Check operand types and coerce if needed.
    #      - Determine result type and result code fragment.
    #      - Allocate temporary for result if needed.
6992

William Stein's avatar
William Stein committed
6993
    subexprs = ['operand1', 'operand2']
6994
    inplace = False
6995 6996 6997 6998 6999 7000 7001

    def calculate_constant_result(self):
        func = compile_time_binary_operators[self.operator]
        self.constant_result = func(
            self.operand1.constant_result,
            self.operand2.constant_result)

7002 7003 7004 7005 7006 7007 7008 7009
    def compile_time_value(self, denv):
        func = get_compile_time_binop(self)
        operand1 = self.operand1.compile_time_value(denv)
        operand2 = self.operand2.compile_time_value(denv)
        try:
            return func(operand1, operand2)
        except Exception, e:
            self.compile_time_value_error(e)
7010

7011 7012
    def infer_type(self, env):
        return self.result_type(self.operand1.infer_type(env),
Robert Bradshaw's avatar
Robert Bradshaw committed
7013
                                self.operand2.infer_type(env))
7014

William Stein's avatar
William Stein committed
7015 7016 7017
    def analyse_types(self, env):
        self.operand1.analyse_types(env)
        self.operand2.analyse_types(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
7018
        self.analyse_operation(env)
7019

Robert Bradshaw's avatar
Robert Bradshaw committed
7020
    def analyse_operation(self, env):
William Stein's avatar
William Stein committed
7021 7022
        if self.is_py_operation():
            self.coerce_operands_to_pyobjects(env)
7023 7024 7025
            self.type = self.result_type(self.operand1.type,
                                         self.operand2.type)
            assert self.type.is_pyobject
William Stein's avatar
William Stein committed
7026
            self.is_temp = 1
DaniloFreitas's avatar
DaniloFreitas committed
7027 7028
        elif self.is_cpp_operation():
            self.analyse_cpp_operation(env)
William Stein's avatar
William Stein committed
7029 7030
        else:
            self.analyse_c_operation(env)
7031

William Stein's avatar
William Stein committed
7032
    def is_py_operation(self):
7033
        return self.is_py_operation_types(self.operand1.type, self.operand2.type)
7034

7035 7036 7037
    def is_py_operation_types(self, type1, type2):
        return type1.is_pyobject or type2.is_pyobject

DaniloFreitas's avatar
DaniloFreitas committed
7038
    def is_cpp_operation(self):
Robert Bradshaw's avatar
Robert Bradshaw committed
7039 7040
        return (self.operand1.type.is_cpp_class
            or self.operand2.type.is_cpp_class)
7041

7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057
    def analyse_cpp_operation(self, env):
        type1 = self.operand1.type
        type2 = self.operand2.type
        entry = env.lookup_operator(self.operator, [self.operand1, self.operand2])
        if not entry:
            self.type_error()
            return
        func_type = entry.type
        if func_type.is_ptr:
            func_type = func_type.base_type
        if len(func_type.args) == 1:
            self.operand2 = self.operand2.coerce_to(func_type.args[0].type, env)
        else:
            self.operand1 = self.operand1.coerce_to(func_type.args[0].type, env)
            self.operand2 = self.operand2.coerce_to(func_type.args[1].type, env)
        self.type = func_type.return_type
7058

7059 7060
    def result_type(self, type1, type2):
        if self.is_py_operation_types(type1, type2):
7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078
            if type2.is_string:
                type2 = Builtin.bytes_type
            if type1.is_string:
                type1 = Builtin.bytes_type
            elif self.operator == '%' \
                     and type1 in (Builtin.str_type, Builtin.unicode_type):
                # note that  b'%s' % b'abc'  doesn't work in Py3
                return type1
            if type1.is_builtin_type:
                if type1 is type2:
                    if self.operator in '**%+|&^':
                        # FIXME: at least these operators should be safe - others?
                        return type1
                elif self.operator == '*':
                    if type1 in (Builtin.bytes_type, Builtin.str_type, Builtin.unicode_type):
                        return type1
                    # multiplication of containers/numbers with an
                    # integer value always (?) returns the same type
7079
                    if type2.is_int:
7080
                        return type1
7081 7082 7083 7084
            elif type2.is_builtin_type and type1.is_int and self.operator == '*':
                # multiplication of containers/numbers with an
                # integer value always (?) returns the same type
                return type2
7085 7086 7087
            return py_object_type
        else:
            return self.compute_c_result_type(type1, type2)
7088

7089
    def nogil_check(self, env):
7090
        if self.is_py_operation():
7091
            self.gil_error()
7092

William Stein's avatar
William Stein committed
7093 7094 7095
    def coerce_operands_to_pyobjects(self, env):
        self.operand1 = self.operand1.coerce_to_pyobject(env)
        self.operand2 = self.operand2.coerce_to_pyobject(env)
7096

William Stein's avatar
William Stein committed
7097
    def check_const(self):
7098
        return self.operand1.check_const() and self.operand2.check_const()
7099

William Stein's avatar
William Stein committed
7100 7101 7102 7103
    def generate_result_code(self, code):
        #print "BinopNode.generate_result_code:", self.operand1, self.operand2 ###
        if self.operand1.type.is_pyobject:
            function = self.py_operation_function()
7104
            if self.operator == '**':
William Stein's avatar
William Stein committed
7105 7106 7107 7108
                extra_args = ", Py_None"
            else:
                extra_args = ""
            code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
7109
                "%s = %s(%s, %s%s); %s" % (
7110 7111
                    self.result(),
                    function,
William Stein's avatar
William Stein committed
7112 7113 7114
                    self.operand1.py_result(),
                    self.operand2.py_result(),
                    extra_args,
7115
                    code.error_goto_if_null(self.result(), self.pos)))
7116
            code.put_gotref(self.py_result())
7117

William Stein's avatar
William Stein committed
7118 7119 7120 7121
    def type_error(self):
        if not (self.operand1.type.is_error
                or self.operand2.type.is_error):
            error(self.pos, "Invalid operand types for '%s' (%s; %s)" %
7122
                (self.operator, self.operand1.type,
William Stein's avatar
William Stein committed
7123 7124 7125 7126
                    self.operand2.type))
        self.type = PyrexTypes.error_type


Robert Bradshaw's avatar
Robert Bradshaw committed
7127
class CBinopNode(BinopNode):
7128

Robert Bradshaw's avatar
Robert Bradshaw committed
7129 7130 7131 7132
    def analyse_types(self, env):
        BinopNode.analyse_types(self, env)
        if self.is_py_operation():
            self.type = PyrexTypes.error_type
7133

Robert Bradshaw's avatar
Robert Bradshaw committed
7134 7135
    def py_operation_function():
        return ""
7136

Robert Bradshaw's avatar
Robert Bradshaw committed
7137 7138
    def calculate_result_code(self):
        return "(%s %s %s)" % (
7139 7140
            self.operand1.result(),
            self.operator,
Robert Bradshaw's avatar
Robert Bradshaw committed
7141 7142 7143 7144 7145 7146 7147 7148
            self.operand2.result())


def c_binop_constructor(operator):
    def make_binop_node(pos, **operands):
        return CBinopNode(pos, operator=operator, **operands)
    return make_binop_node

William Stein's avatar
William Stein committed
7149 7150
class NumBinopNode(BinopNode):
    #  Binary operation taking numeric arguments.
7151

Robert Bradshaw's avatar
Robert Bradshaw committed
7152
    infix = True
7153

William Stein's avatar
William Stein committed
7154 7155 7156 7157 7158 7159
    def analyse_c_operation(self, env):
        type1 = self.operand1.type
        type2 = self.operand2.type
        self.type = self.compute_c_result_type(type1, type2)
        if not self.type:
            self.type_error()
7160
            return
7161
        if self.type.is_complex:
Robert Bradshaw's avatar
Robert Bradshaw committed
7162
            self.infix = False
7163
        if not self.infix or (type1.is_numeric and type2.is_numeric):
7164 7165
            self.operand1 = self.operand1.coerce_to(self.type, env)
            self.operand2 = self.operand2.coerce_to(self.type, env)
7166

William Stein's avatar
William Stein committed
7167 7168
    def compute_c_result_type(self, type1, type2):
        if self.c_types_okay(type1, type2):
7169 7170 7171 7172 7173
            widest_type = PyrexTypes.widest_numeric_type(type1, type2)
            if widest_type is PyrexTypes.c_bint_type:
                if self.operator not in '|^&':
                    # False + False == 0 # not False!
                    widest_type = PyrexTypes.c_int_type
7174 7175 7176
            else:
                widest_type = PyrexTypes.widest_numeric_type(
                    widest_type, PyrexTypes.c_int_type)
7177
            return widest_type
William Stein's avatar
William Stein committed
7178 7179
        else:
            return None
7180

7181 7182 7183 7184 7185 7186 7187 7188 7189 7190
    def may_be_none(self):
        type1 = self.operand1.type
        type2 = self.operand2.type
        if type1 and type1.is_builtin_type and type2 and type2.is_builtin_type:
            # XXX: I can't think of any case where a binary operation
            # on builtin types evaluates to None - add a special case
            # here if there is one.
            return False
        return super(NumBinopNode, self).may_be_none()

7191 7192 7193 7194 7195 7196 7197
    def get_constant_c_result_code(self):
        value1 = self.operand1.get_constant_c_result_code()
        value2 = self.operand2.get_constant_c_result_code()
        if value1 and value2:
            return "(%s %s %s)" % (value1, self.operator, value2)
        else:
            return None
7198

William Stein's avatar
William Stein committed
7199
    def c_types_okay(self, type1, type2):
7200 7201 7202
        #print "NumBinopNode.c_types_okay:", type1, type2 ###
        return (type1.is_numeric  or type1.is_enum) \
            and (type2.is_numeric  or type2.is_enum)
William Stein's avatar
William Stein committed
7203 7204

    def calculate_result_code(self):
7205 7206
        if self.infix:
            return "(%s %s %s)" % (
7207 7208
                self.operand1.result(),
                self.operator,
7209 7210
                self.operand2.result())
        else:
7211 7212 7213
            func = self.type.binary_op(self.operator)
            if func is None:
                error(self.pos, "binary operator %s not supported for %s" % (self.operator, self.type))
7214
            return "%s(%s, %s)" % (
7215
                func,
7216 7217
                self.operand1.result(),
                self.operand2.result())
7218

7219
    def is_py_operation_types(self, type1, type2):
Stefan Behnel's avatar
Stefan Behnel committed
7220 7221
        return (type1.is_unicode_char or
                type2.is_unicode_char or
7222
                BinopNode.is_py_operation_types(self, type1, type2))
7223

William Stein's avatar
William Stein committed
7224
    def py_operation_function(self):
7225 7226 7227 7228
        fuction = self.py_functions[self.operator]
        if self.inplace:
            fuction = fuction.replace('PyNumber_', 'PyNumber_InPlace')
        return fuction
William Stein's avatar
William Stein committed
7229 7230

    py_functions = {
Robert Bradshaw's avatar
Robert Bradshaw committed
7231 7232 7233
        "|":        "PyNumber_Or",
        "^":        "PyNumber_Xor",
        "&":        "PyNumber_And",
7234 7235
        "<<":       "PyNumber_Lshift",
        ">>":       "PyNumber_Rshift",
Robert Bradshaw's avatar
Robert Bradshaw committed
7236 7237 7238 7239
        "+":        "PyNumber_Add",
        "-":        "PyNumber_Subtract",
        "*":        "PyNumber_Multiply",
        "/":        "__Pyx_PyNumber_Divide",
7240
        "//":       "PyNumber_FloorDivide",
Robert Bradshaw's avatar
Robert Bradshaw committed
7241
        "%":        "PyNumber_Remainder",
7242
        "**":       "PyNumber_Power"
William Stein's avatar
William Stein committed
7243 7244 7245 7246
    }

class IntBinopNode(NumBinopNode):
    #  Binary operation taking integer arguments.
7247

William Stein's avatar
William Stein committed
7248
    def c_types_okay(self, type1, type2):
7249 7250 7251
        #print "IntBinopNode.c_types_okay:", type1, type2 ###
        return (type1.is_int or type1.is_enum) \
            and (type2.is_int or type2.is_enum)
William Stein's avatar
William Stein committed
7252

7253

William Stein's avatar
William Stein committed
7254 7255
class AddNode(NumBinopNode):
    #  '+' operator.
7256

7257 7258 7259
    def is_py_operation_types(self, type1, type2):
        if type1.is_string and type2.is_string:
            return 1
William Stein's avatar
William Stein committed
7260
        else:
7261
            return NumBinopNode.is_py_operation_types(self, type1, type2)
William Stein's avatar
William Stein committed
7262 7263

    def compute_c_result_type(self, type1, type2):
7264 7265
        #print "AddNode.compute_c_result_type:", type1, self.operator, type2 ###
        if (type1.is_ptr or type1.is_array) and (type2.is_int or type2.is_enum):
William Stein's avatar
William Stein committed
7266
            return type1
7267
        elif (type2.is_ptr or type2.is_array) and (type1.is_int or type1.is_enum):
William Stein's avatar
William Stein committed
7268 7269 7270 7271 7272 7273 7274 7275
            return type2
        else:
            return NumBinopNode.compute_c_result_type(
                self, type1, type2)


class SubNode(NumBinopNode):
    #  '-' operator.
7276

William Stein's avatar
William Stein committed
7277
    def compute_c_result_type(self, type1, type2):
7278
        if (type1.is_ptr or type1.is_array) and (type2.is_int or type2.is_enum):
William Stein's avatar
William Stein committed
7279
            return type1
7280
        elif (type1.is_ptr or type1.is_array) and (type2.is_ptr or type2.is_array):
William Stein's avatar
William Stein committed
7281 7282 7283 7284 7285 7286 7287 7288
            return PyrexTypes.c_int_type
        else:
            return NumBinopNode.compute_c_result_type(
                self, type1, type2)


class MulNode(NumBinopNode):
    #  '*' operator.
7289

7290
    def is_py_operation_types(self, type1, type2):
William Stein's avatar
William Stein committed
7291 7292 7293 7294
        if (type1.is_string and type2.is_int) \
            or (type2.is_string and type1.is_int):
                return 1
        else:
7295
            return NumBinopNode.is_py_operation_types(self, type1, type2)
William Stein's avatar
William Stein committed
7296 7297


7298 7299
class DivNode(NumBinopNode):
    #  '/' or '//' operator.
7300

7301
    cdivision = None
7302 7303
    truedivision = None   # == "unknown" if operator == '/'
    ctruedivision = False
Robert Bradshaw's avatar
Robert Bradshaw committed
7304
    cdivision_warnings = False
7305
    zerodivision_check = None
7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327

    def find_compile_time_binary_operator(self, op1, op2):
        func = compile_time_binary_operators[self.operator]
        if self.operator == '/' and self.truedivision is None:
            # => true div for floats, floor div for integers
            if isinstance(op1, (int,long)) and isinstance(op2, (int,long)):
                func = compile_time_binary_operators['//']
        return func

    def calculate_constant_result(self):
        op1 = self.operand1.constant_result
        op2 = self.operand2.constant_result
        func = self.find_compile_time_binary_operator(op1, op2)
        self.constant_result = func(
            self.operand1.constant_result,
            self.operand2.constant_result)

    def compile_time_value(self, denv):
        operand1 = self.operand1.compile_time_value(denv)
        operand2 = self.operand2.compile_time_value(denv)
        try:
            func = self.find_compile_time_binary_operator(
Robert Bradshaw's avatar
Robert Bradshaw committed
7328
                operand1, operand2)
7329 7330 7331 7332
            return func(operand1, operand2)
        except Exception, e:
            self.compile_time_value_error(e)

Robert Bradshaw's avatar
Robert Bradshaw committed
7333
    def analyse_operation(self, env):
7334 7335 7336 7337
        if self.cdivision or env.directives['cdivision']:
            self.ctruedivision = False
        else:
            self.ctruedivision = self.truedivision
Robert Bradshaw's avatar
Robert Bradshaw committed
7338
        NumBinopNode.analyse_operation(self, env)
7339 7340
        if self.is_cpp_operation():
            self.cdivision = True
7341
        if not self.type.is_pyobject:
7342 7343
            self.zerodivision_check = (
                self.cdivision is None and not env.directives['cdivision']
7344
                and (not self.operand2.has_constant_result() or
7345
                     self.operand2.constant_result == 0))
7346 7347 7348 7349
            if self.zerodivision_check or env.directives['cdivision_warnings']:
                # Need to check ahead of time to warn or raise zero division error
                self.operand1 = self.operand1.coerce_to_simple(env)
                self.operand2 = self.operand2.coerce_to_simple(env)
7350 7351
                if env.nogil:
                    error(self.pos, "Pythonic division not allowed without gil, consider using cython.cdivision(True)")
7352 7353 7354 7355 7356 7357 7358 7359 7360

    def compute_c_result_type(self, type1, type2):
        if self.operator == '/' and self.ctruedivision:
            if not type1.is_float and not type2.is_float:
                widest_type = PyrexTypes.widest_numeric_type(type1, PyrexTypes.c_double_type)
                widest_type = PyrexTypes.widest_numeric_type(type2, widest_type)
                return widest_type
        return NumBinopNode.compute_c_result_type(self, type1, type2)

7361 7362 7363 7364 7365
    def zero_division_message(self):
        if self.type.is_int:
            return "integer division or modulo by zero"
        else:
            return "float division"
Robert Bradshaw's avatar
Robert Bradshaw committed
7366

7367
    def generate_evaluation_code(self, code):
7368
        if not self.type.is_pyobject and not self.type.is_complex:
7369
            if self.cdivision is None:
7370
                self.cdivision = (code.globalstate.directives['cdivision']
7371 7372 7373
                                    or not self.type.signed
                                    or self.type.is_float)
            if not self.cdivision:
7374
                code.globalstate.use_utility_code(div_int_utility_code.specialize(self.type))
7375
        NumBinopNode.generate_evaluation_code(self, code)
7376
        self.generate_div_warning_code(code)
7377

7378
    def generate_div_warning_code(self, code):
7379 7380
        if not self.type.is_pyobject:
            if self.zerodivision_check:
7381 7382 7383 7384 7385
                if not self.infix:
                    zero_test = "%s(%s)" % (self.type.unary_op('zero'), self.operand2.result())
                else:
                    zero_test = "%s == 0" % self.operand2.result()
                code.putln("if (unlikely(%s)) {" % zero_test)
7386 7387 7388
                code.putln('PyErr_Format(PyExc_ZeroDivisionError, "%s");' % self.zero_division_message())
                code.putln(code.error_goto(self.pos))
                code.putln("}")
7389 7390 7391
                if self.type.is_int and self.type.signed and self.operator != '%':
                    code.globalstate.use_utility_code(division_overflow_test_code)
                    code.putln("else if (sizeof(%s) == sizeof(long) && unlikely(%s == -1) && unlikely(UNARY_NEG_WOULD_OVERFLOW(%s))) {" % (
7392
                                    self.type.declaration_code(''),
7393 7394 7395 7396 7397
                                    self.operand2.result(),
                                    self.operand1.result()))
                    code.putln('PyErr_Format(PyExc_OverflowError, "value too large to perform division");')
                    code.putln(code.error_goto(self.pos))
                    code.putln("}")
Robert Bradshaw's avatar
Robert Bradshaw committed
7398
            if code.globalstate.directives['cdivision_warnings'] and self.operator != '/':
7399 7400 7401 7402 7403
                code.globalstate.use_utility_code(cdivision_warning_utility_code)
                code.putln("if ((%s < 0) ^ (%s < 0)) {" % (
                                self.operand1.result(),
                                self.operand2.result()))
                code.putln(code.set_error_info(self.pos));
7404 7405 7406 7407 7408 7409
                code.put("if (__Pyx_cdivision_warning(%(FILENAME)s, "
                                                     "%(LINENO)s)) " % {
                    'FILENAME': Naming.filename_cname,
                    'LINENO':  Naming.lineno_cname,
                    })

7410 7411
                code.put_goto(code.error_label)
                code.putln("}")
7412

Robert Bradshaw's avatar
Robert Bradshaw committed
7413
    def calculate_result_code(self):
7414 7415 7416
        if self.type.is_complex:
            return NumBinopNode.calculate_result_code(self)
        elif self.type.is_float and self.operator == '//':
7417
            return "floor(%s / %s)" % (
7418
                self.operand1.result(),
7419
                self.operand2.result())
7420 7421 7422 7423 7424 7425 7426 7427 7428
        elif self.truedivision or self.cdivision:
            op1 = self.operand1.result()
            op2 = self.operand2.result()
            if self.truedivision:
                if self.type != self.operand1.type:
                    op1 = self.type.cast_code(op1)
                if self.type != self.operand2.type:
                    op2 = self.type.cast_code(op2)
            return "(%s / %s)" % (op1, op2)
7429 7430
        else:
            return "__Pyx_div_%s(%s, %s)" % (
Craig Citro's avatar
Craig Citro committed
7431
                    self.type.specialization_name(),
7432
                    self.operand1.result(),
7433
                    self.operand2.result())
Robert Bradshaw's avatar
Robert Bradshaw committed
7434 7435


Robert Bradshaw's avatar
Robert Bradshaw committed
7436
class ModNode(DivNode):
William Stein's avatar
William Stein committed
7437
    #  '%' operator.
7438

7439 7440 7441 7442
    def is_py_operation_types(self, type1, type2):
        return (type1.is_string
            or type2.is_string
            or NumBinopNode.is_py_operation_types(self, type1, type2))
William Stein's avatar
William Stein committed
7443

7444 7445 7446 7447 7448
    def zero_division_message(self):
        if self.type.is_int:
            return "integer division or modulo by zero"
        else:
            return "float divmod()"
7449

7450
    def generate_evaluation_code(self, code):
7451 7452 7453 7454 7455
        if not self.type.is_pyobject:
            if self.cdivision is None:
                self.cdivision = code.globalstate.directives['cdivision'] or not self.type.signed
            if not self.cdivision:
                if self.type.is_int:
7456
                    code.globalstate.use_utility_code(mod_int_utility_code.specialize(self.type))
7457
                else:
7458 7459
                    code.globalstate.use_utility_code(
                        mod_float_utility_code.specialize(self.type, math_h_modifier=self.type.math_h_modifier))
7460
        NumBinopNode.generate_evaluation_code(self, code)
7461
        self.generate_div_warning_code(code)
7462

Robert Bradshaw's avatar
Robert Bradshaw committed
7463
    def calculate_result_code(self):
7464 7465 7466 7467
        if self.cdivision:
            if self.type.is_float:
                return "fmod%s(%s, %s)" % (
                    self.type.math_h_modifier,
7468
                    self.operand1.result(),
7469 7470 7471
                    self.operand2.result())
            else:
                return "(%s %% %s)" % (
7472
                    self.operand1.result(),
7473
                    self.operand2.result())
Robert Bradshaw's avatar
Robert Bradshaw committed
7474
        else:
7475
            return "__Pyx_mod_%s(%s, %s)" % (
Craig Citro's avatar
Craig Citro committed
7476
                    self.type.specialization_name(),
7477
                    self.operand1.result(),
7478
                    self.operand2.result())
William Stein's avatar
William Stein committed
7479 7480 7481

class PowNode(NumBinopNode):
    #  '**' operator.
7482

Robert Bradshaw's avatar
Robert Bradshaw committed
7483 7484
    def analyse_c_operation(self, env):
        NumBinopNode.analyse_c_operation(self, env)
7485
        if self.type.is_complex:
Robert Bradshaw's avatar
Robert Bradshaw committed
7486 7487 7488 7489 7490 7491 7492
            if self.type.real_type.is_float:
                self.operand1 = self.operand1.coerce_to(self.type, env)
                self.operand2 = self.operand2.coerce_to(self.type, env)
                self.pow_func = "__Pyx_c_pow" + self.type.real_type.math_h_modifier
            else:
                error(self.pos, "complex int powers not supported")
                self.pow_func = "<error>"
7493
        elif self.type.is_float:
7494
            self.pow_func = "pow" + self.type.math_h_modifier
William Stein's avatar
William Stein committed
7495
        else:
Robert Bradshaw's avatar
Robert Bradshaw committed
7496 7497
            self.pow_func = "__Pyx_pow_%s" % self.type.declaration_code('').replace(' ', '_')
            env.use_utility_code(
7498
                    int_pow_utility_code.specialize(func_name=self.pow_func,
Robert Bradshaw's avatar
Robert Bradshaw committed
7499
                                                type=self.type.declaration_code('')))
7500

William Stein's avatar
William Stein committed
7501
    def calculate_result_code(self):
7502 7503 7504 7505 7506 7507
        # Work around MSVC overloading ambiguity.
        def typecast(operand):
            if self.type == operand.type:
                return operand.result()
            else:
                return self.type.cast_code(operand.result())
Robert Bradshaw's avatar
Robert Bradshaw committed
7508
        return "%s(%s, %s)" % (
7509 7510
            self.pow_func,
            typecast(self.operand1),
7511
            typecast(self.operand2))
7512

William Stein's avatar
William Stein committed
7513

Craig Citro's avatar
Craig Citro committed
7514
# Note: This class is temporarily "shut down" into an ineffective temp
7515 7516
# allocation mode.
#
Craig Citro's avatar
Craig Citro committed
7517 7518 7519
# More sophisticated temp reuse was going on before, one could have a
# look at adding this again after /all/ classes are converted to the
# new temp scheme. (The temp juggling cannot work otherwise).
7520
class BoolBinopNode(ExprNode):
William Stein's avatar
William Stein committed
7521 7522 7523 7524 7525
    #  Short-circuiting boolean operation.
    #
    #  operator     string
    #  operand1     ExprNode
    #  operand2     ExprNode
7526

7527
    subexprs = ['operand1', 'operand2']
7528

7529
    def infer_type(self, env):
7530 7531
        type1 = self.operand1.infer_type(env)
        type2 = self.operand2.infer_type(env)
7532
        return PyrexTypes.independent_spanning_type(type1, type2)
7533

Stefan Behnel's avatar
Stefan Behnel committed
7534 7535 7536 7537 7538 7539
    def may_be_none(self):
        if self.operator == 'or':
            return self.operand2.may_be_none()
        else:
            return self.operand1.may_be_none() or self.operand2.may_be_none()

7540 7541 7542 7543 7544 7545 7546 7547 7548
    def calculate_constant_result(self):
        if self.operator == 'and':
            self.constant_result = \
                self.operand1.constant_result and \
                self.operand2.constant_result
        else:
            self.constant_result = \
                self.operand1.constant_result or \
                self.operand2.constant_result
7549

7550 7551 7552 7553 7554 7555 7556
    def compile_time_value(self, denv):
        if self.operator == 'and':
            return self.operand1.compile_time_value(denv) \
                and self.operand2.compile_time_value(denv)
        else:
            return self.operand1.compile_time_value(denv) \
                or self.operand2.compile_time_value(denv)
7557

7558
    def coerce_to_boolean(self, env):
7559 7560 7561 7562 7563 7564 7565
        return BoolBinopNode(
            self.pos,
            operator = self.operator,
            operand1 = self.operand1.coerce_to_boolean(env),
            operand2 = self.operand2.coerce_to_boolean(env),
            type = PyrexTypes.c_bint_type,
            is_temp = self.is_temp)
7566

William Stein's avatar
William Stein committed
7567 7568 7569
    def analyse_types(self, env):
        self.operand1.analyse_types(env)
        self.operand2.analyse_types(env)
7570
        self.type = PyrexTypes.independent_spanning_type(self.operand1.type, self.operand2.type)
7571 7572
        self.operand1 = self.operand1.coerce_to(self.type, env)
        self.operand2 = self.operand2.coerce_to(self.type, env)
7573

William Stein's avatar
William Stein committed
7574 7575
        # For what we're about to do, it's vital that
        # both operands be temp nodes.
7576 7577
        self.operand1 = self.operand1.coerce_to_simple(env)
        self.operand2 = self.operand2.coerce_to_simple(env)
William Stein's avatar
William Stein committed
7578
        self.is_temp = 1
7579 7580 7581

    gil_message = "Truth-testing Python object"

William Stein's avatar
William Stein committed
7582
    def check_const(self):
7583
        return self.operand1.check_const() and self.operand2.check_const()
7584

William Stein's avatar
William Stein committed
7585
    def generate_evaluation_code(self, code):
7586
        code.mark_pos(self.pos)
William Stein's avatar
William Stein committed
7587
        self.operand1.generate_evaluation_code(code)
7588
        test_result, uses_temp = self.generate_operand1_test(code)
William Stein's avatar
William Stein committed
7589 7590 7591 7592 7593 7594 7595 7596
        if self.operator == 'and':
            sense = ""
        else:
            sense = "!"
        code.putln(
            "if (%s%s) {" % (
                sense,
                test_result))
7597 7598
        if uses_temp:
            code.funcstate.release_temp(test_result)
7599
        self.operand1.generate_disposal_code(code)
William Stein's avatar
William Stein committed
7600
        self.operand2.generate_evaluation_code(code)
7601
        self.allocate_temp_result(code)
7602
        self.operand2.make_owned_reference(code)
7603
        code.putln("%s = %s;" % (self.result(), self.operand2.result()))
7604 7605
        self.operand2.generate_post_assignment_code(code)
        self.operand2.free_temps(code)
7606
        code.putln("} else {")
7607
        self.operand1.make_owned_reference(code)
7608
        code.putln("%s = %s;" % (self.result(), self.operand1.result()))
7609 7610
        self.operand1.generate_post_assignment_code(code)
        self.operand1.free_temps(code)
7611
        code.putln("}")
7612

William Stein's avatar
William Stein committed
7613 7614 7615
    def generate_operand1_test(self, code):
        #  Generate code to test the truth of the first operand.
        if self.type.is_pyobject:
7616 7617
            test_result = code.funcstate.allocate_temp(PyrexTypes.c_bint_type,
                                                       manage_ref=False)
William Stein's avatar
William Stein committed
7618
            code.putln(
7619
                "%s = __Pyx_PyObject_IsTrue(%s); %s" % (
William Stein's avatar
William Stein committed
7620 7621
                    test_result,
                    self.operand1.py_result(),
Robert Bradshaw's avatar
Robert Bradshaw committed
7622
                    code.error_goto_if_neg(test_result, self.pos)))
William Stein's avatar
William Stein committed
7623
        else:
7624
            test_result = self.operand1.result()
7625
        return (test_result, self.type.is_pyobject)
William Stein's avatar
William Stein committed
7626 7627


7628
class CondExprNode(ExprNode):
Robert Bradshaw's avatar
Robert Bradshaw committed
7629 7630 7631 7632 7633
    #  Short-circuiting conditional expression.
    #
    #  test        ExprNode
    #  true_val    ExprNode
    #  false_val   ExprNode
7634

7635 7636
    true_val = None
    false_val = None
7637

Robert Bradshaw's avatar
Robert Bradshaw committed
7638
    subexprs = ['test', 'true_val', 'false_val']
7639

Robert Bradshaw's avatar
Robert Bradshaw committed
7640 7641
    def type_dependencies(self, env):
        return self.true_val.type_dependencies(env) + self.false_val.type_dependencies(env)
7642

Robert Bradshaw's avatar
Robert Bradshaw committed
7643
    def infer_type(self, env):
7644 7645
        return PyrexTypes.independent_spanning_type(self.true_val.infer_type(env),
                                                    self.false_val.infer_type(env))
7646 7647 7648 7649 7650 7651 7652

    def calculate_constant_result(self):
        if self.test.constant_result:
            self.constant_result = self.true_val.constant_result
        else:
            self.constant_result = self.false_val.constant_result

Robert Bradshaw's avatar
Robert Bradshaw committed
7653 7654 7655 7656 7657
    def analyse_types(self, env):
        self.test.analyse_types(env)
        self.test = self.test.coerce_to_boolean(env)
        self.true_val.analyse_types(env)
        self.false_val.analyse_types(env)
7658
        self.type = PyrexTypes.independent_spanning_type(self.true_val.type, self.false_val.type)
7659 7660 7661 7662 7663
        if self.true_val.type.is_pyobject or self.false_val.type.is_pyobject:
            self.true_val = self.true_val.coerce_to(self.type, env)
            self.false_val = self.false_val.coerce_to(self.type, env)
        self.is_temp = 1
        if self.type == PyrexTypes.error_type:
Robert Bradshaw's avatar
Robert Bradshaw committed
7664
            self.type_error()
7665

Robert Bradshaw's avatar
Robert Bradshaw committed
7666 7667 7668 7669 7670
    def type_error(self):
        if not (self.true_val.type.is_error or self.false_val.type.is_error):
            error(self.pos, "Incompatable types in conditional expression (%s; %s)" %
                (self.true_val.type, self.false_val.type))
        self.type = PyrexTypes.error_type
7671

Robert Bradshaw's avatar
Robert Bradshaw committed
7672
    def check_const(self):
7673
        return (self.test.check_const()
7674 7675
            and self.true_val.check_const()
            and self.false_val.check_const())
7676

Robert Bradshaw's avatar
Robert Bradshaw committed
7677
    def generate_evaluation_code(self, code):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
7678 7679
        # Because subexprs may not be evaluated we can use a more optimal
        # subexpr allocation strategy than the default, so override evaluation_code.
7680

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
7681
        code.mark_pos(self.pos)
7682
        self.allocate_temp_result(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
7683
        self.test.generate_evaluation_code(code)
7684
        code.putln("if (%s) {" % self.test.result() )
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
7685
        self.eval_and_get(code, self.true_val)
Robert Bradshaw's avatar
Robert Bradshaw committed
7686
        code.putln("} else {")
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
7687
        self.eval_and_get(code, self.false_val)
Robert Bradshaw's avatar
Robert Bradshaw committed
7688 7689
        code.putln("}")
        self.test.generate_disposal_code(code)
7690
        self.test.free_temps(code)
Robert Bradshaw's avatar
Robert Bradshaw committed
7691

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
7692 7693 7694 7695 7696 7697 7698
    def eval_and_get(self, code, expr):
        expr.generate_evaluation_code(code)
        expr.make_owned_reference(code)
        code.putln("%s = %s;" % (self.result(), expr.result()))
        expr.generate_post_assignment_code(code)
        expr.free_temps(code)

7699 7700 7701 7702 7703 7704 7705 7706 7707 7708
richcmp_constants = {
    "<" : "Py_LT",
    "<=": "Py_LE",
    "==": "Py_EQ",
    "!=": "Py_NE",
    "<>": "Py_NE",
    ">" : "Py_GT",
    ">=": "Py_GE",
}

7709
class CmpNode(object):
William Stein's avatar
William Stein committed
7710 7711
    #  Mixin class containing code common to PrimaryCmpNodes
    #  and CascadedCmpNodes.
7712 7713 7714

    special_bool_cmp_function = None

Stefan Behnel's avatar
typo  
Stefan Behnel committed
7715
    def infer_type(self, env):
7716 7717
        # TODO: Actually implement this (after merging with -unstable).
        return py_object_type
7718 7719 7720 7721 7722

    def calculate_cascaded_constant_result(self, operand1_result):
        func = compile_time_binary_operators[self.operator]
        operand2_result = self.operand2.constant_result
        result = func(operand1_result, operand2_result)
7723 7724 7725 7726 7727 7728 7729
        if self.cascade:
            self.cascade.calculate_cascaded_constant_result(operand2_result)
            if self.cascade.constant_result:
                self.constant_result = result and self.cascade.constant_result
        else:
            self.constant_result = result

7730 7731
    def cascaded_compile_time_value(self, operand1, denv):
        func = get_compile_time_binop(self)
7732
        operand2 = self.operand2.compile_time_value(denv)
7733 7734 7735 7736
        try:
            result = func(operand1, operand2)
        except Exception, e:
            self.compile_time_value_error(e)
7737
            result = None
7738 7739 7740
        if result:
            cascade = self.cascade
            if cascade:
7741
                # FIXME: I bet this must call cascaded_compile_time_value()
7742
                result = result and cascade.cascaded_compile_time_value(operand2, denv)
7743 7744
        return result

7745
    def is_cpp_comparison(self):
Robert Bradshaw's avatar
Robert Bradshaw committed
7746
        return self.operand1.type.is_cpp_class or self.operand2.type.is_cpp_class
7747

7748
    def find_common_int_type(self, env, op, operand1, operand2):
7749 7750 7751 7752 7753 7754
        # type1 != type2 and at least one of the types is not a C int
        type1 = operand1.type
        type2 = operand2.type
        type1_can_be_int = False
        type2_can_be_int = False

7755
        if operand1.is_string_literal and operand1.can_coerce_to_char_literal():
7756
            type1_can_be_int = True
7757
        if operand2.is_string_literal and operand2.can_coerce_to_char_literal():
7758 7759 7760 7761
            type2_can_be_int = True

        if type1.is_int:
            if type2_can_be_int:
7762
                return type1
7763 7764
        elif type2.is_int:
            if type1_can_be_int:
7765
                return type2
7766 7767
        elif type1_can_be_int:
            if type2_can_be_int:
7768
                return PyrexTypes.c_uchar_type
William Stein's avatar
William Stein committed
7769

7770
        return None
7771

7772
    def find_common_type(self, env, op, operand1, common_type=None):
7773
        operand2 = self.operand2
William Stein's avatar
William Stein committed
7774 7775
        type1 = operand1.type
        type2 = operand2.type
7776

7777 7778
        new_common_type = None

Stefan Behnel's avatar
Stefan Behnel committed
7779
        # catch general errors
7780 7781 7782
        if type1 == str_type and (type2.is_string or type2 in (bytes_type, unicode_type)) or \
               type2 == str_type and (type1.is_string or type1 in (bytes_type, unicode_type)):
            error(self.pos, "Comparisons between bytes/unicode and str are not portable to Python 3")
7783
            new_common_type = error_type
Stefan Behnel's avatar
Stefan Behnel committed
7784 7785

        # try to use numeric comparisons where possible
7786
        elif type1.is_complex or type2.is_complex:
7787 7788 7789
            if op not in ('==', '!=') \
               and (type1.is_complex or type1.is_numeric) \
               and (type2.is_complex or type2.is_numeric):
7790 7791
                error(self.pos, "complex types are unordered")
                new_common_type = error_type
7792
            elif type1.is_pyobject:
7793 7794 7795
                new_common_type = type1
            elif type2.is_pyobject:
                new_common_type = type2
7796
            else:
7797
                new_common_type = PyrexTypes.widest_numeric_type(type1, type2)
7798 7799
        elif type1.is_numeric and type2.is_numeric:
            new_common_type = PyrexTypes.widest_numeric_type(type1, type2)
7800
        elif common_type is None or not common_type.is_pyobject:
7801
            new_common_type = self.find_common_int_type(env, op, operand1, operand2)
7802 7803

        if new_common_type is None:
Stefan Behnel's avatar
Stefan Behnel committed
7804
            # fall back to generic type compatibility tests
7805
            if type1 == type2:
7806 7807 7808 7809 7810 7811
                new_common_type = type1
            elif type1.is_pyobject or type2.is_pyobject:
                if type2.is_numeric or type2.is_string:
                    if operand2.check_for_coercion_error(type1):
                        new_common_type = error_type
                    else:
Robert Bradshaw's avatar
Robert Bradshaw committed
7812
                        new_common_type = py_object_type
7813 7814 7815 7816
                elif type1.is_numeric or type1.is_string:
                    if operand1.check_for_coercion_error(type2):
                        new_common_type = error_type
                    else:
Robert Bradshaw's avatar
Robert Bradshaw committed
7817 7818 7819
                        new_common_type = py_object_type
                elif py_object_type.assignable_from(type1) and py_object_type.assignable_from(type2):
                    new_common_type = py_object_type
7820 7821 7822 7823
                else:
                    # one Python type and one non-Python type, not assignable
                    self.invalid_types_error(operand1, op, operand2)
                    new_common_type = error_type
7824 7825 7826 7827
            elif type1.assignable_from(type2):
                new_common_type = type1
            elif type2.assignable_from(type1):
                new_common_type = type2
7828 7829 7830 7831
            else:
                # C types that we couldn't handle up to here are an error
                self.invalid_types_error(operand1, op, operand2)
                new_common_type = error_type
7832

7833 7834 7835 7836 7837 7838
        if new_common_type.is_string and (isinstance(operand1, BytesNode) or
                                          isinstance(operand2, BytesNode)):
            # special case when comparing char* to bytes literal: must
            # compare string values!
            new_common_type = bytes_type

Stefan Behnel's avatar
Stefan Behnel committed
7839
        # recursively merge types
7840
        if common_type is None or new_common_type.is_error:
7841
            common_type = new_common_type
William Stein's avatar
William Stein committed
7842
        else:
7843 7844 7845
            # we could do a lot better by splitting the comparison
            # into a non-Python part and a Python part, but this is
            # safer for now
7846
            common_type = PyrexTypes.spanning_type(common_type, new_common_type)
7847 7848

        if self.cascade:
7849
            common_type = self.cascade.find_common_type(env, self.operator, operand2, common_type)
7850

7851 7852
        return common_type

7853 7854 7855 7856
    def invalid_types_error(self, operand1, op, operand2):
        error(self.pos, "Invalid types for '%s' (%s, %s)" %
              (op, operand1.type, operand2.type))

Stefan Behnel's avatar
Stefan Behnel committed
7857
    def is_python_comparison(self):
7858 7859 7860 7861 7862
        return (not self.is_ptr_contains()
            and not self.is_c_string_contains()
            and (self.has_python_operands()
                 or (self.cascade and self.cascade.is_python_comparison())
                 or self.operator in ('in', 'not_in')))
Stefan Behnel's avatar
Stefan Behnel committed
7863

7864 7865 7866 7867 7868 7869
    def coerce_operands_to(self, dst_type, env):
        operand2 = self.operand2
        if operand2.type != dst_type:
            self.operand2 = operand2.coerce_to(dst_type, env)
        if self.cascade:
            self.cascade.coerce_operands_to(dst_type, env)
7870

7871
    def is_python_result(self):
7872
        return ((self.has_python_operands() and
7873
                 self.special_bool_cmp_function is None and
7874
                 self.operator not in ('is', 'is_not', 'in', 'not_in') and
7875 7876
                 not self.is_c_string_contains() and
                 not self.is_ptr_contains())
7877
            or (self.cascade and self.cascade.is_python_result()))
William Stein's avatar
William Stein committed
7878

7879 7880
    def is_c_string_contains(self):
        return self.operator in ('in', 'not_in') and \
7881 7882
               ((self.operand1.type.is_int
                 and (self.operand2.type.is_string or self.operand2.type is bytes_type)) or
Stefan Behnel's avatar
Stefan Behnel committed
7883
                (self.operand1.type.is_unicode_char
7884
                 and self.operand2.type is unicode_type))
7885

7886 7887
    def is_ptr_contains(self):
        if self.operator in ('in', 'not_in'):
7888 7889 7890
            container_type = self.operand2.type
            return (container_type.is_ptr or container_type.is_array) \
                and not container_type.is_string
7891

7892 7893 7894 7895 7896 7897 7898 7899
    def find_special_bool_compare_function(self, env):
        if self.operator in ('==', '!='):
            type1, type2 = self.operand1.type, self.operand2.type
            if type1.is_pyobject and type2.is_pyobject:
                if type1 is Builtin.unicode_type or type2 is Builtin.unicode_type:
                    env.use_utility_code(pyunicode_equals_utility_code)
                    self.special_bool_cmp_function = "__Pyx_PyUnicode_Equals"
                    return True
7900 7901 7902 7903 7904 7905 7906 7907
                elif type1 is Builtin.bytes_type or type2 is Builtin.bytes_type:
                    env.use_utility_code(pybytes_equals_utility_code)
                    self.special_bool_cmp_function = "__Pyx_PyBytes_Equals"
                    return True
                elif type1 is Builtin.str_type or type2 is Builtin.str_type:
                    env.use_utility_code(pystr_equals_utility_code)
                    self.special_bool_cmp_function = "__Pyx_PyString_Equals"
                    return True
7908 7909
        return False

7910
    def generate_operation_code(self, code, result_code,
William Stein's avatar
William Stein committed
7911
            operand1, op , operand2):
7912
        if self.type.is_pyobject:
7913 7914 7915
            coerce_result = "__Pyx_PyBool_FromLong"
        else:
            coerce_result = ""
7916
        if 'not' in op:
7917
            negation = "!"
7918
        else:
7919
            negation = ""
7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936
        if self.special_bool_cmp_function:
            if operand1.type.is_pyobject:
                result1 = operand1.py_result()
            else:
                result1 = operand1.result()
            if operand2.type.is_pyobject:
                result2 = operand2.py_result()
            else:
                result2 = operand2.result()
            code.putln("%s = %s(%s, %s, %s); %s" % (
                result_code,
                self.special_bool_cmp_function,
                result1,
                result2,
                richcmp_constants[op],
                code.error_goto_if_neg(result_code, self.pos)))
        elif op == 'in' or op == 'not_in':
Stefan Behnel's avatar
typo  
Stefan Behnel committed
7937
            code.globalstate.use_utility_code(contains_utility_code)
7938
            if self.type.is_pyobject:
7939
                coerce_result = "__Pyx_PyBoolOrNull_FromLong"
7940
            if op == 'not_in':
7941
                negation = "__Pyx_NegateNonNeg"
7942
            if operand2.type is dict_type:
7943
                method = "PyDict_Contains"
7944
            else:
7945
                method = "PySequence_Contains"
7946
            if self.type.is_pyobject:
7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957
                error_clause = code.error_goto_if_null
                got_ref = "__Pyx_XGOTREF(%s); " % result_code
            else:
                error_clause = code.error_goto_if_neg
                got_ref = ""
            code.putln(
                "%s = %s(%s(%s(%s, %s))); %s%s" % (
                    result_code,
                    coerce_result,
                    negation,
                    method,
7958 7959
                    operand2.py_result(),
                    operand1.py_result(),
7960 7961
                    got_ref,
                    error_clause(result_code, self.pos)))
William Stein's avatar
William Stein committed
7962 7963
        elif (operand1.type.is_pyobject
            and op not in ('is', 'is_not')):
7964
                code.putln("%s = PyObject_RichCompare(%s, %s, %s); %s" % (
7965 7966 7967
                        result_code,
                        operand1.py_result(),
                        operand2.py_result(),
7968 7969
                        richcmp_constants[op],
                        code.error_goto_if_null(result_code, self.pos)))
7970
                code.put_gotref(result_code)
7971
        elif operand1.type.is_complex:
7972
            if op == "!=":
7973
                negation = "!"
7974
            else:
7975
                negation = ""
7976
            code.putln("%s = %s(%s%s(%s, %s));" % (
7977
                result_code,
7978 7979
                coerce_result,
                negation,
7980 7981
                operand1.type.unary_op('eq'),
                operand1.result(),
7982
                operand2.result()))
William Stein's avatar
William Stein committed
7983
        else:
7984 7985 7986 7987 7988
            type1 = operand1.type
            type2 = operand2.type
            if (type1.is_extension_type or type2.is_extension_type) \
                    and not type1.same_as(type2):
                common_type = py_object_type
7989 7990
            elif type1.is_numeric:
                common_type = PyrexTypes.widest_numeric_type(type1, type2)
7991
            else:
7992 7993 7994
                common_type = type1
            code1 = operand1.result_as(common_type)
            code2 = operand2.result_as(common_type)
7995
            code.putln("%s = %s(%s %s %s);" % (
7996 7997 7998 7999
                result_code,
                coerce_result,
                code1,
                self.c_operator(op),
8000 8001
                code2))

William Stein's avatar
William Stein committed
8002 8003 8004 8005 8006 8007 8008
    def c_operator(self, op):
        if op == 'is':
            return "=="
        elif op == 'is_not':
            return "!="
        else:
            return op
8009

Stefan Behnel's avatar
typo  
Stefan Behnel committed
8010
contains_utility_code = UtilityCode(
8011
proto="""
8012 8013
static CYTHON_INLINE int __Pyx_NegateNonNeg(int b) {
    return unlikely(b < 0) ? b : !b;
Lisandro Dalcin's avatar
Lisandro Dalcin committed
8014
}
8015
static CYTHON_INLINE PyObject* __Pyx_PyBoolOrNull_FromLong(long b) {
8016 8017 8018 8019
    return unlikely(b < 0) ? NULL : __Pyx_PyBool_FromLong(b);
}
""")

8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035
char_in_bytes_utility_code = UtilityCode(
proto="""
static CYTHON_INLINE int __Pyx_BytesContains(PyObject* bytes, char character); /*proto*/
""",
impl="""
static CYTHON_INLINE int __Pyx_BytesContains(PyObject* bytes, char character) {
    const Py_ssize_t length = PyBytes_GET_SIZE(bytes);
    char* char_start = PyBytes_AS_STRING(bytes);
    char* pos;
    for (pos=char_start; pos < char_start+length; pos++) {
        if (character == pos[0]) return 1;
    }
    return 0;
}
""")

8036 8037 8038
py_ucs4_in_unicode_utility_code = UtilityCode(
proto="""
static CYTHON_INLINE int __Pyx_UnicodeContainsUCS4(PyObject* unicode, Py_UCS4 character); /*proto*/
8039
static CYTHON_INLINE int __Pyx_PyUnicodeBufferContainsUCS4(Py_UNICODE* buffer, Py_ssize_t length, Py_UCS4 character); /*proto*/
8040
""",
8041
# additionally handles surrogate pairs for Py_UNICODE buffers in 16bit Unicode builds
8042 8043
impl="""
static CYTHON_INLINE int __Pyx_UnicodeContainsUCS4(PyObject* unicode, Py_UCS4 character) {
8044 8045
#ifdef CYTHON_PEP393_ENABLED
    Py_ssize_t i;
8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056
    int kind;
    void* udata;
    Py_ssize_t length;
    kind = PyUnicode_KIND(unicode);
    if (likely(kind != PyUnicode_WCHAR_KIND)) {
        udata = PyUnicode_DATA(unicode);
        length = PyUnicode_GET_LENGTH(unicode);
        for (i=0; i < length; i++) {
            if (unlikely(character == PyUnicode_READ(kind, udata, i))) return 1;
        }
        return 0;
8057
    }
8058 8059 8060 8061 8062 8063
#endif
    return __Pyx_PyUnicodeBufferContainsUCS4(
        PyUnicode_AS_UNICODE(unicode),
        PyUnicode_GET_SIZE(unicode),
        character);
}
8064

8065 8066 8067
static CYTHON_INLINE int __Pyx_PyUnicodeBufferContainsUCS4(Py_UNICODE* buffer, Py_ssize_t length, Py_UCS4 character) {
    Py_UNICODE uchar;
    Py_UNICODE* pos;
8068
    #if Py_UNICODE_SIZE == 2
8069
    if (character > 65535) {
8070 8071 8072
        Py_UNICODE high_val, low_val;
        high_val = (Py_UNICODE) (0xD800 | (((character - 0x10000) >> 10) & ((1<<10)-1)));
        low_val  = (Py_UNICODE) (0xDC00 | ( (character - 0x10000)        & ((1<<10)-1)));
8073
        for (pos=buffer; pos < buffer+length-1; pos++) {
8074 8075 8076 8077 8078 8079
            if (unlikely(high_val == pos[0]) & unlikely(low_val == pos[1])) return 1;
        }
        return 0;
    }
    #endif
    uchar = (Py_UNICODE) character;
8080
    for (pos=buffer; pos < buffer+length; pos++) {
8081
        if (unlikely(uchar == pos[0])) return 1;
8082 8083 8084 8085 8086
    }
    return 0;
}
""")

8087 8088 8089 8090 8091 8092
pyunicode_equals_utility_code = UtilityCode(
proto="""
static CYTHON_INLINE int __Pyx_PyUnicode_Equals(PyObject* s1, PyObject* s2, int equals); /*proto*/
""",
impl="""
static CYTHON_INLINE int __Pyx_PyUnicode_Equals(PyObject* s1, PyObject* s2, int equals) {
Stefan Behnel's avatar
Stefan Behnel committed
8093
    if (s1 == s2) {   /* as done by PyObject_RichCompareBool(); also catches the (interned) empty string */
8094 8095
        return (equals == Py_EQ);
    } else if (PyUnicode_CheckExact(s1) & PyUnicode_CheckExact(s2)) {
8096
        #ifdef CYTHON_PEP393_ENABLED
8097
        if ((PyUnicode_READY(s1) < 0) || (PyUnicode_READY(s2) < 0))
8098
            return -1;
8099 8100 8101
        if (PyUnicode_GET_LENGTH(s1) != PyUnicode_GET_LENGTH(s2)) {
            return (equals == Py_NE);
        } else if (PyUnicode_GET_LENGTH(s1) == 1) {
8102 8103 8104
            Py_UCS4 ch1 = PyUnicode_READ_CHAR(s1, 0);
            Py_UCS4 ch2 = PyUnicode_READ_CHAR(s2, 0);
            return (equals == Py_EQ) ? (ch1 == ch2) : (ch1 != ch2);
8105 8106 8107 8108 8109
"""
## currently disabled: may not be safe depending on who created the string
#        } else if (PyUnicode_MAX_CHAR_VALUE(s1) != PyUnicode_MAX_CHAR_VALUE(s2)) {
#            return (equals == Py_NE);
"""\
8110
        #else
8111 8112 8113
        if (PyUnicode_GET_SIZE(s1) != PyUnicode_GET_SIZE(s2)) {
            return (equals == Py_NE);
        } else if (PyUnicode_GET_SIZE(s1) == 1) {
8114 8115 8116
            Py_UNICODE ch1 = PyUnicode_AS_UNICODE(s1)[0];
            Py_UNICODE ch2 = PyUnicode_AS_UNICODE(s2)[0];
            return (equals == Py_EQ) ? (ch1 == ch2) : (ch1 != ch2);
8117
        #endif
8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139
        } else {
            int result = PyUnicode_Compare(s1, s2);
            if ((result == -1) && unlikely(PyErr_Occurred()))
                return -1;
            return (equals == Py_EQ) ? (result == 0) : (result != 0);
        }
    } else if ((s1 == Py_None) & PyUnicode_CheckExact(s2)) {
        return (equals == Py_NE);
    } else if ((s2 == Py_None) & PyUnicode_CheckExact(s1)) {
        return (equals == Py_NE);
    } else {
        int result;
        PyObject* py_result = PyObject_RichCompare(s1, s2, equals);
        if (!py_result)
            return -1;
        result = __Pyx_PyObject_IsTrue(py_result);
        Py_DECREF(py_result);
        return result;
    }
}
""")

8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155
pybytes_equals_utility_code = UtilityCode(
proto="""
static CYTHON_INLINE int __Pyx_PyBytes_Equals(PyObject* s1, PyObject* s2, int equals); /*proto*/
""",
impl="""
static CYTHON_INLINE int __Pyx_PyBytes_Equals(PyObject* s1, PyObject* s2, int equals) {
    if (s1 == s2) {   /* as done by PyObject_RichCompareBool(); also catches the (interned) empty string */
        return (equals == Py_EQ);
    } else if (PyBytes_CheckExact(s1) & PyBytes_CheckExact(s2)) {
        if (PyBytes_GET_SIZE(s1) != PyBytes_GET_SIZE(s2)) {
            return (equals == Py_NE);
        } else if (PyBytes_GET_SIZE(s1) == 1) {
            if (equals == Py_EQ)
                return (PyBytes_AS_STRING(s1)[0] == PyBytes_AS_STRING(s2)[0]);
            else
                return (PyBytes_AS_STRING(s1)[0] != PyBytes_AS_STRING(s2)[0]);
8156
        } else {
Lisandro Dalcin's avatar
Lisandro Dalcin committed
8157
            int result = memcmp(PyBytes_AS_STRING(s1), PyBytes_AS_STRING(s2), (size_t)PyBytes_GET_SIZE(s1));
8158 8159
            return (equals == Py_EQ) ? (result == 0) : (result != 0);
        }
8160 8161 8162 8163
    } else if ((s1 == Py_None) & PyBytes_CheckExact(s2)) {
        return (equals == Py_NE);
    } else if ((s2 == Py_None) & PyBytes_CheckExact(s1)) {
        return (equals == Py_NE);
8164
    } else {
8165 8166 8167 8168 8169 8170 8171 8172 8173
        int result;
        PyObject* py_result = PyObject_RichCompare(s1, s2, equals);
        if (!py_result)
            return -1;
        result = __Pyx_PyObject_IsTrue(py_result);
        Py_DECREF(py_result);
        return result;
    }
}
8174 8175
""",
requires=[Builtin.include_string_h_utility_code])
8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186

pystr_equals_utility_code = UtilityCode(
proto="""
#if PY_MAJOR_VERSION >= 3
#define __Pyx_PyString_Equals __Pyx_PyUnicode_Equals
#else
#define __Pyx_PyString_Equals __Pyx_PyBytes_Equals
#endif
""",
requires=[pybytes_equals_utility_code, pyunicode_equals_utility_code])

William Stein's avatar
William Stein committed
8187

8188
class PrimaryCmpNode(ExprNode, CmpNode):
William Stein's avatar
William Stein committed
8189 8190 8191 8192 8193 8194 8195
    #  Non-cascaded comparison or first comparison of
    #  a cascaded sequence.
    #
    #  operator      string
    #  operand1      ExprNode
    #  operand2      ExprNode
    #  cascade       CascadedCmpNode
8196

William Stein's avatar
William Stein committed
8197 8198 8199 8200
    #  We don't use the subexprs mechanism, because
    #  things here are too complicated for it to handle.
    #  Instead, we override all the framework methods
    #  which use it.
8201

Robert Bradshaw's avatar
Robert Bradshaw committed
8202
    child_attrs = ['operand1', 'operand2', 'cascade']
8203

William Stein's avatar
William Stein committed
8204
    cascade = None
8205

Robert Bradshaw's avatar
Robert Bradshaw committed
8206 8207 8208 8209 8210 8211 8212
    def infer_type(self, env):
        # TODO: Actually implement this (after merging with -unstable).
        return py_object_type

    def type_dependencies(self, env):
        return ()

8213
    def calculate_constant_result(self):
8214
        self.calculate_cascaded_constant_result(self.operand1.constant_result)
8215

8216
    def compile_time_value(self, denv):
8217
        operand1 = self.operand1.compile_time_value(denv)
8218 8219
        return self.cascaded_compile_time_value(operand1, denv)

William Stein's avatar
William Stein committed
8220 8221 8222
    def analyse_types(self, env):
        self.operand1.analyse_types(env)
        self.operand2.analyse_types(env)
8223 8224
        if self.is_cpp_comparison():
            self.analyse_cpp_comparison(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
8225 8226 8227
            if self.cascade:
                error(self.pos, "Cascading comparison not yet supported for cpp types.")
            return
William Stein's avatar
William Stein committed
8228
        if self.cascade:
8229 8230
            self.cascade.analyse_types(env)

8231
        if self.operator in ('in', 'not_in'):
8232 8233 8234 8235 8236 8237 8238
            if self.is_c_string_contains():
                self.is_pycmp = False
                common_type = None
                if self.cascade:
                    error(self.pos, "Cascading comparison not yet supported for 'int_val in string'.")
                    return
                if self.operand2.type is unicode_type:
8239
                    env.use_utility_code(py_ucs4_in_unicode_utility_code)
8240 8241 8242 8243 8244 8245
                else:
                    if self.operand1.type is PyrexTypes.c_uchar_type:
                        self.operand1 = self.operand1.coerce_to(PyrexTypes.c_char_type, env)
                    if self.operand2.type is not bytes_type:
                        self.operand2 = self.operand2.coerce_to(bytes_type, env)
                    env.use_utility_code(char_in_bytes_utility_code)
Stefan Behnel's avatar
Stefan Behnel committed
8246 8247
                self.operand2 = self.operand2.as_none_safe_node(
                    "argument of type 'NoneType' is not iterable")
8248 8249 8250 8251 8252 8253
            elif self.is_ptr_contains():
                if self.cascade:
                    error(self.pos, "Cascading comparison not yet supported for 'val in sliced pointer'.")
                self.type = PyrexTypes.c_bint_type
                # Will be transformed by IterationTransform
                return
8254
            else:
8255 8256
                if self.operand2.type is dict_type:
                    self.operand2 = self.operand2.as_none_safe_node("'NoneType' object is not iterable")
8257 8258
                common_type = py_object_type
                self.is_pycmp = True
8259 8260 8261 8262
        elif self.find_special_bool_compare_function(env):
            common_type = None # if coercion needed, the method call above has already done it
            self.is_pycmp = False # result is bint
            self.is_temp = True # must check for error return
8263 8264 8265 8266
        else:
            common_type = self.find_common_type(env, self.operator, self.operand1)
            self.is_pycmp = common_type.is_pyobject

8267
        if common_type is not None and not common_type.is_error:
8268 8269 8270
            if self.operand1.type != common_type:
                self.operand1 = self.operand1.coerce_to(common_type, env)
            self.coerce_operands_to(common_type, env)
8271

William Stein's avatar
William Stein committed
8272 8273 8274
        if self.cascade:
            self.operand2 = self.operand2.coerce_to_simple(env)
            self.cascade.coerce_cascaded_operands_to_temp(env)
8275 8276 8277 8278 8279 8280 8281 8282
        if self.is_python_result():
            self.type = PyrexTypes.py_object_type
        else:
            self.type = PyrexTypes.c_bint_type
        cdr = self.cascade
        while cdr:
            cdr.type = self.type
            cdr = cdr.cascade
William Stein's avatar
William Stein committed
8283 8284
        if self.is_pycmp or self.cascade:
            self.is_temp = 1
8285

8286 8287 8288
    def analyse_cpp_comparison(self, env):
        type1 = self.operand1.type
        type2 = self.operand2.type
8289 8290
        entry = env.lookup_operator(self.operator, [self.operand1, self.operand2])
        if entry is None:
8291 8292
            error(self.pos, "Invalid types for '%s' (%s, %s)" %
                (self.operator, type1, type2))
8293 8294 8295
            self.type = PyrexTypes.error_type
            self.result_code = "<error>"
            return
8296 8297 8298 8299 8300
        func_type = entry.type
        if func_type.is_ptr:
            func_type = func_type.base_type
        if len(func_type.args) == 1:
            self.operand2 = self.operand2.coerce_to(func_type.args[0].type, env)
8301
        else:
8302 8303 8304
            self.operand1 = self.operand1.coerce_to(func_type.args[0].type, env)
            self.operand2 = self.operand2.coerce_to(func_type.args[1].type, env)
        self.type = func_type.return_type
8305

William Stein's avatar
William Stein committed
8306 8307 8308
    def has_python_operands(self):
        return (self.operand1.type.is_pyobject
            or self.operand2.type.is_pyobject)
8309

William Stein's avatar
William Stein committed
8310 8311 8312
    def check_const(self):
        if self.cascade:
            self.not_const()
8313 8314 8315
            return False
        else:
            return self.operand1.check_const() and self.operand2.check_const()
William Stein's avatar
William Stein committed
8316 8317

    def calculate_result_code(self):
8318 8319 8320 8321 8322 8323 8324
        if self.operand1.type.is_complex:
            if self.operator == "!=":
                negation = "!"
            else:
                negation = ""
            return "(%s%s(%s, %s))" % (
                negation,
8325 8326
                self.operand1.type.binary_op('=='),
                self.operand1.result(),
8327
                self.operand2.result())
8328
        elif self.is_c_string_contains():
8329
            if self.operand2.type is unicode_type:
8330
                method = "__Pyx_UnicodeContainsUCS4"
8331
            else:
8332
                method = "__Pyx_BytesContains"
8333 8334 8335 8336 8337 8338 8339
            if self.operator == "not_in":
                negation = "!"
            else:
                negation = ""
            return "(%s%s(%s, %s))" % (
                negation,
                method,
8340
                self.operand2.result(),
8341
                self.operand1.result())
8342 8343 8344 8345 8346
        else:
            return "(%s %s %s)" % (
                self.operand1.result(),
                self.c_operator(self.operator),
                self.operand2.result())
8347

William Stein's avatar
William Stein committed
8348 8349 8350 8351
    def generate_evaluation_code(self, code):
        self.operand1.generate_evaluation_code(code)
        self.operand2.generate_evaluation_code(code)
        if self.is_temp:
8352
            self.allocate_temp_result(code)
8353
            self.generate_operation_code(code, self.result(),
William Stein's avatar
William Stein committed
8354 8355 8356
                self.operand1, self.operator, self.operand2)
            if self.cascade:
                self.cascade.generate_evaluation_code(code,
8357
                    self.result(), self.operand2)
William Stein's avatar
William Stein committed
8358
            self.operand1.generate_disposal_code(code)
8359
            self.operand1.free_temps(code)
William Stein's avatar
William Stein committed
8360
            self.operand2.generate_disposal_code(code)
8361
            self.operand2.free_temps(code)
8362

William Stein's avatar
William Stein committed
8363 8364 8365 8366 8367
    def generate_subexpr_disposal_code(self, code):
        #  If this is called, it is a non-cascaded cmp,
        #  so only need to dispose of the two main operands.
        self.operand1.generate_disposal_code(code)
        self.operand2.generate_disposal_code(code)
8368

8369 8370 8371 8372 8373
    def free_subexpr_temps(self, code):
        #  If this is called, it is a non-cascaded cmp,
        #  so only need to dispose of the two main operands.
        self.operand1.free_temps(code)
        self.operand2.free_temps(code)
8374

8375 8376 8377 8378 8379
    def annotate(self, code):
        self.operand1.annotate(code)
        self.operand2.annotate(code)
        if self.cascade:
            self.cascade.annotate(code)
William Stein's avatar
William Stein committed
8380 8381 8382


class CascadedCmpNode(Node, CmpNode):
8383 8384 8385
    #  A CascadedCmpNode is not a complete expression node. It
    #  hangs off the side of another comparison node, shares
    #  its left operand with that node, and shares its result
William Stein's avatar
William Stein committed
8386 8387 8388 8389 8390 8391
    #  with the PrimaryCmpNode at the head of the chain.
    #
    #  operator      string
    #  operand2      ExprNode
    #  cascade       CascadedCmpNode

Robert Bradshaw's avatar
Robert Bradshaw committed
8392 8393
    child_attrs = ['operand2', 'cascade']

William Stein's avatar
William Stein committed
8394
    cascade = None
8395 8396
    constant_result = constant_value_not_set # FIXME: where to calculate this?

Robert Bradshaw's avatar
Robert Bradshaw committed
8397 8398 8399 8400 8401 8402 8403
    def infer_type(self, env):
        # TODO: Actually implement this (after merging with -unstable).
        return py_object_type

    def type_dependencies(self, env):
        return ()

8404 8405 8406 8407
    def has_constant_result(self):
        return self.constant_result is not constant_value_not_set and \
               self.constant_result is not not_a_constant

8408
    def analyse_types(self, env):
William Stein's avatar
William Stein committed
8409 8410
        self.operand2.analyse_types(env)
        if self.cascade:
8411
            self.cascade.analyse_types(env)
8412

William Stein's avatar
William Stein committed
8413 8414
    def has_python_operands(self):
        return self.operand2.type.is_pyobject
8415

William Stein's avatar
William Stein committed
8416 8417
    def coerce_operands_to_pyobjects(self, env):
        self.operand2 = self.operand2.coerce_to_pyobject(env)
8418 8419
        if self.operand2.type is dict_type and self.operator in ('in', 'not_in'):
            self.operand2 = self.operand2.as_none_safe_node("'NoneType' object is not iterable")
William Stein's avatar
William Stein committed
8420 8421 8422 8423 8424 8425 8426 8427
        if self.cascade:
            self.cascade.coerce_operands_to_pyobjects(env)

    def coerce_cascaded_operands_to_temp(self, env):
        if self.cascade:
            #self.operand2 = self.operand2.coerce_to_temp(env) #CTT
            self.operand2 = self.operand2.coerce_to_simple(env)
            self.cascade.coerce_cascaded_operands_to_temp(env)
8428

William Stein's avatar
William Stein committed
8429
    def generate_evaluation_code(self, code, result, operand1):
8430 8431
        if self.type.is_pyobject:
            code.putln("if (__Pyx_PyObject_IsTrue(%s)) {" % result)
8432
            code.put_decref(result, self.type)
8433 8434
        else:
            code.putln("if (%s) {" % result)
William Stein's avatar
William Stein committed
8435
        self.operand2.generate_evaluation_code(code)
8436
        self.generate_operation_code(code, result,
William Stein's avatar
William Stein committed
8437 8438 8439 8440 8441 8442
            operand1, self.operator, self.operand2)
        if self.cascade:
            self.cascade.generate_evaluation_code(
                code, result, self.operand2)
        # Cascaded cmp result is always temp
        self.operand2.generate_disposal_code(code)
8443
        self.operand2.free_temps(code)
William Stein's avatar
William Stein committed
8444 8445
        code.putln("}")

8446 8447 8448 8449 8450
    def annotate(self, code):
        self.operand2.annotate(code)
        if self.cascade:
            self.cascade.annotate(code)

William Stein's avatar
William Stein committed
8451 8452

binop_node_classes = {
8453 8454
    "or":       BoolBinopNode,
    "and":      BoolBinopNode,
Robert Bradshaw's avatar
Robert Bradshaw committed
8455 8456 8457
    "|":        IntBinopNode,
    "^":        IntBinopNode,
    "&":        IntBinopNode,
8458 8459
    "<<":       IntBinopNode,
    ">>":       IntBinopNode,
Robert Bradshaw's avatar
Robert Bradshaw committed
8460 8461 8462
    "+":        AddNode,
    "-":        SubNode,
    "*":        MulNode,
8463 8464
    "/":        DivNode,
    "//":       DivNode,
Robert Bradshaw's avatar
Robert Bradshaw committed
8465
    "%":        ModNode,
8466
    "**":       PowNode
William Stein's avatar
William Stein committed
8467 8468
}

8469
def binop_node(pos, operator, operand1, operand2, inplace=False):
8470
    # Construct binop node of appropriate class for
William Stein's avatar
William Stein committed
8471
    # given operator.
8472 8473 8474
    return binop_node_classes[operator](pos,
        operator = operator,
        operand1 = operand1,
8475 8476
        operand2 = operand2,
        inplace = inplace)
William Stein's avatar
William Stein committed
8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488

#-------------------------------------------------------------------
#
#  Coercion nodes
#
#  Coercion nodes are special in that they are created during
#  the analyse_types phase of parse tree processing.
#  Their __init__ methods consequently incorporate some aspects
#  of that phase.
#
#-------------------------------------------------------------------

8489
class CoercionNode(ExprNode):
William Stein's avatar
William Stein committed
8490 8491 8492
    #  Abstract base class for coercion nodes.
    #
    #  arg       ExprNode       node being coerced
8493

William Stein's avatar
William Stein committed
8494
    subexprs = ['arg']
8495
    constant_result = not_a_constant
8496

William Stein's avatar
William Stein committed
8497 8498 8499 8500
    def __init__(self, arg):
        self.pos = arg.pos
        self.arg = arg
        if debug_coercion:
Stefan Behnel's avatar
Stefan Behnel committed
8501
            print("%s Coercing %s" % (self, self.arg))
8502 8503

    def calculate_constant_result(self):
8504 8505
        # constant folding can break type coercion, so this is disabled
        pass
8506

8507 8508 8509 8510 8511
    def annotate(self, code):
        self.arg.annotate(code)
        if self.arg.type != self.type:
            file, line, col = self.pos
            code.annotate((file, line, col-1), AnnotationItem(style='coerce', tag='coerce', text='[%s] to [%s]' % (self.arg.type, self.type)))
William Stein's avatar
William Stein committed
8512

8513
class CoerceToMemViewSliceNode(CoercionNode):
8514 8515

    def __init__(self, arg, dst_type, env):
8516 8517
        assert dst_type.is_memoryviewslice
        assert not arg.type.is_memoryviewslice
8518 8519
        CoercionNode.__init__(self, arg)
        self.type = dst_type
8520
        self.is_temp = 1
8521 8522
        self.env = env
        self.use_managed_ref = True
8523
        self.arg = arg
8524 8525

    def generate_result_code(self, code):
8526 8527 8528 8529 8530
        self.type.create_from_py_utility_code(self.env)
        code.putln("%s = %s(%s);" % (self.result(),
                                     self.type.from_py_function,
                                     self.arg.py_result()))

8531 8532 8533
        error_cond = self.type.error_condition(self.result())
        code.putln(code.error_goto_if(error_cond, self.pos))

William Stein's avatar
William Stein committed
8534 8535 8536

class CastNode(CoercionNode):
    #  Wrap a node in a C type cast.
8537

William Stein's avatar
William Stein committed
8538 8539 8540
    def __init__(self, arg, new_type):
        CoercionNode.__init__(self, arg)
        self.type = new_type
Stefan Behnel's avatar
Stefan Behnel committed
8541 8542 8543

    def may_be_none(self):
        return self.arg.may_be_none()
8544

William Stein's avatar
William Stein committed
8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556
    def calculate_result_code(self):
        return self.arg.result_as(self.type)

    def generate_result_code(self, code):
        self.arg.generate_result_code(code)


class PyTypeTestNode(CoercionNode):
    #  This node is used to check that a generic Python
    #  object is an instance of a particular extension type.
    #  This node borrows the result of its argument node.

8557
    def __init__(self, arg, dst_type, env, notnone=False):
William Stein's avatar
William Stein committed
8558 8559
        #  The arg is know to be a Python object, and
        #  the dst_type is known to be an extension type.
Robert Bradshaw's avatar
Robert Bradshaw committed
8560
        assert dst_type.is_extension_type or dst_type.is_builtin_type, "PyTypeTest on non extension type"
William Stein's avatar
William Stein committed
8561 8562 8563
        CoercionNode.__init__(self, arg)
        self.type = dst_type
        self.result_ctype = arg.ctype()
8564
        self.notnone = notnone
8565

8566
    nogil_check = Node.gil_error
8567
    gil_message = "Python type test"
8568

8569 8570
    def analyse_types(self, env):
        pass
Stefan Behnel's avatar
Stefan Behnel committed
8571 8572 8573 8574 8575

    def may_be_none(self):
        if self.notnone:
            return False
        return self.arg.may_be_none()
8576

8577 8578 8579
    def is_simple(self):
        return self.arg.is_simple()

William Stein's avatar
William Stein committed
8580 8581
    def result_in_temp(self):
        return self.arg.result_in_temp()
8582

William Stein's avatar
William Stein committed
8583 8584
    def is_ephemeral(self):
        return self.arg.is_ephemeral()
8585 8586 8587 8588 8589

    def calculate_constant_result(self):
        # FIXME
        pass

William Stein's avatar
William Stein committed
8590
    def calculate_result_code(self):
8591
        return self.arg.result()
8592

William Stein's avatar
William Stein committed
8593 8594
    def generate_result_code(self, code):
        if self.type.typeobj_is_available():
8595
            if not self.type.is_builtin_type:
8596
                code.globalstate.use_utility_code(type_test_utility_code)
William Stein's avatar
William Stein committed
8597
            code.putln(
Robert Bradshaw's avatar
Robert Bradshaw committed
8598
                "if (!(%s)) %s" % (
8599
                    self.type.type_test_code(self.arg.py_result(), self.notnone),
William Stein's avatar
William Stein committed
8600 8601 8602 8603
                    code.error_goto(self.pos)))
        else:
            error(self.pos, "Cannot test type of extern C class "
                "without type object name specification")
8604

William Stein's avatar
William Stein committed
8605 8606
    def generate_post_assignment_code(self, code):
        self.arg.generate_post_assignment_code(code)
8607 8608 8609

    def free_temps(self, code):
        self.arg.free_temps(code)
8610 8611 8612 8613 8614 8615 8616


class NoneCheckNode(CoercionNode):
    # This node is used to check that a Python object is not None and
    # raises an appropriate exception (as specified by the creating
    # transform).

8617 8618
    def __init__(self, arg, exception_type_cname, exception_message,
                 exception_format_args):
8619 8620 8621 8622 8623
        CoercionNode.__init__(self, arg)
        self.type = arg.type
        self.result_ctype = arg.ctype()
        self.exception_type_cname = exception_type_cname
        self.exception_message = exception_message
8624
        self.exception_format_args = tuple(exception_format_args or ())
8625 8626 8627 8628

    def analyse_types(self, env):
        pass

8629 8630 8631
    def may_be_none(self):
        return False

8632 8633 8634
    def is_simple(self):
        return self.arg.is_simple()

8635 8636 8637 8638 8639
    def result_in_temp(self):
        return self.arg.result_in_temp()

    def calculate_result_code(self):
        return self.arg.result()
8640

8641 8642
    def generate_result_code(self, code):
        code.putln(
8643
            "if (unlikely(%s == Py_None)) {" % self.arg.py_result())
8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657
        escape = StringEncoding.escape_byte_string
        if self.exception_format_args:
            code.putln('PyErr_Format(%s, "%s", %s); %s ' % (
                self.exception_type_cname,
                StringEncoding.escape_byte_string(
                    self.exception_message.encode('UTF-8')),
                ', '.join([ '"%s"' % escape(str(arg).encode('UTF-8'))
                            for arg in self.exception_format_args ]),
                code.error_goto(self.pos)))
        else:
            code.putln('PyErr_SetString(%s, "%s"); %s ' % (
                self.exception_type_cname,
                escape(self.exception_message.encode('UTF-8')),
                code.error_goto(self.pos)))
8658 8659 8660 8661 8662 8663 8664 8665
        code.putln("}")

    def generate_post_assignment_code(self, code):
        self.arg.generate_post_assignment_code(code)

    def free_temps(self, code):
        self.arg.free_temps(code)

8666

William Stein's avatar
William Stein committed
8667 8668 8669
class CoerceToPyTypeNode(CoercionNode):
    #  This node is used to convert a C data type
    #  to a Python object.
8670

8671
    type = py_object_type
Robert Bradshaw's avatar
Robert Bradshaw committed
8672
    is_temp = 1
William Stein's avatar
William Stein committed
8673

8674
    def __init__(self, arg, env, type=py_object_type):
8675
        if not arg.type.create_to_py_utility_code(env):
8676 8677 8678 8679 8680 8681 8682
            error(arg.pos, "Cannot convert '%s' to Python object" % arg.type)
        elif arg.type.is_complex:
            # special case: complex coercion is so complex that it
            # uses a macro ("__pyx_PyComplex_FromComplex()"), for
            # which the argument must be simple
            arg = arg.coerce_to_simple(env)
        CoercionNode.__init__(self, arg)
8683 8684 8685 8686
        if type is py_object_type:
            # be specific about some known types
            if arg.type.is_string:
                self.type = bytes_type
Stefan Behnel's avatar
Stefan Behnel committed
8687
            elif arg.type.is_unicode_char:
8688 8689 8690 8691 8692 8693
                self.type = unicode_type
            elif arg.type.is_complex:
                self.type = Builtin.complex_type
        else:
            # FIXME: check that the target type and the resulting type are compatible
            pass
8694

8695 8696 8697 8698
        if arg.type.is_memoryviewslice:
            # Register utility codes at this point
            arg.type.get_to_py_function(env, arg)

8699 8700
        self.env = env

8701
    gil_message = "Converting to Python object"
8702

8703 8704 8705 8706
    def may_be_none(self):
        # FIXME: is this always safe?
        return False

8707
    def coerce_to_boolean(self, env):
8708 8709 8710 8711 8712 8713
        arg_type = self.arg.type
        if (arg_type == PyrexTypes.c_bint_type or
            (arg_type.is_pyobject and arg_type.name == 'bool')):
            return self.arg.coerce_to_temp(env)
        else:
            return CoerceToBooleanNode(self, env)
8714

8715 8716 8717 8718 8719 8720
    def coerce_to_integer(self, env):
        # If not already some C integer type, coerce to longint.
        if self.arg.type.is_int:
            return self.arg
        else:
            return self.arg.coerce_to(PyrexTypes.c_long_type, env)
8721

8722 8723 8724 8725
    def analyse_types(self, env):
        # The arg is always already analysed
        pass

William Stein's avatar
William Stein committed
8726
    def generate_result_code(self, code):
8727
        if self.arg.type.is_memoryviewslice:
8728
            funccall = self.arg.type.get_to_py_function(self.env, self.arg)
8729 8730 8731 8732 8733
        else:
            funccall = "%s(%s)" % (self.arg.type.to_py_function,
                                   self.arg.result())

        code.putln('%s = %s; %s' % (
8734
            self.result(),
8735
            funccall,
8736
            code.error_goto_if_null(self.result(), self.pos)))
8737

8738
        code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
8739 8740


8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780
class CoerceIntToBytesNode(CoerceToPyTypeNode):
    #  This node is used to convert a C int type to a Python bytes
    #  object.

    is_temp = 1

    def __init__(self, arg, env):
        arg = arg.coerce_to_simple(env)
        CoercionNode.__init__(self, arg)
        self.type = Builtin.bytes_type

    def generate_result_code(self, code):
        arg = self.arg
        arg_result = arg.result()
        if arg.type not in (PyrexTypes.c_char_type,
                            PyrexTypes.c_uchar_type,
                            PyrexTypes.c_schar_type):
            if arg.type.signed:
                code.putln("if ((%s < 0) || (%s > 255)) {" % (
                    arg_result, arg_result))
            else:
                code.putln("if (%s > 255) {" % arg_result)
            code.putln('PyErr_Format(PyExc_OverflowError, '
                       '"value too large to pack into a byte"); %s' % (
                           code.error_goto(self.pos)))
            code.putln('}')
        temp = None
        if arg.type is not PyrexTypes.c_char_type:
            temp = code.funcstate.allocate_temp(PyrexTypes.c_char_type, manage_ref=False)
            code.putln("%s = (char)%s;" % (temp, arg_result))
            arg_result = temp
        code.putln('%s = PyBytes_FromStringAndSize(&%s, 1); %s' % (
            self.result(),
            arg_result,
            code.error_goto_if_null(self.result(), self.pos)))
        if temp is not None:
            code.funcstate.release_temp(temp)
        code.put_gotref(self.py_result())


William Stein's avatar
William Stein committed
8781 8782 8783 8784 8785 8786 8787 8788
class CoerceFromPyTypeNode(CoercionNode):
    #  This node is used to convert a Python object
    #  to a C data type.

    def __init__(self, result_type, arg, env):
        CoercionNode.__init__(self, arg)
        self.type = result_type
        self.is_temp = 1
8789
        if not result_type.create_from_py_utility_code(env):
William Stein's avatar
William Stein committed
8790
            error(arg.pos,
Craig Citro's avatar
Craig Citro committed
8791
                  "Cannot convert Python object to '%s'" % result_type)
William Stein's avatar
William Stein committed
8792 8793
        if self.type.is_string and self.arg.is_ephemeral():
            error(arg.pos,
Craig Citro's avatar
Craig Citro committed
8794
                  "Obtaining char * from temporary Python value")
8795

8796 8797 8798 8799
    def analyse_types(self, env):
        # The arg is always already analysed
        pass

William Stein's avatar
William Stein committed
8800 8801
    def generate_result_code(self, code):
        function = self.type.from_py_function
8802 8803 8804 8805
        operand = self.arg.py_result()
        rhs = "%s(%s)" % (function, operand)
        if self.type.is_enum:
            rhs = typecast(self.type, c_long_type, rhs)
Robert Bradshaw's avatar
Robert Bradshaw committed
8806
        code.putln('%s = %s; %s' % (
8807
            self.result(),
8808
            rhs,
8809
            code.error_goto_if(self.type.error_condition(self.result()), self.pos)))
8810
        if self.type.is_pyobject:
8811
            code.put_gotref(self.py_result())
William Stein's avatar
William Stein committed
8812

8813 8814 8815
    def nogil_check(self, env):
        error(self.pos, "Coercion from Python not allowed without the GIL")

William Stein's avatar
William Stein committed
8816 8817 8818 8819

class CoerceToBooleanNode(CoercionNode):
    #  This node is used when a result needs to be used
    #  in a boolean context.
8820

8821
    type = PyrexTypes.c_bint_type
8822 8823 8824 8825

    _special_builtins = {
        Builtin.list_type    : 'PyList_GET_SIZE',
        Builtin.tuple_type   : 'PyTuple_GET_SIZE',
8826
        Builtin.bytes_type   : 'PyBytes_GET_SIZE',
8827 8828 8829
        Builtin.unicode_type : 'PyUnicode_GET_SIZE',
        }

William Stein's avatar
William Stein committed
8830 8831 8832 8833
    def __init__(self, arg, env):
        CoercionNode.__init__(self, arg)
        if arg.type.is_pyobject:
            self.is_temp = 1
8834

8835
    def nogil_check(self, env):
8836
        if self.arg.type.is_pyobject and self._special_builtins.get(self.arg.type) is None:
8837
            self.gil_error()
8838

8839
    gil_message = "Truth-testing Python object"
8840

William Stein's avatar
William Stein committed
8841 8842 8843
    def check_const(self):
        if self.is_temp:
            self.not_const()
8844 8845
            return False
        return self.arg.check_const()
8846

William Stein's avatar
William Stein committed
8847
    def calculate_result_code(self):
8848
        return "(%s != 0)" % self.arg.result()
William Stein's avatar
William Stein committed
8849 8850

    def generate_result_code(self, code):
8851 8852 8853 8854
        if not self.is_temp:
            return
        test_func = self._special_builtins.get(self.arg.type)
        if test_func is not None:
Stefan Behnel's avatar
Stefan Behnel committed
8855
            code.putln("%s = (%s != Py_None) && (%s(%s) != 0);" % (
8856 8857 8858 8859 8860
                       self.result(),
                       self.arg.py_result(),
                       test_func,
                       self.arg.py_result()))
        else:
William Stein's avatar
William Stein committed
8861
            code.putln(
8862
                "%s = __Pyx_PyObject_IsTrue(%s); %s" % (
8863 8864
                    self.result(),
                    self.arg.py_result(),
8865
                    code.error_goto_if_neg(self.result(), self.pos)))
William Stein's avatar
William Stein committed
8866

8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877
class CoerceToComplexNode(CoercionNode):

    def __init__(self, arg, dst_type, env):
        if arg.type.is_complex:
            arg = arg.coerce_to_simple(env)
        self.type = dst_type
        CoercionNode.__init__(self, arg)
        dst_type.create_declaration_utility_code(env)

    def calculate_result_code(self):
        if self.arg.type.is_complex:
8878 8879
            real_part = "__Pyx_CREAL(%s)" % self.arg.result()
            imag_part = "__Pyx_CIMAG(%s)" % self.arg.result()
8880 8881 8882 8883 8884 8885 8886
        else:
            real_part = self.arg.result()
            imag_part = "0"
        return "%s(%s, %s)" % (
                self.type.from_parts,
                real_part,
                imag_part)
8887

8888 8889
    def generate_result_code(self, code):
        pass
William Stein's avatar
William Stein committed
8890 8891 8892 8893 8894 8895 8896 8897 8898

class CoerceToTempNode(CoercionNode):
    #  This node is used to force the result of another node
    #  to be stored in a temporary. It is only used if the
    #  argument node's result is not already in a temporary.

    def __init__(self, arg, env):
        CoercionNode.__init__(self, arg)
        self.type = self.arg.type
8899
        self.constant_result = self.arg.constant_result
William Stein's avatar
William Stein committed
8900 8901 8902
        self.is_temp = 1
        if self.type.is_pyobject:
            self.result_ctype = py_object_type
8903 8904 8905

    gil_message = "Creating temporary Python reference"

8906 8907 8908
    def analyse_types(self, env):
        # The arg is always already analysed
        pass
8909

8910 8911
    def coerce_to_boolean(self, env):
        self.arg = self.arg.coerce_to_boolean(env)
8912 8913
        if self.arg.is_simple():
            return self.arg
8914 8915 8916
        self.type = self.arg.type
        self.result_ctype = self.type
        return self
8917

William Stein's avatar
William Stein committed
8918 8919 8920 8921
    def generate_result_code(self, code):
        #self.arg.generate_evaluation_code(code) # Already done
        # by generic generate_subexpr_evaluation_code!
        code.putln("%s = %s;" % (
8922
            self.result(), self.arg.result_as(self.ctype())))
8923
        if self.type.is_pyobject and self.use_managed_ref:
8924
            code.put_incref(self.result(), self.ctype())
William Stein's avatar
William Stein committed
8925 8926 8927 8928 8929 8930 8931


class CloneNode(CoercionNode):
    #  This node is employed when the result of another node needs
    #  to be used multiple times. The argument node's result must
    #  be in a temporary. This node "borrows" the result from the
    #  argument node, and does not generate any evaluation or
8932
    #  disposal code for it. The original owner of the argument
William Stein's avatar
William Stein committed
8933
    #  node is responsible for doing those things.
8934

William Stein's avatar
William Stein committed
8935
    subexprs = [] # Arg is not considered a subexpr
8936
    nogil_check = None
8937

William Stein's avatar
William Stein committed
8938 8939
    def __init__(self, arg):
        CoercionNode.__init__(self, arg)
8940 8941 8942 8943 8944
        if hasattr(arg, 'type'):
            self.type = arg.type
            self.result_ctype = arg.result_ctype
        if hasattr(arg, 'entry'):
            self.entry = arg.entry
8945

8946
    def result(self):
8947
        return self.arg.result()
8948

8949 8950 8951
    def may_be_none(self):
        return self.arg.may_be_none()

Robert Bradshaw's avatar
Robert Bradshaw committed
8952 8953
    def type_dependencies(self, env):
        return self.arg.type_dependencies(env)
8954

8955 8956
    def infer_type(self, env):
        return self.arg.infer_type(env)
Robert Bradshaw's avatar
Robert Bradshaw committed
8957

Robert Bradshaw's avatar
Robert Bradshaw committed
8958 8959 8960 8961
    def analyse_types(self, env):
        self.type = self.arg.type
        self.result_ctype = self.arg.result_ctype
        self.is_temp = 1
8962 8963
        if hasattr(self.arg, 'entry'):
            self.entry = self.arg.entry
8964

8965 8966 8967
    def is_simple(self):
        return True # result is always in a temp (or a name)

William Stein's avatar
William Stein committed
8968 8969 8970 8971 8972
    def generate_evaluation_code(self, code):
        pass

    def generate_result_code(self, code):
        pass
8973

8974
    def generate_disposal_code(self, code):
8975
        pass
8976

8977 8978
    def free_temps(self, code):
        pass
8979

8980

Stefan Behnel's avatar
Stefan Behnel committed
8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992
class CMethodSelfCloneNode(CloneNode):
    # Special CloneNode for the self argument of builtin C methods
    # that accepts subtypes of the builtin type.  This is safe only
    # for 'final' subtypes, as subtypes of the declared type may
    # override the C method.

    def coerce_to(self, dst_type, env):
        if dst_type.is_builtin_type and self.type.subtype_of(dst_type):
            return self
        return CloneNode.coerce_to(self, dst_type, env)


8993 8994
class ModuleRefNode(ExprNode):
    # Simple returns the module object
8995

8996 8997 8998
    type = py_object_type
    is_temp = False
    subexprs = []
8999

9000 9001 9002
    def analyse_types(self, env):
        pass

9003 9004 9005
    def may_be_none(self):
        return False

9006 9007 9008 9009 9010 9011 9012 9013
    def calculate_result_code(self):
        return Naming.module_cname

    def generate_result_code(self, code):
        pass

class DocstringRefNode(ExprNode):
    # Extracts the docstring of the body element
9014

9015 9016 9017
    subexprs = ['body']
    type = py_object_type
    is_temp = True
9018

9019 9020 9021 9022 9023 9024 9025 9026 9027
    def __init__(self, pos, body):
        ExprNode.__init__(self, pos)
        assert body.type.is_pyobject
        self.body = body

    def analyse_types(self, env):
        pass

    def generate_result_code(self, code):
9028 9029 9030
        code.putln('%s = __Pyx_GetAttrString(%s, "__doc__"); %s' % (
            self.result(), self.body.result(),
            code.error_goto_if_null(self.result(), self.pos)))
9031 9032 9033 9034
        code.put_gotref(self.result())



William Stein's avatar
William Stein committed
9035 9036 9037 9038 9039 9040
#------------------------------------------------------------------------------------
#
#  Runtime support code
#
#------------------------------------------------------------------------------------

9041 9042
get_name_interned_utility_code = UtilityCode(
proto = """
9043
static PyObject *__Pyx_GetName(PyObject *dict, PyObject *name); /*proto*/
9044 9045
""",
impl = """
William Stein's avatar
William Stein committed
9046 9047 9048
static PyObject *__Pyx_GetName(PyObject *dict, PyObject *name) {
    PyObject *result;
    result = PyObject_GetAttr(dict, name);
9049 9050 9051 9052 9053 9054 9055 9056 9057
    if (!result) {
        if (dict != %(BUILTINS)s) {
            PyErr_Clear();
            result = PyObject_GetAttr(%(BUILTINS)s, name);
        }
        if (!result) {
            PyErr_SetObject(PyExc_NameError, name);
        }
    }
William Stein's avatar
William Stein committed
9058 9059
    return result;
}
9060
""" % {'BUILTINS' : Naming.builtins_cname})
William Stein's avatar
William Stein committed
9061 9062 9063

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

9064 9065
import_utility_code = UtilityCode(
proto = """
Haoyu Bai's avatar
Haoyu Bai committed
9066
static PyObject *__Pyx_Import(PyObject *name, PyObject *from_list, long level); /*proto*/
9067 9068
""",
impl = """
Haoyu Bai's avatar
Haoyu Bai committed
9069
static PyObject *__Pyx_Import(PyObject *name, PyObject *from_list, long level) {
9070
    PyObject *py_import = 0;
William Stein's avatar
William Stein committed
9071 9072 9073 9074 9075
    PyObject *empty_list = 0;
    PyObject *module = 0;
    PyObject *global_dict = 0;
    PyObject *empty_dict = 0;
    PyObject *list;
9076 9077
    py_import = __Pyx_GetAttrString(%(BUILTINS)s, "__import__");
    if (!py_import)
William Stein's avatar
William Stein committed
9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092
        goto bad;
    if (from_list)
        list = from_list;
    else {
        empty_list = PyList_New(0);
        if (!empty_list)
            goto bad;
        list = empty_list;
    }
    global_dict = PyModule_GetDict(%(GLOBALS)s);
    if (!global_dict)
        goto bad;
    empty_dict = PyDict_New();
    if (!empty_dict)
        goto bad;
Haoyu Bai's avatar
Haoyu Bai committed
9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106
    #if PY_VERSION_HEX >= 0x02050000
    {
        PyObject *py_level = PyInt_FromLong(level);
        if (!py_level)
            goto bad;
        module = PyObject_CallFunctionObjArgs(py_import,
            name, global_dict, empty_dict, list, py_level, NULL);
        Py_DECREF(py_level);
    }
    #else
    if (level>0) {
        PyErr_SetString(PyExc_RuntimeError, "Relative import is not supported for Python <=2.4.");
        goto bad;
    }
9107
    module = PyObject_CallFunctionObjArgs(py_import,
9108
        name, global_dict, empty_dict, list, NULL);
Haoyu Bai's avatar
Haoyu Bai committed
9109
    #endif
William Stein's avatar
William Stein committed
9110 9111
bad:
    Py_XDECREF(empty_list);
9112
    Py_XDECREF(py_import);
William Stein's avatar
William Stein committed
9113 9114 9115 9116 9117 9118
    Py_XDECREF(empty_dict);
    return module;
}
""" % {
    "BUILTINS": Naming.builtins_cname,
    "GLOBALS":  Naming.module_cname,
9119
})
William Stein's avatar
William Stein committed
9120 9121 9122

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

9123 9124
get_exception_utility_code = UtilityCode(
proto = """
9125
static PyObject *__Pyx_GetExcValue(void); /*proto*/
9126 9127
""",
impl = """
William Stein's avatar
William Stein committed
9128 9129
static PyObject *__Pyx_GetExcValue(void) {
    PyObject *type = 0, *value = 0, *tb = 0;
9130
    PyObject *tmp_type, *tmp_value, *tmp_tb;
William Stein's avatar
William Stein committed
9131 9132 9133 9134 9135 9136 9137 9138 9139 9140
    PyObject *result = 0;
    PyThreadState *tstate = PyThreadState_Get();
    PyErr_Fetch(&type, &value, &tb);
    PyErr_NormalizeException(&type, &value, &tb);
    if (PyErr_Occurred())
        goto bad;
    if (!value) {
        value = Py_None;
        Py_INCREF(value);
    }
9141 9142 9143
    tmp_type = tstate->exc_type;
    tmp_value = tstate->exc_value;
    tmp_tb = tstate->exc_traceback;
William Stein's avatar
William Stein committed
9144 9145 9146
    tstate->exc_type = type;
    tstate->exc_value = value;
    tstate->exc_traceback = tb;
9147 9148 9149 9150 9151
    /* Make sure tstate is in a consistent state when we XDECREF
    these objects (XDECREF may run arbitrary code). */
    Py_XDECREF(tmp_type);
    Py_XDECREF(tmp_value);
    Py_XDECREF(tmp_tb);
William Stein's avatar
William Stein committed
9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162
    result = value;
    Py_XINCREF(result);
    type = 0;
    value = 0;
    tb = 0;
bad:
    Py_XDECREF(type);
    Py_XDECREF(value);
    Py_XDECREF(tb);
    return result;
}
9163
""")
William Stein's avatar
William Stein committed
9164 9165 9166

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

9167 9168
type_test_utility_code = UtilityCode(
proto = """
9169
static CYTHON_INLINE int __Pyx_TypeTest(PyObject *obj, PyTypeObject *type); /*proto*/
9170 9171
""",
impl = """
9172
static CYTHON_INLINE int __Pyx_TypeTest(PyObject *obj, PyTypeObject *type) {
9173
    if (unlikely(!type)) {
William Stein's avatar
William Stein committed
9174 9175 9176
        PyErr_Format(PyExc_SystemError, "Missing type object");
        return 0;
    }
9177
    if (likely(PyObject_TypeCheck(obj, type)))
William Stein's avatar
William Stein committed
9178
        return 1;
9179 9180
    PyErr_Format(PyExc_TypeError, "Cannot convert %.200s to %.200s",
                 Py_TYPE(obj)->tp_name, type->tp_name);
William Stein's avatar
William Stein committed
9181 9182
    return 0;
}
9183
""")
William Stein's avatar
William Stein committed
9184 9185 9186

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

9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197
find_py2_metaclass_utility_code = UtilityCode(
proto = '''
static PyObject *__Pyx_FindPy2Metaclass(PyObject *bases); /*proto*/
''',
impl = '''
static PyObject *__Pyx_FindPy2Metaclass(PyObject *bases) {
    PyObject *metaclass;
    /* Default metaclass */
#if PY_MAJOR_VERSION < 3
    if (PyTuple_Check(bases) && PyTuple_GET_SIZE(bases) > 0) {
        PyObject *base = PyTuple_GET_ITEM(bases, 0);
9198
        metaclass = PyObject_GetAttrString(base, (char *)"__class__");
9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218
        if (!metaclass) {
            PyErr_Clear();
            metaclass = (PyObject*) Py_TYPE(base);
        }
    } else {
        metaclass = (PyObject *) &PyClass_Type;
    }
#else
    if (PyTuple_Check(bases) && PyTuple_GET_SIZE(bases) > 0) {
        PyObject *base = PyTuple_GET_ITEM(bases, 0);
        metaclass = (PyObject*) Py_TYPE(base);
    } else {
        metaclass = (PyObject *) &PyType_Type;
    }
#endif
    Py_INCREF(metaclass);
    return metaclass;
}
''')

9219 9220
create_class_utility_code = UtilityCode(
proto = """
9221
static PyObject *__Pyx_CreateClass(PyObject *bases, PyObject *dict, PyObject *name,
9222 9223 9224 9225 9226
                                   PyObject *modname); /*proto*/
""",
impl = """
static PyObject *__Pyx_CreateClass(PyObject *bases, PyObject *dict, PyObject *name,
                                   PyObject *modname) {
9227 9228
    PyObject *result;
    PyObject *metaclass;
9229 9230 9231 9232 9233 9234

    if (PyDict_SetItemString(dict, "__module__", modname) < 0)
        return NULL;

    /* Python2 __metaclass__ */
    metaclass = PyDict_GetItemString(dict, "__metaclass__");
9235 9236 9237 9238
    if (metaclass) {
        Py_INCREF(metaclass);
    } else {
        metaclass = __Pyx_FindPy2Metaclass(bases);
9239 9240 9241 9242 9243
    }
    result = PyObject_CallFunctionObjArgs(metaclass, name, bases, dict, NULL);
    Py_DECREF(metaclass);
    return result;
}
9244 9245
""",
requires = [find_py2_metaclass_utility_code])
9246 9247 9248 9249 9250

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

create_py3class_utility_code = UtilityCode(
proto = """
Stefan Behnel's avatar
Stefan Behnel committed
9251 9252 9253
static PyObject *__Pyx_Py3MetaclassGet(PyObject *bases, PyObject *mkw); /*proto*/
static PyObject *__Pyx_Py3MetaclassPrepare(PyObject *metaclass, PyObject *bases, PyObject *name, PyObject *mkw, PyObject *modname, PyObject *doc); /*proto*/
static PyObject *__Pyx_Py3ClassCreate(PyObject *metaclass, PyObject *name, PyObject *bases, PyObject *dict, PyObject *mkw); /*proto*/
9254 9255
""",
impl = """
Stefan Behnel's avatar
Stefan Behnel committed
9256
PyObject *__Pyx_Py3MetaclassGet(PyObject *bases, PyObject *mkw) {
9257
    PyObject *metaclass = PyDict_GetItemString(mkw, "metaclass");
9258 9259 9260 9261 9262 9263 9264 9265
    if (metaclass) {
        Py_INCREF(metaclass);
        if (PyDict_DelItemString(mkw, "metaclass") < 0) {
            Py_DECREF(metaclass);
            return NULL;
        }
        return metaclass;
    }
9266
    return __Pyx_FindPy2Metaclass(bases);
9267 9268
}

Stefan Behnel's avatar
Stefan Behnel committed
9269 9270
PyObject *__Pyx_Py3MetaclassPrepare(PyObject *metaclass, PyObject *bases, PyObject *name, PyObject *mkw,
                                    PyObject *modname, PyObject *doc) {
9271 9272 9273
    PyObject *prep;
    PyObject *pargs;
    PyObject *ns;
9274
    PyObject *str;
9275

9276
    prep = PyObject_GetAttrString(metaclass, (char *)"__prepare__");
Stefan Behnel's avatar
Stefan Behnel committed
9277
    if (!prep) {
9278
        if (!PyErr_ExceptionMatches(PyExc_AttributeError))
9279
            return NULL;
9280
        PyErr_Clear();
9281
        return PyDict_New();
9282
    }
Stefan Behnel's avatar
Stefan Behnel committed
9283 9284
    pargs = PyTuple_New(2);
    if (!pargs) {
9285
        Py_DECREF(prep);
9286
        return NULL;
9287
    }
9288

Stefan Behnel's avatar
Stefan Behnel committed
9289 9290 9291 9292
    Py_INCREF(name);
    Py_INCREF(bases);
    PyTuple_SET_ITEM(pargs, 0, name);
    PyTuple_SET_ITEM(pargs, 1, bases);
9293

Stefan Behnel's avatar
Stefan Behnel committed
9294
    ns = PyObject_Call(prep, pargs, mkw);
9295

9296
    Py_DECREF(prep);
9297 9298
    Py_DECREF(pargs);

9299
    if (ns == NULL)
9300 9301 9302 9303
        return NULL;

    /* Required here to emulate assignment order */
    /* XXX: use consts here */
Stefan Behnel's avatar
Stefan Behnel committed
9304 9305 9306
    #if PY_MAJOR_VERSION >= 3
    str = PyUnicode_FromString("__module__");
    #else
9307
    str = PyString_FromString("__module__");
Stefan Behnel's avatar
Stefan Behnel committed
9308
    #endif
9309
    if (!str) {
9310
        Py_DECREF(ns);
9311
        return NULL;
9312
    }
Vitja Makarov's avatar
Vitja Makarov committed
9313

9314 9315 9316
    if (PyObject_SetItem(ns, str, modname) < 0) {
        Py_DECREF(ns);
        Py_DECREF(str);
9317
        return NULL;
9318 9319 9320
    }
    Py_DECREF(str);
    if (doc) {
Stefan Behnel's avatar
Stefan Behnel committed
9321 9322 9323
        #if PY_MAJOR_VERSION >= 3
        str = PyUnicode_FromString("__doc__");
        #else
9324
        str = PyString_FromString("__doc__");
Stefan Behnel's avatar
Stefan Behnel committed
9325
        #endif
9326 9327
        if (!str) {
            Py_DECREF(ns);
9328
            return NULL;
Vitja Makarov's avatar
Vitja Makarov committed
9329
        }
9330 9331 9332 9333
        if (PyObject_SetItem(ns, str, doc) < 0) {
            Py_DECREF(ns);
            Py_DECREF(str);
            return NULL;
Stefan Behnel's avatar
Stefan Behnel committed
9334
        }
9335
        Py_DECREF(str);
Vitja Makarov's avatar
Vitja Makarov committed
9336
    }
9337 9338 9339
    return ns;
}

Stefan Behnel's avatar
Stefan Behnel committed
9340
PyObject *__Pyx_Py3ClassCreate(PyObject *metaclass, PyObject *name, PyObject *bases, PyObject *dict, PyObject *mkw) {
9341
    PyObject *result;
9342
    PyObject *margs = PyTuple_New(3);
9343 9344
    if (!margs)
        return NULL;
9345 9346 9347 9348 9349 9350
    Py_INCREF(name);
    Py_INCREF(bases);
    Py_INCREF(dict);
    PyTuple_SET_ITEM(margs, 0, name);
    PyTuple_SET_ITEM(margs, 1, bases);
    PyTuple_SET_ITEM(margs, 2, dict);
Stefan Behnel's avatar
Stefan Behnel committed
9351
    result = PyObject_Call(metaclass, margs, mkw);
9352
    Py_DECREF(margs);
William Stein's avatar
William Stein committed
9353 9354
    return result;
}
9355 9356
""",
requires = [find_py2_metaclass_utility_code])
William Stein's avatar
William Stein committed
9357 9358

#------------------------------------------------------------------------------------
Robert Bradshaw's avatar
Robert Bradshaw committed
9359

9360 9361
cpp_exception_utility_code = UtilityCode(
proto = """
9362 9363
#ifndef __Pyx_CppExn2PyErr
static void __Pyx_CppExn2PyErr() {
9364 9365
  // Catch a handful of different errors here and turn them into the
  // equivalent Python errors.
Robert Bradshaw's avatar
Robert Bradshaw committed
9366 9367 9368 9369 9370
  try {
    if (PyErr_Occurred())
      ; // let the latest Python exn pass through and ignore the current one
    else
      throw;
9371 9372
  } catch (const std::bad_alloc& exn) {
    PyErr_SetString(PyExc_MemoryError, exn.what());
9373 9374
  } catch (const std::bad_cast& exn) {
    PyErr_SetString(PyExc_TypeError, exn.what());
9375 9376
  } catch (const std::domain_error& exn) {
    PyErr_SetString(PyExc_ValueError, exn.what());
9377 9378
  } catch (const std::invalid_argument& exn) {
    PyErr_SetString(PyExc_ValueError, exn.what());
9379 9380 9381 9382
  } catch (const std::ios_base::failure& exn) {
    // Unfortunately, in standard C++ we have no way of distinguishing EOF
    // from other errors here; be careful with the exception mask
    PyErr_SetString(PyExc_IOError, exn.what());
Robert Bradshaw's avatar
Robert Bradshaw committed
9383
  } catch (const std::out_of_range& exn) {
9384
    // Change out_of_range to IndexError
Robert Bradshaw's avatar
Robert Bradshaw committed
9385
    PyErr_SetString(PyExc_IndexError, exn.what());
9386 9387 9388 9389 9390 9391
  } catch (const std::overflow_error& exn) {
    PyErr_SetString(PyExc_OverflowError, exn.what());
  } catch (const std::range_error& exn) {
    PyErr_SetString(PyExc_ArithmeticError, exn.what());
  } catch (const std::underflow_error& exn) {
    PyErr_SetString(PyExc_ArithmeticError, exn.what());
Robert Bradshaw's avatar
Robert Bradshaw committed
9392 9393 9394 9395 9396 9397 9398 9399
  } catch (const std::exception& exn) {
    PyErr_SetString(PyExc_RuntimeError, exn.what());
  }
  catch (...)
  {
    PyErr_SetString(PyExc_RuntimeError, "Unknown exception");
  }
}
9400
#endif
9401 9402 9403
""",
impl = ""
)
Robert Bradshaw's avatar
Robert Bradshaw committed
9404

9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423
pyerr_occurred_withgil_utility_code= UtilityCode(
proto = """
static CYTHON_INLINE int __Pyx_ErrOccurredWithGIL(void); /* proto */
""",
impl = """
static CYTHON_INLINE int __Pyx_ErrOccurredWithGIL(void) {
  int err;
  #ifdef WITH_THREAD
  PyGILState_STATE _save = PyGILState_Ensure();
  #endif
  err = !!PyErr_Occurred();
  #ifdef WITH_THREAD
  PyGILState_Release(_save);
  #endif
  return err;
}
"""
)

Robert Bradshaw's avatar
Robert Bradshaw committed
9424
#------------------------------------------------------------------------------------
Robert Bradshaw's avatar
Robert Bradshaw committed
9425

9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455
raise_noneattr_error_utility_code = UtilityCode(
proto = """
static CYTHON_INLINE void __Pyx_RaiseNoneAttributeError(const char* attrname);
""",
impl = '''
static CYTHON_INLINE void __Pyx_RaiseNoneAttributeError(const char* attrname) {
    PyErr_Format(PyExc_AttributeError, "'NoneType' object has no attribute '%s'", attrname);
}
''')

raise_noneindex_error_utility_code = UtilityCode(
proto = """
static CYTHON_INLINE void __Pyx_RaiseNoneIndexingError(void);
""",
impl = '''
static CYTHON_INLINE void __Pyx_RaiseNoneIndexingError(void) {
    PyErr_SetString(PyExc_TypeError, "'NoneType' object is unsubscriptable");
}
''')

raise_none_iter_error_utility_code = UtilityCode(
proto = """
static CYTHON_INLINE void __Pyx_RaiseNoneNotIterableError(void);
""",
impl = '''
static CYTHON_INLINE void __Pyx_RaiseNoneNotIterableError(void) {
    PyErr_SetString(PyExc_TypeError, "'NoneType' object is not iterable");
}
''')

9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475
raise_unbound_local_error_utility_code = UtilityCode(
proto = """
static CYTHON_INLINE void __Pyx_RaiseUnboundLocalError(const char *varname);
""",
impl = """
static CYTHON_INLINE void __Pyx_RaiseUnboundLocalError(const char *varname) {
    PyErr_Format(PyExc_UnboundLocalError, "local variable '%s' referenced before assignment", varname);
}
""")

raise_closure_name_error_utility_code = UtilityCode(
proto = """
static CYTHON_INLINE void __Pyx_RaiseClosureNameError(const char *varname);
""",
impl = """
static CYTHON_INLINE void __Pyx_RaiseClosureNameError(const char *varname) {
    PyErr_Format(PyExc_NameError, "free variable '%s' referenced before assignment in enclosing scope", varname);
}
""")

9476 9477 9478 9479
#------------------------------------------------------------------------------------

getitem_dict_utility_code = UtilityCode(
proto = """
9480
#if PY_MAJOR_VERSION >= 3
9481
static PyObject *__Pyx_PyDict_GetItem(PyObject *d, PyObject* key) {
9482
    PyObject *value;
9483
    if (unlikely(d == Py_None)) {
9484 9485 9486
        __Pyx_RaiseNoneIndexingError();
        return NULL;
    }
9487 9488 9489
    value = PyDict_GetItemWithError(d, key);
    if (unlikely(!value)) {
        if (!PyErr_Occurred())
9490
            PyErr_SetObject(PyExc_KeyError, key);
9491
        return NULL;
9492
    }
9493 9494
    Py_INCREF(value);
    return value;
9495
}
9496 9497 9498
#else
    #define __Pyx_PyDict_GetItem(d, key) PyObject_GetItem(d, key)
#endif
9499
""",
9500 9501 9502
requires = [raise_noneindex_error_utility_code])

#------------------------------------------------------------------------------------
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9503

9504 9505 9506 9507
getitem_int_pyunicode_utility_code = UtilityCode(
proto = '''
#define __Pyx_GetItemInt_Unicode(o, i, size, to_py_func) (((size) <= sizeof(Py_ssize_t)) ? \\
                                               __Pyx_GetItemInt_Unicode_Fast(o, i) : \\
Stefan Behnel's avatar
Stefan Behnel committed
9508
                                               __Pyx_GetItemInt_Unicode_Generic(o, to_py_func(i)))
9509

9510
static CYTHON_INLINE Py_UCS4 __Pyx_GetItemInt_Unicode_Fast(PyObject* ustring, Py_ssize_t i) {
9511 9512 9513 9514 9515
    const Py_ssize_t length = __Pyx_PyUnicode_GET_LENGTH(ustring);
    if (likely((0 <= i) & (i < length))) {
        return __Pyx_PyUnicode_READ_CHAR(ustring, i);
    } else if ((-length <= i) & (i < 0)) {
        return __Pyx_PyUnicode_READ_CHAR(ustring, i + length);
9516 9517
    } else {
        PyErr_SetString(PyExc_IndexError, "string index out of range");
9518
        return (Py_UCS4)-1;
9519 9520 9521
    }
}

9522 9523
static CYTHON_INLINE Py_UCS4 __Pyx_GetItemInt_Unicode_Generic(PyObject* ustring, PyObject* j) {
    Py_UCS4 uchar;
9524
    PyObject *uchar_string;
9525
    if (!j) return (Py_UCS4)-1;
9526
    uchar_string = PyObject_GetItem(ustring, j);
9527
    Py_DECREF(j);
9528
    if (!uchar_string) return (Py_UCS4)-1;
9529
    uchar = __Pyx_PyUnicode_READ_CHAR(uchar_string, 0);
9530
    Py_DECREF(uchar_string);
9531 9532
    return uchar;
}
9533
''')
9534

9535 9536
getitem_int_utility_code = UtilityCode(
proto = """
9537

9538
static CYTHON_INLINE PyObject *__Pyx_GetItemInt_Generic(PyObject *o, PyObject* j) {
9539
    PyObject *r;
9540
    if (!j) return NULL;
9541 9542 9543 9544
    r = PyObject_GetItem(o, j);
    Py_DECREF(j);
    return r;
}
9545

9546 9547
""" + ''.join([
"""
9548 9549
#define __Pyx_GetItemInt_%(type)s(o, i, size, to_py_func) (((size) <= sizeof(Py_ssize_t)) ? \\
                                                    __Pyx_GetItemInt_%(type)s_Fast(o, i) : \\
9550 9551
                                                    __Pyx_GetItemInt_Generic(o, to_py_func(i)))

9552
static CYTHON_INLINE PyObject *__Pyx_GetItemInt_%(type)s_Fast(PyObject *o, Py_ssize_t i) {
9553 9554 9555 9556 9557 9558
    if (likely(o != Py_None)) {
        if (likely((0 <= i) & (i < Py%(type)s_GET_SIZE(o)))) {
            PyObject *r = Py%(type)s_GET_ITEM(o, i);
            Py_INCREF(r);
            return r;
        }
9559 9560
        else if ((-Py%(type)s_GET_SIZE(o) <= i) & (i < 0)) {
            PyObject *r = Py%(type)s_GET_ITEM(o, Py%(type)s_GET_SIZE(o) + i);
9561 9562 9563
            Py_INCREF(r);
            return r;
        }
9564
    }
9565
    return __Pyx_GetItemInt_Generic(o, PyInt_FromSsize_t(i));
9566
}
9567 9568
""" % {'type' : type_name} for type_name in ('List', 'Tuple')
]) + """
9569

9570 9571
#define __Pyx_GetItemInt(o, i, size, to_py_func) (((size) <= sizeof(Py_ssize_t)) ? \\
                                                    __Pyx_GetItemInt_Fast(o, i) : \\
9572 9573
                                                    __Pyx_GetItemInt_Generic(o, to_py_func(i)))

9574
static CYTHON_INLINE PyObject *__Pyx_GetItemInt_Fast(PyObject *o, Py_ssize_t i) {
9575 9576 9577 9578 9579 9580 9581
    if (PyList_CheckExact(o)) {
        Py_ssize_t n = (likely(i >= 0)) ? i : i + PyList_GET_SIZE(o);
        if (likely((n >= 0) & (n < PyList_GET_SIZE(o)))) {
            PyObject *r = PyList_GET_ITEM(o, n);
            Py_INCREF(r);
            return r;
        }
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9582
    }
9583 9584 9585 9586 9587 9588 9589
    else if (PyTuple_CheckExact(o)) {
        Py_ssize_t n = (likely(i >= 0)) ? i : i + PyTuple_GET_SIZE(o);
        if (likely((n >= 0) & (n < PyTuple_GET_SIZE(o)))) {
            PyObject *r = PyTuple_GET_ITEM(o, n);
            Py_INCREF(r);
            return r;
        }
9590
    }
9591 9592 9593 9594 9595
    else if (likely(i >= 0)) {
        PySequenceMethods *m = Py_TYPE(o)->tp_as_sequence;
        if (likely(m && m->sq_item)) {
            return m->sq_item(o, i);
        }
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9596
    }
9597
    return __Pyx_GetItemInt_Generic(o, PyInt_FromSsize_t(i));
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9598 9599
}
""",
9600 9601
impl = """
""")
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9602

9603 9604


Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9605 9606
#------------------------------------------------------------------------------------

9607 9608
setitem_int_utility_code = UtilityCode(
proto = """
9609 9610
#define __Pyx_SetItemInt(o, i, v, size, to_py_func) (((size) <= sizeof(Py_ssize_t)) ? \\
                                                    __Pyx_SetItemInt_Fast(o, i, v) : \\
9611 9612
                                                    __Pyx_SetItemInt_Generic(o, to_py_func(i), v))

9613
static CYTHON_INLINE int __Pyx_SetItemInt_Generic(PyObject *o, PyObject *j, PyObject *v) {
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9614
    int r;
9615 9616 9617 9618 9619 9620
    if (!j) return -1;
    r = PyObject_SetItem(o, j, v);
    Py_DECREF(j);
    return r;
}

9621
static CYTHON_INLINE int __Pyx_SetItemInt_Fast(PyObject *o, Py_ssize_t i, PyObject *v) {
9622 9623 9624
    if (PyList_CheckExact(o)) {
        Py_ssize_t n = (likely(i >= 0)) ? i : i + PyList_GET_SIZE(o);
        if (likely((n >= 0) & (n < PyList_GET_SIZE(o)))) {
9625
            PyObject* old = PyList_GET_ITEM(o, n);
9626
            Py_INCREF(v);
9627
            PyList_SET_ITEM(o, n, v);
9628 9629 9630
            Py_DECREF(old);
            return 1;
        }
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9631
    }
9632 9633 9634 9635 9636
    else if (likely(i >= 0)) {
        PySequenceMethods *m = Py_TYPE(o)->tp_as_sequence;
        if (likely(m && m->sq_ass_item)) {
            return m->sq_ass_item(o, i, v);
        }
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9637
    }
9638
    return __Pyx_SetItemInt_Generic(o, PyInt_FromSsize_t(i), v);
Dag Sverre Seljebotn's avatar
Merge  
Dag Sverre Seljebotn committed
9639 9640
}
""",
9641 9642 9643
impl = """
""")

9644 9645
#------------------------------------------------------------------------------------

9646 9647
delitem_int_utility_code = UtilityCode(
proto = """
9648 9649
#define __Pyx_DelItemInt(o, i, size, to_py_func) (((size) <= sizeof(Py_ssize_t)) ? \\
                                                    __Pyx_DelItemInt_Fast(o, i) : \\
9650 9651
                                                    __Pyx_DelItem_Generic(o, to_py_func(i)))

9652
static CYTHON_INLINE int __Pyx_DelItem_Generic(PyObject *o, PyObject *j) {
9653
    int r;
9654 9655 9656 9657 9658 9659
    if (!j) return -1;
    r = PyObject_DelItem(o, j);
    Py_DECREF(j);
    return r;
}

9660
static CYTHON_INLINE int __Pyx_DelItemInt_Fast(PyObject *o, Py_ssize_t i) {
9661 9662 9663 9664 9665
    if (likely(i >= 0)) {
        PySequenceMethods *m = Py_TYPE(o)->tp_as_sequence;
        if (likely(m && m->sq_ass_item)) {
            return m->sq_ass_item(o, i, (PyObject *)NULL);
        }
9666
    }
9667
    return __Pyx_DelItem_Generic(o, PyInt_FromSsize_t(i));
9668 9669 9670 9671 9672 9673 9674
}
""",
impl = """
""")

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

9675 9676
raise_too_many_values_to_unpack = UtilityCode(
proto = """
9677
static CYTHON_INLINE void __Pyx_RaiseTooManyValuesError(Py_ssize_t expected);
9678 9679
""",
impl = '''
9680 9681
static CYTHON_INLINE void __Pyx_RaiseTooManyValuesError(Py_ssize_t expected) {
    PyErr_Format(PyExc_ValueError,
9682
                 "too many values to unpack (expected %"PY_FORMAT_SIZE_T"d)", expected);
9683 9684 9685 9686 9687
}
''')

raise_need_more_values_to_unpack = UtilityCode(
proto = """
9688
static CYTHON_INLINE void __Pyx_RaiseNeedMoreValuesError(Py_ssize_t index);
9689 9690
""",
impl = '''
9691
static CYTHON_INLINE void __Pyx_RaiseNeedMoreValuesError(Py_ssize_t index) {
9692
    PyErr_Format(PyExc_ValueError,
9693 9694
                 "need more than %"PY_FORMAT_SIZE_T"d value%s to unpack",
                 index, (index == 1) ? "" : "s");
9695 9696 9697 9698 9699
}
''')

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

9700 9701 9702
tuple_unpacking_error_code = UtilityCode(
proto = """
static void __Pyx_UnpackTupleError(PyObject *, Py_ssize_t index); /*proto*/
9703
""",
9704 9705 9706 9707 9708 9709 9710
impl = """
static void __Pyx_UnpackTupleError(PyObject *t, Py_ssize_t index) {
    if (t == Py_None) {
      __Pyx_RaiseNoneNotIterableError();
    } else if (PyTuple_GET_SIZE(t) < index) {
      __Pyx_RaiseNeedMoreValuesError(PyTuple_GET_SIZE(t));
    } else {
9711
      __Pyx_RaiseTooManyValuesError(index);
9712 9713
    }
}
9714
""",
9715 9716 9717 9718 9719
requires = [raise_none_iter_error_utility_code,
            raise_need_more_values_to_unpack,
            raise_too_many_values_to_unpack]
)

9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733
unpacking_utility_code = UtilityCode(
proto = """
static PyObject *__Pyx_UnpackItem(PyObject *, Py_ssize_t index); /*proto*/
""",
impl = """
static PyObject *__Pyx_UnpackItem(PyObject *iter, Py_ssize_t index) {
    PyObject *item;
    if (!(item = PyIter_Next(iter))) {
        if (!PyErr_Occurred()) {
            __Pyx_RaiseNeedMoreValuesError(index);
        }
    }
    return item;
}
9734 9735 9736
""",
requires = [raise_need_more_values_to_unpack]
)
9737

9738 9739 9740 9741 9742 9743 9744 9745
iternext_unpacking_end_utility_code = UtilityCode(
proto = """
static int __Pyx_IternextUnpackEndCheck(PyObject *retval, Py_ssize_t expected); /*proto*/
""",
impl = """
static int __Pyx_IternextUnpackEndCheck(PyObject *retval, Py_ssize_t expected) {
    if (unlikely(retval)) {
        Py_DECREF(retval);
9746
        __Pyx_RaiseTooManyValuesError(expected);
9747
        return -1;
9748 9749 9750 9751 9752 9753 9754
    } else if (PyErr_Occurred()) {
        if (likely(PyErr_ExceptionMatches(PyExc_StopIteration))) {
            PyErr_Clear();
            return 0;
        } else {
            return -1;
        }
9755
    }
9756
    return 0;
9757 9758
}
""",
9759
requires = [raise_too_many_values_to_unpack]
9760
)
Robert Bradshaw's avatar
Robert Bradshaw committed
9761

9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773
#------------------------------------------------------------------------------------

# CPython supports calling functions with non-dict kwargs by
# converting them to a dict first

kwargs_call_utility_code = UtilityCode(
proto = """
static PyObject* __Pyx_PyEval_CallObjectWithKeywords(PyObject*, PyObject*, PyObject*); /*proto*/
""",
impl = """
static PyObject* __Pyx_PyEval_CallObjectWithKeywords(PyObject *callable, PyObject *args, PyObject *kwargs) {
    PyObject* result;
9774
    if (likely(PyDict_Check(kwargs))) {
9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785
        return PyEval_CallObjectWithKeywords(callable, args, kwargs);
    } else {
        PyObject* real_dict;
        real_dict = PyObject_CallFunctionObjArgs((PyObject*)&PyDict_Type, kwargs, NULL);
        if (unlikely(!real_dict))
            return NULL;
        result = PyEval_CallObjectWithKeywords(callable, args, real_dict);
        Py_DECREF(real_dict);
        return result; /* may be NULL */
    }
}
9786
""",
9787 9788
)

Robert Bradshaw's avatar
Robert Bradshaw committed
9789 9790 9791 9792 9793

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

int_pow_utility_code = UtilityCode(
proto="""
9794
static CYTHON_INLINE %(type)s %(func_name)s(%(type)s, %(type)s); /* proto */
Robert Bradshaw's avatar
Robert Bradshaw committed
9795 9796
""",
impl="""
9797
static CYTHON_INLINE %(type)s %(func_name)s(%(type)s b, %(type)s e) {
Robert Bradshaw's avatar
Robert Bradshaw committed
9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818
    %(type)s t = b;
    switch (e) {
        case 3:
            t *= b;
        case 2:
            t *= b;
        case 1:
            return t;
        case 0:
            return 1;
    }
    if (unlikely(e<0)) return 0;
    t = 1;
    while (likely(e)) {
        t *= (b * (e&1)) | ((~e)&1);    /* 1 or b */
        b *= b;
        e >>= 1;
    }
    return t;
}
""")
9819 9820 9821

# ------------------------------ Division ------------------------------------

9822 9823
div_int_utility_code = UtilityCode(
proto="""
9824
static CYTHON_INLINE %(type)s __Pyx_div_%(type_name)s(%(type)s, %(type)s); /* proto */
9825 9826
""",
impl="""
9827
static CYTHON_INLINE %(type)s __Pyx_div_%(type_name)s(%(type)s a, %(type)s b) {
9828 9829 9830 9831 9832
    %(type)s q = a / b;
    %(type)s r = a - q*b;
    q -= ((r != 0) & ((r ^ b) < 0));
    return q;
}
9833 9834
""")

9835
mod_int_utility_code = UtilityCode(
9836
proto="""
9837
static CYTHON_INLINE %(type)s __Pyx_mod_%(type_name)s(%(type)s, %(type)s); /* proto */
9838 9839
""",
impl="""
9840
static CYTHON_INLINE %(type)s __Pyx_mod_%(type_name)s(%(type)s a, %(type)s b) {
9841 9842 9843
    %(type)s r = a %% b;
    r += ((r != 0) & ((r ^ b) < 0)) * b;
    return r;
9844 9845 9846
}
""")

9847
mod_float_utility_code = UtilityCode(
9848
proto="""
9849
static CYTHON_INLINE %(type)s __Pyx_mod_%(type_name)s(%(type)s, %(type)s); /* proto */
9850 9851
""",
impl="""
9852
static CYTHON_INLINE %(type)s __Pyx_mod_%(type_name)s(%(type)s a, %(type)s b) {
9853 9854 9855
    %(type)s r = fmod%(math_h_modifier)s(a, b);
    r += ((r != 0) & ((r < 0) ^ (b < 0))) * b;
    return r;
9856 9857
}
""")
Robert Bradshaw's avatar
Robert Bradshaw committed
9858

9859
cdivision_warning_utility_code = UtilityCode(
Robert Bradshaw's avatar
Robert Bradshaw committed
9860
proto="""
9861
static int __Pyx_cdivision_warning(const char *, int); /* proto */
Robert Bradshaw's avatar
Robert Bradshaw committed
9862 9863
""",
impl="""
9864
static int __Pyx_cdivision_warning(const char *filename, int lineno) {
9865
    return PyErr_WarnExplicit(PyExc_RuntimeWarning,
9866
                              "division with oppositely signed operands, C and Python semantics differ",
9867 9868
                              filename,
                              lineno,
9869
                              __Pyx_MODULE_NAME,
9870
                              NULL);
Robert Bradshaw's avatar
Robert Bradshaw committed
9871
}
9872
""")
9873 9874 9875 9876

# from intobject.c
division_overflow_test_code = UtilityCode(
proto="""
Vitja Makarov's avatar
Vitja Makarov committed
9877 9878
#define UNARY_NEG_WOULD_OVERFLOW(x)    \
        (((x) < 0) & ((unsigned long)(x) == 0-(unsigned long)(x)))
9879
""")
Robert Bradshaw's avatar
Robert Bradshaw committed
9880

9881 9882 9883 9884 9885 9886 9887
binding_cfunc_utility_code = UtilityCode.load("CythonFunction",
                                              context=vars(Naming))
fused_function_utility_code = UtilityCode.load(
        "FusedFunction",
        "CythonFunction.c",
        context=vars(Naming),
        requires=[binding_cfunc_utility_code])
9888

9889

9890 9891
generator_utility_code = UtilityCode(
proto="""
9892 9893 9894 9895
static PyObject *__Pyx_Generator_Next(PyObject *self);
static PyObject *__Pyx_Generator_Send(PyObject *self, PyObject *value);
static PyObject *__Pyx_Generator_Close(PyObject *self);
static PyObject *__Pyx_Generator_Throw(PyObject *gen, PyObject *args, CYTHON_UNUSED PyObject *kwds);
9896

9897
typedef PyObject *(*__pyx_generator_body_t)(PyObject *, PyObject *);
9898 9899
""",
impl="""
9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910
static CYTHON_INLINE void __Pyx_Generator_ExceptionClear(struct __pyx_Generator_object *self)
{
    Py_XDECREF(self->exc_type);
    Py_XDECREF(self->exc_value);
    Py_XDECREF(self->exc_traceback);

    self->exc_type = NULL;
    self->exc_value = NULL;
    self->exc_traceback = NULL;
}

9911
static CYTHON_INLINE PyObject *__Pyx_Generator_SendEx(struct __pyx_Generator_object *self, PyObject *value)
9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929
{
    PyObject *retval;

    if (self->is_running) {
        PyErr_SetString(PyExc_ValueError,
                        "generator already executing");
        return NULL;
    }

    if (self->resume_label == 0) {
        if (value && value != Py_None) {
            PyErr_SetString(PyExc_TypeError,
                            "can't send non-None value to a "
                            "just-started generator");
            return NULL;
        }
    }

9930 9931 9932 9933 9934
    if (self->resume_label == -1) {
        PyErr_SetNone(PyExc_StopIteration);
        return NULL;
    }

9935 9936 9937 9938 9939 9940

    if (value)
        __Pyx_ExceptionSwap(&self->exc_type, &self->exc_value, &self->exc_traceback);
    else
        __Pyx_Generator_ExceptionClear(self);

9941
    self->is_running = 1;
9942
    retval = self->body((PyObject *) self, value);
9943 9944
    self->is_running = 0;

9945 9946 9947 9948 9949
    if (retval)
        __Pyx_ExceptionSwap(&self->exc_type, &self->exc_value, &self->exc_traceback);
    else
        __Pyx_Generator_ExceptionClear(self);

9950 9951 9952
    return retval;
}

9953
static PyObject *__Pyx_Generator_Next(PyObject *self)
9954
{
9955
    return __Pyx_Generator_SendEx((struct __pyx_Generator_object *) self, Py_None);
9956 9957
}

9958
static PyObject *__Pyx_Generator_Send(PyObject *self, PyObject *value)
9959
{
9960
    return __Pyx_Generator_SendEx((struct __pyx_Generator_object *) self, value);
9961
}
Vitja Makarov's avatar
Vitja Makarov committed
9962

9963
static PyObject *__Pyx_Generator_Close(PyObject *self)
Vitja Makarov's avatar
Vitja Makarov committed
9964
{
9965
    struct __pyx_Generator_object *generator = (struct __pyx_Generator_object *) self;
Vitja Makarov's avatar
Vitja Makarov committed
9966
    PyObject *retval;
9967 9968 9969
#if PY_VERSION_HEX < 0x02050000
    PyErr_SetNone(PyExc_StopIteration);
#else
Vitja Makarov's avatar
Vitja Makarov committed
9970
    PyErr_SetNone(PyExc_GeneratorExit);
9971
#endif
9972
    retval = __Pyx_Generator_SendEx(generator, NULL);
Vitja Makarov's avatar
Vitja Makarov committed
9973 9974 9975 9976 9977 9978
    if (retval) {
        Py_DECREF(retval);
        PyErr_SetString(PyExc_RuntimeError,
                        "generator ignored GeneratorExit");
        return NULL;
    }
9979 9980 9981
#if PY_VERSION_HEX < 0x02050000
    if (PyErr_ExceptionMatches(PyExc_StopIteration))
#else
Vitja Makarov's avatar
Vitja Makarov committed
9982 9983
    if (PyErr_ExceptionMatches(PyExc_StopIteration)
        || PyErr_ExceptionMatches(PyExc_GeneratorExit))
9984
#endif
Vitja Makarov's avatar
Vitja Makarov committed
9985 9986 9987 9988 9989 9990 9991
    {
        PyErr_Clear();          /* ignore these errors */
        Py_INCREF(Py_None);
        return Py_None;
    }
    return NULL;
}
9992

9993
static PyObject *__Pyx_Generator_Throw(PyObject *self, PyObject *args, CYTHON_UNUSED PyObject *kwds)
9994
{
9995
    struct __pyx_Generator_object *generator = (struct __pyx_Generator_object *) self;
9996 9997 9998 9999
    PyObject *typ;
    PyObject *tb = NULL;
    PyObject *val = NULL;

10000
    if (!PyArg_UnpackTuple(args, (char *)"throw", 1, 3, &typ, &val, &tb))
10001
        return NULL;
10002
    __Pyx_Raise(typ, val, tb, NULL);
10003
    return __Pyx_Generator_SendEx(generator, NULL);
10004
}
Stefan Behnel's avatar
Stefan Behnel committed
10005 10006
""",
proto_block='utility_code_proto_before_types',
10007
requires=[Nodes.raise_utility_code, Nodes.swap_exception_utility_code],
Stefan Behnel's avatar
Stefan Behnel committed
10008
)