Code.py 80.1 KB
Newer Older
1
# cython: language_level = 2
William Stein's avatar
William Stein committed
2
#
3
#   Code output module
William Stein's avatar
William Stein committed
4 5
#

6 7
from __future__ import absolute_import

Stefan Behnel's avatar
Stefan Behnel committed
8
import cython
9 10
cython.declare(os=object, re=object, operator=object,
               Naming=object, Options=object, StringEncoding=object,
Stefan Behnel's avatar
Stefan Behnel committed
11
               Utils=object, SourceDescriptor=object, StringIOTree=object,
12
               DebugFlags=object, basestring=object)
Stefan Behnel's avatar
Stefan Behnel committed
13

14
import os
15
import re
Stefan Behnel's avatar
Stefan Behnel committed
16
import sys
17
from string import Template
18
import operator
19
import textwrap
20

Robert Bradshaw's avatar
Robert Bradshaw committed
21 22 23 24 25
try:
    import hashlib
except ImportError:
    import md5 as hashlib

26 27 28 29 30 31 32
from . import Naming
from . import Options
from . import DebugFlags
from . import StringEncoding
from .. import Utils
from .Scanning import SourceDescriptor
from ..StringIOTree import StringIOTree
33

Stefan Behnel's avatar
Stefan Behnel committed
34
try:
Stefan Behnel's avatar
Stefan Behnel committed
35 36 37
    from __builtin__ import basestring
except ImportError:
    from builtins import str as basestring
38

39
KEYWORDS_MUST_BE_BYTES = sys.version_info < (2,7)
Stefan Behnel's avatar
Stefan Behnel committed
40

41 42

non_portable_builtins_map = {
43
    # builtins that have different names in different Python versions
44 45
    'bytes'         : ('PY_MAJOR_VERSION < 3',  'str'),
    'unicode'       : ('PY_MAJOR_VERSION >= 3', 'str'),
46
    'basestring'    : ('PY_MAJOR_VERSION >= 3', 'str'),
47
    'xrange'        : ('PY_MAJOR_VERSION >= 3', 'range'),
48
    'raw_input'     : ('PY_MAJOR_VERSION >= 3', 'input'),
49 50
    }

51 52
basicsize_builtins_map = {
    # builtins whose type has a different tp_basicsize than sizeof(...)
53 54
    'PyTypeObject': 'PyHeapTypeObject',
}
55

56 57 58 59
uncachable_builtins = [
    # builtin names that cannot be cached because they may or may not
    # be available at import time
    'WindowsError',
60 61
    '_',  # e.g. gettext
]
62

63 64 65 66
modifier_output_mapper = {
    'inline': 'CYTHON_INLINE'
}.get

67 68
is_self_assignment = re.compile(r" *(\w+) = (\1);\s*$").match

Stefan Behnel's avatar
Stefan Behnel committed
69

70 71 72 73 74
def get_utility_dir():
    # make this a function and not global variables:
    # http://trac.cython.org/cython_trac/ticket/475
    Cython_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    return os.path.join(Cython_dir, "Utility")
Mark Florisson's avatar
Mark Florisson committed
75

Stefan Behnel's avatar
Stefan Behnel committed
76

77
class UtilityCodeBase(object):
78 79 80 81 82 83
    """
    Support for loading utility code from a file.

    Code sections in the file can be specified as follows:

        ##### MyUtility.proto #####
84

85
        [proto declarations]
86

87
        ##### MyUtility.init #####
88

89
        [code run at module initialization]
90 91 92

        ##### MyUtility #####
        #@requires: MyOtherUtility
93
        #@substitute: naming
94

95
        [definitions]
96 97 98 99 100 101 102 103 104

    for prototypes and implementation respectively.  For non-python or
    -cython files backslashes should be used instead.  5 to 30 comment
    characters may be used on either side.

    If the @cname decorator is not used and this is a CythonUtilityCode,
    one should pass in the 'name' keyword argument to be used for name
    mangling of such entries.
    """
105 106

    is_cython_utility = False
107
    requires = None
108 109
    _utility_cache = {}

110
    @classmethod
111
    def _add_utility(cls, utility, type, lines, begin_lineno, tags=None):
112 113
        if utility is None:
            return
114

115 116 117 118 119 120 121 122 123 124 125
        code = '\n'.join(lines)
        if tags and 'substitute' in tags and tags['substitute'] == set(['naming']):
            del tags['substitute']
            try:
                code = Template(code).substitute(vars(Naming))
            except (KeyError, ValueError), e:
                raise RuntimeError("Error parsing templated utility code of type '%s' at line %d: %s" % (
                    type, begin_lineno, e))

        # remember correct line numbers at least until after templating
        code = '\n' * begin_lineno + code
126

127
        if type == 'proto':
128
            utility[0] = code
129
        elif type == 'impl':
130
            utility[1] = code
131 132
        else:
            all_tags = utility[2]
Stefan Behnel's avatar
Stefan Behnel committed
133 134
            if KEYWORDS_MUST_BE_BYTES:
                type = type.encode('ASCII')
135
            all_tags[type] = code
136

137 138
        if tags:
            all_tags = utility[2]
Stefan Behnel's avatar
Stefan Behnel committed
139
            for name, values in tags.items():
Stefan Behnel's avatar
Stefan Behnel committed
140 141
                if KEYWORDS_MUST_BE_BYTES:
                    name = name.encode('ASCII')
142
                all_tags.setdefault(name, set()).update(values)
143

144
    @classmethod
145 146 147 148 149
    def load_utilities_from_file(cls, path):
        utilities = cls._utility_cache.get(path)
        if utilities:
            return utilities

150
        filename = os.path.join(get_utility_dir(), path)
151 152 153
        _, ext = os.path.splitext(path)
        if ext in ('.pyx', '.py', '.pxd', '.pxi'):
            comment = '#'
154
            replace_comments = re.compile(r'^\s*#.*').sub
155
        else:
156
            comment = '/'
157
            replace_comments = re.compile(r'^\s*//.*|/\*[^*]*\*/').sub
158
        match_special = re.compile(
159
            (r'^%(C)s{5,30}\s*(?P<name>(?:\w|\.)+)\s*%(C)s{5,30}|'
Stefan Behnel's avatar
Stefan Behnel committed
160
             r'^%(C)s+@(?P<tag>\w+)\s*:\s*(?P<value>(?:\w|[.:])+)'
161
                ) % {'C':comment}).match
162
        match_type = re.compile('(.+)[.](proto|impl|init|cleanup)$').match
163

164 165
        f = Utils.open_source_file(filename, encoding='UTF-8')
        try:
166
            all_lines = f.readlines()
167 168
        finally:
            f.close()
169

170 171
        utilities = {}
        lines = []
172
        tags = {}
173 174 175
        utility = type = None
        begin_lineno = 0

Mark Florisson's avatar
Mark Florisson committed
176
        for lineno, line in enumerate(all_lines):
177
            m = match_special(line)
Mark Florisson's avatar
Mark Florisson committed
178
            if m:
179
                if m.group('name'):
180 181 182 183 184 185
                    cls._add_utility(utility, type, lines, begin_lineno, tags)

                    begin_lineno = lineno + 1
                    del lines[:]
                    tags.clear()

186 187 188 189
                    name = m.group('name')
                    mtype = match_type(name)
                    if mtype:
                        name, type = mtype.groups()
190
                    else:
191
                        type = 'impl'
192
                    utility = utilities.setdefault(name, [None, None, {}])
Mark Florisson's avatar
Mark Florisson committed
193
                else:
194
                    tags.setdefault(m.group('tag'), set()).add(m.group('value'))
195
                    lines.append('') # keep line number correct
Mark Florisson's avatar
Mark Florisson committed
196
            else:
197
                lines.append(replace_comments('', line).rstrip())
Mark Florisson's avatar
Mark Florisson committed
198

199
        if utility is None:
200 201 202
            raise ValueError("Empty utility code file")

        # Don't forget to add the last utility code
203
        cls._add_utility(utility, type, lines, begin_lineno, tags)
204 205 206 207

        cls._utility_cache[path] = utilities
        return utilities

208
    @classmethod
209
    def load(cls, util_code_name, from_file=None, **kwargs):
210
        """
211 212 213 214
        Load utility code from a file specified by from_file (relative to
        Cython/Utility) and name util_code_name.  If from_file is not given,
        load it from the file util_code_name.*.  There should be only one
        file matched by this pattern.
215
        """
216 217 218
        if '::' in util_code_name:
            from_file, util_code_name = util_code_name.rsplit('::', 1)
        if not from_file:
219 220
            utility_dir = get_utility_dir()
            prefix = util_code_name + '.'
221 222 223 224 225 226 227 228 229 230 231 232 233 234
            try:
                listing = os.listdir(utility_dir)
            except OSError:
                # XXX the code below assumes as 'zipimport.zipimporter' instance
                # XXX should be easy to generalize, but too lazy right now to write it
                import zipfile
                global __loader__
                loader = __loader__
                archive = loader.archive
                fileobj = zipfile.ZipFile(archive)
                listing = [ os.path.basename(name)
                            for name in fileobj.namelist()
                            if os.path.join(archive, name).startswith(utility_dir)]
                fileobj.close()
235
            files = [ os.path.join(utility_dir, filename)
236
                      for filename in listing
237 238 239 240 241 242
                      if filename.startswith(prefix) ]
            if not files:
                raise ValueError("No match found for utility code " + util_code_name)
            if len(files) > 1:
                raise ValueError("More than one filename match found for utility code " + util_code_name)
            from_file = files[0]
243 244

        utilities = cls.load_utilities_from_file(from_file)
245 246 247 248
        proto, impl, tags = utilities[util_code_name]

        if tags:
            orig_kwargs = kwargs.copy()
Stefan Behnel's avatar
Stefan Behnel committed
249
            for name, values in tags.items():
250 251 252 253
                if name in kwargs:
                    continue
                # only pass lists when we have to: most argument expect one value or None
                if name == 'requires':
254 255 256 257 258 259 260
                    if orig_kwargs:
                        values = [cls.load(dep, from_file, **orig_kwargs)
                                  for dep in sorted(values)]
                    else:
                        # dependencies are rarely unique, so use load_cached() when we can
                        values = [cls.load_cached(dep, from_file)
                                  for dep in sorted(values)]
261 262 263 264 265
                elif not values:
                    values = None
                elif len(values) == 1:
                    values = values[0]
                kwargs[name] = values
Mark Florisson's avatar
Mark Florisson committed
266

267 268 269 270
        if proto is not None:
            kwargs['proto'] = proto
        if impl is not None:
            kwargs['impl'] = impl
Mark Florisson's avatar
Mark Florisson committed
271

272 273
        if 'name' not in kwargs:
            kwargs['name'] = util_code_name
Mark Florisson's avatar
Mark Florisson committed
274

275 276 277 278 279
        if 'file' not in kwargs and from_file:
            kwargs['file'] = from_file
        return cls(**kwargs)

    @classmethod
280
    def load_cached(cls, utility_code_name, from_file=None, __cache={}):
281
        """
282
        Calls .load(), but using a per-type cache based on utility name and file name.
283
        """
284 285
        key = (cls, from_file, utility_code_name)
        try:
286
            return __cache[key]
287 288
        except KeyError:
            pass
289
        code = __cache[key] = cls.load(utility_code_name, from_file)
290
        return code
291

292 293 294 295 296 297 298
    @classmethod
    def load_as_string(cls, util_code_name, from_file=None, **kwargs):
        """
        Load a utility code as a string. Returns (proto, implementation)
        """
        util = cls.load(util_code_name, from_file, **kwargs)
        proto, impl = util.proto, util.impl
