/usr/include/ncbi-vdb/klib/status.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 | /*===========================================================================
*
* 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_klib_status_
#define _h_klib_status_
#ifndef _h_klib_extern_
#include <klib/extern.h>
#endif
#ifndef _h_klib_writer_
#include <klib/writer.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
typedef uint32_t KStsLevel;
enum
{
STAT_USR = 1, /* normal user verbosity */
STAT_PWR, /* power-user verbosity */
STAT_QA, /* qa-level description */
STAT_PRG, /* programmer description */
STAT_GEEK /* absurdly verbose */
};
KLIB_EXTERN KStsLevel CC KStsLevelGet( void );
KLIB_EXTERN void CC KStsLevelSet( KStsLevel level );
KLIB_EXTERN void CC KStsLevelAdjust( int32_t adjust );
/* -----
* Handlers for application and library writers.
*/
KLIB_EXTERN KWrtHandler* CC KStsHandlerGet (void);
KLIB_EXTERN KWrtHandler* CC KStsLibHandlerGet (void);
KLIB_EXTERN KWrtWriter CC KStsWriterGet (void);
KLIB_EXTERN KWrtWriter CC KStsLibWriterGet (void);
KLIB_EXTERN void* CC KStsDataGet (void);
KLIB_EXTERN void* CC KStsLibDataGet (void);
/*
* Init()
* Initialize the status messages module to a known state
*/
KLIB_EXTERN rc_t CC KStsInit (void);
KLIB_EXTERN rc_t CC KStsMsg (const char * fmt, ...);
KLIB_EXTERN rc_t CC KStsLibMsg (const char * fmt, ...);
/* Set
*/
KLIB_EXTERN rc_t CC KStsHandlerSet (KWrtWriter writer, void * data);
KLIB_EXTERN rc_t CC KStsLibHandlerSet (KWrtWriter writer, void * data);
KLIB_EXTERN rc_t CC KStsHandlerSetStdOut ( void );
KLIB_EXTERN rc_t CC KStsLibHandlerSetStdOut ( void );
KLIB_EXTERN rc_t CC KStsHandlerSetStdErr ( void );
KLIB_EXTERN rc_t CC KStsLibHandlerSetStdErr ( void );
/* formatting */
typedef uint32_t KStsFmtFlags;
enum KStsFmtFlagsEnum
{
kstsFmtTimestamp = 0x00000001,
kstsFmtPid = 0x00000002,
kstsFmtAppName = 0x00000004,
kstsFmtAppVersion = 0x00000008,
kstsFmtMessage = 0x00000010, /* actual message */
kstsFmtLocalTimestamp = 0x00000020 /* print time stamp in local time, if both bits set local takes over */
};
KLIB_EXTERN KFmtHandler* CC KStsFmtHandlerGet (void);
KLIB_EXTERN KFmtHandler* CC KStsLibFmtHandlerGet (void);
KLIB_EXTERN KStsFmtFlags CC KStsFmtFlagsGet ( void );
KLIB_EXTERN KStsFmtFlags CC KStsLibFmtFlagsGet ( void );
KLIB_EXTERN KFmtWriter CC KStsFmtWriterGet (void);
KLIB_EXTERN KFmtWriter CC KStsLibFmtWriterGet (void);
KLIB_EXTERN void* CC KStsFmtDataGet (void);
KLIB_EXTERN void* CC KStsLibFmtDataGet (void);
KLIB_EXTERN rc_t CC KStsFmtFlagsSet (KStsFmtFlags flags);
KLIB_EXTERN rc_t CC KStsLibFmtFlagsSet (KStsFmtFlags flags);
KLIB_EXTERN rc_t CC KStsFmtHandlerSet (KFmtWriter formatter, KStsFmtFlags flags, void * data);
KLIB_EXTERN rc_t CC KStsLibFmtHandlerSet (KFmtWriter formatter, KStsFmtFlags flags, void * data);
KLIB_EXTERN rc_t CC KStsFmtHandlerSetDefault(void);
KLIB_EXTERN rc_t CC KStsLibFmtHandlerSetDefault(void);
/*
* A usage could look like
*
* STSMSG(4, ("Current Status Level is %d\n", KStsLevelGet()));
*
*/
#ifdef _LIBRARY
#define STSMSG(lvl,msg) \
(void)((((unsigned)lvl) <= KStsLevelGet()) ? KStsLibMsg msg : 0)
#define STATUS( lvl, ... ) \
( void ) ( ( ( lvl ) <= KStsLevelGet () ) ? KStsLibMsg ( __VA_ARGS__ ) : 0 )
#else
#define STSMSG(lvl,msg) \
(void)((((unsigned)lvl) <= KStsLevelGet()) ? KStsMsg msg : 0)
#define STATUS( lvl, ... ) \
( void ) ( ( ( lvl ) <= KStsLevelGet () ) ? KStsMsg ( __VA_ARGS__ ) : 0 )
#endif
#ifdef __cplusplus
}
#endif
#endif /* _h_klib_status_ */
|