aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/formal/SymbolicVariable.h
blob: 4de595043245a3390a2c46ebbd0ac007fc5ae83f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
    This file is part of solidity.

    solidity is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    solidity is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with solidity.  If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include <libsolidity/formal/SolverInterface.h>

#include <libsolidity/ast/AST.h>

#include <memory>

namespace dev
{
namespace solidity
{

class Declaration;

/**
 * This class represents the symbolic version of a program variable.
 */
class SymbolicVariable
{
public:
    explicit SymbolicVariable(Declaration const* _decl,
        smt::SolverInterface& _interface);
    SymbolicVariable(SymbolicVariable const&) = default;
    SymbolicVariable(SymbolicVariable&&) = default;
    SymbolicVariable& operator=(SymbolicVariable const&) = default;
    SymbolicVariable& operator=(SymbolicVariable&&) = default;

    smt::Expression operator()(int _seq) const
    {
        return valueAtSequence(_seq);
    }

    std::string uniqueSymbol() const;

    virtual void setZeroValue(int _seq) = 0;
    virtual void setUnknownValue(int _seq) = 0;

protected:
    smt::Expression valueAtSequence(int _seq) const
    {
        return (*m_expression)(_seq);
    }

    Declaration const* m_declaration;
    std::shared_ptr<smt::Expression> m_expression = nullptr;
    smt::SolverInterface& m_interface;
};

}
}