cprover
string_insertion_builtin_functiont Class Reference

String inserting a string into another one. More...

#include <string_builtin_function.h>

+ Inheritance diagram for string_insertion_builtin_functiont:
+ Collaboration diagram for string_insertion_builtin_functiont:

Public Member Functions

 string_insertion_builtin_functiont (const exprt &return_code, const std::vector< exprt > &fun_args, array_poolt &array_pool)
 Constructor from arguments of a function application. More...
 
optionalt< array_string_exprtstring_result () const override
 
std::vector< array_string_exprtstring_arguments () const override
 
virtual std::vector< mp_integereval (const std::vector< mp_integer > &input1_value, const std::vector< mp_integer > &input2_value, const std::vector< mp_integer > &args_value) const
 Evaluate the result from a concrete valuation of the arguments. More...
 
optionalt< exprteval (const std::function< exprt(const exprt &)> &get_value) const override
 Given a function get_value which gives a valuation to expressions, attempt to find the result of the builtin function. More...
 
std::string name () const override
 
string_constraintst constraints (string_constraint_generatort &generator) const override
 Add constraints ensuring that the value of result expression of the builtin function corresponds to the value of the function call. More...
 
exprt length_constraint () const override
 Constraint ensuring that the length of the strings are coherent with the function call. More...
 
bool maybe_testing_function () const override
 Tells whether the builtin function can be a testing function, that is a function that does not return a string, for instance like equals, indexOf or compare. More...
 
- Public Member Functions inherited from string_builtin_functiont
 string_builtin_functiont (const string_builtin_functiont &)=delete
 
virtual ~string_builtin_functiont ()=default
 

Public Attributes

array_string_exprt result
 
array_string_exprt input1
 
array_string_exprt input2
 
std::vector< exprtargs
 
- Public Attributes inherited from string_builtin_functiont
exprt return_code
 

Protected Member Functions

 string_insertion_builtin_functiont (const exprt &return_code)
 
- Protected Member Functions inherited from string_builtin_functiont
 string_builtin_functiont (exprt return_code)
 

Detailed Description

String inserting a string into another one.

Definition at line 271 of file string_builtin_function.h.

Constructor & Destructor Documentation

◆ string_insertion_builtin_functiont() [1/2]

string_insertion_builtin_functiont::string_insertion_builtin_functiont ( const exprt return_code,
const std::vector< exprt > &  fun_args,
array_poolt array_pool 
)

Constructor from arguments of a function application.

The arguments in fun_args should be in order: an integer result.length, a character pointer &result[0], a string arg1 of type refined_string_typet, a string arg2 of type refined_string_typet, and potentially some arguments of primitive types.

Definition at line 36 of file string_builtin_function.cpp.

◆ string_insertion_builtin_functiont() [2/2]

string_insertion_builtin_functiont::string_insertion_builtin_functiont ( const exprt return_code)
inlineexplicitprotected

Definition at line 324 of file string_builtin_function.h.

Member Function Documentation

◆ constraints()

string_constraintst string_insertion_builtin_functiont::constraints ( string_constraint_generatort constraint_generator) const
overridevirtual

Add constraints ensuring that the value of result expression of the builtin function corresponds to the value of the function call.

Implements string_builtin_functiont.

Reimplemented in string_concatenation_builtin_functiont.

Definition at line 493 of file string_builtin_function.cpp.

◆ eval() [1/2]

std::vector< mp_integer > string_insertion_builtin_functiont::eval ( const std::vector< mp_integer > &  input1_value,
const std::vector< mp_integer > &  input2_value,
const std::vector< mp_integer > &  args_value 
) const
virtual

Evaluate the result from a concrete valuation of the arguments.

Reimplemented in string_concatenation_builtin_functiont.

Definition at line 443 of file string_builtin_function.cpp.

◆ eval() [2/2]

optionalt< exprt > string_insertion_builtin_functiont::eval ( const std::function< exprt(const exprt &)> &  get_value) const
overridevirtual

Given a function get_value which gives a valuation to expressions, attempt to find the result of the builtin function.

If not enough information can be gathered from get_value, return an empty optional.

Implements string_builtin_functiont.

Definition at line 469 of file string_builtin_function.cpp.

◆ length_constraint()

exprt string_insertion_builtin_functiont::length_constraint ( ) const
overridevirtual

Constraint ensuring that the length of the strings are coherent with the function call.

Implements string_builtin_functiont.

Reimplemented in string_concatenation_builtin_functiont.

Definition at line 508 of file string_builtin_function.cpp.

◆ maybe_testing_function()

bool string_insertion_builtin_functiont::maybe_testing_function ( ) const
inlineoverridevirtual

Tells whether the builtin function can be a testing function, that is a function that does not return a string, for instance like equals, indexOf or compare.

Reimplemented from string_builtin_functiont.

Definition at line 318 of file string_builtin_function.h.

◆ name()

std::string string_insertion_builtin_functiont::name ( ) const
inlineoverridevirtual

Implements string_builtin_functiont.

Reimplemented in string_concatenation_builtin_functiont.

Definition at line 308 of file string_builtin_function.h.

◆ string_arguments()

std::vector<array_string_exprt> string_insertion_builtin_functiont::string_arguments ( ) const
inlineoverridevirtual

Reimplemented from string_builtin_functiont.

Definition at line 294 of file string_builtin_function.h.

◆ string_result()

optionalt<array_string_exprt> string_insertion_builtin_functiont::string_result ( ) const
inlineoverridevirtual

Reimplemented from string_builtin_functiont.

Definition at line 290 of file string_builtin_function.h.

Member Data Documentation

◆ args

std::vector<exprt> string_insertion_builtin_functiont::args

Definition at line 277 of file string_builtin_function.h.

◆ input1

array_string_exprt string_insertion_builtin_functiont::input1

Definition at line 275 of file string_builtin_function.h.

◆ input2

array_string_exprt string_insertion_builtin_functiont::input2

Definition at line 276 of file string_builtin_function.h.

◆ result

array_string_exprt string_insertion_builtin_functiont::result

Definition at line 274 of file string_builtin_function.h.


The documentation for this class was generated from the following files: