trunk/test/printutil.h

/*
 *  Print support utilities for ASCEND unit tests
 *
 *  Copyright (C) 2005 Jerry St.Clair
 *
 *  This file is part of the Ascend Environment.
 *
 *  The Ascend Environment 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 of the
 *  License, or (at your option) any later version.
 *
 *  The Ascend Environment is distributed in 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 the program; if not, write to the Free Software Foundation,
 *  Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check the file named
 *  COPYING.
 */

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