mumble/plugins/null_plugin.cpp
Robert Adam 27dbee8e62 FEAT(client): Plugin framework
This commit introduces a new plugin framework into the codebase of the
Mumble client. Note that "plugin" here really refers to a (more or less)
general purpose plugin and is therefore not to be confused with the
previously available positional data plugins (only responsible for
fetching positional data from a running game and passing that to
Mumble).

The plugin interface is written in C, removing the compiler-dependence
the old "plugins" had. Instead plugins can now be written in an
arbitrary language as long as that language is capable of being compiled
into a shared library and also being capable of being C-compatible.

As already indicated a plugin is essentially a shared library that
provides certain functions that allow Mumble to interface with it.

Inside Mumble the so-called PluginManager is responsible for managing
the plugins and relaying events to the respective callbacks. Plugins
themselves can also interact with Mumble on their own initiative by
using the provided API functions.

Fixes #2455
Fixes #2148
Fixes #1594
Fixes #2051
Fixes #3742
Fixes #4575
Fixes #4751
2021-04-16 20:15:44 +02:00

37 lines
1.0 KiB
C++

// Copyright 2013-2021 The Mumble Developers. All rights reserved.
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file at the root of the
// Mumble source tree or at <https://www.mumble.info/LICENSE>.
#define MUMBLE_ALLOW_DEPRECATED_LEGACY_PLUGIN_API
#include "mumble_legacy_plugin.h"
#ifndef NULL_DESC
# define NULL_DESC L"Retracted plugin"
#endif // NULL_DESC
static int fetch(float *, float *, float *, float *, float *, float *, std::string &, std::wstring &) {
// Empty
return false;
}
static int trylock() {
// Empty
return false;
}
static const std::wstring longdesc() {
return std::wstring(L"NULL plugin for retracted plugin. This should not be visible in Mumble >= 1.2.4");
}
static std::wstring description(NULL_DESC);
static std::wstring shortname(L"Retracted");
static MumblePlugin nullplug = {
MUMBLE_PLUGIN_MAGIC, description, shortname, nullptr, nullptr, trylock, nullptr, longdesc, fetch
};
extern "C" MUMBLE_PLUGIN_EXPORT MumblePlugin *getMumblePlugin() {
return &nullplug;
}