Files
archived-Reclass/src/iplugin.h
IChooseYou ed8a44917b feat: 32-bit process support, scanner rescan filtering, suppress flash on navigate
- Add pointerSize() to Provider base; WoW64/ELF detection in ProcessMemory,
  WinDbg, and RemoteProcessMemory plugins
- Wire pointer size through NodeTree, source/XML imports, C++ generator,
  controller, compose, address parser, and RPC protocol header
- Add is32Bit to PluginProcessInfo and ProcessInfo; show (32-bit) in picker
- Scanner rescan now filters results against the current input value
- Go-to-address from scanner resets change tracking to prevent false flashing
2026-03-01 07:42:40 -07:00

138 lines
4.2 KiB
C++

#pragma once
#include <QString>
#include <QIcon>
#include <memory>
#include <string>
#ifdef _WIN32
#define RCX_PLUGIN_EXPORT __declspec(dllexport)
#else
#define RCX_PLUGIN_EXPORT __attribute__((visibility("default")))
#endif
// Forward declaration
namespace rcx { class Provider; }
/**
* Plugin interface for Reclass
*
* Plugins are loaded from the "Plugins" folder as shared libraries.
* Each plugin must export a C function: extern "C" RCX_PLUGIN_EXPORT IPlugin* CreatePlugin();
*/
class IPlugin {
public:
virtual ~IPlugin() = default;
// Plugin metadata
virtual std::string Name() const = 0;
virtual std::string Version() const = 0;
virtual std::string Author() const = 0;
virtual std::string Description() const = 0;
virtual QIcon Icon() const { return QIcon(); }
// Plugin type - determines what functionality it provides
enum k_EType
{
// Provides memory/data sources
ProviderPlugin,
// In the future we could make plugins that change the main UI
// for loading different data sources
};
virtual k_EType Type() const = 0;
// Plugin load type - determines whether and when the plugin is loaded
// by the PluginManager
enum k_ELoadType
{
// Plugin is automatically loaded on startup
k_ELoadTypeAuto,
// Plugin must be loaded manually via 'Manage Plugins'
k_ELoadTypeManual,
};
virtual k_ELoadType LoadType() const = 0;
};
// Forward declarations
class QWidget;
class QTableWidget;
/**
* Process information structure for custom process lists
*/
struct PluginProcessInfo {
uint32_t pid;
QString name;
QString path;
QIcon icon;
bool is32Bit = false;
PluginProcessInfo() : pid(0) {}
PluginProcessInfo(uint32_t p, const QString& n, const QString& pth = QString(), const QIcon& i = QIcon())
: pid(p), name(n), path(pth), icon(i) {}
};
/**
* Provider plugin interface
*
* Plugins that implement this interface can create Provider instances
* for reading/writing memory from various sources (processes, files, network, etc.)
*/
class IProviderPlugin : public IPlugin {
public:
k_EType Type() const override { return ProviderPlugin; }
/**
* Check if this plugin can create a provider for the given target
* @param target - Target identifier (e.g., PID for process, path for file)
* @return true if this plugin can handle the target
*/
virtual bool canHandle(const QString& target) const = 0;
/**
* Create a provider instance
* @param target - Target identifier
* @param errorMsg - Output parameter for error message if creation fails
* @return Provider instance, or nullptr on failure
*/
virtual std::unique_ptr<rcx::Provider> createProvider(const QString& target, QString* errorMsg = nullptr) = 0;
/**
* Get initial base address for the provider (optional)
* Called after createProvider to set the document's base address
* @param target - Same target identifier passed to createProvider
* @return Initial base address, or 0 if not applicable
*/
virtual uint64_t getInitialBaseAddress(const QString& target) const { Q_UNUSED(target); return 0; }
/**
* Show a dialog to select a target (e.g., process picker)
* @param parent - Parent widget for dialog
* @param target - Output parameter for selected target
* @return true if user selected a target, false if cancelled
*/
virtual bool selectTarget(QWidget* parent, QString* target) = 0;
/**
* Get custom process list (optional)
*
* If implemented, this allows the plugin to override the default process enumeration.
* Return an empty list to use the default process picker.
*
* @return List of processes to display, or empty list to use default
*/
virtual QVector<PluginProcessInfo> enumerateProcesses() { return QVector<PluginProcessInfo>(); }
/**
* Check if this plugin wants to override the process list
* @return true if enumerateProcesses() should be called
*/
virtual bool providesProcessList() const { return false; }
};
// Plugin factory function signature
typedef IPlugin* (*CreatePluginFunc)();
#define IPLUGIN_IID "com.reclass.IPlugin/1.0"