Import Functions

To use functions from another plugin in your C++ plugin, you need to generate language-specific header files. These headers provide the necessary wrappers to call functions exported by other plugins. This guide explains how to generate these headers and how to use them in your C++ plugin.

Generating Header Files

Plugify provides a Python script (generator.py) to automatically generate header files for importing functions from other plugins. These headers include wrapper functions that handle the function calls and parameter passing.

Steps to Generate Header Files

Using Generated Wrapper Functions

The generated header file contains wrapper functions that allow you to call functions from the other plugin. These wrappers handle the function address lookup and parameter passing.

Example Generated Header

Here’s an example of a generated header file for a plugin named plugin_from_another_language:

#pragma once

#include <plugify/cpp_plugin.hpp>
#include <plugify/any.hpp>
#include <cstdint>

// Generated from plugin_from_another_language.pplugin by https://github.com/untrustedmodders/plugify-module-cpp/blob/main/generator/generator.py

namespace plugin_from_another_language {
    inline void ParamCallback(int32_t a, float b, double c, const plg::vec4& d, const plg::vector<int64_t>& e, char f, const plg::string& g, char16_t h, int16_t k) {
        using ParamCallbackFn = void (*)(int32_t, float, double, const plg::vec4&, const plg::vector<int64_t>&, char, const plg::string&, char16_t, int16_t);
        static ParamCallbackFn __func = nullptr;
        if (__func == nullptr) plg::GetMethodPtr2("plugin_from_another_language.ParamCallback", reinterpret_cast<void**>(&__func));
        __func(a, b, c, d, e, f, g, h, k);
    }
} // namespace plugin_from_another_language

How It Works

• The wrapper function (ParamCallback) retrieves the address of the exported function using plg::GetMethodPtr or plg::GetMethodPtr2.
• The function address is stored in a static variable (__func) to avoid repeated lookups.
• The wrapper function directly passes the parameters to the exported function, leveraging the C++ calling convention.

Example: Using the Generated Header

Here’s how you can use the generated header in your C++ plugin:

#include "plugin_from_another_language.hpp" // Include the generated header

void MyPluginFunction() {
    // Call the exported function from the other plugin
    plugin_from_another_language::ParamCallback(
        42,                // int32_t a
        3.14f,             // float b
        2.718,             // double c
        {1.0f, 2.0f, 3.0f, 4.0f}, // plg::vec4 d
        {100, 200},        // plg::vector<int64_t> e
        'x',               // char f
        "Hello, Plugify!", // plg::string g
        u'✓',              // char16_t h
        10                 // int16_t k
    );
}

When is Header Generation Necessary?

Header generation is essential when importing functions from plugins written in statically-typed languages like C++ or C#. Without these headers, the compiler cannot reference the exported functions. For dynamically-typed languages like Python, header generation is not necessary because method binding happens at runtime.

Best Practices

1. Use the Generator Script: Always use the generator.py script to generate headers for imported functions.
2. Include Generated Headers: Include the generated headers in your plugin source files to access the exported functions.
3. Test Thoroughly: Test the imported functions to ensure they work as expected.
4. Document Dependencies: Clearly document the plugins and functions your plugin depends on.

Conclusion

Importing functions from another plugin in C++ is straightforward when you use the generator.py script to generate the necessary headers. These headers provide wrapper functions that handle function address lookup and parameter passing, making it easy to integrate functionality from other plugins. By following the steps and best practices outlined in this guide, you can create robust and interoperable plugins in the Plugify ecosystem.