Code.py 85.5 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
import operator
18
import textwrap
19 20
from string import Template
from functools import partial
Stefan Behnel's avatar
Stefan Behnel committed
21 22
from contextlib import closing
from collections import defaultdict
23

Robert Bradshaw's avatar
Robert Bradshaw committed
24 25 26 27 28
try:
    import hashlib
except ImportError:
    import md5 as hashlib

29 30 31 32
from . import Naming
from . import Options
from . import DebugFlags
from . import StringEncoding
33
from . import Version
34 35 36
from .. import Utils
from .Scanning import SourceDescriptor
from ..StringIOTree import StringIOTree
37

Stefan Behnel's avatar
Stefan Behnel committed
38
try:
Stefan Behnel's avatar
Stefan Behnel committed
39 40 41
    from __builtin__ import basestring
except ImportError:
    from builtins import str as basestring
42

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

45 46

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

55 56
basicsize_builtins_map = {
    # builtins whose type has a different tp_basicsize than sizeof(...)
57 58
    'PyTypeObject': 'PyHeapTypeObject',
}
59

60 61 62 63
uncachable_builtins = [
    # builtin names that cannot be cached because they may or may not
    # be available at import time
    'WindowsError',
64 65
    '_',  # e.g. gettext
]
66

67 68 69 70 71 72 73
special_py_methods = set([
    '__cinit__', '__dealloc__', '__richcmp__', '__next__',
    '__await__', '__aiter__', '__anext__',
    '__getreadbuffer__', '__getwritebuffer__', '__getsegcount__',
    '__getcharbuffer__', '__getbuffer__', '__releasebuffer__'
])

74 75 76 77
modifier_output_mapper = {
    'inline': 'CYTHON_INLINE'
}.get

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

Stefan Behnel's avatar
Stefan Behnel committed
80

81 82 83 84 85
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
86

Stefan Behnel's avatar
Stefan Behnel committed
87

88
class UtilityCodeBase(object):
89 90 91 92 93 94
    """
    Support for loading utility code from a file.

    Code sections in the file can be specified as follows:

        ##### MyUtility.proto #####
95

96
        [proto declarations]
97

98
        ##### MyUtility.init #####
99

100
        [code run at module initialization]
101 102 103

        ##### MyUtility #####
        #@requires: MyOtherUtility
104
        #@substitute: naming
105

106
        [definitions]
107 108 109 110 111 112 113 114 115

    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.
    """
116 117

    is_cython_utility = False
118
    requires = None
119 120
    _utility_cache = {}

121
    @classmethod
122
    def _add_utility(cls, utility, type, lines, begin_lineno, tags=None):
123 124
        if utility is None:
            return
125

126 127 128 129 130
        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))
131
            except (KeyError, ValueError) as e:
132 133 134 135 136
                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
137

138
        if type == 'proto':
139
            utility[0] = code
140
        elif type == 'impl':
141
            utility[1] = code
142 143
        else:
            all_tags = utility[2]
Stefan Behnel's avatar
Stefan Behnel committed
144 145
            if KEYWORDS_MUST_BE_BYTES:
                type = type.encode('ASCII')
146
            all_tags[type] = code
147

148 149
        if tags:
            all_tags = utility[2]
Stefan Behnel's avatar
Stefan Behnel committed
150
            for name, values in tags.items():
Stefan Behnel's avatar
Stefan Behnel committed
151 152
                if KEYWORDS_MUST_BE_BYTES:
                    name = name.encode('ASCII')
153
                all_tags.setdefault(name, set()).update(values)
154

155
    @classmethod
156 157 158 159 160
    def load_utilities_from_file(cls, path):
        utilities = cls._utility_cache.get(path)
        if utilities:
            return utilities

161
        filename = os.path.join(get_utility_dir(), path)
162 163 164
        _, ext = os.path.splitext(path)
        if ext in ('.pyx', '.py', '.pxd', '.pxi'):
            comment = '#'
Stefan Behnel's avatar
Stefan Behnel committed
165
            strip_comments = partial(re.compile(r'^\s*#.*').sub, '')
Stefan Behnel's avatar
Stefan Behnel committed
166
            rstrip = StringEncoding._unicode.rstrip
167
        else:
168
            comment = '/'
Stefan Behnel's avatar
Stefan Behnel committed
169
            strip_comments = partial(re.compile(r'^\s*//.*|/\*[^*]*\*/').sub, '')
170
            rstrip = partial(re.compile(r'\s+(\\?)$').sub, r'\1')
171
        match_special = re.compile(
172
            (r'^%(C)s{5,30}\s*(?P<name>(?:\w|\.)+)\s*%(C)s{5,30}|'
Stefan Behnel's avatar
Stefan Behnel committed
173 174
             r'^%(C)s+@(?P<tag>\w+)\s*:\s*(?P<value>(?:\w|[.:])+)') %
            {'C': comment}).match
175
        match_type = re.compile('(.+)[.](proto|impl|init|cleanup)$').match
176

Stefan Behnel's avatar
Stefan Behnel committed
177
        with closing(Utils.open_source_file(filename, encoding='UTF-8')) as f:
178
            all_lines = f.readlines()
179

Stefan Behnel's avatar
Stefan Behnel committed
180
        utilities = defaultdict(lambda: [None, None, {}])
181
        lines = []
Stefan Behnel's avatar
Stefan Behnel committed
182
        tags = defaultdict(set)
183 184 185
        utility = type = None
        begin_lineno = 0

Mark Florisson's avatar
Mark Florisson committed
186
        for lineno, line in enumerate(all_lines):
187
            m = match_special(line)
Mark Florisson's avatar
Mark Florisson committed
188
            if m:
189
                if m.group('name'):
190 191 192 193 194 195
                    cls._add_utility(utility, type, lines, begin_lineno, tags)

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

196 197 198 199
                    name = m.group('name')
                    mtype = match_type(name)
                    if mtype:
                        name, type = mtype.groups()
200
                    else:
201
                        type = 'impl'
Stefan Behnel's avatar
Stefan Behnel committed
202
                    utility = utilities[name]
Mark Florisson's avatar
Mark Florisson committed
203
                else:
Stefan Behnel's avatar
Stefan Behnel committed
204 205
                    tags[m.group('tag')].add(m.group('value'))
                    lines.append('')  # keep line number correct
Mark Florisson's avatar
Mark Florisson committed
206
            else:
Stefan Behnel's avatar
Stefan Behnel committed
207
                lines.append(rstrip(strip_comments(line)))
Mark Florisson's avatar
Mark Florisson committed
208

209
        if utility is None:
210 211 212
            raise ValueError("Empty utility code file")

        # Don't forget to add the last utility code
213
        cls._add_utility(utility, type, lines, begin_lineno, tags)
214

Stefan Behnel's avatar
Stefan Behnel committed
215
        utilities = dict(utilities)  # un-defaultdict-ify
216 217 218
        cls._utility_cache[path] = utilities
        return utilities

219
    @classmethod
220
    def load(cls, util_code_name, from_file=None, **kwargs):
221
        """
222 223 224 225
        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.
226
        """
227 228 229
        if '::' in util_code_name:
            from_file, util_code_name = util_code_name.rsplit('::', 1)
        if not from_file:
230 231
            utility_dir = get_utility_dir()
            prefix = util_code_name + '.'
232 233 234 235 236 237 238 239 240
            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
Stefan Behnel's avatar
Stefan Behnel committed
241
                with closing(zipfile.ZipFile(archive)) as fileobj:
242 243 244 245 246
                    listing = [os.path.basename(name)
                               for name in fileobj.namelist()
                               if os.path.join(archive, name).startswith(utility_dir)]
            files = [filename for filename in listing
                     if filename.startswith(prefix)]
247 248 249 250 251
            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]
252 253

        utilities = cls.load_utilities_from_file(from_file)
254 255 256 257
        proto, impl, tags = utilities[util_code_name]

        if tags:
            orig_kwargs = kwargs.copy()
Stefan Behnel's avatar
Stefan Behnel committed
258
            for name, values in tags.items():
259 260 261 262
                if name in kwargs:
                    continue
                # only pass lists when we have to: most argument expect one value or None
                if name == 'requires':
263 264 265 266 267 268 269
                    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)]
270 271 272 273 274
                elif not values:
                    values = None
                elif len(values) == 1:
                    values = values[0]
                kwargs[name] = values
Mark Florisson's avatar
Mark Florisson committed
275

276 277 278 279
        if proto is not None:
            kwargs['proto'] = proto
        if impl is not None:
            kwargs['impl'] = impl
Mark Florisson's avatar
Mark Florisson committed
280

281 282
        if 'name' not in kwargs:
            kwargs['name'] = util_code_name
Mark Florisson's avatar
Mark Florisson committed
283

284 285 286 287 288
        if 'file' not in kwargs and from_file:
            kwargs['file'] = from_file
        return cls(**kwargs)

    @classmethod
289
    def load_cached(cls, utility_code_name, from_file=None, __cache={}):
290
        """
291
        Calls .load(), but using a per-type cache based on utility name and file name.
292
        """
293 294
        key = (cls, from_file, utility_code_name)
        try:
295
            return __cache[key]
296 297
        except KeyError:
            pass
298
        code = __cache[key] = cls.load(utility_code_name, from_file)
299
        return code
300

301 302 303 304 305 306 307
    @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
308
        return util.format_code(proto), util.format_code(impl)
309

310
    def format_code(self, code_string, replace_empty_lines=re.compile(r'\n\n+').sub):
311 312 313 314 315 316 317
        """
        Format a code section for output.
        """
        if code_string:
            code_string = replace_empty_lines('\n', code_string.strip()) + '\n\n'
        return code_string

