summary refs log tree commit diff stats
path: root/compiler/pluginsupport.nim
blob: f67942c97926dcc9e4bc40cac69328553d29fa09 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#
#
#           The Nim Compiler
#        (c) Copyright 2015 Andreas Rumpf
#
#    See the file "copying.txt", included in this
#    distribution, for details about the copyright.
#

## Plugin support for the Nim compiler. Right now plugins
## need to be built with the compiler only: plugins using 
## DLLs or the FFI will not work.

import ast, semdata, idents

type
  Transformation* = proc (c: PContext; n: PNode): PNode {.nimcall.}
  Plugin = ref object
    fn, module, package: PIdent
    t: Transformation
    next: Plugin

proc pluginMatches(p: Plugin; s: PSym): bool =
  if s.name.id != p.fn.id:
    return false
  let module = s.skipGenericOwner
  if module == nil or module.kind != skModule or
      module.name.id != p.module.id:
    return false
  let package = module.owner
  if package == nil or package.kind != skPackage or
      package.name.id != p.package.id:
    return false
  return true

var head: Plugin

proc getPlugin*(fn: PSym): Transformation =
  var it = head
  while it != nil:
    if pluginMatches(it, fn): return it.t
    it = it.next

proc registerPlugin*(package, module, fn: string; t: Transformation) =
  let oldHead = head
  head = Plugin(fn: getIdent(fn), module: getIdent(module),
                 package: getIdent(package), t: t, next: oldHead)
// idempotent :(code) void transform_labels(const recipe_ordinal r) { map<string, int> offset; for (int i = 0; i < SIZE(get(Recipe, r).steps); ++i) { const instruction& inst = get(Recipe, r).steps.at(i); if (!inst.is_label) continue; if (is_jump_target(inst.label)) { if (!contains_key(offset, inst.label)) { put(offset, inst.label, i); } else { raise << maybe(get(Recipe, r).name) << "duplicate label '" << inst.label << "'" << end(); // have all jumps skip some random but noticeable and deterministic amount of code put(offset, inst.label, 9999); } } } for (int i = 0; i < SIZE(get(Recipe, r).steps); ++i) { instruction& inst = get(Recipe, r).steps.at(i); if (inst.name == "jump") { if (inst.ingredients.empty()) { raise << maybe(get(Recipe, r).name) << "'" << to_original_string(inst) << "' expects an ingredient but got 0\n" << end(); return; } replace_offset(inst.ingredients.at(0), offset, i, r); } if (inst.name == "jump-if" || inst.name == "jump-unless") { if (SIZE(inst.ingredients) < 2) { raise << maybe(get(Recipe, r).name) << "'" << to_original_string(inst) << "' expects 2 ingredients but got " << SIZE(inst.ingredients) << '\n' << end(); return; } replace_offset(inst.ingredients.at(1), offset, i, r); } if ((inst.name == "loop" || inst.name == "break") && SIZE(inst.ingredients) >= 1) { replace_offset(inst.ingredients.at(0), offset, i, r); } if ((inst.name == "loop-if" || inst.name == "loop-unless" || inst.name == "break-if" || inst.name == "break-unless") && SIZE(inst.ingredients) >= 2) { replace_offset(inst.ingredients.at(1), offset, i, r); } } } void replace_offset(reagent& x, /*const*/ map<string, int>& offset, const int current_offset, const recipe_ordinal r) { if (!is_literal(x)) { raise << maybe(get(Recipe, r).name) << "jump target must be offset or label but is '" << x.original_string << "'\n" << end(); x.set_value(0); // no jump by default return; } if (x.initialized) return; if (is_integer(x.name)) return; // non-labels will be handled like other number operands if (!is_jump_target(x.name)) { raise << maybe(get(Recipe, r).name) << "can't jump to label '" << x.name << "'\n" << end(); x.set_value(0); // no jump by default return; } if (!contains_key(offset, x.name)) { raise << maybe(get(Recipe, r).name) << "can't find label '" << x.name << "'\n" << end(); x.set_value(0); // no jump by default return; } x.set_value(get(offset, x.name) - current_offset); } void test_break_to_label() { run( "def main [\n" " {\n" " {\n" " break +target:label\n" " 1:num <- copy 0\n" " }\n" " }\n" " +target\n" "]\n" ); CHECK_TRACE_DOESNT_CONTAIN("mem: storing 0 in location 1"); } void test_jump_if_to_label() { run( "def main [\n" " {\n" " {\n" " jump-if 1, +target:label\n" " 1:num <- copy 0\n" " }\n" " }\n" " +target\n" "]\n" ); CHECK_TRACE_DOESNT_CONTAIN("mem: storing 0 in location 1"); } void test_loop_unless_to_label() { run( "def main [\n" " {\n" " {\n" " loop-unless 0, +target:label\n" // loop/break with a label don't care about braces " 1:num <- copy 0\n" " }\n" " }\n" " +target\n" "]\n" ); CHECK_TRACE_DOESNT_CONTAIN("mem: storing 0 in location 1"); } void test_jump_runs_code_after_label() { run( "def main [\n" // first a few lines of padding to exercise the offset computation " 1:num <- copy 0\n" " 2:num <- copy 0\n" " 3:num <- copy 0\n" " jump +target:label\n" " 4:num <- copy 0\n" " +target\n" " 5:num <- copy 0\n" "]\n" ); CHECK_TRACE_CONTENTS( "mem: storing 0 in location 5\n" ); CHECK_TRACE_DOESNT_CONTAIN("mem: storing 0 in location 4"); } void test_jump_fails_without_target() { Hide_errors = true; run( "def main [\n" " jump\n" "]\n" ); CHECK_TRACE_CONTENTS( "error: main: 'jump' expects an ingredient but got 0\n" ); } void test_jump_fails_without_target_2() { Hide_errors = true; run( "def main [\n" " jump-if true\n" "]\n" ); CHECK_TRACE_CONTENTS( "error: main: 'jump-if true' expects 2 ingredients but got 1\n" ); } void test_recipe_fails_on_duplicate_jump_target() { Hide_errors = true; run( "def main [\n" " +label\n" " 1:num <- copy 0\n" " +label\n" " 2:num <- copy 0\n" "]\n" ); CHECK_TRACE_CONTENTS( "error: main: duplicate label '+label'\n" ); } void test_jump_ignores_nontarget_label() { Hide_errors = true; run( "def main [\n" // first a few lines of padding to exercise the offset computation " 1:num <- copy 0\n" " 2:num <- copy 0\n" " 3:num <- copy 0\n" " jump $target:label\n" " 4:num <- copy 0\n" " $target\n" " 5:num <- copy 0\n" "]\n" ); CHECK_TRACE_CONTENTS( "error: main: can't jump to label '$target'\n" ); }