Lichen

Annotated generator.py

209:a1890e60bb0d
2016-11-22 Paul Boddie Made buffer initialisation more robust. Fixed list growth from empty and buffer serialisation.
paul@126 1
#!/usr/bin/env python
paul@126 2
paul@126 3
"""
paul@126 4
Generate C code from object layouts and other deduced information.
paul@126 5
paul@126 6
Copyright (C) 2015, 2016 Paul Boddie <paul@boddie.org.uk>
paul@126 7
paul@126 8
This program is free software; you can redistribute it and/or modify it under
paul@126 9
the terms of the GNU General Public License as published by the Free Software
paul@126 10
Foundation; either version 3 of the License, or (at your option) any later
paul@126 11
version.
paul@126 12
paul@126 13
This program is distributed in the hope that it will be useful, but WITHOUT
paul@126 14
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
paul@126 15
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
paul@126 16
details.
paul@126 17
paul@126 18
You should have received a copy of the GNU General Public License along with
paul@126 19
this program.  If not, see <http://www.gnu.org/licenses/>.
paul@126 20
"""
paul@126 21
paul@126 22
from common import CommonOutput
paul@126 23
from encoders import encode_bound_reference, encode_function_pointer, \
paul@136 24
                     encode_instantiator_pointer, \
paul@136 25
                     encode_literal_constant, encode_literal_constant_member, \
paul@159 26
                     encode_literal_constant_value, \
paul@159 27
                     encode_literal_instantiator, encode_literal_reference, \
paul@136 28
                     encode_path, \
paul@150 29
                     encode_predefined_reference, encode_size, \
paul@150 30
                     encode_symbol, encode_tablename, \
paul@132 31
                     encode_type_attribute
paul@126 32
from os import listdir
paul@183 33
from os.path import exists, isdir, join, split
paul@126 34
from referencing import Reference
paul@126 35
paul@126 36
def copy(source, target):
paul@126 37
paul@126 38
    "Copy a text file from 'source' to 'target'."
paul@126 39
paul@126 40
    if isdir(target):
paul@126 41
        target = join(target, split(source)[-1])
paul@126 42
    infile = open(source)
paul@126 43
    outfile = open(target, "w")
paul@126 44
    try:
paul@126 45
        outfile.write(infile.read())
paul@126 46
    finally:
paul@126 47
        outfile.close()
paul@126 48
        infile.close()
paul@126 49
paul@126 50
class Generator(CommonOutput):
paul@126 51
paul@126 52
    "A code generator."
paul@126 53
paul@126 54
    function_type = "__builtins__.core.function"
paul@126 55
paul@158 56
    # NOTE: These must be synchronised with the library.
paul@158 57
paul@136 58
    predefined_constant_members = (
paul@158 59
        ("__builtins__.boolean", "False"),
paul@158 60
        ("__builtins__.boolean", "True"),
paul@136 61
        ("__builtins__.none", "None"),
paul@136 62
        ("__builtins__.notimplemented", "NotImplemented"),
paul@136 63
        )
paul@136 64
paul@159 65
    literal_instantiator_types = (
paul@159 66
        "__builtins__.dict.dict",
paul@159 67
        "__builtins__.list.list",
paul@159 68
        "__builtins__.tuple.tuple",
paul@159 69
        )
paul@159 70
paul@126 71
    def __init__(self, importer, optimiser, output):
paul@126 72
        self.importer = importer
paul@126 73
        self.optimiser = optimiser
paul@126 74
        self.output = output
paul@126 75
paul@183 76
    def to_output(self, debug=False):
paul@126 77
paul@126 78
        "Write the generated code."
paul@126 79
paul@126 80
        self.check_output()
paul@126 81
        self.write_structures()
paul@183 82
        self.copy_templates(debug)
paul@126 83
paul@183 84
    def copy_templates(self, debug=False):
paul@126 85
paul@126 86
        "Copy template files to the generated output directory."
paul@126 87
paul@126 88
        templates = join(split(__file__)[0], "templates")
paul@126 89
paul@126 90
        for filename in listdir(templates):
paul@183 91
            target = self.output
paul@183 92
paul@183 93
            # Handle debug resources.
paul@183 94
paul@183 95
            if filename.endswith("-debug"):
paul@183 96
                if debug:
paul@183 97
                    target = join(self.output, filename[:-len("-debug")])
paul@183 98
                else:
paul@183 99
                    continue
paul@183 100
paul@183 101
            # Handle non-debug resources.
paul@183 102
paul@183 103
            if debug and exists(join(templates, "%s-debug" % filename)):
paul@183 104
                continue
paul@183 105
paul@183 106
            copy(join(templates, filename), target)
paul@126 107
paul@126 108
    def write_structures(self):
paul@126 109
paul@126 110
        "Write structures used by the program."
paul@126 111
paul@126 112
        f_consts = open(join(self.output, "progconsts.h"), "w")
paul@126 113
        f_defs = open(join(self.output, "progtypes.c"), "w")
paul@126 114
        f_decls = open(join(self.output, "progtypes.h"), "w")
paul@126 115
        f_signatures = open(join(self.output, "main.h"), "w")
paul@126 116
        f_code = open(join(self.output, "main.c"), "w")
paul@126 117
paul@126 118
        try:
paul@126 119
            # Output boilerplate.
