src/compiler/CompileContext.cpp
author David Anderson <dvander@alliedmods.net>
Sat Jan 12 16:35:26 2013 -0800 (2013-01-12)
changeset 260 05de34f712fe
parent 258 241d082d6d89
child 262 c4b1341297e5
permissions -rw-r--r--
Add support for mutually recursive imports.
dvander@195
     1
/*
dvander@195
     2
 * Copyright (C) 2012 David Anderson
dvander@195
     3
 *
dvander@251
     4
 * This file is part of SourcePawn.
dvander@195
     5
 *
dvander@251
     6
 * SourcePawn is free software: you can redistribute it and/or modify it under
dvander@195
     7
 * the terms of the GNU General Public License as published by the Free
dvander@195
     8
 * Software Foundation, either version 3 of the License, or (at your option)
dvander@195
     9
 * any later version.
dvander@195
    10
 * 
dvander@251
    11
 * SourcePawn is distributed in the hope that it will be useful, but WITHOUT ANY
dvander@195
    12
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@195
    13
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
dvander@195
    14
 *
dvander@195
    15
 * You should have received a copy of the GNU General Public License along with
dvander@251
    16
 * SourcePawn. If not, see http://www.gnu.org/licenses/.
dvander@195
    17
 */
dvander@195
    18
#include <stdio.h>
dvander@252
    19
#include <string.h>
dvander@195
    20
#include "../Zone.h"
dvander@195
    21
#include "../Interpreter.h"
dvander@251
    22
#include "../Packages.h"
dvander@251
    23
#include "../FileSystem.h"
dvander@256
    24
#include "../FixedArray.h"
dvander@256
    25
#include "../Vector.h"
dvander@195
    26
#include "Scanner.h"
dvander@195
    27
#include "CompileContext.h"
dvander@195
    28
#include "Parser.h"
dvander@195
    29
#include "NameBinding.h"
dvander@195
    30
#include "SemanticAnalysis.h"
dvander@195
    31
#include "../Spaces-inl.h"
dvander@195
    32
#include "../Heap-inl.h"
dvander@195
    33
dvander@195
    34
using namespace ke;
dvander@195
    35
dvander@195
    36
CompileContext::CompileContext(Zone *zone, const char *file)
dvander@195
    37
  : zone_(zone),
dvander@250
    38
    file_(file),
dvander@250
    39
    active_(NULL)
dvander@195
    40
{
dvander@195
    41
}
dvander@195
    42
dvander@195
    43
CompileContext::~CompileContext()
dvander@195
    44
{
dvander@250
    45
    for (size_t i = 0; i < units_.length(); i++)
dvander@251
    46
        units_[i]->destroy();
dvander@195
    47
}
dvander@195
    48
dvander@195
    49
bool
dvander@251
    50
CompileContext::initialize(Handle<Package> package, const char *name)
dvander@195
    51
{
dvander@251
    52
    size_t len = strlen(name);
dvander@251
    53
    AutoFree<char> path((char *)zone_->malloc(len + 1));
dvander@251
    54
    if (!*path)
dvander@251
    55
        return false;
dvander@251
    56
dvander@251
    57
    strcpy(*path, name);
dvander@251
    58
    if (len > 3 && strcmp(&name[len - 3], ".sp") == 0)
dvander@251
    59
        (*path)[len - 3] = '\0';
dvander@251
    60
dvander@251
    61
    Local<String> strname(zone_, zone_->makeSymbol(*path));
dvander@251
    62
    if (!strname)
dvander@195
    63
        return false;
dvander@195
    64
dvander@256
    65
    PathComponent p(new (zone_->pool()) ScopedRoot<String>(strname), NULL);
dvander@251
    66
dvander@251
    67
    Local<Importable> importable(zone_);
dvander@251
    68
    if (!zone_->packages()->findOrAdd(package, &p, importable.address()))
dvander@251
    69
        return false;
dvander@251
    70
dvander@251
    71
    // If we couldn't find anything on the filesystem to match, we error out
dvander@251
    72
    // early.
dvander@251
    73
    if (!importable) {
dvander@251
    74
        zone_->reportError(Message_CannotImportPath, *path);
dvander@195
    75
        return false;
dvander@251
    76
    }
dvander@251
    77
dvander@251
    78
    if (importable->isModule()) {
dvander@251
    79
        Local<Module> module(zone_, Module::cast(importable));
dvander@251
    80
        if (!add(module))
dvander@251
    81
            return true;
dvander@251
    82
    } else {
dvander@251
    83
        // nyi
dvander@251
    84
        assert(false);
dvander@251
    85
    }
dvander@195
    86
dvander@195
    87
    return true;
dvander@195
    88
}
dvander@195
    89
