trunk/test/redirectStdStreams.h

/*
 *  Standard stream redirection 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
 *  Centralized redirection of standard streams to file.
 *  Many ASCEND routines print messages.  In a testing context, it
 *  is usually preferable to have output redirected to a file.  This
 *  module provides a centralized location for this code (which may
 *  end up somewhat platform-dependent).
 *  <pre>
 *  Requires:     #include <stdio.h>
 *                #include "utilities/ascConfig.h"
 *
 */

#ifndef REDIRECTSTDSTREAMS_H_SEEN
#define REDIRECTSTDSTREAMS_H_SEEN

/**
 *  Redirects stderr to the specified file.
 *  Returns a pointer to the new stream.  If stderr was already being
 *  redirected to a file, the previous file is closed before the new
 *  redirection is set up.
 */
FILE *redirect_stderr(CONST char *filename);

/**
 *  Restores stderr to the console.
 *  This function closes the redirection file (if any) and
 *  restores stderr to console output.  It returns a pointer
 *  to the new stderr stream.

 */
FILE *reset_stderr(void);

/**
 *  Redirects stdin to the specified file.
 *  Returns a pointer to the new stream.  If stdin was already being
 *  redirected to a file, the previous file is closed before the new
 *  redirection is set up.
 */
FILE *redirect_stdin(CONST char *filename);

/**
 *  Restores stdin to the console.
 *  This function closes the redirection file (if any) and
 *  restores stdin to console output.  It returns a pointer
 *  to the new stdin stream.
 */
FILE *reset_stdin(void);

#endif  /* REDIRECTSTDSTREAMS_H_SEEN */
1	/*
2	* Standard stream redirection 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	* Centralized redirection of standard streams to file.
26	* Many ASCEND routines print messages. In a testing context, it
27	* is usually preferable to have output redirected to a file. This
28	* module provides a centralized location for this code (which may
29	* end up somewhat platform-dependent).
30	* <pre>
31	* Requires: #include <stdio.h>
32	* #include "utilities/ascConfig.h"
33	*
34	*/
35
36	#ifndef REDIRECTSTDSTREAMS_H_SEEN
37	#define REDIRECTSTDSTREAMS_H_SEEN
38
39	/**
40	* Redirects stderr to the specified file.
41	* Returns a pointer to the new stream. If stderr was already being
42	* redirected to a file, the previous file is closed before the new
43	* redirection is set up.
44	*/
45	FILE redirect_stderr(CONST char filename);
46
47	/**
48	* Restores stderr to the console.
49	* This function closes the redirection file (if any) and
50	* restores stderr to console output. It returns a pointer
51	* to the new stderr stream.
52
53	*/
54	FILE *reset_stderr(void);
55
56	/**
57	* Redirects stdin to the specified file.
58	* Returns a pointer to the new stream. If stdin was already being
59	* redirected to a file, the previous file is closed before the new
60	* redirection is set up.
61	*/
62	FILE redirect_stdin(CONST char filename);
63
64	/**
65	* Restores stdin to the console.
66	* This function closes the redirection file (if any) and
67	* restores stdin to console output. It returns a pointer
68	* to the new stdin stream.
69	*/
70	FILE *reset_stdin(void);
71
72	#endif /* REDIRECTSTDSTREAMS_H_SEEN */