picrin/src/macro.c

/**
 * See Copyright Notice in picrin.h
 */

#include "picrin.h"
#include "picrin/pair.h"
#include "picrin/string.h"
#include "picrin/proc.h"
#include "picrin/macro.h"
#include "picrin/lib.h"
#include "picrin/error.h"
#include "picrin/dict.h"

pic_sym
pic_add_rename(pic_state *pic, struct pic_senv *senv, pic_sym sym)
{
  pic_sym rename;

  rename = pic_gensym(pic, sym);
  pic_put_rename(pic, senv, sym, rename);
  return rename;
}

void
pic_put_rename(pic_state *pic, struct pic_senv *senv, pic_sym sym, pic_sym rename)
{
  UNUSED(pic);

  xh_put_int(&senv->map, sym, &rename);
}

bool
pic_find_rename(pic_state *pic, struct pic_senv *senv, pic_sym sym, pic_sym *rename)
{
  xh_entry *e;

  if (! pic_interned_p(pic, sym)) {
    if (rename != NULL) {
      *rename = sym;
    }
    return true;
  }

  if ((e = xh_get_int(&senv->map, sym)) == NULL) {
    return false;
  }
  if (rename != NULL) {
    *rename = xh_val(e, pic_sym);
  }
  return true;
}

static void
define_macro(pic_state *pic, pic_sym rename, struct pic_proc *proc, struct pic_senv *senv)
{
  struct pic_macro *mac;

  mac = (struct pic_macro *)pic_obj_alloc(pic, sizeof(struct pic_macro), PIC_TT_MACRO);
  mac->senv = senv;
  mac->proc = proc;

  xh_put_int(&pic->macros, rename, &mac);
}

static struct pic_macro *
find_macro(pic_state *pic, pic_sym rename)
{
  xh_entry *e;

  if ((e = xh_get_int(&pic->macros, rename)) == NULL) {
    return NULL;
  }
  return xh_val(e, struct pic_macro *);
}

static pic_sym
make_identifier(pic_state *pic, pic_sym sym, struct pic_senv *senv)
{
  pic_sym rename;

  while (true) {
    if (pic_find_rename(pic, senv, sym, &rename)) {
      return rename;
    }
    if (! senv->up)
      break;
    senv = senv->up;
  }
  return pic_gensym(pic, sym);
}

static pic_value macroexpand(pic_state *, pic_value, struct pic_senv *);

static pic_value
macroexpand_symbol(pic_state *pic, pic_sym sym, struct pic_senv *senv)
{
  return pic_sym_value(make_identifier(pic, sym, senv));
}

static pic_value
macroexpand_quote(pic_state *pic, pic_value expr)
{
  return pic_cons(pic, pic_sym_value(pic->rQUOTE), pic_cdr(pic, expr));
}

static pic_value
macroexpand_import(pic_state *pic, pic_value expr)
{
  pic_value spec;

  pic_for_each (spec, pic_cdr(pic, expr)) {
    pic_import(pic, spec);
  }

  return pic_none_value();
}

static pic_value
macroexpand_export(pic_state *pic, pic_value expr)
{
  extern pic_value pic_export_as(pic_state *, pic_sym, pic_sym);
  pic_value spec;
  pic_sym sRENAME, sym, as;

  sRENAME = pic_intern_cstr(pic, "rename");

  pic_for_each (spec, pic_cdr(pic, expr)) {
    if (pic_sym_p(spec)) {
      sym = as = pic_sym(spec);
    }
    else if (pic_list_p(spec) && pic_eq_p(pic_car(pic, spec), pic_sym_value(sRENAME))) {
      if (pic_length(pic, spec) != 3) {
        pic_error(pic, "syntax error");
      }
      if (! pic_sym_p(pic_list_ref(pic, spec, 1))) {
        pic_error(pic, "syntax error");
      }
      sym = pic_sym(pic_list_ref(pic, spec, 1));
      if (! pic_sym_p(pic_list_ref(pic, spec, 2))) {
        pic_error(pic, "syntax error");
      }
      as = pic_sym(pic_list_ref(pic, spec, 2));
    }
    else {
      pic_error(pic, "syntax error");
    }
    /* TODO: warn if symbol is shadowed by local variable */
    pic_export_as(pic, sym, as);
  }

  return pic_none_value();
}

