c_expr.h

Go to the documentation of this file.

/*******************************************************************\
 
Module: API to expression classes that are internal to the C frontend
 
Author: Daniel Kroening, kroening@kroening.com
 
\*******************************************************************/
 
#ifndef CPROVER_ANSI_C_C_EXPR_H
#define CPROVER_ANSI_C_C_EXPR_H
 
 
#include <util/std_code.h>
 
class shuffle_vector_exprt : public multi_ary_exprt
{
public:
  shuffle_vector_exprt(
    exprt vector1,
    optionalt<exprt> vector2,
    exprt::operandst indices);
 
  const vector_typet &type() const
  {
    return static_cast<const vector_typet &>(multi_ary_exprt::type());
  }
 
  vector_typet &type()
  {
    return static_cast<vector_typet &>(multi_ary_exprt::type());
  }
 
  const exprt &vector1() const
  {
    return op0();
  }
 
  exprt &vector1()
  {
    return op0();
  }
 
  const exprt &vector2() const
  {
    return op1();
  }
 
  exprt &vector2()
  {
    return op1();
  }
 
  bool has_two_input_vectors() const
  {
    return vector2().is_not_nil();
  }
 
  const exprt::operandst &indices() const
  {
    return op2().operands();
  }
 
  exprt::operandst &indices()
  {
    return op2().operands();
  }
 
  vector_exprt lower() const;
};
 
template <>
inline bool can_cast_expr<shuffle_vector_exprt>(const exprt &base)
{
  return base.id() == ID_shuffle_vector;
}
 
inline void validate_expr(const shuffle_vector_exprt &value)
{
  validate_operands(value, 3, "shuffle_vector must have three operands");
}
 
