init
This commit is contained in:
@@ -0,0 +1,69 @@
|
||||
/* Copyright (c) 2020-2025, Arm Limited and Contributors
|
||||
* Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
#include "plugin.h"
|
||||
#include "platform/platform.h"
|
||||
|
||||
namespace vkb
|
||||
{
|
||||
const std::string &Plugin::get_name() const
|
||||
{
|
||||
return name;
|
||||
}
|
||||
|
||||
const std::string &Plugin::get_description() const
|
||||
{
|
||||
return description;
|
||||
}
|
||||
|
||||
void Plugin::log_help(size_t width) const
|
||||
{
|
||||
LOGI("");
|
||||
LOGI("\t{}", name);
|
||||
LOGI("\t\t{}", description);
|
||||
LOGI("");
|
||||
|
||||
if (!commands.empty())
|
||||
{
|
||||
LOGI("\t\tSubcommands:");
|
||||
for (auto const &command : commands)
|
||||
{
|
||||
std::ostringstream oss;
|
||||
oss.setf(std::ios::left);
|
||||
oss.width(width + 2);
|
||||
oss << command.first;
|
||||
LOGI("\t\t\t{}{}", oss.str().c_str(), command.second);
|
||||
}
|
||||
LOGI("");
|
||||
}
|
||||
|
||||
if (!options.empty())
|
||||
{
|
||||
LOGI("\t\tOptions:");
|
||||
for (auto const &option : options)
|
||||
{
|
||||
std::ostringstream oss;
|
||||
oss.setf(std::ios::left);
|
||||
oss.width(width);
|
||||
oss << option.first;
|
||||
LOGI("\t\t\t--{}{}", oss.str().c_str(), option.second);
|
||||
}
|
||||
LOGI("");
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace vkb
|
||||
@@ -0,0 +1,310 @@
|
||||
/* Copyright (c) 2020-2025, Arm Limited and Contributors
|
||||
* Copyright (c) 2023-2025, Mobica Limited
|
||||
* Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <cassert>
|
||||
#include <deque>
|
||||
#include <string>
|
||||
#include <typeindex>
|
||||
#include <vector>
|
||||
|
||||
#include "common/tags.h"
|
||||
#include "gui.h"
|
||||
|
||||
namespace vkb
|
||||
{
|
||||
class Platform;
|
||||
class RenderContext;
|
||||
class Plugin;
|
||||
|
||||
/**
|
||||
* @brief Tags are used to define a plugins behaviour. This is useful to dictate which plugins will work together
|
||||
* and which will not without directly specifying an exclusion or inclusion list. Tags are struct types so that they can
|
||||
* be used in the tagging system (See plugin implementation).
|
||||
*
|
||||
* Entrypoint - An entrypoint is a starting point for the application that will load a vkb::Application (see start_app)
|
||||
* FullControl - The plugin wants full control over how the application executes. Stopping plugins will be ignored (see batch_mode)
|
||||
* Stopping - The plugin will stop the app through its own mechanism (see stop_after)
|
||||
* Passive - These plugins provide non intrusive behaviour (see fps_logger)
|
||||
*/
|
||||
namespace tags
|
||||
{
|
||||
struct Entrypoint
|
||||
{};
|
||||
struct FullControl
|
||||
{};
|
||||
struct Stopping
|
||||
{};
|
||||
struct Passive
|
||||
{};
|
||||
} // namespace tags
|
||||
|
||||
/**
|
||||
* @brief Associate how plugins can interact with each other. This interoperability is decided by comparing tags of different plugins. The plugins inclusion and exclusion lists are populated by this function
|
||||
*
|
||||
* @param plugins A list of plugins which are used together
|
||||
* @return std::vector<Plugin *> A list of plugins which are used together
|
||||
*/
|
||||
std::vector<Plugin *> associate_plugins(const std::vector<Plugin *> &plugins);
|
||||
|
||||
/**
|
||||
* @brief Hooks are points in the project that an plugin can subscribe too. These can be expanded on to implement more behaviour in the future
|
||||
*
|
||||
* Update - Executed at each update() loop
|
||||
* OnAppStart - Executed when an app starts
|
||||
* OnAppClose - Executed when an app closes
|
||||
* OnPlatformClose - Executed when the platform closes (End off the apps lifecycle)
|
||||
*/
|
||||
enum class Hook
|
||||
{
|
||||
OnUpdate,
|
||||
OnAppStart,
|
||||
OnAppClose,
|
||||
OnAppError,
|
||||
OnPlatformClose,
|
||||
PostDraw,
|
||||
OnUpdateUi
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Plugins are used to define custom behaviour. This allows the addition of features without directly
|
||||
* interfering with the applications core implementation
|
||||
*/
|
||||
class Plugin
|
||||
{
|
||||
public:
|
||||
Plugin(const std::string name,
|
||||
const std::string description,
|
||||
std::vector<std::pair<std::string, std::string>> const &commands = {},
|
||||
std::vector<std::pair<std::string, std::string>> const &options = {}) :
|
||||
name{name}, description{description}, commands{commands}, options{options} {};
|
||||
|
||||
virtual ~Plugin() = default;
|
||||
|
||||
/**
|
||||
* @brief Return a list of hooks that an plugin wants to subscribe to
|
||||
*
|
||||
* @return Hooks that the plugin wants to use
|
||||
*/
|
||||
virtual const std::vector<Hook> &get_hooks() const = 0;
|
||||
|
||||
/**
|
||||
* @brief Called when an application has been updated
|
||||
*
|
||||
* @param delta_time The time taken to compute a frame
|
||||
*/
|
||||
virtual void on_update(float delta_time) = 0;
|
||||
|
||||
/**
|
||||
* @brief Called when an app has started
|
||||
*
|
||||
* @param app_id The ID of the app
|
||||
*/
|
||||
virtual void on_app_start(const std::string &app_id) = 0;
|
||||
|
||||
/**
|
||||
* @brief Called when an app has been closed
|
||||
*
|
||||
* @param app_id The ID of the app
|
||||
*/
|
||||
virtual void on_app_close(const std::string &app_id) = 0;
|
||||
|
||||
/**
|
||||
* @brief Handle when an application errors
|
||||
*
|
||||
* @param app_id The ID of the app which errored
|
||||
*/
|
||||
virtual void on_app_error(const std::string &app_id) = 0;
|
||||
|
||||
/**
|
||||
* @brief Called when the platform has been requested to close
|
||||
*/
|
||||
virtual void on_platform_close() = 0;
|
||||
|
||||
/**
|
||||
* @brief Post Draw
|
||||
*/
|
||||
virtual void on_post_draw(RenderContext &context) = 0;
|
||||
|
||||
/**
|
||||
* @brief Allows to add a UI to a sample
|
||||
*
|
||||
* @param drawer The object that is responsible for drawing the overlay
|
||||
*/
|
||||
virtual void on_update_ui_overlay(vkb::Drawer &drawer) = 0;
|
||||
|
||||
const std::string &get_name() const;
|
||||
const std::string &get_description() const;
|
||||
|
||||
/**
|
||||
* @brief Test whether the plugin contains a given tag
|
||||
*
|
||||
* @tparam C the tag to check for
|
||||
* @return true tag present
|
||||
* @return false tag not present
|
||||
*/
|
||||
template <typename C>
|
||||
bool has_tag() const
|
||||
{
|
||||
return has_tag(Tag<C>::ID);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Tests whether the plugins contains multiple tags
|
||||
*
|
||||
* @tparam C A set of tags
|
||||
* @return true Contains all tags
|
||||
* @return false Does not contain all tags
|
||||
*/
|
||||
template <typename... C>
|
||||
bool has_tags() const
|
||||
{
|
||||
std::vector<TagID> query = {Tag<C>::ID...};
|
||||
bool res = true;
|
||||
for (auto id : query)
|
||||
{
|
||||
res &= has_tag(id);
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Implemented by plugin base to return if the plugin contains a tag
|
||||
*
|
||||
* @param id The tag id of a tag
|
||||
* @return true contains tag
|
||||
* @return false does not contain tag
|
||||
*/
|
||||
virtual bool has_tag(TagID id) const = 0;
|
||||
|
||||
std::vector<std::pair<std::string, std::string>> const &get_commands() const
|
||||
{
|
||||
return commands;
|
||||
}
|
||||
|
||||
std::vector<std::pair<std::string, std::string>> const &get_options() const
|
||||
{
|
||||
return options;
|
||||
}
|
||||
|
||||
virtual bool handle_command(std::deque<std::string> &arguments) const
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
virtual bool handle_option(std::deque<std::string> &arguments)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
virtual void trigger_command()
|
||||
{}
|
||||
|
||||
void log_help(size_t width) const;
|
||||
|
||||
void set_platform(Platform *platform)
|
||||
{
|
||||
assert(!this->platform && platform);
|
||||
this->platform = platform;
|
||||
}
|
||||
|
||||
void clear_platform()
|
||||
{
|
||||
platform = nullptr;
|
||||
}
|
||||
|
||||
protected:
|
||||
Platform *platform = nullptr;
|
||||
|
||||
private:
|
||||
std::string name;
|
||||
std::string description;
|
||||
std::vector<std::pair<std::string, std::string>> commands;
|
||||
std::vector<std::pair<std::string, std::string>> options;
|
||||
};
|
||||
|
||||
/**
|
||||
* The following section provides helper functions for filtering containers of plugins
|
||||
*/
|
||||
namespace plugins
|
||||
{
|
||||
/**
|
||||
* @brief Get all plugins with tags
|
||||
* Plugin must include one or more tags
|
||||
*
|
||||
* @tparam TAGS Tags that an plugin must contain
|
||||
* @param domain The list of plugins to query
|
||||
* @return const std::vector<Plugin *> A list of plugins containing one or more TAGS
|
||||
*/
|
||||
template <typename... TAGS>
|
||||
const std::vector<Plugin *> with_tags(const std::vector<Plugin *> &domain = {})
|
||||
{
|
||||
std::vector<TagID> tags = {Tag<TAGS>::ID...};
|
||||
std::vector<Plugin *> compatable;
|
||||
for (auto ext : domain)
|
||||
{
|
||||
assert(ext != nullptr);
|
||||
|
||||
bool has_one = false;
|
||||
for (auto t : tags)
|
||||
{
|
||||
has_one |= ext->has_tag(t);
|
||||
}
|
||||
|
||||
if (has_one)
|
||||
{
|
||||
compatable.push_back(ext);
|
||||
}
|
||||
}
|
||||
return compatable;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Get all plugins without the given tags
|
||||
* Plugin must not include one or more tags
|
||||
* Essentially the opoposite of plugins::with_tags<...TAGS>()
|
||||
*
|
||||
* @tparam TAGS Tags that an plugin must not contain
|
||||
* @param domain The list of plugins to query
|
||||
* @return const std::vector<Plugin *> A list of plugins containing one or more TAGS
|
||||
*/
|
||||
template <typename... TAGS>
|
||||
const std::vector<Plugin *> without_tags(const std::vector<Plugin *> &domain = {})
|
||||
{
|
||||
std::vector<TagID> tags = {Tag<TAGS>::ID...};
|
||||
std::vector<Plugin *> compatable;
|
||||
for (auto ext : domain)
|
||||
{
|
||||
assert(ext != nullptr);
|
||||
|
||||
bool has_any = false;
|
||||
for (auto t : tags)
|
||||
{
|
||||
has_any |= ext->has_tag(t);
|
||||
}
|
||||
|
||||
if (!has_any)
|
||||
{
|
||||
compatable.push_back(ext);
|
||||
}
|
||||
}
|
||||
return compatable;
|
||||
}
|
||||
} // namespace plugins
|
||||
} // namespace vkb
|
||||
@@ -0,0 +1,76 @@
|
||||
/* Copyright (c) 2020-2025, Arm Limited and Contributors
|
||||
* Copyright (c) 2023-2025, Mobica Limited
|
||||
* Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <fmt/format.h>
|
||||
|
||||
#include "common/tags.h"
|
||||
#include "platform/platform.h"
|
||||
#include "plugin.h"
|
||||
|
||||
namespace vkb
|
||||
{
|
||||
/**
|
||||
* @brief PluginBase is the base class that plugins inherit from. The class enforces the use of tags when creating new plugins.
|
||||
* For method information see Plugin
|
||||
*/
|
||||
template <typename... TAGS>
|
||||
class PluginBase : public Plugin, public Tag<TAGS...>
|
||||
{
|
||||
public:
|
||||
PluginBase(const std::string name, const std::string description, const std::vector<Hook> &hooks = {}, std::vector<std::pair<std::string, std::string>> const &commands = {}, std::vector<std::pair<std::string, std::string>> const &options = {});
|
||||
|
||||
virtual ~PluginBase() = default;
|
||||
|
||||
const std::vector<Hook> &get_hooks() const override;
|
||||
bool has_tag(TagID id) const override;
|
||||
|
||||
// hooks that can be implemented by plugins
|
||||
void on_update(float delta_time) override{};
|
||||
void on_app_start(const std::string &app_id) override{};
|
||||
void on_app_close(const std::string &app_id) override{};
|
||||
void on_platform_close() override{};
|
||||
void on_post_draw(RenderContext &context) override{};
|
||||
void on_app_error(const std::string &app_id) override{};
|
||||
void on_update_ui_overlay(vkb::Drawer &drawer) override{};
|
||||
|
||||
private:
|
||||
Tag<TAGS...> *tags = reinterpret_cast<Tag<TAGS...> *>(this);
|
||||
|
||||
std::vector<Hook> hooks;
|
||||
};
|
||||
|
||||
template <typename... TAGS>
|
||||
PluginBase<TAGS...>::PluginBase(const std::string name, const std::string description, const std::vector<Hook> &hooks, std::vector<std::pair<std::string, std::string>> const &commands, std::vector<std::pair<std::string, std::string>> const &options) :
|
||||
Plugin(name, description, commands, options), hooks{hooks}
|
||||
{
|
||||
}
|
||||
|
||||
template <typename... TAGS>
|
||||
bool PluginBase<TAGS...>::has_tag(TagID id) const
|
||||
{
|
||||
return tags->has_tag(id);
|
||||
}
|
||||
|
||||
template <typename... TAGS>
|
||||
const std::vector<Hook> &PluginBase<TAGS...>::get_hooks() const
|
||||
{
|
||||
return hooks;
|
||||
}
|
||||
} // namespace vkb
|
||||
Reference in New Issue
Block a user