paul@126 120
paul@126 121
            print >>f_consts, """\
paul@126 122
#ifndef __PROGCONSTS_H__
paul@126 123
#define __PROGCONSTS_H__
paul@126 124
"""
paul@126 125
            print >>f_decls, """\
paul@126 126
#ifndef __PROGTYPES_H__
paul@126 127
#define __PROGTYPES_H__
paul@126 128
paul@126 129
#include "progconsts.h"
paul@126 130
#include "types.h"
paul@126 131
"""
paul@126 132
            print >>f_defs, """\
paul@126 133
#include "progtypes.h"
paul@132 134
#include "progops.h"
paul@126 135
#include "main.h"
paul@126 136
"""
paul@126 137
            print >>f_signatures, """\
paul@126 138
#ifndef __MAIN_H__
paul@126 139
#define __MAIN_H__
paul@126 140
paul@126 141
#include "types.h"
paul@126 142
"""
paul@126 143
            print >>f_code, """\
paul@126 144
#include <string.h>
paul@159 145
#include <stdio.h>
paul@126 146
#include "types.h"
paul@159 147
#include "exceptions.h"
paul@126 148
#include "ops.h"
paul@126 149
#include "progconsts.h"
paul@126 150
#include "progtypes.h"
paul@126 151
#include "progops.h"
paul@126 152
#include "main.h"
paul@126 153
"""
paul@126 154
paul@126 155
            # Generate structure size data.
paul@126 156
paul@126 157
            size_tables = {}
paul@126 158
paul@126 159
            for kind in ["<class>", "<module>", "<instance>"]:
paul@126 160
                size_tables[kind] = {}
paul@126 161
paul@126 162
            for ref, structure in self.optimiser.structures.items():
paul@126 163
                size_tables[ref.get_kind()][ref.get_origin()] = len(structure)
paul@126 164
paul@126 165
            size_tables = size_tables.items()
paul@126 166
            size_tables.sort()
paul@126 167
paul@126 168
            for kind, sizes in size_tables:
paul@150 169
                self.write_size_constants(f_consts, kind, sizes, 0)
paul@126 170
paul@126 171
            # Generate parameter table size data.
paul@126 172
paul@126 173
            min_sizes = {}
paul@126 174
            max_sizes = {}
paul@126 175
paul@126 176
            for path, parameters in self.optimiser.parameters.items():
paul@126 177
                argmin, argmax = self.get_argument_limits(path)
paul@126 178
                min_sizes[path] = argmin
paul@126 179
                max_sizes[path] = argmax
paul@126 180
paul@126 181
                # Record instantiator limits.
paul@126 182
paul@126 183
                if path.endswith(".__init__"):
paul@126 184
                    path = path[:-len(".__init__")]
paul@126 185
paul@126 186
            self.write_size_constants(f_consts, "pmin", min_sizes, 0)
paul@126 187
            self.write_size_constants(f_consts, "pmax", max_sizes, 0)
paul@126 188
paul@132 189
            # Generate parameter codes.
paul@132 190
paul@132 191
            self.write_code_constants(f_consts, self.optimiser.all_paramnames, self.optimiser.arg_locations, "pcode", "ppos")
paul@132 192
paul@126 193
            # Generate attribute codes.
paul@126 194
paul@132 195
            self.write_code_constants(f_consts, self.optimiser.all_attrnames, self.optimiser.locations, "code", "pos")
paul@126 196
paul@126 197
            # Generate table and structure data.
paul@126 198
paul@126 199
            function_instance_attrs = None
paul@126 200
            objects = self.optimiser.attr_table.items()
paul@126 201
            objects.sort()
paul@126 202
paul@126 203
            for ref, indexes in objects:
paul@126 204
                attrnames = self.get_attribute_names(indexes)
paul@126 205
paul@126 206
                kind = ref.get_kind()
paul@126 207
                path = ref.get_origin()
paul@150 208
                table_name = encode_tablename(kind, path)
paul@150 209
                structure_size = encode_size(kind, path)
paul@126 210
paul@126 211
                # Generate structures for classes and modules.
paul@126 212
paul@126 213
                if kind != "<instance>":
paul@126 214
                    structure = []
paul@126 215
                    attrs = self.get_static_attributes(kind, path, attrnames)
paul@126 216
paul@126 217
                    # Set a special instantiator on the class.
paul@126 218
paul@126 219
                    if kind == "<class>":
paul@126 220
                        attrs["__fn__"] = path
paul@126 221
                        attrs["__args__"] = encode_size("pmin", path)
paul@126 222
paul@126 223
                        # Write instantiator declarations based on the
paul@126 224
                        # applicable initialiser.
paul@126 225
paul@126 226
                        init_ref = attrs["__init__"]
paul@126 227
paul@126 228
                        # Write instantiator definitions.
paul@126 229
paul@159 230
                        self.write_instantiator(f_code, f_signatures, path, init_ref)
paul@126 231
paul@126 232
                        # Write parameter table.
paul@126 233
paul@126 234
                        self.make_parameter_table(f_decls, f_defs, path, init_ref.get_origin())
paul@126 235
paul@126 236
                    self.populate_structure(Reference(kind, path), attrs, kind, structure)
paul@136 237
paul@136 238
                    if kind == "<class>":
paul@136 239
                        self.write_instance_structure(f_decls, path, structure_size)