299
        return util.format_code(proto), util.format_code(impl)
300

301
    def format_code(self, code_string, replace_empty_lines=re.compile(r'\n\n+').sub):
302 303 304 305 306 307 308
        """
        Format a code section for output.
        """
        if code_string:
            code_string = replace_empty_lines('\n', code_string.strip()) + '\n\n'
        return code_string

309 310 311
    def __str__(self):
        return "<%s(%s)" % (type(self).__name__, self.name)

312 313
    def get_tree(self):
        pass
314

Stefan Behnel's avatar
Stefan Behnel committed
315

316
class UtilityCode(UtilityCodeBase):
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
    """
    Stores utility code to add during code generation.

    See GlobalState.put_utility_code.

    hashes/equals by instance

    proto           C prototypes
    impl            implemenation code
    init            code to call on module initialization
    requires        utility code dependencies
    proto_block     the place in the resulting file where the prototype should
                    end up
    name            name of the utility code (or None)
    file            filename of the utility code file this utility was loaded
                    from (or None)
    """
334

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
335
    def __init__(self, proto=None, impl=None, init=None, cleanup=None, requires=None,
336
                 proto_block='utility_code_proto', name=None, file=None):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
337
        # proto_block: Which code block to dump prototype in. See GlobalState.
338 339 340 341 342 343 344
        self.proto = proto
        self.impl = impl
        self.init = init
        self.cleanup = cleanup
        self.requires = requires
        self._cache = {}
        self.specialize_list = []
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
345
        self.proto_block = proto_block
346
        self.name = name
347
        self.file = file
348

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
    def __hash__(self):
        return hash((self.proto, self.impl))

    def __eq__(self, other):
        if self is other:
            return True
        if not isinstance(other, type(self)):
            return False

        self_proto = getattr(self, 'proto', None)
        other_proto = getattr(other, 'proto', None)
        return (self_proto, self.impl) == (other_proto, other.impl)

    def none_or_sub(self, s, context):
        """
        Format a string in this utility code with context. If None, do nothing.
        """
        if s is None:
            return None
        return s % context

    def specialize(self, pyrex_type=None, **data):
371 372
        # Dicts aren't hashable...
        if pyrex_type is not None:
373
            data['type'] = pyrex_type.empty_declaration_code()
Craig Citro's avatar
Craig Citro committed
374
            data['type_name'] = pyrex_type.specialization_name()
Stefan Behnel's avatar
Stefan Behnel committed
375
        key = tuple(sorted(data.items()))
376 377 378 379 380 381 382
        try:
            return self._cache[key]
        except KeyError:
            if self.requires is None:
                requires = None
            else:
                requires = [r.specialize(data) for r in self.requires]
383

384
            s = self._cache[key] = UtilityCode(
385 386 387 388
                    self.none_or_sub(self.proto, data),
                    self.none_or_sub(self.impl, data),
                    self.none_or_sub(self.init, data),
                    self.none_or_sub(self.cleanup, data),
389 390 391
                    requires,
                    self.proto_block)

392 393 394
            self.specialize_list.append(s)
            return s

395 396 397
    def inject_string_constants(self, impl, output):
        """Replace 'PYIDENT("xyz")' by a constant Python identifier cname.
        """
398 399 400 401 402 403 404 405 406 407 408 409
        replacements = {}
        def externalise(matchobj):
            name = matchobj.group(1)
            try:
                cname = replacements[name]
            except KeyError:
                cname = replacements[name] = output.get_interned_identifier(
                    StringEncoding.EncodedString(name)).cname
            return cname

        impl = re.sub('PYIDENT\("([^"]+)"\)', externalise, impl)
        return bool(replacements), impl
410

411 412 413 414 415
    def put_code(self, output):
        if self.requires:
            for dependency in self.requires:
                output.use_utility_code(dependency)
        if self.proto:
416 417 418
            output[self.proto_block].put_or_include(
                self.format_code(self.proto),
                '%s_proto' % self.name)
419
        if self.impl:
420 421 422 423 424 425 426 427
            impl = self.format_code(self.impl)
            is_specialised, impl = self.inject_string_constants(impl, output)
            if not is_specialised:
                # no module specific adaptations => can be reused
                output['utility_code_def'].put_or_include(
                    impl, '%s_impl' % self.name)
            else:
                output['utility_code_def'].put(impl)
428 429
        if self.init:
            writer = output['init_globals']
430
            writer.putln("/* %s.init */" % self.name)
431
            if isinstance(self.init, basestring):
432
                writer.put(self.format_code(self.init))
433 434
            else:
                self.init(writer, output.module_pos)
435 436
            writer.putln(writer.error_goto_if_PyErr(output.module_pos))
            writer.putln()
437 438 439
        if self.cleanup and Options.generate_cleanup_code:
            writer = output['cleanup_globals']
            if isinstance(self.cleanup, basestring):
440 441 442
                writer.put_or_include(
                    self.format_code(self.cleanup),
                    '%s_cleanup' % self.name)
443 444
            else:
                self.cleanup(writer, output.module_pos)
445 446


447
def sub_tempita(s, context, file=None, name=None):
448 449 450
    "Run tempita on string s with given context."
    if not s:
        return None
451

452 453 454 455
    if file:
        context['__name'] = "%s:%s" % (file, name)
    elif name:
        context['__name'] = name
456

457
    from ..Tempita import sub
458
    return sub(s, **context)
459

460
class TempitaUtilityCode(UtilityCode):
461
    def __init__(self, name=None, proto=None, impl=None, init=None, file=None, context=None, **kwargs):
462 463
        if context is None:
            context = {}
464 465
        proto = sub_tempita(proto, context, file, name)
        impl = sub_tempita(impl, context, file, name)
466
        init = sub_tempita(init, context, file, name)
467
        super(TempitaUtilityCode, self).__init__(
468
            proto, impl, init=init, name=name, file=file, **kwargs)
469 470 471 472 473 474 475 476

    def none_or_sub(self, s, context):
        """
        Format a string in this utility code with context. If None, do nothing.
        """
        if s is None:
            return None
        return sub_tempita(s, context, self.file, self.name)
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491


class LazyUtilityCode(UtilityCodeBase):
    """
    Utility code that calls a callback with the root code writer when
    available. Useful when you only have 'env' but not 'code'.
    """

    def __init__(self, callback):
        self.callback = callback

    def put_code(self, globalstate):
        utility = self.callback(globalstate.rootwriter)
        globalstate.use_utility_code(utility)

492

493 494 495 496 497 498 499 500 501
class FunctionState(object):
    # return_label     string          function return point label
    # error_label      string          error catch point label
    # continue_label   string          loop continue point label
    # break_label      string          loop break point label
    # return_from_error_cleanup_label string
    # label_counter    integer         counter for naming labels
    # in_try_finally   boolean         inside try of try...finally
    # exc_vars         (string * 3)    exception variables for reraise, or None
502
    # can_trace        boolean         line tracing is supported in the current context
503

504
    # Not used for now, perhaps later
Robert Bradshaw's avatar
Robert Bradshaw committed
505
    def __init__(self, owner, names_taken=set()):
506
        self.names_taken = names_taken
507
        self.owner = owner
508

509 510
        self.error_label = None
        self.label_counter = 0
Robert Bradshaw's avatar
Robert Bradshaw committed
511
        self.labels_used = set()
512 513 514 515
        self.return_label = self.new_label()
        self.new_error_label()
        self.continue_label = None
        self.break_label = None
516
        self.yield_labels = []
517

518 519
        self.in_try_finally = 0
        self.exc_vars = None
520
        self.can_trace = False
521

522
        self.temps_allocated = [] # of (name, type, manage_ref, static)
523 524
        self.temps_free = {} # (type, manage_ref) -> list of free vars with same type/managed status
        self.temps_used_type = {} # name -> (type, manage_ref)
525
        self.temp_counter = 0
526
        self.closure_temps = None
527

528 529 530 531
        # This is used to collect temporaries, useful to find out which temps
        # need to be privatized in parallel sections
        self.collect_temps_stack = []

532 533 534 535 536
        # This is used for the error indicator, which needs to be local to the
        # function. It used to be global, which relies on the GIL being held.
        # However, exceptions may need to be propagated through 'nogil'
        # sections, in which case we introduce a race condition.
        self.should_declare_error_indicator = False
537
        self.uses_error_indicator = False
538

539 540
    # labels

541
    def new_label(self, name=None):
542 543
        n = self.label_counter
        self.label_counter = n + 1
544 545 546 547
        label = "%s%d" % (Naming.label_prefix, n)
        if name is not None:
            label += '_' + name
        return label
548

549 550 551 552 553 554
    def new_yield_label(self):
        label = self.new_label('resume_from_yield')
        num_and_label = (len(self.yield_labels) + 1, label)
        self.yield_labels.append(num_and_label)
        return num_and_label

555 556
    def new_error_label(self):
        old_err_lbl = self.error_label
557
        self.error_label = self.new_label('error')
558
        return old_err_lbl
559

560 561 562 563
    def get_loop_labels(self):
        return (
            self.continue_label,
            self.break_label)
564

565 566 567
    def set_loop_labels(self, labels):
        (self.continue_label,
         self.break_label) = labels
568

569 570 571
    def new_loop_labels(self):
        old_labels = self.get_loop_labels()
        self.set_loop_labels(
572
            (self.new_label("continue"),
Robert Bradshaw's avatar
Robert Bradshaw committed
573
             self.new_label("break")))
574
        return old_labels
575

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
    def get_all_labels(self):
        return (
            self.continue_label,
            self.break_label,
            self.return_label,
            self.error_label)

    def set_all_labels(self, labels):
        (self.continue_label,
         self.break_label,
         self.return_label,
         self.error_label) = labels

    def all_new_labels(self):
        old_labels = self.get_all_labels()
        new_labels = []
592
        for old_label, name in zip(old_labels, ['continue', 'break', 'return', 'error']):
593
            if old_label:
594
                new_labels.append(self.new_label(name))
595 596 597 598
            else:
                new_labels.append(old_label)
        self.set_all_labels(new_labels)
        return old_labels
599

600
    def use_label(self, lbl):
Stefan Behnel's avatar
Stefan Behnel committed
601
        self.labels_used.add(lbl)
602

603 604 605
    def label_used(self, lbl):
        return lbl in self.labels_used

606 607
    # temp handling

608
    def allocate_temp(self, type, manage_ref, static=False):
609 610 611 612 613
        """
        Allocates a temporary (which may create a new one or get a previously
        allocated and released one of the same type). Type is simply registered
        and handed back, but will usually be a PyrexType.

614 615 616 617 618
        If type.is_pyobject, manage_ref comes into play. If manage_ref is set to
        True, the temp will be decref-ed on return statements and in exception
        handling clauses. Otherwise the caller has to deal with any reference
        counting of the variable.

619 620 621 622
        If not type.is_pyobject, then manage_ref will be ignored, but it
        still has to be passed. It is recommended to pass False by convention
        if it is known that type will never be a Python object.

623 624 625 626
        static=True marks the temporary declaration with "static".
        This is only used when allocating backing store for a module-level
        C array literals.

627 628
        A C string referring to the variable is returned.
        """
629 630
        if type.is_const:
            type = type.const_base_type
631
        if not type.is_pyobject and not type.is_memoryviewslice:
632 633 634
            # Make manage_ref canonical, so that manage_ref will always mean
            # a decref is needed.
            manage_ref = False
635

636
        freelist = self.temps_free.get((type, manage_ref))
637
        if freelist is not None and len(freelist) > 0:
