Daily bump.
[official-gcc.git] / gcc / analyzer / call-info.h
blob369d217a22f5f2600725e98a3b7e746eaf46991d
1 /* Subclasses of custom_edge_info for describing outcomes of function calls.
2 Copyright (C) 2021 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)
10 any later version.
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
24 namespace ana {
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
28 implemented. */
30 class call_info : public custom_edge_info
32 public:
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;
45 protected:
46 call_info (const call_details &cd);
48 private:
49 const gcall *m_call_stmt;
50 tree m_fndecl;
53 /* Subclass of call_info for a "success" outcome of a call,
54 adding a "when `FNDECL' succeeds" message.
55 This is still abstract: the custom_edge_info::update_model vfunc
56 must be implemented. */
58 class success_call_info : public call_info
60 public:
61 label_text get_desc (bool can_colorize) const FINAL OVERRIDE;
63 protected:
64 success_call_info (const call_details &cd) : call_info (cd) {}
67 /* Subclass of call_info for a "failure" outcome of a call,
68 adding a "when `FNDECL' fails" message.
69 This is still abstract: the custom_edge_info::update_model vfunc
70 must be implemented. */
72 class failed_call_info : public call_info
74 public:
75 label_text get_desc (bool can_colorize) const FINAL OVERRIDE;
77 protected:
78 failed_call_info (const call_details &cd) : call_info (cd) {}
81 } // namespace ana
83 #endif /* GCC_ANALYZER_CALL_INFO_H */