summaryrefslogtreecommitdiffstatsabout
diff options
context:
space:
mode:
authorFrederic Leger2012-06-14 02:48:33 (EDT)
committer Anton Leherbauer2012-06-14 02:48:33 (EDT)
commitb33065d9c452fb5528f9a56cff72b9f623b4744c (patch)
tree313e6f7f93d1f026fe4d7bdc2494b4c037ed777c
parent495ce3633a9473289b8994466e4f9fbd782d13a6 (diff)
downloadorg.eclipse.tcf-b33065d9c452fb5528f9a56cff72b9f623b4744c.zip
org.eclipse.tcf-b33065d9c452fb5528f9a56cff72b9f623b4744c.tar.gz
org.eclipse.tcf-b33065d9c452fb5528f9a56cff72b9f623b4744c.tar.bz2
TCF Python: Bug 382488 - Trailing comma at the end of the TYPE_SOFTWARE
property name
-rw-r--r--python/src/tcf/services/breakpoints.py212
1 files changed, 118 insertions, 94 deletions
diff --git a/python/src/tcf/services/breakpoints.py b/python/src/tcf/services/breakpoints.py
index 23a5d2d..35a8f16 100644
--- a/python/src/tcf/services/breakpoints.py
+++ b/python/src/tcf/services/breakpoints.py
@@ -1,5 +1,5 @@
-# *******************************************************************************
-# * Copyright (c) 2011 Wind River Systems, Inc. and others.
+# *****************************************************************************
+# * Copyright (c) 2011, 2012 Wind River Systems, Inc. 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
@@ -7,20 +7,23 @@
# *
# * Contributors:
# * Wind River Systems - initial API and implementation
-# *******************************************************************************
+# *****************************************************************************
-"""
-Breakpoint is represented by unique identifier and set of properties.
-Breakpoint identifier (String id) needs to be unique across all hosts and targets.
+"""Breakpoint is represented by unique identifier and set of properties.
+
+Breakpoint identifier (String id) needs to be unique across all hosts and
+targets.
-Breakpoint properties (Map<String,Object>) is extendible collection of named attributes,
-which define breakpoint location and behavior. This module defines some common
-attribute names (see PROP_*), host tools and target agents may support additional attributes.
+Breakpoint properties (Map<String,Object>) is extendible collection of named
+attributes, which define breakpoint location and behavior. This module defines
+some common attribute names (see PROP_*), host tools and target agents may
+support additional attributes.
-For each breakpoint a target agent maintains another extendible collection of named attributes:
-breakpoint status (Map<String,Object>, see STATUS_*). While breakpoint properties are
-persistent and represent user input, breakpoint status reflects dynamic target agent reports
-about breakpoint current state, like actual addresses where breakpoint is planted or planting errors.
+For each breakpoint a target agent maintains another extendible collection of
+named attributes: breakpoint status (Map<String,Object>, see STATUS_*). While
+breakpoint properties are persistent and represent user input, breakpoint
+status reflects dynamic target agent reports about breakpoint current state,
+like actual addresses where breakpoint is planted or planting errors.
"""
from tcf import services
@@ -52,15 +55,15 @@ PROP_CONDITION = "Condition" # String
PROP_TEMPORARY = "Temporary" # Boolean
# BreakpointType values
-TYPE_SOFTWARE = "Software",
+TYPE_SOFTWARE = "Software"
TYPE_HARDWARE = "Hardware"
TYPE_AUTO = "Auto"
# AccessMode values
-ACCESSMODE_READ = 0x01
-ACCESSMODE_WRITE = 0x02
+ACCESSMODE_READ = 0x01
+ACCESSMODE_WRITE = 0x02
ACCESSMODE_EXECUTE = 0x04
-ACCESSMODE_CHANGE = 0x08
+ACCESSMODE_CHANGE = 0x08
# TimeScale values
TIMESCALE_RELATIVE = "Relative"
@@ -72,16 +75,16 @@ TIMEUNIT_CYCLE_COUNT = "CycleCount"
TIMEUNIT_INSTRUCTION_COUNT = "InstructionCount"
# Breakpoint status field names.
-STATUS_INSTANCES = "Instances" # Array of Map<String,Object>
-STATUS_ERROR= "Error" # String
-STATUS_FILE = "File" # String
-STATUS_LINE = "Line" # Number
-STATUS_COLUMN = "Column" # Number
+STATUS_INSTANCES = "Instances" # Array of Map<String,Object>
+STATUS_ERROR = "Error" # String
+STATUS_FILE = "File" # String
+STATUS_LINE = "Line" # Number
+STATUS_COLUMN = "Column" # Number
# Breakpoint instance field names.
-INSTANCE_ERROR = "Error" # String
-INSTANCE_CONTEXT = "LocationContext" # String
-INSTANCE_ADDRESS = "Address" # Number
+INSTANCE_ERROR = "Error" # String
+INSTANCE_CONTEXT = "LocationContext" # String
+INSTANCE_ADDRESS = "Address" # Number
# Breakpoint service capabilities.
CAPABILITY_CONTEXT_ID = "ID" # String
@@ -94,220 +97,241 @@ CAPABILITY_STOP_GROUP = "StopGroup" # Boolean
CAPABILITY_IGNORECOUNT = "IgnoreCount" # Boolean
CAPABILITY_ACCESSMODE = "AccessMode" # Number
+
class BreakpointsService(services.Service):
def getName(self):
return NAME
- def set(self, properties, done):
- """
- Download breakpoints data to target agent.
- The command is intended to be used only to initialize target breakpoints table
- when communication channel is open. After that, host should
- notify target about (incremental) changes in breakpoint data by sending
- add, change and remove commands.
+ def set(self, properties, done): # @ReservedAssignment
+ """Download breakpoints data to target agent.
+
+ The command is intended to be used only to initialize target
+ breakpoints table when communication channel is open. After that, host
+ should notify target about (incremental) changes in breakpoint data by
+ sending add, change and remove commands.
@param properties - array of breakpoints.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneCommand
"""
raise NotImplementedError("Abstract method")
def add(self, properties, done):
- """
- Called when breakpoint is added into breakpoints table.
+ """Called when breakpoint is added into breakpoints table.
+
@param properties - breakpoint properties.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneCommand
"""
raise NotImplementedError("Abstract method")
def change(self, properties, done):
- """
- Called when breakpoint properties are changed.
+ """Called when breakpoint properties are changed.
+
@param properties - breakpoint properties.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneCommand
"""
raise NotImplementedError("Abstract method")
def enable(self, ids, done):
- """
- Tell target to change (only) PROP_ENABLED breakpoint property to 'true'.
+ """Tell target to change (only) PROP_ENABLED breakpoint property to
+ 'true'.
+
@param ids - array of enabled breakpoint identifiers.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneCommand
"""
raise NotImplementedError("Abstract method")
def disable(self, ids, done):
- """
- Tell target to change (only) PROP_ENABLED breakpoint property to 'false'.
+ """Tell target to change (only) PROP_ENABLED breakpoint property to
+ 'false'.
+
@param ids - array of disabled breakpoint identifiers.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneCommand
"""
raise NotImplementedError("Abstract method")
def remove(self, ids, done):
- """
- Tell target to remove breakpoints.
+ """Tell target to remove breakpoints.
+
@param id - unique breakpoint identifier.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneCommand
"""
raise NotImplementedError("Abstract method")
def getIDs(self, done):
- """
- Upload IDs of breakpoints known to target agent.
+ """Upload IDs of breakpoints known to target agent.
+
@param done - command result call back object.
+
@return - pending command handle.
@see DoneGetIDs
"""
raise NotImplementedError("Abstract method")
- def getProperties(self, id, done):
- """
- Upload properties of given breakpoint from target agent breakpoint table.
- @param id - unique breakpoint identifier.
+ def getProperties(self, bpID, done):
+ """Upload properties of given breakpoint from target agent breakpoint
+ table.
+
+ @param bpID - unique breakpoint identifier.
@param done - command result call back object.
+
@see DoneGetProperties
"""
raise NotImplementedError("Abstract method")
- def getStatus(self, id, done):
- """
- Upload status of given breakpoint from target agent.
- @param id - unique breakpoint identifier.
+ def getStatus(self, bpID, done):
+ """Upload status of given breakpoint from target agent.
+
+ @param bpID - unique breakpoint identifier.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneGetStatus
"""
raise NotImplementedError("Abstract method")
- def getCapabilities(self, id, done):
- """
- Report breakpoint service capabilities to clients so they
- can adjust to different implementations of the service.
- When called with a None ("") context ID the global capabilities are returned,
- otherwise context specific capabilities are returned. A special capability
- property is used to indicate that all child contexts have the same
- capabilities.
+ def getCapabilities(self, bpID, done):
+ """Report breakpoint service capabilities to clients so they can adjust
+ to different implementations of the service.
+
+ When called with a None ("") context ID the global capabilities are
+ returned, otherwise context specific capabilities are returned. A
+ special capability property is used to indicate that all child contexts
+ have the same capabilities.
+
@param id - a context ID or None.
@param done - command result call back object.
+
@return - pending command handle.
@see DoneGetCapabilities
"""
raise NotImplementedError("Abstract method")
def addListener(self, listener):
- """
- Add breakpoints service event listener.
+ """Add breakpoints service event listener.
+
@param listener - object that implements BreakpointsListener interface.
"""
raise NotImplementedError("Abstract method")
def removeListener(self, listener):
- """
- Remove breakpoints service event listener.
+ """Remove breakpoints service event listener.
+
@param listener - object that implements BreakpointsListener interface.
"""
raise NotImplementedError("Abstract method")
class DoneCommand(object):
- "Call back interface for breakpoint service commands."
+ """Call back interface for breakpoint service commands."""
def doneCommand(self, token, error):
- """
- Called when command is done.
+ """Called when command is done.
+
@param token - command handle.
@param error - error object or None.
"""
pass
+
class DoneGetIDs(object):
- "Call back interface for 'getIDs' command."
+ """Call back interface for 'getIDs' command."""
def doneGetIDs(self, token, error, ids):
- """
- Called when 'getIDs' command is done.
+ """Called when 'getIDs' command is done.
+
@param token - command handle.
@param error - error object or None.
@param ids - IDs of breakpoints known to target agent.
"""
pass
+
class DoneGetProperties(object):
- "Call back interface for 'getProperties' command."
+ """Call back interface for 'getProperties' command."""
def doneGetProperties(self, token, error, properties):
- """
- Called when 'getProperties' command is done.
+ """Called when 'getProperties' command is done.
+
@param token - command handle.
@param error - error object or None.
@param properties - properties of the breakpoint.
"""
pass
+
class DoneGetStatus(object):
- "Call back interface for 'getStatus' command."
+ """Call back interface for 'getStatus' command."""
def doneGetStatus(self, token, error, status):
- """
- Called when 'getStatus' command is done.
+ """Called when 'getStatus' command is done.
+
@param token - command handle.
@param error - error object or None.
@param status - status of the breakpoint.
"""
pass
+
class DoneGetCapabilities(object):
- "Call back interface for 'getCapabilities' command."
+ """Call back interface for 'getCapabilities' command."""
def doneGetCapabilities(self, token, error, capabilities):
- """
- Called when 'getCapabilities' command is done.
+ """Called when 'getCapabilities' command is done.
+
@param token - command handle.
@param error - error object or None.
@param capabilities - breakpoints service capabilities description.
"""
pass
+
class BreakpointsListener(object):
- """
- Breakpoints service events listener.
- Note that contextAdded, contextChanged and contextRemoved events carry exactly same set
- of breakpoint properties that was sent by a client to a target. The purpose of these events is to
- let all clients know about breakpoints that were created by other clients.
+ """Breakpoints service events listener.
+
+ Note that contextAdded, contextChanged and contextRemoved events carry
+ exactly same set of breakpoint properties that was sent by a client to a
+ target. The purpose of these events is to let all clients know about
+ breakpoints that were created by other clients.
"""
- def breakpointStatusChanged(self, id, status):
- """
- Called when breakpoint status changes.
- @param id - unique breakpoint identifier.
+ def breakpointStatusChanged(self, bpID, status):
+ """Called when breakpoint status changes.
+
+ @param bpID - unique breakpoint identifier.
@param status - breakpoint status.
"""
pass
def contextAdded(self, bps):
- """
- Called when a new breakpoints are added.
+ """Called when a new breakpoints are added.
+
@param bps - array of breakpoints.
"""
pass
def contextChanged(self, bps):
- """
- Called when breakpoint properties change.
+ """Called when breakpoint properties change.
+
@param bps - array of breakpoints.
"""
pass
def contextRemoved(self, ids):
- """
- Called when breakpoints are removed .
+ """Called when breakpoints are removed .
+
@param ids - array of breakpoint IDs.
"""
pass