Fix: bt_value_map_borrow_entry_value(): use `@bt_pre_is_map_val`
[babeltrace.git] / include / babeltrace2 / integer-range-set.h
index 8eb13434de06d032d2162b1acb0729a1ea7effcd..d3aff20ee6360663834647bae73a6ee94385a1e3 100644 (file)
@@ -1,28 +1,14 @@
-#ifndef BABELTRACE2_INTEGER_RANGE_SET_H
-#define BABELTRACE2_INTEGER_RANGE_SET_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:
+ * SPDX-License-Identifier: MIT
  *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * 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_INTEGER_RANGE_SET_H
+#define BABELTRACE2_INTEGER_RANGE_SET_H
+
+/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
+
 #ifndef __BT_IN_BABELTRACE_H
 # error "Please include <babeltrace2/babeltrace.h> instead."
 #endif
@@ -114,13 +100,11 @@ bt_integer_range_set_signed_is_equal().
 @brief
     Unsigned 64-bit integer range.
 
-
 @typedef struct bt_integer_range_signed bt_integer_range_signed
 
 @brief
     Signed 64-bit integer range.
 
-
 @typedef struct bt_integer_range_set bt_integer_range_set
 
 @brief
@@ -130,13 +114,11 @@ This is an abstract type for common properties and operations. See \ref
 api-fund-c-typing to learn more about conceptual object type
 inheritance.
 
-
 @typedef struct bt_integer_range_set_unsigned bt_integer_range_set_unsigned;
 
 @brief
     Set of unsigned 64-bit integer ranges.
 
-
 @typedef struct bt_integer_range_set_signed bt_integer_range_set_signed;
 
 @brief