dvander@195
    90
char *
dvander@251
    91
CompileContext::loadSource(Handle<Module> module, size_t *lengthp)
dvander@195
    92
{
dvander@195
    93
    char *bytes = NULL;
dvander@195
    94
    size_t length;
dvander@195
    95
dvander@251
    96
    FILE *fp = fopen(module->path()->chars(), "rb");
dvander@195
    97
    if (!fp) {
dvander@195
    98
        reportError(SourcePosition(), Message_CantOpenFile);
dvander@195
    99
        return NULL;
dvander@195
   100
    }
dvander@195
   101
dvander@195
   102
    if (fseek(fp, 0, SEEK_END)) {
dvander@195
   103
        reportError(SourcePosition(), Message_ErrorSeekingFile);
dvander@195
   104
        fclose(fp);
dvander@195
   105
        return NULL;
dvander@195
   106
    }
dvander@195
   107
    long size = ftell(fp);
dvander@195
   108
    if (size < 0) {
dvander@195
   109
        reportError(SourcePosition(), Message_ErrorSeekingFile);
dvander@195
   110
        fclose(fp);
dvander@195
   111
        return NULL;
dvander@195
   112
    }
dvander@195
   113
    rewind(fp);
dvander@195
   114
    length = size_t(size);
dvander@195
   115
    bytes = new char[length + 1];
dvander@195
   116
    if (fread(bytes, 1, length, fp) != length) {
dvander@195
   117
        reportError(SourcePosition(), Message_ErrorReadingFile);
dvander@195
   118
        fclose(fp);
dvander@195
   119
        delete [] bytes;
dvander@195
   120
        return NULL;
dvander@195
   121
    }
dvander@195
   122
    fclose(fp);
dvander@195
   123
dvander@195
   124
    *lengthp = length;
dvander@195
   125
    return bytes;
dvander@195
   126
}
dvander@195
   127
dvander@195
   128
bool
dvander@195
   129
CompileContext::parse(TranslationUnit *unit)
dvander@195
   130
{
dvander@195
   131
    assert(!unit->tree_);
dvander@195
   132
dvander@195
   133
    size_t length;
dvander@251
   134
    char *source = loadSource(unit->module(), &length);
dvander@195
   135
    if (!source)
dvander@195
   136
        return false;
dvander@195
   137
dvander@195
   138
    Parser parser(ZONE(), *this, source, length);
dvander@195
   139
    if ((unit->tree_ = parser.parse()) == NULL)
dvander@195
   140
        return false;
dvander@195
   141
dvander@195
   142
    return true;
dvander@195
   143
}
dvander@195
   144
dvander@251
   145
bool
dvander@195
   146
