ARB
Classes | Macros | Typedefs | Enumerations | Functions
arbdb.h File Reference
#include <arbtools.h>
#include <arbdb_base.h>
#include <arb_error.h>
#include <stdint.h>
#include <ad_prot.h>
#include <arb_mem.h>
#include <arb_msg.h>
#include <arb_string.h>
Include dependency graph for arbdb.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  GB_transaction
 
struct  GB_initial_transaction
 
class  GB_shell
 
class  GB_securityLevel
 
struct  GB_topSecurityLevel
 
struct  GB_previousSecurityLevel
 

Macros

#define GB_SYSTEM_FOLDER   "__SYSTEM__"
 
#define GB_SYSTEM_KEY_DATA   "@key_data"
 
#define GB_DEFAULT_ALIGNMENT   "presets/use"
 
#define GB_USERFLAG_ANY   127
 
#define GB_USERFLAG_QUERY   1
 
#define GB_USERFLAG_WASMARKED   2
 
#define GB_USERFLAG_GHOSTNODE   1
 

Typedefs

typedef int GB_COMPRESSION_MASK
 
typedef long(* gb_hash_loop_type )(const char *key, long val, void *client_data)
 
typedef void(* gb_hash_const_loop_type )(const char *key, long val, void *client_data)
 
typedef int(* gbs_hash_compare_function )(const char *key0, long val0, const char *key1, long val1)
 
typedef const char *(* gb_export_sequence_cb )(GBDATA *gb_species, size_t *seq_len, GB_ERROR *error)
 
typedef GBDATA *(* GB_Link_Follower )(GBDATA *GB_root, GBDATA *GB_elem, const char *link)
 
typedef const char *(* gb_getenv_hook )(const char *varname)
 

Enumerations

enum  GB_TYPES {
  GB_NONE = 0, GB_BIT = 1, GB_BYTE = 2, GB_INT = 3,
  GB_FLOAT = 4, GB_POINTER = 5, GB_BITS = 6, GB_BYTES = 8,
  GB_INTS = 9, GB_FLOATS = 10, GB_OBSOLETE = 11, GB_STRING = 12,
  GB_STRING_SHRT = 13, GB_DB = 15, GB_TYPE_MAX = 16, GB_CREATE_CONTAINER = GB_DB,
  GB_FIND = GB_NONE
}
 
enum  GB_SEARCH_TYPE {
  SEARCH_BROTHER = 1, SEARCH_CHILD = 2, SEARCH_GRANDCHILD = 4, SEARCH_NEXT_BROTHER = SEARCH_BROTHER+8,
  SEARCH_CHILD_OF_NEXT = SEARCH_CHILD+8
}
 
enum  GB_UNDO_TYPE {
  GB_UNDO_NONE, GB_UNDO_KILL, GB_UNDO_UNDO, GB_UNDO_REDO,
  GB_UNDO_UNDO_REDO
}
 
enum  XCMD_TYPE {
  _XCMD__ASYNC = 1, _XCMD__WAITKEY = 2, XCMD_ASYNC_WAITKEY = _XCMD__ASYNC|_XCMD__WAITKEY, XCMD_ASYNC_WAIT_ON_ERROR = _XCMD__ASYNC,
  XCMD_SYNC_WAITKEY = _XCMD__WAITKEY, XCMD_SYNC_WAIT_ON_ERROR = 0
}
 

Functions

bool GB_TYPE_readable_as_string (GB_TYPES type)
 
charGBS_find_string (char *content, GB_CSTR key, int match_mode)
 
void GB_end_transaction_show_error (GBDATA *gbd, ARB_ERROR &error, void(*error_handler)(GB_ERROR))
 
ARB_ERROR GB_end_transaction (GBDATA *gbd, ARB_ERROR &error)
 

Macro Definition Documentation

#define GB_SYSTEM_FOLDER   "__SYSTEM__"
#define GB_SYSTEM_KEY_DATA   "@key_data"

Definition at line 28 of file arbdb.h.

Referenced by gb_load_key_data_and_dictionaries(), and NT_fix_dict_compress().