318
    def __str__(self):
319
        return "<%s(%s)>" % (type(self).__name__, self.name)
320

321
    def get_tree(self, **kwargs):
322
        pass
323

Stefan Behnel's avatar
Stefan Behnel committed
324

325
class UtilityCode(UtilityCodeBase):
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    """
    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)
    """
343

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
344
    def __init__(self, proto=None, impl=None, init=None, cleanup=None, requires=None,
345
                 proto_block='utility_code_proto', name=None, file=None):
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
346
        # proto_block: Which code block to dump prototype in. See GlobalState.
347 348 349 350 351 352 353
        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
354
        self.proto_block = proto_block
355
        self.name = name
356
        self.file = file
357

358 359 360 361 362 363
    def __hash__(self):
        return hash((self.proto, self.impl))

    def __eq__(self, other):
        if self is other:
            return True
364 365
        self_type, other_type = type(self), type(other)
        if self_type is not other_type and not (isinstance(other, self_type) or isinstance(self, other_type)):
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
            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):
381 382
        # Dicts aren't hashable...
        if pyrex_type is not None:
383
            data['type'] = pyrex_type.empty_declaration_code()
Craig Citro's avatar
Craig Citro committed
384
            data['type_name'] = pyrex_type.specialization_name()
Stefan Behnel's avatar
Stefan Behnel committed
385
        key = tuple(sorted(data.items()))
386 387 388 389 390 391 392
        try:
            return self._cache[key]
        except KeyError:
            if self.requires is None:
                requires = None
            else:
                requires = [r.specialize(data) for r in self.requires]
393

394
            s = self._cache[key] = UtilityCode(
395 396 397 398
                    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),
399 400 401
                    requires,
                    self.proto_block)

402 403 404
            self.specialize_list.append(s)
            return s

405 406 407
    def inject_string_constants(self, impl, output):
        """Replace 'PYIDENT("xyz")' by a constant Python identifier cname.
        """
408 409 410
        if 'PYIDENT(' not in impl:
            return False, impl

411 412 413 414 415 416 417 418 419 420
        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

421 422
        impl = re.sub(r'PYIDENT\("([^"]+)"\)', externalise, impl)
        assert 'PYIDENT(' not in impl
423
        return bool(replacements), impl
424

425 426 427 428 429 430
    def inject_unbound_methods(self, impl, output):
        """Replace 'UNBOUND_METHOD(type, "name")' by a constant Python identifier cname.
        """
        if 'CALL_UNBOUND_METHOD(' not in impl:
            return False, impl

431
        utility_code = set()
432 433 434 435 436
        def externalise(matchobj):
            type_cname, method_name, args = matchobj.groups()
            args = [arg.strip() for arg in args[1:].split(',')]
            if len(args) == 1:
                call = '__Pyx_CallUnboundCMethod0'
437
                utility_code.add("CallUnboundCMethod0")
438 439
            elif len(args) == 2:
                call = '__Pyx_CallUnboundCMethod1'
440
                utility_code.add("CallUnboundCMethod1")
441 442 443
            else:
                assert False, "CALL_UNBOUND_METHOD() requires 1 or 2 call arguments"

444
            cname = output.get_cached_unbound_method(type_cname, method_name, len(args))
445 446
            return '%s(&%s, %s)' % (call, cname, ', '.join(args))

447
        impl = re.sub(r'CALL_UNBOUND_METHOD\(([a-zA-Z_]+),\s*"([^"]+)"((?:,\s*[^),]+)+)\)', externalise, impl)
448
        assert 'CALL_UNBOUND_METHOD(' not in impl
449 450 451 452

        for helper in sorted(utility_code):
            output.use_utility_code(UtilityCode.load_cached(helper, "ObjectHandling.c"))
        return bool(utility_code), impl
453

454 455 456 457 458 459 460 461 462 463 464 465
    def wrap_c_strings(self, impl):
        """Replace CSTRING('''xyz''') by a C compatible string
        """
        if 'CSTRING(' not in impl:
            return impl

        def split_string(matchobj):
            content = matchobj.group(1).replace('"', '\042')
            return ''.join(
                '"%s\\n"\n' % line if not line.endswith('\\') or line.endswith('\\\\') else '"%s"\n' % line[:-1]
                for line in content.splitlines())

466
        impl = re.sub(r'CSTRING\(\s*"""([^"]*(?:"[^"]+)*)"""\s*\)', split_string, impl)
467 468 469
        assert 'CSTRING(' not in impl
        return impl

470 471 472 473 474
    def put_code(self, output):
        if self.requires:
            for dependency in self.requires:
                output.use_utility_code(dependency)
        if self.proto:
475 476 477
            output[self.proto_block].put_or_include(
                self.format_code(self.proto),
                '%s_proto' % self.name)
478
        if self.impl:
479
            impl = self.format_code(self.wrap_c_strings(self.impl))
480 481 482
            is_specialised1, impl = self.inject_string_constants(impl, output)
            is_specialised2, impl = self.inject_unbound_methods(impl, output)
            if not (is_specialised1 or is_specialised2):
483 484 485 486 487
                # 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)
488 489
        if self.init:
            writer = output['init_globals']
490
            writer.putln("/* %s.init */" % self.name)
491
            if isinstance(self.init, basestring):
492
                writer.put(self.format_code(self.init))
493 494
            else:
                self.init(writer, output.module_pos)
495 496
            writer.putln(writer.error_goto_if_PyErr(output.module_pos))
            writer.putln()
497 498 499
        if self.cleanup and Options.generate_cleanup_code:
            writer = output['cleanup_globals']
            if isinstance(self.cleanup, basestring):
500 501 502
                writer.put_or_include(
                    self.format_code(self.cleanup),
                    '%s_cleanup' % self.name)
503 504
            else:
                self.cleanup(writer, output.module_pos)
505 506


507
def sub_tempita(s, context, file=None, name=None):
508 509 510
    "Run tempita on string s with given context."
    if not s:
        return None
511

512 513 514 515
    if file:
        context['__name'] = "%s:%s" % (file, name)
    elif name:
        context['__name'] = name
516

517
    from ..Tempita import sub
518
    return sub(s, **context)
519

520

521
class TempitaUtilityCode(UtilityCode):
522
    def __init__(self, name=None, proto=None, impl=None, init=None, file=None, context=None, **kwargs):
523 524
        if context is None:
            context = {}
525 526
        proto = sub_tempita(proto, context, file, name)
        impl = sub_tempita(impl, context, file, name)
527
        init = sub_tempita(init, context, file, name)
528
        super(TempitaUtilityCode, self).__init__(
529
            proto, impl, init=init, name=name, file=file, **kwargs)
530

531 532 533 534 535 536 537 538 539 540 541 542
    @classmethod
    def load_cached(cls, utility_code_name, from_file=None, context=None, __cache={}):
        context_key = tuple(sorted(context.items())) if context else None
        assert hash(context_key) is not None  # raise TypeError if not hashable
        key = (cls, from_file, utility_code_name, context_key)
        try:
            return __cache[key]
        except KeyError:
            pass
        code = __cache[key] = cls.load(utility_code_name, from_file, context=context)
        return code

543 544 545 546 547 548 549
    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)
550 551 552 553 554 555 556


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'.
    """
557
    __name__ = '<lazy>'
558 559 560 561 562 563 564 565

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

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

566

567 568 569 570 571 572 573 574 575
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
576
    # can_trace        boolean         line tracing is supported in the current context
577

578
    # Not used for now, perhaps later
Robert Bradshaw's avatar
Robert Bradshaw committed
579
    def __init__(self, owner, names_taken=set()):
580
        self.names_taken = names_taken
581
        self.owner = owner
582

583 584
        self.error_label = None
        self.label_counter = 0
Robert Bradshaw's avatar
Robert Bradshaw committed
585
        self.labels_used = set()
586 587 588 589
        self.return_label = self.new_label()
        self.new_error_label()
        self.continue_label = None
        self.break_label = None
590
        self.yield_labels = []
591

592 593
        self.in_try_finally = 0
        self.exc_vars = None
594
        self.can_trace = False
595
        self.gil_owned = True
596

597
        self.temps_allocated = [] # of (name, type, manage_ref, static)
598 599
        self.temps_free = {} # (type, manage_ref) -> list of free vars with same type/managed status
        self.temps_used_type = {} # name -> (type, manage_ref)
600
        self.temp_counter = 0
601
        self.closure_temps = None
602

603 604 605 606
        # This is used to collect temporaries, useful to find out which temps
        # need to be privatized in parallel sections
        self.collect_temps_stack = []

607 608 609 610 611
        # 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
612
        self.uses_error_indicator = False
613

614 615
    # labels

616
    def new_label(self, name=None):
617 618
        n = self.label_counter
        self.label_counter = n + 1
619 620 621 622
        label = "%s%d" % (Naming.label_prefix, n)
        if name is not None:
            label += '_' + name
        return label
623

624 625 626 627 628 629
    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

630 631
    def new_error_label(self):
        old_err_lbl = self.error_label
632
        self.error_label = self.new_label('error')
633
        return old_err_lbl
634

635 636 637 638
    def get_loop_labels(self):
        return (
            self.continue_label,
            self.break_label)
639

640 641 642
    def set_loop_labels(self, labels):
        (self.continue_label,
         self.break_label) = labels
643

644 645 646
    def new_loop_labels(self):
        old_labels = self.get_loop_labels()
        self.set_loop_labels(
647
            (self.new_label("continue"),
Robert Bradshaw's avatar
Robert Bradshaw committed
648
             self.new_label("break")))
649
        return old_labels
650

651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
    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 = []
667
        for old_label, name in zip(old_labels, ['continue', 'break', 'return', 'error']):
668
            if old_label:
669
                new_labels.append(self.new_label(name))
670 671 672 673
            else:
                new_labels.append(old_label)
        self.set_all_labels(new_labels)
        return old_labels
674

675
    def use_label(self, lbl):
Stefan Behnel's avatar
Stefan Behnel committed
676
        self.labels_used.add(lbl)
677

678 679 680
    def label_used(self, lbl):
        return lbl in self.labels_used

681 682
    # temp handling

683
    def allocate_temp(self, type, manage_ref, static=False):
684 685 686 687 688
        """
        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.

