/usr/include/ncbi-vdb/xfs/model.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 | /*===========================================================================
*
* 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 _xfs_model_h_
#define _xfs_model_h_
#include <xfs/xfs-defs.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*))
|| Lyrics.
++ That file contains interfaces for model which contains formal
|| description for XFS Tree.
((*/
/*)))
/// XFSModel and other forwards.
(((*/
struct XFSModel;
struct XFSModelNode;
struct KNamelist;
/*)) Common name defines for model property names
((*/
#define XFS_MODEL_ROOT "root" /* the only mandatory node
to have */
#define XFS_MODEL_AS "as" /* use this node as template
overridden properties */
#define XFS_MODEL_TYPE "type" /* mandatory, used for tree
rendering */
#define XFS_MODEL_LABEL "label" /* name which will be used at
rendered tree, could be
overriden by alias */
#define XFS_MODEL_SECURITY "security" /* in real life those are
permissions */
#define XFS_MODEL_CHILDREN "children" /* usually any container, it
is list of names of children
with labels */
#define XFS_MODEL_SOURCE "source"
#define XFS_MODEL_TEXT "text"
#define XFS_MODEL_PASSWD "password"
#define XFS_MODEL_ENCTYPE "enctype"
#define XFS_MODEL_MODE "mode"
#define XFS_MODEL_MODE_RO "RO"
#define XFS_MODEL_MODE_RW "RW"
#define XFS_MODEL_PROJECTID "project-id"
#define XFS_MODEL_OBJECTID "object-id"
#define XFS_MODEL_ACCESSION "accession"
/*)))
/// Methods
(((*/
XFS_EXTERN
const char * CC
XFSModelNodeName ( const struct XFSModelNode * self );
XFS_EXTERN
const char * CC
XFSModelNodeType ( const struct XFSModelNode * self );
XFS_EXTERN
bool CC
XFSModelNodeReadOnly ( const struct XFSModelNode * self );
XFS_EXTERN
const char * CC
XFSModelNodeAs ( const struct XFSModelNode * self );
XFS_EXTERN
const char * CC
XFSModelNodeLabel ( const struct XFSModelNode * self );
XFS_EXTERN
const char * CC
XFSModelNodeSecurity ( const struct XFSModelNode * self );
XFS_EXTERN
bool CC
XFSModelNodeIsRoot ( const struct XFSModelNode * self );
XFS_EXTERN
rc_t CC
XFSModelNodePropertyNames (
const struct XFSModelNode * self,
const struct KNamelist ** Properties
);
XFS_EXTERN
const char * CC
XFSModelNodeProperty (
const struct XFSModelNode * self,
const char * PropertyName
);
XFS_EXTERN
rc_t CC
XFSModelNodeChildrenNames (
const struct XFSModelNode * self,
const struct KNamelist ** Children
);
XFS_EXTERN
const char * CC
XFSModelNodeChildAlias (
const struct XFSModelNode * self,
const char * ChildName
);
XFS_EXTERN
rc_t CC
XFSModelMake (
struct XFSModel ** Model,
const char * Resource, /* OK to be NULL */
const char * Version /* OK to be NULL */
);
XFS_EXTERN
rc_t CC
XFSModelDispose ( struct XFSModel * self );
XFS_EXTERN
rc_t CC
XFSModelAddRef ( const struct XFSModel * self );
XFS_EXTERN
rc_t CC
XFSModelRelease ( const struct XFSModel * self );
XFS_EXTERN
const struct XFSModelNode * CC
XFSModelRootNode ( const struct XFSModel * self );
XFS_EXTERN
const struct XFSModelNode * CC
XFSModelLookupNode ( const struct XFSModel * self, const char * Name );
XFS_EXTERN
const char * CC
XFSModelResource ( const struct XFSModel * self );
XFS_EXTERN
const char * CC
XFSModelVersion ( const struct XFSModel * self );
/*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*/
/* Model Editing methods */
/*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*/
XFS_EXTERN
rc_t CC
XFSModelFromScratch (
struct XFSModel ** Model,
const char * Version
);
XFS_EXTERN
rc_t CC
XFSModelAddNode (
struct XFSModel * self,
const char * NodeName, /* not null */
const char * Type /* not null */
);
XFS_EXTERN
rc_t CC
XFSModelAddRootNode (
struct XFSModel * self,
const char * Type /* not null */
);
XFS_EXTERN
rc_t CC
XFSModelNodeSetProperty (
struct XFSModelNode * self,
const char * Key, /* not null */
const char * Value /* could be null */
);
XFS_EXTERN
rc_t CC
XFSModelNodeSetLabel (
struct XFSModelNode * self,
const char * Label /* could be null */
);
XFS_EXTERN
rc_t CC
XFSModelNodeSetSecurity (
struct XFSModelNode * self,
const char * Security /* could be null */
);
XFS_EXTERN
rc_t CC
XFSModelNodeSetSource (
struct XFSModelNode * self,
const char * Source /* could be null */
);
XFS_EXTERN
rc_t CC
XFSModelNodeSetChildren (
struct XFSModelNode * self,
const char * CommaSeparChildrenNames /* could be null */
);
/*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*/
/*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*_*/
XFS_EXTERN
void CC
XFSModelNodeDDump ( const struct XFSModelNode * self );
XFS_EXTERN
void CC
XFSModelDDump ( const struct XFSModel * self );
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* _xfs_model_h_ */
|