PhasorRT.h

Go to the documentation of this file.

// Copyright 2026 Daniel McGuire
// Licensed under the Apache License (with LLVM-Exceptions), Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// https://llvm.org/LICENSE.txt
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
// README
//
// This is the main header file for the Phasor Runtime C ABI.
// The goal is to keep this ABI as stable as possible, see the details below, or at
// https://phasor-docs.pages.dev/man?f=phasorrt.3
// man phasorrt
 
#ifndef PHASOR_RT_H
#define PHASOR_RT_H
 
#ifdef __cplusplus
#include <cstddef>
#else
#include <stdbool.h>
#include <stddef.h>
#endif
 
#ifdef _WIN32
#ifdef PHASOR_EXPORTS
#define PHASOR_API __declspec(dllexport)
#else
#define PHASOR_API __declspec(dllimport)
#endif
#elif defined(__GNUC__) || defined(__clang__)
#ifdef PHASOR_EXPORTS
#define PHASOR_API __attribute__((visibility("default")))
#else
#define PHASOR_API
#endif
#else
#define PHASOR_API
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
    PHASOR_API const char *getVersion();

    PHASOR_API int exec(void *state, const unsigned char *bytecode, size_t bytecodeSize, const char *moduleName,
                        int argc, const char **argv);

    PHASOR_API int execFuncInt(void *state, const unsigned char *bytecode, size_t bytecodeSize, const char *moduleName,
                               int argc, const char **argv, const char *functionName);

    PHASOR_API const char *execFuncString(void *state, const unsigned char *bytecode, size_t bytecodeSize,
                                          const char *moduleName, int argc, const char **argv,
                                          const char *functionName);

    PHASOR_API int evaluatePHS(void *state, const char *script, const char *moduleName, const char *modulePath,
                               bool verbose);

    PHASOR_API int evaluatePUL(void *state, const char *script, const char *moduleName);

    PHASOR_API bool compilePHS(const char *script, const char *moduleName, const char *modulePath,
                               unsigned char *buffer, size_t bufferSize, size_t *outSize);

    PHASOR_API bool compilePUL(const char *script, const char *moduleName, unsigned char *buffer, size_t bufferSize,
                               size_t *outSize);

    PHASOR_API void *createState();

    PHASOR_API void initStdLib(void *state);

    PHASOR_API bool freeState(void *state);

    PHASOR_API bool resetState(void *state, bool resetFunctions, bool resetVariables);
 
#ifdef __cplusplus
}
#endif
 
#endif // PHASOR_RT_H