include/babeltrace/graph/private-component-class.h

   1 #ifndef BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_H
   2 #define BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_H
   3
   4 /*
   5  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  *
   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:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  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
  23  * SOFTWARE.
  24  */
  25
  26 /* For enum bt_query_status */
  27 #include <babeltrace/graph/query-executor.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 struct bt_component_class;
  34 struct bt_private_component_class;
  35
  36 static inline
  37 struct bt_component_class *
  38 bt_private_component_class_as_component_class(
  39                 struct bt_private_component_class *priv_comp_cls)
  40 {
  41         return (void *) priv_comp_cls;
  42 }
  43
  44 extern int bt_private_component_class_set_description(
  45                 struct bt_private_component_class *component_class,
  46                 const char *description);
  47
  48 extern int bt_private_component_class_set_help(
  49                 struct bt_private_component_class *component_class,
  50                 const char *help);
  51
  52 #ifdef __cplusplus
  53 }
  54 #endif
  55
  56 #endif /* BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_H */