source: trunk/libtransmission/bencode.h @ 7590

Last change on this file since 7590 was 7590, checked in by charles, 12 years ago

(trunk libT) inline the tr_bencIs*() utility functions

  • Property svn:keywords set to Date Rev Author Id
File size: 5.2 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@transmissionbt.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: bencode.h 7590 2009-01-03 00:11:31Z charles $
11 */
12
13#ifndef TR_BENCODE_H
14#define TR_BENCODE_H 1
15
16#include <inttypes.h> /* for int64_t */
17
18struct evbuffer;
19
20enum
21{
22    TYPE_INT  = 1,
23    TYPE_STR  = 2,
24    TYPE_LIST = 4,
25    TYPE_DICT = 8
26};
27
28typedef struct tr_benc
29{
30    char    type;
31    union
32    {
33        int64_t i;
34        struct
35        {
36            size_t i;
37            char * s;
38        } s;
39        struct
40        {
41            size_t alloc;
42            size_t count;
43            struct tr_benc * vals;
44        } l;
45    } val;
46} tr_benc;
47
48/***
49****
50***/
51
52int       tr_bencParse( const void *     buf,
53                        const void *     bufend,
54                        tr_benc *        setme_benc,
55                        const uint8_t ** setme_end );
56
57int       tr_bencLoad( const void * buf,
58                       size_t       buflen,
59                       tr_benc *    setme_benc,
60                       char **      setme_end );
61
62int       tr_bencLoadFile( const char * filename,
63                                        tr_benc * );
64
65int       tr_bencLoadJSONFile( const char * filename,
66                                            tr_benc * );
67
68#if 0
69void      tr_bencPrint( const tr_benc * );
70
71#endif
72
73void      tr_bencFree( tr_benc * );
74
75char*     tr_bencSave( const tr_benc * val, int * len );
76
77char*     tr_bencSaveAsJSON( const tr_benc * top, struct evbuffer * out );
78
79int       tr_bencSaveFile( const char * filename, const tr_benc * );
80
81int       tr_bencSaveJSONFile( const char * filename, const tr_benc * );
82
83void      tr_bencInitStr( tr_benc *, const void * str, int str_len );
84
85void      tr_bencInitRaw( tr_benc *, const void * raw, size_t raw_len );
86
87void      tr_bencInitInt( tr_benc *, int64_t num );
88
89int       tr_bencInitDict( tr_benc *, size_t reserveCount );
90
91int       tr_bencInitList( tr_benc *, size_t reserveCount );
92
93/***
94****
95***/
96
97int       tr_bencListReserve( tr_benc *, size_t reserveCount );
98
99tr_benc * tr_bencListAdd( tr_benc * );
100
101tr_benc * tr_bencListAddInt( tr_benc *, int64_t val );
102
103tr_benc * tr_bencListAddStr( tr_benc *, const char * val );
104
105tr_benc * tr_bencListAddList( tr_benc *, size_t reserveCount );
106
107tr_benc * tr_bencListAddDict( tr_benc *, size_t reserveCount );
108
109size_t    tr_bencListSize( const tr_benc * list );
110
111tr_benc * tr_bencListChild( tr_benc * list, size_t n );
112
113/***
114****
115***/
116
117int       tr_bencDictReserve( tr_benc *, size_t reserveCount );
118
119int       tr_bencDictRemove( tr_benc *, const char * key );
120
121tr_benc * tr_bencDictAdd( tr_benc *, const char * key );
122
123tr_benc * tr_bencDictAddDouble( tr_benc *, const char * key, double );
124
125tr_benc * tr_bencDictAddInt( tr_benc *, const char * key, int64_t );
126
127tr_benc * tr_bencDictAddStr( tr_benc *, const char * key, const char * );
128
129tr_benc * tr_bencDictAddList( tr_benc *, const char * key, size_t reserve );
130
131tr_benc * tr_bencDictAddDict( tr_benc *, const char * key, size_t reserve );
132
133tr_benc * tr_bencDictAddRaw( tr_benc *, const char * key,
134                             const void * raw, size_t rawlen );
135
136tr_benc*  tr_bencDictFind( tr_benc *, const char * key );
137
138tr_bool   tr_bencDictFindList( tr_benc *, const char * key, tr_benc ** setme );
139
140tr_bool   tr_bencDictFindDict( tr_benc *, const char * key, tr_benc ** setme );
141
142tr_bool   tr_bencDictFindInt( tr_benc *, const char * key, int64_t * setme );
143
144tr_bool   tr_bencDictFindDouble( tr_benc *, const char * key, double * setme );
145
146tr_bool   tr_bencDictFindStr( tr_benc *, const char * key, const char ** setme );
147
148tr_bool   tr_bencDictFindRaw( tr_benc *, const char * key,
149                              const uint8_t ** setme_raw, size_t * setme_len );
150
151/***
152****
153***/
154
155tr_bool   tr_bencGetInt( const tr_benc * val, int64_t * setme );
156
157tr_bool   tr_bencGetStr( const tr_benc * val, const char ** setme );
158
159static inline tr_bool tr_bencIsType  ( const tr_benc * b, int type ) { return ( b != NULL ) && ( b->type == type ); }
160static inline tr_bool tr_bencIsInt   ( const tr_benc * b ) { return tr_bencIsType( b, TYPE_INT ); }
161static inline tr_bool tr_bencIsDict  ( const tr_benc * b ) { return tr_bencIsType( b, TYPE_DICT ); }
162static inline tr_bool tr_bencIsList  ( const tr_benc * b ) { return tr_bencIsType( b, TYPE_LIST ); }
163static inline tr_bool tr_bencIsString( const tr_benc * b ) { return tr_bencIsType( b, TYPE_STR ); }
164
165/**
166***  Treat these as private -- they're only made public here
167***  so that the unit tests can find them
168**/
169
170int tr_bencParseInt( const uint8_t *  buf,
171                     const uint8_t *  bufend,
172                     const uint8_t ** setme_end,
173                     int64_t *        setme_val );
174
175int tr_bencParseStr( const uint8_t *  buf,
176                     const uint8_t *  bufend,
177                     const uint8_t ** setme_end,
178                     const uint8_t ** setme_str,
179                     size_t *         setme_strlen );
180
181/**
182***
183**/
184
185void  tr_bencMergeDicts( tr_benc * target, const tr_benc * source );
186
187#endif
Note: See TracBrowser for help on using the repository browser.