base

SDK/version_3/libs/neon-0.29.5/doc/man/ne_token.3

@@ -0,0 +1,80 @@
+'\" t
+.\"     Title: ne_token
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 14 October 2010
+.\"    Manual: neon API reference
+.\"    Source: neon 0.29.5
+.\"  Language: English
+.\"
+.TH "NE_TOKEN" "3" "14 October 2010" "neon 0.29.5" "neon API reference"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+ne_token, ne_qtoken \- string tokenizers
+.SH "SYNOPSIS"
+.sp
+.ft B
+.nf
+#include <ne_string\&.h>
+.fi
+.ft
+.HP \w'char\ *ne_token('u
+.BI "char *ne_token(char\ **" "str" ", char\ " "sep" ");"
+.HP \w'char\ *ne_qtoken('u
+.BI "char *ne_qtoken(char\ **" "str" ", char\ " "sep" ", const\ char\ *" "quotes" ");"
+.SH "DESCRIPTION"
+.PP
+\fBne_token\fR
+and
+\fBne_qtoken\fR
+tokenize the string at the location stored in the pointer
+\fIstr\fR\&. Each time the function is called, it returns the next token, and modifies the
+\fIstr\fR
+pointer to point to the remainer of the string, or
+NULL
+if there are no more tokens in the string\&. A token is delimited by the separator character
+\fIsep\fR; if
+\fBne_qtoken\fR
+is used any quoted segments of the string are skipped when searching for a separator\&. A quoted segment is enclosed in a pair of one of the characters given in the
+\fIquotes\fR
+string\&.
+.PP
+The string being tokenized is modified each time the tokenizing function is called; replacing the next separator character with a
+NUL
+terminator\&.
+.SH "EXAMPLES"
+.PP
+The following function prints out each token in a comma\-separated string
+\fIlist\fR, which is modified in\-place:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+static void splitter(char *list)
+{
+  do {
+    printf("Token: %s\en", ne_token(&list, \',\'));
+  while (list);
+}
+.fi
+.if n \{\
+.RE
+.\}
+.SH "AUTHOR"
+.PP
+\fBJoe Orton\fR <\&neon@lists.manyfish.co.uk\&>
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br