write_location_context.h

Go to the documentation of this file.

/*******************************************************************\
 
 Module: analyses variable-sensitivity write_location_context
 
 Author: Diffblue Ltd.
 
\*******************************************************************/
 
#ifndef CPROVER_ANALYSES_VARIABLE_SENSITIVITY_WRITE_LOCATION_CONTEXT_H
#define CPROVER_ANALYSES_VARIABLE_SENSITIVITY_WRITE_LOCATION_CONTEXT_H
 
#include <analyses/variable-sensitivity/context_abstract_object.h>
#include <iostream>
#include <stack>
 
class write_location_contextt : public context_abstract_objectt
{
public:
  explicit write_location_contextt(
    const abstract_object_pointert child,
    const typet &type)
    : context_abstract_objectt(child, type)
  {
  }
 
  write_location_contextt(
    const abstract_object_pointert child,
    const typet &type,
    bool top,
    bool bottom)
    : context_abstract_objectt(child, type, top, bottom)
  {
  }
 
  explicit write_location_contextt(
    const abstract_object_pointert child,
    const exprt &expr,
    const abstract_environmentt &environment,
    const namespacet &ns)
    : context_abstract_objectt(child, expr, environment, ns)
  {
  }
 
  virtual ~write_location_contextt()
  {
  }
 
  // Standard abstract_objectt interface
 
  bool has_been_modified(const abstract_object_pointert &before) const override;
 
  locationst get_location_union(const locationst &locations) const;
 
  void output(std::ostream &out, const class ai_baset &ai, const namespacet &ns)
    const override;
 
protected:
  CLONE
 
  abstract_object_pointert merge(
    const abstract_object_pointert &other,
    const widen_modet &widen_mode) const override;
  abstract_object_pointert
  meet(const abstract_object_pointert &other) const override;
 
  abstract_object_pointert abstract_object_merge_internal(
    const abstract_object_pointert &other) const override;
 
  abstract_object_pointert write(
    abstract_environmentt &environment,
    const namespacet &ns,
    const std::stack<exprt> &stack,
    const exprt &specifier,
    const abstract_object_pointert &value,
    bool merging_write) const override;
 
  static void
  output_last_written_locations(std::ostream &out, const locationst &locations);
 
  virtual locationst get_last_written_locations() const;
  void set_last_written_locations(const locationst &locations);
 
private:
  using combine_fn = std::function<abstract_objectt::combine_result(
    const abstract_object_pointert &op1,
    const abstract_object_pointert &op2)>;
  using write_location_context_ptrt =
    std::shared_ptr<const write_location_contextt>;
 
  abstract_object_pointert
  combine(const write_location_context_ptrt &other, combine_fn fn) const;
 
  // To enforce copy-on-write these are private and have read-only accessors
  locationst last_written_locations;
 
  context_abstract_object_ptrt
  update_location_context_internal(const locationst &locations) const override;
};
 
#endif // CPROVER_ANALYSES_VARIABLE_SENSITIVITY_WRITE_LOCATION_CONTEXT_H