/*
* Copyright (c) 1998-2010 Caucho Technology -- all rights reserved
*
* This file is part of Resin(R) Open Source
*
* Each copy or derived work must preserve the copyright notice and this
* notice unmodified.
*
* Resin Open Source is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Resin Open Source is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
* of NON-INFRINGEMENT. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with Resin Open Source; if not, write to the
*
* Free Software Foundation, Inc.
* 59 Temple Place, Suite 330
* Boston, MA 02111-1307 USA
*
* @author Scott Ferguson
*/
package com.caucho.quercus.program;
import com.caucho.quercus.env.*;
import com.caucho.quercus.expr.Expr;
import com.caucho.quercus.function.AbstractFunction;
import com.caucho.quercus.program.ClassDef.FieldEntry;
import com.caucho.quercus.Location;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
/**
* Represents an interpreted PHP class definition.
*/
public class InterpretedClassDef extends ClassDef
implements InstanceInitializer {
protected boolean _isAbstract;
protected boolean _isInterface;
protected boolean _isFinal;
protected boolean _hasNonPublicMethods;
// true if defined in the top scope of a page
private boolean _isTopScope;
protected final HashMap<String, AbstractFunction> _functionMap = new HashMap<String, AbstractFunction>();
protected final HashMap<StringValue, FieldEntry> _fieldMap = new LinkedHashMap<StringValue, FieldEntry>();
protected final HashMap<String, StaticFieldEntry> _staticFieldMap = new LinkedHashMap<String, StaticFieldEntry>();
protected final HashMap<String, Expr> _constMap = new HashMap<String, Expr>();
protected AbstractFunction _constructor;
protected AbstractFunction _destructor;
protected AbstractFunction _getField;
protected AbstractFunction _setField;
protected AbstractFunction _isset;
protected AbstractFunction _unset;
protected AbstractFunction _call;
protected AbstractFunction _invoke;
protected AbstractFunction _toString;
protected int _parseIndex;
protected String _comment;
public InterpretedClassDef(Location location,
String name,
String parentName,
String[] ifaceList,
int index) {
super(location, name, parentName, ifaceList);
_parseIndex = index;
}
public InterpretedClassDef(String name,
String parentName,
String[] ifaceList) {
this(null, name, parentName, ifaceList, 0);
}
/**
* true for an abstract class.
*/
public void setAbstract(boolean isAbstract) {
_isAbstract = isAbstract;
}
/**
* True for an abstract class.
*/
@Override
public boolean isAbstract() {
return _isAbstract;
}
/**
* true for an interface class.
*/
public void setInterface(boolean isInterface) {
_isInterface = isInterface;
}
/**
* True for an interface class.
*/
@Override
public boolean isInterface() {
return _isInterface;
}
/*
* True for a final class.
*/
public void setFinal(boolean isFinal) {
_isFinal = isFinal;
}
/*
* Returns true for a final class.
*/
@Override
public boolean isFinal() {
return _isFinal;
}
/*
* Returns true if class has protected or private methods.
*/
public boolean getHasNonPublicMethods() {
return _hasNonPublicMethods;
}
/**
* True if defined at the top-level scope
*/
public boolean isTopScope() {
return _isTopScope;
}
/**
* True if defined at the top-level scope
*/
public void setTopScope(boolean isTopScope) {
_isTopScope = isTopScope;
}
/*
* Unique name to use for compilation.
*/
public String getCompilationName() {
String name = getName();
name = name.replace("__", "___");
name = name.replace("\\", "__");
return name + "_" + _parseIndex;
}
/**
* Initialize the quercus class.
*/
@Override
public void initClass(QuercusClass cl) {
if (_constructor != null) {
cl.setConstructor(_constructor);
// php/093o
//cl.addMethod("__construct", _constructor);
}
if (_destructor != null) {
cl.setDestructor(_destructor);
cl.addMethod("__destruct", _destructor);
}
if (_getField != null) {
cl.setFieldGet(_getField);
}
if (_setField != null) {
cl.setFieldSet(_setField);
}
if (_call != null) {
cl.setCall(_call);
}
if (_invoke != null) {
cl.setInvoke(_invoke);
}
if (_toString != null) {
cl.setToString(_toString);
}
if (_isset != null) {
cl.setIsset(_isset);
}
if (_unset != null) {
cl.setUnset(_unset);
}
cl.addInitializer(this);
for (Map.Entry<String, AbstractFunction> entry : _functionMap.entrySet()) {
cl.addMethod(entry.getKey(), entry.getValue());
}
for (Map.Entry<StringValue, FieldEntry> entry : _fieldMap.entrySet()) {
FieldEntry fieldEntry = entry.getValue();
cl.addField(entry.getKey(),
fieldEntry.getValue(),
fieldEntry.getVisibility());
}
String className = getName();
for (Map.Entry<String, StaticFieldEntry> entry : _staticFieldMap.entrySet()) {
StaticFieldEntry field = entry.getValue();
cl.addStaticFieldExpr(className, entry.getKey(), field.getValue());
}
for (Map.Entry<String, Expr> entry : _constMap.entrySet()) {
cl.addConstant(entry.getKey(), entry.getValue());
}
}
/**
* Sets the constructor.
*/
public void setConstructor(AbstractFunction fun) {
_constructor = fun;
}
/**
* Adds a function.
*/
public void addFunction(String name, Function fun) {
_functionMap.put(name.intern(), fun);
if (!fun.isPublic()) {
_hasNonPublicMethods = true;
}
if (name.equals("__construct")) {
_constructor = fun;
} else if (name.equals("__destruct")) {
_destructor = fun;
} else if (name.equals("__get")) {
_getField = fun;
} else if (name.equals("__set")) {
_setField = fun;
} else if (name.equals("__call")) {
_call = fun;
} else if (name.equals("__invoke")) {
_invoke = fun;
} else if (name.equals("__toString")) {
_toString = fun;
} else if (name.equals("__isset")) {
_isset = fun;
} else if (name.equals("__unset")) {
_unset = fun;
} else if (name.equalsIgnoreCase(getName()) && _constructor == null) {
_constructor = fun;
}
}
/**
* Adds a static value.
*/
public void addStaticValue(Value name, Expr value) {
_staticFieldMap.put(name.toString(), new StaticFieldEntry(value));
}
/**
* Adds a static value.
*/
public void addStaticValue(Value name, Expr value, String comment) {
_staticFieldMap.put(name.toString(), new StaticFieldEntry(value, comment));
}
/**
* Adds a const value.
*/
public void addConstant(String name, Expr value) {
_constMap.put(name.intern(), value);
}
/**
* Return a const value.
*/
@Override
public Expr findConstant(String name) {
return _constMap.get(name);
}
/**
* Adds a value.
*/
public void addValue(Value name, Expr value, FieldVisibility visibility) {
_fieldMap.put(name.toStringValue(), new FieldEntry(value, visibility));
}
/**
* Adds a value.
*/
public void addValue(Value name,
Expr value,
FieldVisibility visibility,
String comment) {
_fieldMap.put(name.toStringValue(),
new FieldEntry(value, visibility, comment));
}
/**
* Adds a value.
*/
public Expr get(Value name) {
FieldEntry entry = _fieldMap.get(name.toStringValue());
if (entry != null) {
return entry.getValue();
} else {
return null;
}
}
/**
* Return true for a declared field.
*/
public boolean isDeclaredField(StringValue name) {
return _fieldMap.get(name) != null;
}
/**
* Initialize the class.
*/
public void init(Env env) {
QuercusClass qClass = env.getClass(getName());
for (Map.Entry<String, StaticFieldEntry> entry : _staticFieldMap.entrySet()) {
String name = entry.getKey();
StaticFieldEntry field = entry.getValue();
qClass.getStaticFieldVar(env, env.createString(name)).set(field.getValue().eval(env).copy());
}
}
/**
* Initialize the fields
*/
@Override
public void initInstance(Env env, Value value) {
ObjectValue object = (ObjectValue) value;
for (Map.Entry<StringValue, FieldEntry> entry : _fieldMap.entrySet()) {
FieldEntry fieldEntry = entry.getValue();
object.initField(entry.getKey(),
fieldEntry.getValue().eval(env).copy(),
fieldEntry.getVisibility());
}
if (_destructor != null && value instanceof ObjectExtValue) {
env.addObjectCleanup((ObjectExtValue) object);
}
}
/**
* Returns the constructor
*/
@Override
public AbstractFunction findConstructor() {
return _constructor;
}
/**
* Sets the documentation for this class.
*/
public void setComment(String comment) {
_comment = comment;
}
/**
* Returns the documentation for this class.
*/
@Override
public String getComment() {
return _comment;
}
/**
* Returns the comment for the specified field.
*/
@Override
public String getFieldComment(StringValue name) {
FieldEntry field = _fieldMap.get(name);
if (field != null) {
return field.getComment();
} else {
return null;
}
}
/**
* Returns the comment for the specified field.
*/
@Override
public String getStaticFieldComment(String name) {
StaticFieldEntry field = _staticFieldMap.get(name);
if (field != null) {
return field.getComment();
} else {
return null;
}
}
@Override
public Set<Map.Entry<StringValue, FieldEntry>> fieldSet() {
return _fieldMap.entrySet();
}
@Override
public Set<Map.Entry<String, StaticFieldEntry>> staticFieldSet() {
return _staticFieldMap.entrySet();
}
@Override
public Set<Map.Entry<String, AbstractFunction>> functionSet() {
return _functionMap.entrySet();
}
}