Toggle Breakpoints Target Factories

Identifier:
org.eclipse.debug.ui.toggleBreakpointsTargetFactories

Since:
3.5

Description:
This extension point provides a mechanism for contributing breakpoint toggle action targets which can be registered for specific editors, debug models, or files.

Configuration Markup:

<!ELEMENT extension (toggleTargetFactory+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT toggleTargetFactory (enablement?)>

<!ATTLIST toggleTargetFactory

id    CDATA #REQUIRED

class CDATA #REQUIRED>

Element declaring a toggle breakpoints target factory. This element can optionally contain an enablement element which determines when this factory is going to be applicable. The evaluation context for the enablement expression includes: (default variable) - the active workbench part of type IWorkbenchPart "debugContext" - currently active debug context selection, of type List "editorInput" - the editor input to the editor if the currently active part is an editor, of type IEditorInput "selection" - the current selection in the active part, of type List



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

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 | reference)>

This element represents a NOT operation on the result of evaluating its sub-element expression.



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

This element represents an AND operation on the result of evaluating all its sub-elements expressions.



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

This element represent an OR operation on the result of evaluating all its 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

forcePluginActivation (true | false) >

This element is used to evaluate the property state of the object in focus. The set of testable properties can be extended using the org.eclipse.core.expressions.propertyTesters extension point. The test expression returns EvaluationResult.NOT_LOADED if the property tester doing the actual testing isn't loaded yet and the attribute forcePluginActivation is set to false. If forcePluginActivation is set to true and the evaluation context used to evaluate this expression support plug-in activation then evaluating the property will result in activating the plug-in defining the tester.



<!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 , reference)*>

<!ATTLIST with

variable CDATA #REQUIRED>

This element changes the object to be inspected for all its child element to the object referenced by the given variable. If the variable can not be resolved then the expression will throw an 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 , reference)*>

<!ATTLIST resolve

variable CDATA #REQUIRED

args     CDATA #IMPLIED>

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



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

<!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 EvaluationResult.NOT_LOADED if either the adapter or the type referenced isn't loaded yet. It throws an 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 , reference)*>

<!ATTLIST iterate

operator (or|and)

ifEmpty  (true | false) >

This element is used to iterate over a variable that is of type java.util.Collection, or a variable that adapts to org.eclipse.core.expressions.IIterable. If the object in focus is not one of the above then a CoreException with an ExpressionStatus will be thrown while evaluating the expression. The child expressions of an iterate expression are combined using the "and" operator.



<!ELEMENT reference EMPTY>

<!ATTLIST reference

definitionId IDREF #REQUIRED>

This element is used to reference an expression from the org.eclipse.core.expressions.definitions extension point. The expression definition will be evaluated within the current expression element using the current evaluation context.



Examples:
The following is an example of a breakpoint toggle target factory extension.


 <extension point="org.eclipse.debug.ui.toggleBreakpointsTargetFactories">
  <toggleTargetFactory
   id="com.example.ExampleBreakpointToggleTargetFactory"
   class="com.example.BreakpointToggleTargetFactory">
      <enablement>
         <!-- Test the active debug context.  Enable only if the active context
              is an element from "Example" debugger, or if there is no debug context 
              associated with the context element.  Also enable if debug context is
              empty -->
         <with variable="debugContext">
            <iterate>
             <or>
                <test property="org.eclipse.debug.ui.getModelIdentifier" value="com.example.model"/>
                <test property="org.eclipse.debug.ui.getModelIdentifier" value=""/>
             </or>
         </iterate>
         </with>
         <!-- If the debug context matches of if there isno active debug context.  
              Enable the breakpoint toggle for the "Example" editors -->
         <instanceof value="com.example.Editor"/>
      </enablement>
  </toggleTargetFactory>
 </extension>

API Information:
Value of the attribute class must be a fully qualified name of a Java class that implements the interface org.eclipse.debug.ui.actions.IToggleBreakpointsTargetFactory.

Supplied Implementation:
[Enter information about supplied implementation of this extension point.]


Copyright (c) 2007, 2011 Wind River Systems and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html