AutoGen - The Automated Program Generator: 7.5.32.1 ao_string_tokenize

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

#### 7.5.32.1 ao_string_tokenize

tokenize an input string

Usage:

    token_list_t* res = ao_string_tokenize( string );

Where the arguments are:

| Name | Type | Description
| —– | —– | ————-
| string | `char const*` | string to be tokenized
| returns | token_list_t* | pointer to a structure that lists each token

This function will convert one input string into a list of strings. The list of strings is derived by separating the input based on white space separation. However, if the input contains either single or double quote characters, then the text after that character up to a matching quote will become the string in the list.

The returned pointer should be deallocated with `free(3C)` when are done using the data. The data are placed in a single block of allocated memory. Do not deallocate individual token/strings.

The structure pointed to will contain at least these two fields:

‘`tkn_ct`’

  The number of tokens found in the input string.

‘`tok_list`’

  An array of `tkn_ct + 1` pointers to substring tokens, with the last pointer set to NULL.

There are two types of quoted strings: single quoted (`'`) and double quoted (`"`). Singly quoted strings are fairly raw in that escape characters (`\\`) are simply another character, except when preceding the following characters:

    \\  double backslashes reduce to one
    '   incorporates the single quote into the string
    \n  suppresses both the backslash and newline character

Double quote strings are formed according to the rules of string constants in ANSI-C programs.

NULL is returned and `errno` will be set to indicate the problem:

- `EINVAL` - There was an unterminated quoted string.
- `ENOENT` - The input string was empty.
- `ENOMEM` - There is not enough memory.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

This document was generated by Bruce Korb on May, 24 2008 using texi2html 1.78.