2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
18 Permission is hereby granted, free of charge, to any person obtaining
19 a copy of this software and associated documentation files (the
20 "Software"), to deal in the Software without restriction, including
21 without limitation the rights to use, copy, modify, merge, publish,
22 distribute, sublicense, and/or sell copies of the Software, and to
23 permit persons to whom the Software is furnished to do so, subject to
24 the following conditions:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
29 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 #ifndef included_format_h
39 #define included_format_h
43 #include <vppinfra/clib.h> /* for CLIB_UNIX, etc. */
44 #include <vppinfra/vec.h>
45 #include <vppinfra/error.h> /* for ASSERT */
46 #include <vppinfra/string.h>
48 typedef u8 *(format_function_t) (u8 * s, va_list * args);
50 u8 *va_format (u8 * s, const char *format, va_list * args);
51 u8 *format (u8 * s, const char *format, ...);
57 #else /* ! CLIB_UNIX */
59 /* We're not Unix and have not stdio.h */
61 #define stdin ((FILE *) 0)
62 #define stdout ((FILE *) 1)
63 #define stderr ((FILE *) 2)
67 word va_fformat (FILE * f, char *fmt, va_list * va);
68 word fformat (FILE * f, char *fmt, ...);
69 word fdformat (int fd, char *fmt, ...);
72 format_get_indent (u8 * s)
90 #define _(f) __clib_export u8 * f (u8 * s, va_list * va)
92 /* Standard user-defined formats. */
95 _(format_ascii_bytes);
97 _(format_hex_bytes_no_wrap);
98 _(format_white_space);
100 _(format_time_interval);
104 /* Unix specific formats. */
105 _(format_address_family);
106 _(format_network_address);
107 _(format_network_protocol);
108 _(format_network_port);
111 _(format_time_float);
113 _(format_ucontext_pc);
120 typedef struct _unformat_input_t
122 /* Input buffer (vector). */
125 /* Current index in input buffer. */
128 /* Vector of buffer marks. Used to delineate pieces of the buffer
129 for error reporting and for parse recovery. */
132 /* User's function to fill the buffer when its empty
134 uword (*fill_buffer) (struct _unformat_input_t * i);
136 /* Return values for fill buffer function which indicate whether not
137 input has been exhausted. */
138 #define UNFORMAT_END_OF_INPUT (~0)
139 #define UNFORMAT_MORE_INPUT 0
141 /* User controlled argument to fill buffer function. */
142 void *fill_buffer_arg;
146 unformat_init (unformat_input_t * i,
147 uword (*fill_buffer) (unformat_input_t *),
148 void *fill_buffer_arg)
150 clib_memset (i, 0, sizeof (i[0]));
151 i->fill_buffer = fill_buffer;
152 i->fill_buffer_arg = fill_buffer_arg;
156 unformat_free (unformat_input_t * i)
158 vec_free (i->buffer);
159 vec_free (i->buffer_marks);
160 clib_memset (i, 0, sizeof (i[0]));
164 unformat_check_input (unformat_input_t * i)
166 /* Low level fill input function. */
167 extern uword _unformat_fill_input (unformat_input_t * i);
169 if (i->index >= vec_len (i->buffer) && i->index != UNFORMAT_END_OF_INPUT)
170 _unformat_fill_input (i);
175 /* Return true if input is exhausted */
177 unformat_is_eof (unformat_input_t * input)
179 return unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
182 /* Return next element in input vector,
183 possibly calling fill input to get more. */
185 unformat_get_input (unformat_input_t * input)
187 uword i = unformat_check_input (input);
188 if (i < vec_len (input->buffer))
190 input->index = i + 1;
191 i = input->buffer[i];
196 /* Back up input pointer by one. */
198 unformat_put_input (unformat_input_t * input)
203 /* Peek current input character without advancing. */
205 unformat_peek_input (unformat_input_t * input)
207 uword c = unformat_get_input (input);
208 if (c != UNFORMAT_END_OF_INPUT)
209 unformat_put_input (input);
213 /* Skip current input line. */
215 unformat_skip_line (unformat_input_t * i)
219 while ((c = unformat_get_input (i)) != UNFORMAT_END_OF_INPUT && c != '\n')
223 uword unformat_skip_white_space (unformat_input_t * input);
225 /* Unformat function. */
226 typedef uword (unformat_function_t) (unformat_input_t * input,
229 /* External functions. */
231 /* General unformatting function with programmable input stream. */
232 uword unformat (unformat_input_t * i, const char *fmt, ...);
234 /* Call user defined parse function.
235 unformat_user (i, f, ...) is equivalent to unformat (i, "%U", f, ...) */
236 uword unformat_user (unformat_input_t * input, unformat_function_t * func,
239 /* Alternate version which allows for extensions. */
240 uword va_unformat (unformat_input_t * i, const char *fmt, va_list * args);
242 /* Setup for unformat of Unix style command line. */
243 void unformat_init_command_line (unformat_input_t * input, char *argv[]);
245 /* Setup for unformat of given string. */
246 void unformat_init_string (unformat_input_t *input, const char *string,
250 unformat_init_cstring (unformat_input_t * input, char *string)
252 unformat_init_string (input, string, strlen (string));
255 /* Setup for unformat of given vector string; vector will be freed by unformat_string. */
256 void unformat_init_vector (unformat_input_t * input, u8 * vector_string);
258 /* Format function for unformat input usable when an unformat error
260 u8 *format_unformat_error (u8 * s, va_list * va);
262 #define unformat_parse_error(input) \
263 clib_error_return (0, "parse error `%U'", format_unformat_error, input)
265 /* Print all input: not just error context. */
266 u8 *format_unformat_input (u8 * s, va_list * va);
268 /* Unformat (parse) function which reads a %s string and converts it
269 to and unformat_input_t. */
270 unformat_function_t unformat_input;
272 /* Parse a line ending with \n and return it. */
273 unformat_function_t unformat_line;
275 /* Parse a line ending with \n and return it as an unformat_input_t. */
276 unformat_function_t unformat_line_input;
278 /* Parse a token containing given set of characters. */
279 unformat_function_t unformat_token;
281 /* Parses a hexstring into a vector of bytes. */
282 unformat_function_t unformat_hex_string;
284 /* Returns non-zero match if input is exhausted.
285 Useful to ensure that the entire input matches with no trailing junk. */
286 unformat_function_t unformat_eof;
288 /* Parse memory size e.g. 100, 100k, 100m, 100g. */
289 unformat_function_t unformat_memory_size;
291 /* Format base 10 e.g. 100, 100K, 100M, 100G */
292 u8 *format_base10 (u8 *s, va_list *va);
294 /* Unparse memory size e.g. 100, 100k, 100m, 100g. */
295 u8 *format_memory_size (u8 * s, va_list * va);
297 /* Parse memory page size e.g. 4K, 2M */
298 unformat_function_t unformat_log2_page_size;
300 /* Unparse memory page size e.g. 4K, 2M */
301 u8 *format_log2_page_size (u8 * s, va_list * va);
303 /* Format c identifier: e.g. a_name -> "a name". */
304 u8 *format_c_identifier (u8 * s, va_list * va);
306 /* Format hexdump with both hex and printable chars - compatible with text2pcap */
307 u8 *format_hexdump (u8 * s, va_list * va);
309 /* Format bitmap of array of u64 numbers */
310 u8 *format_u64_bitmap (u8 *s, va_list *va);
312 /* Unix specific formats. */
314 /* Setup input from Unix file. */
315 void unformat_init_clib_file (unformat_input_t * input, int file_descriptor);
317 /* Take input from Unix environment variable; returns
318 1 if variable exists zero otherwise. */
319 uword unformat_init_unix_env (unformat_input_t * input, char *var);
321 /* Unformat unix group id (gid) specified as integer or string */
322 unformat_function_t unformat_unix_gid;
323 #endif /* CLIB_UNIX */
325 uword unformat_data_size (unformat_input_t * input, va_list * args);
328 int test_format_main (unformat_input_t * input);
329 int test_unformat_main (unformat_input_t * input);
331 /* This is not the right place for this, but putting it in vec.h
332 created circular dependency problems. */
333 int test_vec_main (unformat_input_t * input);
335 #endif /* included_format_h */
338 * fd.io coding-style-patch-verification: ON
341 * eval: (c-set-style "gnu")