solidity/libsolc/libsolc.h

66 lines
1.9 KiB
C
Raw Normal View History

2017-08-28 23:34:39 +00:00
/*
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/>.
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Public compiler API.
2017-08-28 23:34:39 +00:00
*/
2018-12-12 15:47:05 +00:00
#pragma once
2017-08-28 23:34:39 +00:00
#include <stdbool.h>
#ifdef __cplusplus
#define SOLC_NOEXCEPT noexcept
#else
#define SOLC_NOEXCEPT
#endif
2017-08-28 23:34:39 +00:00
#ifdef __cplusplus
extern "C" {
#endif
2019-01-22 17:18:27 +00:00
/// Callback used to retrieve additional source files.
///
/// "Returns" two pointers that should be heap-allocated and are free'd by the caller.
2017-08-28 23:34:39 +00:00
typedef void (*CStyleReadFileCallback)(char const* _path, char** o_contents, char** o_error);
2019-01-22 17:18:27 +00:00
/// Returns the complete license document.
///
/// The pointer returned must not be freed by the caller.
char const* solidity_license() SOLC_NOEXCEPT;
2019-01-22 17:18:27 +00:00
/// Returns the compiler version.
///
/// The pointer returned must not be freed by the caller.
char const* solidity_version() SOLC_NOEXCEPT;
2019-01-22 17:18:27 +00:00
/// Takes a "Standard Input JSON" and an optional callback (can be set to null). Returns
/// a "Standard Output JSON". Both are to be UTF-8 encoded.
///
/// The pointer returned must not be freed by the caller.
char const* solidity_compile(char const* _input, CStyleReadFileCallback _readCallback) SOLC_NOEXCEPT;
2019-01-22 11:41:21 +00:00
/// Frees up any allocated memory.
///
/// NOTE: the pointer returned by solidity_compile is invalid after calling this!
void solidity_free() SOLC_NOEXCEPT;
2017-08-28 23:34:39 +00:00
#ifdef __cplusplus
}
#endif