1 #ifndef BABELTRACE_PLUGINS_COMMON_PARAM_VALIDATION_PARAM_VALIDATION_H
2 #define BABELTRACE_PLUGINS_COMMON_PARAM_VALIDATION_PARAM_VALIDATION_H
5 * Copyright 2019 EfficiOS Inc.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #include <babeltrace2/babeltrace.h>
29 #include <stdio.h> /* For __MINGW_PRINTF_FORMAT. */
31 #ifdef __MINGW_PRINTF_FORMAT
32 # define BT_PRINTF_FORMAT __MINGW_PRINTF_FORMAT
34 # define BT_PRINTF_FORMAT printf
37 struct bt_param_validation_context
;
38 struct bt_param_validation_value_descr
;
40 #define BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END { NULL, 0, {} }
42 struct bt_param_validation_map_value_descr
{
43 const struct bt_param_validation_map_value_entry_descr
*entries
;
46 #define BT_PARAM_VALIDATION_INFINITE UINT64_MAX
48 struct bt_param_validation_array_value_descr
{
50 uint64_t max_length
; /* Use BT_PARAM_VALIDATION_INFINITE if there's no max. */
51 const struct bt_param_validation_value_descr
*element_type
;
54 struct bt_param_validation_string_value_descr
{
55 /* NULL-terminated array of choices. Unused if NULL. */
59 enum bt_param_validation_status
{
60 BT_PARAM_VALIDATION_STATUS_OK
= 0,
61 BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR
= -1,
62 BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR
= -2,
65 typedef enum bt_param_validation_status
66 (bt_param_validation_func
)(const bt_value
*value
,
67 struct bt_param_validation_context
*);
69 struct bt_param_validation_value_descr
{
72 /* Additional checks dependent on the type. */
74 struct bt_param_validation_array_value_descr array
;
75 struct bt_param_validation_map_value_descr map
;
76 struct bt_param_validation_string_value_descr string
;
80 * If set, call this function, which is responsible of validating the
81 * value. The other fields are ignored.
83 * If validation fails, this function must call
84 * `bt_param_validation_error` with the provided context
85 * to set the error string.
87 bt_param_validation_func
*validation_func
;
90 #define BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL true
91 #define BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY false
93 struct bt_param_validation_map_value_entry_descr
{
97 const struct bt_param_validation_value_descr value_descr
;
100 enum bt_param_validation_status
bt_param_validation_validate(
101 const bt_value
*params
,
102 const struct bt_param_validation_map_value_entry_descr
*entries
,
105 __attribute__((format(BT_PRINTF_FORMAT
, 2, 3)))
106 enum bt_param_validation_status
bt_param_validation_error(
107 struct bt_param_validation_context
*ctx
,
108 const char *format
, ...);
110 #endif /* BABELTRACE_PLUGINS_COMMON_PARAM_VALIDATION_PARAM_VALIDATION_H */