Memory Rendering Types

org.eclipse.debug.ui.memoryRenderingTypes

Eclipse 3.1

Allows plug-ins to contribute renderings for memory blocks. A rendering translates raw bytes of a memory block into text that can be displayed in the memory view. The debug platform provides a set of memory renderings (HEX, ASCII, Signed Integer and Unsigned Integer). NOTE: this extension point was provided in the 3.0 release as experimental API, subject to change, and became public API in the 3.1 release.

<!ELEMENT extension (rendering* | renderingBinding* | defaultRenderings* | viewBinding*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT rendering (renderingProperty* , viewBinding+)>

<!ATTLIST rendering

renderingId      CDATA #REQUIRED

name             CDATA #REQUIRED

renderingFactory CDATA #REQUIRED>

This element defines a rendering. A rendering is comprised of an id, a name, an optional rendering factory, and an optional list of rendering properties.



<!ELEMENT renderingProperty EMPTY>

<!ATTLIST renderingProperty

name        CDATA #REQUIRED

value       CDATA #REQUIRED

renderingId CDATA #IMPLIED>

Specifies rendering specific properties.



<!ELEMENT renderingBinding (enablement*)>

<!ATTLIST renderingBinding

renderingIds CDATA #REQUIRED>

Binds a type of memory block with available renderings.



<!ELEMENT defaultRenderings (enablement+)>

<!ATTLIST defaultRenderings

renderingIds CDATA #REQUIRED>

Specifies the default renderings to create for a specific type of memory block.



<!ELEMENT viewBinding EMPTY>

<!ATTLIST viewBinding

renderingId CDATA #IMPLIED

viewIds     CDATA #REQUIRED>

Define the views that are supported by the specified rendering



<!ELEMENT enablement (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

A generic root element. The element can be used inside an extension point to define its enablement expression. The children of an enablement expression are combined using the and operator.



<!ELEMENT not (not | and | or | instanceof | test | systemTest | equals | count | with | resolve | adapt | iterate)>

This element represent a NOT operation on the result of evaluating it's sub-element expression.



<!ELEMENT and (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

This element represent an AND operation on the result of evaluating all it's sub-elements expressions.



<!ELEMENT or (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

This element represent an OR operation on the result of evaluating all it's sub-element expressions.



<!ELEMENT instanceof EMPTY>

<!ATTLIST instanceof

value CDATA #REQUIRED>

This element is used to perform an instanceof check of the object in focus. The expression returns EvaluationResult.TRUE if the object's type is a sub type of the type specified by the attribute value. Otherwise EvaluationResult.FALSE is returned.



<!ELEMENT test EMPTY>

<!ATTLIST test

property CDATA #REQUIRED

args     CDATA #IMPLIED

value    CDATA #IMPLIED>

This element is used to evaluate the property state of the object in focus. The set of testable properties can be extended using the propery tester extension point. The test expression returns EvaluationResult.NOT_LOADED if teh property tester doing the actual testing isn't loaded yet.



<!ELEMENT systemTest EMPTY>

<!ATTLIST systemTest

property CDATA #REQUIRED

value    CDATA #REQUIRED>

Tests a system property by calling the System.getProperty method and compares the result with the value specified through the value attribute.



<!ELEMENT equals EMPTY>

<!ATTLIST equals

value CDATA #REQUIRED>

This element is used to perform an equals check of the object in focus. The expression returns EvaluationResult.TRUE if the object is equal to the value provided by the attribute value. Otherwise EvaluationResult.FALSE is returned.



<!ELEMENT count EMPTY>

<!ATTLIST count

value CDATA #REQUIRED>

This element is used to test the number of elements in a collection.



<!ELEMENT with (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST with

variable CDATA #REQUIRED>

This element changes the object to be inspected for all its child element to the object referneced by the given variable. If the variable can not be resolved then the expression will throw a ExpressionException when evaluating it. The children of a with expression are combined using the and operator.



<!ELEMENT resolve (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST resolve

variable CDATA #REQUIRED

args     CDATA #IMPLIED>

This element changes the object to be inspected for all its child element to the object referneced by the given variable. If the variable can not be resolved then the expression will throw a ExpressionException when evaluating it. The children of a with expression are combined using the and operator.



<!ELEMENT adapt (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST adapt

type CDATA #REQUIRED>

This element is used to adapt the object in focus to the type specified by the attribute type. The expression returns not loaded if either the adapter or the type referenced isn't loaded yet. It throws a ExpressionException during evaluation if the type name doesn't exist at all. The children of an adapt expression are combined using the and operator.



<!ELEMENT iterate (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST iterate

operator (or|and) >

This element is used to iterate over a variable that is of type java.util.Collection. If the object in focus is not of type java.util.Collection then an ExpressionException will be thrown while evaluating the expression.



The following is an example for defining a new rendering type.

<extension id=

"org.eclipse.debug.ui.renderings"

name=

"Sample Rendering Type"

point=

"org.eclipse.debug.ui.memoryRenderingTypes"

>

<rendering name=

"Sample Rendering"

renderingId=

"com.example.sampleRendering"

renderingFactory=

"com.example.SampleRenderingsFactory"

>

<renderingProperty name=

"viewTabFactory"

value=

"com.example.SampleViewTabFactory"

>

</renderingProperty>

<viewBinding viewIds=

"org.eclipse.debug.ui.MemoryView.RenderingViewPane"

/>

</rendering>

</extension>

In the above example, a new rendering type, Sample Rendering, is defined. This rendering type supports the rendering view pane from the Memory View.

The following is an example for allowing Sample Rendering to be displayed in the rendering view pane from the Memory View.

<extension id=

"com.example"

name=

"Sample Rendering Extension"

point=

"org.eclipse.debug.ui.memoryRenderingTypes"

>

<renderingBinding renderingIds=

"com.example.sampleRendering"

>

<enablement>

<instanceof value=

"com.example.SampleMemoryBlock"

/>

</enablement>

</renderingBinding>

<defaultRenderings renderingIds=

"com.example.sampleRendering"

>

<enablement>

<instanceof value=

"com.example.SampleMemoryBlock"

/>

</enablement>

</defaultRenderings>

</extension>

In the above example, the Sample Rendering is defined as a valid rendering for SampleMemoryBlock. Whenever SampleMemoryBlock is created in the Memory View, a Sample Rendering will be created.

  • Value of the attribute renderingFactory must be a fully qualifed name of a Java class that implements IMemoryRenderingFactory.
  • Value of the attribute value from the viewTabFactory rendering property must be a fully qualifed name of a Java class that implements IMemoryViewTabFactory.
  • Value of the attribute instanceof from the enablement element must be a fully qualified name of a Java class that implements the interface IMemoryBlock.
  • The debug platform provides the following rendering types:
  • Hex Rendering (rendering id: org.eclipse.debug.ui.rendering.raw_memory)
  • ASCII Rendering (rendering id: org.eclipse.debug.ui.rendering.ascii)
  • Signed Integer Rendering (rendering id: org.eclipse.debug.ui.rendering.signedint)
  • Unsigned Integer Rendering (rendering id: org.eclipse.debug.ui.rendering.unsignedint)