mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-23 17:05:26 +02:00
javadoc IBindings and ITypes
This commit is contained in:
Andrew Niefer
parent
e4d3a83c55
commit
5410741fac
22 changed files with 135 additions and 10 deletions
|
|
@ -18,6 +18,10 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IArrayType extends IType {
|
||||
|
||||
/**
|
||||
* get the type that this is an array of
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
IType getType() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,5 +18,11 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IEnumeration extends IBinding, IType {
|
||||
|
||||
/**
|
||||
* returns an array of the IEnumerators declared in this enumeration
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
IEnumerator [] getEnumerators() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -19,7 +19,10 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
*/
|
||||
public interface IEnumerator extends IBinding {
|
||||
/**
|
||||
* @return the type of the variable
|
||||
* returns the type of this enumeration. The type of an enumerator
|
||||
* is the enumeration in which it is declared.
|
||||
*
|
||||
* @return the type of the enumeration
|
||||
*/
|
||||
public IType getType() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,9 +20,9 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
public interface IFunction extends IBinding {
|
||||
|
||||
/**
|
||||
* This gets the parameters to the function which are IVariables.
|
||||
* This gets the parameters to the function
|
||||
*
|
||||
* @return List of IParameter
|
||||
* @return array of IParameter
|
||||
* @throws DOMException if this is a problem binding
|
||||
*/
|
||||
public IParameter [] getParameters() throws DOMException;
|
||||
|
|
@ -36,7 +36,7 @@ public interface IFunction extends IBinding {
|
|||
public IScope getFunctionScope() throws DOMException;
|
||||
|
||||
/**
|
||||
*
|
||||
* Get the IFunctionType for this function
|
||||
* @return
|
||||
* @throws DOMException if this is a problem binding
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -18,7 +18,18 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IFunctionType extends IType {
|
||||
/**
|
||||
* get the return type of this function type
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public IType getReturnType() throws DOMException;
|
||||
|
||||
/**
|
||||
* get the adjusted parameter types
|
||||
* ISO C99 6.7.5.3, ISO C++98 8.3.4-3
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public IType [] getParameterTypes() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,7 +18,24 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IPointerType extends IType {
|
||||
/**
|
||||
* get the type that this is a pointer to
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public IType getType() throws DOMException;
|
||||
|
||||
/**
|
||||
* is this a const pointer
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public boolean isConst() throws DOMException;
|
||||
|
||||
/**
|
||||
* is this a volatile pointer
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public boolean isVolatile() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,8 +18,24 @@ package org.eclipse.cdt.core.dom.ast;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IQualifierType extends IType {
|
||||
/**
|
||||
* is this a const type
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public boolean isConst() throws DOMException;
|
||||
|
||||
/**
|
||||
* is this a volatile type
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public boolean isVolatile() throws DOMException;
|
||||
|
||||
/**
|
||||
* get the type that this is qualifying
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public IType getType() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,5 +21,10 @@ public interface IVariable extends IBinding {
|
|||
public IType getType() throws DOMException;
|
||||
|
||||
|
||||
/**
|
||||
* whether or not this is a static variable
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public boolean isStatic() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -17,6 +17,10 @@ package org.eclipse.cdt.core.dom.ast.c;
|
|||
import org.eclipse.cdt.core.dom.ast.IBinding;
|
||||
|
||||
/**
|
||||
* This interface represents a binding for a function or variable that
|
||||
* is assumed to exist in another compilation unit and that would be found
|
||||
* at link time.
|
||||
*
|
||||
* @author aniefer
|
||||
*/
|
||||
public interface ICExternalBinding extends IBinding {
|
||||
|
|
|
|||
|
|
@ -20,5 +20,10 @@ import org.eclipse.cdt.core.dom.ast.IPointerType;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface ICPointerType extends IPointerType {
|
||||
|
||||
/**
|
||||
* is this a restrict pointer
|
||||
* @return
|
||||
*/
|
||||
boolean isRestrict();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,5 +20,9 @@ import org.eclipse.cdt.core.dom.ast.IQualifierType;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface ICQualifierType extends IQualifierType {
|
||||
/**
|
||||
* is this a restrict type
|
||||
* @return
|
||||
*/
|
||||
public boolean isRestrict();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -83,9 +83,17 @@ public interface ICPPClassType extends ICompositeType {
|
|||
public ICPPMethod[] getDeclaredMethods() throws DOMException;
|
||||
|
||||
/**
|
||||
* Returns an array of ICPPConstructor objects representing the contructors for this
|
||||
* class. This list includes both declared and implicit constructors.
|
||||
* @return
|
||||
*/
|
||||
public ICPPConstructor[] getConstructors() throws DOMException;
|
||||
|
||||
/**
|
||||
* return an array of bindings for those classes/functions declared as friends of this
|
||||
* class.
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public IBinding [] getFriends() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -17,8 +17,16 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
|
|||
import org.eclipse.cdt.core.dom.ast.IBinding;
|
||||
|
||||
/**
|
||||
* This binding is a container for other bindings. It is used in instances
|
||||
* where an IASTName refers to more than one binding, for example a using declaration
|
||||
* refering to a set of overloaded functions.
|
||||
* @author aniefer
|
||||
*/
|
||||
public interface ICPPCompositeBinding extends IBinding {
|
||||
/**
|
||||
* get the bindings
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
IBinding [] getBindings() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
|
|||
public interface ICPPConstructor extends ICPPMethod {
|
||||
|
||||
/**
|
||||
*
|
||||
* Whether or not this constructor was declared as explicit
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -17,8 +17,14 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
|
|||
import org.eclipse.cdt.core.dom.ast.IBinding;
|
||||
|
||||
/**
|
||||
* This interface represents a C++ namespace
|
||||
* @author aniefer
|
||||
*/
|
||||
public interface ICPPNamespace extends IBinding {
|
||||
/**
|
||||
* get the scope object associated with this namespace
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public ICPPNamespaceScope getNamespaceScope() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,12 +14,16 @@
|
|||
*/
|
||||
package org.eclipse.cdt.core.dom.ast.cpp;
|
||||
|
||||
import org.eclipse.cdt.core.dom.ast.IBinding;
|
||||
import org.eclipse.cdt.core.dom.ast.IPointerType;
|
||||
|
||||
/**
|
||||
* @author aniefer
|
||||
*/
|
||||
public interface ICPPPointerToMemberType extends IPointerType {
|
||||
public IBinding getMemberOfClass();
|
||||
|
||||
/**
|
||||
* Get the class to whose members this points to
|
||||
* @return
|
||||
*/
|
||||
public ICPPClassType getMemberOfClass();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,5 +21,10 @@ import org.eclipse.cdt.core.dom.ast.IType;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface ICPPReferenceType extends IType {
|
||||
/**
|
||||
* get the type that this is a reference of
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
public IType getType() throws DOMException;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ public interface ICPPTemplateTypeParameter extends ICPPTemplateParameter, IType
|
|||
|
||||
/**
|
||||
* The default type for this parameter.
|
||||
*
|
||||
* May be null
|
||||
* @return
|
||||
*/
|
||||
public IType getDefault() throws DOMException;
|
||||
|
|
|
|||
|
|
@ -20,5 +20,9 @@ import org.eclipse.cdt.core.dom.ast.IPointerType;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IGPPPointerType extends IPointerType {
|
||||
/**
|
||||
* is this a restrict pointer
|
||||
* @return
|
||||
*/
|
||||
boolean isRestrict();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,5 +20,9 @@ import org.eclipse.cdt.core.dom.ast.IQualifierType;
|
|||
* @author aniefer
|
||||
*/
|
||||
public interface IGPPQualifierType extends IQualifierType {
|
||||
/**
|
||||
* is this a restrict type
|
||||
* @return
|
||||
*/
|
||||
public boolean isRestrict();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,9 +18,20 @@ import org.eclipse.cdt.core.dom.ast.DOMException;
|
|||
import org.eclipse.cdt.core.dom.ast.IType;
|
||||
|
||||
/**
|
||||
* internal interface representing types that contain other types
|
||||
* @author aniefer
|
||||
*/
|
||||
public interface ITypeContainer extends IType{
|
||||
/**
|
||||
* get the type this contains
|
||||
* @return
|
||||
* @throws DOMException
|
||||
*/
|
||||
IType getType() throws DOMException;
|
||||
|
||||
/**
|
||||
* set the type this contains
|
||||
* @param type
|
||||
*/
|
||||
void setType( IType type );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ public class CPPPointerToMemberType extends CPPPointerType implements
|
|||
/* (non-Javadoc)
|
||||
* @see org.eclipse.cdt.core.dom.ast.cpp.ICPPPointerToMemberType#getMemberOfClass()
|
||||
*/
|
||||
public IBinding getMemberOfClass() {
|
||||
public ICPPClassType getMemberOfClass() {
|
||||
if( clsType == null ){
|
||||
ICPPASTPointerToMember pm = (ICPPASTPointerToMember) operator;
|
||||
IASTName name = pm.getName();
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue