Program Listing for File plugin.h

↰ Return to documentation for file (liberate/sys/plugin.h)

/*
 * This file is part of liberate.
 *
 * Author(s): Jens Finkhaeuser <jens@finkhaeuser.de>
 *
 * Copyright (c) 2023 Interpeer gUG (haftungsbeschränkt)
 *
 * SPDX-License-Identifier: GPL-3.0-only
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef LIBERATE_SYS_PLUGIN_H
#define LIBERATE_SYS_PLUGIN_H

#ifndef __cplusplus
#error You are trying to include a C++ only header file
#endif

#include <liberate.h>

#include <string>

namespace liberate::sys {

using plugin_type = uint32_t;

using plugin_version = uint32_t;

struct LIBERATE_API plugin_meta
{
  plugin_type     type;

  plugin_version  version;

  void *          data;

  void *          plugin_handle;
};


LIBERATE_API bool
load_plugin(plugin_meta const * & meta, char const * filename);

LIBERATE_API bool
load_plugin(plugin_meta const * & meta, std::string const & filename);


LIBERATE_API bool
unload_plugin(plugin_meta const * & meta);


} // namespace liberate::sys

#endif // guard