Skip to content

Add documentation to goto_trace_constant_pointer_exprt #5037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/goto-programs/goto_trace.h
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,11 @@ void show_goto_trace(
options.set_option("stack-trace", true);

/// Variety of constant expression only used in the context of a GOTO trace, to
/// give both the numeric value and the symbolic value of a pointer.
/// give both the numeric value and the symbolic value of a pointer,
/// e.g. numeric value "0xabcd0004" but symbolic value "&some_object + 4". The
/// numeric value is stored in the `constant_exprt`'s usual value slot (see
/// \ref constant_exprt::get_value) and the symbolic value is accessed using the
/// `symbolic_pointer` method introduced by this class.
class goto_trace_constant_pointer_exprt : public constant_exprt
{
public:
Expand Down