subfield.h
Go to the documentation of this file.
1 /*
2  * libasterix
3  * Copyright [2013-2020] SinoATC <http://www.sinoatc.com>.
4  * All Rights Reserved.
5  *
6  * NOTICE: All information contained herein is, and remains
7  * the property of SinoATC and its suppliers, if any.
8  * The intellectual and technical concepts contained herein
9  * are proprietary to Aerosys Corporation and its suppliers and may be
10  * covered by U.S. and Foreign Patents, patents in process,
11  * and are protected by trade secret or copyright law.
12  * Dissemination of this information or reproduction of this material
13  * is strictly forbidden unless prior written permission is obtained
14  * from SinoATC.
15  */
16 
23 #ifndef LIBASTERIX_SUBFIELD_H
24 #define LIBASTERIX_SUBFIELD_H
25 
26 #include "fspec.h"
27 #include "dataitem.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
46 #define AST_MAP_SUBFIELD_TYPE_EX(category_name, category_value, dataitem, subfield) \
47  I ## category_name ## _ ## dataitem ## _ ## S ## subfield = category_value ## dataitem ## 0 ## subfield,
48 
52 typedef enum _ast_subfield_type_t
53 {
54  INULLFIELD = 0,
55 
56  //For CAT001~CAT009
57 #define AST_MAP_SUBFIELD_TYPE(category, dataitem, subfield) AST_MAP_SUBFIELD_TYPE_EX(00 ## category, category, dataitem, subfield)
58 
59  //Dataitem I004/100
60  AST_MAP_SUBFIELD_TYPE(4, 100, 01)
61  AST_MAP_SUBFIELD_TYPE(4, 100, 02)
62  AST_MAP_SUBFIELD_TYPE(4, 100, 03)
63  AST_MAP_SUBFIELD_TYPE(4, 100, 04)
64  AST_MAP_SUBFIELD_TYPE(4, 100, 05)
65  AST_MAP_SUBFIELD_TYPE(4, 100, 06)
66 
67  //Dataitem I004/120
68  AST_MAP_SUBFIELD_TYPE(4, 120, 01)
69  AST_MAP_SUBFIELD_TYPE(4, 120, 02)
70  AST_MAP_SUBFIELD_TYPE(4, 120, 03)
71  AST_MAP_SUBFIELD_TYPE(4, 120, 04)
72 
73  //Dataitem I004/170
74  AST_MAP_SUBFIELD_TYPE(4, 170, 01)
75  AST_MAP_SUBFIELD_TYPE(4, 170, 02)
76  AST_MAP_SUBFIELD_TYPE(4, 170, 03)
77  AST_MAP_SUBFIELD_TYPE(4, 170, 04)
78  AST_MAP_SUBFIELD_TYPE(4, 170, 05)
79  AST_MAP_SUBFIELD_TYPE(4, 170, 06)
80  AST_MAP_SUBFIELD_TYPE(4, 170, 07)
81  AST_MAP_SUBFIELD_TYPE(4, 170, 08)
82  AST_MAP_SUBFIELD_TYPE(4, 170, 09)
83  AST_MAP_SUBFIELD_TYPE(4, 170, 10)
84 
85  //Dataitem I004/171
86  AST_MAP_SUBFIELD_TYPE(4, 171, 01)
87  AST_MAP_SUBFIELD_TYPE(4, 171, 02)
88  AST_MAP_SUBFIELD_TYPE(4, 171, 03)
89  AST_MAP_SUBFIELD_TYPE(4, 171, 04)
90  AST_MAP_SUBFIELD_TYPE(4, 171, 05)
91  AST_MAP_SUBFIELD_TYPE(4, 171, 06)
92  AST_MAP_SUBFIELD_TYPE(4, 171, 07)
93  AST_MAP_SUBFIELD_TYPE(4, 171, 08)
94  AST_MAP_SUBFIELD_TYPE(4, 171, 09)
95  AST_MAP_SUBFIELD_TYPE(4, 171, 10)
96 
97  //For CAT010~CAT099
98 #undef AST_MAP_SUBFIELD_TYPE
99 #define AST_MAP_SUBFIELD_TYPE(category, dataitem, subfield) AST_MAP_SUBFIELD_TYPE_EX(0 ## category, category, dataitem, subfield)
100 
101  //Dataitem I021/110
102  AST_MAP_SUBFIELD_TYPE(21, 110, 01)
103  AST_MAP_SUBFIELD_TYPE(21, 110, 02)
104 
105  //Dataitem I021/220
106  AST_MAP_SUBFIELD_TYPE(21, 220, 01)
107  AST_MAP_SUBFIELD_TYPE(21, 220, 02)
108  AST_MAP_SUBFIELD_TYPE(21, 220, 03)
109  AST_MAP_SUBFIELD_TYPE(21, 220, 04)
110 
111  //Dataitem I021/295
112  AST_MAP_SUBFIELD_TYPE(21, 295, 01)
113  AST_MAP_SUBFIELD_TYPE(21, 295, 02)
114  AST_MAP_SUBFIELD_TYPE(21, 295, 03)
115  AST_MAP_SUBFIELD_TYPE(21, 295, 04)
116  AST_MAP_SUBFIELD_TYPE(21, 295, 05)
117  AST_MAP_SUBFIELD_TYPE(21, 295, 06)
118  AST_MAP_SUBFIELD_TYPE(21, 295, 07)
119  AST_MAP_SUBFIELD_TYPE(21, 295, 08)
120  AST_MAP_SUBFIELD_TYPE(21, 295, 09)
121  AST_MAP_SUBFIELD_TYPE(21, 295, 10)
122  AST_MAP_SUBFIELD_TYPE(21, 295, 11)
123  AST_MAP_SUBFIELD_TYPE(21, 295, 12)
124  AST_MAP_SUBFIELD_TYPE(21, 295, 13)
125  AST_MAP_SUBFIELD_TYPE(21, 295, 14)
126  AST_MAP_SUBFIELD_TYPE(21, 295, 15)
127  AST_MAP_SUBFIELD_TYPE(21, 295, 16)
128  AST_MAP_SUBFIELD_TYPE(21, 295, 17)
129  AST_MAP_SUBFIELD_TYPE(21, 295, 18)
130  AST_MAP_SUBFIELD_TYPE(21, 295, 19)
131  AST_MAP_SUBFIELD_TYPE(21, 295, 20)
132  AST_MAP_SUBFIELD_TYPE(21, 295, 21)
133  AST_MAP_SUBFIELD_TYPE(21, 295, 22)
134  AST_MAP_SUBFIELD_TYPE(21, 295, 23)
135 
136  //Dataitem I034/050
137  AST_MAP_SUBFIELD_TYPE(34, 050, 01)
138  AST_MAP_SUBFIELD_TYPE(34, 050, 02)
139  AST_MAP_SUBFIELD_TYPE(34, 050, 03)
140  AST_MAP_SUBFIELD_TYPE(34, 050, 04)
141  AST_MAP_SUBFIELD_TYPE(34, 050, 05)
142  AST_MAP_SUBFIELD_TYPE(34, 050, 06)
143  AST_MAP_SUBFIELD_TYPE(34, 050, 07)
144 
145  //Dataitem I034/060
146  AST_MAP_SUBFIELD_TYPE(34, 060, 01)
147  AST_MAP_SUBFIELD_TYPE(34, 060, 02)
148  AST_MAP_SUBFIELD_TYPE(34, 060, 03)
149  AST_MAP_SUBFIELD_TYPE(34, 060, 04)
150  AST_MAP_SUBFIELD_TYPE(34, 060, 05)
151  AST_MAP_SUBFIELD_TYPE(34, 060, 06)
152  AST_MAP_SUBFIELD_TYPE(34, 060, 07)
153 
154  //Dataitem I048/120
155  AST_MAP_SUBFIELD_TYPE(48, 120, 01)
156  AST_MAP_SUBFIELD_TYPE(48, 120, 02)
157 
158  //Dataitem I048/130
159  AST_MAP_SUBFIELD_TYPE(48, 130, 01)
160  AST_MAP_SUBFIELD_TYPE(48, 130, 02)
161  AST_MAP_SUBFIELD_TYPE(48, 130, 03)
162  AST_MAP_SUBFIELD_TYPE(48, 130, 04)
163  AST_MAP_SUBFIELD_TYPE(48, 130, 05)
164  AST_MAP_SUBFIELD_TYPE(48, 130, 06)
165  AST_MAP_SUBFIELD_TYPE(48, 130, 07)
166 
167  //Dataitem I062/110
168  AST_MAP_SUBFIELD_TYPE(62, 110, 01)
169  AST_MAP_SUBFIELD_TYPE(62, 110, 02)
170  AST_MAP_SUBFIELD_TYPE(62, 110, 03)
171  AST_MAP_SUBFIELD_TYPE(62, 110, 04)
172  AST_MAP_SUBFIELD_TYPE(62, 110, 05)
173  AST_MAP_SUBFIELD_TYPE(62, 110, 06)
174  AST_MAP_SUBFIELD_TYPE(62, 110, 07)
175 
176  //Dataitem I062/290
177  AST_MAP_SUBFIELD_TYPE(62, 290, 01)
178  AST_MAP_SUBFIELD_TYPE(62, 290, 02)
179  AST_MAP_SUBFIELD_TYPE(62, 290, 03)
180  AST_MAP_SUBFIELD_TYPE(62, 290, 04)
181  AST_MAP_SUBFIELD_TYPE(62, 290, 05)
182  AST_MAP_SUBFIELD_TYPE(62, 290, 06)
183  AST_MAP_SUBFIELD_TYPE(62, 290, 07)
184  AST_MAP_SUBFIELD_TYPE(62, 290, 08)
185  AST_MAP_SUBFIELD_TYPE(62, 290, 09)
186  AST_MAP_SUBFIELD_TYPE(62, 290, 10)
187 
188  //Dataitem I062/295
189  AST_MAP_SUBFIELD_TYPE(62, 295, 01)
190  AST_MAP_SUBFIELD_TYPE(62, 295, 02)
191  AST_MAP_SUBFIELD_TYPE(62, 295, 03)
192  AST_MAP_SUBFIELD_TYPE(62, 295, 04)
193  AST_MAP_SUBFIELD_TYPE(62, 295, 05)
194  AST_MAP_SUBFIELD_TYPE(62, 295, 06)
195  AST_MAP_SUBFIELD_TYPE(62, 295, 07)
196  AST_MAP_SUBFIELD_TYPE(62, 295, 08)
197  AST_MAP_SUBFIELD_TYPE(62, 295, 09)
198  AST_MAP_SUBFIELD_TYPE(62, 295, 10)
199  AST_MAP_SUBFIELD_TYPE(62, 295, 11)
200  AST_MAP_SUBFIELD_TYPE(62, 295, 12)
201  AST_MAP_SUBFIELD_TYPE(62, 295, 13)
202  AST_MAP_SUBFIELD_TYPE(62, 295, 14)
203  AST_MAP_SUBFIELD_TYPE(62, 295, 15)
204  AST_MAP_SUBFIELD_TYPE(62, 295, 16)
205  AST_MAP_SUBFIELD_TYPE(62, 295, 17)
206  AST_MAP_SUBFIELD_TYPE(62, 295, 18)
207  AST_MAP_SUBFIELD_TYPE(62, 295, 19)
208  AST_MAP_SUBFIELD_TYPE(62, 295, 20)
209  AST_MAP_SUBFIELD_TYPE(62, 295, 21)
210  AST_MAP_SUBFIELD_TYPE(62, 295, 22)
211  AST_MAP_SUBFIELD_TYPE(62, 295, 23)
212  AST_MAP_SUBFIELD_TYPE(62, 295, 24)
213  AST_MAP_SUBFIELD_TYPE(62, 295, 25)
214  AST_MAP_SUBFIELD_TYPE(62, 295, 26)
215  AST_MAP_SUBFIELD_TYPE(62, 295, 27)
216  AST_MAP_SUBFIELD_TYPE(62, 295, 28)
217  AST_MAP_SUBFIELD_TYPE(62, 295, 29)
218  AST_MAP_SUBFIELD_TYPE(62, 295, 30)
219  AST_MAP_SUBFIELD_TYPE(62, 295, 31)
220 
221  //Dataitem I062/340
222  AST_MAP_SUBFIELD_TYPE(62, 340, 01)
223  AST_MAP_SUBFIELD_TYPE(62, 340, 02)
224  AST_MAP_SUBFIELD_TYPE(62, 340, 03)
225  AST_MAP_SUBFIELD_TYPE(62, 340, 04)
226  AST_MAP_SUBFIELD_TYPE(62, 340, 05)
227  AST_MAP_SUBFIELD_TYPE(62, 340, 06)
228 
229  //Dataitem I062/380
230  AST_MAP_SUBFIELD_TYPE(62, 380, 01)
231  AST_MAP_SUBFIELD_TYPE(62, 380, 02)
232  AST_MAP_SUBFIELD_TYPE(62, 380, 03)
233  AST_MAP_SUBFIELD_TYPE(62, 380, 04)
234  AST_MAP_SUBFIELD_TYPE(62, 380, 05)
235  AST_MAP_SUBFIELD_TYPE(62, 380, 06)
236  AST_MAP_SUBFIELD_TYPE(62, 380, 07)
237  AST_MAP_SUBFIELD_TYPE(62, 380, 08)
238  AST_MAP_SUBFIELD_TYPE(62, 380, 09)
239  AST_MAP_SUBFIELD_TYPE(62, 380, 10)
240  AST_MAP_SUBFIELD_TYPE(62, 380, 11)
241  AST_MAP_SUBFIELD_TYPE(62, 380, 12)
242  AST_MAP_SUBFIELD_TYPE(62, 380, 13)
243  AST_MAP_SUBFIELD_TYPE(62, 380, 14)
244  AST_MAP_SUBFIELD_TYPE(62, 380, 15)
245  AST_MAP_SUBFIELD_TYPE(62, 380, 16)
246  AST_MAP_SUBFIELD_TYPE(62, 380, 17)
247  AST_MAP_SUBFIELD_TYPE(62, 380, 18)
248  AST_MAP_SUBFIELD_TYPE(62, 380, 19)
249  AST_MAP_SUBFIELD_TYPE(62, 380, 20)
250  AST_MAP_SUBFIELD_TYPE(62, 380, 21)
251  AST_MAP_SUBFIELD_TYPE(62, 380, 22)
252  AST_MAP_SUBFIELD_TYPE(62, 380, 23)
253  AST_MAP_SUBFIELD_TYPE(62, 380, 24)
254  AST_MAP_SUBFIELD_TYPE(62, 380, 25)
255  AST_MAP_SUBFIELD_TYPE(62, 380, 26)
256  AST_MAP_SUBFIELD_TYPE(62, 380, 27)
257  AST_MAP_SUBFIELD_TYPE(62, 380, 28)
258 
259  //Dataitem I062/390
260  AST_MAP_SUBFIELD_TYPE(62, 390, 01)
261  AST_MAP_SUBFIELD_TYPE(62, 390, 02)
262  AST_MAP_SUBFIELD_TYPE(62, 390, 03)
263  AST_MAP_SUBFIELD_TYPE(62, 390, 04)
264  AST_MAP_SUBFIELD_TYPE(62, 390, 05)
265  AST_MAP_SUBFIELD_TYPE(62, 390, 06)
266  AST_MAP_SUBFIELD_TYPE(62, 390, 07)
267  AST_MAP_SUBFIELD_TYPE(62, 390, 08)
268  AST_MAP_SUBFIELD_TYPE(62, 390, 09)
269  AST_MAP_SUBFIELD_TYPE(62, 390, 10)
270  AST_MAP_SUBFIELD_TYPE(62, 390, 11)
271  AST_MAP_SUBFIELD_TYPE(62, 390, 12)
272  AST_MAP_SUBFIELD_TYPE(62, 390, 13)
273  AST_MAP_SUBFIELD_TYPE(62, 390, 14)
274  AST_MAP_SUBFIELD_TYPE(62, 390, 15)
275  AST_MAP_SUBFIELD_TYPE(62, 390, 16)
276  AST_MAP_SUBFIELD_TYPE(62, 390, 17)
277  AST_MAP_SUBFIELD_TYPE(62, 390, 18)
278 
279  //Dataitem I062/500
280  AST_MAP_SUBFIELD_TYPE(62, 500, 01)
281  AST_MAP_SUBFIELD_TYPE(62, 500, 02)
282  AST_MAP_SUBFIELD_TYPE(62, 500, 03)
283  AST_MAP_SUBFIELD_TYPE(62, 500, 04)
284  AST_MAP_SUBFIELD_TYPE(62, 500, 05)
285  AST_MAP_SUBFIELD_TYPE(62, 500, 06)
286  AST_MAP_SUBFIELD_TYPE(62, 500, 07)
287  AST_MAP_SUBFIELD_TYPE(62, 500, 08)
288 
289 } ast_subfield_type_t;
290 
292 typedef struct _ast_subfield_t
293 {
294  bool existing;
295 
296  const unsigned char* data;
297  size_t size;
298 
299  ast_subfield_type_t type;
300 
301  bool valid;
302 } ast_subfield_t;
303 
305 #define AST_MAX_SUBFIELD_SIZE 32
306 
308 AST_API size_t ast_subfield_get_size(const unsigned char* buffer, const size_t bufsize, const ast_subfield_type_t type);
309 
311 AST_API const char* ast_subfield_get_id(const ast_subfield_type_t type);
312 
314 AST_API const char* ast_subfield_get_name(const ast_subfield_type_t type);
315 
317 #define AST_SUBFIELD_SUMMARY_PREFERED_CHARS summary_size
318 
320 AST_API void ast_subfield_get_summary(char* summary, const size_t summary_size, const ast_dataitem_t di, const ast_subfield_type_t type);
321 
323 AST_API void ast_subfield_get_detail_html(char* detail, const size_t detail_size, const ast_dataitem_t di, const ast_subfield_type_t type);
324 
326 #define AST_SUBFIELD_BIN_HTML_PREFERED_CHARS (AST_MAX_SUBFIELD_SIZE * 128 + 64)
327 
333 AST_API void ast_subfield_get_bin_html(char* html, const size_t html_size, const ast_subfield_t sf);
334 
362 #define AST_MAX_SUBFIELDS 35
363 
365 typedef struct _ast_dataitem_subfields_t
366 {
367  bool valid;
368 
369  ast_fspec_t fspec;
370  ast_subfield_t subfields[AST_MAX_SUBFIELDS];
371  size_t n_subfields;
372 } ast_dataitem_subfields_t;
373 
375 AST_API size_t ast_dataitem_subfields_get_size(const unsigned char* buffer, const size_t bufsize, const ast_dataitem_type_t dataitem);
376 
378 AST_API size_t ast_dataitem_subfields_get_number(const ast_dataitem_type_t type);
379 
381 AST_API ast_dataitem_subfields_t ast_dataitem_subfields_decode(const ast_dataitem_t di);
382 
384 AST_API void ast_dataitem_subfields_get_summary(char* summary, const size_t summary_size, const ast_dataitem_t di);
385 
387 AST_API void ast_dataitem_subfields_get_detail_html(char* detail, const size_t detail_size, const ast_dataitem_t di);
388 
392 #ifdef __cplusplus
393  }
394 #endif // extern "C"
395 
396 #endif //LIBASTERIX_SUBFIELD_H
397 
398 // vim:set ft=c sw=2 sts=2 fenc=utf8:
ast_subfield_type_t
ast_subfield_type_t
Definition of subfield id in each dataitem.
Definition: subfield.h:52
ast_subfield_t::existing
bool existing
Definition: subfield.h:294
ast_subfield_t::valid
bool valid
True if subfield is correctlly decoded.
Definition: subfield.h:301
ast_subfield_get_id
const char * ast_subfield_get_id(const ast_subfield_type_t type)
Get ID string of subfield.
ast_dataitem_subfields_t::valid
bool valid
Definition: subfield.h:367
AST_API
#define AST_API
Definition: platform.h:63
ast_dataitem_subfields_decode
ast_dataitem_subfields_t ast_dataitem_subfields_decode(const ast_dataitem_t di)
Decode function.
INULLFIELD
Null subfield.
Definition: subfield.h:54
ast_subfield_get_bin_html
void ast_subfield_get_bin_html(char *html, const size_t html_size, const ast_subfield_t sf)
Function to get a html snippet of the raw subfield data in binary format.
ast_subfield_t::type
ast_subfield_type_t type
Type of subfield.
Definition: subfield.h:299
ast_subfield_get_size
size_t ast_subfield_get_size(const unsigned char *buffer, const size_t bufsize, const ast_subfield_type_t type)
Get size of subfield.
fspec.h
Implementation of Field SPECification (FSPEC) concept defined by ASTERIX.
ast_dataitem_subfields_t::n_subfields
size_t n_subfields
Definition: subfield.h:371
AST_MAP_SUBFIELD_TYPE
#define AST_MAP_SUBFIELD_TYPE(category, dataitem, subfield)
Definition: subfield.h:99
ast_subfield_t
Subfield struct.
Definition: subfield.h:292
ast_fspec_t
Definition: fspec.h:36
dataitem.h
Implementation of Dataitem concept defined by ASTERIX.
ast_dataitem_subfields_get_size
size_t ast_dataitem_subfields_get_size(const unsigned char *buffer, const size_t bufsize, const ast_dataitem_type_t dataitem)
Get size function.
ast_subfield_get_name
const char * ast_subfield_get_name(const ast_subfield_type_t type)
Get name of subfield.
ast_dataitem_subfields_t::fspec
ast_fspec_t fspec
Definition: subfield.h:369
ast_dataitem_subfields_get_detail_html
void ast_dataitem_subfields_get_detail_html(char *detail, const size_t detail_size, const ast_dataitem_t di)
Get detail function.
ast_subfield_t::data
const unsigned char * data
Address of subfield.
Definition: subfield.h:296
ast_dataitem_t
Dataitem.
Definition: dataitem.h:422
ast_subfield_get_detail_html
void ast_subfield_get_detail_html(char *detail, const size_t detail_size, const ast_dataitem_t di, const ast_subfield_type_t type)
Get detail of subfield, in html format.
ast_subfield_t::size
size_t size
Size of subfield.
Definition: subfield.h:297
ast_dataitem_type_t
ast_dataitem_type_t
Definition of data item id in each category.
Definition: dataitem.h:67
AST_MAX_SUBFIELDS
#define AST_MAX_SUBFIELDS
Definition: subfield.h:362
ast_dataitem_subfields_get_number
size_t ast_dataitem_subfields_get_number(const ast_dataitem_type_t type)
Get number of subfields function.
ast_dataitem_subfields_get_summary
void ast_dataitem_subfields_get_summary(char *summary, const size_t summary_size, const ast_dataitem_t di)
Get summary funciton.
ast_subfield_get_summary
void ast_subfield_get_summary(char *summary, const size_t summary_size, const ast_dataitem_t di, const ast_subfield_type_t type)
Get summary of subfield.
ast_dataitem_subfields_t
Data Item - Subfields.
Definition: subfield.h:365
Copyright 2008-2021 SinoATC