689 690 691 692 693
        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.

694 695 696 697
        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.

698 699 700 701
        static=True marks the temporary declaration with "static".
        This is only used when allocating backing store for a module-level
        C array literals.

702 703
        A C string referring to the variable is returned.
        """
704
        if type.is_const and not type.is_reference:
705
            type = type.const_base_type
706
        elif type.is_reference and not type.is_fake_reference:
707
            type = type.ref_base_type
708
        if not type.is_pyobject and not type.is_memoryviewslice:
709 710 711
            # Make manage_ref canonical, so that manage_ref will always mean
            # a decref is needed.
            manage_ref = False
712

713
        freelist = self.temps_free.get((type, manage_ref))
714
        if freelist is not None and len(freelist) > 0:
715
            result = freelist.pop()
716
        else:
717 718 719 720
            while True:
                self.temp_counter += 1
                result = "%s%d" % (Naming.codewriter_temp_prefix, self.temp_counter)
                if not result in self.names_taken: break
721
            self.temps_allocated.append((result, type, manage_ref, static))
722
        self.temps_used_type[result] = (type, manage_ref)
723
        if DebugFlags.debug_temp_code_comments:
724
            self.owner.putln("/* %s allocated (%s) */" % (result, type))
725 726 727 728

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

729 730 731 732 733 734 735
        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.
        """
736 737
        type, manage_ref = self.temps_used_type[name]
        freelist = self.temps_free.get((type, manage_ref))
738 739
        if freelist is None:
            freelist = []
740
            self.temps_free[(type, manage_ref)] = freelist
741 742
        if name in freelist:
            raise RuntimeError("Temp %s freed twice!" % name)
743
        freelist.append(name)
744 745
        if DebugFlags.debug_temp_code_comments:
            self.owner.putln("/* %s released */" % name)
746

747
    def temps_in_use(self):
748
        """Return a list of (cname,type,manage_ref) tuples of temp names and their type
749 750 751
        that are currently in use.
        """
        used = []
752
        for name, type, manage_ref, static in self.temps_allocated:
753
            freelist = self.temps_free.get((type, manage_ref))
754
            if freelist is None or name not in freelist:
755
                used.append((name, type, manage_ref and type.is_pyobject))
756 757
        return used

758
    def temps_holding_reference(self):
759
        """Return a list of (cname,type) tuples of temp names and their type
760 761
        that are currently in use. This includes only temps of a
        Python object type which owns its reference.
762 763
        """
        return [(name, type)
764
                for name, type, manage_ref in self.temps_in_use()
765
                if manage_ref  and type.is_pyobject]
766 767 768 769 770

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

774 775 776 777 778 779 780
    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)
781 782
                for (type, manage_ref), freelist in self.temps_free.items() if manage_ref
                for cname in freelist]
783

784 785 786 787
    def start_collecting_temps(self):
        """
        Useful to find out which temps were used in a code block
        """
Robert Bradshaw's avatar
Robert Bradshaw committed
788
        self.collect_temps_stack.append(set())
789 790 791

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

793 794 795
    def init_closure_temps(self, scope):
        self.closure_temps = ClosureTempAllocator(scope)

796