CompileContext::evaluateImports(TranslationUnit *unit)
dvander@195
   147
{
dvander@251
   148
    PoolList<ImportStatement *> *imports = unit->tree()->imports();
dvander@251
   149
dvander@256
   150
    if (!imports->length())
dvander@256
   151
        return true;
dvander@256
   152
dvander@256
   153
    // We're allowed to use Handle<> here instead of ScopedRoot<> because
dvander@256
   154
    // we get the handle from ImportStatement which has a ScopedRoot<>.
dvander@256
   155
    Vector<Handle<Importable> > vec;
dvander@256
   156
dvander@251
   157
    for (size_t i = 0; i < imports->length(); i++) {
dvander@251
   158
        ImportStatement *import = imports->at(i);
dvander@251
   159
dvander@256
   160
        // Crawl the path until we find a valid file to load.
dvander@251
   161
        Local<Importable> obj(zone_);
dvander@251
   162
        Local<Package> package(zone_, unit->module()->parent());
dvander@251
   163
        if (!zone_->packages()->findOrAdd(package, import->path(), obj.address()))
dvander@251
   164
            return false;
dvander@251
   165
        if (!obj) {
dvander@251
   166
            PathComponent *path = import->path();
dvander@251
   167
            while (path->next)
dvander@251
   168
                path = path->next;
dvander@251
   169
            reportError(import->pos(), Message_CannotImportPath, path->name->chars());
dvander@251
   170
            return false;
dvander@251
   171
        }
dvander@195
   172
dvander@251
   173
        // If the object is a package, we will attempt to execute it
dvander@251
   174
        // immediately after resolving imports.
dvander@251
   175
        if (obj->isPackage()) {
dvander@251
   176
            assert(false);
dvander@251
   177
        } else {
dvander@251
   178
            Local<Module> module(zone_, Module::cast(obj));
dvander@251
   179
            if (!add(module))
dvander@251
   180
                return false;
dvander@251
   181
        }
dvander@256
   182
dvander@256
   183
        import->setSource(obj);
dvander@256
   184
        
dvander@256
   185
        // See if there are any duplicates. This is O(n^2), but we expect
dvander@256
   186
        // |n| to be small.
dvander@256
   187
        unsigned index = 0;
dvander@256
   188
        for (; index < vec.length(); index++) {
dvander@256
   189
            if (vec[index] == obj)
dvander@256
   190
                break;
dvander@256
   191
        }
dvander@256
   192
        if (index == vec.length() && !vec.append(import->source()))
dvander@256
   193
            return false;
dvander@256
   194
dvander@256
   195
        import->setImportIndex(index);
dvander@256
   196
    }
dvander@256
   197
dvander@256
   198
    if (!IsUint32MultiplySafe(vec.length(), 2)) {
dvander@256
   199
        zone_->reportAllocationOverflow();
dvander@256
   200
        return false;
dvander@251
   201
    }
dvander@195
   202
dvander@256
   203
    // Create an array of the import and paths.
dvander@256
   204
    Local<FixedArray> importables(zone_, FixedArray::New(zone_, vec.length() * 2, Heap::Tenure_Default));
dvander@256
   205
    if (!importables)
dvander@256
   206
        return false;
dvander@256
   207
dvander@256
   208
    for (unsigned i = 0; i < vec.length(); i++) {
dvander@256
   209
        importables->set(zone_, i * 2, vec[i]);
dvander@256
   210
dvander@256
   211
        unsigned count = 0;
dvander@256
   212
        PathComponent *path = imports->at(i)->path();
dvander@256
   213
        for (PathComponent *iter = path; iter; iter = iter->next)
dvander@256
   214
            count++;
dvander@256
   215
dvander@256
   216
        Local<FixedArray> list(zone_, FixedArray::New(zone_, count, Heap::Tenure_Default));
dvander@256
   217
        if (!list)
dvander@256
   218
            return false;
dvander@256
   219
dvander@256
   220
        count = 0;
dvander@256
   221
        for (PathComponent *iter = path; iter; iter = iter->next, count++)
dvander@256
   222
            list->set(zone_, count, iter->name);
dvander@256
   223
dvander@256
   224
        importables->set(zone_, i * 2 + 1, list);
dvander@256
   225
    }
dvander@256
   226
dvander@256
   227
    unit->module()->setImports(importables);
dvander@251
   228
    return true;
dvander@251
   229
}
dvander@195
   230
dvander@251
   231
bool
dvander@251
   232
