src/ccunit/CCUnitTestCase.h

   1 /* -*- mode: C; -*- */
   2 /* Copyright (C) 2003 TSUTSUMI Kikuo.
   3    This file is part of the CCUnit Library.
   4
   5    The CCUnit Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public License
   7    as published by the Free Software Foundation; either version 2.1 of
   8    the License, or (at your option) any later version.
   9
  10    The CCUnit Library is distributed in the hope that it will be
  11    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  12    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the CCUnit Library; see the file COPYING.LESSER.
  17    If not, write to the Free Software Foundation, Inc., 59 Temple
  18    Place - Suite 330, Boston, MA 02111-1307, USA.
  19 */
  20
  21 /*
  22  * $Id$
  23  */
  24
  25 /** @file
  26  * TestCase module.
  27  */
  28
  29 #ifndef CCUNITTESTCASE_H
  30 #define CCUNITTESTCASE_H
  31
  32 /**
  33  * @ingroup CCUnitTestFixture
  34  * @defgroup CCUnitTestCase TestCase
  35  *
  36  * A single test object.
  37  *
  38  * This class is used to implement a simple test case.
  39  *
  40  * @{
  41  */
  42
  43 /**
  44  * A single test object.
  45  * @ingroup WritingTestFixture
  46  */
  47 typedef struct CCUnitTestCase
  48 {
  49   const char* name;                             /**< test case name */
  50   const char* desc;                             /**< test description */
  51   void (*runTest) ();                           /**< run test function */
  52 } CCUnitTestCase;
  53
  54 /**
  55  * Create new test case.
  56  * @ingroup WritingTestFixture
  57  * @param name case name.
  58  * @param desc case description.
  59  * @param runTest run test function.
  60  * @return new test case
  61  */
  62 extern CCUnitTestCase* ccunit_newTestCase (const char* name,
  63                                            const char* desc,
  64                                            void (*runTest)());
  65
  66 /**
  67  * Delete test case.
  68  * @ingroup WritingTestFixture
  69  * @param testCase deleting case.
  70  */
  71 extern void ccunit_deleteTestCase (CCUnitTestCase* testCase);
  72
  73 /** @} */
  74
  75 #endif  /* !CCUNITTESTCASE_H */