Stefan Behnel's avatar
Stefan Behnel committed
797 798 799 800 801 802 803
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
804 805
    """

Stefan Behnel's avatar
Stefan Behnel committed
806
    def __init__(self, cname, value, py_type, value_code=None):
807 808
        self.cname = cname
        self.value = value
Stefan Behnel's avatar
Stefan Behnel committed
809 810 811
        self.py_type = py_type
        self.value_code = value_code or value

812

813 814 815 816 817 818 819 820 821 822
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
823

824
cython.declare(possible_unicode_identifier=object, possible_bytes_identifier=object,
825
               replace_identifier=object, find_alphanums=object)
826
possible_unicode_identifier = re.compile(br"(?![0-9])\w+$".decode('ascii'), re.U).match
Stefan Behnel's avatar
Stefan Behnel committed
827
possible_bytes_identifier = re.compile(r"(?![0-9])\w+$".encode('ASCII')).match
828
replace_identifier = re.compile(r'[^a-zA-Z0-9_]+').sub
829
find_alphanums = re.compile('([a-zA-Z0-9]+)').findall
830 831 832 833 834 835 836 837 838 839 840 841 842

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
843 844 845
        self.py_versions = []

    def add_py_version(self, version):
846 847 848
        if not version:
            self.py_versions = [2,3]
        elif version not in self.py_versions:
849
            self.py_versions.append(version)
850

851 852
    def get_py_string_const(self, encoding, identifier=None,
                            is_str=False, py3str_cstring=None):
853 854 855
        py_strings = self.py_strings
        text = self.text

Stefan Behnel's avatar
Stefan Behnel committed
856
        is_str = bool(identifier or is_str)
857
        is_unicode = encoding is None and not is_str
858

859 860 861 862 863 864 865 866 867 868 869 870
        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))

871 872 873 874 875 876
        key = (is_str, is_unicode, encoding_key, py3str_cstring)
        if py_strings is not None:
            try:
                return py_strings[key]
            except KeyError:
                pass
877
        else:
878
            self.py_strings = {}
879

880 881 882
        if identifier:
            intern = True
        elif identifier is None:
883
            if isinstance(text, bytes):
884
                intern = bool(possible_bytes_identifier(text))
885 886
            else:
                intern = bool(possible_unicode_identifier(text))
887 888 889
        else:
            intern = False
        if intern:
890
            prefix = Naming.interned_prefixes['str']
891 892
        else:
            prefix = Naming.py_const_prefix
893 894 895 896 897 898 899

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

        pystring_cname = "%s%s%s_%s" % (
900 901
            prefix,
            (is_str and 's') or (is_unicode and 'u') or 'b',
902
            encoding_prefix,
903 904 905 906 907
            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
908 909 910 911 912 913
        return py_string

class PyStringConst(object):
    """Global info about a Python string constant held by GlobalState.
    """
    # cname       string
914
    # py3str_cstring string
915
    # encoding    string
916
    # intern      boolean
917 918
    # is_unicode  boolean
    # is_str      boolean
919

920 921
    def __init__(self, cname, encoding, is_unicode, is_str=False,
                 py3str_cstring=None, intern=False):
922
        self.cname = cname
923
        self.py3str_cstring = py3str_cstring
924 925 926
        self.encoding = encoding
        self.is_str = is_str
        self.is_unicode = is_unicode
927 928
        self.intern = intern

Stefan Behnel's avatar
Stefan Behnel committed
929 930 931
    def __lt__(self, other):
        return self.cname < other.cname

932

933 934 935 936 937 938
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.
939
    #
940
    # utility_codes   set                IDs of used utility code (to avoid reinsertion)
941 942 943 944 945 946
    #
    # 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.
947
    #
948
    # const_cnames_used  dict          global counter for unique constant identifiers
949
    #
950

951 952
    # parts            {string:CCodeWriter}

953

954 955 956 957
    # interned_strings
    # consts
    # interned_nums

958 959 960 961 962 963
    # directives       set             Temporary variable used to track
    #                                  the current set of directives in the code generation
    #                                  process.

    directives = {}

964 965
    code_layout = [
        'h_code',
Robert Bradshaw's avatar
Robert Bradshaw committed
966
        'filename_table',
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
967
        'utility_code_proto_before_types',
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
968 969 970 971
        '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
972 973
        'module_declarations',
        'typeinfo',
974 975
        'before_global_var',
        'global_var',
976
        'string_decls',
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
977
        'decls',
978
        'all_the_rest',
979 980
        'pystring_table',
        'cached_builtins',
981
        'cached_constants',
982 983 984 985 986
        'init_globals',
        'init_module',
        'cleanup_globals',
        'cleanup_module',
        'main_method',
987 988
        'utility_code_def',
        'end'
989
    ]
990

991

992
    def __init__(self, writer, module_node, code_config, common_utility_include_dir=None):
993 994 995
        self.filename_table = {}
        self.filename_list = []
        self.input_file_contents = {}
Robert Bradshaw's avatar
Robert Bradshaw committed
996
        self.utility_codes = set()
997
        self.declared_cnames = {}
998
        self.in_utility_code_generation = False
999
        self.code_config = code_config
1000
        self.common_utility_include_dir = common_utility_include_dir
1001
        self.parts = {}
1002 1003
        self.module_node = module_node # because some utility code generation needs it
                                       # (generating backwards-compatible Get/ReleaseBuffer
1004

1005
        self.const_cnames_used = {}
1006
        self.string_const_index = {}
Nikita Nemkin's avatar
Nikita Nemkin committed
1007
        self.pyunicode_ptr_const_index = {}
Stefan Behnel's avatar
Stefan Behnel committed
1008
        self.num_const_index = {}
1009
        self.py_constants = []
1010
        self.cached_cmethods = {}
1011

1012
        writer.set_global_state(self)
1013
        self.rootwriter = writer
1014

1015 1016 1017 1018
    def initialize_main_c_code(self):
        rootwriter = self.rootwriter
        for part in self.code_layout:
            self.parts[part] = rootwriter.insertion_point()
1019

1020 1021 1022 1023 1024 1025
        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) {")
1026

1027 1028 1029 1030
        w = self.parts['cached_constants']
        w.enter_cfunc_scope()
        w.putln("")
        w.putln("static int __Pyx_InitCachedConstants(void) {")
1031
        w.put_declare_refcount_context()
1032 1033
        w.put_setup_refcount_context("__Pyx_InitCachedConstants")

1034 1035 1036 1037
        w = self.parts['init_globals']
        w.enter_cfunc_scope()
        w.putln("")
        w.putln("static int __Pyx_InitGlobals(void) {")
1038

1039 1040 1041 1042 1043 1044 1045
        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) {")
1046

1047 1048 1049 1050
        code = self.parts['utility_code_proto']
        code.putln("")
        code.putln("/* --- Runtime support code (head) --- */")

1051
        code = self.parts['utility_code_def']
1052
        if self.code_config.emit_linenums:
1053 1054
            code.write('\n#line 1 "cython_utility"\n')
        code.putln("")
1055
        code.putln("/* --- Runtime support code --- */")
1056

1057
    def finalize_main_c_code(self):
1058 1059 1060 1061 1062 1063
        self.close_global_decls()

        #
        # utility_code_def
        #
        code = self.parts['utility_code_def']
1064 1065
        util = TempitaUtilityCode.load_cached("TypeConversions", "TypeConversion.c")
        code.put(util.format_code(util.impl))
1066 1067
        code.putln("")

1068 1069 1070
    def __getitem__(self, key):
        return self.parts[key]

1071 1072 1073
    #
    # Global constants, interned objects, etc.
    #
1074 1075
    def close_global_decls(self):
        # This is called when it is known that no more global declarations will
1076
        # declared.
1077
        self.generate_const_declarations()
1078
        if Options.cache_builtins:
1079
            w = self.parts['cached_builtins']
1080
            w.putln("return 0;")
1081 1082 1083
            if w.label_used(w.error_label):
                w.put_label(w.error_label)
                w.putln("return -1;")
1084 1085 1086
            w.putln("}")
            w.exit_cfunc_scope()

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
        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()

1097
        w = self.parts['init_globals']
1098
        w.putln("return 0;")
1099 1100 1101
        if w.label_used(w.error_label):
            w.put_label(w.error_label)
            w.putln("return -1;")
1102 1103
        w.putln("}")
        w.exit_cfunc_scope()
1104

1105 1106 1107 1108 1109
        if Options.generate_cleanup_code:
            w = self.parts['cleanup_globals']
            w.putln("}")
            w.exit_cfunc_scope()

1110 1111 1112 1113
        if Options.generate_cleanup_code:
            w = self.parts['cleanup_module']
            w.putln("}")
            w.exit_cfunc_scope()
1114

1115
    def put_pyobject_decl(self, entry):
1116
        self['global_var'].putln("static PyObject *%s;" % entry.cname)
1117

1118 1119
    # constant handling at code generation time

1120 1121 1122
    def get_cached_constants_writer(self):
        return self.parts['cached_constants']

1123
    def get_int_const(self, str_value, longness=False):
Stefan Behnel's avatar
Stefan Behnel committed
1124
        py_type = longness and 'long' or 'int'
1125
        try:
Stefan Behnel's avatar
Stefan Behnel committed
1126
            c = self.num_const_index[(str_value, py_type)]
1127
        except KeyError:
Stefan Behnel's avatar
Stefan Behnel committed
1128 1129 1130 1131 1132 1133 1134 1135
            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)
1136 1137
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1138
    def get_py_const(self, type, prefix='', cleanup_level=None):
1139
        # create a new Python object constant
Stefan Behnel's avatar
Stefan Behnel committed
1140
        const = self.new_py_const(type, prefix)
1141
        if cleanup_level is not None \
Stefan Behnel's avatar
Stefan Behnel committed
1142
                and cleanup_level <= Options.generate_cleanup_code:
1143
            cleanup_writer = self.parts['cleanup_globals']
1144
            cleanup_writer.putln('Py_CLEAR(%s);' % const.cname)
1145
        return const
1146

1147
    def get_string_const(self, text, py_version=None):
1148 1149
        # return a C string constant, creating a new one if necessary
        if text.is_unicode:
1150
            byte_string = text.utf8encode()
1151 1152 1153 1154 1155 1156
        else:
            byte_string = text.byteencode()
        try:
            c = self.string_const_index[byte_string]
        except KeyError:
            c = self.new_string_const(text, byte_string)
1157
        c.add_py_version(py_version)
1158 1159
        return c

1160
    def get_pyunicode_ptr_const(self, text):
1161 1162 1163
        # return a Py_UNICODE[] constant, creating a new one if necessary
        assert text.is_unicode
        try:
Nikita Nemkin's avatar
Nikita Nemkin committed
1164
            c = self.pyunicode_ptr_const_index[text]
1165
        except KeyError:
Nikita Nemkin's avatar
Nikita Nemkin committed
1166
            c = self.pyunicode_ptr_const_index[text] = self.new_const_cname()
1167 1168
        return c

1169 1170
    def get_py_string_const(self, text, identifier=None,
                            is_str=False, unicode_value=None):
1171
        # return a Python string constant, creating a new one if necessary
1172 1173
        py3str_cstring = None
        if is_str and unicode_value is not None \
1174
               and unicode_value.utf8encode() != text.byteencode():
1175 1176 1177 1178
            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)
1179 1180
        py_string = c_string.get_py_string_const(
            text.encoding, identifier, is_str, py3str_cstring)
1181 1182
        return py_string

1183 1184 1185
    def get_interned_identifier(self, text):
        return self.get_py_string_const(text, identifier=True)

1186
    def new_string_const(self, text, byte_string):
Stefan Behnel's avatar
Stefan Behnel committed
1187
        cname = self.new_string_const_cname(byte_string)
1188 1189 1190 1191
        c = StringConst(cname, text, byte_string)
        self.string_const_index[byte_string] = c
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1192 1193 1194 1195
    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
1196 1197
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1198 1199
    def new_py_const(self, type, prefix=''):
        cname = self.new_const_cname(prefix)
1200 1201 1202 1203
        c = PyObjectConst(cname, type)
        self.py_constants.append(c)
        return c

Stefan Behnel's avatar
Stefan Behnel committed
1204
    def new_string_const_cname(self, bytes_value):
1205
        # Create a new globally-unique nice name for a C string constant.
Stefan Behnel's avatar
Stefan Behnel committed
1206
        value = bytes_value.decode('ASCII', 'ignore')
1207
        return self.new_const_cname(value=value)
1208

Stefan Behnel's avatar
Stefan Behnel committed
1209 1210
    def new_num_const_cname(self, value, py_type):
        if py_type == 'long':
1211
            value += 'L'
1212 1213
            py_type = 'int'
        prefix = Naming.interned_prefixes[py_type]
Stefan Behnel's avatar
Stefan Behnel committed
1214
        cname = "%s%s" % (prefix, value)
1215
        cname = cname.replace('+', '_').replace('-', 'neg_').replace('.', '_')
1216 1217
        return cname

1218 1219
    def new_const_cname(self, prefix='', value=''):
        value = replace_identifier('_', value)[:32].strip('_')
1220 1221 1222
        used = self.const_cnames_used
        name_suffix = value
        while name_suffix in used:
1223
            counter = used[value] = used[value] + 1
1224
            name_suffix = '%s_%d' % (value, counter)
1225
        used[name_suffix] = 1
1226 1227 1228 1229 1230
        if prefix:
            prefix = Naming.interned_prefixes[prefix]
        else:
            prefix = Naming.const_prefix
        return "%s%s" % (prefix, name_suffix)
1231

1232 1233
    def get_cached_unbound_method(self, type_cname, method_name, args_count):
        key = (type_cname, method_name, args_count)
1234 1235 1236 1237 1238 1239 1240
        try:
            cname = self.cached_cmethods[key]
        except KeyError:
            cname = self.cached_cmethods[key] = self.new_const_cname(
                'umethod', '%s_%s' % (type_cname, method_name))
        return cname

1241
    def add_cached_builtin_decl(self, entry):
1242
        if entry.is_builtin and entry.is_const:
1243 1244
            if self.should_declare(entry.cname, entry):
                self.put_pyobject_decl(entry)
1245
                w = self.parts['cached_builtins']
1246 1247 1248 1249
                condition = None
                if entry.name in non_portable_builtins_map:
                    condition, replacement = non_portable_builtins_map[entry.name]
                    w.putln('#if %s' % condition)
1250
                    self.put_cached_builtin_init(
1251
                        entry.pos, StringEncoding.EncodedString(replacement),
1252
                        entry.cname)
1253 1254 1255 1256
                    w.putln('#else')
                self.put_cached_builtin_init(
                    entry.pos, StringEncoding.EncodedString(entry.name),
                    entry.cname)
1257
                if condition:
1258 1259 1260 1261 1262
                    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
1263 1264 1265
        self.use_utility_code(
            UtilityCode.load_cached("GetBuiltinName", "ObjectHandling.c"))
        w.putln('%s = __Pyx_GetBuiltinName(%s); if (!%s) %s' % (
1266 1267 1268 1269
            cname,
            interned_cname,
            cname,
            w.error_goto(pos)))
1270 1271

    def generate_const_declarations(self):
1272
        self.generate_cached_methods_decls()
1273
        self.generate_string_constants()
Stefan Behnel's avatar
Stefan Behnel committed
1274
        self.generate_num_constants()
1275 1276 1277 1278 1279 1280
        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
1281
        decls_writer = self.parts['decls']
1282
        for _, cname, c in consts:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1283
            decls_writer.putln(
1284
                "static %s;" % c.type.declaration_code(cname))
1285

1286 1287 1288 1289
    def generate_cached_methods_decls(self):
        if not self.cached_cmethods:
            return

1290 1291
        decl = self.parts['decls']
        init = self.parts['init_globals']
1292
        cnames = []
1293
        for (type_cname, method_name, _), cname in sorted(self.cached_cmethods.items()):
1294 1295
            cnames.append(cname)
            method_name_cname = self.get_interned_identifier(StringEncoding.EncodedString(method_name)).cname
1296 1297 1298 1299 1300
            decl.putln('static __Pyx_CachedCFunction %s = {0, &%s, 0, 0, 0};' % (
                cname, method_name_cname))
            # split type reference storage as it might not be static
            init.putln('%s.type = (PyObject*)&%s;' % (
                cname, type_cname))
1301 1302 1303 1304 1305 1306

        if Options.generate_cleanup_code:
            cleanup = self.parts['cleanup_globals']
            for cname in cnames:
                cleanup.putln("Py_CLEAR(%s.method);" % cname)

1307
    def generate_string_constants(self):
1308
        c_consts = [(len(c.cname), c.cname, c) for c in self.string_const_index.values()]
1309 1310
        c_consts.sort()
        py_strings = []
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1311

1312
        decls_writer = self.parts['string_decls']
1313
        for _, cname, c in c_consts:
1314 1315 1316 1317 1318
            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 '>='))
1319
            decls_writer.putln('static const char %s[] = "%s";' % (
1320
                cname, StringEncoding.split_string_literal(c.escaped_value)))
1321 1322
            if conditional:
                decls_writer.putln("#endif")
1323
            if c.py_strings is not None:
Stefan Behnel's avatar
Stefan Behnel committed
1324
                for py_string in c.py_strings.values():
1325 1326
                    py_strings.append((c.cname, len(py_string.cname), py_string))

1327
        for c, cname in sorted(self.pyunicode_ptr_const_index.items()):
1328
            utf16_array, utf32_array = StringEncoding.encode_pyunicode_string(c)
1329 1330
            if utf16_array:
                # Narrow and wide representations differ
Nikita Nemkin's avatar
Nikita Nemkin committed
1331
                decls_writer.putln("#ifdef Py_UNICODE_WIDE")
1332 1333 1334 1335 1336
            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")
1337

1338
        if py_strings:
1339
            self.use_utility_code(UtilityCode.load_cached("InitStrings", "StringTools.c"))
1340
            py_strings.sort()
1341 1342 1343
            w = self.parts['pystring_table']
            w.putln("")
            w.putln("static __Pyx_StringTabEntry %s[] = {" %
1344 1345
                                      Naming.stringtab_cname)
            for c_cname, _, py_string in py_strings:
1346 1347 1348 1349 1350 1351 1352
                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
1353
                decls_writer.putln(
1354
                    "static PyObject *%s;" % py_string.cname)
1355 1356 1357 1358 1359 1360 1361
                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,
1362 1363
                        '0', 1, 0,
                        py_string.intern
1364 1365
                        ))
                    w.putln("#else")
1366
                w.putln(
1367
                    "{&%s, %s, sizeof(%s), %s, %d, %d, %d}," % (
1368 1369 1370
                    py_string.cname,
                    c_cname,
                    c_cname,
1371 1372 1373 1374
                    encoding,
                    py_string.is_unicode,
                    py_string.is_str,
                    py_string.intern
1375
                    ))
1376 1377
                if py_string.py3str_cstring:
                    w.putln("#endif")
1378
            w.putln("{0, 0, 0, 0, 0, 0, 0}")
1379
            w.putln("};")
1380

1381 1382
            init_globals = self.parts['init_globals']
            init_globals.putln(
1383 1384
                "if (__Pyx_InitStrings(%s) < 0) %s;" % (
                    Naming.stringtab_cname,
1385
                    init_globals.error_goto(self.module_pos)))
1386

Stefan Behnel's avatar
Stefan Behnel committed
1387
    def generate_num_constants(self):
1388
        consts = [(c.py_type, c.value[0] == '-', len(c.value), c.value, c.value_code, c)
Stefan Behnel's avatar
Stefan Behnel committed
1389
                  for c in self.num_const_index.values()]
1390
        consts.sort()
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1391
        decls_writer = self.parts['decls']
Stefan Behnel's avatar
Stefan Behnel committed
1392
        init_globals = self.parts['init_globals']
1393
        for py_type, _, _, value, value_code, c in consts:
1394
            cname = c.cname
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1395
            decls_writer.putln("static PyObject *%s;" % cname)
Stefan Behnel's avatar
Stefan Behnel committed
1396
            if py_type == 'float':
Stefan Behnel's avatar
Stefan Behnel committed
1397
                function = 'PyFloat_FromDouble(%s)'
Stefan Behnel's avatar
Stefan Behnel committed
1398
            elif py_type == 'long':
Stefan Behnel's avatar
Stefan Behnel committed
1399
                function = 'PyLong_FromString((char *)"%s", 0, 0)'
1400
            elif Utils.long_literal(value):
Stefan Behnel's avatar
Stefan Behnel committed
1401
                function = 'PyInt_FromString((char *)"%s", 0, 0)'
1402 1403
            elif len(value.lstrip('-')) > 4:
                function = "PyInt_FromLong(%sL)"
1404
            else:
Stefan Behnel's avatar
Stefan Behnel committed
1405 1406 1407
                function = "PyInt_FromLong(%s)"
            init_globals.putln('%s = %s; %s' % (
                cname, function % value_code,
1408
                init_globals.error_goto_if_null(cname, self.module_pos)))
1409

1410 1411 1412
    # 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
1413
    # to see quickly how BlockNode worked, until this is replaced.
1414

1415 1416 1417
    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
1418
            assert str(entry.type) == str(other.type)
1419 1420 1421 1422 1423 1424 1425 1426 1427
            assert entry.init == other.init
            return False
        else:
            self.declared_cnames[cname] = entry
            return True

    #
    # File name state
    #
1428

1429
    def lookup_filename(self, source_desc):
1430
        try:
1431
            index = self.filename_table[source_desc.get_filenametable_entry()]
1432 1433
        except KeyError:
            index = len(self.filename_list)
1434 1435
            self.filename_list.append(source_desc)
            self.filename_table[source_desc.get_filenametable_entry()] = index
1436 1437 1438 1439 1440 1441
        return index

    def commented_file_contents(self, source_desc):
        try:
            return self.input_file_contents[source_desc]
        except KeyError:
1442 1443 1444 1445
            pass
        source_file = source_desc.get_lines(encoding='ASCII',
                                            error_handling='ignore')
        try:
1446 1447
            F = [u' * ' + line.rstrip().replace(
                    u'*/', u'*[inserted by cython to avoid comment closer]/'
1448 1449
                    ).replace(
                    u'/*', u'/[inserted by cython to avoid comment start]*'
1450
                    )
1451 1452 1453 1454 1455 1456 1457
                 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
1458

1459 1460 1461
    #
    # Utility code state
    #
1462

1463
    def use_utility_code(self, utility_code):
1464
        """
