/usr/include/firebird/Interface.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 | /*
* PROGRAM: Firebird interface.
* MODULE: firebird/Interface.h
* DESCRIPTION: Base class for all FB interfaces / plugins.
*
* 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 Alex Peshkov
* for the Firebird Open Source RDBMS project.
*
* Copyright (c) 2010 Alex Peshkov <peshkoff at mail.ru>
* and all contributors signed below.
*
* All Rights Reserved.
* Contributor(s): ______________________________________.
*
*
*/
#ifndef FB_INTERFACE_H
#define FB_INTERFACE_H
#include "ibase.h"
#include <assert.h>
#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__)
#define CLOOP_CARG __cdecl
#endif
struct dsc;
struct PerformanceInfo;
#include "IdlFbInterfaces.h"
namespace Firebird
{
class FbException
{
public:
FbException(IStatus* aStatus, const ISC_STATUS* vector)
{
aStatus->setErrors(vector);
status = aStatus->clone();
}
FbException(IStatus* aStatus)
: status(aStatus->clone())
{
}
FbException(const FbException& copy)
: status(copy.status->clone())
{
}
FbException& operator =(const FbException& copy)
{
status->dispose();
status = copy.status->clone();
return *this;
}
virtual ~FbException()
{
status->dispose();
}
public:
static void check(ISC_STATUS code, IStatus* status, const ISC_STATUS* vector)
{
if (code != 0 && vector[1])
throw FbException(status, vector);
}
public:
IStatus* getStatus() const
{
return status;
}
private:
IStatus* status;
};
template <typename T>
class BaseStatusWrapper : public IStatusImpl<T, T>
{
public:
BaseStatusWrapper(IStatus* aStatus)
: status(aStatus),
dirty(false)
{
}
public:
static void catchException(IStatus* status)
{
if (!status)
return;
try
{
throw;
}
catch (const FbException& e)
{
status->setErrors(e.getStatus()->getErrors());
}
catch (...)
{
ISC_STATUS statusVector[] = {
isc_arg_gds, isc_random,
isc_arg_string, (ISC_STATUS) "Unrecognized C++ exception",
isc_arg_end};
status->setErrors(statusVector);
}
}
static void clearException(BaseStatusWrapper* status)
{
status->clearException();
}
void clearException()
{
if (dirty)
{
dirty = false;
status->init();
}
}
bool isDirty() const
{
return dirty;
}
bool hasData() const
{
return getState() & IStatus::STATE_ERRORS;
}
bool isEmpty() const
{
return !hasData();
}
static void setVersionError(IStatus* status, const char* interfaceName,
unsigned currentVersion, unsigned expectedVersion)
{
intptr_t codes[] = {
isc_arg_gds,
isc_interface_version_too_old,
isc_arg_number,
(intptr_t) expectedVersion,
isc_arg_number,
(intptr_t) currentVersion,
isc_arg_string,
(intptr_t) interfaceName,
isc_arg_end
};
status->setErrors(codes);
}
public:
virtual void dispose()
{
// Disposes only the delegated status. Let the user destroy this instance.
status->dispose();
}
virtual void init()
{
clearException();
}
virtual unsigned getState() const
{
return dirty ? status->getState() : 0;
}
virtual void setErrors2(unsigned length, const intptr_t* value)
{
dirty = true;
status->setErrors2(length, value);
}
virtual void setWarnings2(unsigned length, const intptr_t* value)
{
dirty = true;
status->setWarnings2(length, value);
}
virtual void setErrors(const intptr_t* value)
{
dirty = true;
status->setErrors(value);
}
virtual void setWarnings(const intptr_t* value)
{
dirty = true;
status->setWarnings(value);
}
virtual const intptr_t* getErrors() const
{
return dirty ? status->getErrors() : cleanStatus();
}
virtual const intptr_t* getWarnings() const
{
return dirty ? status->getWarnings() : cleanStatus();
}
virtual IStatus* clone() const
{
return status->clone();
}
protected:
IStatus* status;
bool dirty;
static const intptr_t* cleanStatus()
{
static intptr_t clean[3] = {1, 0, 0};
return clean;
}
};
class CheckStatusWrapper : public BaseStatusWrapper<CheckStatusWrapper>
{
public:
CheckStatusWrapper(IStatus* aStatus)
: BaseStatusWrapper(aStatus)
{
}
public:
static void checkException(CheckStatusWrapper* status)
{
}
};
class ThrowStatusWrapper : public BaseStatusWrapper<ThrowStatusWrapper>
{
public:
ThrowStatusWrapper(IStatus* aStatus)
: BaseStatusWrapper(aStatus)
{
}
public:
static void checkException(ThrowStatusWrapper* status)
{
if (status->dirty && (status->getState() & IStatus::STATE_ERRORS))
throw FbException(status->status);
}
};
#ifdef FB_API_VER // internal hack
class Helper
{
public:
template <typename StatusType>
static isc_db_handle getIscDbHandle(StatusType* status, IAttachment* attachment)
{
if (!attachment)
return 0;
ISC_STATUS_ARRAY statusVector = {0};
isc_db_handle handle = 0;
fb_get_database_handle(statusVector, &handle, attachment);
if (!handle)
{
status->setErrors(statusVector);
StatusType::checkException(status);
}
return handle;
}
template <typename StatusType>
static isc_db_handle getIscDbHandle(StatusType* status, IExternalContext* context)
{
IAttachment* attachment = context->getAttachment(status);
if (!attachment)
return 0;
try
{
isc_db_handle handle = getIscDbHandle(status, attachment);
attachment->release();
return handle;
}
catch (...)
{
attachment->release();
throw;
}
}
template <typename StatusType>
static isc_tr_handle getIscTrHandle(StatusType* status, ITransaction* transaction)
{
if (!transaction)
return 0;
ISC_STATUS_ARRAY statusVector = {0};
isc_tr_handle handle = 0;
fb_get_transaction_handle(statusVector, &handle, transaction);
if (!handle)
{
status->setErrors(statusVector);
StatusType::checkException(status);
}
return handle;
}
template <typename StatusType>
static isc_tr_handle getIscTrHandle(StatusType* status, IExternalContext* context)
{
ITransaction* transaction = context->getTransaction(status);
if (!transaction)
return 0;
try
{
isc_tr_handle handle = getIscTrHandle(status, transaction);
transaction->release();
return handle;
}
catch (...)
{
transaction->release();
throw;
}
}
};
#endif // FB_API_VER
// Additional API function.
// Should be used only in non-plugin modules.
// All plugins including providers should use passed at init time interface instead.
extern "C" IMaster* ISC_EXPORT fb_get_master_interface();
} // namespace Firebird
#define FB_PLUGIN_ENTRY_POINT firebird_plugin
#define FB_UDR_PLUGIN_ENTRY_POINT firebird_udr_plugin
#endif // FB_INTERFACE_H
|