static pic_value
macroexpand_deflibrary(pic_state *pic, pic_value expr)
{
  struct pic_lib *prev = pic->lib;
  pic_value v;

  if (pic_length(pic, expr) < 2) {
    pic_error(pic, "syntax error");
  }

  pic_make_library(pic, pic_cadr(pic, expr));

  pic_try {
    pic_in_library(pic, pic_cadr(pic, expr));

    pic_for_each (v, pic_cddr(pic, expr)) {
      pic_void(pic_eval(pic, v));
    }

    pic_in_library(pic, prev->name);
  }
  pic_catch {
    pic_in_library(pic, prev->name); /* restores pic->lib even if an error occurs */
    pic_throw_error(pic, pic->err);
  }

  return pic_none_value();
}

static pic_value
macroexpand_list(pic_state *pic, pic_value obj, struct pic_senv *senv)
{
  size_t ai = pic_gc_arena_preserve(pic);
  pic_value x, head, tail;

  if (pic_pair_p(obj)) {
    head = macroexpand(pic, pic_car(pic, obj), senv);
    tail = macroexpand_list(pic, pic_cdr(pic, obj), senv);
    x = pic_cons(pic, head, tail);
  } else {
    x = macroexpand(pic, obj, senv);
  }

  pic_gc_arena_restore(pic, ai);
  pic_gc_protect(pic, x);
  return x;
}

static pic_value
macroexpand_lambda(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
  pic_value formal, body;
  struct pic_senv *in;
  pic_value a;

  if (pic_length(pic, expr) < 2) {
    pic_error(pic, "syntax error");
  }

  in = pic_senv_new(pic, senv);

  for (a = pic_cadr(pic, expr); pic_pair_p(a); a = pic_cdr(pic, a)) {
    pic_value v = pic_car(pic, a);

    if (! pic_sym_p(v)) {
      v = macroexpand(pic, v, senv);
    }
    if (! pic_sym_p(v)) {
      pic_error(pic, "syntax error");
    }
    pic_add_rename(pic, in, pic_sym(v));
  }
  if (! pic_sym_p(a)) {
    a = macroexpand(pic, a, senv);
  }
  if (pic_sym_p(a)) {
    pic_add_rename(pic, in, pic_sym(a));
  }
  else if (! pic_nil_p(a)) {
    pic_error(pic, "syntax error");
  }

  formal = macroexpand_list(pic, pic_cadr(pic, expr), in);
  body = macroexpand_list(pic, pic_cddr(pic, expr), in);

  return pic_cons(pic, pic_sym_value(pic->rLAMBDA), pic_cons(pic, formal, body));
}

static pic_value
macroexpand_define(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
  pic_sym sym;
  pic_value formal, body, var, val;

  if (pic_length(pic, expr) < 2) {
    pic_error(pic, "syntax error");
  }

  formal = pic_cadr(pic, expr);
  if (pic_pair_p(formal)) {
    var = pic_car(pic, formal);
  } else {
    if (pic_length(pic, expr) != 3) {
      pic_error(pic, "syntax error");
    }
    var = formal;
  }
  if (! pic_sym_p(var)) {
    var = macroexpand(pic, var, senv);
  }
  if (! pic_sym_p(var)) {
    pic_error(pic, "binding to non-symbol object");
  }
  sym = pic_sym(var);
  if (! pic_find_rename(pic, senv, sym, NULL)) {
    pic_add_rename(pic, senv, sym);
  }
  body = pic_cddr(pic, expr);
  if (pic_pair_p(formal)) {
    val = macroexpand_lambda(pic, pic_cons(pic, pic_false_value(), pic_cons(pic, pic_cdr(pic, formal), body)), senv);
  } else {
    val = macroexpand(pic, pic_car(pic, body), senv);
  }
  return pic_list3(pic, pic_sym_value(pic->rDEFINE), macroexpand_symbol(pic, sym, senv), val);
}