paul@136 240
paul@136 241
                    self.write_structure(f_decls, f_defs, path, table_name, structure_size, structure,
paul@136 242
                        kind == "<class>" and path)
paul@126 243
paul@126 244
                # Record function instance details for function generation below.
paul@126 245
paul@126 246
                else:
paul@126 247
                    attrs = self.get_instance_attributes(path, attrnames)
paul@126 248
                    if path == self.function_type:
paul@126 249
                        function_instance_attrs = attrs
paul@126 250
paul@126 251
                # Write a table for all objects.
paul@126 252
paul@126 253
                table = []
paul@126 254
                self.populate_table(Reference(kind, path), table)
paul@126 255
                self.write_table(f_decls, f_defs, table_name, structure_size, table)
paul@126 256
paul@126 257
            # Generate function instances.
paul@126 258
paul@195 259
            functions = self.importer.function_parameters.keys()
paul@126 260
            functions.sort()
paul@126 261
paul@126 262
            for path in functions:
paul@195 263
paul@195 264
                # Instantiators are generated above.
paul@195 265
paul@195 266
                if self.importer.classes.has_key(path) or not self.importer.get_object(path):
paul@195 267
                    continue
paul@195 268
paul@126 269
                cls = self.function_type
paul@150 270
                table_name = encode_tablename("<instance>", cls)
paul@150 271
                structure_size = encode_size("<instance>", cls)
paul@126 272
paul@126 273
                # Set a special callable attribute on the instance.
paul@126 274
paul@126 275
                function_instance_attrs["__fn__"] = path
paul@126 276
                function_instance_attrs["__args__"] = encode_size("pmin", path)
paul@126 277
paul@126 278
                # Produce two structures where a method is involved.
paul@126 279
paul@195 280
                parent, name = path.rsplit(".", 1)
paul@195 281
                parent_ref = self.importer.get_object(parent)
paul@126 282
                parent_kind = parent_ref and parent_ref.get_kind()
paul@126 283
paul@126 284
                # Populate and write each structure.
paul@126 285
paul@126 286
                if parent_kind == "<class>":
paul@126 287
paul@132 288
                    # A bound version of a method.
paul@132 289
paul@132 290
                    structure = self.populate_function(path, function_instance_attrs, False)
paul@136 291
                    self.write_structure(f_decls, f_defs, encode_bound_reference(path), table_name, structure_size, structure)
paul@132 292
paul@126 293
                    # An unbound version of a method.
paul@126 294
paul@126 295
                    structure = self.populate_function(path, function_instance_attrs, True)
paul@126 296
                    self.write_structure(f_decls, f_defs, path, table_name, structure_size, structure)
paul@126 297
paul@132 298
                else:
paul@132 299
                    # A normal function.
paul@126 300
paul@126 301
                    structure = self.populate_function(path, function_instance_attrs, False)
paul@132 302
                    self.write_structure(f_decls, f_defs, path, table_name, structure_size, structure)
paul@126 303
paul@154 304
                # Functions with defaults need to declare instance structures.
paul@154 305
paul@154 306
                if self.importer.function_defaults.get(path):
paul@154 307
                    self.write_instance_structure(f_decls, path, structure_size)
paul@154 308
paul@126 309
                # Write function declarations.
paul@126 310
                # Signature: __attr <name>(__attr[]);
paul@126 311
paul@126 312
                print >>f_signatures, "__attr %s(__attr args[]);" % encode_function_pointer(path)
paul@126 313
paul@126 314
                # Write parameter table.
paul@126 315
paul@126 316
                self.make_parameter_table(f_decls, f_defs, path, path)
paul@126 317
paul@136 318
            # Generate predefined constants.
paul@136 319
paul@136 320
            for path, name in self.predefined_constant_members:
paul@136 321
                self.make_predefined_constant(f_decls, f_defs, path, name)
paul@136 322
paul@136 323
            # Generate literal constants.
paul@136 324
paul@136 325
            for value, n in self.optimiser.constants.items():
paul@136 326
                self.make_literal_constant(f_decls, f_defs, n, value)
paul@136 327
paul@146 328
            # Finish the main source file.
paul@146 329
paul@146 330
            self.write_main_program(f_code, f_signatures)
paul@146 331
paul@126 332
            # Output more boilerplate.
paul@126 333
paul@126 334
            print >>f_consts, """\
paul@126 335
paul@126 336
#endif /* __PROGCONSTS_H__ */"""
paul@126 337
paul@126 338
            print >>f_decls, """\
paul@126 339
paul@126 340
#define __FUNCTION_TYPE %s
paul@126 341
#define __FUNCTION_INSTANCE_SIZE %s
paul@126 342
paul@126 343
#endif /* __PROGTYPES_H__ */""" % (
paul@126 344
    encode_path(self.function_type),
paul@150 345
    encode_size("<instance>", self.function_type)
paul@126 346
    )
paul@126 347
paul@126 348
            print >>f_signatures, """\
paul@126 349
paul@126 350
#endif /* __MAIN_H__ */"""
paul@126 351
paul@126 352
        finally:
paul@126 353
            f_consts.close()
paul@126 354
            f_defs.close()
paul@126 355
            f_decls.close()
paul@126 356
            f_signatures.close()
paul@126 357
            f_code.close()
paul@126 358
paul@136 359
    def make_literal_constant(self, f_decls, f_defs, n, value):
