contrib/atf/atf-c/tp.h

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