}
/**
- * Split string and return pointers to its parts.
+ * Split a string and return pointers to its parts.
*
* \param args The string to be split.
* \param argv_ptr Pointer to the list of substrings.
* \param delim Delimiter.
*
* This function modifies \a args by replacing each occurance of \a delim by
- * zero. A \p NULL-terminated array of pointers to char* is allocated dynamically
+ * zero. A \p NULL terminated array of pointers to char* is allocated dynamically
* and these pointers are initialized to point to the broken-up substrings
* within \a args. A pointer to this array is returned via \a argv_ptr.
*
return n;
}
-enum line_state_flags {LSF_HAVE_WORD = 1, LSF_BACKSLASH = 2, LSF_QUOTE = 4};
static int get_next_word(const char *line, char **word)
{
+ enum line_state_flags {LSF_HAVE_WORD = 1, LSF_BACKSLASH = 2,
+ LSF_QUOTE = 4};
const char *in;
char *out;
int ret, state = 0;
return ret;
}
+/**
+ * Free an array of words created by create_argv().
+ *
+ * \param argv A pointer previously obtained by \ref create_argv().
+ */
void free_argv(char **argv)
{
int i;
}
/**
+ * Split a line into words which are separated by whitespace.
+ *
+ * In contrast to gengetopt's string parser, double quotes, backslash-escaped
+ * characters and special characters like \p \\n are honored. The result
+ * contains pointers to copies of the words contained in \a line and has to be
+ * freed by using \ref free_argv().
+ *
+ * \param line The line to be split.
+ * \param result The array of words is returned here.
+ *
* \return Number of words in \a line, negative on errors.
*/
int create_argv(const char *line, char ***result)