Ustr - 1.0.4 reference documentation -- constants (60)

Index of sections

• Compile switch constants (6)
• Constants to created fixed/read-only Ustr's (10)
• Constants to use with parsing numbers: ustr_parse_uintmaxx, etc. (16)
• Constants to pass to ustr_split* (4)
• Misc constants to use in code (4)
• Constants passed to ustr_cntl_opt() (16)
• Constants passed to ustr_pool_ll_cntl() (4)

Index of sections, and their contents

• Compile switch constants
  • USTR_CONF_INCLUDE_CODEONLY_HEADERS
  • USTR_CONF_USE_EOS_MARK
  • USTR_CONF_USE_ASSERT
  • USTR_CONF_COMPILE_USE_ATTRIBUTES
  • USTR_CONF_COMPILE_TYPEDEF
  • USTR_CONF_COMPILE_USE_INLINE
• Constants to created fixed/read-only Ustr's
  • USTR_BEG_CONST1
  • USTR_BEG_CONST2
  • USTR_BEG_CONST4
  • USTR_BEG_FIXED1
  • USTR_BEG_FIXED2
  • USTR_BEG_FIXED4
  • USTR_BEG_FIXED8
  • USTR_END_ALOCDx
  • USTR_END_CONSTx
  • USTR_END_FIXEDx
• Constants to use with parsing numbers: ustr_parse_uintmaxx, etc.
  • USTR_FLAG_PARSE_NUM_DEF
  • USTR_FLAG_PARSE_NUM_SEP
  • USTR_FLAG_PARSE_NUM_OVERFLOW
  • USTR_FLAG_PARSE_NUM_SPACE
  • USTR_FLAG_PARSE_NUM_NO_BEG_ZERO
  • USTR_FLAG_PARSE_NUM_NO_BEG_PM
  • USTR_FLAG_PARSE_NUM_NO_NEGATIVE
  • USTR_FLAG_PARSE_NUM_EXACT
  • USTR_TYPE_PARSE_NUM_ERR_NONE
  • USTR_TYPE_PARSE_NUM_ERR_ONLY_S
  • USTR_TYPE_PARSE_NUM_ERR_ONLY_SPM
  • USTR_TYPE_PARSE_NUM_ERR_ONLY_SPMX
  • USTR_TYPE_PARSE_NUM_ERR_OOB
  • USTR_TYPE_PARSE_NUM_ERR_OVERFLOW
  • USTR_TYPE_PARSE_NUM_ERR_NEGATIVE
  • USTR_TYPE_PARSE_NUM_ERR_BEG_ZERO
• Constants to pass to ustr_split*
  • USTR_FLAG_SPLIT_DEF
  • USTR_FLAG_SPLIT_RET_SEP
  • USTR_FLAG_SPLIT_RET_NON
  • USTR_FLAG_SPLIT_KEEP_CONFIG
• Misc constants to use in code
  • USTR_NULL
  • USTR_POOL_NULL
  • USTR_TRUE
  • USTR_FALSE
• Constants passed to ustr_cntl_opt()
  • USTR_CNTL_OPT_GET_REF_BYTES
  • USTR_CNTL_OPT_SET_REF_BYTES
  • USTR_CNTL_OPT_GET_HAS_SIZE
  • USTR_CNTL_OPT_SET_HAS_SIZE
  • USTR_CNTL_OPT_GET_EXACT_BYTES
  • USTR_CNTL_OPT_SET_EXACT_BYTES
  • USTR_CNTL_OPT_GET_MEM
  • USTR_CNTL_OPT_SET_MEM
  • USTR_CNTL_OPT_GET_MC_M_SCRUB
  • USTR_CNTL_OPT_SET_MC_M_SCRUB
  • USTR_CNTL_OPT_GET_MC_F_SCRUB
  • USTR_CNTL_OPT_SET_MC_F_SCRUB
  • USTR_CNTL_OPT_GET_MC_R_SCRUB
  • USTR_CNTL_OPT_SET_MC_R_SCRUB
  • USTR_CNTL_OPT_GET_FMT
  • USTR_CNTL_OPT_SET_FMT
• Constants passed to ustr_pool_ll_cntl()
  • USTR_POOL_LL_CNTL_GET_FREE_CMP
  • USTR_POOL_LL_CNTL_SET_FREE_CMP
  • USTR_POOL_LL_CNTL_GET_REALLOC
  • USTR_POOL_LL_CNTL_SET_REALLOC