1465 1466 1467 1468
        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
1469

1470
        See UtilityCode.
1471
        """
1472 1473 1474
        if utility_code not in self.utility_codes:
            self.utility_codes.add(utility_code)
            utility_code.put_code(self)
1475

1476

1477
def funccontext_property(name):
1478
    attribute_of = operator.attrgetter(name)
1479
    def get(self):
1480
        return attribute_of(self.funcstate)
1481
    def set(self, value):
1482
        setattr(self.funcstate, name, value)
1483 1484
    return property(get, set)

1485

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
class CCodeConfig(object):
    # emit_linenums       boolean         write #line pragmas?
    # emit_code_comments  boolean         copy the original code into C comments?
    # c_line_in_traceback boolean         append the c file and line number to the traceback for exceptions?

    def __init__(self, emit_linenums=True, emit_code_comments=True, c_line_in_traceback=True):
        self.emit_code_comments = emit_code_comments
        self.emit_linenums = emit_linenums
        self.c_line_in_traceback = c_line_in_traceback


1497
class CCodeWriter(object):
1498
    """
1499
    Utility class to output C code.
1500

1501
    When creating an insertion point one must care about the state that is
1502
    kept:
1503 1504
    - formatting state (level, bol) is cloned and used in insertion points
      as well
1505 1506
    - 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
1507 1508 1509 1510 1511
      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.
