xref: /minix3/external/bsd/atf/dist/atf-c/tp.h (revision 11be35a165022172ed3cea20f2b5df0307540b0e)
1*11be35a1SLionel Sambuc /*
2*11be35a1SLionel Sambuc  * Automated Testing Framework (atf)
3*11be35a1SLionel Sambuc  *
4*11be35a1SLionel Sambuc  * Copyright (c) 2008 The NetBSD Foundation, Inc.
5*11be35a1SLionel Sambuc  * All rights reserved.
6*11be35a1SLionel Sambuc  *
7*11be35a1SLionel Sambuc  * Redistribution and use in source and binary forms, with or without
8*11be35a1SLionel Sambuc  * modification, are permitted provided that the following conditions
9*11be35a1SLionel Sambuc  * are met:
10*11be35a1SLionel Sambuc  * 1. Redistributions of source code must retain the above copyright
11*11be35a1SLionel Sambuc  *    notice, this list of conditions and the following disclaimer.
12*11be35a1SLionel Sambuc  * 2. Redistributions in binary form must reproduce the above copyright
13*11be35a1SLionel Sambuc  *    notice, this list of conditions and the following disclaimer in the
14*11be35a1SLionel Sambuc  *    documentation and/or other materials provided with the distribution.
15*11be35a1SLionel Sambuc  *
16*11be35a1SLionel Sambuc  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
17*11be35a1SLionel Sambuc  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18*11be35a1SLionel Sambuc  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19*11be35a1SLionel Sambuc  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20*11be35a1SLionel Sambuc  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
21*11be35a1SLionel Sambuc  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*11be35a1SLionel Sambuc  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23*11be35a1SLionel Sambuc  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24*11be35a1SLionel Sambuc  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25*11be35a1SLionel Sambuc  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26*11be35a1SLionel Sambuc  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27*11be35a1SLionel Sambuc  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*11be35a1SLionel Sambuc  */
29*11be35a1SLionel Sambuc 
30*11be35a1SLionel Sambuc #if !defined(ATF_C_TP_H)
31*11be35a1SLionel Sambuc #define ATF_C_TP_H
32*11be35a1SLionel Sambuc 
33*11be35a1SLionel Sambuc #include <stdbool.h>
34*11be35a1SLionel Sambuc 
35*11be35a1SLionel Sambuc #include <atf-c/error_fwd.h>
36*11be35a1SLionel Sambuc 
37*11be35a1SLionel Sambuc struct atf_tc;
38*11be35a1SLionel Sambuc 
39*11be35a1SLionel Sambuc /* ---------------------------------------------------------------------
40*11be35a1SLionel Sambuc  * The "atf_tp" type.
41*11be35a1SLionel Sambuc  * --------------------------------------------------------------------- */
42*11be35a1SLionel Sambuc 
43*11be35a1SLionel Sambuc struct atf_tp_impl;
44*11be35a1SLionel Sambuc struct atf_tp {
45*11be35a1SLionel Sambuc     struct atf_tp_impl *pimpl;
46*11be35a1SLionel Sambuc };
47*11be35a1SLionel Sambuc typedef struct atf_tp atf_tp_t;
48*11be35a1SLionel Sambuc 
49*11be35a1SLionel Sambuc /* Constructors/destructors. */
50*11be35a1SLionel Sambuc atf_error_t atf_tp_init(atf_tp_t *, const char *const *);
51*11be35a1SLionel Sambuc void atf_tp_fini(atf_tp_t *);
52*11be35a1SLionel Sambuc 
53*11be35a1SLionel Sambuc /* Getters. */
54*11be35a1SLionel Sambuc char **atf_tp_get_config(const atf_tp_t *);
55*11be35a1SLionel Sambuc bool atf_tp_has_tc(const atf_tp_t *, const char *);
56*11be35a1SLionel Sambuc const struct atf_tc *atf_tp_get_tc(const atf_tp_t *, const char *);
57*11be35a1SLionel Sambuc const struct atf_tc *const *atf_tp_get_tcs(const atf_tp_t *);
58*11be35a1SLionel Sambuc 
59*11be35a1SLionel Sambuc /* Modifiers. */
60*11be35a1SLionel Sambuc atf_error_t atf_tp_add_tc(atf_tp_t *, struct atf_tc *);
61*11be35a1SLionel Sambuc 
62*11be35a1SLionel Sambuc /* ---------------------------------------------------------------------
63*11be35a1SLionel Sambuc  * Free functions.
64*11be35a1SLionel Sambuc  * --------------------------------------------------------------------- */
65*11be35a1SLionel Sambuc 
66*11be35a1SLionel Sambuc atf_error_t atf_tp_run(const atf_tp_t *, const char *, const char *);
67*11be35a1SLionel Sambuc atf_error_t atf_tp_cleanup(const atf_tp_t *, const char *);
68*11be35a1SLionel Sambuc 
69*11be35a1SLionel Sambuc #endif /* ATF_C_TP_H */
70