ghidra::CommentDatabaseInternal Class Reference

An in-memory implementation of the CommentDatabase API. More...

#include <comment.hh>

Inheritance diagram for ghidra::CommentDatabaseInternal:

Public Member Functions
	CommentDatabaseInternal (void)
	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. More...
virtual void	addComment (uint4 tp, const Address &fad, const Address &ad, const string &txt)
	Add a new comment to the container. More...
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. More...
virtual void	deleteComment (Comment *com)
	Remove the given Comment object from the container. More...
virtual CommentSet::const_iterator	beginComment (const Address &fad) const
	Get an iterator to the beginning of comments for a single function. More...
virtual CommentSet::const_iterator	endComment (const Address &fad) const
	Get an iterator to the ending of comments for a single function. More...
virtual void	encode (Encoder &encoder) const
	Encode all comments in the container to a stream. More...
virtual void	decode (Decoder &decoder)
	Restore all comments from a <commentdb> element. More...
Public Member Functions inherited from ghidra::CommentDatabase
	CommentDatabase (void)
	Constructor.
virtual	~CommentDatabase (void)
	Destructor.

Private Attributes
CommentSet	commentset
	The sorted set of Comment objects.

Detailed Description

An in-memory implementation of the CommentDatabase API.

All Comment objects are held in memory in a sorted container. This can be used as stand-alone database of comments, or it can act as a cache for some other container.

Member Function Documentation

addComment()

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

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

Implements ghidra::CommentDatabase.

References commentset, and ghidra::Comment::uniq.

Referenced by ghidra::CommentDatabaseGhidra::addComment(), and decode().

addCommentNoDuplicate()

bool ghidra::CommentDatabaseInternal::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

Returns

true if a new Comment was created, false if there was a duplicate

Implements ghidra::CommentDatabase.

References commentset, and ghidra::Comment::uniq.

Referenced by ghidra::CommentDatabaseGhidra::addCommentNoDuplicate().

beginComment()

CommentSet::const_iterator ghidra::CommentDatabaseInternal::beginComment ( const Address &  fad ) const

virtual

Get an iterator to the beginning of comments for a single function.

Parameters

fad	is the address of the function

Returns

the beginning iterator

Implements ghidra::CommentDatabase.

References commentset, and ghidra::Address::m_minimal.

Referenced by ghidra::CommentDatabaseGhidra::beginComment(), and ghidra::CommentDatabaseGhidra::fillCache().

clearType()

void ghidra::CommentDatabaseInternal::clearType ( const Address &  fad, uint4  tp  )

virtual

Clear all comments matching (one of) the indicated types.

Clearing is restricted to comments belonging to a specific function and matching at least one of the given properties

Parameters

fad	is the address of the owning function
tp	is a set of one or more properties

Implements ghidra::CommentDatabase.

References commentset, ghidra::Address::m_maximal, and ghidra::Address::m_minimal.

Referenced by ghidra::CommentDatabaseGhidra::clearType().

decode()

void ghidra::CommentDatabaseInternal::decode ( Decoder &  decoder )

virtual

Restore all comments from a <commentdb> element.

Parameters

decoder

is the stream decoder

Implements ghidra::CommentDatabase.

References addComment(), ghidra::Decoder::closeElement(), ghidra::Comment::decode(), ghidra::Comment::getAddr(), ghidra::Comment::getFuncAddr(), ghidra::Comment::getText(), ghidra::Comment::getType(), ghidra::Decoder::openElement(), and ghidra::Decoder::peekElement().

Referenced by ghidra::CommentDatabaseGhidra::fillCache().

deleteComment()

void ghidra::CommentDatabaseInternal::deleteComment ( Comment *  com )

virtual

Remove the given Comment object from the container.

Parameters

com	is the given Comment

Implements ghidra::CommentDatabase.

References commentset.

encode()

void ghidra::CommentDatabaseInternal::encode ( Encoder &  encoder ) const

virtual

Encode all comments in the container to a stream.

Writes a <commentdb> element, with <comment> children for each Comment object.

Parameters

encoder

is the stream encoder

Implements ghidra::CommentDatabase.

References ghidra::Encoder::closeElement(), commentset, and ghidra::Encoder::openElement().

endComment()

CommentSet::const_iterator ghidra::CommentDatabaseInternal::endComment ( const Address &  fad ) const

virtual

Get an iterator to the ending of comments for a single function.

Parameters

fad	is the address of the function

Returns

the ending iterator

Implements ghidra::CommentDatabase.

References commentset, and ghidra::Address::m_maximal.

Referenced by ghidra::CommentDatabaseGhidra::endComment(), and ghidra::CommentDatabaseGhidra::fillCache().

---

The documentation for this class was generated from the following files:

• comment.hh
• comment.cc