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