static pic_value
macroexpand_defsyntax(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
  pic_value var, val;
  pic_sym sym, rename;

  if (pic_length(pic, expr) != 3) {
    pic_error(pic, "syntax error");
  }

  var = pic_cadr(pic, expr);
  if (! pic_sym_p(var)) {
    var = macroexpand(pic, var, senv);
  }
  if (! pic_sym_p(var)) {
    pic_error(pic, "binding to non-symbol object");
  }
  sym = pic_sym(var);
  if (! pic_find_rename(pic, senv, sym, &rename)) {
    rename = pic_add_rename(pic, senv, sym);
  }

  val = pic_cadr(pic, pic_cdr(pic, expr));

  pic_try {
    val = pic_eval(pic, val);
  } pic_catch {
    pic_errorf(pic, "macroexpand error while definition: %s", pic_errmsg(pic));
  }

  if (! pic_proc_p(val)) {
    pic_errorf(pic, "macro definition \"~s\" evaluates to non-procedure object", var);
  }

  define_macro(pic, rename, pic_proc_ptr(val), senv);

  return pic_none_value();
}

static pic_value
macroexpand_defmacro(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
  pic_value var, val;
  pic_sym sym, rename;

  if (pic_length(pic, expr) < 2) {
    pic_error(pic, "syntax error");
  }

  var = pic_car(pic, pic_cdr(pic, expr));
  if (pic_pair_p(var)) {
    /* FIXME: unhygienic */
    val = pic_cons(pic, pic_sym_value(pic->sLAMBDA),
                   pic_cons(pic, pic_cdr(pic, var),
                            pic_cdr(pic, pic_cdr(pic, expr))));
    var = pic_car(pic, var);
  }
  else {
    if (pic_length(pic, expr) != 3) {
      pic_error(pic, "syntax_error");
    }
    val = pic_car(pic, pic_cdr(pic, pic_cdr(pic, expr)));
  }
  if (! pic_sym_p(var)) {
    pic_error(pic, "syntax error");
  }
  sym = pic_sym(var);
  if (! pic_find_rename(pic, senv, sym, &rename)) {
    rename = pic_add_rename(pic, senv, sym);
  }

  pic_try {
    val = pic_eval(pic, val);
  } pic_catch {
    pic_errorf(pic, "macroexpand error while definition: %s", pic_errmsg(pic));
  }

  if (! pic_proc_p(val)) {
    pic_errorf(pic, "macro definition \"~s\" evaluates to non-procedure object", var);
  }

  define_macro(pic, rename, pic_proc_ptr(val), NULL);

  return pic_none_value();
}

static pic_value
macroexpand_let_syntax(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
  struct pic_senv *in;
  pic_value formal, v, var, val;
  pic_sym sym, rename;

  in = pic_senv_new(pic, senv);

  if (pic_length(pic, expr) < 2) {
    pic_error(pic, "syntax error");
  }

  formal = pic_cadr(pic, expr);
  if (! pic_list_p(formal)) {
    pic_error(pic, "syntax error");
  }
  pic_for_each (v, formal) {
    var = pic_car(pic, v);
    if (! pic_sym_p(var)) {
      var = macroexpand(pic, var, senv);
    }
    if (! pic_sym_p(var)) {
      pic_error(pic, "binding to non-symbol object");
    }
    sym = pic_sym(var);
    if (! pic_find_rename(pic, in, sym, &rename)) {
      rename = pic_add_rename(pic, in, sym);
    }
    val = pic_eval(pic, pic_cadr(pic, v));
    if (! pic_proc_p(val)) {
      pic_errorf(pic, "macro definition \"~s\" evaluated to non-procedure object", var);
    }
    define_macro(pic, rename, pic_proc_ptr(val), senv);
  }
  return pic_cons(pic, pic_sym_value(pic->rBEGIN), macroexpand_list(pic, pic_cddr(pic, expr), in));
}

static pic_value
macroexpand_macro(pic_state *pic, struct pic_macro *mac, pic_value expr, struct pic_senv *senv)
{
  pic_value v, args;

#if DEBUG
  puts("before expand-1:");
  pic_debug(pic, expr);
  puts("");
#endif

  if (mac->senv == NULL) { /* legacy macro */
    args = pic_cdr(pic, expr);
  }
  else {
    args = pic_list3(pic, expr, pic_obj_value(senv), pic_obj_value(mac->senv));
  }

  pic_try {
    v = pic_apply(pic, mac->proc, args);
  } pic_catch {
    pic_errorf(pic, "macroexpand error while application: %s", pic_errmsg(pic));
  }

#if DEBUG
  puts("after expand-1:");
  pic_debug(pic, v);
  puts("");
#endif

  return macroexpand(pic, v, senv);
}