paul@136 360
paul@136 361
        """
paul@136 362
        Write literal constant details to 'f_decls' (to declare a structure) and
paul@136 363
        to 'f_defs' (to define the contents) for the constant with the number
paul@136 364
        'n' with the given literal 'value'.
paul@136 365
        """
paul@136 366
paul@136 367
        const_path = encode_literal_constant(n)
paul@136 368
        structure_name = encode_literal_reference(n)
paul@136 369
paul@136 370
        # NOTE: This makes assumptions about the __builtins__ structure.
paul@136 371
paul@188 372
        modname = value.__class__.__name__
paul@188 373
        typename = modname == "str" and "string" or modname
paul@188 374
        ref = Reference("<instance>", "__builtins__.%s.%s" % (modname, typename))
paul@136 375
paul@136 376
        self.make_constant(f_decls, f_defs, ref, const_path, structure_name, value)
paul@136 377
paul@136 378
    def make_predefined_constant(self, f_decls, f_defs, path, name):
paul@136 379
paul@136 380
        """
paul@136 381
        Write predefined constant details to 'f_decls' (to declare a structure)
paul@136 382
        and to 'f_defs' (to define the contents) for the constant located in
paul@136 383
        'path' with the given 'name'.
paul@136 384
        """
paul@136 385
paul@136 386
        # Determine the details of the constant.
paul@136 387
paul@136 388
        attr_path = "%s.%s" % (path, name)
paul@136 389
        structure_name = encode_predefined_reference(attr_path)
paul@136 390
        ref = self.importer.get_object(attr_path)
paul@136 391
paul@136 392
        self.make_constant(f_decls, f_defs, ref, attr_path, structure_name)
paul@136 393
paul@136 394
    def make_constant(self, f_decls, f_defs, ref, const_path, structure_name, data=None):
paul@136 395
paul@136 396
        """
paul@136 397
        Write constant details to 'f_decls' (to declare a structure) and to
paul@136 398
        'f_defs' (to define the contents) for the constant described by 'ref'
paul@136 399
        having the given 'path' and 'structure_name' (for the constant structure
paul@136 400
        itself).
paul@136 401
        """
paul@136 402
paul@136 403
        # Obtain the attributes.
paul@136 404
paul@136 405
        cls = ref.get_origin()
paul@136 406
        indexes = self.optimiser.attr_table[ref]
paul@136 407
        attrnames = self.get_attribute_names(indexes)
paul@136 408
        attrs = self.get_instance_attributes(cls, attrnames)
paul@136 409
paul@136 410
        # Set the data, if provided.
paul@136 411
paul@136 412
        if data is not None:
paul@136 413
            attrs["__data__"] = data
paul@136 414
paul@136 415
        # Define the structure details. An object is created for the constant,
paul@136 416
        # but an attribute is provided, referring to the object, for access to
paul@136 417
        # the constant in the program.
paul@136 418
paul@136 419
        structure = []
paul@150 420
        table_name = encode_tablename("<instance>", cls)
paul@150 421
        structure_size = encode_size("<instance>", cls)
paul@136 422
        self.populate_structure(ref, attrs, ref.get_kind(), structure)
paul@136 423
        self.write_structure(f_decls, f_defs, structure_name, table_name, structure_size, structure)
paul@136 424
paul@136 425
        # Define a macro for the constant.
paul@136 426
paul@136 427
        attr_name = encode_path(const_path)
paul@136 428
        print >>f_decls, "#define %s ((__attr) {&%s, &%s})" % (attr_name, structure_name, structure_name)
paul@136 429
paul@126 430
    def make_parameter_table(self, f_decls, f_defs, path, function_path):
paul@126 431
paul@126 432
        """
paul@126 433
        Write parameter table details to 'f_decls' (to declare a table) and to
paul@126 434
        'f_defs' (to define the contents) for the function with the given
paul@126 435
        'path', using 'function_path' to obtain the parameter details. The
paul@126 436
        latter two arguments may differ when describing an instantiator using
paul@126 437
        the details of an initialiser.
paul@126 438
        """
paul@126 439
paul@126 440
        table = []
paul@150 441
        table_name = encode_tablename("<function>", path)
paul@126 442
        structure_size = encode_size("pmax", path)
paul@126 443
        self.populate_parameter_table(function_path, table)
paul@126 444
        self.write_parameter_table(f_decls, f_defs, table_name, structure_size, table)
paul@126 445
paul@126 446
    def write_size_constants(self, f_consts, size_prefix, sizes, padding):
paul@126 447
paul@126 448
        """
paul@126 449
        Write size constants to 'f_consts' for the given 'size_prefix', using
paul@126 450
        the 'sizes' dictionary to populate the definition, adding the given
paul@126 451
        'padding' to the basic sizes.
paul@126 452
        """
paul@126 453
paul@126 454
        print >>f_consts, "enum %s {" % encode_size(size_prefix)
paul@126 455
        first = True
paul@126 456
        for path, size in sizes.items():
paul@126 457
            if not first:
paul@126 458
                print >>f_consts, ","
paul@126 459
            else:
paul@126 460
                first = False
paul@126 461
            f_consts.write("    %s = %d" % (encode_size(size_prefix, path), size + padding))
paul@126 462
        print >>f_consts, "\n    };"
paul@126 463
paul@132 464
    def write_code_constants(self, f_consts, attrnames, locations, code_prefix, pos_prefix):
