summaryrefslogtreecommitdiffstats
path: root/utils/storage/tag_utility.h
blob: 0b7ed7ae93f2c9483d832c6d3d4dcac2f642cd8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/* 
 *  libpinyin
 *  Library to deal with pinyin.
 *  
 *  Copyright (C) 2010 Peng Wu
 *  
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef TAG_UTILITY_H
#define TAG_UTILITY_H

/* Note: the optional tag has been removed from the first implementation.
 * Maybe the optional tag will be added back later.
 */

bool taglib_init();

/* Note: most string array (const char *) are null pointer terminated. */
bool taglib_add_tag(int line_type, const char * line_tag, int num_of_values, const char * required_tags[], const char * ignored_tags[]);

/* most parameters are hash table of string (const char *).
 * "..." special token handling is also omitted from the first implementation.
 */
bool taglib_read(const char * input_line, int & line_type, GPtrArray * values, GHashTable * required);

/* Note: taglib_write is omited, as printf is more suitable for this. */

/* Note the following function is only available when the optional tag exists.
 * bool taglib_report_status(int line_type);
 */

/* remove the tag of type line_type. */
bool taglib_remove_tag(int line_type);

/* the following functions are used to save current known tag list in stack.
 * Used when the parsing context is changed.
 */
bool taglib_push_state();
bool taglib_pop_state();

bool taglib_fini();

/* Useful macros to ease taglib_add_tag call,
 * or else need to use C++0x-features.
 */

#define TAGLIB_BEGIN_ADD_TAG(line_type, line_tag, num_of_values)        \
    {                                                                   \
        int line_type_saved = line_type;                          \
        const char * line_tag_saved = line_tag;                         \
        int num_of_values_saved = num_of_values;                  \
        ;

#define TAGLIB_REQUIRED_TAGS const char * required_tags_saved[]
/* #define TAGLIB_OPTIONAL_TAGS const char * optional_tags_saved[] */
#define TAGLIB_IGNORED_TAGS const char * ignored_tags_saved[]

#define TAGLIB_END_ADD_TAG                                              \
    assert(taglib_add_tag(line_type_saved, line_tag_saved,              \
                          num_of_values_saved,                          \
                          required_tags_saved, ignored_tags_saved));    \
    };

#endif