Lichen

Annotated generator.py

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