/usr/include/ncbi-vdb/kdb/meta.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
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 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kdb_meta_
#define _h_kdb_meta_
#ifndef _h_kdb_extern_
#include <kdb/extern.h>
#endif
#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif
#include <stdarg.h>
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct KTable;
struct KColumn;
struct KDatabase;
/*--------------------------------------------------------------------------
* KMetadata
* a versioned, hierarchical structure
*/
typedef struct KMetadata KMetadata;
/* AddRef
* Release
* all objects are reference counted
* NULL references are ignored
*/
KDB_EXTERN rc_t CC KMetadataAddRef ( const KMetadata *self );
KDB_EXTERN rc_t CC KMetadataRelease ( const KMetadata *self );
/* OpenMetadataRead
* opens metadata for read
*
* "meta" [ OUT ] - return parameter for metadata
*/
KDB_EXTERN rc_t CC KDatabaseOpenMetadataRead ( struct KDatabase const *self,
const KMetadata **meta );
KDB_EXTERN rc_t CC KTableOpenMetadataRead ( struct KTable const *self,
const KMetadata **meta );
KDB_EXTERN rc_t CC KColumnOpenMetadataRead ( struct KColumn const *self,
const KMetadata **meta );
/* OpenMetadataUpdate
* open metadata for read/write
*
* "meta" [ OUT ] - return parameter for metadata
*/
KDB_EXTERN rc_t CC KDatabaseOpenMetadataUpdate ( struct KDatabase *self,
KMetadata **meta );
KDB_EXTERN rc_t CC KTableOpenMetadataUpdate ( struct KTable *self,
KMetadata **meta );
KDB_EXTERN rc_t CC KColumnOpenMetadataUpdate ( struct KColumn *self,
KMetadata **meta );
/* Version
* returns the metadata format version
*/
KDB_EXTERN rc_t CC KMetadataVersion ( const KMetadata *self, uint32_t *version );
/* ByteOrder
* indicates whether original byte order is reversed
* under current architecture.
*
* the byte order of the column is established by
* the host architecture when created.
*
* "reversed" [ OUT ] - if true, the original byte
* order is reversed with regard to host native byte order.
*/
KDB_EXTERN rc_t CC KMetadataByteOrder ( const KMetadata *self, bool *reversed );
/* Revision
* returns current revision number
* where 0 ( zero ) means tip
*/
KDB_EXTERN rc_t CC KMetadataRevision ( const KMetadata *self, uint32_t *revision );
/* MaxRevision
* returns the maximum revision available
*/
KDB_EXTERN rc_t CC KMetadataMaxRevision ( const KMetadata *self, uint32_t *revision );
/* Commit
* ensure any changes are committed to disk
*/
KDB_EXTERN rc_t CC KMetadataCommit ( KMetadata *self );
/* Freeze
* freezes current metadata revision
* further modification will begin on a copy
*/
KDB_EXTERN rc_t CC KMetadataFreeze ( KMetadata *self );
/* OpenRevision
* opens a read-only indexed revision of metadata
*/
KDB_EXTERN rc_t CC KMetadataOpenRevision ( const KMetadata *self,
const KMetadata **meta, uint32_t revision );
/* GetSequence
* SetSequence
* NextSequence
* access a named sequence
*
* "seq" [ IN ] - NUL terminated sequence name
*
* "val" [ OUT ] - return parameter for sequence value
* "val" [ IN ] - new sequence value
*/
KDB_EXTERN rc_t CC KMetadataGetSequence ( const KMetadata *self,
const char *seq, int64_t *val );
KDB_EXTERN rc_t CC KMetadataSetSequence ( KMetadata *self,
const char *seq, int64_t val );
KDB_EXTERN rc_t CC KMetadataNextSequence ( KMetadata *self,
const char *seq, int64_t *val );
/*--------------------------------------------------------------------------
* KMDataNode
* a node with an optional value,
* optional attributes, and optional children
*
* nodes are identified by path, relative to a starting node,
* where "/" serves as a path separator.
*/
typedef struct KMDataNode KMDataNode;
/* AddRef
* Release
* all objects are reference counted
* NULL references are ignored
*/
KDB_EXTERN rc_t CC KMDataNodeAddRef ( const KMDataNode *self );
KDB_EXTERN rc_t CC KMDataNodeRelease ( const KMDataNode *self );
/* OpenNodeRead
* VOpenNodeRead
* opens a metadata node
*
* "node" [ OUT ] - return parameter for indicated metadata node
*
* "path" [ IN, NULL OKAY ] - optional path for specifying named
* node within metadata hierarchy. paths will be interpreted as
* if they were file system paths, using '/' as separator. the
* special values NULL and "" are interpreted as "."
*/
KDB_EXTERN rc_t CC KMetadataOpenNodeRead ( const KMetadata *self,
const KMDataNode **node, const char *path, ... );
KDB_EXTERN rc_t CC KMDataNodeOpenNodeRead ( const KMDataNode *self,
const KMDataNode **node, const char *path, ... );
KDB_EXTERN rc_t CC KMetadataVOpenNodeRead ( const KMetadata *self,
const KMDataNode **node, const char *path, va_list args );
KDB_EXTERN rc_t CC KMDataNodeVOpenNodeRead ( const KMDataNode *self,
const KMDataNode **node, const char *path, va_list args );
/* OpenNodeUpdate
* VOpenNodeUpdate
* opens a metadata node
*
* "node" [ OUT ] - return parameter for indicated metadata node
*
* "path" [ IN, NULL OKAY ] - optional path for specifying named
* node within metadata hierarchy. paths will be interpreted as
* if they were file system paths, using '/' as separator. the
* special values NULL and "" are interpreted as "."
*/
KDB_EXTERN rc_t CC KMetadataOpenNodeUpdate ( KMetadata *self,
KMDataNode **node, const char *path, ... );
KDB_EXTERN rc_t CC KMDataNodeOpenNodeUpdate ( KMDataNode *self,
KMDataNode **node, const char *path, ... );
KDB_EXTERN rc_t CC KMetadataVOpenNodeUpdate ( KMetadata *self,
KMDataNode **node, const char *path, va_list args );
KDB_EXTERN rc_t CC KMDataNodeVOpenNodeUpdate ( KMDataNode *self,
KMDataNode **node, const char *path, va_list args );
/* ByteOrder
* indicates whether original byte order is reversed
* under current architecture.
*
* the byte order of the column is established by
* the host architecture when created.
*
* "reversed" [ OUT ] - if true, the original byte
* order is reversed with regard to host native byte order.
*/
KDB_EXTERN rc_t CC KMDataNodeByteOrder ( const KMDataNode *self, bool *reversed );
/* Read
* read a node value
*
* "offset" [ IN ] - initial offset into metadata
*
* "buffer" [ OUT ] and "bsize" [ IN ] - return buffer for read
*
* "num_read" [ OUT ] - number of bytes actually read
*
* "remaining" [ OUT, NULL OKAY ] - optional return parameter for
* the number of bytes remaining to be read.
* specifically, "offset" + "num_read" + "remaining" == sizeof node data
*/
KDB_EXTERN rc_t CC KMDataNodeRead ( const KMDataNode *self,
size_t offset, void *buffer, size_t bsize,
size_t *num_read, size_t *remaining );
/* Write
* write a node value or attribute
* overwrites anything already there
*
* "buffer" [ IN ] and "size" [ IN ] - new value data
*/
KDB_EXTERN rc_t CC KMDataNodeWrite ( KMDataNode *self, const void *buffer, size_t size );
/* Append
* append data to value
*
* "buffer" [ IN ] and "size" [ IN ] - value data to be appended
*/
KDB_EXTERN rc_t CC KMDataNodeAppend ( KMDataNode *self, const void *buffer, size_t size );
/* Read ( formatted )
* reads as integer or float value in native byte order
*
* "bXX" [ OUT ] - return parameter for numeric value
*/
KDB_EXTERN rc_t CC KMDataNodeReadB8 ( const KMDataNode *self, void *b8 );
KDB_EXTERN rc_t CC KMDataNodeReadB16 ( const KMDataNode *self, void *b16 );
KDB_EXTERN rc_t CC KMDataNodeReadB32 ( const KMDataNode *self, void *b32 );
KDB_EXTERN rc_t CC KMDataNodeReadB64 ( const KMDataNode *self, void *b64 );
KDB_EXTERN rc_t CC KMDataNodeReadB128 ( const KMDataNode *self, void *b128 );
/* ReadAs ( formatted )
* reads as integer or float value in native byte order
* casts smaller-sized values to desired size, e.g.
* uint32_t to uint64_t
*
* "i" [ OUT ] - return parameter for signed integer
* "u" [ OUT ] - return parameter for unsigned integer
* "f" [ OUT ] - return parameter for double float
*/
KDB_EXTERN rc_t CC KMDataNodeReadAsI16 ( const KMDataNode *self, int16_t *i );
KDB_EXTERN rc_t CC KMDataNodeReadAsU16 ( const KMDataNode *self, uint16_t *u );
KDB_EXTERN rc_t CC KMDataNodeReadAsI32 ( const KMDataNode *self, int32_t *i );
KDB_EXTERN rc_t CC KMDataNodeReadAsU32 ( const KMDataNode *self, uint32_t *u );
KDB_EXTERN rc_t CC KMDataNodeReadAsI64 ( const KMDataNode *self, int64_t *i );
KDB_EXTERN rc_t CC KMDataNodeReadAsU64 ( const KMDataNode *self, uint64_t *u );
KDB_EXTERN rc_t CC KMDataNodeReadAsF64 ( const KMDataNode *self, double *f );
/* Read ( formatted )
* reads as C-string
*
* "buffer" [ OUT ] and "bsize" [ IN ] - output buffer for
* NUL terminated string.
*
* "size" [ OUT ] - return parameter giving size of string
* not including NUL byte. the size is set both upon success
* and insufficient buffer space error.
*/
KDB_EXTERN rc_t CC KMDataNodeReadCString ( const KMDataNode *self,
char *buffer, size_t bsize, size_t *size );
/* Write ( formatted )
* writes integer or float value in metadata byte order
*
* "bXX" [ IN ] - numeric value
*/
KDB_EXTERN rc_t CC KMDataNodeWriteB8 ( KMDataNode *self, const void *b8 );
KDB_EXTERN rc_t CC KMDataNodeWriteB16 ( KMDataNode *self, const void *b16 );
KDB_EXTERN rc_t CC KMDataNodeWriteB32 ( KMDataNode *self, const void *b32 );
KDB_EXTERN rc_t CC KMDataNodeWriteB64 ( KMDataNode *self, const void *b64 );
KDB_EXTERN rc_t CC KMDataNodeWriteB128 ( KMDataNode *self, const void *b128 );
/* Write ( formatted )
* writes string
*
* "str" [ IN ] - NUL terminated string.
*/
KDB_EXTERN rc_t CC KMDataNodeWriteCString ( KMDataNode *self, const char *str );
/* ReadAttr
* reads as NUL-terminated string
*
* "name" [ IN ] - NUL terminated attribute name
*
* "buffer" [ OUT ] and "bsize" - return parameter for attribute value
*
* "size" [ OUT ] - return parameter giving size of string
* not including NUL byte. the size is set both upon success
* and insufficient buffer space error.
*/
KDB_EXTERN rc_t CC KMDataNodeReadAttr ( const KMDataNode *self, const char *name,
char *buffer, size_t bsize, size_t *size );
/* WriteAttr
* writes NUL-terminated string
*
* "name" [ IN ] - NUL terminated attribute name
*
* "value" [ IN ] - NUL terminated attribute value
*/
KDB_EXTERN rc_t CC KMDataNodeWriteAttr ( KMDataNode *self,
const char *name, const char *value );
/* ReadAttrAs ( formatted )
* reads as integer or float value in native byte order
* casts smaller-sized values to desired size, e.g.
* uint32_t to uint64_t
*
* "i" [ OUT ] - return parameter for signed integer
* "u" [ OUT ] - return parameter for unsigned integer
* "f" [ OUT ] - return parameter for double float
*/
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsI16 ( const KMDataNode *self, const char *attr, int16_t *i );
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsU16 ( const KMDataNode *self, const char *attr, uint16_t *u );
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsI32 ( const KMDataNode *self, const char *attr, int32_t *i );
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsU32 ( const KMDataNode *self, const char *attr, uint32_t *u );
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsI64 ( const KMDataNode *self, const char *attr, int64_t *i );
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsU64 ( const KMDataNode *self, const char *attr, uint64_t *u );
KDB_EXTERN rc_t CC KMDataNodeReadAttrAsF64 ( const KMDataNode *self, const char *attr, double *f );
/* Drop
* VDrop
* drop some or all node content
*/
KDB_EXTERN rc_t CC KMDataNodeDropAll ( KMDataNode *self );
KDB_EXTERN rc_t CC KMDataNodeDropAttr ( KMDataNode *self, const char *attr );
KDB_EXTERN rc_t CC KMDataNodeDropChild ( KMDataNode *self, const char *path, ... );
KDB_EXTERN rc_t CC KMDataNodeVDropChild ( KMDataNode *self, const char *path, va_list args );
/* Rename
* renames a contained object
*
* "from" [ IN ] - NUL terminated string in UTF-8
* giving simple name of existing attr
*
* "to" [ IN ] - NUL terminated string in UTF-8
* giving new simple attr name
*/
KDB_EXTERN rc_t CC KMDataNodeRenameAttr ( KMDataNode *self, const char *from, const char *to );
KDB_EXTERN rc_t CC KMDataNodeRenameChild ( KMDataNode *self, const char *from, const char *to );
#ifdef __cplusplus
}
#endif
#endif /* _h_kdb_meta_ */
|