Package ghidra.trace.database.listing

Class DBTraceCommentAdapter

java.lang.Object

ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager<DBTraceAddressSnapRangePropertyMapSpace<DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceCommentAdapter.DBTraceCommentEntry>>

ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap<DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceCommentAdapter.DBTraceCommentEntry>

ghidra.trace.database.listing.DBTraceCommentAdapter

All Implemented Interfaces:

ErrorHandler, DBTraceManager, DBTraceDelegatingManager<DBTraceAddressSnapRangePropertyMapSpace<DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceCommentAdapter.DBTraceCommentEntry>>, TraceAddressSnapRangePropertyMap<DBTraceCommentAdapter.DBTraceCommentEntry>, TraceAddressSnapRangePropertyMapOperations<DBTraceCommentAdapter.DBTraceCommentEntry>, SpatialMap<TraceAddressSnapRange,DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceAddressSnapRangePropertyMapTree.TraceAddressSnapRangeQuery>

public class DBTraceCommentAdapter
extends DBTraceAddressSnapRangePropertyMap<DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceCommentAdapter.DBTraceCommentEntry>

A property map for storing code unit comments

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DBTraceCommentAdapter.DBTraceCommentEntry	A comment entry

Nested classes/interfaces inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap

DBTraceAddressSnapRangePropertyMap.DBTraceAddressSnapRangePropertyMapDataFactory<T,DR extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<T>>

Nested classes/interfaces inherited from class ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager

AbstractDBTraceSpaceBasedManager.DBTraceSpaceEntry

Nested classes/interfaces inherited from interface ghidra.trace.database.space.DBTraceDelegatingManager

DBTraceDelegatingManager.ExcConsumer<T,E extends Throwable>, DBTraceDelegatingManager.ExcFunction<T,R,E extends Throwable>, DBTraceDelegatingManager.ExcPredicate<T,E extends Throwable>, DBTraceDelegatingManager.ExcSupplier<T,E extends Throwable>

Nested classes/interfaces inherited from interface ghidra.util.database.spatial.SpatialMap

SpatialMap.EmptySpatialMap<DS extends BoundedShape<?>,T,Q>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	EMPTY_STRING_ARRAY

Fields inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap

dataFactory, dataType

Fields inherited from class ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager

baseLanguage, dbh, lock, name, NO_ADDRESS_SPACE, regSpacesByContainer, spaces, spaceStore, spacesView, threadManager, trace

Fields inherited from interface ghidra.util.database.spatial.SpatialMap

EMPTY_MAP

Constructor Summary

Constructors

Constructor	Description
DBTraceCommentAdapter(DBHandle dbh, OpenMode openMode, ReadWriteLock lock, TaskMonitor monitor, Language baseLanguage, DBTrace trace, DBTraceThreadManager threadManager)

Method Summary

Modifier and Type	Method	Description
static String[]	arrayFromComment(String comment)	Split a comment into an array of lines
void	clearComments(Lifespan span, AddressRange range, CommentType commentType)	Clear all comments in the given box of the given type
static String	commentFromArray(String[] comment)	Construct a comment from an array of lines
String	getComment(long snap, Address address, CommentType commentType)	Get the comment at the given point
protected void	makeWay(DBTraceCommentAdapter.DBTraceCommentEntry entry, Lifespan span)	Truncate or delete and existing comment entry
DBTraceCommentAdapter.DBTraceCommentEntry	put(TraceAddressSnapRange shape, DBTraceCommentAdapter.DBTraceCommentEntry value)	Put an entry into the map
void	setComment(Lifespan lifespan, Address address, CommentType commentType, String comment)	Set a comment at the given address for the given lifespan

Methods inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap

clear, createSpace, deleteData, deleteValue, entries, firstEntry, firstKey, firstValue, getAddressSetView, getAddressSetView, getForSpace, getName, getRegisterSpace, getRegisterSpace, isEmpty, keys, orderedEntries, orderedKeys, orderedValues, readLock, reduce, remove, remove, size, values, writeLock

Methods inherited from class ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager

dbError, get, getActiveSpaces, getBaseLanguage, getForRegisterSpace, getForRegisterSpace, getForRegisterSpace, getLock, getSpaceByName, getTabledSpaces, getTrace, invalidateCache, loadSpaces, tableName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ghidra.trace.database.space.DBTraceDelegatingManager

checkIsInMemory, delegateAddressSet, delegateAny, delegateCollection, delegateDeleteB, delegateDeleteV, delegateFirst, delegateHashSet, delegateRead, delegateRead, delegateReadB, delegateReadI, delegateReadI, delegateReadOr, delegateWrite, delegateWriteAll, delegateWriteI, delegateWriteV

Methods inherited from interface ghidra.trace.model.map.TraceAddressSnapRangePropertyMapOperations

put, put, put, put

Field Details

EMPTY_STRING_ARRAY

protected static final String[] EMPTY_STRING_ARRAY

Constructor Details

DBTraceCommentAdapter

public DBTraceCommentAdapter(DBHandle dbh,
 OpenMode openMode,
 ReadWriteLock lock,
 TaskMonitor monitor,
 Language baseLanguage,
 DBTrace trace,
 DBTraceThreadManager threadManager)
                      throws IOException,
VersionException

Throws:

IOException

VersionException

Method Details

makeWay

protected void makeWay(DBTraceCommentAdapter.DBTraceCommentEntry entry,
 Lifespan span)

Truncate or delete and existing comment entry

It is assumed the entry intersects some implied address range.

Parameters:

entry - the entry to truncate or delete

span - the span that must be clear

setComment

public void setComment(Lifespan lifespan,
 Address address,
 CommentType commentType,
 String comment)

Set a comment at the given address for the given lifespan

Parameters:

lifespan - the lifespan

address - the address

commentType - the type of comment as in Listing.setComment(Address, CommentType, String)

comment - the comment

commentFromArray

public static String commentFromArray(String[] comment)

Construct a comment from an array of lines

Parameters:

comment - the lines or null

Returns:

the comment text or null

arrayFromComment

public static String[] arrayFromComment(String comment)

Split a comment into an array of lines

Parameters:

comment - the comment text or null

Returns:

the array of lines or null

getComment

public String getComment(long snap,
 Address address,
 CommentType commentType)

Get the comment at the given point

Parameters:

snap - the snap

address - the address

commentType - the type of comment

Returns:

the comment text

clearComments

public void clearComments(Lifespan span,
 AddressRange range,
 CommentType commentType)

Clear all comments in the given box of the given type

Parameters:

span - the lifespan fo the box

range - the address range of the box

commentType - a comment type to clear, or null to clear all.

put

public DBTraceCommentAdapter.DBTraceCommentEntry put(TraceAddressSnapRange shape,
 DBTraceCommentAdapter.DBTraceCommentEntry value)

Description copied from interface: SpatialMap

Put an entry into the map

Note that the map may copy, and possibly modify, the given value. The value returned is the value actually stored by the map. This may be useful when the map's values are identical to its records. This allows the creation of a "blank" entry with a given shape. The entry is then populated by the user.

 class MyDBDataRecord extends DBTreeDataRecord<MyShape, MyNodeShape, MyDBDataRecord> {
 	&#64;Override
 	protected void setValue(MyDBDataRecord value) {
 		// Do nothing: value ought to be null. Map will create and return "blank" record
 	}
 
 	protected MyDBDataRecord getValue() {
 		return this; // The record is the value
 	}
 }
 
 MyDBDataRecord rec = map.put(MyShape.create(args), null);
 rec.setSomething(6);
 rec.setAnother("My user data");
 

This practice is preferred when the values are not simple, and/or when the shape is a property of the value. In other cases, e.g., when the value is an enum or a Color, then DBTreeDataRecord.setRecordValue(Object) and DBTreeDataRecord.getRecordValue() should be implemented as field accessors.

Specified by:

put in interface SpatialMap<TraceAddressSnapRange,DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceAddressSnapRangePropertyMapTree.TraceAddressSnapRangeQuery>

Overrides:

put in class DBTraceAddressSnapRangePropertyMap<DBTraceCommentAdapter.DBTraceCommentEntry,DBTraceCommentAdapter.DBTraceCommentEntry>

Parameters:

shape - the shape of the entry

value - the value for the entry

Returns:

the value as stored in the map