src/framework/*: improve the doxygen documentation (work in progress). This also...
[melted] / src / framework / mlt_tokeniser.h
1 /**
2 * \file mlt_tokeniser.h
3 * \brief string tokeniser
4 *
5 * Copyright (C) 2002-2003 Ushodaya Enterprises Limited
6 * \author Charles Yates <charles.yates@pandora.be>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 #ifndef _MLT_TOKENISER_H_
24 #define _MLT_TOKENISER_H_
25
26 /** \brief Tokeniser class
27 *
28 */
29
30 typedef struct
31 {
32 char *input;
33 char **tokens;
34 int count;
35 int size;
36 }
37 *mlt_tokeniser, mlt_tokeniser_t;
38
39 /* Remote parser API.
40 */
41
42 extern mlt_tokeniser mlt_tokeniser_init( );
43 extern int mlt_tokeniser_parse_new( mlt_tokeniser self, char *text, char *delimiter );
44 extern char *mlt_tokeniser_get_input( mlt_tokeniser self );
45 extern int mlt_tokeniser_count( mlt_tokeniser self );
46 extern char *mlt_tokeniser_get_string( mlt_tokeniser self, int index );
47 extern void mlt_tokeniser_close( mlt_tokeniser self );
48
49 #endif