Vstr documentation -- structs (29)

Index of sections

• struct Vstr_ref (aka. Vstr reference) (3)
• struct Vstr_conf (aka. Vstr configuration) (1)
• struct Vstr_base (aka. Vstr string) (2)
• struct Vstr_sects (aka. Vstr sections) (8)
• struct Vstr_fmt_spec (aka. Vstr format specifier) (12)
• struct Vstr_iter (aka. Vstr iteration) (3)

Index of sections, and their contents

• struct Vstr_ref (aka. Vstr reference)
  • func
  • ptr
  • ref
• struct Vstr_conf (aka. Vstr configuration)
  • malloc_bad
• struct Vstr_base (aka. Vstr string)
  • len
  • conf
• struct Vstr_sects (aka. Vstr sections)
  • num
  • sz
  • malloc_bad
  • free_ptr
  • can_add_sz
  • can_del_sz
  • alloc_double
  • ptr
• struct Vstr_fmt_spec (aka. Vstr format specifier)
  • vstr_orig_len
  • fmt_precision
  • obj_precision
  • fmt_field_width
  • obj_field_width
  • fmt_minus
  • fmt_plus
  • fmt_space
  • fmt_hash
  • fmt_zero
  • fmt_quote
  • fmt_I
• struct Vstr_iter (aka. Vstr iteration)
  • ptr
  • len
  • num

This is the cleanup function to be called when noone wants a reference to the memory help by the reference anymore.

This function should free() the memory accociated with the reference struct itself, if that is required.

This is a ptr to a block of memory.

When this reaches the value 0, you are free to call the func member.

It is safest to only change this by calling either vstr_ref_add_ref() or vstr_ref_del_ref(). These will automatically call the cleanup function when the reference reaches zero.

This is a bitflag which is set to TRUE by any function which does an allocation on a Vstr string or Vstr configuration that fails, this allows the programmer to call multiple allocation functions and then do a single test.

This is the length of the Vstr string.

This is a pointer to the Vstr configuration used by the Vstr string.

This is the number of used sections in the Vstr sections.

Some of the section nodes may be used by null or deleted sections.

This is the size of space allocated for sections in the Vstr sections.

This is a bitflag which is set to TRUE by any function which does an allocation on a section that fails, this allows the programmer to call multiple allocation functions and then do a single test.

This is a bitflag which is set to TRUE when the data in ->ptr can be passed to free().

This is a bitflag which is set to TRUE when the data in ->ptr can be passed to realloc() to make it bigger.

This is a bitflag which is set to TRUE when the data in ->ptr can be passed to realloc() to make it smaller.

This is a bitflag which is set to TRUE when the data in ->ptr should be realloc()'d at twice it's current size when it needs to be bigger.

This is a pointer to the section nodes.

This is the length of the Vstr string prior to vstr_add_vfmt() being called, this allows you to work out how much data has been added to the Vstr string already.

This flag specifies that the caller passed a precision, either directory or via. an argument. The precision itself is then passed as obj_precision.

This is the value passed as the precision, if one is set.

Even though the obj_precision argument is an unsigned type, as an argument the type has to be treated as signed as ISO 9899:1999 specifies that a negative precision means that the precision should be ignored (hence in this case fmt_precision will be 0). This doesn't apply to a precision typed directly into the format.

This flag specifies that the caller passed a field width, either directory or via. an argument. The field width itself is then passed as obj_field_width.

This is the value passed as the field_width, if one is set.

Even though the obj_field_width is an unsigned type, as an argument the type has to be treated as signed as ISO 9899:1999 specifies that a negative field width means that the fmt_minus flag should be set and the field width should become it's positive counter part (in vstr this work properly for INT_MIN). This doesn't apply to a field width typed directly into the format.

This is a flag specifing that the user put a '-' attribute on the format, either directly or via. a negative field width value.

This is a flag specifing that the user put a '+' attribute on the format.

This is a flag specifing that the user put a ' ' attribute on the format.

This is a flag specifing that the user put a '#' attribute on the format.

This is a flag specifing that the user put a '0' attribute on the format.

This is a flag specifing that the user put a '\'' attribute on the format.

This is a flag specifing that the user put a 'I' attribute on the format.

This is used by glibc to mean that integers should come out as locale dependant bytes. This flag currently does nothing in vstr, apart from being passed to custom specifiers.

This member is a pointer to the start of the current part of the iteration.

You can alter the pointer itself.

You shouldn't write to the memory through this pointer, as it may be read-only.

This member is the length of the current part of the iteration.

You can alter the length.

This member is the number of the current node given an iteration of the entire Vstr string.

You should not alter this value.