638
            result = freelist.pop()
639
        else:
640 641 642 643
            while True:
                self.temp_counter += 1
                result = "%s%d" % (Naming.codewriter_temp_prefix, self.temp_counter)
                if not result in self.names_taken: break
644
            self.temps_allocated.append((result, type, manage_ref, static))
645
        self.temps_used_type[result] = (type, manage_ref)
646
        if DebugFlags.debug_temp_code_comments:
647
            self.owner.putln("/* %s allocated (%s) */" % (result, type))
648 649 650 651

        if self.collect_temps_stack:
            self.collect_temps_stack[-1].add((result, type))

652 653 654 655 656 657 658
        return result

    def release_temp(self, name):
        """
        Releases a temporary so that it can be reused by other code needing
        a temp of the same type.
        """
659 660
        type, manage_ref = self.temps_used_type[name]
        freelist = self.temps_free.get((type, manage_ref))
661 662
        if freelist is None:
            freelist = []
663
            self.temps_free[(type, manage_ref)] = freelist
664 665
        if name in freelist:
            raise RuntimeError("Temp %s freed twice!" % name)
666
        freelist.append(name)
667 668
        if DebugFlags.debug_temp_code_comments:
            self.owner.putln("/* %s released */" % name)
669

670
    def temps_in_use(self):
671
        """Return a list of (cname,type,manage_ref) tuples of temp names and their type
672 673 674
        that are currently in use.
        """
        used = []
675
        for name, type, manage_ref, static in self.temps_allocated:
676
            freelist = self.temps_free.get((type, manage_ref))
677
            if freelist is None or name not in freelist:
678
                used.append((name, type, manage_ref and type.is_pyobject))
679 680
        return used

681
    def temps_holding_reference(self):
682
        """Return a list of (cname,type) tuples of temp names and their type
683 684
        that are currently in use. This includes only temps of a
        Python object type which owns its reference.
685 686
        """
        return [(name, type)
687
                for name, type, manage_ref in self.temps_in_use()
688
                if manage_ref  and type.is_pyobject]
689 690 691 692 693

    def all_managed_temps(self):
        """Return a list of (cname, type) tuples of refcount-managed Python objects.
        """
        return [(cname, type)
694
                    for cname, type, manage_ref, static in self.temps_allocated
695
                        if manage_ref]
696

697 698 699 700 701 702 703
    def all_free_managed_temps(self):
        """Return a list of (cname, type) tuples of refcount-managed Python
        objects that are not currently in use.  This is used by
        try-except and try-finally blocks to clean up temps in the
        error case.
        """
        return [(cname, type)
704 705 706
                    for (type, manage_ref), freelist in self.temps_free.items()
                        if manage_ref
                            for cname in freelist]
707

708 709 710 711
    def start_collecting_temps(self):
        """
        Useful to find out which temps were used in a code block
        """
Robert Bradshaw's avatar
Robert Bradshaw committed
712
        self.collect_temps_stack.append(set())
713 714 715

    def stop_collecting_temps(self):
        return self.collect_temps_stack.pop()
716

717 718 719
    def init_closure_temps(self, scope):
        self.closure_temps = ClosureTempAllocator(scope)

720

Stefan Behnel's avatar
Stefan Behnel committed
721 722 723 724 725 726 727
class NumConst(object):
    """Global info about a Python number constant held by GlobalState.

    cname       string
    value       string
    py_type     string     int, long, float
    value_code  string     evaluation code if different from value
728 729
    """

Stefan Behnel's avatar
Stefan Behnel committed
730
    def __init__(self, cname, value, py_type, value_code=None):
731 732
        self.cname = cname
        self.value = value
Stefan Behnel's avatar
Stefan Behnel committed
733 734 735
        self.py_type = py_type
        self.value_code = value_code or value

736

737 738 739 740 741 742 743 744 745 746
class PyObjectConst(object):
    """Global info about a generic constant held by GlobalState.
    """
    # cname       string
    # type        PyrexType

    def __init__(self, cname, type):
        self.cname = cname
        self.type = type

Stefan Behnel's avatar
Stefan Behnel committed
747

748
cython.declare(possible_unicode_identifier=object, possible_bytes_identifier=object,
749
               replace_identifier=object, find_alphanums=object)
Stefan Behnel's avatar
Stefan Behnel committed
750 751
possible_unicode_identifier = re.compile(ur"(?![0-9])\w+$", re.U).match
possible_bytes_identifier = re.compile(r"(?![0-9])\w+$".encode('ASCII')).match
752
replace_identifier = re.compile(r'[^a-zA-Z0-9_]+').sub
753
find_alphanums = re.compile('([a-zA-Z0-9]+)').findall
754 755 756 757 758 759 760 761 762 763 764 765 766

class StringConst(object):
    """Global info about a C string constant held by GlobalState.
    """
    # cname            string
    # text             EncodedString or BytesLiteral
    # py_strings       {(identifier, encoding) : PyStringConst}

    def __init__(self, cname, text, byte_string):
        self.cname = cname
        self.text = text
        self.escaped_value = StringEncoding.escape_byte_string(byte_string)
        self.py_strings = None
767 768 769
        self.py_versions = []

    def add_py_version(self, version):
770 771 772
        if not version:
            self.py_versions = [2,3]
        elif version not in self.py_versions:
773
            self.py_versions.append(version)
774

775 776
    def get_py_string_const(self, encoding, identifier=None,
                            is_str=False, py3str_cstring=None):
777 778 779
        py_strings = self.py_strings
        text = self.text

Stefan Behnel's avatar
Stefan Behnel committed
780
        is_str = bool(identifier or is_str)
781
        is_unicode = encoding is None and not is_str
782

783 784 785 786 787 788 789 790 791 792 793 794
        if encoding is None:
            # unicode string
            encoding_key = None
        else:
            # bytes or str
            encoding = encoding.lower()
            if encoding in ('utf8', 'utf-8', 'ascii', 'usascii', 'us-ascii'):
                encoding = None
                encoding_key = None
            else:
                encoding_key = ''.join(find_alphanums(encoding))

795 796 797 798 799 800
        key = (is_str, is_unicode, encoding_key, py3str_cstring)
        if py_strings is not None:
            try:
                return py_strings[key]
            except KeyError:
                pass
801
        else:
802
            self.py_strings = {}
803

804 805 806 807 808 809 810 811 812 813
        if identifier:
            intern = True
        elif identifier is None:
            if isinstance(text, unicode):
                intern = bool(possible_unicode_identifier(text))
            else:
                intern = bool(possible_bytes_identifier(text))
        else:
            intern = False
        if intern:
814
            prefix = Naming.interned_prefixes['str']
815 816
        else:
            prefix = Naming.py_const_prefix
817 818 819 820 821 822 823

        if encoding_key:
            encoding_prefix = '_%s' % encoding_key
        else:
            encoding_prefix = ''

        pystring_cname = "%s%s%s_%s" % (
824 825
            prefix,
            (is_str and 's') or (is_unicode and 'u') or 'b',
826
            encoding_prefix,
827 828 829 830 831
            self.cname[len(Naming.const_prefix):])

        py_string = PyStringConst(
            pystring_cname, encoding, is_unicode, is_str, py3str_cstring, intern)
        self.py_strings[key] = py_string
832 833 834 835 836 837
        return py_string

class PyStringConst(object):
    """Global info about a Python string constant held by GlobalState.
    """
    # cname       string
838
    # py3str_cstring string
839
    # encoding    string
840
    # intern      boolean
841 842
    # is_unicode  boolean
    # is_str      boolean
843

844 845
    def __init__(self, cname, encoding, is_unicode, is_str=False,
                 py3str_cstring=None, intern=False):
846
        self.cname = cname
847
        self.py3str_cstring = py3str_cstring
848 849 850
        self.encoding = encoding
        self.is_str = is_str
        self.is_unicode = is_unicode
851 852
        self.intern = intern

Stefan Behnel's avatar
Stefan Behnel committed
853 854 855
    def __lt__(self, other):
        return self.cname < other.cname

856

857 858 859 860 861 862
class GlobalState(object):
    # filename_table   {string : int}  for finding filename table indexes
    # filename_list    [string]        filenames in filename table order
    # input_file_contents dict         contents (=list of lines) of any file that was used as input
    #                                  to create this output C code.  This is
    #                                  used to annotate the comments.
863
    #
864
    # utility_codes   set                IDs of used utility code (to avoid reinsertion)
865 866 867 868 869 870
    #
    # declared_cnames  {string:Entry}  used in a transition phase to merge pxd-declared
    #                                  constants etc. into the pyx-declared ones (i.e,
    #                                  check if constants are already added).
    #                                  In time, hopefully the literals etc. will be
    #                                  supplied directly instead.
871
    #
872
    # const_cnames_used  dict          global counter for unique constant identifiers
873
    #
874

875 876
    # parts            {string:CCodeWriter}

877

878 879 880 881
    # interned_strings
    # consts
    # interned_nums

882 883 884 885 886 887
    # directives       set             Temporary variable used to track
    #                                  the current set of directives in the code generation
    #                                  process.

    directives = {}

888 889
    code_layout = [
        'h_code',
Robert Bradshaw's avatar
Robert Bradshaw committed
890
        'filename_table',
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
891
        'utility_code_proto_before_types',
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
892 893 894 895
        'numeric_typedefs',          # Let these detailed individual parts stay!,
        'complex_type_declarations', # as the proper solution is to make a full DAG...
        'type_declarations',         # More coarse-grained blocks would simply hide
        'utility_code_proto',        # the ugliness, not fix it
896 897
        'module_declarations',
        'typeinfo',
898 899
        'before_global_var',
        'global_var',
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
900
        'decls',
901
        'all_the_rest',
902 903
        'pystring_table',
        'cached_builtins',
904
        'cached_constants',
905 906 907 908 909
        'init_globals',
        'init_module',
        'cleanup_globals',
        'cleanup_module',
        'main_method',
910 911
        'utility_code_def',
        'end'
912
    ]
913

914

915
    def __init__(self, writer, module_node, emit_linenums=False, common_utility_include_dir=None):
916 917 918
        self.filename_table = {}
        self.filename_list = []
        self.input_file_contents = {}
Robert Bradshaw's avatar
Robert Bradshaw committed
919
        self.utility_codes = set()
920
        self.declared_cnames = {}
921
        self.in_utility_code_generation = False
922
        self.emit_linenums = emit_linenums
923
        self.common_utility_include_dir = common_utility_include_dir
924
        self.parts = {}
925 926
        self.module_node = module_node # because some utility code generation needs it
                                       # (generating backwards-compatible Get/ReleaseBuffer
927

928
        self.const_cnames_used = {}
929
        self.string_const_index = {}
Nikita Nemkin's avatar
Nikita Nemkin committed
930
        self.pyunicode_ptr_const_index = {}
Stefan Behnel's avatar
Stefan Behnel committed
931
        self.num_const_index = {}
932
        self.py_constants = []
933

934 935
        assert writer.globalstate is None
        writer.globalstate = self
936
        self.rootwriter = writer
937

938 939 940 941
    def initialize_main_c_code(self):
        rootwriter = self.rootwriter
        for part in self.code_layout:
            self.parts[part] = rootwriter.insertion_point()
942

943 944 945 946 947 948
        if not Options.cache_builtins:
            del self.parts['cached_builtins']
        else:
            w = self.parts['cached_builtins']
            w.enter_cfunc_scope()
            w.putln("static int __Pyx_InitCachedBuiltins(void) {")
949

950 951 952 953
        w = self.parts['cached_constants']
        w.enter_cfunc_scope()
        w.putln("")
        w.putln("static int __Pyx_InitCachedConstants(void) {")
954
        w.put_declare_refcount_context()
955 956
        w.put_setup_refcount_context("__Pyx_InitCachedConstants")

957 958 959 960
        w = self.parts['init_globals']
        w.enter_cfunc_scope()
        w.putln("")
        w.putln("static int __Pyx_InitGlobals(void) {")
961

962 963 964 965 966 967 968
        if not Options.generate_cleanup_code:
            del self.parts['cleanup_globals']
        else:
            w = self.parts['cleanup_globals']
            w.enter_cfunc_scope()
            w.putln("")
            w.putln("static void __Pyx_CleanupGlobals(void) {")
969

970 971 972 973
        code = self.parts['utility_code_proto']
        code.putln("")
        code.putln("/* --- Runtime support code (head) --- */")

974 975 976 977
        code = self.parts['utility_code_def']
        if self.emit_linenums:
            code.write('\n#line 1 "cython_utility"\n')
        code.putln("")
978
        code.putln("/* --- Runtime support code --- */")
979

980
    def finalize_main_c_code(self):
981 982 983 984 985 986
        self.close_global_decls()

        #
        # utility_code_def
        #
        code = self.parts['utility_code_def']
987
        code.put(UtilityCode.load_as_string("TypeConversions", "TypeConversion.c")[1])
988 989
        code.putln("")

990 991 992
    def __getitem__(self, key):
        return self.parts[key]

993 994 995
    #
    # Global constants, interned objects, etc.
    #
996 997
    def close_global_decls(self):
        # This is called when it is known that no more global declarations will
998
        # declared.
999
        self.generate_const_declarations()
1000
        if Options.cache_builtins:
1001
            w = self.parts['cached_builtins']
1002
            w.putln("return 0;")
1003 1004 1005
            if w.label_used(w.error_label):
                w.put_label(w.error_label)
                w.putln("return -1;")
1006 1007 1008
            w.putln("}")
            w.exit_cfunc_scope()

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
        w = self.parts['cached_constants']
        w.put_finish_refcount_context()
        w.putln("return 0;")
        if w.label_used(w.error_label):
            w.put_label(w.error_label)
            w.put_finish_refcount_context()
            w.putln("return -1;")
        w.putln("}")
        w.exit_cfunc_scope()

1019
        w = self.parts['init_globals']
1020
        w.putln("return 0;")
1021 1022 1023
        if w.label_used(w.error_label):
            w.put_label(w.error_label)
            w.putln("return -1;")
1024 1025
        w.putln("}")
        w.exit_cfunc_scope()
1026

1027 1028 1029 1030 1031
        if Options.generate_cleanup_code:
            w = self.parts['cleanup_globals']
            w.putln("}")
            w.exit_cfunc_scope()

1032 1033 1034 1035
        if Options.generate_cleanup_code:
            w = self.parts['cleanup_module']
            w.putln("}")
            w.exit_cfunc_scope()
1036

1037
    def put_pyobject_decl(self, entry):
1038
        self['global_var'].putln("static PyObject *%s;" % entry.cname)
1039

1040 1041
    # constant handling at code generation time

1042 1043 1044
    def get_cached_constants_writer(self):
        return self.parts['cached_constants']

1045
    def get_int_const(self, str_value, longness=False):
Stefan Behnel's avatar
Stefan Behnel committed
1046
        py_type = longness and 'long' or 'int'
1047
        try:
Stefan Behnel's avatar
Stefan Behnel committed
1048
            c = self.num_const_index[(str_value, py_type)]
1049
        except KeyError:
Stefan Behnel's avatar
Stefan Behnel committed
1050 1051 1052 1053 1054 1055 1056 1057
            c = self.new_num_const(str_value, py_type)
        return c

    def get_float_const(self, str_value, value_code):
        try:
            c = self.num_const_index[(str_value, 'float')]
        except KeyError:
            c = self.new_num_const(str_value, 'float', value_code)
1058 1059
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1060
    def get_py_const(self, type, prefix='', cleanup_level=None):
1061
        # create a new Python object constant
Stefan Behnel's avatar
Stefan Behnel committed
1062
        const = self.new_py_const(type, prefix)
1063
        if cleanup_level is not None \
Stefan Behnel's avatar
Stefan Behnel committed
1064
                and cleanup_level <= Options.generate_cleanup_code:
1065
            cleanup_writer = self.parts['cleanup_globals']
1066
            cleanup_writer.putln('Py_CLEAR(%s);' % const.cname)
1067
        return const
1068

1069
    def get_string_const(self, text, py_version=None):
1070 1071
        # return a C string constant, creating a new one if necessary
        if text.is_unicode:
1072
            byte_string = text.utf8encode()
1073 1074 1075 1076 1077 1078
        else:
            byte_string = text.byteencode()
        try:
            c = self.string_const_index[byte_string]
        except KeyError:
            c = self.new_string_const(text, byte_string)
1079
        c.add_py_version(py_version)
1080 1081
        return c

1082
    def get_pyunicode_ptr_const(self, text):
1083 1084 1085
        # return a Py_UNICODE[] constant, creating a new one if necessary
        assert text.is_unicode
        try:
Nikita Nemkin's avatar
Nikita Nemkin committed
1086
            c = self.pyunicode_ptr_const_index[text]
1087
        except KeyError:
Nikita Nemkin's avatar
Nikita Nemkin committed
1088
            c = self.pyunicode_ptr_const_index[text] = self.new_const_cname()
1089 1090
        return c

1091 1092
    def get_py_string_const(self, text, identifier=None,
                            is_str=False, unicode_value=None):
1093
        # return a Python string constant, creating a new one if necessary
1094 1095
        py3str_cstring = None
        if is_str and unicode_value is not None \
1096
               and unicode_value.utf8encode() != text.byteencode():
1097 1098 1099 1100
            py3str_cstring = self.get_string_const(unicode_value, py_version=3)
            c_string = self.get_string_const(text, py_version=2)
        else:
            c_string = self.get_string_const(text)
1101 1102
        py_string = c_string.get_py_string_const(
            text.encoding, identifier, is_str, py3str_cstring)
1103 1104
        return py_string

1105 1106 1107
    def get_interned_identifier(self, text):
        return self.get_py_string_const(text, identifier=True)

1108
    def new_string_const(self, text, byte_string):
Stefan Behnel's avatar
Stefan Behnel committed
1109
        cname = self.new_string_const_cname(byte_string)
1110 1111 1112 1113
        c = StringConst(cname, text, byte_string)
        self.string_const_index[byte_string] = c
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1114 1115 1116 1117
    def new_num_const(self, value, py_type, value_code=None):
        cname = self.new_num_const_cname(value, py_type)
        c = NumConst(cname, value, py_type, value_code)
        self.num_const_index[(value, py_type)] = c
1118 1119
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1120 1121
    def new_py_const(self, type, prefix=''):
        cname = self.new_const_cname(prefix)
1122 1123 1124 1125
        c = PyObjectConst(cname, type)
        self.py_constants.append(c)
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1126
    def new_string_const_cname(self, bytes_value):
1127
        # Create a new globally-unique nice name for a C string constant.
Stefan Behnel's avatar
Stefan Behnel committed
1128
        value = bytes_value.decode('ASCII', 'ignore')
1129
        return self.new_const_cname(value=value)
1130

Stefan Behnel's avatar
Stefan Behnel committed
1131 1132
    def new_num_const_cname(self, value, py_type):
        if py_type == 'long':
1133
            value += 'L'
1134 1135
            py_type = 'int'
        prefix = Naming.interned_prefixes[py_type]
Stefan Behnel's avatar
Stefan Behnel committed
1136
        cname = "%s%s" % (prefix, value)
1137
        cname = cname.replace('+', '_').replace('-', 'neg_').replace('.', '_')
1138 1139
        return cname

1140 1141
    def new_const_cname(self, prefix='', value=''):
        value = replace_identifier('_', value)[:32].strip('_')
1142 1143 1144
        used = self.const_cnames_used
        name_suffix = value
        while name_suffix in used:
1145
            counter = used[value] = used[value] + 1
1146
            name_suffix = '%s_%d' % (value, counter)
1147
        used[name_suffix] = 1
1148 1149 1150 1151 1152
        if prefix:
            prefix = Naming.interned_prefixes[prefix]
        else:
            prefix = Naming.const_prefix
        return "%s%s" % (prefix, name_suffix)
1153 1154

    def add_cached_builtin_decl(self, entry):
1155
        if entry.is_builtin and entry.is_const:
1156 1157
            if self.should_declare(entry.cname, entry):
                self.put_pyobject_decl(entry)
1158
                w = self.parts['cached_builtins']
1159 1160 1161 1162
                condition = None
                if entry.name in non_portable_builtins_map:
                    condition, replacement = non_portable_builtins_map[entry.name]
                    w.putln('#if %s' % condition)
1163
                    self.put_cached_builtin_init(
1164
                        entry.pos, StringEncoding.EncodedString(replacement),
1165
                        entry.cname)
1166 1167 1168 1169
                    w.putln('#else')
                self.put_cached_builtin_init(
                    entry.pos, StringEncoding.EncodedString(entry.name),
                    entry.cname)
1170
                if condition:
1171 1172 1173 1174 1175
                    w.putln('#endif')

    def put_cached_builtin_init(self, pos, name, cname):
        w = self.parts['cached_builtins']
        interned_cname = self.get_interned_identifier(name).cname
1176 1177 1178
        self.use_utility_code(
            UtilityCode.load_cached("GetBuiltinName", "ObjectHandling.c"))
        w.putln('%s = __Pyx_GetBuiltinName(%s); if (!%s) %s' % (
1179 1180 1181 1182
            cname,
            interned_cname,
            cname,
            w.error_goto(pos)))
1183 1184 1185

    def generate_const_declarations(self):
        self.generate_string_constants()
Stefan Behnel's avatar
Stefan Behnel committed
1186
        self.generate_num_constants()
1187 1188 1189 1190 1191 1192
        self.generate_object_constant_decls()

    def generate_object_constant_decls(self):
        consts = [ (len(c.cname), c.cname, c)
                   for c in self.py_constants ]
        consts.sort()
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1193
        decls_writer = self.parts['decls']
1194
        for _, cname, c in consts:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1195
            decls_writer.putln(
1196
                "static %s;" % c.type.declaration_code(cname))
1197 1198 1199

    def generate_string_constants(self):
        c_consts = [ (len(c.cname), c.cname, c)
Stefan Behnel's avatar
Stefan Behnel committed
1200
                     for c in self.string_const_index.values() ]
1201 1202
        c_consts.sort()
        py_strings = []
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1203 1204

        decls_writer = self.parts['decls']
1205
        for _, cname, c in c_consts:
1206 1207 1208 1209 1210
            conditional = False
            if c.py_versions and (2 not in c.py_versions or 3 not in c.py_versions):
                conditional = True
                decls_writer.putln("#if PY_MAJOR_VERSION %s 3" % (
                    (2 in c.py_versions) and '<' or '>='))
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1211
            decls_writer.putln('static char %s[] = "%s";' % (
1212
                cname, StringEncoding.split_string_literal(c.escaped_value)))
1213 1214
            if conditional:
                decls_writer.putln("#endif")
1215
            if c.py_strings is not None:
Stefan Behnel's avatar
Stefan Behnel committed
1216
                for py_string in c.py_strings.values():
1217 1218
                    py_strings.append((c.cname, len(py_string.cname), py_string))

Nikita Nemkin's avatar
Nikita Nemkin committed
1219
        for c, cname in self.pyunicode_ptr_const_index.items():
