org.jruby.ast.Node Maven / Gradle / Ivy
/*
***** 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-2002 Jan Arne Petersen
* Copyright (C) 2001-2002 Benoit Cerrina
* Copyright (C) 2002-2004 Anders Bengtsson
* Copyright (C) 2004 Thomas E Enebo
* Copyright (C) 2004 Stefan Matthias Aust
* Copyright (C) 2006 Thomas Corbat
*
* 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.ast;
import java.util.ArrayList;
import java.util.List;
import org.jruby.Ruby;
import org.jruby.ast.types.INameNode;
import org.jruby.ast.visitor.NodeVisitor;
import org.jruby.exceptions.JumpException;
import org.jruby.lexer.yacc.ISourcePosition;
import org.jruby.lexer.yacc.ISourcePositionHolder;
import org.jruby.runtime.Block;
import org.jruby.runtime.ThreadContext;
import org.jruby.runtime.builtin.IRubyObject;
import org.jruby.util.ByteList;
/**
* Base class for all Nodes in the AST
*/
public abstract class Node implements ISourcePositionHolder {
// We define an actual list to get around bug in java integration (1387115)
static final List EMPTY_LIST = new ArrayList();
// defined? results
public static final ByteList EXPRESSION_BYTELIST = ByteList.create("expression");
public static final ByteList ASSIGNMENT_BYTELIST = ByteList.create("assignment");
public static final ByteList GLOBAL_VARIABLE_BYTELIST = ByteList.create("global-variable");
public static final ByteList METHOD_BYTELIST = ByteList.create("method");
public static final ByteList CLASS_VARIABLE_BYTELIST = ByteList.create("class variable");
public static final ByteList CONSTANT_BYTELIST = ByteList.create("constant");
public static final ByteList LOCAL_VARIABLE_BYTELIST = ByteList.create("local-variable");
public static final ByteList LOCAL_VARIABLE_IN_BLOCK_BYTELIST = ByteList.create("local-variable(in-block)");
public static final ByteList FALSE_BYTELIST = ByteList.create("false");
public static final ByteList INSTANCE_VARIABLE_BYTELIST = ByteList.create("instance-variable");
public static final ByteList NIL_BYTELIST = ByteList.create("nil");
public static final ByteList SELF_BYTELIST = ByteList.create("self");
public static final ByteList SUPER_BYTELIST = ByteList.create("super");
public static final ByteList TRUE_BYTELIST = ByteList.create("true");
public static final ByteList YIELD_BYTELIST = ByteList.create("yield");
private ISourcePosition position;
public Node(ISourcePosition position) {
assert position != null;
this.position = position;
}
/**
* Location of this node within the source
*/
public ISourcePosition getPosition() {
return position;
}
public void setPosition(ISourcePosition position) {
this.position = position;
}
public abstract Object accept(NodeVisitor visitor);
public abstract List childNodes();
protected static List createList(Node... nodes) {
ArrayList list = new ArrayList();
for (Node node: nodes) {
if (node != null) list.add(node);
}
return list;
}
@Override
public String toString() {
if (this instanceof InvisibleNode) return "";
StringBuilder builder = new StringBuilder(60);
builder.append("(").append(getNodeName());
if (this instanceof INameNode) {
builder.append(":").append(((INameNode) this).getName());
}
builder.append(" ").append(getPosition().getStartLine());
for (Node child: childNodes()) {
builder.append(", ").append(child);
}
builder.append(")");
return builder.toString();
}
protected String getNodeName() {
String name = getClass().getName();
int i = name.lastIndexOf('.');
String nodeType = name.substring(i + 1);
return nodeType;
}
/**
* Is the current node something that is syntactically visible in the AST. IDE consumers
* should ignore these elements.
*/
public boolean isInvisible() {
return this instanceof InvisibleNode;
}
public IRubyObject interpret(Ruby runtime, ThreadContext context, IRubyObject self, Block aBlock) {
throw new RuntimeException(this.getClass().getSimpleName() + " should not be directly interpreted");
}
public IRubyObject assign(Ruby runtime, ThreadContext context, IRubyObject self, IRubyObject value, Block block, boolean checkArity) {
throw new RuntimeException("Invalid node encountered in interpreter: \"" + getClass().getName() + "\", please report this at www.jruby.org");
}
public ByteList definition(Ruby runtime, ThreadContext context, IRubyObject self, Block aBlock) {
try {
interpret(runtime, context, self, aBlock);
return EXPRESSION_BYTELIST;
} catch (JumpException jumpExcptn) {
}
return null;
}
/**
* @return the nodeId
*/
public abstract NodeType getNodeType();
}