solidity/libsolidity/analysis/ContractLevelChecker.h

98 lines
3.7 KiB
C
Raw Normal View History

/*
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/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
* Component that verifies overloads, abstract contracts, function clashes and others
* checks at contract or function level.
*/
#pragma once
#include <libsolidity/ast/ASTForward.h>
#include <libsolidity/analysis/OverrideChecker.h>
#include <liblangutil/SourceLocation.h>
#include <map>
#include <functional>
2019-09-16 12:33:43 +00:00
#include <set>
2019-12-11 16:31:36 +00:00
namespace solidity::langutil
{
class ErrorReporter;
}
2019-12-11 16:31:36 +00:00
namespace solidity::frontend
{
/**
* Component that verifies overloads, abstract contracts, function clashes and others
* checks at file, contract, or function level.
*/
class ContractLevelChecker
{
public:
2019-09-16 12:33:43 +00:00
/// @param _errorReporter provides the error logging functionality.
explicit ContractLevelChecker(langutil::ErrorReporter& _errorReporter):
m_overrideChecker{_errorReporter},
m_errorReporter(_errorReporter)
{}
/// Performs checks on the given source ast.
/// @returns true iff all checks passed. Note even if all checks passed, errors() can still contain warnings
bool check(SourceUnit const& _sourceUnit);
private:
/// Performs checks on the given contract.
/// @returns true iff all checks passed. Note even if all checks passed, errors() can still contain warnings
bool check(ContractDefinition const& _contract);
2018-11-29 16:39:57 +00:00
/// Checks that two functions defined in this contract with the same name have different
/// arguments and that there is at most one constructor.
2018-11-29 17:23:58 +00:00
void checkDuplicateFunctions(ContractDefinition const& _contract);
void checkDuplicateEvents(ContractDefinition const& _contract);
2018-11-29 16:39:57 +00:00
template <class T>
2020-05-12 09:42:29 +00:00
void findDuplicateDefinitions(std::map<std::string, std::vector<T>> const& _definitions);
/// Checks for unimplemented functions and modifiers.
void checkAbstractDefinitions(ContractDefinition const& _contract);
2019-11-04 13:12:58 +00:00
/// Checks that the base constructor arguments are properly provided.
/// Fills the list of unimplemented functions in _contract's annotations.
2018-11-29 17:23:58 +00:00
void checkBaseConstructorArguments(ContractDefinition const& _contract);
2018-11-29 16:58:15 +00:00
void annotateBaseConstructorArguments(
ContractDefinition const& _currentContract,
FunctionDefinition const* _baseConstructor,
ASTNode const* _argumentNode
);
2018-11-29 17:32:06 +00:00
/// Checks that different functions with external visibility end up having different
/// external argument types (i.e. different signature).
void checkExternalTypeClashes(ContractDefinition const& _contract);
2018-11-29 17:33:54 +00:00
/// Checks for hash collisions in external function signatures.
void checkHashCollisions(ContractDefinition const& _contract);
2018-11-29 17:36:26 +00:00
/// Checks that all requirements for a library are fulfilled if this is a library.
void checkLibraryRequirements(ContractDefinition const& _contract);
/// Checks base contracts for ABI compatibility
void checkBaseABICompatibility(ContractDefinition const& _contract);
2018-11-29 16:39:57 +00:00
/// Warns if the contract has a payable fallback, but no receive ether function.
void checkPayableFallbackWithoutReceive(ContractDefinition const& _contract);
2020-07-14 08:32:11 +00:00
/// Error if the contract requires too much storage
void checkStorageSize(ContractDefinition const& _contract);
OverrideChecker m_overrideChecker;
langutil::ErrorReporter& m_errorReporter;
};
}