1220
            utf16_array, utf32_array = StringEncoding.encode_pyunicode_string(c)
1221 1222
            if utf16_array:
                # Narrow and wide representations differ
Nikita Nemkin's avatar
Nikita Nemkin committed
1223
                decls_writer.putln("#ifdef Py_UNICODE_WIDE")
1224 1225 1226 1227 1228
            decls_writer.putln("static Py_UNICODE %s[] = { %s };" % (cname, utf32_array))
            if utf16_array:
                decls_writer.putln("#else")
                decls_writer.putln("static Py_UNICODE %s[] = { %s };" % (cname, utf16_array))
                decls_writer.putln("#endif")
1229

1230
        if py_strings:
1231
            self.use_utility_code(UtilityCode.load_cached("InitStrings", "StringTools.c"))
1232
            py_strings.sort()
1233 1234 1235
            w = self.parts['pystring_table']
            w.putln("")
            w.putln("static __Pyx_StringTabEntry %s[] = {" %
1236 1237
                                      Naming.stringtab_cname)
            for c_cname, _, py_string in py_strings:
1238 1239 1240 1241 1242 1243 1244
                if not py_string.is_str or not py_string.encoding or \
                       py_string.encoding in ('ASCII', 'USASCII', 'US-ASCII',
                                              'UTF8', 'UTF-8'):
                    encoding = '0'
                else:
                    encoding = '"%s"' % py_string.encoding.lower()

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1245
                decls_writer.putln(
1246
                    "static PyObject *%s;" % py_string.cname)
1247 1248 1249 1250 1251 1252 1253
                if py_string.py3str_cstring:
                    w.putln("#if PY_MAJOR_VERSION >= 3")
                    w.putln(
                        "{&%s, %s, sizeof(%s), %s, %d, %d, %d}," % (
                        py_string.cname,
                        py_string.py3str_cstring.cname,
                        py_string.py3str_cstring.cname,
1254 1255
                        '0', 1, 0,
                        py_string.intern
1256 1257
                        ))
                    w.putln("#else")
1258
                w.putln(
1259
                    "{&%s, %s, sizeof(%s), %s, %d, %d, %d}," % (
1260 1261 1262
                    py_string.cname,
                    c_cname,
                    c_cname,
1263 1264 1265 1266
                    encoding,
                    py_string.is_unicode,
                    py_string.is_str,
                    py_string.intern
1267
                    ))
1268 1269
                if py_string.py3str_cstring:
                    w.putln("#endif")
1270
            w.putln("{0, 0, 0, 0, 0, 0, 0}")
1271
            w.putln("};")
1272

1273 1274
            init_globals = self.parts['init_globals']
            init_globals.putln(
1275 1276
                "if (__Pyx_InitStrings(%s) < 0) %s;" % (
                    Naming.stringtab_cname,
1277
                    init_globals.error_goto(self.module_pos)))
1278

Stefan Behnel's avatar
Stefan Behnel committed
1279
    def generate_num_constants(self):
1280
        consts = [(c.py_type, c.value[0] == '-', len(c.value), c.value, c.value_code, c)
Stefan Behnel's avatar
Stefan Behnel committed
1281
                  for c in self.num_const_index.values()]
1282
        consts.sort()
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1283
        decls_writer = self.parts['decls']
Stefan Behnel's avatar
Stefan Behnel committed
1284
        init_globals = self.parts['init_globals']
1285
        for py_type, _, _, value, value_code, c in consts:
1286
            cname = c.cname
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1287
            decls_writer.putln("static PyObject *%s;" % cname)
Stefan Behnel's avatar
Stefan Behnel committed
1288
            if py_type == 'float':
Stefan Behnel's avatar
Stefan Behnel committed
1289
                function = 'PyFloat_FromDouble(%s)'
Stefan Behnel's avatar
Stefan Behnel committed
1290
            elif py_type == 'long':
Stefan Behnel's avatar
Stefan Behnel committed
1291
                function = 'PyLong_FromString((char *)"%s", 0, 0)'
1292
            elif Utils.long_literal(value):
Stefan Behnel's avatar
Stefan Behnel committed
1293
                function = 'PyInt_FromString((char *)"%s", 0, 0)'
1294 1295
            elif len(value.lstrip('-')) > 4:
                function = "PyInt_FromLong(%sL)"
1296
            else:
Stefan Behnel's avatar
Stefan Behnel committed
1297 1298 1299
                function = "PyInt_FromLong(%s)"
            init_globals.putln('%s = %s; %s' % (
                cname, function % value_code,
1300
                init_globals.error_goto_if_null(cname, self.module_pos)))
1301

1302 1303 1304
    # The functions below are there in a transition phase only
    # and will be deprecated. They are called from Nodes.BlockNode.
    # The copy&paste duplication is intentional in order to be able
1305
    # to see quickly how BlockNode worked, until this is replaced.
1306

1307 1308 1309
    def should_declare(self, cname, entry):
        if cname in self.declared_cnames:
            other = self.declared_cnames[cname]
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1310
            assert str(entry.type) == str(other.type)
1311 1312 1313 1314 1315 1316 1317 1318 1319
            assert entry.init == other.init
            return False
        else:
            self.declared_cnames[cname] = entry
            return True

    #
    # File name state
    #
1320

1321
    def lookup_filename(self, source_desc):
1322
        try:
1323
            index = self.filename_table[source_desc.get_filenametable_entry()]
1324 1325
        except KeyError:
            index = len(self.filename_list)
1326 1327
            self.filename_list.append(source_desc)
            self.filename_table[source_desc.get_filenametable_entry()] = index
1328 1329 1330 1331 1332 1333
        return index

    def commented_file_contents(self, source_desc):
        try:
            return self.input_file_contents[source_desc]
        except KeyError:
1334 1335 1336 1337
            pass
        source_file = source_desc.get_lines(encoding='ASCII',
                                            error_handling='ignore')
        try:
1338 1339
            F = [u' * ' + line.rstrip().replace(
                    u'*/', u'*[inserted by cython to avoid comment closer]/'
1340 1341
                    ).replace(
                    u'/*', u'/[inserted by cython to avoid comment start]*'
1342
                    )
1343 1344 1345 1346 1347 1348 1349
                 for line in source_file]
        finally:
            if hasattr(source_file, 'close'):
                source_file.close()
        if not F: F.append(u'')
        self.input_file_contents[source_desc] = F
        return F
1350

1351 1352 1353
    #
    # Utility code state
    #
1354

1355
    def use_utility_code(self, utility_code):
1356
        """
1357 1358 1359 1360
        Adds code to the C file. utility_code should
        a) implement __eq__/__hash__ for the purpose of knowing whether the same
           code has already been included
        b) implement put_code, which takes a globalstate instance
1361

1362
        See UtilityCode.
1363
        """
1364 1365 1366
        if utility_code not in self.utility_codes:
            self.utility_codes.add(utility_code)
            utility_code.put_code(self)
1367

1368

1369
def funccontext_property(name):
1370
    attribute_of = operator.attrgetter(name)
1371
    def get(self):
1372
        return attribute_of(self.funcstate)
1373
    def set(self, value):
1374
        setattr(self.funcstate, name, value)
1375 1376
    return property(get, set)

1377

1378
class CCodeWriter(object):
1379
    """
1380
    Utility class to output C code.
1381

1382
    When creating an insertion point one must care about the state that is
1383
    kept:
1384 1385
    - formatting state (level, bol) is cloned and used in insertion points
      as well
1386 1387
    - labels, temps, exc_vars: One must construct a scope in which these can
      exist by calling enter_cfunc_scope/exit_cfunc_scope (these are for
1388 1389 1390 1391 1392
      sanity checking and forward compatabilty). Created insertion points
      looses this scope and cannot access it.
    - marker: Not copied to insertion point
    - filename_table, filename_list, input_file_contents: All codewriters
      coming from the same root share the same instances simultaneously.
1393
    """
1394

1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
    # f                   file            output file
    # buffer              StringIOTree

    # level               int             indentation level
    # bol                 bool            beginning of line?
    # marker              string          comment to emit before next line
    # funcstate           FunctionState   contains state local to a C function used for code
    #                                     generation (labels and temps state etc.)
    # globalstate         GlobalState     contains state global for a C file (input file info,
    #                                     utility code, declared constants etc.)
    # emit_linenums       boolean         whether or not to write #line pragmas
1406
    #
1407 1408 1409 1410
    # c_line_in_traceback boolean         append the c file and line number to the traceback for exceptions
    #
    # pyclass_stack       list            used during recursive code generation to pass information
    #                                     about the current class one is in
1411

1412
    globalstate = None
1413

1414
    def __init__(self, create_from=None, buffer=None, copy_formatting=False, emit_linenums=None, c_line_in_traceback=True):
1415 1416
        if buffer is None: buffer = StringIOTree()
        self.buffer = buffer
1417 1418
        self.marker = None
        self.last_marker_line = 0
1419
        self.source_desc = ""
1420
        self.pyclass_stack = []
1421

1422 1423
        self.funcstate = None
        self.level = 0
Robert Bradshaw's avatar
Robert Bradshaw committed
1424
        self.call_level = 0
1425
        self.bol = 1
1426 1427

        if create_from is not None:
1428 1429
            # Use same global state
            self.globalstate = create_from.globalstate
1430
            self.funcstate = create_from.funcstate
1431
            # Clone formatting state
1432 1433 1434
            if copy_formatting:
                self.level = create_from.level
                self.bol = create_from.bol
Robert Bradshaw's avatar
Robert Bradshaw committed
1435
                self.call_level = create_from.call_level
1436

1437
        if emit_linenums is None and self.globalstate:
1438 1439 1440
            self.emit_linenums = self.globalstate.emit_linenums
        else:
            self.emit_linenums = emit_linenums
1441
        self.c_line_in_traceback = c_line_in_traceback
1442

1443
    def create_new(self, create_from, buffer, copy_formatting):
1444 1445
        # polymorphic constructor -- very slightly more versatile
        # than using __class__
1446 1447
        result = CCodeWriter(create_from, buffer, copy_formatting,
                             c_line_in_traceback=self.c_line_in_traceback)
1448
        return result
1449 1450 1451 1452

    def copyto(self, f):
        self.buffer.copyto(f)

1453 1454 1455 1456
    def getvalue(self):
        return self.buffer.getvalue()

    def write(self, s):
1457
        # also put invalid markers (lineno 0), to indicate that those lines
Mark Florisson's avatar
Mark Florisson committed
1458 1459 1460 1461 1462
        # have no Cython source code correspondence
        if self.marker is None:
            cython_lineno = self.last_marker_line
        else:
            cython_lineno = self.marker[0]
1463

Mark Florisson's avatar
Mark Florisson committed
1464
        self.buffer.markers.extend([cython_lineno] * s.count('\n'))
1465
        self.buffer.write(s)
1466 1467

    def insertion_point(self):
1468
        other = self.create_new(create_from=self, buffer=self.buffer.insertion_point(), copy_formatting=True)
1469 1470
        return other

1471 1472 1473 1474 1475
    def new_writer(self):
        """
        Creates a new CCodeWriter connected to the same global state, which
        can later be inserted using insert.
        """
1476
        return CCodeWriter(create_from=self, c_line_in_traceback=self.c_line_in_traceback)
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486

    def insert(self, writer):
        """
        Inserts the contents of another code writer (created with
        the same global state) in the current location.

        It is ok to write to the inserted writer also after insertion.
        """
        assert writer.globalstate is self.globalstate
        self.buffer.insert(writer.buffer)