inline const shuffle_vector_exprt &to_shuffle_vector_expr(const exprt &expr)
{
  PRECONDITION(expr.id() == ID_shuffle_vector);
  const shuffle_vector_exprt &ret =
    static_cast<const shuffle_vector_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
inline shuffle_vector_exprt &to_shuffle_vector_expr(exprt &expr)
{
  PRECONDITION(expr.id() == ID_shuffle_vector);
  shuffle_vector_exprt &ret = static_cast<shuffle_vector_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
class side_effect_expr_overflowt : public side_effect_exprt
{
public:
  side_effect_expr_overflowt(
    const irep_idt &kind,
    exprt _lhs,
    exprt _rhs,
    exprt _result,
    const source_locationt &loc)
    : side_effect_exprt(
        "overflow-" + id2string(kind),
        {std::move(_lhs), std::move(_rhs), std::move(_result)},
        bool_typet{},
        loc)
  {
  }
 
  exprt &lhs()
  {
    return op0();
  }
 
  const exprt &lhs() const
  {
    return op0();
  }
 
  exprt &rhs()
  {
    return op1();
  }
 
  const exprt &rhs() const
  {
    return op1();
  }
 
  exprt &result()
  {
    return op2();
  }
 
  const exprt &result() const
  {
    return op2();
  }
};
 
template <>
inline bool can_cast_expr<side_effect_expr_overflowt>(const exprt &base)
{
  if(base.id() != ID_side_effect)
    return false;
 
  const irep_idt &statement = to_side_effect_expr(base).get_statement();
  return statement == ID_overflow_plus || statement == ID_overflow_mult ||
         statement == ID_overflow_minus;
}
 
inline const side_effect_expr_overflowt &
to_side_effect_expr_overflow(const exprt &expr)
{
  const auto &side_effect_expr = to_side_effect_expr(expr);
  PRECONDITION(
    side_effect_expr.get_statement() == ID_overflow_plus ||
    side_effect_expr.get_statement() == ID_overflow_mult ||
    side_effect_expr.get_statement() == ID_overflow_minus);
  return static_cast<const side_effect_expr_overflowt &>(side_effect_expr);
}
 
inline side_effect_expr_overflowt &to_side_effect_expr_overflow(exprt &expr)
{
  auto &side_effect_expr = to_side_effect_expr(expr);
  PRECONDITION(
    side_effect_expr.get_statement() == ID_overflow_plus ||
    side_effect_expr.get_statement() == ID_overflow_mult ||
    side_effect_expr.get_statement() == ID_overflow_minus);
  return static_cast<side_effect_expr_overflowt &>(side_effect_expr);
}
 
class history_exprt : public unary_exprt
{
public:
  explicit history_exprt(exprt variable, const irep_idt &id)
    : unary_exprt(id, std::move(variable))
  {
  }
 
  const exprt &expression() const
  {
    return op0();
  }
};
 
inline const history_exprt &
to_history_expr(const exprt &expr, const irep_idt &id)
{
  PRECONDITION(id == ID_old || id == ID_loop_entry);
  PRECONDITION(expr.id() == id);
  auto &ret = static_cast<const history_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
class conditional_target_group_exprt : public exprt
{
public:
  explicit conditional_target_group_exprt(exprt _condition, exprt _target_list)
    : exprt(ID_conditional_target_group, empty_typet{})
  {
    add_to_operands(std::move(_condition));
    add_to_operands(std::move(_target_list));
  }
 
  static void check(
    const exprt &expr,
    const validation_modet vm = validation_modet::INVARIANT)
  {
    DATA_CHECK(
      vm,
      expr.operands().size() == 2,
      "conditional target expression must have two operands");
 
    DATA_CHECK(
      vm,
      expr.operands()[1].id() == ID_expression_list,
      "conditional target second operand must be an ID_expression_list "
      "expression, found " +
        id2string(expr.operands()[1].id()));
  }
 
  static void validate(
    const exprt &expr,
    const namespacet &,
    const validation_modet vm = validation_modet::INVARIANT)
  {
    check(expr, vm);
  }
 
  const exprt &condition() const
  {
    return op0();
  }
 
  exprt &condition()
  {
    return op0();
  }
 
  const exprt::operandst &targets() const
  {
    return op1().operands();
  }
 
  exprt::operandst &targets()
  {
    return op1().operands();
  }
};
 
inline void validate_expr(const conditional_target_group_exprt &value)
{
  conditional_target_group_exprt::check(value);
}
 
template <>
inline bool can_cast_expr<conditional_target_group_exprt>(const exprt &base)
{
  return base.id() == ID_conditional_target_group;
}
 
inline const conditional_target_group_exprt &
to_conditional_target_group_expr(const exprt &expr)
{
  PRECONDITION(expr.id() == ID_conditional_target_group);
  auto &ret = static_cast<const conditional_target_group_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
inline conditional_target_group_exprt &
to_conditional_target_group_expr(exprt &expr)
{
  PRECONDITION(expr.id() == ID_conditional_target_group);
  auto &ret = static_cast<conditional_target_group_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
class function_pointer_obeys_contract_exprt : public exprt
{
public:
  explicit function_pointer_obeys_contract_exprt(
    exprt _function_pointer,
    exprt _contract)
    : exprt(ID_function_pointer_obeys_contract, empty_typet{})
  {
    add_to_operands(std::move(_function_pointer));
    add_to_operands(std::move(_contract));
  }
 
  static void check(
    const exprt &expr,
    const validation_modet vm = validation_modet::INVARIANT)
  {
    DATA_CHECK(
      vm,
      expr.operands().size() == 2,
      "function pointer obeys contract expression must have two operands");
  }
 
  static void validate(
    const exprt &expr,
    const namespacet &,
    const validation_modet vm = validation_modet::INVARIANT)
  {
    check(expr, vm);
  }
 
  const exprt &function_pointer() const
  {
    return op0();
  }
 
  exprt &function_pointer()
  {
    return op0();
  }
 
  const symbol_exprt &contract_symbol_expr() const
  {
    return to_symbol_expr(op1().operands().at(0));
  }
 
  symbol_exprt &contract_symbol_expr()
  {
    return to_symbol_expr(op1().operands().at(0));
  }
 
  const exprt &address_of_contract() const
  {
    return op1();
  }
 
  exprt &address_of_contract()
  {
    return op1();
  }
};
 
inline void validate_expr(const function_pointer_obeys_contract_exprt &value)
{
  function_pointer_obeys_contract_exprt::check(value);
}
 
template <>
inline bool
can_cast_expr<function_pointer_obeys_contract_exprt>(const exprt &base)
{
  return base.id() == ID_function_pointer_obeys_contract;
}
 
inline const function_pointer_obeys_contract_exprt &
to_function_pointer_obeys_contract_expr(const exprt &expr)
{
  PRECONDITION(expr.id() == ID_function_pointer_obeys_contract);
  auto &ret = static_cast<const function_pointer_obeys_contract_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
inline function_pointer_obeys_contract_exprt &
to_function_pointer_obeys_contract_expr(exprt &expr)
{
  PRECONDITION(expr.id() == ID_function_pointer_obeys_contract);
  auto &ret = static_cast<function_pointer_obeys_contract_exprt &>(expr);
  validate_expr(ret);
  return ret;
}
 
#endif // CPROVER_ANSI_C_C_EXPR_H