1 /* Subclasses of custom_edge_info for describing outcomes of function calls.
2 Copyright (C) 2021-2024 Free Software Foundation, Inc.
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GCC is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef GCC_ANALYZER_CALL_INFO_H
22 #define GCC_ANALYZER_CALL_INFO_H
26 /* Subclass of custom_edge_info for an outcome of a call.
27 This is still abstract; the update_model and get_desc vfuncs must be
30 class call_info
: public custom_edge_info
33 void print (pretty_printer
*pp
) const final override
;
34 void add_events_to_path (checker_path
*emission_path
,
35 const exploded_edge
&eedge
) const final override
;
37 const gcall
*get_call_stmt () const { return m_call_stmt
; }
38 tree
get_fndecl () const { return m_fndecl
; }
40 virtual label_text
get_desc (bool can_colorize
) const = 0;
42 call_details
get_call_details (region_model
*model
,
43 region_model_context
*ctxt
) const;
46 call_info (const call_details
&cd
);
47 call_info (const call_details
&cd
, const function
&called_fn
);
50 const gcall
*m_call_stmt
;
54 /* Subclass of call_info for a "success" outcome of a call,
56 "when `FNDECL' succeeds" message (when 'success' is true)
58 "when `FNDECL' fails" message (when 'success' is false).
59 This is still abstract: the custom_edge_info::update_model vfunc
60 must be implemented. */
62 class succeed_or_fail_call_info
: public call_info
65 label_text
get_desc (bool can_colorize
) const final override
;
68 succeed_or_fail_call_info (const call_details
&cd
, bool success
)
69 : call_info (cd
), m_success (success
) {}
74 /* Subclass of call_info for a "success" outcome of a call,
75 adding a "when `FNDECL' succeeds" message.
76 This is still abstract: the custom_edge_info::update_model vfunc
77 must be implemented. */
79 class success_call_info
: public succeed_or_fail_call_info
82 success_call_info (const call_details
&cd
)
83 : succeed_or_fail_call_info (cd
, true)
87 /* Subclass of call_info for a "failure" outcome of a call,
88 adding a "when `FNDECL' fails" message.
89 This is still abstract: the custom_edge_info::update_model vfunc
90 must be implemented. */
92 class failed_call_info
: public succeed_or_fail_call_info
95 failed_call_info (const call_details
&cd
)
96 : succeed_or_fail_call_info (cd
, false)
102 #endif /* GCC_ANALYZER_CALL_INFO_H */