1487 1488 1489 1490 1491 1492 1493 1494

    # Properties delegated to function scope
    label_counter = funccontext_property("label_counter")
    return_label = funccontext_property("return_label")
    error_label = funccontext_property("error_label")
    labels_used = funccontext_property("labels_used")
    continue_label = funccontext_property("continue_label")
    break_label = funccontext_property("break_label")
1495
    return_from_error_cleanup_label = funccontext_property("return_from_error_cleanup_label")
1496
    yield_labels = funccontext_property("yield_labels")
1497 1498

    # Functions delegated to function scope
Dag Sverre Seljebotn's avatar
merge  
Dag Sverre Seljebotn committed
1499
    def new_label(self, name=None):    return self.funcstate.new_label(name)
1500
    def new_error_label(self):         return self.funcstate.new_error_label()
1501
    def new_yield_label(self):         return self.funcstate.new_yield_label()
1502 1503 1504 1505 1506 1507 1508 1509
    def get_loop_labels(self):         return self.funcstate.get_loop_labels()
    def set_loop_labels(self, labels): return self.funcstate.set_loop_labels(labels)
    def new_loop_labels(self):         return self.funcstate.new_loop_labels()
    def get_all_labels(self):          return self.funcstate.get_all_labels()
    def set_all_labels(self, labels):  return self.funcstate.set_all_labels(labels)
    def all_new_labels(self):          return self.funcstate.all_new_labels()
    def use_label(self, lbl):          return self.funcstate.use_label(lbl)
    def label_used(self, lbl):         return self.funcstate.label_used(lbl)
1510 1511


1512
    def enter_cfunc_scope(self):
1513
        self.funcstate = FunctionState(self)
1514

1515
    def exit_cfunc_scope(self):
1516
        self.funcstate = None
1517

1518 1519
    # constant handling

Stefan Behnel's avatar
Stefan Behnel committed
1520
    def get_py_int(self, str_value, longness):
1521 1522
        return self.globalstate.get_int_const(str_value, longness).cname

Stefan Behnel's avatar
Stefan Behnel committed
1523 1524 1525
    def get_py_float(self, str_value, value_code):
        return self.globalstate.get_float_const(str_value, value_code).cname

1526 1527
    def get_py_const(self, type, prefix='', cleanup_level=None):
        return self.globalstate.get_py_const(type, prefix, cleanup_level).cname
1528

1529 1530 1531
    def get_string_const(self, text):
        return self.globalstate.get_string_const(text).cname

1532 1533
    def get_pyunicode_ptr_const(self, text):
        return self.globalstate.get_pyunicode_ptr_const(text)
1534

1535 1536 1537 1538
    def get_py_string_const(self, text, identifier=None,
                            is_str=False, unicode_value=None):
        return self.globalstate.get_py_string_const(
            text, identifier, is_str, unicode_value).cname
1539

1540 1541 1542
    def get_argument_default_const(self, type):
        return self.globalstate.get_py_const(type).cname

1543 1544 1545 1546
    def intern(self, text):
        return self.get_py_string_const(text)

    def intern_identifier(self, text):
1547
        return self.get_py_string_const(text, identifier=True)
1548

1549 1550 1551
    def get_cached_constants_writer(self):
        return self.globalstate.get_cached_constants_writer()

1552 1553
    # code generation

Stefan Behnel's avatar
Stefan Behnel committed
1554
    def putln(self, code="", safe=False):
William Stein's avatar
William Stein committed
1555 1556
        if self.marker and self.bol:
            self.emit_marker()
1557 1558
        if self.emit_linenums and self.last_marker_line != 0:
            self.write('\n#line %s "%s"\n' % (self.last_marker_line, self.source_desc))
1559

William Stein's avatar
William Stein committed
1560
        if code:
1561 1562 1563 1564
            if safe:
                self.put_safe(code)
            else:
                self.put(code)
1565
        self.write("\n")
William Stein's avatar
William Stein committed
1566
        self.bol = 1
1567

William Stein's avatar
William Stein committed
1568
    def emit_marker(self):
1569
        self.write("\n")
William Stein's avatar
William Stein committed
1570
        self.indent()
1571
        self.write("/* %s */\n" % self.marker[1])
1572 1573
        if (self.funcstate and self.funcstate.can_trace
                and self.globalstate.directives['linetrace']):
1574 1575
            self.indent()
            self.write('__Pyx_TraceLine(%d)\n' % self.marker[0])
1576
        self.last_marker_line = self.marker[0]
William Stein's avatar
William Stein committed
1577 1578
        self.marker = None

1579 1580 1581 1582 1583
    def put_safe(self, code):
        # put code, but ignore {}
        self.write(code)
        self.bol = 0

1584
    def put_or_include(self, code, name):
Stefan Behnel's avatar
Stefan Behnel committed
1585
        include_dir = self.globalstate.common_utility_include_dir
1586
        if include_dir and len(code) > 1024:
Stefan Behnel's avatar
Stefan Behnel committed
1587
            include_file = "%s_%s.h" % (
1588
                name, hashlib.md5(code.encode('utf8')).hexdigest())
Stefan Behnel's avatar
Stefan Behnel committed
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
            path = os.path.join(include_dir, include_file)
            if not os.path.exists(path):
                tmp_path = '%s.tmp%s' % (path, os.getpid())
                f = Utils.open_new_file(tmp_path)
                try:
                    f.write(code)
                finally:
                    f.close()
                os.rename(tmp_path, path)
            code = '#include "%s"\n' % path
        self.put(code)
1600

William Stein's avatar
William Stein committed
1601
    def put(self, code):
1602 1603
        if is_self_assignment(code):
            return
1604
        fix_indent = False
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
        if "{" in code:
            dl = code.count("{")
        else:
            dl = 0
        if "}" in code:
            dl -= code.count("}")
            if dl < 0:
                self.level += dl
            elif dl == 0 and code[0] == "}":
                # special cases like "} else {" need a temporary dedent
                fix_indent = True
                self.level -= 1
William Stein's avatar
William Stein committed
1617 1618
        if self.bol:
            self.indent()
1619
        self.write(code)
William Stein's avatar
William Stein committed
1620 1621 1622
        self.bol = 0
        if dl > 0:
            self.level += dl
1623
        elif fix_indent:
1624 1625
            self.level += 1

Mark Florisson's avatar
Mark Florisson committed
1626
    def putln_tempita(self, code, **context):
1627
        from ..Tempita import sub
1628
        self.putln(sub(code, **context))
Mark Florisson's avatar
Mark Florisson committed
1629 1630

    def put_tempita(self, code, **context):
1631
        from ..Tempita import sub
1632
        self.put(sub(code, **context))
Mark Florisson's avatar
Mark Florisson committed
1633

William Stein's avatar
William Stein committed
1634
    def increase_indent(self):
Stefan Behnel's avatar
Stefan Behnel committed
1635
        self.level += 1
1636

William Stein's avatar
William Stein committed
1637
    def decrease_indent(self):
Stefan Behnel's avatar
Stefan Behnel committed
1638
        self.level -= 1
1639

William Stein's avatar
William Stein committed
1640 1641 1642
    def begin_block(self):
        self.putln("{")
        self.increase_indent()
1643

William Stein's avatar
William Stein committed
1644 1645 1646
    def end_block(self):
        self.decrease_indent()
        self.putln("}")
1647

William Stein's avatar
William Stein committed
1648
    def indent(self):
1649
        self.write("  " * self.level)
1650

1651 1652 1653
    def get_py_version_hex(self, pyversion):
        return "0x%02X%02X%02X%02X" % (tuple(pyversion) + (0,0,0,0))[:4]

William Stein's avatar
William Stein committed
1654
    def mark_pos(self, pos):
Robert Bradshaw's avatar
Robert Bradshaw committed
1655 1656
        if pos is None:
            return
1657
        source_desc, line, col = pos
1658 1659
        if self.last_marker_line == line:
            return
1660
        assert isinstance(source_desc, SourceDescriptor)
1661
        contents = self.globalstate.commented_file_contents(source_desc)
Stefan Behnel's avatar
Stefan Behnel committed
1662
        lines = contents[max(0, line-3):line]  # line numbers start at 1
1663 1664
        lines[-1] += u'             # <<<<<<<<<<<<<<'
        lines += contents[line:line+2]
1665

1666 1667
        marker = u'"%s":%d\n%s\n' % (
            source_desc.get_escaped_description(), line, u'\n'.join(lines))
1668
        self.marker = (line, marker)
1669 1670
        if self.emit_linenums:
            self.source_desc = source_desc.get_escaped_description()
1671

William Stein's avatar
William Stein committed
1672
    def put_label(self, lbl):
1673
        if lbl in self.funcstate.labels_used:
1674
            self.putln("%s:;" % lbl)
1675

1676
    def put_goto(self, lbl):
1677
        self.funcstate.use_label(lbl)
1678
        self.putln("goto %s;" % lbl)
1679

1680
    def put_var_declaration(self, entry, storage_class="",
Stefan Behnel's avatar
Stefan Behnel committed
1681
                            dll_linkage=None, definition=True):
1682
        #print "Code.put_var_declaration:", entry.name, "definition =", definition ###
1683 1684
        if entry.visibility == 'private' and not (definition or entry.defined_in_pxd):
            #print "...private and not definition, skipping", entry.cname ###
1685
            return
1686 1687
        if entry.visibility == "private" and not entry.used:
            #print "...private and not used, skipping", entry.cname ###
William Stein's avatar
William Stein committed
1688 1689 1690
            return
        if storage_class:
            self.put("%s " % storage_class)
1691 1692
        if not entry.cf_used:
            self.put('CYTHON_UNUSED ')
1693
        self.put(entry.type.declaration_code(
Stefan Behnel's avatar
Stefan Behnel committed
1694
            entry.cname, dll_linkage=dll_linkage))
William Stein's avatar
William Stein committed
1695
        if entry.init is not None:
1696
            self.put_safe(" = %s" % entry.type.literal_code(entry.init))
1697
        elif entry.type.is_pyobject:
Stefan Behnel's avatar
Stefan Behnel committed
1698
            self.put(" = NULL")
William Stein's avatar
William Stein committed
1699
        self.putln(";")
1700 1701

    def put_temp_declarations(self, func_context):
1702
        for name, type, manage_ref, static in func_context.temps_allocated:
1703 1704 1705
            decl = type.declaration_code(name)
            if type.is_pyobject:
                self.putln("%s = NULL;" % decl)
1706
            elif type.is_memoryviewslice:
1707
                from . import MemoryView
Mark Florisson's avatar
Mark Florisson committed
1708
                self.putln("%s = %s;" % (decl, MemoryView.memslice_entry_init))
1709
            else:
1710
                self.putln("%s%s;" % (static and "static " or "", decl))
1711

1712
        if func_context.should_declare_error_indicator:
1713 1714 1715 1716
            if self.funcstate.uses_error_indicator:
                unused = ''
            else:
                unused = 'CYTHON_UNUSED '
1717
            # Initialize these variables to silence compiler warnings
1718 1719 1720
            self.putln("%sint %s = 0;" % (unused, Naming.lineno_cname))
            self.putln("%sconst char *%s = NULL;" % (unused, Naming.filename_cname))
            self.putln("%sint %s = 0;" % (unused, Naming.clineno_cname))
1721

1722 1723 1724
    def put_h_guard(self, guard):
        self.putln("#ifndef %s" % guard)
        self.putln("#define %s" % guard)
1725

1726 1727 1728 1729 1730 1731
    def unlikely(self, cond):
        if Options.gcc_branch_hints:
            return 'unlikely(%s)' % cond
        else:
            return cond

