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