#define GB_DEFAULT_ALIGNMENT   "presets/use"
#define GB_USERFLAG_ANY   127

Definition at line 54 of file arbdb.h.

Referenced by GB_clear_user_flag(), and legal_user_bitmask().

#define GB_USERFLAG_QUERY   1
#define GB_USERFLAG_WASMARKED   2

Definition at line 56 of file arbdb.h.

Referenced by NT_create_config_after_import().

#define GB_USERFLAG_GHOSTNODE   1

Definition at line 57 of file arbdb.h.

Referenced by gbt_write_tree(), and gbt_write_tree_nodes().

Typedef Documentation

Definition at line 35 of file arbdb.h.

typedef long(* gb_hash_loop_type)(const char *key, long val, void *client_data)

Definition at line 130 of file arbdb.h.

typedef void(* gb_hash_const_loop_type)(const char *key, long val, void *client_data)

Definition at line 131 of file arbdb.h.

typedef int(* gbs_hash_compare_function)(const char *key0, long val0, const char *key1, long val1)

Definition at line 132 of file arbdb.h.

typedef const char*(* gb_export_sequence_cb)(GBDATA *gb_species, size_t *seq_len, GB_ERROR *error)

Definition at line 134 of file arbdb.h.

typedef GBDATA*(* GB_Link_Follower)(GBDATA *GB_root, GBDATA *GB_elem, const char *link)

Definition at line 136 of file arbdb.h.

typedef const char*(* gb_getenv_hook)(const char *varname)

Definition at line 138 of file arbdb.h.

Enumeration Type Documentation

enum GB_TYPES
Enumerator
GB_NONE 
GB_BIT 
GB_BYTE 
GB_INT 
GB_FLOAT 
GB_POINTER 
GB_BITS 
GB_BYTES 
GB_INTS 
GB_FLOATS 
GB_OBSOLETE 
GB_STRING 
GB_STRING_SHRT 
GB_DB 
GB_TYPE_MAX 
GB_CREATE_CONTAINER 
GB_FIND 

Definition at line 62 of file arbdb.h.

Enumerator
SEARCH_BROTHER 
SEARCH_CHILD 
SEARCH_GRANDCHILD 
SEARCH_NEXT_BROTHER 
SEARCH_CHILD_OF_NEXT 

Definition at line 99 of file arbdb.h.

Enumerator
GB_UNDO_NONE 
GB_UNDO_KILL 
GB_UNDO_UNDO 
GB_UNDO_REDO 
GB_UNDO_UNDO_REDO 

Definition at line 107 of file arbdb.h.

enum XCMD_TYPE
Enumerator
_XCMD__ASYNC 
_XCMD__WAITKEY 
XCMD_ASYNC_WAITKEY 
XCMD_ASYNC_WAIT_ON_ERROR 
XCMD_SYNC_WAITKEY 
XCMD_SYNC_WAIT_ON_ERROR 

Definition at line 115 of file arbdb.h.

Function Documentation

bool GB_TYPE_readable_as_string ( GB_TYPES  type)
inline

returns true if 'type' is readable using GB_read_as_string(). For other types GB_read_as_string() returns NULp. Implies that it is writeable using GB_write_autoconv_string().

See also
GB_readable_as_string()

Definition at line 90 of file arbdb.h.

References GB_BITS, GB_BYTE, GB_FLOAT, GB_INT, and GB_STRING.

Referenced by GB_read_as_string(), GB_readable_as_string(), and FieldTransfer::Rule::makeFromConfig().

char* GBS_find_string ( char content,
GB_CSTR  key,
int  match_mode 
)
inline

Definition at line 254 of file arbdb.h.

void GB_end_transaction_show_error ( GBDATA gbd,
ARB_ERROR error,
void(*)(GB_ERROR error_handler 
)
inline

Definition at line 261 of file arbdb.h.

References ARB_ERROR::deliver().

ARB_ERROR GB_end_transaction ( GBDATA gbd,
ARB_ERROR error 
)
inline

Definition at line 264 of file arbdb.h.

References ARB_ERROR::deliver().