mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-17 22:15:23 +02:00
Code Issues Wiki Activity

Checked in patch for bug 183400, and cleaned up TODOs.

Browse source
This commit is contained in:
Pawel Piech 2007-04-20 18:11:02 +00:00
parent 4c76a8df1e
commit 2c84b29d1d
1 changed files with 165 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

198
plugins/org.eclipse.dd.dsf.debug/src/org/eclipse/dd/dsf/debug/service/IExpressions.java
View file

@ -20,74 +20,206 @@ import org.eclipse.dd.dsf.datamodel.IDMEvent;
import org.eclipse.dd.dsf.datamodel.IDMService; import org.eclipse.dd.dsf.datamodel.IDMService;
/** /**
* Expressions service provides access to the debugger's expression evaluator. * Expressions service provides access to the debugger's expression evaluator. This service has
* This service has dependencies on the Modules service, RunControl service, and * dependencies on the Modules service, RunControl service, and Stack service, as all may be used to
* Stack service, as all may be used to provide context for an expression to be * provide context for an expression to be evaluated.
* evaluated.
*/ */
public interface IExpressions extends IDMService { public interface IExpressions extends IDMService {
/** /**
* Expression context. Since some expressions have children, expression * Expression context. Since some expressions have children, expression contexts can be have an
* contexts can be have an arbitrary number of parents of type * arbitrary number of parents of type ExpressionContext.
* ExpressionContext.
*/ */
public interface IExpressionDMContext extends IDMContext<IExpressionDMData> { public interface IExpressionDMContext extends IDMContext<IExpressionDMData> {
String getExpression(); String getExpression();
} }
/** /**
* Expression data. It is based pretty closely on what DFW's info-retrieve * This is the model data interface that corresponds to IExpressionDMContext.
* node for expressions.
*/ */
public interface IExpressionDMData extends IDMData { interface IExpressionDMData extends IDMData {
// These static fields define the possible return values of method getTypeId(). QUESTION: Why can't
// these have type int?
final static String TYPEID_UNKNOWN = "TYPEID_UNKNOWN"; //$NON-NLS-1$
final static String TYPEID_INTEGER = "TYPEID_INTEGER"; //$NON-NLS-1$
final static String TYPEID_CHAR = "TYPEID_CHAR"; //$NON-NLS-1$
final static String TYPEID_FLOAT = "TYPEID_FLOAT"; //$NON-NLS-1$
final static String TYPEID_DOUBLE = "TYPEID_DOUBLE"; //$NON-NLS-1$
final static String TYPEID_OPAQUE = "TYPEID_OPAQUE"; //$NON-NLS-1$
/**
* This enumerates the possible basic types that an expression can have.
*
* @see Method getBasicType().
*/
enum BasicType {
unknown, // Unknown type.
basic, // Scalar type (e.g., int, short, float).
pointer, // Pointer to anything.
array, // Array of anything.
composite, // Struct, union, or class.
enumeration, // Enumeration.
function // Function.
}
/**
* ISSUE: Should this method be named getExpression() instead?
*
* @return The original expression string that was supplied to IExpressions.createExpression().
*/
String getName(); String getName();
public enum BasicType { basic, pointer, array, composite, enumeration, function }
/**
* @return A BasicType enumerator describing the basic type of an expression.
*/
BasicType getBasicType(); BasicType getBasicType();
/**
* @return The source code type of this expression. This is a string such as "struct Foo", "short",
* "int *", "mytypedef", "(int *)[]", "enum Bar". If the debugger backend cannot supply
* this information, this method returns "<UNKNOWN>" (the angle brackets are there just in
* case there is a type named "UNKNOWN" in the application).
*/
String getTypeName(); String getTypeName();
/**
* This method needs to be defined. For now, this returns the empty string.
*/
String getEncoding(); String getEncoding();
/**
* @return One of the TYPEID_* static field values defined by this interface.
*/
String getTypeId(); String getTypeId();
/**
* @return The number of bits in the value of the expression. For a bit field, this is the number
* of bits in the field. For other types, this is 8 times the number of bytes in the value.
*/
int getBitCount(); int getBitCount();
/**
* @return A string containing the value of the expression in a format that is natural for its type.
* For example, type "char" is shown as a single-quoted character, type "int" (and its cousins)
* is shown in decimal, type "unsigned int" (and its cousins) and pointers are shown in hex,
* floating point values are shown in non-scientific notation.
*/
String getNaturalValue(); String getNaturalValue();
/**
* @return A string containing the hexadecimal representation of the expression value. If the
* expression value is not convertable to an integer, this returns "UNKNOWN".
*/
String getHexValue(); String getHexValue();
/**
* @return A string containing the octal representation of the expression value. If the
* expression value is not convertable to an integer, this returns "UNKNOWN".
*/
String getOctalValue(); String getOctalValue();
/**
* @return A string containing the binary representation of the expression value. If the
* expression value is not convertable to an integer, this returns "UNKNOWN".
*/
String getBinaryValue(); String getBinaryValue();
/**
* @return A string containing the value of the expression as returned by the debugger backend.
*/
String getStringValue(); String getStringValue();
/**
* @return An IAddress object representing the memory address of the value of the expression (if it
* has one). Non-lvalues do not have memory addresses (e.g., "x + 5"). When the expression
* has no address, this method returns an IAddress object on which isZero() returns true.
* ISSUE: It would be nice if there was a method IAddress.isValid() which could return false
* in this case.
*/
IAddress getAddress(); IAddress getAddress();
/**
* @return A Map in which the keys are strings that are the names of enumerators in the enumeration
* that is the value of this expression and the values are the integer values of the
* enumerators. If the expression type is not an enumeration, this returns an empty Map.
*/
Map<String, Integer> getEnumerations();
/**
* This method needs to be defined.
*/
IRegisters.IRegisterDMContext getRegister(); IRegisters.IRegisterDMContext getRegister();
Map<String,String> getEnumerations();
} }
/** /**
* Event indicating that a given expression is changed. If an expression * Event indicating that a given expression is changed. If an expression is changed, it's implied that all
* is changed, it's implied that all the children of that expression are * the children of that expression are changed too.
* changed too.
*/ */
public interface IExpressionChangedDMEvent extends IDMEvent<IExpressionDMContext> {} interface IExpressionChangedDMEvent extends IDMEvent<IExpressionDMContext> {}
/** /**
* Returns the context for the specified expression. * Returns the data model context object for the specified expression in the context of the symbols
* @param symCtx Symbol context in which to evaluate the expression. This parameter is required and cannot be null. * specified by <b>symbolsDmc</b>.
* @param execCtx Optional execution context for the evaluation. Can be null. *
* @param frameCtx Optional stack frame context for the evaluation. Can be null. * @param symbolsDmc: Symbol context in which to evaluate the expression. This parameter can be null if
* @param expression Expression to evaluate. * there is no symbol context available.
* @return Expression context. *
* @param expression: The expression to evaluate.
*
* @return An expression data model context object that must be passed to getModelData() to obtain the
* value of the expression.
*/ */
IExpressionDMContext createExpression(IModules.ISymbolDMContext symCtx, IRunControl.IExecutionDMContext execDmc, IStack.IFrameDMContext frameDmc, String expression); IExpressionDMContext createExpression(IModules.ISymbolDMContext symbolsDmc, String expression);
/** /**
* Retrieves the sub-expressions of the given expression. * Returns the data model context object for the specified expression in the context of the thread
* @param exprCtx Expression context to evaluate. * specified by <b>execDmc</b>.
* @param rm The return parameter is an Iterable because it's possible *
* that the sub-expressions as members of an array which could be very large. * @param execDmc: Optional execution context for the evaluation. This parameter cannot be null. If
* there is no execution context available, the client should instead call
* createExpression(ISymbolDMContext, String).
*
* @param expression: The expression to evaluate.
*
* @return An expression data model context object that must be passed to getModelData() to obtain the
* value of the expression.
*/
IExpressionDMContext createExpression(IRunControl.IExecutionDMContext execDmc, String expression);
/**
* Returns the data model context object for the specified expression in the context of the stack frame
* specified by <b>frameDmc</b>.
*
* @param frameDmc: Optional stack frame context for the evaluation. This parameter cannot be null. If
* there is no stack frame context available, the client should instead call
* createExpression(ISymbolDMContext, String) or createExpression(IExecutionDMContext, String).
*
* @param expression: The expression to evaluate.
*
* @return An expression data model context object that must be passed to getModelData() to obtain the
* value of the expression.
*/
IExpressionDMContext createExpression(IStack.IFrameDMContext frameDmc, String expression);
/**
* Retrieves the sub-expressions of the given expression. Sub-expressions are fields of a struct, union,
* or class, the enumerators of an enumeration, and the element of an array.
*
* @param exprCtx: The data model context representing an expression.
*
* @param rm: The return parameter is an Iterable because it's possible that the sub-expressions as
* members of an array which could be very large.
*/ */
void getSubExpressions(IExpressionDMContext exprCtx, DataRequestMonitor<Iterable<IExpressionDMContext>> rm); void getSubExpressions(IExpressionDMContext exprCtx, DataRequestMonitor<Iterable<IExpressionDMContext>> rm);
/** /**
* For object oriented languages, this method returns the expressions * For object oriented languages, this method returns the expressions representing base types of
* representing base types of the given expression type. * the given expression type.
* @param exprContext *
* @param rm Request completion monitor. * @param exprContext: The data model context representing an expression.
*
* @param rm: Request completion monitor.
*/ */
void getBaseExpressions(IExpressionDMContext exprContext, DataRequestMonitor<IExpressionDMContext[]> rm); void getBaseExpressions(IExpressionDMContext exprContext, DataRequestMonitor<IExpressionDMContext[]> rm);
} }