class Object - ripper: Ruby Standard Library Documentation

# class Object

### Constants

SCRIPT_LINES__

  When a Hash is assigned to `SCRIPT_LINES__` the contents of files loaded after the assignment will be added as an Array of lines with the file name as the key.

### Public Instance Methods

check_arity(h) click to toggle source

    # File ripper/tools/generate.rb, line 151
    def check_arity(h)
      invalid = false
      h.each do |event, list|
        unless list.map {|line, arity| arity }.uniq.size == 1
          invalid = true
          locations = list.map {|line, a| "#{line}:#{a}" }.join(', ')
          $stderr.puts "arity crash [event=#{event}]: #{locations}"
        end
      end
      abort if invalid
    end

generate_eventids1(ids) click to toggle source

    # File ripper/tools/generate.rb, line 92
    def generate_eventids1(ids)
      buf = "".dup
      buf << %Q[#include "ruby/ruby.h"\n]
      buf << %Q[#include "eventids1.h"\n]
      buf << %Q[\n]
      buf << %Q[struct ripper_parser_ids ripper_parser_ids;\n]
      buf << %Q[\n]
      buf << %Q[void\n]
      buf << %Q[ripper_init_eventids1(void)\n]
      buf << %Q[{\n]
      buf << %Q[#define set_id1(name) RIPPER_ID(name) = rb_intern_const("on_"#name)\n]
      ids.each do |id, arity|
        buf << %Q[    set_id1(#{id});\n]
      end
      buf << %Q[}\n]
      buf << %Q[\n]
      buf << %Q[#define intern_sym(name) ID2SYM(rb_intern_const(name))\n]
      buf << %Q[\n]
      buf << %Q[void\n]
      buf << %Q[ripper_init_eventids1_table(VALUE self)\n]
      buf << %Q[{\n]
      buf << %Q[    VALUE h = rb_hash_new();\n]
      buf << %Q[    rb_define_const(self, "PARSER_EVENT_TABLE", h);\n]
      ids.each do |id, arity|
        buf << %Q[    rb_hash_aset(h, intern_sym("#{id}"), INT2FIX(#{arity}));\n]
      end
      buf << %Q[}\n]
      buf
    end

generate_eventids1_h(ids) click to toggle source

    # File ripper/tools/generate.rb, line 73
    def generate_eventids1_h(ids)
      buf = "".dup
      buf << %Q[#ifndef RIPPER_EVENTIDS1\n]
      buf << %Q[#define RIPPER_EVENTIDS1\n]
      buf << %Q[\n]
      buf << %Q[#define RIPPER_ID(n) ripper_parser_ids.id_ ## n\n]
      buf << %Q[void ripper_init_eventids1(void);\n]
      buf << %Q[void ripper_init_eventids1_table(VALUE self);\n]
      buf << %Q[\n]
      buf << %Q[struct ripper_parser_ids {\n]
      ids.each do |id, arity|
        buf << %Q[    ID id_#{id};\n]
      end
      buf << %Q[};\n]
      buf << %Q[\n]
      buf << %Q[#endif /* RIPPER_EVENTIDS1 */\n]
      buf << %Q[\n]
    end

generate_eventids2_table(ids) click to toggle source

    # File ripper/tools/generate.rb, line 122
    def generate_eventids2_table(ids)
      buf = "".dup
      buf << %Q[#include "ruby/ruby.h"\n]
      buf << %Q[\n]
      buf << %Q[#define intern_sym(name) ID2SYM(rb_intern_const(name))\n]
      buf << %Q[\n]
      buf << %Q[void\n]
      buf << %Q[ripper_init_eventids2_table(VALUE self)\n]
      buf << %Q[{\n]
      buf << %Q[    VALUE h = rb_hash_new();\n]
      buf << %Q[    rb_define_const(self, "SCANNER_EVENT_TABLE", h);\n]
      ids.each do |id|
        buf << %Q[    rb_hash_aset(h, intern_sym("#{id}"), INT2FIX(1));\n]
      end
      buf << %Q[}\n]
      buf << %Q[\n]
      buf << %Q[#define RIPPER_EVENTIDS2_TABLE_SIZE #{ids.size}\n]
      buf
    end

generate_line(f, out) { |line| ... } click to toggle source

    # File ripper/tools/preproc.rb, line 56
    def generate_line(f, out)
      while line = f.gets
        case
        when gen = DSL.line?(line, f.lineno)
          out << gen.generate << "\n"
        when line.start_with?("%%")
          out << "%%\n"
          break
        else
          out << yield(line)
        end
      end
    end

grammar(f, out) click to toggle source

    # File ripper/tools/preproc.rb, line 87
    def grammar(f, out)
      generate_line(f, out) do |line|
        case line
        when %r</\*%%%\*/>
          "#if 0\n"
        when %r</\*%>
          "#endif\n"
        when %r<%\*/>
          "\n"
        else
          line
        end
      end
    end

main() click to toggle source

    # File ripper/tools/generate.rb, line 6
    def main
      mode = nil
      ids1src = nil
      ids2src = nil
      output = nil

      parser = @parser = OptionParser.new
      parser.banner = "Usage: #{File.basename($0)} --mode=MODE [--ids1src=PATH] [--ids2src=PATH] [--output=PATH]"
      parser.on('--mode=MODE', 'check, eventids1_h, eventids1, or eventids2table.') {|m|
        mode = m
      }
      parser.on('--ids1src=PATH', 'A source file of event-IDs 1 (parse.y).') {|path|
        ids1src = path
      }
      parser.on('--ids2src=PATH', 'A source file of event-IDs 2 (eventids2.c).') {|path|
        ids2src = path
      }
      parser.on('--output=PATH', 'An output file.') {|path|
        output = path
      }
      parser.on('--help', 'Prints this message and quit.') {
        puts parser.help
        exit true
      }
      begin
        parser.parse!
      rescue OptionParser::ParseError => err
        usage err.message
      end
      usage 'no mode given' unless mode
      case mode
      when 'check'
        usage 'no --ids1src' unless ids1src
        usage 'no --ids2src' unless ids2src
        h = read_ids1_with_locations(ids1src)
        check_arity h
        ids2 = read_ids2(ids2src)
        common = h.keys & ids2
        unless common.empty?
          abort "event crash: #{common.join(' ')}"
        end
        exit 0
      when 'eventids1_h'
        usage 'no --ids1src' unless ids1src
        result = generate_eventids1_h(read_ids1(ids1src))
      when 'eventids1'
        usage 'no --ids1src' unless ids1src
        result = generate_eventids1(read_ids1(ids1src))
      when 'eventids2table'
        usage 'no --ids2src' unless ids2src
        result = generate_eventids2_table(read_ids2(ids2src))
      end
      if output
        File.open(output, 'w') {|f|
          f.write result
        }
      else
        puts result
      end
    end

prelude(f, out) click to toggle source

    # File ripper/tools/preproc.rb, line 70
    def prelude(f, out)
      @exprs = {}
      generate_line(f, out) do |line|
        if (/^enum lex_state_(?:bits|e) \{/ =~ line)..(/^\}/ =~ line)
          case line
          when /^\s*(EXPR_\w+),\s+\/\*(.+)\*\//
            @exprs[$1.chomp("_bit")] = $2.strip
          when /^\s*(EXPR_\w+)\s+=\s+(.+)$/
            name = $1
            val = $2.chomp(",")
            @exprs[name] = "equals to " + (val.start_with?("(") ? "<tt>#{val}</tt>" : "+#{val}+")
          end
        end
        line
      end
    end

process(f, out, path, template) click to toggle source

    # File ripper/tools/preproc.rb, line 48
    def process(f, out, path, template)
      prelude f, out
      grammar f, out
      usercode f, out, path, template
    end

read_ids1(path) click to toggle source

    # File ripper/tools/generate.rb, line 142
    def read_ids1(path)
      strip_locations(read_ids1_with_locations(path))
    end

read_ids1_with_locations(path) click to toggle source

    # File ripper/tools/generate.rb, line 165
    def read_ids1_with_locations(path)
      h = {}
      File.open(path) {|f|
        f.each do |line|
          next if /\A\#\s*define\s+dispatch/ =~ line
          next if /ripper_dispatch/ =~ line
          line.scan(/\bdispatch(\d)\((\w+)/) do |arity, event|
            (h[event] ||= []).push [f.lineno, arity.to_i]
          end
          if gen = DSL.line?(line, f.lineno)
            gen.events.each do |event, arity|
              (h[event] ||= []).push [f.lineno, arity.to_i]
            end
          end
        end
      }
      h
    end

read_ids2(path) click to toggle source

    # File ripper/tools/generate.rb, line 184
    def read_ids2(path)
      src = File.open(path) {|f| f.read}
      ids2 = src.scan(/ID\s+ripper_id_(\w+)/).flatten.uniq.sort
      diff = src.scan(/set_id2\((\w+)\);/).flatten - ids2
      unless diff.empty?
        abort "missing scanner IDs: #{diff}"
      end
      return ids2
    end

strip_locations(h) click to toggle source

    # File ripper/tools/generate.rb, line 146
    def strip_locations(h)
      h.map {|event, list| [event, list.first[1]] }\
          .sort_by {|event, arity| event.to_s }
    end

usage(msg) click to toggle source

    # File ripper/tools/generate.rb, line 67
    def usage(msg)
      $stderr.puts msg
      $stderr.puts @parser.help
      exit false
    end

usercode(f, out, path, template) click to toggle source

    # File ripper/tools/preproc.rb, line 102
    def usercode(f, out, path, template)
      require 'erb'
      lineno = nil
      src = nil
      compiler = ERB::Compiler.new('%-')
      compiler.put_cmd = compiler.insert_cmd = "out.<<"

      if template
        File.open(template) do |f|
          out.clear
          lineno = f.lineno
          src, = compiler.compile(f.read)
          path = template
        end
      else
        lineno = f.lineno
        src, = compiler.compile(f.read)
      end

      eval(src, binding, path, lineno)
    end