Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPlugin.h
Go to the documentation of this file.
1
10 #ifndef K_API_PLUGIN_H
11 #define K_API_PLUGIN_H
12
13 #include <kApi/kApiDef.h>
14 #include <kApi/Utils/kPlugin.x.h>
15
26 //typedef kObject kPlugin; --forward-declared in kApiDef.x.h
27
39 kFx(kStatus) kPlugin_Construct(kPlugin* plugin, const kChar* path, kAlloc allocator);
40
82 kFx(kStatus) kPlugin_ConstructEx(kPlugin* plugin, const kChar* path, kVersion requiredPlatformVersion, kVersion* platformVersion,
83 kVersion requiredAssemblyVersion, kVersion* assemblyVersion, kAlloc allocator);
84
92 kInlineFx(kAssembly) kPlugin_Assembly(kPlugin plugin)
93 {
94 kObj(kPlugin, plugin);
95
96 return obj->assembly;
97 }
98
106 kInlineFx(kDynamicLib) kPlugin_Library(kPlugin plugin)
107 {
108 kObj(kPlugin, plugin);
109
110 return obj->library;
111 }
112
113 #endif
kPlugin::kPlugin_ConstructEx
kStatus kPlugin_ConstructEx(kPlugin *plugin, const kChar *path, kVersion requiredPlatformVersion, kVersion *platformVersion, kVersion requiredAssemblyVersion, kVersion *assemblyVersion, kAlloc allocator)
Constructs a kPlugin object, optionally performing version checks to ensure compatibility.
kAssembly
Represents a library of types.
kPlugin::kPlugin_Assembly
kAssembly kPlugin_Assembly(kPlugin plugin)
Gets the assembly associated with this plugin.
Definition: kPlugin.h:92
kAlloc
Abstract base class for memory allocator types.
kInlineFx
#define kInlineFx(TYPE)
Inline method declaration helper.
Definition: kApiDef.h:26
kChar
Represents a single unit (byte) in a UTF-8 character.
kPlugin::kPlugin_Library
kDynamicLib kPlugin_Library(kPlugin plugin)
Gets the library associated with this plugin.
Definition: kPlugin.h:106
kPlugin
Represents a dynamically loaded assembly.
kPlugin::kPlugin_Construct
kStatus kPlugin_Construct(kPlugin *plugin, const kChar *path, kAlloc allocator)
Constructs a kPlugin object.
kObj
#define kObj(TypeName_T, T_object)
Declares a local "obj" (this-pointer) variable and initializes it from a type-checked object handle...
Definition: kApiDef.h:2892
kApiDef.h
Core Zen type declarations.
kVersion
Represents a version number.
kStatus
Represents an error code.
kDynamicLib
Represents a dynamically loaded library.