secapi-sys 0.4.0

FFI bindings to SecAPI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

/**
 * Copyright 2023 Comcast Cable Communications Management, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/** @section Description
 * @file overflow.h
 *
 * This file contains the functions and structures that check the addition operation for overflow.
 */

#ifndef OVERFLOW_H
#define OVERFLOW_H

#ifdef __cplusplus

#include <cstdbool>

extern "C" {
#else
#include <stdbool.h>
#endif

/**
 * Adds two unsigned long values together and checks for overflow. The result is placed in result.
 *
 * @param[in] a left value to add.
 * @param[in] b right value to add
 * @param[out] result result of addition if no overflow occurs.
 * @return false if no overflow and true if there is.
 */
bool add_overflow(
        unsigned long a,
        unsigned long b,
        unsigned long* result);

#ifdef __cplusplus
}
#endif

#endif // OVERFLOW_H