PhasorFFI.hpp

Go to the documentation of this file.

// Copyright 2026 Daniel McGuire
// Licensed under the Apache License, 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
// http://www.apache.org/licenses/LICENSE-2.0
// 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
//
// The FFI is used by the VM, these declarations should only be used for loading external C plugins
 
#pragma once
 
#if defined(_WIN32)
#include <windows.h>
#else
#include <dlfcn.h>
#endif
 
#include <functional>
#include <filesystem>
#include <vector>
#include <string>
 
#include "PhasorFFI.h"
#include "Value.hpp"
 
namespace Phasor
{
class VM;
}
 
using FFIFunction = void (*)(const PhasorAPI *api, PhasorVM *vm);
namespace Phasor
{

struct Plugin
{
#if defined(_WIN32)
    HMODULE handle; 
#else
    void *handle; 
#endif
    std::string           path;     
    FFIFunction           init;     
    std::function<void()> shutdown; 
};

Phasor::Value c_native_func_wrapper(PhasorNativeFunction c_func, Phasor::VM *vm,
                                    const std::vector<Phasor::Value> &args);

void register_native_c_func(PhasorVM *vm, const char *name, PhasorNativeFunction func);

class FFI
{
  public:
    explicit FFI(const std::filesystem::path &pluginFolder, VM *vm);

    ~FFI();

    bool addPlugin(const std::filesystem::path &pluginPath);
 
  private:
    bool native_add_plugin(const std::vector<Value> &args, VM *vm);

    bool loadPlugin(const std::filesystem::path &library, VM *vm);

    std::vector<std::string> scanPlugins(const std::filesystem::path &folder);

    void unloadAll();
 
    std::vector<Plugin>   plugins_;      
    std::filesystem::path pluginFolder_; 
    VM                   *vm_;           
};
 
} // namespace Phasor