CompileContext::add(Handle<Module> module)
dvander@251
   233
{
dvander@260
   234
    if (module->compiled() || module->translationUnit())
dvander@251
   235
        return true;
dvander@251
   236
dvander@251
   237
    TranslationUnit *tu = new (zone_->pool()) TranslationUnit(module);
dvander@251
   238
dvander@251
   239
    if (!unparsed_.append(tu) || !units_.append(tu))
dvander@195
   240
        return false;
dvander@195
   241
dvander@260
   242
    module->setTranslationUnit(tu);
dvander@260
   243
dvander@251
   244
    return true;
dvander@195
   245
}
dvander@195
   246
dvander@195
   247
bool
dvander@195
   248
CompileContext::propagateFailure()
dvander@195
   249
{
dvander@195
   250
    Vector<TranslationUnit *> worklist;
dvander@195
   251
    for (size_t i = 0; i < units_.length(); i++) {
dvander@195
   252
        if (units_[i]->failed() && !worklist.append(units_[i]))
dvander@195
   253
            return false;
dvander@195
   254
    }
dvander@195
   255
dvander@195
   256
    while (!worklist.empty()) {
dvander@195
   257
        TranslationUnit *unit = worklist.popCopy();
dvander@195
   258
        for (size_t i = 0; i < unit->dependents().length(); i++) {
dvander@195
   259
            TranslationUnit *other = unit->dependents().at(i);
dvander@195
   260
            if (other->failed())
dvander@195
   261
                continue;
dvander@195
   262
dvander@250
   263
            other->setDependencyFailed();
dvander@195
   264
            if (!worklist.append(other))
dvander@195
   265
                return false;
dvander@195
   266
        }
dvander@195
   267
    }
dvander@195
   268
dvander@195
   269
    return true;
dvander@195
   270
}
dvander@195
   271
dvander@195
   272
bool
dvander@195
   273
CompileContext::compile()
dvander@195
   274
{
dvander@195
   275
    // Phase 1. Parse all modules we're importing. This process may load new
dvander@258
   276
    // modules off disk and add them to the parse queue.
dvander@195
   277
    while (!unparsed_.empty()) {
dvander@195
   278
        TranslationUnit *unit = unparsed_.popCopy();
dvander@195
   279
dvander@251
   280
        AutoEnterCompileContext enter(*this, unit);
dvander@195
   281
        if (!parse(unit))
dvander@250
   282
            continue;
dvander@195
   283
dvander@250
   284
        evaluateImports(unit);
dvander@195
   285
    }
dvander@195
   286
dvander@195
   287
    // Phase 2. Create scopes and symbol tables for every lexical region with
dvander@195
   288
    // a declaration. This phase excludes declarations created via imports.
dvander@195
   289
    for (size_t i = 0; i < units_.length(); i++) {
dvander@195
   290
        TranslationUnit *unit = units_[i];
dvander@195
   291
        if (unit->failed())
dvander@195
   292
            continue;
dvander@195
   293
dvander@250
   294
        PopulateNamesAndTypes(zone_, *this, unit);
dvander@195
   295
    }
dvander@195
   296
dvander@195
   297
    // Phase 3. Complete imports and bind all names.
dvander@195
   298
    for (size_t i = 0; i < units_.length(); i++) {
dvander@195
   299
        TranslationUnit *unit = units_[i];
dvander@195
   300
        if (unit->failed())
dvander@195
   301
            continue;
dvander@195
   302
dvander@258
   303
        BindGlobals(zone_, *this, unit);
dvander@195
   304
dvander@195
   305
        if (unit->failed())
dvander@195
   306
            continue;
dvander@195
   307
dvander@258
   308
        BindNamesAndTypes(zone_, *this, unit);
dvander@195
   309
    }
dvander@195
   310
dvander@250
   311
    // Phase 4. Now we can finally perform SemA+bytecode compilation.
dvander@195
   312
    for (size_t i = 0; i < units_.length(); i++) {
dvander@195
   313
        TranslationUnit *unit = units_[i];
dvander@195
   314
        if (unit->failed())
dvander@195
   315
            continue;
dvander@195
   316
dvander@250
   317
        AutoEnterCompileContext enter(*this, unit);
dvander@195
   318
        SemanticAnalysis sema(zone_, *this, unit);
dvander@195
   319
        sema.analyze();
dvander@195
   320
    }
dvander@195
   321
dvander@250
   322
    // Phase 5. Run modules.
dvander@195
   323
    for (size_t i = 0; i < units_.length(); i++) {
dvander@195
   324
        TranslationUnit *unit = units_[i];
dvander@258
   325
dvander@258
   326
        // Mark the unit as no longer being translated.
dvander@258
   327
        unit->module()->setTranslationUnit(NULL);
dvander@258
   328
dvander@195
   329
        if (unit->failed())
dvander@250
   330
            break;
dvander@195
   331
dvander@195
   332
        InvokeArgs args;
dvander@195
   333
        if (!zone_->stack().pushModuleFrame(unit->module_, args))
dvander@195
   334
            assert(false);
dvander@195
   335
dvander@195
   336
        ke::LocalSlot slot;
dvander@195
   337
        if (!Interpret(zone_, NULL, &slot))
dvander@195
   338
            assert(false);
dvander@195
   339
    }
dvander@195
   340
dvander@250
   341
    if (Ke::IMessageReporter *reporter = zone_->errorReporter()) {
dvander@250
   342
        for (size_t i = 0; i < units_.length(); i++) {
dvander@250
   343
            TranslationUnit *unit = units_[i];
dvander@250
   344
dvander@250
   345
            // We don't explicitly report errors for dependency failures or OOM
dvander@250
   346
            // (OOM is reported separately (:TODO:) and dep failures are redundant.
dvander@250
   347
            if (!unit->errors()->length())
dvander@250
   348
                continue;
dvander@237
   349
dvander@251
   350
            reporter->beginCompilationErrors(unit->module()->path()->chars());
dvander@250
   351
            for (size_t j = 0; j < unit->errors()->length(); j++) {
dvander@250
   352
                const CompileError &error = unit->errors()->at(j);
dvander@250
   353
                reporter->reportCompilationError(error.message, error.line, error.col);
dvander@250
   354
            }
dvander@250
   355
            reporter->endCompilationErrors();
dvander@250
   356
        }
dvander@250
   357
    }
dvander@250
   358
dvander@250
   359
    return !units_[0]->failed();
dvander@250
   360
}
dvander@250
   361