1732 1733 1734 1735 1736
    def build_function_modifiers(self, modifiers, mapper=modifier_output_mapper):
        if not modifiers:
            return ''
        return '%s ' % ' '.join([mapper(m,m) for m in modifiers])

1737 1738
    # Python objects and reference counting

William Stein's avatar
William Stein committed
1739 1740
    def entry_as_pyobject(self, entry):
        type = entry.type
1741 1742
        if (not entry.is_self_arg and not entry.type.is_complete()
            or entry.type.is_extension_type):
William Stein's avatar
William Stein committed
1743 1744 1745
            return "(PyObject *)" + entry.cname
        else:
            return entry.cname
1746

William Stein's avatar
William Stein committed
1747
    def as_pyobject(self, cname, type):
1748
        from .PyrexTypes import py_object_type, typecast
William Stein's avatar
William Stein committed
1749
        return typecast(py_object_type, type, cname)
1750

1751
    def put_gotref(self, cname):
1752
        self.putln("__Pyx_GOTREF(%s);" % cname)
1753

1754 1755
    def put_giveref(self, cname):
        self.putln("__Pyx_GIVEREF(%s);" % cname)
1756

1757 1758 1759
    def put_xgiveref(self, cname):
        self.putln("__Pyx_XGIVEREF(%s);" % cname)

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1760 1761 1762
    def put_xgotref(self, cname):
        self.putln("__Pyx_XGOTREF(%s);" % cname)

1763 1764 1765 1766 1767
    def put_incref(self, cname, type, nanny=True):
        if nanny:
            self.putln("__Pyx_INCREF(%s);" % self.as_pyobject(cname, type))
        else:
            self.putln("Py_INCREF(%s);" % self.as_pyobject(cname, type))
1768

1769
    def put_decref(self, cname, type, nanny=True):
1770
        self._put_decref(cname, type, nanny, null_check=False, clear=False)
1771 1772 1773 1774

    def put_var_gotref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_GOTREF(%s);" % self.entry_as_pyobject(entry))
1775

1776 1777 1778 1779
    def put_var_giveref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_GIVEREF(%s);" % self.entry_as_pyobject(entry))

1780 1781 1782 1783
    def put_var_xgotref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_XGOTREF(%s);" % self.entry_as_pyobject(entry))

1784 1785 1786 1787
    def put_var_xgiveref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_XGIVEREF(%s);" % self.entry_as_pyobject(entry))

William Stein's avatar
William Stein committed
1788 1789
    def put_var_incref(self, entry):
        if entry.type.is_pyobject:
1790
            self.putln("__Pyx_INCREF(%s);" % self.entry_as_pyobject(entry))
1791

1792 1793 1794
    def put_decref_clear(self, cname, type, nanny=True, clear_before_decref=False):
        self._put_decref(cname, type, nanny, null_check=False,
                         clear=True, clear_before_decref=clear_before_decref)
1795

1796
    def put_xdecref(self, cname, type, nanny=True, have_gil=True):
1797 1798
        self._put_decref(cname, type, nanny, null_check=True,
                         have_gil=have_gil, clear=False)
1799

1800 1801 1802
    def put_xdecref_clear(self, cname, type, nanny=True, clear_before_decref=False):
        self._put_decref(cname, type, nanny, null_check=True,
                         clear=True, clear_before_decref=clear_before_decref)
1803

1804 1805
    def _put_decref(self, cname, type, nanny=True, null_check=False,
                    have_gil=True, clear=False, clear_before_decref=False):
1806
        if type.is_memoryviewslice:
1807
            self.put_xdecref_memoryviewslice(cname, have_gil=have_gil)
1808 1809
            return

1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
        prefix = nanny and '__Pyx' or 'Py'
        X = null_check and 'X' or ''

        if clear:
            if clear_before_decref:
                if not nanny:
                    X = ''  # CPython doesn't have a Py_XCLEAR()
                self.putln("%s_%sCLEAR(%s);" % (prefix, X, cname))
            else:
                self.putln("%s_%sDECREF(%s); %s = 0;" % (
                    prefix, X, self.as_pyobject(cname, type), cname))
1821
        else:
1822 1823
            self.putln("%s_%sDECREF(%s);" % (
                prefix, X, self.as_pyobject(cname, type)))
William Stein's avatar
William Stein committed
1824

1825 1826 1827 1828 1829 1830
    def put_decref_set(self, cname, rhs_cname):
        self.putln("__Pyx_DECREF_SET(%s, %s);" % (cname, rhs_cname))

    def put_xdecref_set(self, cname, rhs_cname):
        self.putln("__Pyx_XDECREF_SET(%s, %s);" % (cname, rhs_cname))

William Stein's avatar
William Stein committed
1831 1832
    def put_var_decref(self, entry):
        if entry.type.is_pyobject:
1833
            self.putln("__Pyx_XDECREF(%s);" % self.entry_as_pyobject(entry))
1834

William Stein's avatar
William Stein committed
1835 1836
    def put_var_xdecref(self, entry):
        if entry.type.is_pyobject:
1837
            self.putln("__Pyx_XDECREF(%s);" % self.entry_as_pyobject(entry))
1838

1839 1840 1841
    def put_var_decref_clear(self, entry):
        self._put_var_decref_clear(entry, null_check=False)

William Stein's avatar
William Stein committed
1842
    def put_var_xdecref_clear(self, entry):
1843 1844 1845
        self._put_var_decref_clear(entry, null_check=True)

    def _put_var_decref_clear(self, entry, null_check):
William Stein's avatar
William Stein committed
1846
        if entry.type.is_pyobject:
1847 1848 1849 1850 1851 1852 1853 1854 1855
            if entry.in_closure:
                # reset before DECREF to make sure closure state is
                # consistent during call to DECREF()
                self.putln("__Pyx_%sCLEAR(%s);" % (
                    null_check and 'X' or '',
                    entry.cname))
            else:
                self.putln("__Pyx_%sDECREF(%s); %s = 0;" % (
                    null_check and 'X' or '',
1856
                    self.entry_as_pyobject(entry),
1857
                    entry.cname))
1858

1859
    def put_var_decrefs(self, entries, used_only = 0):
William Stein's avatar
William Stein committed
1860
        for entry in entries:
1861 1862 1863 1864 1865
            if not used_only or entry.used:
                if entry.xdecref_cleanup:
                    self.put_var_xdecref(entry)
                else:
                    self.put_var_decref(entry)
1866

William Stein's avatar
William Stein committed
1867 1868 1869
    def put_var_xdecrefs(self, entries):
        for entry in entries:
            self.put_var_xdecref(entry)
1870

William Stein's avatar
William Stein committed
1871 1872 1873
    def put_var_xdecrefs_clear(self, entries):
        for entry in entries:
            self.put_var_xdecref_clear(entry)
1874

1875
    def put_incref_memoryviewslice(self, slice_cname, have_gil=False):
1876
        from . import MemoryView
Mark Florisson's avatar
Mark Florisson committed
1877
        self.globalstate.use_utility_code(MemoryView.memviewslice_init_code)
1878 1879 1880
        self.putln("__PYX_INC_MEMVIEW(&%s, %d);" % (slice_cname, int(have_gil)))

    def put_xdecref_memoryviewslice(self, slice_cname, have_gil=False):
1881
        from . import MemoryView
Mark Florisson's avatar
Mark Florisson committed
1882
        self.globalstate.use_utility_code(MemoryView.memviewslice_init_code)
1883 1884 1885 1886 1887
        self.putln("__PYX_XDEC_MEMVIEW(&%s, %d);" % (slice_cname, int(have_gil)))

    def put_xgiveref_memoryviewslice(self, slice_cname):
        self.put_xgiveref("%s.memview" % slice_cname)

1888
    def put_init_to_py_none(self, cname, type, nanny=True):
1889
        from .PyrexTypes import py_object_type, typecast
William Stein's avatar
William Stein committed
1890
        py_none = typecast(type, py_object_type, "Py_None")
1891 1892 1893 1894
        if nanny:
            self.putln("%s = %s; __Pyx_INCREF(Py_None);" % (cname, py_none))
        else:
            self.putln("%s = %s; Py_INCREF(Py_None);" % (cname, py_none))
1895

1896
    def put_init_var_to_py_none(self, entry, template = "%s", nanny=True):
William Stein's avatar
William Stein committed
1897 1898
        code = template % entry.cname
        #if entry.type.is_extension_type:
Robert Bradshaw's avatar
Robert Bradshaw committed
1899
        #    code = "((PyObject*)%s)" % code
1900
        self.put_init_to_py_none(code, entry.type, nanny)
1901
        if entry.in_closure:
Stefan Behnel's avatar
Stefan Behnel committed
1902
            self.put_giveref('Py_None')
William Stein's avatar
William Stein committed
1903

1904
    def put_pymethoddef(self, entry, term, allow_skip=True):
1905
        if entry.is_special or entry.name == '__getattribute__':
1906 1907 1908
            if entry.name not in ['__cinit__', '__dealloc__', '__richcmp__', '__next__', '__getreadbuffer__', '__getwritebuffer__', '__getsegcount__', '__getcharbuffer__', '__getbuffer__', '__releasebuffer__']:
                if entry.name == '__getattr__' and not self.globalstate.directives['fast_getattr']:
                    pass
1909 1910 1911
                # Python's typeobject.c will automatically fill in our slot
                # in add_operators() (called by PyType_Ready) with a value
                # that's better than ours.
1912
                elif allow_skip:
1913
                    return
1914
        from .TypeSlots import method_coexist
William Stein's avatar
William Stein committed
1915 1916 1917 1918
        if entry.doc:
            doc_code = entry.doc_cname
        else:
            doc_code = 0
1919 1920
        method_flags = entry.signature.method_flags()
        if method_flags:
1921
            if entry.is_special:
1922
                method_flags += [method_coexist]
1923
            self.putln(
1924
                '{"%s", (PyCFunction)%s, %s, %s}%s' % (
1925
                    entry.name,
1926
                    entry.func_cname,
1927
                    "|".join(method_flags),
1928 1929
                    doc_code,
                    term))
1930

1931 1932
    # GIL methods

1933
    def put_ensure_gil(self, declare_gilstate=True, variable=None):
1934 1935 1936 1937 1938 1939
        """
        Acquire the GIL. The generated code is safe even when no PyThreadState
        has been allocated for this thread (for threads not initialized by
        using the Python API). Additionally, the code generated by this method
        may be called recursively.
        """
1940 1941
        self.globalstate.use_utility_code(
            UtilityCode.load_cached("ForceInitThreads", "ModuleSetupCode.c"))
1942
        self.putln("#ifdef WITH_THREAD")
1943 1944 1945 1946 1947
        if not variable:
            variable = '__pyx_gilstate_save'
            if declare_gilstate:
                self.put("PyGILState_STATE ")
        self.putln("%s = PyGILState_Ensure();" % variable)
1948 1949
        self.putln("#endif")

1950
    def put_release_ensured_gil(self, variable=None):
1951 1952 1953
        """
        Releases the GIL, corresponds to `put_ensure_gil`.
        """
1954 1955
        if not variable:
            variable = '__pyx_gilstate_save'
1956
        self.putln("#ifdef WITH_THREAD")
1957
        self.putln("PyGILState_Release(%s);" % variable)
1958 1959
        self.putln("#endif")

1960
    def put_acquire_gil(self, variable=None):
1961 1962 1963 1964
        """
        Acquire the GIL. The thread's thread state must have been initialized
        by a previous `put_release_gil`
        """