static pic_value
macroexpand_node(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
#if DEBUG
  printf("[macroexpand] expanding... ");
  pic_debug(pic, expr);
  puts("");
#endif

  switch (pic_type(expr)) {
  case PIC_TT_SYMBOL: {
    return macroexpand_symbol(pic, pic_sym(expr), senv);
  }
  case PIC_TT_PAIR: {
    pic_value car;
    struct pic_macro *mac;

    if (! pic_list_p(expr)) {
      pic_errorf(pic, "cannot macroexpand improper list: ~s", expr);
    }

    car = macroexpand(pic, pic_car(pic, expr), senv);
    if (pic_sym_p(car)) {
      pic_sym tag = pic_sym(car);

      if (tag == pic->rDEFINE_LIBRARY) {
        return macroexpand_deflibrary(pic, expr);
      }
      else if (tag == pic->rIMPORT) {
        return macroexpand_import(pic, expr);
      }
      else if (tag == pic->rEXPORT) {
        return macroexpand_export(pic, expr);
      }
      else if (tag == pic->rDEFINE_SYNTAX) {
        return macroexpand_defsyntax(pic, expr, senv);
      }
      else if (tag == pic->rDEFINE_MACRO) {
        return macroexpand_defmacro(pic, expr, senv);
      }
      else if (tag == pic->rLET_SYNTAX) {
        return macroexpand_let_syntax(pic, expr, senv);
      }
      else if (tag == pic->rLAMBDA) {
        return macroexpand_lambda(pic, expr, senv);
      }
      else if (tag == pic->rDEFINE) {
        return macroexpand_define(pic, expr, senv);
      }
      else if (tag == pic->rQUOTE) {
        return macroexpand_quote(pic, expr);
      }

      if ((mac = find_macro(pic, tag)) != NULL) {
        return macroexpand_macro(pic, mac, expr, senv);
      }
    }

    return pic_cons(pic, car, macroexpand_list(pic, pic_cdr(pic, expr), senv));
  }
  case PIC_TT_EOF:
  case PIC_TT_NIL:
  case PIC_TT_BOOL:
  case PIC_TT_FLOAT:
  case PIC_TT_INT:
  case PIC_TT_CHAR:
  case PIC_TT_STRING:
  case PIC_TT_VECTOR:
  case PIC_TT_BLOB: {
    return expr;
  }
  case PIC_TT_PROC:
  case PIC_TT_PORT:
  case PIC_TT_ERROR:
  case PIC_TT_ENV:
  case PIC_TT_CONT:
  case PIC_TT_UNDEF:
  case PIC_TT_SENV:
  case PIC_TT_MACRO:
  case PIC_TT_LIB:
  case PIC_TT_VAR:
  case PIC_TT_IREP:
  case PIC_TT_DATA:
  case PIC_TT_DICT:
    pic_errorf(pic, "unexpected value type: ~s", expr);
  }
  UNREACHABLE();
}

static pic_value
macroexpand(pic_state *pic, pic_value expr, struct pic_senv *senv)
{
  size_t ai = pic_gc_arena_preserve(pic);
  pic_value v;

  v = macroexpand_node(pic, expr, senv);

  pic_gc_arena_restore(pic, ai);
  pic_gc_protect(pic, v);
  return v;
}

pic_value
pic_macroexpand(pic_state *pic, pic_value expr)
{
  pic_value v;

#if DEBUG
  puts("before expand:");
  pic_debug(pic, expr);
  puts("");
#endif

  v = macroexpand(pic, expr, pic->lib->senv);

#if DEBUG
  puts("after expand:");
  pic_debug(pic, v);
  puts("");
#endif

  return v;
}

