trunk/test/printutil.h

/*  ASCEND modelling environment
    Copyright (C) 2005 Jerry St.Clair
    Copyright (C) 2006 Carnegie Mellon University

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2, or (at your option)
    any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*//**
    @file
    Print support utilities for ASCEND unit tests

    These functions provide support for managing a print vtable
    for use during unit testing.
*/

#ifndef PRINTUTIL_H_SEEN
#define PRINTUTIL_H_SEEN

/**
 *  Enables printing of ASCEND messages to the console.
 *  @return Returns 1 if an error occurs, 0 otherwise.
 */
int test_enable_printing(void);

/**
 *  Disables printing of ASCEND messages to the console.
 */
void test_disable_printing(void);

/**
 *  Queries whether printing to the console is enabled.
 *  @return Returns TRUE if printing is enabled, FALSE otherwise.
 */
int test_printing_enabled(void);

#endif  /* PRINTUTIL_H_SEEN */
1	/* ASCEND modelling environment
2	Copyright (C) 2005 Jerry St.Clair
3	Copyright (C) 2006 Carnegie Mellon University
4
5	This program is free software; you can redistribute it and/or modify
6	it under the terms of the GNU General Public License as published by
7	the Free Software Foundation; either version 2, or (at your option)
8	any later version.
9
10	This program is distributed in the hope that it will be useful,
11	but WITHOUT ANY WARRANTY; without even the implied warranty of
12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	GNU General Public License for more details.
14
15	You should have received a copy of the GNU General Public License
16	along with this program. If not, see <http://www.gnu.org/licenses/>.
17	//*
18	@file
19	Print support utilities for ASCEND unit tests
20
21	These functions provide support for managing a print vtable
22	for use during unit testing.
23	*/
24
25	#ifndef PRINTUTIL_H_SEEN
26	#define PRINTUTIL_H_SEEN
27
28	/**
29	* Enables printing of ASCEND messages to the console.
30	* @return Returns 1 if an error occurs, 0 otherwise.
31	*/
32	int test_enable_printing(void);
33
34	/**
35	* Disables printing of ASCEND messages to the console.
36	*/
37	void test_disable_printing(void);
38
39	/**
40	* Queries whether printing to the console is enabled.
41	* @return Returns TRUE if printing is enabled, FALSE otherwise.
42	*/
43	int test_printing_enabled(void);
44
45	#endif /* PRINTUTIL_H_SEEN */