An interface to a container of comments. More...

#include <comment.hh>

Inheritance diagram for ghidra::CommentDatabase:

Public Member Functions
	CommentDatabase (void)
	Constructor.

virtual	~CommentDatabase (void)
	Destructor.

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

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

virtual void	addComment (uint4 tp, const Address &fad, const Address &ad, const string &txt)=0
	Add a new comment to the container. More...

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

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

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

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

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

virtual void	decode (Decoder &decoder)=0
	Restore all comments from a <commentdb> element. More...

Detailed Description

An interface to a container of comments.

Comments can be added (and removed) from a database, keying on the function and address the Comment is attached to. The interface can generate a begin and end iterator covering all Comment objects for a single function.

Member Function Documentation

◆ addComment()

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

pure virtual

Add a new comment to the container.

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

Implemented in ghidra::CommentDatabaseInternal, and ghidra::CommentDatabaseGhidra.

◆ addCommentNoDuplicate()

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

pure 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