source: trunk/libtransmission/bencode.h @ 8268

Last change on this file since 8268 was 8268, checked in by charles, 13 years ago

(trunk libT) tweak the bencode comments a bit

  • Property svn:keywords set to Date Rev Author Id
File size: 6.3 KB
Line 
1/*
2 * This file Copyright (C) 2008-2009 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 8268 2009-04-21 16:52:28Z charles $
11 */
12
13#ifndef TR_BENCODE_H
14#define TR_BENCODE_H 1
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
20#include <inttypes.h> /* for int64_t */
21
22struct evbuffer;
23
24/* these are PRIVATE IMPLEMENTATION details that should not be touched.
25 * it's included in the header for inlining and composition */
26enum
27{
28    TR_TYPE_INT  = 1,
29    TR_TYPE_STR  = 2,
30    TR_TYPE_LIST = 4,
31    TR_TYPE_DICT = 8,
32    TR_TYPE_BOOL = 16,
33    TR_TYPE_REAL = 32
34};
35   
36/* these are PRIVATE IMPLEMENTATION details that should not be touched.
37 * it's included in the header for inlining and composition */
38typedef struct tr_benc
39{
40    char type;
41
42    union
43    {
44        uint8_t b; /* bool type */
45
46        double d;  /* double type */
47
48        int64_t i; /* int type */
49
50        struct /* string type */
51        {
52            size_t i; /* the string length */
53            char * s; /* the string */
54        } s;
55
56        struct /* list & dict types */
57        {
58            size_t alloc; /* nodes allocated */
59            size_t count; /* nodes used */
60            struct tr_benc * vals; /* nodes */
61        } l;
62    } val;
63} tr_benc;
64
65/***
66****
67***/
68
69int       tr_bencParse( const void     * buf,
70                        const void     * bufend,
71                        tr_benc        * setme_benc,
72                        const uint8_t ** setme_end );
73
74int       tr_bencLoad( const void   * buf,
75                       size_t         buflen,
76                       tr_benc      * setme_benc,
77                       char        ** setme_end );
78
79int       tr_bencLoadFile( const char * filename, tr_benc * setme );
80
81int       tr_bencLoadJSONFile( const char * filename, tr_benc * setme );
82
83void      tr_bencFree( tr_benc * );
84
85char*     tr_bencSave( const tr_benc * val, int * len );
86
87char*     tr_bencSaveAsJSON( const tr_benc * top, struct evbuffer * out );
88
89char*     tr_bencToJSON( const tr_benc * top );
90
91int       tr_bencSaveFile( const char * filename, const tr_benc * );
92
93int       tr_bencSaveJSONFile( const char * filename, const tr_benc * );
94
95void      tr_bencInitStr( tr_benc *, const void * str, int str_len );
96
97void      tr_bencInitRaw( tr_benc *, const void * raw, size_t raw_len );
98
99void      tr_bencInitInt( tr_benc *, int64_t num );
100
101int       tr_bencInitDict( tr_benc *, size_t reserveCount );
102
103int       tr_bencInitList( tr_benc *, size_t reserveCount );
104
105void      tr_bencInitBool( tr_benc *, int value );
106
107void      tr_bencInitReal( tr_benc *, double value );
108
109/***
110****
111***/
112
113int       tr_bencListReserve( tr_benc *, size_t reserveCount );
114
115tr_benc * tr_bencListAdd( tr_benc * );
116
117tr_benc * tr_bencListAddInt( tr_benc *, int64_t val );
118
119tr_benc * tr_bencListAddStr( tr_benc *, const char * val );
120
121tr_benc * tr_bencListAddList( tr_benc *, size_t reserveCount );
122
123tr_benc * tr_bencListAddDict( tr_benc *, size_t reserveCount );
124
125size_t    tr_bencListSize( const tr_benc * list );
126
127tr_benc * tr_bencListChild( tr_benc * list, size_t n );
128
129/***
130****
131***/
132
133int       tr_bencDictReserve( tr_benc *, size_t reserveCount );
134
135int       tr_bencDictRemove( tr_benc *, const char * key );
136
137tr_benc * tr_bencDictAdd( tr_benc *, const char * key );
138
139tr_benc * tr_bencDictAddReal( tr_benc *, const char * key, double );
140
141tr_benc * tr_bencDictAddInt( tr_benc *, const char * key, int64_t );
142
143tr_benc * tr_bencDictAddBool( tr_benc *, const char * key, tr_bool );
144
145tr_benc * tr_bencDictAddStr( tr_benc *, const char * key, const char * );
146
147tr_benc * tr_bencDictAddList( tr_benc *, const char * key, size_t reserve );
148
149tr_benc * tr_bencDictAddDict( tr_benc *, const char * key, size_t reserve );
150
151tr_benc * tr_bencDictAddRaw( tr_benc *, const char * key,
152                             const void * raw, size_t rawlen );
153
154tr_benc*  tr_bencDictFind( tr_benc *, const char * key );
155
156tr_bool   tr_bencDictFindList( tr_benc *, const char * key, tr_benc ** setme );
157
158tr_bool   tr_bencDictFindDict( tr_benc *, const char * key, tr_benc ** setme );
159
160tr_bool   tr_bencDictFindInt( tr_benc *, const char * key, int64_t * setme );
161
162tr_bool   tr_bencDictFindReal( tr_benc *, const char * key, double * setme );
163
164tr_bool   tr_bencDictFindBool( tr_benc *, const char * key, tr_bool * setme );
165
166tr_bool   tr_bencDictFindStr( tr_benc *, const char * key, const char ** setme );
167
168tr_bool   tr_bencDictFindRaw( tr_benc *, const char * key,
169                              const uint8_t ** setme_raw, size_t * setme_len );
170
171/***
172****
173***/
174
175tr_bool   tr_bencGetInt( const tr_benc * val, int64_t * setme );
176tr_bool   tr_bencGetStr( const tr_benc * val, const char ** setme );
177tr_bool   tr_bencGetBool( const tr_benc * val, tr_bool * setme );
178tr_bool   tr_bencGetReal( const tr_benc * val, double * setme );
179
180static TR_INLINE tr_bool tr_bencIsType  ( const tr_benc * b, int type ) { return ( b != NULL ) && ( b->type == type ); }
181static TR_INLINE tr_bool tr_bencIsInt   ( const tr_benc * b ) { return tr_bencIsType( b, TR_TYPE_INT ); }
182static TR_INLINE tr_bool tr_bencIsDict  ( const tr_benc * b ) { return tr_bencIsType( b, TR_TYPE_DICT ); }
183static TR_INLINE tr_bool tr_bencIsList  ( const tr_benc * b ) { return tr_bencIsType( b, TR_TYPE_LIST ); }
184static TR_INLINE tr_bool tr_bencIsString( const tr_benc * b ) { return tr_bencIsType( b, TR_TYPE_STR ); }
185static TR_INLINE tr_bool tr_bencIsBool  ( const tr_benc * b ) { return tr_bencIsType( b, TR_TYPE_BOOL ); }
186static TR_INLINE tr_bool tr_bencIsReal  ( const tr_benc * b ) { return tr_bencIsType( b, TR_TYPE_REAL ); }
187
188/**
189***  Treat these as private -- they're only made public here
190***  so that the unit tests can find them
191**/
192
193int tr_bencParseInt( const uint8_t *  buf,
194                     const uint8_t *  bufend,
195                     const uint8_t ** setme_end,
196                     int64_t *        setme_val );
197
198int tr_bencParseStr( const uint8_t *  buf,
199                     const uint8_t *  bufend,
200                     const uint8_t ** setme_end,
201                     const uint8_t ** setme_str,
202                     size_t *         setme_strlen );
203
204/**
205***
206**/
207
208void  tr_bencMergeDicts( tr_benc * target, const tr_benc * source );
209
210#ifdef __cplusplus
211}
212#endif
213
214#endif
Note: See TracBrowser for help on using the repository browser.