Ghidra Decompiler Analysis Engine
Public Member Functions | List of all members
IfcCommentInstr Class Reference

Attach a comment to an address: comment <address> comment text... More...

Inheritance diagram for IfcCommentInstr:
Inheritance graph
[legend]
Collaboration diagram for IfcCommentInstr:
Collaboration graph
[legend]

Public Member Functions

virtual void execute (istream &s)
 
- Public Member Functions inherited from IfaceDecompCommand
virtual void setData (IfaceStatus *root, IfaceData *data)
 Associate a specific data object with this command. More...
 
virtual string getModule (void) const
 Get the formal module name to which this command belongs. More...
 
virtual IfaceDatacreateData (void)
 Create a specialized data object for this command (and its module) More...
 
virtual void iterationCallback (Funcdata *fd)
 Perform the per-function aspect of this command. More...
 
void iterateFunctionsAddrOrder (void)
 Iterate command over all functions in all scopes. More...
 
void iterateFunctionsLeafOrder (void)
 Iterate command over all functions in a call-graph traversal. More...
 
- Public Member Functions inherited from IfaceCommand
void addWord (const string &temp)
 Add a token to the command line string associated with this command. More...
 
void addWords (const vector< string > &wordlist)
 Add words to the associated command line string.
 
void commandString (string &res) const
 Get the complete command line string. More...
 
int4 compare (const IfaceCommand &op2) const
 Order two commands by their command line strings. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IfaceDecompCommand
void iterateScopesRecursive (Scope *scope)
 Iterate recursively over all functions in given scope. More...
 
void iterateFunctionsAddrOrder (Scope *scope)
 Iterate over all functions in a given scope. More...
 
- Protected Attributes inherited from IfaceDecompCommand
IfaceStatusstatus
 The console owning this command.
 
IfaceDecompDatadcp
 Data common to decompiler commands.
 

Detailed Description

Attach a comment to an address: comment <address> comment text...

Add a comment to the database, suitable for integration into decompiler output for the current function. The command-line takes the address of the machine instruction which the comment will be attached to and is followed by the text of the comment.

Member Function Documentation

◆ execute()

void IfcCommentInstr::execute ( istream &  s)
virtual

Execute this command. Additional state can be read from the given command line stream. Otherwise, the command gets its data from its registered IfaceData object

Parameters
sis the input stream from the command line

Implements IfaceCommand.


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