calog/vendor/mruby/mrbgems/mruby-proc-ext/src/proc.c

#include <mruby.h>
#include <mruby/class.h>
#include <mruby/proc.h>
#include <mruby/opcode.h>
#include <mruby/array.h>
#include <mruby/string.h>
#include <mruby/debug.h>
#include <mruby/internal.h>

/*
 *  call-seq:
 *     prc.lambda?    -> true or false
 *
 *  Returns `true` if `prc` is a lambda, `false` if it is a proc.
 *  The difference is how they react to a `return` statement. In a lambda,
 *  `return` makes the lambda return. In a proc, `return` makes the method
 *  that called the proc return.
 *
 *     def gen_times(factor)
 *       return proc {|n| n*factor }  # return from the proc
 *     end
 *
 *     times3 = gen_times(3)
 *     times5 = gen_times(5)
 *
 *     times3.lambda?   #=> false
 *     times5.lambda?   #=> false
 *
 *     def gen_times(factor)
 *       return lambda {|n| n*factor }  # return from the lambda
 *     end
 *
 *     times3 = gen_times(3)
 *     times5 = gen_times(5)
 *
 *     times3.lambda?   #=> true
 *     times5.lambda?   #=> true
 */

static mrb_value
proc_lambda_p(mrb_state *mrb, mrb_value self)
{
  struct RProc *p = mrb_proc_ptr(self);
  return mrb_bool_value(MRB_PROC_STRICT_P(p));
}

/* Internal helper function to extract source location from a proc */
mrb_value
mrb_proc_source_location(mrb_state *mrb, const struct RProc *p)
{
  if (MRB_PROC_CFUNC_P(p)) {
    return mrb_nil_value();
  }

  /* handle alias */
  if (MRB_PROC_ALIAS_P(p)) {
    p = p->upper;
  }

  const mrb_irep *irep = p->body.irep;
  int32_t line;
  const char *filename;

  if (!mrb_debug_get_position(mrb, irep, 0, &line, &filename)) {
    return mrb_nil_value();
  }
  return mrb_assoc_new(mrb, mrb_str_new_cstr(mrb, filename), mrb_fixnum_value(line));
}

/*
 *  call-seq:
 *     prc.source_location  -> [filename, line] or nil
 *
 *  Returns the Ruby source filename and line number containing this proc
 *  or `nil` if this proc was not defined in Ruby (i.e. native).
 *
 *     p = proc { puts "hello" }
 *     p.source_location   #=> ["prog.rb", 1]
 */

static mrb_value
proc_source_location(mrb_state *mrb, mrb_value self)
{
  return mrb_proc_source_location(mrb, mrb_proc_ptr(self));
}

/*
 *  call-seq:
 *     prc.to_s    -> string
 *     prc.inspect -> string
 *
 *  Returns the unique identifier for this proc, along with
 *  an indication of where the proc was defined.
 *
 *     p = proc { puts "hello" }
 *     p.inspect   #=> "#<Proc:0x401b2e88@prog.rb:1>"
 *     p.to_s      #=> "#<Proc:0x401b2e88@prog.rb:1>"
 *
 *     l = lambda { puts "hello" }
 *     l.inspect   #=> "#<Proc:0x401b2e88@prog.rb:1 (lambda)>"
 */

static mrb_value
proc_inspect(mrb_state *mrb, mrb_value self)
{
  struct RProc *p = mrb_proc_ptr(self);
  mrb_value str = mrb_str_new_lit(mrb, "#<Proc:");
  mrb_str_cat_str(mrb, str, mrb_ptr_to_str(mrb, p));

  if (!MRB_PROC_CFUNC_P(p)) {
    const mrb_irep *irep = p->body.irep;
    const char *filename;
    int32_t line;
    mrb_str_cat_lit(mrb, str, " ");

    if (mrb_debug_get_position(mrb, irep, 0, &line, &filename)) {
      mrb_str_cat_cstr(mrb, str, filename);
      mrb_str_cat_lit(mrb, str, ":");
      mrb_str_concat(mrb, str, mrb_fixnum_value(line));
    }
    else {
      mrb_str_cat_lit(mrb, str, "-:-");
    }
  }

  if (MRB_PROC_STRICT_P(p)) {
    mrb_str_cat_lit(mrb, str, " (lambda)");
  }

  mrb_str_cat_lit(mrb, str, ">");
  return str;
}

/*
 *  call-seq:
 *     proc { |...| block }  -> a_proc
 *
 *  Equivalent to `Proc.new`.
 *
 *     def proc(&block)
 *       block
 *     end
 *
 *     proc { puts "Hello world" }   #=> #<Proc:0x401b2e88@-e:58>
 */

