/usr/include/firebird/UdrCppEngine.h is in firebird-dev 3.0.1.32609.ds4-14.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | /*
* The contents of this file are subject to the Initial
* Developer's Public License Version 1.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.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_idpl.
*
* Software distributed under the License is distributed AS IS,
* WITHOUT WARRANTY OF ANY KIND, either express or implied.
* See the License for the specific language governing rights
* and limitations under the License.
*
* The Original Code was created by Adriano dos Santos Fernandes
* for the Firebird Open Source RDBMS project.
*
* Copyright (c) 2008 Adriano dos Santos Fernandes <adrianosf@uol.com.br>
* and all contributors signed below.
*
* All Rights Reserved.
* Contributor(s): ______________________________________.
*/
#ifndef FIREBIRD_UDR_CPP_ENGINE
#define FIREBIRD_UDR_CPP_ENGINE
#ifndef FB_UDR_STATUS_TYPE
#error FB_UDR_STATUS_TYPE must be defined with the Status class before UdrCppEngine.h inclusion.
#endif
#include "./Message.h"
#include <string.h>
// Build must export firebird_udr_plugin function.
#define FB_UDR_IMPLEMENT_ENTRY_POINT \
namespace Firebird \
{ \
namespace Udr \
{ \
RegistrationNode<IUdrFunctionFactory>* regFunctions = NULL; \
RegistrationNode<IUdrProcedureFactory>* regProcedures = NULL; \
RegistrationNode<IUdrTriggerFactory>* regTriggers = NULL; \
} \
} \
\
extern "C" FB_BOOLEAN* FB_UDR_PLUGIN_ENTRY_POINT(::Firebird::IStatus* status, \
FB_BOOLEAN* theirUnloadFlag, ::Firebird::IUdrPlugin* udrPlugin) \
{ \
::Firebird::Udr::FactoryRegistration::finish(status, udrPlugin); \
\
class UnloadDetector \
{ \
public: \
UnloadDetector(FB_BOOLEAN* aTheirUnloadFlag, ::Firebird::IUdrPlugin* aUdrPlugin) \
: myUnloadFlag(FB_FALSE), \
theirUnloadFlag(aTheirUnloadFlag), \
udrPlugin(aUdrPlugin) \
{ \
} \
\
~UnloadDetector() \
{ \
if (!myUnloadFlag) \
*theirUnloadFlag = FB_TRUE; \
} \
\
FB_BOOLEAN myUnloadFlag; \
FB_BOOLEAN* theirUnloadFlag; \
::Firebird::IUdrPlugin* udrPlugin; \
}; \
\
static UnloadDetector unloadDetector(theirUnloadFlag, udrPlugin); \
\
return &unloadDetector.myUnloadFlag; \
}
#define FB_UDR_BEGIN_FUNCTION(name) \
namespace Func##name \
{ \
class Impl; \
\
static ::Firebird::Udr::FunctionFactoryImpl<Impl, FB_UDR_STATUS_TYPE> factory(#name); \
\
class Impl : public ::Firebird::Udr::Function<Impl, FB_UDR_STATUS_TYPE> \
{ \
public: \
FB__UDR_COMMON_IMPL
#define FB_UDR_END_FUNCTION \
}; \
}
#define FB_UDR_EXECUTE_FUNCTION \
void execute(FB_UDR_STATUS_TYPE* status, ::Firebird::IExternalContext* context, \
void* in, void* out) \
{ \
internalExecute(status, context, (InMessage::Type*) in, (OutMessage::Type*) out); \
} \
\
void internalExecute(FB_UDR_STATUS_TYPE* status, ::Firebird::IExternalContext* context, \
InMessage::Type* in, OutMessage::Type* out)
#define FB_UDR_BEGIN_PROCEDURE(name) \
namespace Proc##name \
{ \
class Impl; \
\
static ::Firebird::Udr::ProcedureFactoryImpl<Impl, FB_UDR_STATUS_TYPE> factory(#name); \
\
class Impl : public ::Firebird::Udr::Procedure<Impl, FB_UDR_STATUS_TYPE> \
{ \
public: \
FB__UDR_COMMON_IMPL
#define FB_UDR_END_PROCEDURE \
}; \
}; \
}
#define FB_UDR_EXECUTE_PROCEDURE \
::Firebird::IExternalResultSet* open(FB_UDR_STATUS_TYPE* status, \
::Firebird::IExternalContext* context, void* in, void* out) \
{ \
return new ResultSet(status, context, this, (InMessage::Type*) in, (OutMessage::Type*) out); \
} \
\
class ResultSet : public ::Firebird::Udr::ResultSet<ResultSet, Impl, InMessage, OutMessage, FB_UDR_STATUS_TYPE> \
{ \
public: \
ResultSet(FB_UDR_STATUS_TYPE* status, ::Firebird::IExternalContext* context, \
Impl* const procedure, InMessage::Type* const in, OutMessage::Type* const out) \
: ::Firebird::Udr::ResultSet<ResultSet, Impl, InMessage, OutMessage, FB_UDR_STATUS_TYPE>( \
context, procedure, in, out)
#define FB_UDR_FETCH_PROCEDURE \
FB_BOOLEAN fetch(FB_UDR_STATUS_TYPE* status) \
{ \
return (FB_BOOLEAN) internalFetch(status); \
} \
\
bool internalFetch(FB_UDR_STATUS_TYPE* status)
#define FB_UDR_BEGIN_TRIGGER(name) \
namespace Trig##name \
{ \
class Impl; \
\
static ::Firebird::Udr::TriggerFactoryImpl<Impl, FB_UDR_STATUS_TYPE> factory(#name); \
\
class Impl : public ::Firebird::Udr::Trigger<Impl, FB_UDR_STATUS_TYPE> \
{ \
public: \
FB__UDR_COMMON_IMPL
#define FB_UDR_END_TRIGGER \
}; \
}
#define FB_UDR_EXECUTE_TRIGGER \
void execute(FB_UDR_STATUS_TYPE* status, ::Firebird::IExternalContext* context, \
unsigned int action, void* oldFields, void* newFields) \
{ \
internalExecute(status, context, action, \
(FieldsMessage::Type*) oldFields, (FieldsMessage::Type*) newFields); \
} \
\
void internalExecute(FB_UDR_STATUS_TYPE* status, ::Firebird::IExternalContext* context, \
unsigned int action, \
FieldsMessage::Type* oldFields, FieldsMessage::Type* newFields)
#define FB_UDR_CONSTRUCTOR \
Impl(FB_UDR_STATUS_TYPE* const status, ::Firebird::IExternalContext* const context, \
::Firebird::IRoutineMetadata* const metadata__) \
: master(context->getMaster()), \
metadata(metadata__)
#define FB_UDR_DESTRUCTOR \
~Impl()
#define FB_UDR_MESSAGE(name, fields) \
FB_MESSAGE(name, FB_UDR_STATUS_TYPE, fields)
#define FB_UDR_TRIGGER_MESSAGE(name, fields) \
FB_TRIGGER_MESSAGE(name, FB_UDR_STATUS_TYPE, fields)
#define FB__UDR_COMMON_IMPL \
Impl(const void* const, ::Firebird::IExternalContext* const context, \
::Firebird::IRoutineMetadata* const aMetadata) \
: master(context->getMaster()), \
metadata(aMetadata) \
{ \
} \
\
::Firebird::IMaster* master; \
::Firebird::IRoutineMetadata* metadata;
#define FB__UDR_COMMON_TYPE(name) \
struct name \
{ \
typedef unsigned char Type; \
static void setup(FB_UDR_STATUS_TYPE*, ::Firebird::IMetadataBuilder*) {} \
}
namespace Firebird
{
namespace Udr
{
//------------------------------------------------------------------------------
template <typename T, typename StatusType> class Procedure;
template <typename This, typename Procedure, typename InMessage, typename OutMessage, typename StatusType>
class ResultSet : public IExternalResultSetImpl<This, StatusType>
{
public:
ResultSet(IExternalContext* aContext, Procedure* aProcedure,
typename InMessage::Type* aIn, typename OutMessage::Type* aOut)
: context(aContext),
procedure(aProcedure),
in(aIn),
out(aOut)
{
}
public:
void dispose()
{
delete static_cast<This*>(this);
}
protected:
IExternalContext* const context;
Procedure* const procedure;
typename InMessage::Type* const in;
typename OutMessage::Type* const out;
};
template <typename This, typename StatusType>
class Function : public IExternalFunctionImpl<This, StatusType>
{
public:
FB__UDR_COMMON_TYPE(InMessage);
FB__UDR_COMMON_TYPE(OutMessage);
void dispose()
{
delete static_cast<This*>(this);
}
void getCharSet(StatusType* /*status*/, IExternalContext* /*context*/,
char* /*name*/, unsigned /*nameSize*/)
{
}
};
template <typename This, typename StatusType>
class Procedure : public IExternalProcedureImpl<This, StatusType>
{
public:
FB__UDR_COMMON_TYPE(InMessage);
FB__UDR_COMMON_TYPE(OutMessage);
void dispose()
{
delete static_cast<This*>(this);
}
void getCharSet(StatusType* /*status*/, IExternalContext* /*context*/,
char* /*name*/, unsigned /*nameSize*/)
{
}
};
template <typename This, typename StatusType>
class Trigger : public IExternalTriggerImpl<This, StatusType>
{
public:
FB__UDR_COMMON_TYPE(FieldsMessage);
void dispose()
{
delete static_cast<This*>(this);
}
void getCharSet(StatusType* /*status*/, IExternalContext* /*context*/,
char* /*name*/, unsigned /*nameSize*/)
{
}
};
template <typename T> struct RegistrationNode
{
const char* name;
T* factory;
RegistrationNode<T>* next;
};
extern RegistrationNode<IUdrFunctionFactory>* regFunctions;
extern RegistrationNode<IUdrProcedureFactory>* regProcedures;
extern RegistrationNode<IUdrTriggerFactory>* regTriggers;
class FactoryRegistration
{
public:
template <typename T> static void schedule(const char* name, T* factory,
RegistrationNode<T>** list)
{
RegistrationNode<T>* node = new RegistrationNode<T>();
node->name = name;
node->factory = factory;
node->next = *list;
*list = node;
}
static void finish(IStatus* status, IUdrPlugin* plugin)
{
CheckStatusWrapper statusWrapper(status);
if (!run(&statusWrapper, plugin, &IUdrPlugin::registerFunction, regFunctions))
return;
if (!run(&statusWrapper, plugin, &IUdrPlugin::registerProcedure, regProcedures))
return;
if (!run(&statusWrapper, plugin, &IUdrPlugin::registerTrigger, regTriggers))
return;
}
private:
template <typename T>
static bool run(CheckStatusWrapper* statusWrapper, IUdrPlugin* plugin,
void (IUdrPlugin::*routine)(CheckStatusWrapper* status, const char* name, T* factory),
RegistrationNode<T>* list)
{
for (RegistrationNode<T>* node = list; node; node = node->next)
{
(plugin->*routine)(statusWrapper, node->name, node->factory);
if (statusWrapper->getState() & IStatus::STATE_ERRORS)
return false;
}
return true;
}
};
template <typename T, typename StatusType> class FunctionFactoryImpl :
public IUdrFunctionFactoryImpl<FunctionFactoryImpl<T, StatusType>, StatusType>
{
public:
explicit FunctionFactoryImpl(const char* name)
{
FactoryRegistration::schedule<IUdrFunctionFactory>(name, this, ®Functions);
}
void dispose()
{
// Do not delete this. The instances are statically allocated.
}
void setup(StatusType* status, IExternalContext* /*context*/,
IRoutineMetadata* /*metadata*/, IMetadataBuilder* in, IMetadataBuilder* out)
{
T::InMessage::setup(status, in);
T::OutMessage::setup(status, out);
}
IExternalFunction* newItem(StatusType* status, IExternalContext* context,
IRoutineMetadata* metadata)
{
return new T(status, context, metadata);
}
};
template <typename T, typename StatusType> class ProcedureFactoryImpl :
public IUdrProcedureFactoryImpl<ProcedureFactoryImpl<T, StatusType>, StatusType>
{
public:
explicit ProcedureFactoryImpl(const char* name)
{
FactoryRegistration::schedule<IUdrProcedureFactory>(name, this, ®Procedures);
}
void dispose()
{
// Do not delete this. The instances are statically allocated.
}
void setup(StatusType* status, IExternalContext* /*context*/,
IRoutineMetadata* /*metadata*/, IMetadataBuilder* in, IMetadataBuilder* out)
{
T::InMessage::setup(status, in);
T::OutMessage::setup(status, out);
}
IExternalProcedure* newItem(StatusType* status, IExternalContext* context,
IRoutineMetadata* metadata)
{
return new T(status, context, metadata);
}
};
template <typename T, typename StatusType> class TriggerFactoryImpl :
public IUdrTriggerFactoryImpl<TriggerFactoryImpl<T, StatusType>, StatusType>
{
public:
explicit TriggerFactoryImpl(const char* name)
{
FactoryRegistration::schedule<IUdrTriggerFactory>(name, this, ®Triggers);
}
void dispose()
{
// Do not delete this. The instances are statically allocated.
}
void setup(StatusType* status, IExternalContext* /*context*/,
IRoutineMetadata* /*metadata*/, IMetadataBuilder* fields)
{
T::FieldsMessage::setup(status, fields);
}
IExternalTrigger* newItem(StatusType* status, IExternalContext* context,
IRoutineMetadata* metadata)
{
return new T(status, context, metadata);
}
};
//------------------------------------------------------------------------------
} // namespace Udr
} // namespace Firebird
#endif // FIREBIRD_UDR_CPP_ENGINE
|