/// The API version of the clice plugin.
/// Update this version when you change:
/// - The definition of struct `PluginInfo`.
/// - The definition of function `clice_get_server_plugin_info`.
/// Note: you don't have to update this version if you only change other APIs, which is guaranteed
/// by the `PluginInfo::definition_hash`.
#ifndef CLICE_PLUGIN_API_VERSION
#define CLICE_PLUGIN_API_VERSION 1
#elif CLICE_PLUGIN_API_VERSION != 1
#error "CLICE_PLUGIN_API_VERSION must be 1, but got " CLICE_PLUGIN_API_VERSION
#endif

/// Defines the library APIs that loads a plugin.
#ifdef CLICE_PLUGIN_PROTOCOL
struct ServerPluginBuilder;
extern "C" {
    /// A C-compatible struct that contains information about the plugin.
    struct PluginInfo {
        /// The clice API version of the plugin.
        std::uint32_t api_version;
        /// The name of the plugin.
        const char* name;
        /// The version of the plugin.
        const char* version;
        /// The plugin definition hash.
        const char* definition_hash;
        /// Registers the server callbacks for the loaded plugin.
        void (*register_server_callbacks)(ServerPluginBuilder& builder);
    };

    /// The public entry point for a pass plugin.
    ///
    /// When a plugin is loaded by the server, it will call this entry point to
    /// obtain information about this plugin and about how to register its customization points.
    /// This function needs to be implemented by the plugin, see the example below:
    ///
    /// ```
    /// extern "C" ::clice::PluginInfo LLVM_ATTRIBUTE_WEAK
    /// clice_get_server_plugin_info() {
    ///   return {
    ///     CLICE_PLUGIN_API_VERSION, "MyPlugin", "v0.1", CLICE_PLUGIN_DEF_HASH,
    ///     [](ServerPluginBuilder builder) {  ... }
    ///   };
    /// }
    /// ```
    PluginInfo LLVM_ATTRIBUTE_WEAK clice_get_server_plugin_info();
}

struct ServerRef {
public:
    struct Self;

    ServerRef(Self* self) : self(self) {}

    Self* operator->() const {
        return self;
    }

    Server& server() const;

    /// Gets the configuration for the given section.
    std::expected<llvm::json::Value, std::string> get_configuration(llvm::StringRef section);

protected:
    Self* self;
};
#endif

/// Defines the library APIs to register callbacks for a plugin.
#ifdef CliceServerPluginAPI
CliceServerPluginAPI(get_server_ref, ServerRef& server);
using configuration_handler_t = async::Task<> (*)(ServerRef server, void* plugin_data);
CliceServerPluginAPI(on_did_change_configuration, configuration_handler_t callback);
using command_handler_t =
    async::Task<llvm::json::Value> (*)(ServerRef server,
                                       void* plugin_data,
                                       const llvm::ArrayRef<llvm::StringRef>& arguments);
CliceServerPluginAPI(register_commmand_handler,
                     llvm::StringRef command,
                     command_handler_t callback);
#endif