1965 1966 1967
        self.putln("#ifdef WITH_THREAD")
        if variable:
            self.putln('_save = %s;' % variable)
1968
        self.putln("Py_BLOCK_THREADS")
1969
        self.putln("#endif")
1970

1971
    def put_release_gil(self, variable=None):
1972 1973
        "Release the GIL, corresponds to `put_acquire_gil`."
        self.putln("#ifdef WITH_THREAD")
1974
        self.putln("PyThreadState *_save;")
1975
        self.putln("Py_UNBLOCK_THREADS")
1976 1977 1978
        if variable:
            self.putln('%s = _save;' % variable)
        self.putln("#endif")
1979

1980 1981
    def declare_gilstate(self):
        self.putln("#ifdef WITH_THREAD")
1982
        self.putln("PyGILState_STATE __pyx_gilstate_save;")
1983 1984
        self.putln("#endif")

1985 1986
    # error handling

Robert Bradshaw's avatar
Robert Bradshaw committed
1987 1988 1989 1990
    def put_error_if_neg(self, pos, value):
#        return self.putln("if (unlikely(%s < 0)) %s" % (value, self.error_goto(pos)))  # TODO this path is almost _never_ taken, yet this macro makes is slower!
        return self.putln("if (%s < 0) %s" % (value, self.error_goto(pos)))

1991
    def put_error_if_unbound(self, pos, entry, in_nogil_context=False):
1992
        from . import ExprNodes
1993
        if entry.from_closure:
1994 1995 1996
            func = '__Pyx_RaiseClosureNameError'
            self.globalstate.use_utility_code(
                ExprNodes.raise_closure_name_error_utility_code)
1997 1998 1999 2000
        elif entry.type.is_memoryviewslice and in_nogil_context:
            func = '__Pyx_RaiseUnboundMemoryviewSliceNogil'
            self.globalstate.use_utility_code(
                ExprNodes.raise_unbound_memoryview_utility_code_nogil)
2001
        else:
2002 2003 2004
            func = '__Pyx_RaiseUnboundLocalError'
            self.globalstate.use_utility_code(
                ExprNodes.raise_unbound_local_error_utility_code)
Mark Florisson's avatar
Mark Florisson committed
2005

2006
        self.putln('if (unlikely(!%s)) { %s("%s"); %s }' % (
Mark Florisson's avatar
Mark Florisson committed
2007 2008 2009 2010
                                entry.type.check_for_null_code(entry.cname),
                                func,
                                entry.name,
                                self.error_goto(pos)))
2011

2012
    def set_error_info(self, pos, used=False):
2013
        self.funcstate.should_declare_error_indicator = True
2014 2015
        if used:
            self.funcstate.uses_error_indicator = True
2016
        if self.c_line_in_traceback:
2017
            cinfo = " %s = %s;" % (Naming.clineno_cname, Naming.line_c_macro)
Robert Bradshaw's avatar
Robert Bradshaw committed
2018 2019
        else:
            cinfo = ""
2020

2021
        return "%s = %s[%s]; %s = %s;%s" % (
William Stein's avatar
William Stein committed
2022 2023 2024 2025 2026
            Naming.filename_cname,
            Naming.filetable_cname,
            self.lookup_filename(pos[0]),
            Naming.lineno_cname,
            pos[1],
2027
            cinfo)
2028

2029 2030 2031 2032 2033
    def error_goto(self, pos):
        lbl = self.funcstate.error_label
        self.funcstate.use_label(lbl)
        return "{%s goto %s;}" % (
            self.set_error_info(pos),
2034
            lbl)
2035 2036 2037

    def error_goto_if(self, cond, pos):
        return "if (%s) %s" % (self.unlikely(cond), self.error_goto(pos))
2038

Robert Bradshaw's avatar
Robert Bradshaw committed
2039 2040
    def error_goto_if_null(self, cname, pos):
        return self.error_goto_if("!%s" % cname, pos)
2041

Robert Bradshaw's avatar
Robert Bradshaw committed
2042 2043
    def error_goto_if_neg(self, cname, pos):
        return self.error_goto_if("%s < 0" % cname, pos)
2044

Robert Bradshaw's avatar
Robert Bradshaw committed
2045 2046
    def error_goto_if_PyErr(self, pos):
        return self.error_goto_if("PyErr_Occurred()", pos)
2047

William Stein's avatar
William Stein committed
2048
    def lookup_filename(self, filename):
2049
        return self.globalstate.lookup_filename(filename)
William Stein's avatar
William Stein committed
2050

2051
    def put_declare_refcount_context(self):
2052
        self.putln('__Pyx_RefNannyDeclarations')
2053

2054 2055
    def put_setup_refcount_context(self, name, acquire_gil=False):
        if acquire_gil:
2056 2057
            self.globalstate.use_utility_code(
                UtilityCode.load_cached("ForceInitThreads", "ModuleSetupCode.c"))
2058
        self.putln('__Pyx_RefNannySetupContext("%s", %d);' % (name, acquire_gil and 1 or 0))
2059

2060
    def put_finish_refcount_context(self):
2061
        self.putln("__Pyx_RefNannyFinishContext();")
2062

2063 2064 2065 2066
    def put_add_traceback(self, qualified_name):
        """
        Build a Python traceback for propagating exceptions.

2067
        qualified_name should be the qualified name of the function.
2068 2069 2070 2071 2072 2073 2074
        """
        format_tuple = (
            qualified_name,
            Naming.clineno_cname,
            Naming.lineno_cname,
            Naming.filename_cname,
        )
2075
        self.funcstate.uses_error_indicator = True
2076 2077
        self.putln('__Pyx_AddTraceback("%s", %s, %s, %s);' % format_tuple)

2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088
    def put_unraisable(self, qualified_name):
        """
        Generate code to print a Python warning for an unraisable exception.

        qualified_name should be the qualified name of the function.
        """
        format_tuple = (
            qualified_name,
            Naming.clineno_cname,
            Naming.lineno_cname,
            Naming.filename_cname,
2089
            int(self.globalstate.directives['unraisable_tracebacks'])
2090 2091
        )
        self.funcstate.uses_error_indicator = True
2092
        self.putln('__Pyx_WriteUnraisable("%s", %s, %s, %s, %s);' % format_tuple)
2093 2094 2095
        self.globalstate.use_utility_code(
            UtilityCode.load_cached("WriteUnraisableException", "Exceptions.c"))

2096 2097
    def put_trace_declarations(self, codeobj=None):
        self.putln('__Pyx_TraceDeclarations(%s)' % (codeobj or 'NULL'))
2098

Robert Bradshaw's avatar
Robert Bradshaw committed
2099
    def put_trace_call(self, name, pos):
2100
        self.putln('__Pyx_TraceCall("%s", %s[%s], %s);' % (name, Naming.filetable_cname, self.lookup_filename(pos[0]), pos[1]))
2101

Robert Bradshaw's avatar
Robert Bradshaw committed
2102 2103
    def put_trace_exception(self):
        self.putln("__Pyx_TraceException();")
2104

Robert Bradshaw's avatar
Robert Bradshaw committed
2105 2106 2107
    def put_trace_return(self, retvalue_cname):
        self.putln("__Pyx_TraceReturn(%s);" % retvalue_cname)

Mark Florisson's avatar
Mark Florisson committed
2108 2109 2110
    def putln_openmp(self, string):
        self.putln("#ifdef _OPENMP")
        self.putln(string)
2111
        self.putln("#endif /* _OPENMP */")
William Stein's avatar
William Stein committed
2112

2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
    def undef_builtin_expect(self, cond):
        """
        Redefine the macros likely() and unlikely to no-ops, depending on
        condition 'cond'
        """
        self.putln("#if %s" % cond)
        self.putln("    #undef likely")
        self.putln("    #undef unlikely")
        self.putln("    #define likely(x)   (x)")
        self.putln("    #define unlikely(x) (x)")
        self.putln("#endif")

    def redef_builtin_expect(self, cond):
        self.putln("#if %s" % cond)
        self.putln("    #undef likely")
        self.putln("    #undef unlikely")
        self.putln("    #define likely(x)   __builtin_expect(!!(x), 1)")
        self.putln("    #define unlikely(x) __builtin_expect(!!(x), 0)")
        self.putln("#endif")

2133
class PyrexCodeWriter(object):
William Stein's avatar
William Stein committed
2134 2135 2136 2137
    # f                file      output file
    # level            int       indentation level

    def __init__(self, outfile_name):
2138
        self.f = Utils.open_new_file(outfile_name)
William Stein's avatar
William Stein committed
2139
        self.level = 0
2140

William Stein's avatar
William Stein committed
2141 2142
    def putln(self, code):
        self.f.write("%s%s\n" % (" " * self.level, code))
2143

William Stein's avatar
William Stein committed
2144 2145
    def indent(self):
        self.level += 1
2146

William Stein's avatar
William Stein committed
2147 2148 2149
    def dedent(self):
        self.level -= 1

2150 2151
class PyxCodeWriter(object):
    """
2152 2153 2154
    Can be used for writing out some Cython code. To use the indenter
    functionality, the Cython.Compiler.Importer module will have to be used
    to load the code to support python 2.4
2155 2156
    """

2157
    def __init__(self, buffer=None, indent_level=0, context=None, encoding='ascii'):
2158 2159 2160
        self.buffer = buffer or StringIOTree()
        self.level = indent_level
        self.context = context
2161
        self.encoding = encoding
2162 2163 2164

    def indent(self, levels=1):
        self.level += levels
2165
        return True
2166 2167 2168 2169 2170 2171

    def dedent(self, levels=1):
        self.level -= levels

    def indenter(self, line):
        """
2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
        Instead of

            with pyx_code.indenter("for i in range(10):"):
                pyx_code.putln("print i")

        write

            if pyx_code.indenter("for i in range(10);"):
                pyx_code.putln("print i")
                pyx_code.dedent()
2182 2183
        """
        self.putln(line)
2184 2185
        self.indent()
        return True
2186 2187

    def getvalue(self):
2188 2189 2190 2191 2192
        result = self.buffer.getvalue()
        if not isinstance(result, unicode):
            result = result.decode(self.encoding)

        return result
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218

    def putln(self, line, context=None):
        context = context or self.context
        if context:
            line = sub_tempita(line, context)
        self._putln(line)

    def _putln(self, line):
        self.buffer.write("%s%s\n" % (self.level * "    ", line))

    def put_chunk(self, chunk, context=None):
        context = context or self.context
        if context:
            chunk = sub_tempita(chunk, context)

        chunk = textwrap.dedent(chunk)
        for line in chunk.splitlines():
            self._putln(line)

    def insertion_point(self):
        return PyxCodeWriter(self.buffer.insertion_point(), self.level,
                             self.context)

    def named_insertion_point(self, name):
        setattr(self, name, self.insertion_point())

2219 2220

class ClosureTempAllocator(object):
2221
    def __init__(self, klass):
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241
        self.klass = klass
        self.temps_allocated = {}
        self.temps_free = {}
        self.temps_count = 0

    def reset(self):
        for type, cnames in self.temps_allocated.items():
            self.temps_free[type] = list(cnames)

    def allocate_temp(self, type):
        if not type in self.temps_allocated:
            self.temps_allocated[type] = []
            self.temps_free[type] = []
        elif self.temps_free[type]:
            return self.temps_free[type].pop(0)
        cname = '%s%d' % (Naming.codewriter_temp_prefix, self.temps_count)
        self.klass.declare_var(pos=None, name=cname, cname=cname, type=type, is_cdef=True)
        self.temps_allocated[type].append(cname)
        self.temps_count += 1
        return cname