1512
    """
1513

1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
    # 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.)
    # pyclass_stack       list            used during recursive code generation to pass information
    #                                     about the current class one is in
1526
    # code_config         CCodeConfig     configuration options for the C code writer
1527

1528
    globalstate = code_config = None
1529

1530
    def __init__(self, create_from=None, buffer=None, copy_formatting=False):
1531 1532
        if buffer is None: buffer = StringIOTree()
        self.buffer = buffer
1533 1534
        self.last_pos = None
        self.last_marked_pos = None
1535
        self.pyclass_stack = []
1536

1537 1538
        self.funcstate = None
        self.level = 0
Robert Bradshaw's avatar
Robert Bradshaw committed
1539
        self.call_level = 0
1540
        self.bol = 1
1541 1542

        if create_from is not None:
1543
            # Use same global state
1544
            self.set_global_state(create_from.globalstate)
1545
            self.funcstate = create_from.funcstate
1546
            # Clone formatting state
1547 1548 1549
            if copy_formatting:
                self.level = create_from.level
                self.bol = create_from.bol
Robert Bradshaw's avatar
Robert Bradshaw committed
1550
                self.call_level = create_from.call_level
1551 1552
            self.last_pos = create_from.last_pos
            self.last_marked_pos = create_from.last_marked_pos
1553

1554
    def create_new(self, create_from, buffer, copy_formatting):
1555 1556
        # polymorphic constructor -- very slightly more versatile
        # than using __class__
1557
        result = CCodeWriter(create_from, buffer, copy_formatting)
1558
        return result
1559

1560 1561 1562 1563 1564
    def set_global_state(self, global_state):
        assert self.globalstate is None  # prevent overwriting once it's set
        self.globalstate = global_state
        self.code_config = global_state.code_config

1565 1566 1567
    def copyto(self, f):
        self.buffer.copyto(f)

1568 1569 1570 1571
    def getvalue(self):
        return self.buffer.getvalue()

    def write(self, s):
1572
        # also put invalid markers (lineno 0), to indicate that those lines
Mark Florisson's avatar
Mark Florisson committed
1573
        # have no Cython source code correspondence
1574
        cython_lineno = self.last_marked_pos[1] if self.last_marked_pos else 0
Mark Florisson's avatar
Mark Florisson committed
1575
        self.buffer.markers.extend([cython_lineno] * s.count('\n'))
1576
        self.buffer.write(s)
1577 1578

    def insertion_point(self):
1579
        other = self.create_new(create_from=self, buffer=self.buffer.insertion_point(), copy_formatting=True)
1580 1581
        return other

1582 1583 1584 1585 1586
    def new_writer(self):
        """
        Creates a new CCodeWriter connected to the same global state, which
        can later be inserted using insert.
        """
1587
        return CCodeWriter(create_from=self)
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597

    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)
1598 1599 1600 1601 1602 1603 1604 1605

    # 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")
1606
    return_from_error_cleanup_label = funccontext_property("return_from_error_cleanup_label")
1607
    yield_labels = funccontext_property("yield_labels")
1608 1609

    # Functions delegated to function scope
Dag Sverre Seljebotn's avatar
merge  
Dag Sverre Seljebotn committed
1610
    def new_label(self, name=None):    return self.funcstate.new_label(name)
1611
    def new_error_label(self):         return self.funcstate.new_error_label()
1612
    def new_yield_label(self):         return self.funcstate.new_yield_label()
1613 1614 1615 1616 1617 1618 1619 1620
    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)
1621 1622


1623
    def enter_cfunc_scope(self):
1624
        self.funcstate = FunctionState(self)
1625

1626
    def exit_cfunc_scope(self):
1627
        self.funcstate = None
1628

1629 1630
    # constant handling

Stefan Behnel's avatar
Stefan Behnel committed
1631
    def get_py_int(self, str_value, longness):
1632 1633
        return self.globalstate.get_int_const(str_value, longness).cname

Stefan Behnel's avatar
Stefan Behnel committed
1634 1635 1636
    def get_py_float(self, str_value, value_code):
        return self.globalstate.get_float_const(str_value, value_code).cname

1637 1638
    def get_py_const(self, type, prefix='', cleanup_level=None):
        return self.globalstate.get_py_const(type, prefix, cleanup_level).cname
1639

1640 1641 1642
    def get_string_const(self, text):
        return self.globalstate.get_string_const(text).cname

1643 1644
    def get_pyunicode_ptr_const(self, text):
        return self.globalstate.get_pyunicode_ptr_const(text)
1645

1646 1647 1648 1649
    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
1650

1651 1652 1653
    def get_argument_default_const(self, type):
        return self.globalstate.get_py_const(type).cname

1654 1655 1656 1657
    def intern(self, text):
        return self.get_py_string_const(text)

    def intern_identifier(self, text):
1658
        return self.get_py_string_const(text, identifier=True)
1659

1660 1661 1662
    def get_cached_constants_writer(self):
        return self.globalstate.get_cached_constants_writer()

1663 1664
    # code generation

Stefan Behnel's avatar
Stefan Behnel committed
1665
    def putln(self, code="", safe=False):
1666
        if self.last_pos and self.bol:
William Stein's avatar
William Stein committed
1667
            self.emit_marker()
1668
        if self.code_config.emit_linenums and self.last_marked_pos:
1669 1670
            source_desc, line, _ = self.last_marked_pos
            self.write('\n#line %s "%s"\n' % (line, source_desc.get_escaped_description()))
William Stein's avatar
William Stein committed
1671
        if code:
1672 1673 1674 1675
            if safe:
                self.put_safe(code)
            else:
                self.put(code)
1676
        self.write("\n")
William Stein's avatar
William Stein committed
1677
        self.bol = 1
1678

1679
    def mark_pos(self, pos, trace=True):
1680 1681 1682 1683
        if pos is None:
            return
        if self.last_marked_pos and self.last_marked_pos[:2] == pos[:2]:
            return
1684
        self.last_pos = (pos, trace)
1685

William Stein's avatar
William Stein committed
1686
    def emit_marker(self):
1687 1688
        pos, trace = self.last_pos
        self.last_marked_pos = pos
1689
        self.last_pos = None
1690
        self.write("\n")
1691
        if self.code_config.emit_code_comments:
1692 1693
            self.indent()
            self.write("/* %s */\n" % self._build_marker(pos))
1694
        if trace and self.funcstate and self.funcstate.can_trace and self.globalstate.directives['linetrace']:
1695
            self.indent()
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
            self.write('__Pyx_TraceLine(%d,%d,%s)\n' % (
                pos[1], not self.funcstate.gil_owned, self.error_goto(pos)))

    def _build_marker(self, pos):
        source_desc, line, col = pos
        assert isinstance(source_desc, SourceDescriptor)
        contents = self.globalstate.commented_file_contents(source_desc)
        lines = contents[max(0, line-3):line]  # line numbers start at 1
        lines[-1] += u'             # <<<<<<<<<<<<<<'
        lines += contents[line:line+2]
        return u'"%s":%d\n%s\n' % (source_desc.get_escaped_description(), line, u'\n'.join(lines))
William Stein's avatar
William Stein committed
1707

1708 1709 1710 1711 1712
    def put_safe(self, code):
        # put code, but ignore {}
        self.write(code)
        self.bol = 0

1713
    def put_or_include(self, code, name):
Stefan Behnel's avatar
Stefan Behnel committed
1714
        include_dir = self.globalstate.common_utility_include_dir
1715
        if include_dir and len(code) > 1024:
Stefan Behnel's avatar
Stefan Behnel committed
1716
            include_file = "%s_%s.h" % (
1717
                name, hashlib.md5(code.encode('utf8')).hexdigest())
Stefan Behnel's avatar
Stefan Behnel committed
1718 1719 1720
            path = os.path.join(include_dir, include_file)
            if not os.path.exists(path):
                tmp_path = '%s.tmp%s' % (path, os.getpid())
Stefan Behnel's avatar
Stefan Behnel committed
1721
                with closing(Utils.open_new_file(tmp_path)) as f:
Stefan Behnel's avatar
Stefan Behnel committed
1722 1723 1724 1725
                    f.write(code)
                os.rename(tmp_path, path)
            code = '#include "%s"\n' % path
        self.put(code)
1726

William Stein's avatar
William Stein committed
1727
    def put(self, code):
1728 1729
        if is_self_assignment(code):
            return
1730
        fix_indent = False
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
        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
1743 1744
        if self.bol:
            self.indent()
1745
        self.write(code)
William Stein's avatar
William Stein committed
1746 1747 1748
        self.bol = 0
        if dl > 0:
            self.level += dl
1749
        elif fix_indent:
1750 1751
            self.level += 1

Mark Florisson's avatar
Mark Florisson committed
1752
    def putln_tempita(self, code, **context):
1753
        from ..Tempita import sub
1754
        self.putln(sub(code, **context))
Mark Florisson's avatar
Mark Florisson committed
1755 1756

    def put_tempita(self, code, **context):
1757
        from ..Tempita import sub
1758
        self.put(sub(code, **context))
Mark Florisson's avatar
Mark Florisson committed
1759

William Stein's avatar
William Stein committed
1760
    def increase_indent(self):
Stefan Behnel's avatar
Stefan Behnel committed
1761
        self.level += 1
1762

William Stein's avatar
William Stein committed
1763
    def decrease_indent(self):
Stefan Behnel's avatar
Stefan Behnel committed
1764
        self.level -= 1
1765

William Stein's avatar
William Stein committed
1766 1767 1768
    def begin_block(self):
        self.putln("{")
        self.increase_indent()
1769

William Stein's avatar
William Stein committed
1770 1771 1772
    def end_block(self):
        self.decrease_indent()
        self.putln("}")
1773

William Stein's avatar
William Stein committed
1774
    def indent(self):
1775
        self.write("  " * self.level)
1776

1777 1778 1779
    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
1780
    def put_label(self, lbl):
1781
        if lbl in self.funcstate.labels_used:
1782
            self.putln("%s:;" % lbl)
1783

1784
    def put_goto(self, lbl):
1785
        self.funcstate.use_label(lbl)
1786
        self.putln("goto %s;" % lbl)
1787

1788
    def put_var_declaration(self, entry, storage_class="",
Stefan Behnel's avatar
Stefan Behnel committed
1789
                            dll_linkage=None, definition=True):
1790
        #print "Code.put_var_declaration:", entry.name, "definition =", definition ###
1791 1792
        if entry.visibility == 'private' and not (definition or entry.defined_in_pxd):
            #print "...private and not definition, skipping", entry.cname ###
1793
            return
1794 1795
        if entry.visibility == "private" and not entry.used:
            #print "...private and not used, skipping", entry.cname ###
William Stein's avatar
William Stein committed
1796 1797 1798
            return
        if storage_class:
            self.put("%s " % storage_class)
1799 1800
        if not entry.cf_used:
            self.put('CYTHON_UNUSED ')
1801
        self.put(entry.type.declaration_code(
Stefan Behnel's avatar
Stefan Behnel committed
1802
            entry.cname, dll_linkage=dll_linkage))
William Stein's avatar
William Stein committed
1803
        if entry.init is not None:
1804
            self.put_safe(" = %s" % entry.type.literal_code(entry.init))
1805
        elif entry.type.is_pyobject:
Stefan Behnel's avatar
Stefan Behnel committed
1806
            self.put(" = NULL")
William Stein's avatar
William Stein committed
1807
        self.putln(";")
1808 1809

    def put_temp_declarations(self, func_context):
1810
        for name, type, manage_ref, static in func_context.temps_allocated:
1811 1812 1813
            decl = type.declaration_code(name)
            if type.is_pyobject:
                self.putln("%s = NULL;" % decl)
1814
            elif type.is_memoryviewslice:
1815
                from . import MemoryView
Mark Florisson's avatar
Mark Florisson committed
1816
                self.putln("%s = %s;" % (decl, MemoryView.memslice_entry_init))
1817
            else:
1818
                self.putln("%s%s;" % (static and "static " or "", decl))
1819

1820
        if func_context.should_declare_error_indicator:
1821 1822 1823 1824
            if self.funcstate.uses_error_indicator:
                unused = ''
            else:
                unused = 'CYTHON_UNUSED '
1825
            # Initialize these variables to silence compiler warnings
1826 1827 1828
            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))
1829

1830 1831 1832 1833
    def put_generated_by(self):
        self.putln("/* Generated by Cython %s */" % Version.watermark)
        self.putln("")

1834 1835 1836
    def put_h_guard(self, guard):
        self.putln("#ifndef %s" % guard)
        self.putln("#define %s" % guard)
1837

1838 1839 1840 1841 1842 1843
    def unlikely(self, cond):
        if Options.gcc_branch_hints:
            return 'unlikely(%s)' % cond
        else:
            return cond

1844 1845 1846 1847 1848
    def build_function_modifiers(self, modifiers, mapper=modifier_output_mapper):
        if not modifiers:
            return ''
        return '%s ' % ' '.join([mapper(m,m) for m in modifiers])

1849 1850
    # Python objects and reference counting

William Stein's avatar
William Stein committed
1851 1852
    def entry_as_pyobject(self, entry):
        type = entry.type
1853 1854
        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
1855 1856 1857
            return "(PyObject *)" + entry.cname
        else:
            return entry.cname
1858

William Stein's avatar
William Stein committed
1859
    def as_pyobject(self, cname, type):
1860
        from .PyrexTypes import py_object_type, typecast
William Stein's avatar
William Stein committed
1861
        return typecast(py_object_type, type, cname)
1862

1863
    def put_gotref(self, cname):
1864
        self.putln("__Pyx_GOTREF(%s);" % cname)
1865

1866 1867
    def put_giveref(self, cname):
        self.putln("__Pyx_GIVEREF(%s);" % cname)
1868

1869 1870 1871
    def put_xgiveref(self, cname):
        self.putln("__Pyx_XGIVEREF(%s);" % cname)

Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1872 1873 1874
    def put_xgotref(self, cname):
        self.putln("__Pyx_XGOTREF(%s);" % cname)

1875 1876 1877 1878 1879
    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))
1880

1881
    def put_decref(self, cname, type, nanny=True):
1882
        self._put_decref(cname, type, nanny, null_check=False, clear=False)
1883 1884 1885 1886

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

1888 1889 1890 1891
    def put_var_giveref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_GIVEREF(%s);" % self.entry_as_pyobject(entry))

1892 1893 1894 1895
    def put_var_xgotref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_XGOTREF(%s);" % self.entry_as_pyobject(entry))

1896 1897 1898 1899
    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
1900 1901
    def put_var_incref(self, entry):
        if entry.type.is_pyobject:
1902
            self.putln("__Pyx_INCREF(%s);" % self.entry_as_pyobject(entry))
1903

1904 1905 1906 1907
    def put_var_xincref(self, entry):
        if entry.type.is_pyobject:
            self.putln("__Pyx_XINCREF(%s);" % self.entry_as_pyobject(entry))

1908 1909 1910
    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)
1911

1912
    def put_xdecref(self, cname, type, nanny=True, have_gil=True):
1913 1914
        self._put_decref(cname, type, nanny, null_check=True,
                         have_gil=have_gil, clear=False)
1915

1916 1917 1918
    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)
1919

1920 1921
    def _put_decref(self, cname, type, nanny=True, null_check=False,
                    have_gil=True, clear=False, clear_before_decref=False):
1922
        if type.is_memoryviewslice:
1923
            self.put_xdecref_memoryviewslice(cname, have_gil=have_gil)
1924 1925
            return

1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
        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))
1937
        else:
1938 1939
            self.putln("%s_%sDECREF(%s);" % (
                prefix, X, self.as_pyobject(cname, type)))
William Stein's avatar
William Stein committed
1940

1941 1942 1943 1944 1945 1946
    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
1947 1948
    def put_var_decref(self, entry):
        if entry.type.is_pyobject:
1949
            self.putln("__Pyx_XDECREF(%s);" % self.entry_as_pyobject(entry))
1950

William Stein's avatar
William Stein committed
1951 1952
    def put_var_xdecref(self, entry):
        if entry.type.is_pyobject:
1953
            self.putln("__Pyx_XDECREF(%s);" % self.entry_as_pyobject(entry))
1954

1955 1956 1957
    def put_var_decref_clear(self, entry):
        self._put_var_decref_clear(entry, null_check=False)

William Stein's avatar
William Stein committed
1958
    def put_var_xdecref_clear(self, entry):
1959 1960 1961
        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
1962
        if entry.type.is_pyobject:
1963 1964 1965 1966 1967 1968 1969 1970 1971
            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 '',
1972
                    self.entry_as_pyobject(entry),
1973
                    entry.cname))
1974

1975
    def put_var_decrefs(self, entries, used_only = 0):
William Stein's avatar
William Stein committed
1976
        for entry in entries:
1977 1978 1979 1980 1981
            if not used_only or entry.used:
                if entry.xdecref_cleanup:
                    self.put_var_xdecref(entry)
                else:
                    self.put_var_decref(entry)
1982

William Stein's avatar
William Stein committed
1983 1984 1985
    def put_var_xdecrefs(self, entries):
        for entry in entries:
            self.put_var_xdecref(entry)
1986

William Stein's avatar
William Stein committed
1987 1988 1989
    def put_var_xdecrefs_clear(self, entries):
        for entry in entries:
            self.put_var_xdecref_clear(entry)
1990

1991
    def put_incref_memoryviewslice(self, slice_cname, have_gil=False):
1992
        from . import MemoryView
Mark Florisson's avatar
Mark Florisson committed
1993
        self.globalstate.use_utility_code(MemoryView.memviewslice_init_code)
1994 1995 1996
        self.putln("__PYX_INC_MEMVIEW(&%s, %d);" % (slice_cname, int(have_gil)))

    def put_xdecref_memoryviewslice(self, slice_cname, have_gil=False):
1997
        from . import MemoryView
Mark Florisson's avatar
Mark Florisson committed
1998
        self.globalstate.use_utility_code(MemoryView.memviewslice_init_code)
1999 2000 2001 2002 2003
        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)

2004
    def put_init_to_py_none(self, cname, type, nanny=True):
2005
        from .PyrexTypes import py_object_type, typecast
William Stein's avatar
William Stein committed
2006
        py_none = typecast(type, py_object_type, "Py_None")
2007 2008 2009 2010
        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))
2011

2012
    def put_init_var_to_py_none(self, entry, template = "%s", nanny=True):
William Stein's avatar
William Stein committed
2013 2014
        code = template % entry.cname
        #if entry.type.is_extension_type:
Robert Bradshaw's avatar
Robert Bradshaw committed
2015
        #    code = "((PyObject*)%s)" % code
2016
        self.put_init_to_py_none(code, entry.type, nanny)
2017
        if entry.in_closure:
Stefan Behnel's avatar
Stefan Behnel committed
2018
            self.put_giveref('Py_None')
William Stein's avatar
William Stein committed
2019

2020
    def put_pymethoddef(self, entry, term, allow_skip=True):
2021
        if entry.is_special or entry.name == '__getattribute__':
2022
            if entry.name not in special_py_methods:
2023 2024
                if entry.name == '__getattr__' and not self.globalstate.directives['fast_getattr']:
                    pass
2025 2026 2027
                # 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.
2028
                elif allow_skip:
2029
                    return
2030
        from .TypeSlots import method_coexist
William Stein's avatar
William Stein committed
2031 2032 2033 2034
        if entry.doc:
            doc_code = entry.doc_cname
        else:
            doc_code = 0
2035 2036
        method_flags = entry.signature.method_flags()
        if method_flags:
2037
            if entry.is_special:
2038
                method_flags += [method_coexist]
2039
            self.putln(
2040
                '{"%s", (PyCFunction)%s, %s, %s}%s' % (
2041
                    entry.name,
2042
                    entry.func_cname,
2043
                    "|".join(method_flags),
2044 2045
                    doc_code,
                    term))
2046

2047 2048
    # GIL methods

2049
    def put_ensure_gil(self, declare_gilstate=True, variable=None):
2050 2051 2052 2053 2054 2055
        """
        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.
        """
2056 2057
        self.globalstate.use_utility_code(
            UtilityCode.load_cached("ForceInitThreads", "ModuleSetupCode.c"))
2058
        self.putln("#ifdef WITH_THREAD")
2059 2060 2061 2062 2063
        if not variable:
            variable = '__pyx_gilstate_save'
            if declare_gilstate:
                self.put("PyGILState_STATE ")
        self.putln("%s = PyGILState_Ensure();" % variable)
2064 2065
        self.putln("#endif")

2066
    def put_release_ensured_gil(self, variable=None):
2067 2068 2069
        """
        Releases the GIL, corresponds to `put_ensure_gil`.
        """
2070 2071
        if not variable:
            variable = '__pyx_gilstate_save'
2072
        self.putln("#ifdef WITH_THREAD")
2073
        self.putln("PyGILState_Release(%s);" % variable)
2074 2075
        self.putln("#endif")

2076
    def put_acquire_gil(self, variable=None):
2077 2078 2079 2080
        """
        Acquire the GIL. The thread's thread state must have been initialized
        by a previous `put_release_gil`
        """
2081 2082 2083
        self.putln("#ifdef WITH_THREAD")
        if variable:
            self.putln('_save = %s;' % variable)
2084
        self.putln("Py_BLOCK_THREADS")
2085
        self.putln("#endif")
2086

2087
    def put_release_gil(self, variable=None):
2088 2089
        "Release the GIL, corresponds to `put_acquire_gil`."
        self.putln("#ifdef WITH_THREAD")
2090
        self.putln("PyThreadState *_save;")
2091
        self.putln("Py_UNBLOCK_THREADS")
2092 2093 2094
        if variable:
            self.putln('%s = _save;' % variable)
        self.putln("#endif")
2095

2096 2097
    def declare_gilstate(self):
        self.putln("#ifdef WITH_THREAD")
2098
        self.putln("PyGILState_STATE __pyx_gilstate_save;")
2099 2100
        self.putln("#endif")

2101 2102
    # error handling

Robert Bradshaw's avatar
Robert Bradshaw committed
2103 2104 2105 2106
    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)))

2107
    def put_error_if_unbound(self, pos, entry, in_nogil_context=False):
2108
        from . import ExprNodes
2109
        if entry.from_closure:
2110 2111 2112
            func = '__Pyx_RaiseClosureNameError'
            self.globalstate.use_utility_code(
                ExprNodes.raise_closure_name_error_utility_code)
2113 2114 2115 2116
        elif entry.type.is_memoryviewslice and in_nogil_context:
            func = '__Pyx_RaiseUnboundMemoryviewSliceNogil'
            self.globalstate.use_utility_code(
                ExprNodes.raise_unbound_memoryview_utility_code_nogil)
2117
        else:
2118 2119 2120
            func = '__Pyx_RaiseUnboundLocalError'
            self.globalstate.use_utility_code(
                ExprNodes.raise_unbound_local_error_utility_code)
Mark Florisson's avatar
Mark Florisson committed
2121

2122
        self.putln('if (unlikely(!%s)) { %s("%s"); %s }' % (
Mark Florisson's avatar
Mark Florisson committed
2123 2124 2125 2126
                                entry.type.check_for_null_code(entry.cname),
                                func,
                                entry.name,
                                self.error_goto(pos)))
2127

2128
    def set_error_info(self, pos, used=False):
2129
        self.funcstate.should_declare_error_indicator = True
2130 2131
        if used:
            self.funcstate.uses_error_indicator = True
2132
        if self.code_config.c_line_in_traceback:
2133
            cinfo = " %s = %s;" % (Naming.clineno_cname, Naming.line_c_macro)
Robert Bradshaw's avatar
Robert Bradshaw committed
2134 2135
        else:
            cinfo = ""
2136

2137
        return "%s = %s[%s]; %s = %s;%s" % (
William Stein's avatar
William Stein committed
2138 2139 2140 2141 2142
            Naming.filename_cname,
            Naming.filetable_cname,
            self.lookup_filename(pos[0]),
            Naming.lineno_cname,
            pos[1],
2143
            cinfo)
2144

2145 2146 2147
    def error_goto(self, pos):
        lbl = self.funcstate.error_label
        self.funcstate.use_label(lbl)
2148 2149 2150
        return "__PYX_ERR(%s, %s, %s)" % (
            self.lookup_filename(pos[0]),
            pos[1],
2151
            lbl)
2152 2153 2154

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

Robert Bradshaw's avatar
Robert Bradshaw committed
2156 2157
    def error_goto_if_null(self, cname, pos):
        return self.error_goto_if("!%s" % cname, pos)
2158

Robert Bradshaw's avatar
Robert Bradshaw committed
2159 2160
    def error_goto_if_neg(self, cname, pos):
        return self.error_goto_if("%s < 0" % cname, pos)
2161

Robert Bradshaw's avatar
Robert Bradshaw committed
2162 2163
    def error_goto_if_PyErr(self, pos):
        return self.error_goto_if("PyErr_Occurred()", pos)
2164

William Stein's avatar
William Stein committed
2165
    def lookup_filename(self, filename):
2166
        return self.globalstate.lookup_filename(filename)
William Stein's avatar
William Stein committed
2167

2168
    def put_declare_refcount_context(self):
2169
        self.putln('__Pyx_RefNannyDeclarations')
2170

2171 2172
    def put_setup_refcount_context(self, name, acquire_gil=False):
        if acquire_gil:
2173 2174
            self.globalstate.use_utility_code(
                UtilityCode.load_cached("ForceInitThreads", "ModuleSetupCode.c"))
2175
        self.putln('__Pyx_RefNannySetupContext("%s", %d);' % (name, acquire_gil and 1 or 0))
2176

2177
    def put_finish_refcount_context(self):
2178
        self.putln("__Pyx_RefNannyFinishContext();")
2179

2180 2181 2182 2183
    def put_add_traceback(self, qualified_name):
        """
        Build a Python traceback for propagating exceptions.

