contrib/atf/atf-c/tp.h

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