struct pic_senv *
pic_senv_new(pic_state *pic, struct pic_senv *up)
{
  struct pic_senv *senv;

  senv = (struct pic_senv *)pic_obj_alloc(pic, sizeof(struct pic_senv), PIC_TT_SENV);
  senv->up = up;
  xh_init_int(&senv->map, sizeof(pic_sym));

  return senv;
}

struct pic_senv *
pic_null_syntactic_environment(pic_state *pic)
{
  struct pic_senv *senv;

  senv = pic_senv_new(pic, NULL);

  pic_define_syntactic_keyword(pic, senv, pic->sDEFINE_LIBRARY, pic->rDEFINE_LIBRARY);
  pic_define_syntactic_keyword(pic, senv, pic->sIMPORT, pic->rIMPORT);
  pic_define_syntactic_keyword(pic, senv, pic->sEXPORT, pic->rEXPORT);

  return senv;
}

void
pic_define_syntactic_keyword(pic_state *pic, struct pic_senv *senv, pic_sym sym, pic_sym rsym)
{
  pic_put_rename(pic, senv, sym, rsym);

  if (pic->lib && pic->lib->senv == senv) {
    pic_export(pic, sym);
  }
}

void
pic_defmacro(pic_state *pic, const char *name, struct pic_proc *macro)
{
  pic_sym sym, rename;

  /* symbol registration */
  sym = pic_intern_cstr(pic, name);
  rename = pic_add_rename(pic, pic->lib->senv, sym);
  define_macro(pic, rename, macro, NULL);

  /* auto export! */
  pic_export(pic, sym);
}

bool
pic_identifier_p(pic_state *pic, pic_value obj)
{
  return pic_sym_p(obj) && ! pic_interned_p(pic, pic_sym(obj));
}

bool
pic_identifier_eq_p(pic_state *pic, struct pic_senv *e1, pic_sym x, struct pic_senv *e2, pic_sym y)
{
  x = make_identifier(pic, x, e1);
  y = make_identifier(pic, y, e2);

  return x == y;
}

static pic_value
pic_macro_gensym(pic_state *pic)
{
  static const char skel[] = ".g";
  pic_sym uniq;

  pic_get_args(pic, "");

  uniq = pic_gensym(pic, pic_intern_cstr(pic, skel));
  return pic_sym_value(uniq);
}

static pic_value
pic_macro_macroexpand(pic_state *pic)
{
  pic_value expr;

  pic_get_args(pic, "o", &expr);

  return pic_macroexpand(pic, expr);
}

static pic_value
pic_macro_identifier_p(pic_state *pic)
{
  pic_value obj;

  pic_get_args(pic, "o", &obj);

  return pic_bool_value(pic_identifier_p(pic, obj));
}

static pic_value
pic_macro_identifier_eq_p(pic_state *pic)
{
  pic_sym x, y;
  pic_value e, f;
  struct pic_senv *e1, *e2;

  pic_get_args(pic, "omom", &e, &x, &f, &y);

  if (! pic_senv_p(e)) {
    pic_error(pic, "unexpected type of argument 1");
  }
  e1 = pic_senv_ptr(e);
  if (! pic_senv_p(f)) {
    pic_error(pic, "unexpected type of argument 3");
  }
  e2 = pic_senv_ptr(f);

  return pic_bool_value(pic_identifier_eq_p(pic, e1, x, e2, y));
}

static pic_value
pic_macro_make_identifier(pic_state *pic)
{
  pic_value obj;
  pic_sym sym;

  pic_get_args(pic, "mo", &sym, &obj);

  pic_assert_type(pic, obj, senv);

  return pic_sym_value(make_identifier(pic, sym, pic_senv_ptr(obj)));
}

void
pic_init_macro(pic_state *pic)
{
  pic_deflibrary ("(picrin macro)") {

    /* export define-macro syntax */
    pic_define_syntactic_keyword(pic, pic->lib->senv, pic->sDEFINE_MACRO, pic->rDEFINE_MACRO);

    pic_defun(pic, "gensym", pic_macro_gensym);
    pic_defun(pic, "macroexpand", pic_macro_macroexpand);
    pic_defun(pic, "identifier?", pic_macro_identifier_p);
    pic_defun(pic, "identifier=?", pic_macro_identifier_eq_p);
    pic_defun(pic, "make-identifier", pic_macro_make_identifier);
  }
}