LAL  7.5.0.1-b72065a
UserInputPrint.c File Reference

Prototypes

char * XLALPrintStringValueOfINT8 (const INT8 *valINT8)
 Return 'string value' (allocated here) of an INT8. More...
 
char * XLALPrintStringValueOfINT4 (const INT4 *valINT4)
 Return 'string value' (allocated here) of an INT4. More...
 
char * XLALPrintStringValueOfUINT8 (const UINT8 *valUINT8)
 Return 'string value' (allocated here) of an UINT8. More...
 
char * XLALPrintStringValueOfUINT4 (const UINT4 *valUINT4)
 Return 'string value' (allocated here) of an UINT4. More...
 
char * XLALPrintStringValueOfREAL8 (const REAL8 *valREAL8)
 Return 'string value' (allocated here) of a REAL8 (printed at full precision) More...
 
char * XLALPrintStringValueOfREAL4 (const REAL4 *valREAL4)
 Return 'string value' (allocated here) of a REAL4 (printed at full precision) More...
 
char * XLALPrintStringValueOfBOOLEAN (const BOOLEAN *valBOOLEAN)
 Return 'string value' (allocated here) of a BOOLEAN. More...
 
char * XLALPrintStringValueOfEPOCH (const LIGOTimeGPS *valGPS)
 Return 'string value' (allocated here) of a GPS epoch, as parseable by XLALParseStringValueAs[GPS|EPOCH]() More...
 
char * XLALPrintStringValueOfSTRING (CHAR **valSTRING)
 Return 'string value' (allocated here) of a STRING, surrounded by double quotes. More...
 
char * XLALPrintStringValueOfINT4Range (const INT4Range *int4Range)
 Return 'string value' (allocated here) of a INT4Range, as parseable by XLALParseStringValueAsINT4Range() More...
 
char * XLALPrintStringValueOfREAL8Range (const REAL8Range *real8Range)
 Return 'string value' (allocated here) of a REAL8Range, as parseable by XLALParseStringValueAsREAL8Range() More...
 
char * XLALPrintStringValueOfEPOCHRange (const LIGOTimeGPSRange *gpsRange)
 Return 'string value' (allocated here) of a EPOCHRange, as parseable by XLALParseStringValueAsEPOCHRange() More...
 
char * XLALPrintStringValueOfUserEnum (const int *valEnum, const UserChoices *enumData)
 Return 'string value' (allocated here) of a user selection of an enumeration value. More...
 
char * XLALFormatHelpStringOfUserEnum (const UserChoices *enumData)
 Return format help string (allocated here) for a user selection of an enumeration value. More...
 
char * XLALPrintStringValueOfUserFlag (const int *valFlag, const UserChoices *flagData)
 Return 'string value' (allocated here) of a user selection of an bitflag value. More...
 
char * XLALFormatHelpStringOfUserFlag (const UserChoices *flagData)
 Return format help string (allocated here) for a user selection of an bitflag value. More...
 
char * XLALPrintStringValueOfSTRINGVector (LALStringVector **valSTRINGVector)
 Return 'string value' (allocated here) of a STRINGVector, by turning into comma-separated list of strings, each surrounded by single quotes. More...
 
 DEFN_XLALPrintStringValueOfVector (INT4)
 
 DEFN_XLALPrintStringValueOfVector (UINT4)
 
 DEFN_XLALPrintStringValueOfVector (REAL8)
 

Go to the source code of this file.

Macros

#define DEFN_XLALPrintStringValueOfVector(CTYPE)
 Return 'string value' (allocated here) of a <CTYPE>Vector, by turning into comma-separated list of <CTYPE> values. More...
 

Macro Definition Documentation

◆ DEFN_XLALPrintStringValueOfVector

#define DEFN_XLALPrintStringValueOfVector (   CTYPE)
Value:
{ \
XLAL_CHECK_NULL ( valVector != NULL, XLAL_EINVAL ); \
char *ret = NULL; \
if ( (*valVector == NULL) || ((*valVector)->data == NULL) || ((*valVector)->length == 0) ) \
{ \
XLAL_CHECK_NULL ( (ret = XLALStringDuplicate("NULL")) != NULL, XLAL_EFUNC ); \
} \
else \
{ \
for ( UINT4 i=0; i < (*valVector)->length; i++ ) \
{ \
if ( i != 0 ) { \
XLAL_CHECK_NULL ( (ret = XLALStringAppend ( ret, "," )) != NULL, XLAL_EFUNC ); \
} \
char *tmp; \
XLAL_CHECK_NULL ( (tmp = XLALPrintStringValueOf##CTYPE ( &(*valVector)->data[i])) != NULL, XLAL_EFUNC ); \
XLAL_CHECK_NULL ( (ret = XLALStringAppend ( ret, tmp )) != NULL, XLAL_EFUNC ); \
XLALFree ( tmp ); \
} /* for i < length */ \
} /* end: if non-empty input vector */ \
\
return ret; \
\
} /* XLALPrintStringValueOf<CYPTE>Vector() */
uint32_t UINT4
Four-byte unsigned integer.
char * XLALStringDuplicate(const char *s)
Like strdup but uses LAL allocation routines (free with LALFree).
Definition: LALString.c:89
char * XLALStringAppend(char *s, const char *append)
Like strcat but dynamically reallocates string with LALRealloc.
Definition: LALString.c:50
#define DECL_XLALPrintStringValueOfVector(CTYPE)
@ XLAL_EFUNC
Internal function call failed bit: "or" this with existing error number.
Definition: XLALError.h:462
@ XLAL_EINVAL
Invalid argument.
Definition: XLALError.h:409

Return 'string value' (allocated here) of a <CTYPE>Vector, by turning into comma-separated list of <CTYPE> values.

The output is parseable by XLALParseStringValueAs<CTYPE>Vector(). In case of a NULL or empty vector (data==NULL|length==0), generate the string 'NULL'.

Definition at line 370 of file UserInputPrint.c.

Function Documentation

◆ DEFN_XLALPrintStringValueOfVector() [1/3]

DEFN_XLALPrintStringValueOfVector ( INT4  )

◆ DEFN_XLALPrintStringValueOfVector() [2/3]

DEFN_XLALPrintStringValueOfVector ( UINT4  )

◆ DEFN_XLALPrintStringValueOfVector() [3/3]

DEFN_XLALPrintStringValueOfVector ( REAL8  )