Join composite types into a single string

Collaboration diagram for Join composite types into a single string:

Functions
int	amxc_string_join_llist (amxc_string_t *string, const amxc_llist_t *list, char separator)
	Joins a list of amxc_string_t values into a single string with a separator. More...
int	amxc_string_join_var (amxc_string_t *string, const amxc_var_t *const var, const char *sep)
	Joins a variant containing a list of variants into a single string. More...
int	amxc_string_join_var_until (amxc_string_t *string, const amxc_var_t *const var, const char *sep, const char *end, bool remove)
	Joins a variant containing a list of variants into a single string until the end string is encountered . More...
int	amxc_string_csv_join_var (amxc_string_t *string, const amxc_var_t *const var)
	Joins a variant containing a list of variants into a single string using ',' as separator. More...
int	amxc_string_ssv_join_var (amxc_string_t *string, const amxc_var_t *const var)
	Joins a variant containing a list of variants into a single string using ' ' as separator. More...

Detailed Description

When a list of strings or a list of variants is available they can be joined into a single string using one of these functions

Function Documentation

amxc_string_csv_join_var()

int amxc_string_csv_join_var	(	amxc_string_t *	string,
		const amxc_var_t *const	var
	)

Joins a variant containing a list of variants into a single string using ',' as separator.

This function does the same as amxc_string_join_var and uses ',' as the value separator.

Parameters

string	a pointer to a amxc_string_t structure, the joined string will be put in this string.
var	The variant containing a linked list of variants

Returns

0 on success. -1 if an error has occurred

Definition at line 164 of file amxc_string_join.c.

                                                          {
    return amxc_string_join_var(string, var, ",");
}

amxc_string_join_llist()

int amxc_string_join_llist	(	amxc_string_t *	string,
		const amxc_llist_t *	list,
		char	separator
	)

Joins a list of amxc_string_t values into a single string with a separator.

All amxc_string_t items in the linked list are joined into one amxc_string_t. A single character separator can be provided and will be put between all individual items.

Note

The characters [ and ] can not be used as a separator. When a space character is used (tab, new line, ...) as a separator it is replaced with a single space ' '.

Warning

This function only works on a linked list where all items are of the type amxc_string_t.

Parameters

string	a pointer to a amxc_string_t structure, the joined string will be put in this string.
list	the linked list of strings
separator	single character separator.

Returns

0 on success. -1 if an error has occurred

Definition at line 69 of file amxc_string_join.c.

                                           {
    int retval = -1;
 
    when_null(string, exit);
    when_null(list, exit);
    when_true(isalnum(separator) != 0, exit);
    when_true(separator == '[' || separator == ']', exit);
 
    if(isspace(separator) != 0) {
        separator = ' ';
    }
 
    amxc_llist_for_each(it, list) {
        amxc_string_t* part = amxc_string_from_llist_it(it);
        if(!amxc_string_is_empty(string)) {
            amxc_string_appendf(string, "%c", separator);
        }
        amxc_string_append(string,
                           amxc_string_get(part, 0),
                           amxc_string_text_length(part));
    }
 
    retval = 0;
 
exit:
    return retval;
}

amxc_string_join_var()

int amxc_string_join_var	(	amxc_string_t *	string,
		const amxc_var_t *const	var,
		const char *	sep
	)

Joins a variant containing a list of variants into a single string.

All variants in the linked list of variants are converted to a string and added to the result string. A separator string can be provided and will be put between the items.

If an item in the list is a variant containing a list, this list will be added as a string starting with '[' and ending with ']'. All items in that list are added as a string and separated with ','.

Warning

This function only works when the provided variant contains a list of variants.

Parameters

string	a pointer to a amxc_string_t structure, the joined string will be put in this string.
var	The variant containing a linked list of variants
sep	separator string.

Returns

0 on success. -1 if an error has occurred

Definition at line 158 of file amxc_string_join.c.

                                                {
    return amxc_string_join_var_until(string, var, separator, NULL, false);
}

amxc_string_join_var_until()

int amxc_string_join_var_until	(	amxc_string_t *	string,
		const amxc_var_t *const	var,
		const char *	sep,
		const char *	end,
		bool	remove
	)

Joins a variant containing a list of variants into a single string until the end string is encountered .

All variants in the linked list of variants are converted to a string and added to the result string. A separator string can be provided and will be put between the items.

If an item in the list is a variant containing a list, this list will be added as a string starting with '[' and ending with ']'. All items in that list are added as a string and separated with ','.

When a variant in the list is encountered that after converting to a string matches the end string, joining is stopped. The end string itself is not added to the result string.

When remove is set to true, all variants used will be removed from the list of variants.

Warning

This function only works when the provided variant contains a list of variants.

Parameters

string	a pointer to a amxc_string_t structure, the joined string will be put in this string.
var	The variant containing a linked list of variants
sep	separator string or NULL
end	end string or NULL
remove	when set to true, all used variants are removed from the list.

Returns

0 on success. -1 if an error has occurred

Definition at line 99 of file amxc_string_join.c.

                                            {
    int retval = -1;
    const amxc_llist_t* list = NULL;
    const char* sep = "";
    when_null(string, exit);
    when_null(var, exit);
    when_true(amxc_var_type_of(var) != AMXC_VAR_ID_LIST, exit);
 
    list = amxc_var_constcast(amxc_llist_t, var);
 
    amxc_llist_for_each(it, list) {
        amxc_var_t* part = amxc_var_from_llist_it(it);
 
        amxc_string_appendf(string, "%s", sep);
 
        if(amxc_var_type_of(part) == AMXC_VAR_ID_LIST) {
            amxc_string_append(string, "[", 1);
            amxc_string_csv_join_var(string, part);
            amxc_string_append(string, "]", 1);
        } else if((amxc_var_type_of(part) == AMXC_VAR_ID_CSTRING) ||
                  ( amxc_var_type_of(part) == AMXC_VAR_ID_CSV_STRING) ||
                  ( amxc_var_type_of(part) == AMXC_VAR_ID_SSV_STRING)) {
            const char* txt = amxc_var_constcast(cstring_t, part);
            if((txt != NULL) && (end != NULL) && (strcmp(txt, end) == 0)) {
                if(remove) {
                    amxc_var_delete(&part);
                }
                break;
            }
            amxc_string_appendf(string, "%s", txt);
        } else {
            char* txt = amxc_var_dyncast(cstring_t, part);
            if((txt != NULL) && (end != NULL) && (strcmp(txt, end) == 0)) {
                if(remove) {
                    amxc_var_delete(&part);
                }
                free(txt);
                break;
            }
            amxc_string_appendf(string, "%s", txt);
            free(txt);
        }
        if(remove) {
            amxc_var_delete(&part);
        }
        sep = separator;
    }
 
    retval = 0;
 
exit:
    return retval;
 
}

amxc_string_ssv_join_var()

int amxc_string_ssv_join_var	(	amxc_string_t *	string,
		const amxc_var_t *const	var
	)

Joins a variant containing a list of variants into a single string using ' ' as separator.

This function does the same as amxc_string_join_var and uses '' as the value separator.

Parameters

string	a pointer to a amxc_string_t structure, the joined string will be put in this string.
var	The variant containing a linked list of variants

Returns

0 on success. -1 if an error has occurred

Definition at line 169 of file amxc_string_join.c.

                                                          {
    return amxc_string_join_var(string, var, " ");
}