static mrb_value
kernel_proc(mrb_state *mrb, mrb_value self)
{
  mrb_value blk;

  mrb_get_args(mrb, "&!", &blk);

  return blk;
}

/*
 * call-seq:
 *    prc.parameters  -> array
 *
 * Returns the parameter information of this proc.
 *
 *    prc = lambda{|x, y=42, *other|}
 *    prc.parameters  #=> [[:req, :x], [:opt, :y], [:rest, :other]]
 */

mrb_value
mrb_proc_parameters(mrb_state *mrb, mrb_value self)
{
  struct parameters_type {
    mrb_sym name;
    int size;
  } *p, parameters_list [] = {
    {MRB_SYM(req),    0},
    {MRB_SYM(opt),    0},
    {MRB_SYM(rest),   0},
    {MRB_SYM(req),    0},
    {MRB_SYM(keyrest),0},
    {MRB_SYM(block),  0},
    {MRB_SYM(key),    0},
    {0, 0}
  };
  int i;
  const struct RProc *proc = mrb_proc_ptr(self);
  if (MRB_PROC_CFUNC_P(proc)) {
    /* TODO: cfunc aspec is not implemented yet - C functions don't store argument spec info */
    return mrb_ary_new(mrb);
  }
  const struct mrb_irep *irep = proc->body.irep;
  if (!irep || !irep->lv || *irep->iseq != OP_ENTER) {
    return mrb_ary_new(mrb);
  }

  if (!MRB_PROC_STRICT_P(proc)) {
    parameters_list[0].name = MRB_SYM(opt);
    parameters_list[3].name = MRB_SYM(opt);
  }

  mrb_aspec aspec = PEEK_W(irep->iseq+1);
  parameters_list[0].size = MRB_ASPEC_REQ(aspec);
  parameters_list[1].size = MRB_ASPEC_OPT(aspec);
  parameters_list[2].size = MRB_ASPEC_REST(aspec);
  parameters_list[3].size = MRB_ASPEC_POST(aspec);
  parameters_list[4].size = MRB_ASPEC_KDICT(aspec);
  parameters_list[5].size = MRB_ASPEC_BLOCK(aspec);
  parameters_list[6].size = MRB_ASPEC_KEY(aspec);

  int max = 0;
  for (i = 0; parameters_list[i].name; i++) {
    max += parameters_list[i].size;
  }

  mrb_value parameters = mrb_ary_new_capa(mrb, max);
  mrb_value krest = mrb_nil_value();
  mrb_value block = mrb_nil_value();

  for (i = 0, p = parameters_list; p->name; p++) {
    mrb_value sname = mrb_symbol_value(p->name);

    for (int j = 0; j < p->size; i++, j++) {
      mrb_value a = mrb_ary_new(mrb);
      mrb_ary_push(mrb, a, sname);
      if (i < max && irep->lv[i]) {
        mrb_ary_push(mrb, a, mrb_symbol_value(irep->lv[i]));
      }
      if (p->name == MRB_SYM(block)) {
        if (irep->lv[i+1]) {
          mrb_ary_push(mrb, a, mrb_symbol_value(irep->lv[i+1]));
        }
        block = a; continue;
      }
      if (p->name == MRB_SYM(keyrest)) {
        krest = a; continue;
      }
      mrb_ary_push(mrb, parameters, a);
    }
    /* need to skip empty block slot */
    if (p->size == 0 && p->name == MRB_SYM(block)) i++;
  }
  if (!mrb_nil_p(krest)) mrb_ary_push(mrb, parameters, krest);
  if (!mrb_nil_p(block)) mrb_ary_push(mrb, parameters, block);
  return parameters;
}

/* ---------------------------*/
static const mrb_mt_entry proc_ext_rom_entries[] = {
  MRB_MT_ENTRY(proc_inspect,         MRB_SYM(inspect),      MRB_ARGS_NONE()),
  MRB_MT_ENTRY(proc_lambda_p,        MRB_SYM_Q(lambda),     MRB_ARGS_NONE()),
  MRB_MT_ENTRY(mrb_proc_parameters,  MRB_SYM(parameters),   MRB_ARGS_NONE()),
  MRB_MT_ENTRY(proc_source_location, MRB_SYM(source_location), MRB_ARGS_NONE()),
  MRB_MT_ENTRY(proc_inspect,         MRB_SYM(to_s),         MRB_ARGS_NONE()),
};

void
mrb_mruby_proc_ext_gem_init(mrb_state* mrb)
{
  struct RClass *p = mrb->proc_class;

  MRB_MT_INIT_ROM(mrb, p, proc_ext_rom_entries);
  mrb_define_private_method_id(mrb, mrb->kernel_module, MRB_SYM(proc), kernel_proc, MRB_ARGS_BLOCK());
}

void
mrb_mruby_proc_ext_gem_final(mrb_state* mrb)
{
}