blob: 0ccaf53817d418c7ed2c6802b1fccc390aca948e (
plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* 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.
*/
/**
* @file longBow_TestFixtureConfig.h
* @ingroup testing
* @brief The Test Fixture configuration interface
*
*/
#ifndef LongBow_longBow_FixtureConfig_h
#define LongBow_longBow_FixtureConfig_h
#include <stdbool.h>
struct longbow_fixture_config {
char *name;
bool enabled;
};
typedef struct longbow_fixture_config LongBowTestFixtureConfig;
/**
* Create and initialise a LongBowTestFixtureConfig instance.
*
* @param [in] name The name of the Test Fixture
* @param [in] enabled True if the fixture is enabled, false otherwise.
*
* @return non-NULL A pointer to an allocated `LongBowTestFixtureConfig` isntance that must be destroyed via `longBowTestFixtureConfig_Destroy`.
* @return NULL An error occurred.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
* @see longBowTestFixtureConfig_Destroy
*/
LongBowTestFixtureConfig *longBowTestFixtureConfig_Create(const char *name, bool enabled);
/**
* Destroy a LongBowTestFixtureConfig intance.
*
* @param [in,out] configPtr A pointer to a pointer to a `LongBowTestFixtureConfig` instance.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
* @see longBowTestFixtureConfig_Create
*/
void longBowTestFixtureConfig_Destroy(LongBowTestFixtureConfig **configPtr);
#endif // LongBow_longBow_FixtureConfig_h
|