This switch controls whether all the code will be included as inline functions. Having this be non-zero means that you don't have to link against the library.

This switch turns on End of String markers, so any bounds overflow will be noticed by ustr_assert_valid().

Changing this will not do anything useful unless USTR_CONF_INCLUDE_CODEONLY_HEADERS is non-zero.

This switch turns USTR_ASSERT() calls on, so the code within them will be evaluated. Note that there are many calls to ustr_assert_valid() within USTR_ASSERT() macros and that call is relatively expensive.

Changing this will not do anything useful unless USTR_CONF_INCLUDE_CODEONLY_HEADERS is non-zero.

This switch controls whether gcc type __attribute__() statements are used in the public headers headers for the library. If the value is 1 then if they are supported by the compiler that built the library they will be used, if the value is 0 they won't be used at all.

This switch controls whether typedef will be used for the structs in the public headers for the library. If the value is 1 then they will be used, if the value is 0 they won't be used at all (and your code will have to use struct tags instead -- note all libraries using ustr should compile without this option set).

This switch controls whether inline functions will be used in a few cases where the function bodies are very small.

In some cases this is used so that GCC can eliminate calls to strlen(), for the *_cstr() functions.

This macro is a constant C-style string of the first byte of a constant/read-only Ustr that has a length in the range 0-255.

This macro is a constant C-style string of the first byte of a constant/read-only Ustr that has a length in the range 0-65535.

This macro is a constant C-style string of the first byte of a constant/read-only Ustr that has a length in the range 0-4294967295.

This macro is a constant C-style string of the first byte of a fixed Ustr that has a length in the range 0-255.

This macro is a constant C-style string of the first byte of a fixed Ustr that has a length in the range 0-65535.

This macro is a constant C-style string of the first byte of a fixed Ustr that has a length in the range 0-4294967295.

This macro is a constant C-style string of the first byte of a fixed Ustr that has a length in the range 0-18446744073709551615.

This macro is only available if the Ustr code was compiled in a 64bit environment.

This macro is a constant C-style string of the last bytes of an allocated Ustr.

Unless USTR_CONF_USE_EOS_MARK is non-zero, this is just the NIL byte.

This macro is a constant C-style string of the last bytes of a constant/read-only Ustr.

Unless USTR_CONF_USE_EOS_MARK is non-zero, this is just the NIL byte.

This macro is a constant C-style string of the last bytes of a fixed Ustr.

Unless USTR_CONF_USE_EOS_MARK is non-zero, this is just the NIL byte.

Default flags, this is merely 0 but can be used as live documentation.

This flag allows the parsing (and ignoring) of the seperator character, at arbitrary pointers in the number, so "1234" and "1_234" would both parse the same (assuming "_" is the seperator).

This flag turns on the overflow checking, in other words without it USTR_TYPE_PARSE_NUM_ERR_OVERFLOW will never be returned as an error code.

This flag allows one or more ' ' (Space) characters before the number or number prefix (Plus Sign, Hyphen).

Other forms of whitespace don't count, this just affects ' '.

This flag disallows one or more '0' (Digit Zero) characters before the number.

This flag disallows a plus or a minus character before the number.

This flag disallows negative values.

This flag makes the parsing functions return an error if the entire string doesn't contain the number being parsed.

This error code has the value 0, and means that no error occurred parsing the number.

This error code means that the Ustr string consisted only of spaces.

This error code means that the Ustr string consisted only spaces, and a plus or minus sign.

This error code means that the Ustr string consisted of only spaces, a plus or minus sign and a "0x" base 16 prefix.

This error code means that the Ustr string had characters in it that where out of bounds from the working base.

Without the USTR_FLAG_PARSE_NUM_EXACT, this error is ignored as soon as any number is parsed.

This out of bounds includes the Ustr string "++" as well as "4A", when parsing in a base less than 11.

This error code means that the number parsed from the Ustr string would overflow the type it is being parsed into, this is only returned when the USTR_FLAG_PARSE_NUM_OVERFLOW flag was passed to the parse function.

This error code means that the number parsed from the Vstr string starts with a '-' (Hyphen) character when it is supposed to be an unsigned number.