2184
        qualified_name should be the qualified name of the function.
2185 2186 2187 2188 2189 2190 2191
        """
        format_tuple = (
            qualified_name,
            Naming.clineno_cname,
            Naming.lineno_cname,
            Naming.filename_cname,
        )
2192
        self.funcstate.uses_error_indicator = True
2193 2194
        self.putln('__Pyx_AddTraceback("%s", %s, %s, %s);' % format_tuple)

2195
    def put_unraisable(self, qualified_name, nogil=False):
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
        """
        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,
2206 2207
            self.globalstate.directives['unraisable_tracebacks'],
            nogil,
2208 2209
        )
        self.funcstate.uses_error_indicator = True
2210
        self.putln('__Pyx_WriteUnraisable("%s", %s, %s, %s, %d, %d);' % format_tuple)
2211 2212 2213
        self.globalstate.use_utility_code(
            UtilityCode.load_cached("WriteUnraisableException", "Exceptions.c"))

2214 2215 2216 2217
    def put_trace_declarations(self):
        self.putln('__Pyx_TraceDeclarations')

    def put_trace_frame_init(self, codeobj=None):
2218 2219
        if codeobj:
            self.putln('__Pyx_TraceFrameInit(%s)' % codeobj)
2220

2221
    def put_trace_call(self, name, pos, nogil=False):
