ErrorParser

[derula]

ErrorParser ist ein kleines aber feines Script für RMXP, dass das Debugging erleichtern soll. Es hilft vor allem dann, wenn man Scripts aus externen Dateien verwenden will. Man kann ihn die Fehlermeldungen auch beliebig gestalten lassen. Dazu gibt es Vorlagen, die man bearbeiten kann.

Wird das Spiel nicht aus dem Maker heraus gestartet, erhält man standardmäßig dieselbe Fehlermeldung, die man mit Standard-RGSS auch erhalten würde (außer, dass externe Skripte unterstützt werden). Man kann das natürlich auch ändern, falls man dem Spieler weniger Einblick gewähren will in das, was da schieflaufen könnte

Startet man das Spiel aus dem Maker heraus (oder mit Kommandozeilenparameter 'debug'), erscheint (standardmäßig) eine ausführlichere Fehlermeldung inklusive Stacktrace (auch die kann man natürlich nach belieben anpassen, wenn man lustig ist).

Einfach ein neues Skript irgendwo über Main erstellen und folgendes einfügen:

#==============================================================================
# ** ErrorParser
#------------------------------------------------------------------------------
#  This improves the error messages in debug mode. You can change the message
#  templates to your likings (for both debug and normal mode).
#  Supports errors in external files.
#==============================================================================

class ErrorParser
  # This is the template for the message shown in debug mode.
  # CLASS, FILETYPE, FILENAME, LINE, METHOD, MESSAGE and TRACE get replaced
  # by the relevant information about the error.
  TEMPLATE_DEBUG = <<STRING
CLASS occurred!
FILETYPE: FILENAME
Line: LINE
Method: METHOD
Message: MESSAGE

Trace:
TRACE
STRING
  # This is the template for the message shown in normal mode.
  # You can use all of the variables from above.
  TEMPLATE_DEFAULT = "FILETYPE 'FILENAME' line LINE: CLASS occurred!\n\nMESSAGE"
  # This will be used as the template for an entry in the stack trace.
  # CLASS, MESSAGE, and TRACE cannot be used here.
  TEMPLATE_TRACE_ENTRY = "FILETYPE 'FILENAME' line LINE (in METHOD)\n"
  # This is the FILETYPE for scripts in Scripts.rxdata
  FILETYPE_SCRIPT = 'Script'
  # This is the FILETYPE for external Ruby scripts (if used).
  FILETYPE_FILE = 'File'
  # This will be used whereever we fail to parse the error correctly.
  UNKNOWN = '<unknown>'

  # Modifies the Main script to pass any errors to ErrorParser
  MAIN_CODE = <<CODE
rescue
  parser = ErrorParser.new
  print parser.error_message
  exit! parser.exit_code
