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, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//**
    @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	johnpye	607	/* ASCEND modelling environment
2			Copyright (C) 2005 Jerry St.Clair
3			Copyright (C) 2006 Carnegie Mellon University
4	jds	59
5	johnpye	607	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	jds	59
10	johnpye	607	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, write to the Free Software
17			Foundation, Inc., 59 Temple Place - Suite 330,
18			Boston, MA 02111-1307, USA.
19			//*
20			@file
21			Print support utilities for ASCEND unit tests
22
23			These functions provide support for managing a print vtable
24			for use during unit testing.
25			*/
26
27	jds	59	#ifndef PRINTUTIL_H_SEEN
28			#define PRINTUTIL_H_SEEN
29
30	johnpye	607	/**
31	jds	59	* Enables printing of ASCEND messages to the console.
32			* @return Returns 1 if an error occurs, 0 otherwise.
33			*/
34			int test_enable_printing(void);
35
36			/**
37			* Disables printing of ASCEND messages to the console.
38			*/
39			void test_disable_printing(void);
40
41			/**
42			* Queries whether printing to the console is enabled.
43			* @return Returns TRUE if printing is enabled, FALSE otherwise.
44			*/
45			int test_printing_enabled(void);
46
47			#endif /* PRINTUTIL_H_SEEN */