This error code means that the number parsed from the Vstr string starts with a '0' (Digit Zero) character, when the USTR_FLAG_PARSE_NUM_NO_BEG_ZERO flag was passed to the parse function.

Default flags, this is merely 0 but can be used as live documentation.

Return the separator along with the tokens. For example splitting "a,b," using separator "," will return the tokens "a," and "b," whereas without this flag only "a" and "b" would be returned.

Return empty tokens. For example: splitting "a,,b" with separator "," will return the tokens {"a" "" "b"}.

Force the returned Ustr's to have same configuration parameters as the Ustr string that is being split.

This macro is merely 0 cast to (struct Ustr *), and can be used anywhere NULL would be but "returns" the correct type.

This macro is merely 0 cast to (struct Ustr_pool *), and can be used anywhere NULL would be but "returns" the correct type.

This macro is 1, but shows the intent that a boolean value is expected and not a number.

This macro is 0, but shows the intent that a boolean value is expected and not a number.

This option will get the default number of bytes used for a reference count when creating Ustr's.

This option will set the default number of bytes used for a reference count when creating Ustr's.

For a single instance, the ustr_dupx_*() functions can be used.

This option will get the default flag for whether to store an explicit size in created Ustr's.

This option will set the default flag for whether to store an explicit size in created Ustr's.

For a single instance, the ustr_dupx_*() functions can be used.

This option will get the default flag for whether to exactly allocate memory when a Ustr needs to be resized.

This option will set the default flag for whether to exactly allocate memory when a Ustr needs to be resized.

For a single instance, the ustr_dupx_*() functions can be used.

This option will get the "system" allocation functions (malloc, realloc, free) for allocated Ustr's.

As you would expect the default values are: malloc, realloc, free.

This option will set the "system" allocation functions (malloc, realloc, free) for allocated Ustr's.

If this option is set after a Ustr has been created, then when freeing or reallocating the existing Ustr the given functions will be used. So they must either be compatible with the default or you must ensure that nothing is allocated before they are set.

This option will get the flag for whether to "scrub" data allocated via. malloc check.

Malloc check has to be enabled for this to mean anything, Ie. USTR_CNTL_MALLOC_LVL() must be positive.

This option will set the flag for whether to "scrub" data allocated via. malloc check.

Malloc check has to be enabled for this to mean anything, Ie. USTR_CNTL_MALLOC_LVL() must be positive.

This option will get the flag for whether to "scrub" data freed via. malloc check.

Malloc check has to be enabled for this to mean anything, Ie. USTR_CNTL_MALLOC_LVL() must be positive.

This option will set the flag for whether to "scrub" data freed via. malloc check.

Malloc check has to be enabled for this to mean anything, Ie. USTR_CNTL_MALLOC_LVL() must be positive.

This option will get the flag for whether to "scrub" data reallocated via. malloc check. This is done by turning all reallocations into a malloc() and free(), and so is even more costly than normal scrubbing.

Malloc check has to be enabled for this to mean anything, Ie. USTR_CNTL_MALLOC_LVL() must be positive.

This option will set the flag for whether to "scrub" data reallocated via. malloc check. This is done by turning all reallocations into a malloc() and free(), and so is even more costly than normal scrubbing.

Malloc check has to be enabled for this to mean anything, Ie. USTR_CNTL_MALLOC_LVL() must be positive.

This option will get the system formatting functions (vsnprintf) for Ustr's.

There are two functions, the first is always called and the second is likely called (always with the exact same arguments) if the length passed to the first call was not big enough.

As you would expect the default values are: vsnprintf and vsnprintf

This option will set the system formatting functions (vsnprintf) for Ustr's.

This option will get the number of comparisons done on a pool free operation.

This option will set the number of comparisons done on a pool free operation.

The default is a small non-zero value, as it's significantly common to have very short lived ustr's ... however this doesn't mean that you can't forget to take references even with pool allocated ustrs.

This option will get the flag for if we call realloc() to make data bigger, or revert to just allocating anew each time.

This option will set the flag for if we call realloc() to make data bigger, or revert to just allocating anew each time.

As with USTR_POOL_LL_CNTL_SET_FREE_CMP this option means you can't assume that pool allocated data is never freed until ustr_pool_free() is called, and again it is due to there being significant speed improvements for not making that assumption. Instead of disabling this option, just take areference (which will also make sure the ustr isn't modified behind your back).