1 | /* MiniUPnP project |
---|
2 | * http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/ |
---|
3 | * |
---|
4 | * Copyright (c) 2006-2008, Thomas Bernard |
---|
5 | * All rights reserved. |
---|
6 | * |
---|
7 | * Redistribution and use in source and binary forms, with or without |
---|
8 | * modification, are permitted provided that the following conditions are met: |
---|
9 | * * Redistributions of source code must retain the above copyright |
---|
10 | * notice, this list of conditions and the following disclaimer. |
---|
11 | * * Redistributions in binary form must reproduce the above copyright |
---|
12 | * notice, this list of conditions and the following disclaimer in the |
---|
13 | * documentation and/or other materials provided with the distribution. |
---|
14 | * * The name of the author may not be used to endorse or promote products |
---|
15 | * derived from this software without specific prior written permission. |
---|
16 | * |
---|
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
18 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
20 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
---|
21 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
22 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
23 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
24 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
25 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
26 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
27 | * POSSIBILITY OF SUCH DAMAGE. |
---|
28 | */ |
---|
29 | #ifndef __UPNPDESCGEN_H__ |
---|
30 | #define __UPNPDESCGEN_H__ |
---|
31 | |
---|
32 | #include "config.h" |
---|
33 | |
---|
34 | /* for the root description |
---|
35 | * The child list reference is stored in "data" member using the |
---|
36 | * INITHELPER macro with index/nchild always in the |
---|
37 | * same order, whatever the endianness */ |
---|
38 | struct XMLElt { |
---|
39 | const char * eltname; /* begin with '/' if no child */ |
---|
40 | const char * data; /* Value */ |
---|
41 | }; |
---|
42 | |
---|
43 | /* for service description */ |
---|
44 | struct serviceDesc { |
---|
45 | const struct action * actionList; |
---|
46 | const struct stateVar * serviceStateTable; |
---|
47 | }; |
---|
48 | |
---|
49 | struct action { |
---|
50 | const char * name; |
---|
51 | const struct argument * args; |
---|
52 | }; |
---|
53 | |
---|
54 | struct argument { |
---|
55 | const char * name; /* the name of the argument */ |
---|
56 | unsigned char dir; /* 1 = in, 2 = out */ |
---|
57 | unsigned char relatedVar; /* index of the related variable */ |
---|
58 | }; |
---|
59 | |
---|
60 | struct stateVar { |
---|
61 | const char * name; |
---|
62 | unsigned char itype; /* MSB: sendEvent flag, 7 LSB: index in upnptypes */ |
---|
63 | unsigned char idefault; /* default value */ |
---|
64 | unsigned char iallowedlist; /* index in allowed values list */ |
---|
65 | unsigned char ieventvalue; /* fixed value returned or magical values */ |
---|
66 | }; |
---|
67 | |
---|
68 | /* little endian |
---|
69 | * The code has now be tested on big endian architecture */ |
---|
70 | #define INITHELPER(i, n) ((char *)((n<<16)|i)) |
---|
71 | |
---|
72 | /* char * genRootDesc(int *); |
---|
73 | * returns: NULL on error, string allocated on the heap */ |
---|
74 | char * |
---|
75 | genRootDesc(int * len); |
---|
76 | |
---|
77 | /* for the two following functions */ |
---|
78 | char * |
---|
79 | genContentDirectory(int * len); |
---|
80 | |
---|
81 | char * |
---|
82 | genConnectionManager(int * len); |
---|
83 | |
---|
84 | char * |
---|
85 | genX_MS_MediaReceiverRegistrar(int * len); |
---|
86 | |
---|
87 | char * |
---|
88 | getVarsContentDirectory(int * len); |
---|
89 | |
---|
90 | char * |
---|
91 | getVarsConnectionManager(int * len); |
---|
92 | |
---|
93 | char * |
---|
94 | getVarsX_MS_MediaReceiverRegistrar(int * len); |
---|
95 | |
---|
96 | #endif |
---|
97 | |
---|