dvander@250
   362
void
dvander@250
   363
CompileContext::enter(TranslationUnit *unit)
dvander@250
   364
{
dvander@250
   365
    assert(!active_);
dvander@250
   366
    active_ = unit;
dvander@250
   367
}
dvander@250
   368
dvander@250
   369
void
dvander@250
   370
CompileContext::leave()
dvander@250
   371
{
dvander@250
   372
    assert(active_);
dvander@250
   373
    active_ = NULL;
dvander@195
   374
}
dvander@195
   375
dvander@195
   376
void
dvander@195
   377
CompileContext::reportErrorVa(const SourcePosition &pos, Message msg, va_list ap)
dvander@195
   378
{
dvander@250
   379
    const char *report = BuildErrorMessage(Messages[msg].format, ap);
dvander@250
   380
    if (!report) {
dvander@250
   381
        active_->setOutOfMemory();
dvander@250
   382
        return;
dvander@250
   383
    }
dvander@195
   384
dvander@250
   385
    active_->appendError(report, pos.line, pos.col);
dvander@195
   386
}
dvander@195
   387
dvander@195
   388
void
dvander@195
   389
CompileContext::reportError(const SourcePosition &pos, Message msg, ...)
dvander@195
   390
{
dvander@195
   391
    va_list ap;
dvander@195
   392
    va_start(ap, msg);
dvander@195
   393
    reportErrorVa(pos, msg, ap);
dvander@195
   394
    va_end(ap);
dvander@195
   395
}
dvander@250
   396
dvander@251
   397
void
dvander@251
   398
TranslationUnit::destroy()
dvander@250
   399
{
dvander@250
   400
    for (size_t i = 0; i < errors_.length(); i++)
dvander@250
   401
        FreeErrorMessage(errors_[i].message);
dvander@250
   402
}