This file is indexed.

/usr/include/opendbx/api.h is in libopendbx1-dev 1.4.6-11.

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
/*
 *  OpenDBX - A simple but extensible database abstraction layer
 *  Copyright (C) 2004-2008 Norbert Sendetzky <norbert@linuxnetworks.de>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 *  02111-1307 USA.
 */


#include <inttypes.h>
#include <sys/types.h>
#include <sys/time.h>



#ifndef ODBX_H
#define ODBX_H



#ifdef __cplusplus
extern "C" {
#endif



/*
 *  Extended capabilities supported by the backends
 *  0x0000-0x00ff: Well known capabilities
 */

enum odbxcap {
	ODBX_CAP_BASIC,
#define ODBX_CAP_BASIC   ODBX_CAP_BASIC
	ODBX_CAP_LO
#define ODBX_CAP_LO   ODBX_CAP_LO
};



/*
 * ODBX bind type
 */

enum odbxbind {
	ODBX_BIND_SIMPLE
#define ODBX_BIND_SIMPLE   ODBX_BIND_SIMPLE
};



/*
 *  ODBX error types
 */

enum odbxerr {
	ODBX_ERR_SUCCESS,
#define ODBX_ERR_SUCCESS   ODBX_ERR_SUCCESS
	ODBX_ERR_BACKEND,
#define ODBX_ERR_BACKEND   ODBX_ERR_BACKEND
	ODBX_ERR_NOCAP,
#define ODBX_ERR_NOCAP   ODBX_ERR_NOCAP
	ODBX_ERR_PARAM,
#define ODBX_ERR_PARAM   ODBX_ERR_PARAM
	ODBX_ERR_NOMEM,
#define ODBX_ERR_NOMEM   ODBX_ERR_NOMEM
	ODBX_ERR_SIZE,
#define ODBX_ERR_SIZE   ODBX_ERR_SIZE
	ODBX_ERR_NOTEXIST,
#define ODBX_ERR_NOTEXIST   ODBX_ERR_NOTEXIST
	ODBX_ERR_NOOP,
#define ODBX_ERR_NOOP   ODBX_ERR_NOOP
	ODBX_ERR_OPTION,
#define ODBX_ERR_OPTION   ODBX_ERR_OPTION
	ODBX_ERR_OPTRO,
#define ODBX_ERR_OPTRO   ODBX_ERR_OPTRO
	ODBX_ERR_OPTWR,
#define ODBX_ERR_OPTWR   ODBX_ERR_OPTWR
	ODBX_ERR_RESULT,
#define ODBX_ERR_RESULT   ODBX_ERR_RESULT
	ODBX_ERR_NOTSUP,
#define ODBX_ERR_NOTSUP   ODBX_ERR_NOTSUP
	ODBX_ERR_HANDLE
#define ODBX_ERR_HANDLE   ODBX_ERR_HANDLE
};

#define ODBX_MAX_ERRNO   0x0d



/*
 *  ODBX result/fetch return values
 */

enum odbxres {
	ODBX_RES_DONE,
#define ODBX_RES_DONE   ODBX_RES_DONE
	ODBX_RES_TIMEOUT,
#define ODBX_RES_TIMEOUT   ODBX_RES_TIMEOUT
	ODBX_RES_NOROWS,
#define ODBX_RES_NOROWS   ODBX_RES_NOROWS
	ODBX_RES_ROWS
#define ODBX_RES_ROWS   ODBX_RES_ROWS
};

enum odbxrow {
	ODBX_ROW_DONE,
#define ODBX_ROW_DONE   ODBX_ROW_DONE
	ODBX_ROW_NEXT
#define ODBX_ROW_NEXT   ODBX_ROW_NEXT
};



/*
 *  ODBX (SQL2003) data types
 */

enum odbxtype {
	ODBX_TYPE_BOOLEAN = 0x00,
#define ODBX_TYPE_BOOLEAN   ODBX_TYPE_BOOLEAN
	ODBX_TYPE_SMALLINT = 0x01,
#define ODBX_TYPE_SMALLINT   ODBX_TYPE_SMALLINT
	ODBX_TYPE_INTEGER = 0x02,
#define ODBX_TYPE_INTEGER   ODBX_TYPE_INTEGER
	ODBX_TYPE_BIGINT = 0x03,
#define ODBX_TYPE_BIGINT   ODBX_TYPE_BIGINT
	ODBX_TYPE_DECIMAL = 0x07,
#define ODBX_TYPE_DECIMAL   ODBX_TYPE_DECIMAL

	ODBX_TYPE_REAL = 0x08,
#define ODBX_TYPE_REAL   ODBX_TYPE_REAL
	ODBX_TYPE_DOUBLE = 0x09,
#define ODBX_TYPE_DOUBLE   ODBX_TYPE_DOUBLE
	ODBX_TYPE_FLOAT = 0x0f,
#define ODBX_TYPE_FLOAT   ODBX_TYPE_FLOAT

	ODBX_TYPE_CHAR = 0x10,
#define ODBX_TYPE_CHAR   ODBX_TYPE_CHAR
	ODBX_TYPE_NCHAR = 0x11,
#define ODBX_TYPE_NCHAR   ODBX_TYPE_NCHAR
	ODBX_TYPE_VARCHAR = 0x12,
#define ODBX_TYPE_VARCHAR   ODBX_TYPE_VARCHAR
	ODBX_TYPE_NVARCHAR = 0x13,
#define ODBX_TYPE_NVARCHAR  ODBX_TYPE_NVARCHAR

	ODBX_TYPE_CLOB = 0x20,
#define ODBX_TYPE_CLOB   ODBX_TYPE_CLOB
	ODBX_TYPE_NCLOB = 0x21,
#define ODBX_TYPE_NCLOB   ODBX_TYPE_NCLOB
	ODBX_TYPE_XML = 0x22,
#define ODBX_TYPE_XML   ODBX_TYPE_XML

	ODBX_TYPE_BLOB = 0x2f,
#define ODBX_TYPE_BLOB   ODBX_TYPE_BLOB

	ODBX_TYPE_TIME = 0x30,
#define ODBX_TYPE_TIME   ODBX_TYPE_TIME
	ODBX_TYPE_TIMETZ = 0x31,
#define ODBX_TYPE_TIMETZ   ODBX_TYPE_TIMETZ
	ODBX_TYPE_TIMESTAMP = 0x32,
#define ODBX_TYPE_TIMESTAMP   ODBX_TYPE_TIMESTAMP
	ODBX_TYPE_TIMESTAMPTZ = 0x33,
#define ODBX_TYPE_TIMESTAMPTZ ODBX_TYPE_TIMESTAMPTZ
	ODBX_TYPE_DATE = 0x34,
#define ODBX_TYPE_DATE   ODBX_TYPE_DATE
	ODBX_TYPE_INTERVAL = 0x35,
#define ODBX_TYPE_INTERVAL   ODBX_TYPE_INTERVAL

	ODBX_TYPE_ARRAY = 0x40,
#define ODBX_TYPE_ARRAY   ODBX_TYPE_ARRAY
	ODBX_TYPE_MULTISET = 0x41,
#define ODBX_TYPE_MULTISET   ODBX_TYPE_MULTISET

	ODBX_TYPE_DATALINK = 0x50,
#define ODBX_TYPE_DATALINK   ODBX_TYPE_DATALINK

	ODBX_TYPE_UNKNOWN = 0xff
#define ODBX_TYPE_UNKNOWN   ODBX_TYPE_UNKNOWN
};



/*
 *  ODBX options
 *
 *  0x0000 - 0x1fff reserved for api options
 *  0x2000 - 0x3fff reserved for api extension options
 *  0x4000 - 0xffff reserved for vendor specific and experimental options
 */

enum odbxopt {
/* Informational options */
	ODBX_OPT_API_VERSION = 0x0000,
#define ODBX_OPT_API_VERSION   ODBX_OPT_API_VERSION
	ODBX_OPT_THREAD_SAFE = 0x0001,
#define ODBX_OPT_THREAD_SAFE   ODBX_OPT_THREAD_SAFE
	ODBX_OPT_LIB_VERSION = 0x0002,
#define ODBX_OPT_LIB_VERSION   ODBX_OPT_LIB_VERSION

/* Security related options */
	ODBX_OPT_TLS = 0x0010,
#define ODBX_OPT_TLS   ODBX_OPT_TLS

/* Implemented options */
	ODBX_OPT_MULTI_STATEMENTS = 0x0020,
#define ODBX_OPT_MULTI_STATEMENTS   ODBX_OPT_MULTI_STATEMENTS
	ODBX_OPT_PAGED_RESULTS = 0x0021,
#define ODBX_OPT_PAGED_RESULTS   ODBX_OPT_PAGED_RESULTS
	ODBX_OPT_COMPRESS = 0x0022,
#define ODBX_OPT_COMPRESS   ODBX_OPT_COMPRESS
	ODBX_OPT_MODE = 0x0023,
#define ODBX_OPT_MODE   ODBX_OPT_MODE
	ODBX_OPT_CONNECT_TIMEOUT = 0x0024
#define ODBX_OPT_CONNECT_TIMEOUT   ODBX_OPT_CONNECT_TIMEOUT
};


/* SSL/TLS related options */

enum odbxtls {
	ODBX_TLS_NEVER,
#define ODBX_TLS_NEVER   ODBX_TLS_NEVER
	ODBX_TLS_TRY,
#define ODBX_TLS_TRY   ODBX_TLS_TRY
	ODBX_TLS_ALWAYS
#define ODBX_TLS_ALWAYS   ODBX_TLS_ALWAYS
};


#define ODBX_DISABLE   0
#define ODBX_ENABLE   1




typedef struct odbx_t odbx_t;
typedef struct odbx_lo_t odbx_lo_t;
typedef struct odbx_result_t odbx_result_t;



/*
 *  ODBX basic operations
 */

int odbx_init( odbx_t** handle, const char* backend, const char* host, const char* port );

int odbx_bind( odbx_t* handle, const char* database, const char* who, const char* cred, int method );

int odbx_unbind( odbx_t* handle );

int odbx_finish( odbx_t* handle );

int odbx_capabilities( odbx_t* handle, unsigned int cap );

int odbx_get_option( odbx_t* handle, unsigned int option, void* value );

int odbx_set_option( odbx_t* handle, unsigned int option, void* value );

const char* odbx_error( odbx_t* handle, int error );

int odbx_error_type( odbx_t* handle, int error );

int odbx_escape( odbx_t* handle, const char* from, unsigned long fromlen, char* to, unsigned long* tolen );

int odbx_query( odbx_t* handle, const char* query, unsigned long length );

int odbx_result( odbx_t* handle, odbx_result_t** result, struct timeval* timeout, unsigned long chunk );

int odbx_result_finish( odbx_result_t* result );

int odbx_row_fetch( odbx_result_t* result );

uint64_t odbx_rows_affected( odbx_result_t* result );

unsigned long odbx_column_count( odbx_result_t* result );

const char* odbx_column_name( odbx_result_t* result, unsigned long pos );

int odbx_column_type( odbx_result_t* result, unsigned long pos );

unsigned long odbx_field_length( odbx_result_t* result, unsigned long pos );

const char* odbx_field_value( odbx_result_t* result, unsigned long pos );



/*
 *  ODBX large object operations
 */

int odbx_lo_open( odbx_result_t* result, odbx_lo_t** lo, const char* value );

ssize_t odbx_lo_read( odbx_lo_t* lo, void* buffer, size_t buflen );

ssize_t odbx_lo_write( odbx_lo_t* lo, void* buffer, size_t buflen );

int odbx_lo_close( odbx_lo_t* lo );





/*
 *  Depricated defines and functions
 *
 *  They won't be available in version 2.0 any more
 *  Please don't use and replace them in your code
 */


/*
 * Depricated types
 */

#define ODBX_BOOLEAN   0x00
#define ODBX_SMALLINT   0x01
#define ODBX_INTEGER   0x02
#define ODBX_BIGINT   0x03
#define ODBX_DECIMAL   0x07

#define ODBX_REAL   0x08
#define ODBX_DOUBLE   0x09
#define ODBX_FLOAT   0x0f

#define ODBX_CHAR   0x10
#define ODBX_NCHAR   0x11
#define ODBX_VARCHAR   0x12
#define ODBX_NVARCHAR  0x13

#define ODBX_CLOB   0x20
#define ODBX_NCLOB   0x21
#define ODBX_XML   0x22

#define ODBX_BLOB   0x2f

#define ODBX_TIME   0x30
#define ODBX_TIME_TZ   0x31
#define ODBX_TIMESTAMP   0x32
#define ODBX_TIMESTAMP_TZ 0x33
#define ODBX_DATE   0x34
#define ODBX_INTERVAL   0x35

#define ODBX_ARRAY   0x40
#define ODBX_MULTISET   0x41

#define ODBX_DATALINK   0x50

#define ODBX_UNKNOWN   0xff


/*
 * Depricated errors
 */

#define ODBX_ERR_TOOLONG ODBX_ERR_SIZE


/*
 * Depricated functions
 */

int odbx_bind_simple( odbx_t* handle, const char* database, const char* username, const char* password );

void odbx_result_free( odbx_result_t* result );



#ifdef  __cplusplus
}
#endif


#endif