paul@126 465
paul@126 466
        """
paul@126 467
        Write code constants to 'f_consts' for the given 'attrnames' and
paul@126 468
        attribute 'locations'.
paul@126 469
        """
paul@126 470
paul@132 471
        print >>f_consts, "enum %s {" % encode_symbol(code_prefix)
paul@126 472
        first = True
paul@126 473
        for i, attrname in enumerate(attrnames):
paul@126 474
            if not first:
paul@126 475
                print >>f_consts, ","
paul@126 476
            else:
paul@126 477
                first = False
paul@132 478
            f_consts.write("    %s = %d" % (encode_symbol(code_prefix, attrname), i))
paul@126 479
        print >>f_consts, "\n    };"
paul@126 480
paul@132 481
        print >>f_consts, "enum %s {" % encode_symbol(pos_prefix)
paul@126 482
        first = True
paul@126 483
        for i, attrnames in enumerate(locations):
paul@126 484
            for attrname in attrnames:
paul@126 485
                if not first:
paul@126 486
                    print >>f_consts, ","
paul@126 487
                else:
paul@126 488
                    first = False
paul@132 489
                f_consts.write("    %s = %d" % (encode_symbol(pos_prefix, attrname), i))
paul@126 490
        print >>f_consts, "\n    };"
paul@126 491
paul@126 492
    def write_table(self, f_decls, f_defs, table_name, structure_size, table):
paul@126 493
paul@126 494
        """
paul@126 495
        Write the declarations to 'f_decls' and definitions to 'f_defs' for
paul@126 496
        the object having the given 'table_name' and the given 'structure_size',
paul@126 497
        with 'table' details used to populate the definition.
paul@126 498
        """
paul@126 499
paul@126 500
        print >>f_decls, "extern const __table %s;\n" % table_name
paul@126 501
paul@126 502
        # Write the corresponding definition.
paul@126 503
paul@126 504
        print >>f_defs, "const __table %s = {\n    %s,\n    {\n        %s\n        }\n    };\n" % (
paul@126 505
            table_name, structure_size,
paul@126 506
            ",\n        ".join(table))
paul@126 507
paul@126 508
    def write_parameter_table(self, f_decls, f_defs, table_name, structure_size, table):
paul@126 509
paul@126 510
        """
paul@126 511
        Write the declarations to 'f_decls' and definitions to 'f_defs' for
paul@126 512
        the object having the given 'table_name' and the given 'structure_size',
paul@126 513
        with 'table' details used to populate the definition.
paul@126 514
        """
paul@126 515
paul@126 516
        print >>f_decls, "extern const __ptable %s;\n" % table_name
paul@126 517
paul@126 518
        # Write the corresponding definition.
paul@126 519
paul@126 520
        print >>f_defs, "const __ptable %s = {\n    %s,\n    {\n        %s\n        }\n    };\n" % (
paul@126 521
            table_name, structure_size,
paul@126 522
            ",\n        ".join([("{%s, %s}" % t) for t in table]))
paul@126 523
paul@136 524
    def write_instance_structure(self, f_decls, path, structure_size):
paul@126 525
paul@126 526
        """
paul@136 527
        Write a declaration to 'f_decls' for the object having the given 'path'
paul@136 528
        and the given 'structure_size'.
paul@126 529
        """
paul@126 530
paul@126 531
        # Write an instance-specific type definition for instances of classes.
paul@126 532
        # See: templates/types.h
paul@126 533
paul@126 534
        print >>f_decls, """\
paul@126 535
typedef struct {
paul@126 536
    const __table * table;
paul@126 537
    unsigned int pos;
paul@126 538
    __attr attrs[%s];
paul@126 539
} %s;
paul@136 540
""" % (structure_size, encode_symbol("obj", path))
paul@136 541
paul@136 542
    def write_structure(self, f_decls, f_defs, structure_name, table_name, structure_size, structure, path=None):
paul@126 543
paul@136 544
        """
paul@136 545
        Write the declarations to 'f_decls' and definitions to 'f_defs' for
paul@136 546
        the object having the given 'structure_name', the given 'table_name',
paul@136 547
        and the given 'structure_size', with 'structure' details used to
paul@136 548
        populate the definition.
paul@136 549
        """
paul@126 550
paul@136 551
        if f_decls:
paul@136 552
            print >>f_decls, "extern __obj %s;\n" % encode_path(structure_name)
paul@136 553
paul@136 554
        is_class = path and self.importer.get_object(path).has_kind("<class>")
paul@132 555
        pos = is_class and encode_symbol("pos", encode_type_attribute(path)) or "0"
paul@132 556
paul@132 557
        print >>f_defs, """\
paul@132 558
__obj %s = {
paul@132 559
    &%s,
paul@132 560
    %s,
paul@132 561
    {
paul@132 562
        %s
paul@132 563
    }};
paul@132 564
""" % (
paul@136 565
            encode_path(structure_name), table_name, pos,
paul@126 566
            ",\n        ".join(structure))
paul@126 567
paul@132 568
    def get_argument_limits(self, path):
paul@126 569
paul@132 570
        """
paul@132 571
        Return the argument minimum and maximum for the callable at 'path',
paul@132 572
        adding an argument position for a universal context.
paul@132 573
        """
paul@132 574
paul@126 575
        parameters = self.importer.function_parameters[path]
