X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace2%2Fgraph%2Fcomponent-class.h;h=4fe692f2c88110a112ad9abfe82252253131e0fb;hb=HEAD;hp=98f66fbb26c47f4fcd6e1d9ea7d6234ada6e5b64;hpb=43c59509042845f8d42c3e99ec74d45fa2dc0908;p=babeltrace.git diff --git a/include/babeltrace2/graph/component-class.h b/include/babeltrace2/graph/component-class.h index 98f66fbb..64bccf3b 100644 --- a/include/babeltrace2/graph/component-class.h +++ b/include/babeltrace2/graph/component-class.h @@ -1,28 +1,14 @@ -#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_H -#define BABELTRACE2_GRAPH_COMPONENT_CLASS_H - /* - * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * SPDX-License-Identifier: MIT * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation */ +#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_H +#define BABELTRACE2_GRAPH_COMPONENT_CLASS_H + +/* IWYU pragma: private, include */ + #ifndef __BT_IN_BABELTRACE_H # error "Please include instead." #endif @@ -45,9 +31,9 @@ A component class is the class of a \bt_comp: @image html component.png @attention - This module (component class API) offers basic, read-only functions - to get component class properties. To \em create a component class, - see \ref api-comp-cls-dev or \ref api-plugin-dev. + This API (component class API) offers basic, + read-only functions to get component class properties. To \em create + a component class, see \ref api-comp-cls-dev or \ref api-plugin-dev. You can instantiate a given component class many times, with different initialization parameters, to create many components with the @@ -55,7 +41,7 @@ initialization parameters, to create many components with the There are two ways to obtain a component class: -- Create one programatically: see \ref api-comp-cls-dev. +- Create one programmatically: see \ref api-comp-cls-dev. - Borrow one from a \bt_plugin. @@ -252,7 +238,7 @@ typedef enum bt_component_class_type { Returns whether or not a component class is a \bt_sink_comp_cls. */ extern bt_component_class_type bt_component_class_get_type( - const bt_component_class *component_class); + const bt_component_class *component_class) __BT_NOEXCEPT; /*! @brief @@ -272,7 +258,7 @@ extern bt_component_class_type bt_component_class_get_type( */ static inline bt_bool bt_component_class_is_source( - const bt_component_class *component_class) + const bt_component_class *component_class) __BT_NOEXCEPT { return bt_component_class_get_type(component_class) == BT_COMPONENT_CLASS_TYPE_SOURCE; @@ -296,7 +282,7 @@ bt_bool bt_component_class_is_source( */ static inline bt_bool bt_component_class_is_filter( - const bt_component_class *component_class) + const bt_component_class *component_class) __BT_NOEXCEPT { return bt_component_class_get_type(component_class) == BT_COMPONENT_CLASS_TYPE_FILTER; @@ -320,7 +306,7 @@ bt_bool bt_component_class_is_filter( */ static inline bt_bool bt_component_class_is_sink( - const bt_component_class *component_class) + const bt_component_class *component_class) __BT_NOEXCEPT { return bt_component_class_get_type(component_class) == BT_COMPONENT_CLASS_TYPE_SINK; @@ -353,7 +339,7 @@ See the \ref api-comp-cls-prop-name "name" property. @bt_pre_not_null{component_class} */ extern const char *bt_component_class_get_name( - const bt_component_class *component_class); + const bt_component_class *component_class) __BT_NOEXCEPT; /*! @brief @@ -376,7 +362,7 @@ See the \ref api-comp-cls-prop-descr "description" property. @bt_pre_not_null{component_class} */ extern const char *bt_component_class_get_description( - const bt_component_class *component_class); + const bt_component_class *component_class) __BT_NOEXCEPT; /*! @brief @@ -398,7 +384,7 @@ See the \ref api-comp-cls-prop-help "help text" property. @bt_pre_not_null{component_class} */ extern const char *bt_component_class_get_help( - const bt_component_class *component_class); + const bt_component_class *component_class) __BT_NOEXCEPT; /*! @} */ @@ -423,7 +409,7 @@ extern const char *bt_component_class_get_help( Decrements the reference count of a component class. */ extern void bt_component_class_get_ref( - const bt_component_class *component_class); + const bt_component_class *component_class) __BT_NOEXCEPT; /*! @brief @@ -441,7 +427,7 @@ extern void bt_component_class_get_ref( Increments the reference count of a component class. */ extern void bt_component_class_put_ref( - const bt_component_class *component_class); + const bt_component_class *component_class) __BT_NOEXCEPT; /*! @brief @@ -523,7 +509,7 @@ expression static inline const bt_component_class * bt_component_class_source_as_component_class_const( - const bt_component_class_source *component_class) + const bt_component_class_source *component_class) __BT_NOEXCEPT { return __BT_UPCAST_CONST(bt_component_class, component_class); } @@ -551,7 +537,7 @@ bt_component_class_source_as_component_class_const( Decrements the reference count of a source component class. */ extern void bt_component_class_source_get_ref( - const bt_component_class_source *component_class); + const bt_component_class_source *component_class) __BT_NOEXCEPT; /*! @brief @@ -569,7 +555,7 @@ extern void bt_component_class_source_get_ref( Increments the reference count of a source component class. */ extern void bt_component_class_source_put_ref( - const bt_component_class_source *component_class); + const bt_component_class_source *component_class) __BT_NOEXCEPT; /*! @brief @@ -650,7 +636,7 @@ existing \bt_p{_dst} reference. static inline const bt_component_class * bt_component_class_filter_as_component_class_const( - const bt_component_class_filter *component_class) + const bt_component_class_filter *component_class) __BT_NOEXCEPT { return __BT_UPCAST_CONST(bt_component_class, component_class); } @@ -678,7 +664,7 @@ bt_component_class_filter_as_component_class_const( Decrements the reference count of a filter component class. */ extern void bt_component_class_filter_get_ref( - const bt_component_class_filter *component_class); + const bt_component_class_filter *component_class) __BT_NOEXCEPT; /*! @brief @@ -696,7 +682,7 @@ extern void bt_component_class_filter_get_ref( Increments the reference count of a filter component class. */ extern void bt_component_class_filter_put_ref( - const bt_component_class_filter *component_class); + const bt_component_class_filter *component_class) __BT_NOEXCEPT; /*! @brief @@ -777,7 +763,7 @@ existing \bt_p{_dst} reference. static inline const bt_component_class * bt_component_class_sink_as_component_class_const( - const bt_component_class_sink *component_class) + const bt_component_class_sink *component_class) __BT_NOEXCEPT { return __BT_UPCAST_CONST(bt_component_class, component_class); } @@ -805,7 +791,7 @@ bt_component_class_sink_as_component_class_const( Decrements the reference count of a sink component class. */ extern void bt_component_class_sink_get_ref( - const bt_component_class_sink *component_class); + const bt_component_class_sink *component_class) __BT_NOEXCEPT; /*! @brief @@ -823,7 +809,7 @@ extern void bt_component_class_sink_get_ref( Increments the reference count of a sink component class. */ extern void bt_component_class_sink_put_ref( - const bt_component_class_sink *component_class); + const bt_component_class_sink *component_class) __BT_NOEXCEPT; /*! @brief