1  /* Subclasses of custom_edge_info for describing outcomes of function calls.
       2     Copyright (C) 2021-2023 Free Software Foundation, Inc.
       3     Contributed by David Malcolm <dmalcolm@redhat.com>.
       4  
       5  This file is part of GCC.
       6  
       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.
      11  
      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.
      16  
      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/>.  */
      20  
      21  #ifndef GCC_ANALYZER_CALL_INFO_H
      22  #define GCC_ANALYZER_CALL_INFO_H
      23  
      24  namespace ana {
      25  
      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.  */
      29  
      30  class call_info : public custom_edge_info
      31  {
      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;
      36  
      37    const gcall *get_call_stmt () const { return m_call_stmt; }
      38    tree get_fndecl () const { return m_fndecl; }
      39  
      40    virtual label_text get_desc (bool can_colorize) const = 0;
      41  
      42    call_details get_call_details (region_model *model,
      43  				 region_model_context *ctxt) const;
      44  
      45  protected:
      46    call_info (const call_details &cd);
      47  
      48  private:
      49    const gcall *m_call_stmt;
      50    tree m_fndecl;
      51  };
      52  
      53  /* Subclass of call_info for a "success" outcome of a call,
      54     adding either a
      55       "when `FNDECL' succeeds" message (when 'success' is true)
      56     or a
      57       "when `FNDECL' fails" message    (when 'success' is false).
      58     This is still abstract: the custom_edge_info::update_model vfunc
      59     must be implemented.  */
      60  
      61  class succeed_or_fail_call_info : public call_info
      62  {
      63  public:
      64    label_text get_desc (bool can_colorize) const final override;
      65  
      66  protected:
      67    succeed_or_fail_call_info (const call_details &cd, bool success)
      68     : call_info (cd), m_success (success) {}
      69  
      70    bool m_success;
      71  };
      72  
      73  /* Subclass of call_info for a "success" outcome of a call,
      74     adding a "when `FNDECL' succeeds" message.
      75     This is still abstract: the custom_edge_info::update_model vfunc
      76     must be implemented.  */
      77  
      78  class success_call_info : public succeed_or_fail_call_info
      79  {
      80  protected:
      81    success_call_info (const call_details &cd)
      82    : succeed_or_fail_call_info (cd, true)
      83    {}
      84  };
      85  
      86  /* Subclass of call_info for a "failure" outcome of a call,
      87     adding a "when `FNDECL' fails" message.
      88     This is still abstract: the custom_edge_info::update_model vfunc
      89     must be implemented.  */
      90  
      91  class failed_call_info : public succeed_or_fail_call_info
      92  {
      93  protected:
      94    failed_call_info (const call_details &cd)
      95    : succeed_or_fail_call_info (cd, false)
      96    {}
      97  };
      98  
      99  } // namespace ana
     100  
     101  #endif /* GCC_ANALYZER_CALL_INFO_H */