@@ -167,7 +149,7 @@ The returned lower value is included in \bt_p{int_range}.
 @bt_pre_is_bool_val{int_range}
 */
 extern uint64_t bt_integer_range_unsigned_get_lower(
-               const bt_integer_range_unsigned *int_range);
+               const bt_integer_range_unsigned *int_range) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -186,7 +168,7 @@ The returned upper value is included in \bt_p{int_range}.
 @bt_pre_is_bool_val{int_range}
 */
 extern uint64_t bt_integer_range_unsigned_get_upper(
-               const bt_integer_range_unsigned *int_range);
+               const bt_integer_range_unsigned *int_range) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -210,7 +192,7 @@ lower and upper values.
 */
 extern bt_bool bt_integer_range_unsigned_is_equal(
                const bt_integer_range_unsigned *a_int_range,
-               const bt_integer_range_unsigned *b_int_range);
+               const bt_integer_range_unsigned *b_int_range) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -236,7 +218,7 @@ The returned lower value is included in \bt_p{int_range}.
 @bt_pre_is_bool_val{int_range}
 */
 extern int64_t bt_integer_range_signed_get_lower(
-               const bt_integer_range_signed *int_range);
+               const bt_integer_range_signed *int_range) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -255,7 +237,7 @@ The returned upper value is included in \bt_p{int_range}.
 @bt_pre_is_bool_val{int_range}
 */
 extern int64_t bt_integer_range_signed_get_upper(
-               const bt_integer_range_signed *int_range);
+               const bt_integer_range_signed *int_range) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -279,7 +261,7 @@ lower and upper values.
 */
 extern bt_bool bt_integer_range_signed_is_equal(
                const bt_integer_range_signed *a_int_range,
-               const bt_integer_range_signed *b_int_range);
+               const bt_integer_range_signed *b_int_range) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -329,7 +311,7 @@ typedef enum bt_integer_range_set_add_range_status {
 @bt_pre_not_null{int_range_set}
 */
 extern uint64_t bt_integer_range_set_get_range_count(
-               const bt_integer_range_set *int_range_set);
+               const bt_integer_range_set *int_range_set) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -345,7 +327,8 @@ extern uint64_t bt_integer_range_set_get_range_count(
 @returns
     New unsigned integer range set, or \c NULL on memory error.
 */
-extern bt_integer_range_set_unsigned *bt_integer_range_set_unsigned_create(void);
+extern bt_integer_range_set_unsigned *bt_integer_range_set_unsigned_create(
+               void) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -380,7 +363,7 @@ integer range to add to \bt_p{int_range_set}.
 extern bt_integer_range_set_add_range_status
 bt_integer_range_set_unsigned_add_range(
                bt_integer_range_set_unsigned *int_range_set,
-               uint64_t lower, uint64_t upper);
+               uint64_t lower, uint64_t upper) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -412,7 +395,7 @@ bt_integer_range_set_unsigned_add_range(
 extern const bt_integer_range_unsigned *
 bt_integer_range_set_unsigned_borrow_range_by_index_const(
                const bt_integer_range_set_unsigned *int_range_set,
-               uint64_t index);
+               uint64_t index) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -438,7 +421,8 @@ is \em not equal to an unsigned integer range containing [2,&nbsp;15].
 */
 extern bt_bool bt_integer_range_set_unsigned_is_equal(
                const bt_integer_range_set_unsigned *int_range_set_a,
-               const bt_integer_range_set_unsigned *int_range_set_b);
+               const bt_integer_range_set_unsigned *int_range_set_b)
+               __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -458,6 +442,7 @@ extern bt_bool bt_integer_range_set_unsigned_is_equal(
 static inline
 const bt_integer_range_set *bt_integer_range_set_unsigned_as_range_set_const(
                const bt_integer_range_set_unsigned *int_range_set)
+               __BT_NOEXCEPT
 {
        return __BT_UPCAST_CONST(bt_integer_range_set, int_range_set);
 }
@@ -479,7 +464,8 @@ const bt_integer_range_set *bt_integer_range_set_unsigned_as_range_set_const(
     Decrements the reference count of an unsigned integer range set.
 */
 extern void bt_integer_range_set_unsigned_get_ref(
-               const bt_integer_range_set_unsigned *int_range_set);
+               const bt_integer_range_set_unsigned *int_range_set)
+               __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -498,7 +484,8 @@ extern void bt_integer_range_set_unsigned_get_ref(
     Increments the reference count of an unsigned integer range set.
 */
 extern void bt_integer_range_set_unsigned_put_ref(
-               const bt_integer_range_set_unsigned *int_range_set);
+               const bt_integer_range_set_unsigned *int_range_set)
+               __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -569,7 +556,8 @@ the existing \bt_p{_dst} reference.
 @returns
     New signed integer range set, or \c NULL on memory error.
 */
-extern bt_integer_range_set_signed *bt_integer_range_set_signed_create(void);
+extern bt_integer_range_set_signed *bt_integer_range_set_signed_create(
+               void) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -604,7 +592,7 @@ integer range to add to \bt_p{int_range_set}.
 extern bt_integer_range_set_add_range_status
 bt_integer_range_set_signed_add_range(
                bt_integer_range_set_signed *int_range_set,
-               int64_t lower, int64_t upper);
+               int64_t lower, int64_t upper) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -635,7 +623,8 @@ bt_integer_range_set_signed_add_range(
 */
 extern const bt_integer_range_signed *
 bt_integer_range_set_signed_borrow_range_by_index_const(
-               const bt_integer_range_set_signed *int_range_set, uint64_t index);
+               const bt_integer_range_set_signed *int_range_set,
+               uint64_t index) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -644,8 +633,8 @@ bt_integer_range_set_signed_borrow_range_by_index_const(
 
 Two signed integer range sets are considered equal if they contain the
 exact same signed integer ranges, whatever the order. In other words,
-a signed integer range set containing [-57,&nbsp;23] and [24,&nbsp;42]
-is \em not equal to a signed integer range containing [-57,&nbsp;42].
+a signed integer range set containing [57,&nbsp;23] and [24,&nbsp;42]
+is \em not equal to a signed integer range containing [57,&nbsp;42].
 
 @param[in] int_range_set_a
     Signed integer range set A.
@@ -661,7 +650,8 @@ is \em not equal to a signed integer range containing [-57,&nbsp;42].
 */
 extern bt_bool bt_integer_range_set_signed_is_equal(
                const bt_integer_range_set_signed *int_range_set_a,
-               const bt_integer_range_set_signed *int_range_set_b);
+               const bt_integer_range_set_signed *int_range_set_b)
+               __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -681,6 +671,7 @@ extern bt_bool bt_integer_range_set_signed_is_equal(
 static inline
 const bt_integer_range_set *bt_integer_range_set_signed_as_range_set_const(
                const bt_integer_range_set_signed *int_range_set)
+               __BT_NOEXCEPT
 {
        return __BT_UPCAST_CONST(bt_integer_range_set, int_range_set);
 }
@@ -702,7 +693,7 @@ const bt_integer_range_set *bt_integer_range_set_signed_as_range_set_const(
     Decrements the reference count of a signed integer range set.
 */
 extern void bt_integer_range_set_signed_get_ref(
-               const bt_integer_range_set_signed *int_range_set);
+               const bt_integer_range_set_signed *int_range_set) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -721,7 +712,7 @@ extern void bt_integer_range_set_signed_get_ref(
     Increments the reference count of a signed integer range set.
 */
 extern void bt_integer_range_set_signed_put_ref(
-               const bt_integer_range_set_signed *int_range_set);
+               const bt_integer_range_set_signed *int_range_set) __BT_NOEXCEPT;
 
 /*!
 @brief
This page took 0.034903 seconds and 4 git commands to generate.