paul@126 576
        defaults = self.importer.function_defaults.get(path)
paul@132 577
        num_parameters = len(parameters) + 1
paul@132 578
        return num_parameters - (defaults and len(defaults) or 0), num_parameters
paul@126 579
paul@126 580
    def get_attribute_names(self, indexes):
paul@126 581
paul@126 582
        """
paul@126 583
        Given a list of attribute table 'indexes', return a list of attribute
paul@126 584
        names.
paul@126 585
        """
paul@126 586
paul@126 587
        all_attrnames = self.optimiser.all_attrnames
paul@126 588
        attrnames = []
paul@126 589
        for i in indexes:
paul@126 590
            if i is None:
paul@126 591
                attrnames.append(None)
paul@126 592
            else:
paul@126 593
                attrnames.append(all_attrnames[i])
paul@126 594
        return attrnames
paul@126 595
paul@126 596
    def get_static_attributes(self, kind, name, attrnames):
paul@126 597
paul@126 598
        """
paul@126 599
        Return a mapping of attribute names to paths for attributes belonging
paul@126 600
        to objects of the given 'kind' (being "<class>" or "<module>") with
paul@126 601
        the given 'name' and supporting the given 'attrnames'.
paul@126 602
        """
paul@126 603
paul@126 604
        attrs = {}
paul@126 605
paul@126 606
        for attrname in attrnames:
paul@126 607
            if attrname is None:
paul@126 608
                continue
paul@126 609
            if kind == "<class>":
paul@126 610
                path = self.importer.all_class_attrs[name][attrname]
paul@126 611
            elif kind == "<module>":
paul@126 612
                path = "%s.%s" % (name, attrname)
paul@126 613
            else:
paul@126 614
                continue
paul@126 615
paul@126 616
            # The module may be hidden.
paul@126 617
paul@126 618
            attr = self.importer.get_object(path)
paul@126 619
            if not attr:
paul@126 620
                module = self.importer.hidden.get(path)
paul@126 621
                if module:
paul@126 622
                    attr = Reference(module.name, "<module>")
paul@126 623
            attrs[attrname] = attr
paul@126 624
paul@126 625
        return attrs
paul@126 626
paul@126 627
    def get_instance_attributes(self, name, attrnames):
paul@126 628
paul@126 629
        """
paul@126 630
        Return a mapping of attribute names to references for attributes
paul@126 631
        belonging to instances of the class with the given 'name', where the
paul@126 632
        given 'attrnames' are supported.
paul@126 633
        """
paul@126 634
paul@126 635
        consts = self.importer.all_instance_attr_constants[name]
paul@126 636
        attrs = {}
paul@126 637
        for attrname in attrnames:
paul@126 638
            if attrname is None:
paul@126 639
                continue
paul@126 640
            const = consts.get(attrname)
paul@126 641
            attrs[attrname] = const or Reference("<var>", "%s.%s" % (name, attrname))
paul@126 642
        return attrs
paul@126 643
paul@126 644
    def populate_table(self, key, table):
paul@126 645
paul@126 646
        """
paul@126 647
        Traverse the attributes in the determined order for the structure having
paul@126 648
        the given 'key', adding entries to the attribute 'table'.
paul@126 649
        """
paul@126 650
paul@126 651
        for attrname in self.optimiser.structures[key]:
paul@126 652
paul@126 653
            # Handle gaps in the structure.
paul@126 654
paul@126 655
            if attrname is None:
paul@126 656
                table.append("0")
paul@126 657
            else:
paul@126 658
                table.append(encode_symbol("code", attrname))
paul@126 659
paul@126 660
    def populate_parameter_table(self, key, table):
paul@126 661
paul@126 662
        """
paul@126 663
        Traverse the parameters in the determined order for the structure having
paul@126 664
        the given 'key', adding entries to the attribute 'table'.
paul@126 665
        """
paul@126 666
paul@126 667
        for value in self.optimiser.parameters[key]:
paul@126 668
paul@126 669
            # Handle gaps in the structure.
paul@126 670
paul@126 671
            if value is None:
paul@126 672
                table.append(("0", "0"))
paul@126 673
            else:
paul@126 674
                name, pos = value
paul@126 675
                table.append((encode_symbol("pcode", name), pos))
paul@126 676
paul@126 677
    def populate_function(self, path, function_instance_attrs, unbound=False):
paul@126 678
paul@126 679
        """
paul@126 680
        Populate a structure for the function with the given 'path'. The given
paul@126 681
        'attrs' provide the instance attributes, and if 'unbound' is set to a
paul@126 682
        true value, an unbound method structure is produced (as opposed to a
paul@126 683
        callable bound method structure).
paul@126 684
        """
paul@126 685
paul@126 686
        structure = []
paul@174 687
        self.populate_structure(Reference("<function>", path), function_instance_attrs, "<instance>", structure, unbound)
paul@126 688
paul@126 689
        # Append default members.
paul@126 690
paul@126 691
        self.append_defaults(path, structure)
paul@126 692
        return structure
paul@126 693
paul@126 694
    def populate_structure(self, ref, attrs, kind, structure, unbound=False):