2222 2223
        self.putln('__Pyx_TraceCall("%s", %s[%s], %s, %d, %s);' % (
            name, Naming.filetable_cname, self.lookup_filename(pos[0]), pos[1], nogil, self.error_goto(pos)))
2224

Robert Bradshaw's avatar
Robert Bradshaw committed
2225 2226
    def put_trace_exception(self):
        self.putln("__Pyx_TraceException();")
2227

2228 2229
    def put_trace_return(self, retvalue_cname, nogil=False):
        self.putln("__Pyx_TraceReturn(%s, %d);" % (retvalue_cname, nogil))
Robert Bradshaw's avatar
Robert Bradshaw committed
2230

Mark Florisson's avatar
Mark Florisson committed
2231 2232 2233
    def putln_openmp(self, string):
        self.putln("#ifdef _OPENMP")
        self.putln(string)
2234
        self.putln("#endif /* _OPENMP */")
William Stein's avatar
William Stein committed
2235

2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
    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")

2256
class PyrexCodeWriter(object):
William Stein's avatar
William Stein committed
2257 2258 2259 2260
    # f                file      output file
    # level            int       indentation level

    def __init__(self, outfile_name):
2261
        self.f = Utils.open_new_file(outfile_name)
William Stein's avatar
William Stein committed
2262
        self.level = 0
2263

William Stein's avatar
William Stein committed
2264 2265
    def putln(self, code):
        self.f.write("%s%s\n" % (" " * self.level, code))
2266

William Stein's avatar
William Stein committed
2267 2268
    def indent(self):
        self.level += 1
2269

William Stein's avatar
William Stein committed
2270 2271 2272
    def dedent(self):
        self.level -= 1

2273 2274
class PyxCodeWriter(object):
    """
2275 2276 2277
    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
2278 2279
    """

2280
    def __init__(self, buffer=None, indent_level=0, context=None, encoding='ascii'):
2281 2282 2283
        self.buffer = buffer or StringIOTree()
        self.level = indent_level
        self.context = context
2284
        self.encoding = encoding
2285 2286 2287

    def indent(self, levels=1):
        self.level += levels
2288
        return True
2289 2290 2291 2292 2293 2294

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

    def indenter(self, line):
        """
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304
        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()
2305 2306
        """
        self.putln(line)
2307 2308
        self.indent()
        return True
2309 2310

    def getvalue(self):
2311
        result = self.buffer.getvalue()
2312
        if isinstance(result, bytes):
2313 2314
            result = result.decode(self.encoding)
        return result
2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340

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

2341 2342

class ClosureTempAllocator(object):
2343
    def __init__(self, klass):
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
        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