com.sun.org.apache.xalan.internal.xsltc.compiler.VariableRefBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxp-ri Show documentation
Show all versions of jaxp-ri Show documentation
Java API for XML Processing Reference Implementation
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id: VariableRefBase.java,v 1.11 2010-11-01 04:34:18 joehw Exp $
*/
package com.sun.org.apache.xalan.internal.xsltc.compiler;
import com.sun.org.apache.xalan.internal.xsltc.compiler.util.Type;
import com.sun.org.apache.xalan.internal.xsltc.compiler.util.TypeCheckError;
/**
* @author Morten Jorgensen
* @author Santiago Pericas-Geertsen
*/
class VariableRefBase extends Expression {
/**
* A reference to the associated variable.
*/
protected VariableBase _variable;
/**
* A reference to the enclosing expression/instruction for which a
* closure is needed (Predicate, Number or Sort).
*/
protected Closure _closure = null;
public VariableRefBase(VariableBase variable) {
_variable = variable;
variable.addReference(this);
}
public VariableRefBase() {
_variable = null;
}
/**
* Returns a reference to the associated variable
*/
public VariableBase getVariable() {
return _variable;
}
/**
* If this variable reference is in a top-level element like
* another variable, param or key, add a dependency between
* that top-level element and the referenced variable. For
* example,
*
*
*
*
* and assuming this class represents "$x", add a reference
* between variable y and variable x.
*/
public void addParentDependency() {
SyntaxTreeNode node = this;
while (node != null && node instanceof TopLevelElement == false) {
node = node.getParent();
}
TopLevelElement parent = (TopLevelElement) node;
if (parent != null) {
VariableBase var = _variable;
if (_variable._ignore) {
if (_variable instanceof Variable) {
var = parent.getSymbolTable()
.lookupVariable(_variable._name);
} else if (_variable instanceof Param) {
var = parent.getSymbolTable().lookupParam(_variable._name);
}
}
parent.addDependency(var);
}
}
/**
* Two variable references are deemed equal if they refer to the
* same variable.
*/
public boolean equals(Object obj) {
try {
return (_variable == ((VariableRefBase) obj)._variable);
}
catch (ClassCastException e) {
return false;
}
}
/**
* Returns a string representation of this variable reference on the
* format 'variable-ref()'.
* @return Variable reference description
*/
public String toString() {
return "variable-ref("+_variable.getName()+'/'+_variable.getType()+')';
}
public Type typeCheck(SymbolTable stable)
throws TypeCheckError
{
// Returned cached type if available
if (_type != null) return _type;
// Find nearest closure to add a variable reference
if (_variable.isLocal()) {
SyntaxTreeNode node = getParent();
do {
if (node instanceof Closure) {
_closure = (Closure) node;
break;
}
if (node instanceof TopLevelElement) {
break; // way up in the tree
}
node = node.getParent();
} while (node != null);
if (_closure != null) {
_closure.addVariable(this);
}
}
// Attempt to get the cached variable type
_type = _variable.getType();
// If that does not work we must force a type-check (this is normally
// only needed for globals in included/imported stylesheets
if (_type == null) {
_variable.typeCheck(stable);
_type = _variable.getType();
}
// If in a top-level element, create dependency to the referenced var
addParentDependency();
// Return the type of the referenced variable
return _type;
}
}