paul@126 695
paul@126 696
        """
paul@126 697
        Traverse the attributes in the determined order for the structure having
paul@126 698
        the given 'ref' whose members are provided by the 'attrs' mapping, in a
paul@126 699
        structure of the given 'kind', adding entries to the object 'structure'.
paul@126 700
        If 'unbound' is set to a true value, an unbound method function pointer
paul@126 701
        will be employed, with a reference to the bound method incorporated into
paul@126 702
        the special __fn__ attribute.
paul@126 703
        """
paul@126 704
paul@174 705
        # Populate function instance structures for functions.
paul@174 706
paul@174 707
        if ref.has_kind("<function>"):
paul@174 708
            origin = self.function_type
paul@174 709
            structure_ref = Reference("<instance>", self.function_type)
paul@174 710
paul@174 711
        # Otherwise, just populate the appropriate structures.
paul@126 712
paul@174 713
        else:
paul@174 714
            origin = ref.get_origin()
paul@174 715
            structure_ref = ref
paul@174 716
paul@174 717
        # Refer to instantiator function tables for classes, specific function
paul@174 718
        # tables for individual functions.
paul@174 719
paul@174 720
        ptable = encode_tablename("<function>", ref.get_origin())
paul@174 721
paul@174 722
        for attrname in self.optimiser.structures[structure_ref]:
paul@126 723
paul@126 724
            # Handle gaps in the structure.
paul@126 725
paul@126 726
            if attrname is None:
paul@126 727
                structure.append("{0, 0}")
paul@126 728
paul@126 729
            # Handle non-constant and constant members.
paul@126 730
paul@126 731
            else:
paul@126 732
                attr = attrs[attrname]
paul@126 733
paul@136 734
                # Special function pointer member.
paul@136 735
paul@126 736
                if attrname == "__fn__":
paul@126 737
paul@126 738
                    # Provide bound method references and the unbound function
paul@126 739
                    # pointer if populating methods in a class.
paul@126 740
paul@126 741
                    bound_attr = None
paul@126 742
paul@126 743
                    # Classes offer instantiators.
paul@126 744
paul@126 745
                    if kind == "<class>":
paul@126 746
                        attr = encode_instantiator_pointer(attr)
paul@126 747
paul@126 748
                    # Methods offers references to bound versions and an unbound
paul@126 749
                    # method function.
paul@126 750
paul@126 751
                    elif unbound:
paul@126 752
                        bound_attr = encode_bound_reference(attr)
paul@126 753
                        attr = "__unbound_method"
paul@126 754
paul@126 755
                    # Other functions just offer function pointers.
paul@126 756
paul@126 757
                    else:
paul@126 758
                        attr = encode_function_pointer(attr)
paul@126 759
paul@132 760
                    structure.append("{%s, .fn=%s}" % (bound_attr and ".b=&%s" % bound_attr or "0", attr))
paul@126 761
                    continue
paul@126 762
paul@136 763
                # Special argument specification member.
paul@136 764
paul@126 765
                elif attrname == "__args__":
paul@174 766
                    structure.append("{.min=%s, .ptable=&%s}" % (attr, ptable))
paul@126 767
                    continue
paul@126 768
paul@136 769
                # Special internal data member.
paul@136 770
paul@136 771
                elif attrname == "__data__":
paul@136 772
                    structure.append("{0, .%s=%s}" % (encode_literal_constant_member(attr),
paul@136 773
                                                      encode_literal_constant_value(attr)))
paul@136 774
                    continue
paul@136 775
paul@126 776
                structure.append(self.encode_member(origin, attrname, attr, kind))
paul@126 777
paul@126 778
    def encode_member(self, path, name, ref, structure_type):
paul@126 779
paul@126 780
        """
paul@126 781
        Encode within the structure provided by 'path', the member whose 'name'
paul@126 782
        provides 'ref', within the given 'structure_type'.
paul@126 783
        """
paul@126 784
paul@126 785
        kind = ref.get_kind()
paul@126 786
        origin = ref.get_origin()
paul@126 787
paul@126 788
        # References to constant literals.
paul@126 789
paul@126 790
        if kind == "<instance>":
paul@126 791
            attr_path = "%s.%s" % (path, name)
paul@126 792
paul@126 793
            # Obtain a constant value directly assigned to the attribute.
paul@126 794
paul@126 795
            if self.optimiser.constant_numbers.has_key(attr_path):
paul@126 796
                constant_number = self.optimiser.constant_numbers[attr_path]
paul@126 797
                constant_value = "const%d" % constant_number
paul@126 798
                return "{&%s, &%s} /* %s */" % (constant_value, constant_value, name)
paul@126 799
paul@136 800
        # Predefined constant references.
paul@136 801
paul@136 802
        if (path, name) in self.predefined_constant_members:
paul@136 803
            attr_path = encode_predefined_reference("%s.%s" % (path, name))
paul@136 804
            return "{&%s, &%s} /* %s */" % (attr_path, attr_path, name)
paul@136 805
paul@126 806
        # General undetermined members.
paul@126 807
paul@126 808
        if kind in ("<var>", "<instance>"):
paul@126 809
            return "{0, 0} /* %s */" % name
paul@126 810
paul@126 811
        # Set the context depending on the kind of attribute.
paul@139 812
        # For methods:          {&<parent>, &<attr>}
paul@126 813
        # For other attributes: {&<attr>, &<attr>}
paul@126 814
paul@126 815
        else:
paul@139 816
            if kind == "<function>" and structure_type == "<class>":
