include/babeltrace2/graph/component-class.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 /* For BT_QUERY_EXECUTOR_STATUS_* */
  28 #include <babeltrace2/graph/query-executor-const.h>
  29
  30 /* For bt_component_class */
  31 #include <babeltrace2/types.h>
  32
  33 /* For bt_component_class_status */
  34 #include <babeltrace2/graph/component-class-const.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef enum bt_query_status {
  41         BT_QUERY_STATUS_OK = BT_QUERY_EXECUTOR_STATUS_OK,
  42         BT_QUERY_STATUS_AGAIN = BT_QUERY_EXECUTOR_STATUS_AGAIN,
  43         BT_QUERY_STATUS_ERROR = BT_QUERY_EXECUTOR_STATUS_ERROR,
  44         BT_QUERY_STATUS_NOMEM = BT_QUERY_EXECUTOR_STATUS_NOMEM,
  45         BT_QUERY_STATUS_INVALID_OBJECT = BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT,
  46         BT_QUERY_STATUS_INVALID_PARAMS = BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS,
  47 } bt_query_status;
  48
  49 extern bt_component_class_status bt_component_class_set_description(
  50                 bt_component_class *component_class,
  51                 const char *description);
  52
  53 extern bt_component_class_status bt_component_class_set_help(
  54                 bt_component_class *component_class,
  55                 const char *help);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */