2 * include/runner.h - type representing the tesh runner .
\r
4 * Copyright 2008,2009 Martin Quinson, Malek Cherier All right reserved.
\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
10 * This file contains all the declarations of the functions related with
\r
11 * the tesh runner type.
\r
24 /*! \brief runner_init - initialize the tesh runner.
\r
26 * \param check_syntax_flag If 1, the runner check the syntax of all the tesh files before running.
\r
27 * \param timeout The time alloted to the run of all the units (if -1 no time alloted).
\r
28 * \param fstreams A fstreams object containing the file streams representing the tesh files to run.
\r
30 * \return If successful the function returns 0. Otherwise the function returns -1 and sets
\r
31 * the global variable errno with the appropiate error code.
\r
34 * [EALREADY] if the runner is already initialized.
\r
35 * [ENOMEM] if the system has not enough space to initialize the runner.
\r
36 * [ESYNTAX] if the parameter check_syntax_flag is 1 and a syntax error is detected.
\r
39 runner_init(/*int check_syntax_flag, */int timeout, fstreams_t fstreams);
\r
41 /*! \brief runner_run - run the tesh files.
\r
46 /*! \brief runner_destroy - destroy the runner (release all the resources allocated by the runner)
\r
49 runner_destroy(void);
\r
51 /*! \brief runner_summarize - display the summary of the execution of all the tests of the tesh files.
\r
54 runner_summarize(void);
\r
56 /*! \brief runner_interrupt - interrupt all the units of the run.
\r
59 runner_interrupt(void);
\r
62 runner_is_timedout(void);
\r
70 #endif /* !__RUNNER_H */
\r