CODE
  $RGSS_SCRIPTS[-1][3].insert(
    $RGSS_SCRIPTS[-1][3].rindex('rescue'), MAIN_CODE
  )
  
  attr_reader :error_message, :exit_code
  def initialize
    @exit_code = 0
    @error_message = $DEBUG ? TEMPLATE_DEBUG : TEMPLATE_DEFAULT
    fill_template @error_message, $!.backtrace[0].dup, true
    @error_message.sub! 'CLASS', $!.class.to_s
    @error_message.sub! 'MESSAGE', $!.message
    if @error_message['TRACE']
      @error_message.sub! 'TRACE', (
        $!.backtrace.collect do |trace_line|
          fill_template TEMPLATE_TRACE_ENTRY.dup, trace_line
        end
      ).to_s
    end
  end

  private

  def fill_template(template, trace, set_exit_code = false)
    type = 
    if trace.sub!(/\ASection(\d+)/, '')
      @exit_code = $1.to_i << 16 if set_exit_code
      name = $RGSS_SCRIPTS[$1.to_i][1]
      FILETYPE_SCRIPT
    else
      set_exit_code = false
      if trace.sub!(/\A(?:\.\/)?([^:]*)/, '')
        name = $1
        FILETYPE_FILE
      end
    end
    template.sub! 'FILETYPE', (type or UNKNOWN)
    template.sub! 'FILENAME', name
    line =
    if trace.slice!(/\A:(\d+)/)
      @exit_code += $1.to_i if set_exit_code
      $1
    else
      UNKNOWN
    end
    template.sub! 'LINE', line
    template.sub! 'METHOD', trace[/\A:in `(.+)'\z/] ? $1 : UNKNOWN
    template
  end
end

(Hinweis: Funktioniert nur richtig, wenn Main das letzte Script in der Liste ist :P Edit: ...und hinter dem end des Main-Scripts nichts mehr steht ^^)

Viel Spaß

Edit: Funktioniert nicht mit SyntaxErrors oder NameErrors, die auftreten, bevor das Main-Script ausgeführt wird.

[derula]

Version 2:

#==============================================================================
# ** ErrorParser
#------------------------------------------------------------------------------
#  This improves the error messages in debug mode. You can change the message
#  templates to your likings (for both debug and normal mode).
#  Supports errors in external files.
#==============================================================================

class ErrorParser
  # This is the template for the message shown in debug mode.
  # CLASS, FILETYPE, FILENAME, LINE, METHOD, MESSAGE and TRACE get replaced
  # by the relevant information about the error.
  TEMPLATE_DEBUG = <<STRING
CLASS occurred!
FILETYPE: FILENAME
Line: LINE
SOURCETYPE: SOURCE
Message: MESSAGE

Trace:
TRACE
STRING
  # This is the template for the message shown in normal mode.
  # You can use all of the variables from above.
  TEMPLATE_DEFAULT = "FILETYPE 'FILENAME' line LINE: CLASS occurred!\n\nMESSAGE"
  # This will be used as the template for an entry in the stack trace.
  # CLASS, MESSAGE, and TRACE cannot be used here.
  TEMPLATE_TRACE_ENTRY = "FILETYPE 'FILENAME' line LINE (SOURCETYPE SOURCE)"
  # This is the template for line numbers in events.
  TEMPLATE_EVENT_LINE = "COMMAND/LINE"
  # This is the FILETYPE for scripts in Scripts.rxdata
  FILETYPE_SCRIPT = 'Script'
  # This is the FILETYPE for scripts called from an event
  FILETYPE_EVENT = 'Event'
  # This is the FILETYPE for otherwise evaled scripts
  FILETYPE_EVAL = 'Unknown source'
  # This is the FILETYPE for external Ruby scripts (if used).
  FILETYPE_FILE = 'File'
  # This is the SOURCETYPE for methods in a script or file
  SOURCETYPE_METHOD = 'Method'
  # This is the SOURCETYPE for script calls from events
  SOURCETYPE_MAP = 'Map'
  # This will be used whereever we fail to parse the error correctly.
  UNKNOWN = '<unknown>'

  # Modifies the Main script to pass any errors to ErrorParser
  MAIN_CODE = <<CODE
rescue
  parser = ErrorParser.new
  print parser.error_message
  exit! parser.exit_code
CODE
  $RGSS_SCRIPTS[-1][3].insert(
    $RGSS_SCRIPTS[-1][3].rindex('rescue'), MAIN_CODE
  )
  
  # Modifies the Interpreter script to output extra error information or
  # errors in Call Script commands
  INTERPRETER_CODE = <<CODE
begin
  eval script
rescue
  $!.message.insert(5,
    ":\[email protected]_id}:\[email protected]_id}:\[email protected] + 1}:\#{$!.message[7, 1]}"
  )
  raise
end
CODE
  $RGSS_SCRIPTS.each do |a|
    if a[1] == "Interpreter 7"
      a[3].sub!('eval(script)', INTERPRETER_CODE)
      break
    end
  end
  
  attr_reader :error_message, :exit_code
  def initialize
    @error_message = $DEBUG ? TEMPLATE_DEBUG : TEMPLATE_DEFAULT
    @exit_code =
    if $!.message.slice!(/\A\(eval((?::\d+){4})?\)(:\d+:in `[^']*')/)
      if $1
        top = $1.split(':')
        top.shift
      else
        top = $2
      end
      ErrorParser.fill_template @error_message, top
    else
      ErrorParser.fill_template @error_message, $!.backtrace[0].dup
    end
    @error_message.sub! 'CLASS', $!.class.to_s
    @error_message.sub! 'MESSAGE', $!.message
    if @error_message['TRACE']
      @error_message.sub! 'TRACE', (
        ErrorParser.parse_backtrace($!.backtrace)
      ).join("\n")
    end
  end
  
  module ::Kernel
    alias old_caller caller
    def caller
      ErrorParser.parse_backtrace(old_caller)
    end
  end
  
  def self.parse_backtrace(trace)
    if trace
      trace.collect do |trace_line|
        line = TEMPLATE_TRACE_ENTRY.dup
        ErrorParser.fill_template line, trace_line
        line
      end
    else
      []
    end
  end

  private

  def self.fill_template(template, trace)
    exit_code = nil
    if trace.is_a? Array
      name, source, command_id, line_number = trace
      filetype = FILETYPE_EVENT
      line = TEMPLATE_EVENT_LINE
      line.sub!('COMMAND', command_id)
      line.sub!('LINE', line_number)
      sourcetype = SOURCETYPE_MAP
    else
      filetype =
      if trace.slice!(/\ASection(\d+)/)
        exit_code = $1.to_i << 16
        name = $RGSS_SCRIPTS[$1.to_i][1]
        FILETYPE_SCRIPT
      else
        if trace.slice!(/\A(?:\.\/)?([^:]*)/).length > 0
          name = $1
          FILETYPE_FILE
        else
          name = 'evaluated'
          FILETYPE_EVAL
        end
      end
      line =
      if trace.slice!(/\A:(\d+)/)
        exit_code += $1.to_i if exit_code
        $1
      else
        UNKNOWN
      end
      sourcetype = SOURCETYPE_METHOD
      source = trace[/\A:in `(.+)'\z/] ? $1 : UNKNOWN
    end
    template.sub! 'FILETYPE', (filetype or UNKNOWN)
    template.sub! 'FILENAME', name
    template.sub! 'LINE', line
    template.sub! 'SOURCETYPE', sourcetype
    template.sub! 'SOURCE', source
    exit_code or 0
  end
end

Neuerungen:
- Falls ein Fehler in einem Call-Script-Befehl in einem Event auftritt, gibt er Map-ID, Event-ID, Index des Befehls und Zeilennummer innerhalb des Befehls zurück.
- Auch das Rückgabe-Array von Kernel#caller wird nun geparst, das heißt man hat da ebenfalls statt wie bisher Section052-blabla die Scriptnamen stehen.

Viel Vergnügen