tools/tesh2/include/runner.h

   1 /*\r
   2  * include/runner.h - type representing the tesh runner .\r
   3  *\r
   4  * Copyright 2008,2009 Martin Quinson, Malek Cherier All right reserved. \r
   5  *\r
   6  * This program is free software; you can redistribute it and/or modify it \r
   7  * under the terms of the license (GNU LGPL) which comes with this package.\r
   8  *\r
   9  * Purpose:\r
  10  *              This file contains all the declarations of the functions related with\r
  11  *              the tesh runner type.\r
  12  *\r
  13  */  \r
  14     \r
  15 #ifndef __RUNNER_H      \r
  16 #define __RUNNER_H\r
  17     \r
  18 #include <com.h>\r
  19     \r
  20 #ifdef __cplusplus\r
  21 extern "C" {
  22   \r
  23 #endif  /* \r */
  24   \r
  25 /*! \brief runner_init - initialize the tesh runner.\r
  26  *\r
  27  * \param check_syntax_flag             If 1, the runner check the syntax of all the tesh files before running.\r
  28  * \param timeout                               The time alloted to the run of all the units (if -1 no time alloted).\r
  29  * \param fstreams                              A fstreams object containing the file streams representing the tesh files to run.\r
  30  *\r
  31  * \return                                              If successful the function returns 0. Otherwise the function returns -1 and sets\r
  32  *                                                              the global variable errno with the appropiate error code.\r
  33  *\r
  34  * errors :\r
  35  *                                                              [EALREADY] if the runner is already initialized.\r
  36  *                                                              [ENOMEM] if the system has not enough space to initialize the runner.\r
  37  *                                                              [ESYNTAX] if the parameter check_syntax_flag is 1 and a syntax error is detected.\r
  38  */ \r
  39   int \r
  40       runner_init( /*int check_syntax_flag, */ int timeout,
  41                   fstreams_t fstreams);
  42   \r\r
  43 /*! \brief runner_run - run the tesh files.\r
  44  */ \r
  45   void \r runner_run(void);
  46   \r\r
  47 /*! \brief runner_destroy - destroy the runner (release all the resources allocated by the runner)\r
  48  */ \r
  49   void \r runner_destroy(void);
  50   \r\r
  51 /*! \brief runner_summarize - display the summary of the execution of all the tests of the tesh files.\r
  52  */ \r
  53   void \r runner_summarize(void);
  54   \r\r
  55 /*! \brief runner_interrupt - interrupt all the units of the run.\r
  56  */ \r
  57   void \r runner_interrupt(void);
  58   \r\rint \r runner_is_timedout(void);
  59   \r\r\r
  60 #ifdef __cplusplus\r
  61 } \r
  62 #endif  /* \r */
  63 \r\r
  64 #endif  /* !__RUNNER_H */\r