paul@139 817
                parent = origin.rsplit(".", 1)[0]
paul@139 818
                context = "&%s" % encode_path(parent)
paul@139 819
            elif kind == "<instance>":
paul@139 820
                context = "&%s" % encode_path(origin)
paul@139 821
            else:
paul@139 822
                context = "0"
paul@126 823
            return "{%s, &%s}" % (context, encode_path(origin))
paul@126 824
paul@126 825
    def append_defaults(self, path, structure):
paul@126 826
paul@126 827
        """
paul@126 828
        For the given 'path', append default parameter members to the given
paul@126 829
        'structure'.
paul@126 830
        """
paul@126 831
paul@126 832
        for name, default in self.importer.function_defaults.get(path):
paul@126 833
            structure.append(self.encode_member(path, name, default, "<instance>"))
paul@126 834
paul@159 835
    def write_instantiator(self, f_code, f_signatures, path, init_ref):
paul@126 836
paul@126 837
        """
paul@159 838
        Write an instantiator to 'f_code', with a signature to 'f_signatures',
paul@159 839
        for instances of the class with the given 'path', with 'init_ref' as the
paul@159 840
        initialiser function reference.
paul@126 841
paul@126 842
        NOTE: This also needs to initialise any __fn__ and __args__ members
paul@126 843
        NOTE: where __call__ is provided by the class.
paul@126 844
        """
paul@126 845
paul@132 846
        parameters = self.importer.function_parameters[init_ref.get_origin()]
paul@126 847
paul@126 848
        print >>f_code, """\
paul@132 849
__attr %s(__attr __args[])
paul@126 850
{
paul@159 851
    /* Allocate the structure. */
paul@132 852
    __args[0] = __new(&%s, &%s, sizeof(%s));
paul@159 853
paul@159 854
    /* Call the initialiser. */
paul@146 855
    %s(__args);
paul@159 856
paul@159 857
    /* Return the allocated object details. */
paul@132 858
    return __args[0];
paul@126 859
}
paul@126 860
""" % (
paul@126 861
    encode_instantiator_pointer(path),
paul@150 862
    encode_tablename("<instance>", path),
paul@150 863
    encode_path(path),
paul@150 864
    encode_symbol("obj", path),
paul@126 865
    encode_function_pointer(init_ref.get_origin())
paul@126 866
    )
paul@126 867
paul@159 868
        print >>f_signatures, "__attr %s(__attr[]);" % encode_instantiator_pointer(path)
paul@159 869
paul@159 870
        # Write additional literal instantiators. These do not call the
paul@159 871
        # initialisers but instead populate the structures directly.
paul@159 872
paul@159 873
        if path in self.literal_instantiator_types:
paul@159 874
            print >>f_code, """\
paul@159 875
__attr %s(__attr __args[], unsigned int number)
paul@159 876
{
paul@159 877
    __attr data;
paul@159 878
paul@159 879
    /* Allocate the structure. */
paul@159 880
    __args[0] = __new(&%s, &%s, sizeof(%s));
paul@159 881
paul@159 882
    /* Allocate a structure for the data. */
paul@159 883
    data = __newdata(__args, number);
paul@159 884
paul@159 885
    /* Store a reference to the data in the object's __data__ attribute. */
paul@159 886
    __store_via_object(__args[0].value, %s, data);
paul@159 887
paul@159 888
    /* Return the allocated object details. */
paul@159 889
    return __args[0];
paul@159 890
}
paul@159 891
""" % (
paul@159 892
    encode_literal_instantiator(path),
paul@159 893
    encode_tablename("<instance>", path),
paul@159 894
    encode_path(path),
paul@159 895
    encode_symbol("obj", path),
paul@159 896
    encode_symbol("pos", "__data__")
paul@159 897
    )
paul@159 898
paul@159 899
        print >>f_signatures, "__attr %s(__attr[], unsigned int);" % encode_literal_instantiator(path)
paul@159 900
paul@146 901
    def write_main_program(self, f_code, f_signatures):
paul@146 902
paul@146 903
        """
paul@146 904
        Write the main program to 'f_code', invoking the program's modules. Also
paul@146 905
        write declarations for module main functions to 'f_signatures'.
paul@146 906
        """
paul@146 907
paul@146 908
        print >>f_code, """\
paul@146 909
int main(int argc, char *argv[])
paul@159 910
{
paul@190 911
    __exc __tmp_exc;
paul@159 912
    __Try
paul@159 913
    {"""
paul@146 914
paul@186 915
        for name in self.importer.order_modules():
paul@146 916
            function_name = "__main_%s" % encode_path(name)
paul@146 917
            print >>f_signatures, "void %s();" % function_name
paul@146 918
paul@161 919
            # Omit the native module.
paul@146 920
paul@186 921
            if name != "native":
paul@146 922
                print >>f_code, """\
paul@165 923
        %s();""" % function_name
paul@146 924
paul@146 925
        print >>f_code, """\
paul@159 926
        return 0;
paul@159 927
    }
paul@190 928
    __Catch(__tmp_exc)
paul@159 929
    {
paul@159 930
        fprintf(stderr, "Program terminated due to exception.\\n");
paul@159 931
        return 1;
paul@159 932
    }
paul@146 933
}
paul@146 934
"""
paul@146 935
paul@126 936
# vim: tabstop=4 expandtab shiftwidth=4