/***** BEGIN LICENSE BLOCK *****
* Version: CPL 1.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Common Public
* License Version 1.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/cpl-v10.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2001 Alan Moore <alan_moore@gmx.net>
* Copyright (C) 2001-2004 Jan Arne Petersen <jpetersen@uni-bonn.de>
* Copyright (C) 2002 Benoit Cerrina <b.cerrina@wanadoo.fr>
* Copyright (C) 2002-2004 Anders Bengtsson <ndrsbngtssn@yahoo.se>
* Copyright (C) 2002-2006 Thomas E Enebo <enebo@acm.org>
* Copyright (C) 2004 Joey Gibson <joey@joeygibson.com>
* Copyright (C) 2004-2005 Charles O Nutter <headius@headius.com>
* Copyright (C) 2004 Stefan Matthias Aust <sma@3plus4.de>
* Copyright (C) 2005 David Corbin <dcorbin@users.sf.net>
* Copyright (C) 2006 Michael Studman <codehaus@michaelstudman.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the CPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the CPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****/
package org.jruby;
import java.io.IOException;
import java.io.PrintStream;
import java.util.List;
import org.jruby.anno.JRubyClass;
import org.jruby.anno.JRubyMethod;
import org.jruby.runtime.Block;
import org.jruby.runtime.ObjectAllocator;
import org.jruby.runtime.ObjectMarshal;
import org.jruby.runtime.ThreadContext;
import org.jruby.runtime.Visibility;
import org.jruby.runtime.builtin.IRubyObject;
import org.jruby.runtime.builtin.Variable;
import org.jruby.runtime.component.VariableEntry;
import org.jruby.runtime.marshal.MarshalStream;
import org.jruby.runtime.marshal.UnmarshalStream;
import org.jruby.util.SafePropertyAccessor;
/**
*
* @author jpetersen
*/
@JRubyClass(name="Exception")
public class RubyException extends RubyObject {
private StackTraceElement[] backtraceFrames;
private StackTraceElement[] javaStackTrace;
private IRubyObject backtrace;
public IRubyObject message;
public static final int TRACE_HEAD = 8;
public static final int TRACE_TAIL = 4;
public static final int TRACE_MAX = TRACE_HEAD + TRACE_TAIL + 6;
protected RubyException(Ruby runtime, RubyClass rubyClass) {
this(runtime, rubyClass, null);
}
public RubyException(Ruby runtime, RubyClass rubyClass, String message) {
super(runtime, rubyClass);
this.message = message == null ? runtime.getNil() : runtime.newString(message);
}
private static ObjectAllocator EXCEPTION_ALLOCATOR = new ObjectAllocator() {
public IRubyObject allocate(Ruby runtime, RubyClass klass) {
RubyException instance = new RubyException(runtime, klass);
// for future compatibility as constructors move toward not accepting metaclass?
instance.setMetaClass(klass);
return instance;
}
};
private static final ObjectMarshal EXCEPTION_MARSHAL = new ObjectMarshal() {
public void marshalTo(Ruby runtime, Object obj, RubyClass type,
MarshalStream marshalStream) throws IOException {
RubyException exc = (RubyException)obj;
marshalStream.registerLinkTarget(exc);
List<Variable<IRubyObject>> attrs = exc.getVariableList();
attrs.add(new VariableEntry<IRubyObject>(
"mesg", exc.message == null ? runtime.getNil() : exc.message));
attrs.add(new VariableEntry<IRubyObject>("bt", exc.getBacktrace()));
marshalStream.dumpVariables(attrs);
}
public Object unmarshalFrom(Ruby runtime, RubyClass type,
UnmarshalStream unmarshalStream) throws IOException {
RubyException exc = (RubyException)type.allocate();
unmarshalStream.registerLinkTarget(exc);
unmarshalStream.defaultVariablesUnmarshal(exc);
exc.message = exc.removeInternalVariable("mesg");
exc.set_backtrace(exc.removeInternalVariable("bt"));
return exc;
}
};
public static RubyClass createExceptionClass(Ruby runtime) {
RubyClass exceptionClass = runtime.defineClass("Exception", runtime.getObject(), EXCEPTION_ALLOCATOR);
runtime.setException(exceptionClass);
exceptionClass.setMarshal(EXCEPTION_MARSHAL);
exceptionClass.defineAnnotatedMethods(RubyException.class);
return exceptionClass;
}
public static RubyException newException(Ruby runtime, RubyClass excptnClass, String msg) {
return new RubyException(runtime, excptnClass, msg);
}
public void setBacktraceFrames(StackTraceElement[] backtraceFrames) {
this.backtraceFrames = backtraceFrames;
if (TRACE_TYPE == RAW ||
TRACE_TYPE == RAW_FILTERED ||
TRACE_TYPE == RUBY_COMPILED ||
TRACE_TYPE == RUBY_HYBRID) {
javaStackTrace = Thread.currentThread().getStackTrace();
}
}
public static final int RAW = 0;
public static final int RAW_FILTERED = 1;
public static final int RUBY_FRAMED = 2;
public static final int RUBY_COMPILED = 3;
public static final int RUBY_HYBRID = 4;
public static final int TRACE_TYPE;
static {
String style = SafePropertyAccessor.getProperty("jruby.backtrace.style", "ruby_framed").toLowerCase();
if (style.equals("raw")) TRACE_TYPE = RAW;
else if (style.equals("raw_filtered")) TRACE_TYPE = RAW_FILTERED;
else if (style.equals("ruby_framed")) TRACE_TYPE = RUBY_FRAMED;
else if (style.equals("ruby_compiled")) TRACE_TYPE = RUBY_COMPILED;
else if (style.equals("ruby_hybrid")) TRACE_TYPE = RUBY_HYBRID;
else TRACE_TYPE = RUBY_FRAMED;
}
public IRubyObject getBacktrace() {
if (backtrace == null) {
initBacktrace();
}
return backtrace;
}
public void initBacktrace() {
switch (TRACE_TYPE) {
case RAW:
backtrace = ThreadContext.createRawBacktrace(getRuntime(), javaStackTrace, false);
break;
case RAW_FILTERED:
backtrace = ThreadContext.createRawBacktrace(getRuntime(), javaStackTrace, true);
break;
case RUBY_FRAMED:
backtrace = backtraceFrames == null ? getRuntime().getNil() : ThreadContext.createBacktraceFromFrames(getRuntime(), backtraceFrames);
break;
case RUBY_COMPILED:
backtrace = ThreadContext.createRubyCompiledBacktrace(getRuntime(), javaStackTrace);
break;
case RUBY_HYBRID:
backtrace = ThreadContext.createRubyHybridBacktrace(getRuntime(), backtraceFrames, javaStackTrace, getRuntime().getDebug().isTrue());
break;
}
}
@JRubyMethod(optional = 2, frame = true, visibility = Visibility.PRIVATE)
public IRubyObject initialize(IRubyObject[] args, Block block) {
if (args.length == 1) message = args[0];
return this;
}
@JRubyMethod
public IRubyObject backtrace() {
return getBacktrace();
}
@JRubyMethod(required = 1)
public IRubyObject set_backtrace(IRubyObject obj) {
if (obj.isNil()) {
backtrace = null;
} else if (!isArrayOfStrings(obj)) {
throw getRuntime().newTypeError("backtrace must be Array of String");
} else {
backtrace = (RubyArray) obj;
}
return backtrace();
}
@JRubyMethod(name = "exception", optional = 1, rest = true, meta = true)
public static IRubyObject exception(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block) {
return ((RubyClass) recv).newInstance(context, args, block);
}
@JRubyMethod(optional = 1)
public RubyException exception(IRubyObject[] args) {
switch (args.length) {
case 0 :
return this;
case 1 :
if(args[0] == this) {
return this;
}
RubyException ret = (RubyException)rbClone();
ret.initialize(args, Block.NULL_BLOCK); // This looks wrong, but it's the way MRI does it.
return ret;
default :
throw getRuntime().newArgumentError("Wrong argument count");
}
}
@JRubyMethod(name = "to_s")
public IRubyObject to_s(ThreadContext context) {
if (message.isNil()) return context.getRuntime().newString(getMetaClass().getName());
message.setTaint(isTaint());
return message;
}
@JRubyMethod(name = "message")
public IRubyObject message(ThreadContext context) {
return callMethod(context, "to_s");
}
/** inspects an object and return a kind of debug information
*
*@return A RubyString containing the debug information.
*/
@JRubyMethod(name = "inspect")
public IRubyObject inspect(ThreadContext context) {
RubyModule rubyClass = getMetaClass();
RubyString exception = RubyString.objAsString(context, this);
if (exception.getByteList().realSize == 0) return getRuntime().newString(rubyClass.getName());
StringBuilder sb = new StringBuilder("#<");
sb.append(rubyClass.getName()).append(": ").append(exception.getByteList()).append(">");
return getRuntime().newString(sb.toString());
}
protected void copySpecialInstanceVariables(IRubyObject clone) {
RubyException exception = (RubyException)clone;
exception.backtraceFrames = backtraceFrames;
exception.javaStackTrace = javaStackTrace;
exception.backtrace = backtrace;
exception.message = message;
}
public void printBacktrace(PrintStream errorStream) {
IRubyObject backtrace = callMethod(getRuntime().getCurrentContext(), "backtrace");
boolean debug = getRuntime().getDebug().isTrue();
if (!backtrace.isNil() && backtrace instanceof RubyArray) {
IRubyObject[] elements = backtrace.convertToArray().toJavaArray();
for (int i = 1; i < elements.length; i++) {
IRubyObject stackTraceLine = elements[i];
if (stackTraceLine instanceof RubyString) {
printStackTraceLine(errorStream, stackTraceLine);
}
if (!debug && i == RubyException.TRACE_HEAD && elements.length > RubyException.TRACE_MAX) {
int hiddenLevels = elements.length - RubyException.TRACE_HEAD - RubyException.TRACE_TAIL;
errorStream.print("\t ... " + hiddenLevels + " levels...\n");
i = elements.length - RubyException.TRACE_TAIL;
}
}
}
}
private void printStackTraceLine(PrintStream errorStream, IRubyObject stackTraceLine) {
errorStream.print("\tfrom " + stackTraceLine + '\n');
}
private boolean isArrayOfStrings(IRubyObject backtrace) {
if (!(backtrace instanceof RubyArray)) return false;
IRubyObject[] elements = ((RubyArray) backtrace).toJavaArray();
for (int i = 0 ; i < elements.length ; i++) {
if (!(elements[i] instanceof RubyString)) return false;
}
return true;
}
}