An implementation of CommentDatabase backed by a Ghidra client. More...

#include <comment_ghidra.hh>

Inheritance diagram for ghidra::CommentDatabaseGhidra:

Collaboration diagram for ghidra::CommentDatabaseGhidra:

Public Member Functions
	CommentDatabaseGhidra (ArchitectureGhidra *g)
	Constructor.

virtual void	clear (void)
	Clear all comments from this container.

virtual void	clearType (const Address &fad, uint4 tp)
	Clear all comments matching (one of) the indicated types.

virtual void	addComment (uint4 tp, const Address &fad, const Address &ad, const string &txt)

virtual bool	addCommentNoDuplicate (uint4 tp, const Address &fad, const Address &ad, const string &txt)
	Add a new comment to the container, making sure there is no duplicate.

virtual void	deleteComment (Comment *com)
	Remove the given Comment object from the container.

virtual CommentSet::const_iterator	beginComment (const Address &fad) const
	Get an iterator to the beginning of comments for a single function.

virtual CommentSet::const_iterator	endComment (const Address &fad) const
	Get an iterator to the ending of comments for a single function.

virtual void	encode (Encoder &encoder) const
	Encode all comments in the container to a stream.

virtual void	decode (Decoder &decoder)
	Decode all comments from a <commentdb> element.

Public Member Functions inherited from ghidra::CommentDatabase
	CommentDatabase (void)
	Constructor.

virtual	~CommentDatabase (void)
	Destructor.

Private Member Functions
void	fillCache (const Address &fad) const
	Fetch comments for the given function.

Private Attributes
ArchitectureGhidra *	ghidra
	The Architecture and connection to the Ghidra client.

CommentDatabaseInternal	cache
	A cache of Comment objects received from the Ghidra client.

bool	cachefilled
	Set to true if comments for the current function have been fetched.

Detailed Description

An implementation of CommentDatabase backed by a Ghidra client.

Comment information about particular functions is obtained by querying a Ghidra client. All comments for a single function are queried at once, and results are cached in this object. The cache needs to be cleared between functions using the clear() method.

Member Function Documentation

◆ addComment()

void ghidra::CommentDatabaseGhidra::addComment	(	uint4	tp,
		const Address &	fad,
		const Address &	ad,
		const string &	txt
	)

virtual

For the Ghidra implementation of CommentDatabase, addComment() is currently only called by the warning routines which generates the warning and warningheader comment types. Neither of these types is intended to be a permanent comment in the database, so we only add the comment to the cache

Implements ghidra::CommentDatabase.

References ghidra::CommentDatabaseInternal::addComment(), and cache.

◆ addCommentNoDuplicate()

bool ghidra::CommentDatabaseGhidra::addCommentNoDuplicate	(	uint4	tp,
		const Address &	fad,
		const Address &	ad,
		const string &	txt
	)

virtual

Add a new comment to the container, making sure there is no duplicate.

If there is already a comment at the same address with the same body, no new comment is added.

Parameters

tp	is a set of properties to associate with the new comment (may be zero)
fad	is the address of the function to which the comment belongs
ad	is the address to which the comment is attached
txt	is the body of the comment