Subversion Repositories tendra.SVN

/*

    		 Crown Copyright (c) 1997

    This TenDRA(r) Computer Program is subject to Copyright

    owned by the United Kingdom Secretary of State for Defence

    acting through the Defence Evaluation and Research Agency

    (DERA).  It is made available to Recipients with a

    royalty-free licence for its use, reproduction, transfer

    to other parties and amendment for any purpose not excluding

    product development provided that any such use et cetera

    shall be deemed to be acceptance of the following conditions:-

        (1) Its Recipients shall ensure that this Notice is

        reproduced upon any copies or amended versions of it;

        (2) Any amended version of it shall be clearly marked to

        show both the nature of and the organisation responsible

        for the relevant amendment or amendments;

        (3) Its onward transfer from a recipient to another

        party shall be deemed to be that party's acceptance of

        these conditions;

        (4) DERA gives no warranty or assurance as to its

        quality or suitability for any purpose and DERA accepts

        no liability whatsoever in relation to any use to which

        it may be put.

*/

/**** ostream.h --- Output stream handling.

 *

 ** Author: Steve Folkes <smf@hermes.mod.uk>

 *

 **** Commentary:

 *

 ***=== INTRODUCTION =========================================================

 *

 * This file specifies the interface to the output stream facility.

 *

 ***=== TYPES ================================================================

 *

 ** Type:	OStreamT

 ** Type:	OStreamP

 ** Repr:	<private>

 *

 * This is the output stream type.

 *

 ***=== CONSTANTS ============================================================

 *

 ** Constant:	ostream_output

 *

 * This is the standard output stream.  Its initial buffering state is

 * undefined.  The ``ostream_setup'' function must be called before this

 * constant is used.

 *

 ** Constant:	ostream_error

 *

 * This is the standard error stream.  Its initial buffering state is

 * undefined.  The ``ostream_setup'' function must be called before this

 * constant is used.

 *

 ***=== FUNCTIONS ============================================================

 *

 ** Function:	void			ostream_setup

 *			PROTO_S ((void))

 ** Exceptions:

 *

 * This function initialises the output stream facility.  It should be called

 * before any other ostream manipulation function.

 *

 ** Function:	void			ostream_init

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:

 *

 * This function initialises the specified ostream not to write to any file.

 *

 ** Function:	BoolT			ostream_open

 *			PROTO_S ((OStreamP ostream, CStringP name))

 ** Exceptions:

 *

 * This function initialises the specified ostream to write to the file with

 * the specified name.  If the file cannot be opened, the function returns

 * false.  If the file is opened successfully, the function returns true.  The

 * name should not be modified or deallocated until the ostream has been

 * closed.  The initial buffering state of the ostream is fully buffered.

 *

 ** Function:	BoolT			ostream_is_open

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:

 *

 * This function returns true if the specified ostream is writing to a file,

 * and false otherwise.

 *

 ** Function:	void			ostream_buffer

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:

 *

 * This function sets the buffering state of the specified ostream to fully

 * buffered.

 *

 ** Function:	void			ostream_unbuffer

 *			PROTO_S ((OStreamP ostream))

 *

 * This function sets the buffering state of the specified ostream to

 * unbuffered.

 *

 ** Function:	void			ostream_close

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function closes the specified ostream.

 *

 ** Function:	void			ostream_flush

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function flushes the ostream's output buffer.

 *

 ** Function:	CStringP		ostream_name

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:

 *

 * This function returns the name of the file that the specified ostream is

 * writing to.  The return value should not be modified or deallocated.

 *

 ** Function:	unsigned		ostream_line

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:

 *

 * This function returns one more than the number of newlines that have been

 * written to the specified ostream.  The result is undefined if the stream

 * is not open.

 *

 ** Function:	void			write_newline

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes a newline to the specified ostream.

 *

 ** Function:	void			write_tab

 *			PROTO_S ((OStreamP ostream))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes a tab to the specified ostream.

 *

 ** Function:	void			write_byte

 *			PROTO_S ((OStreamP ostream, ByteT c))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified byte to the specified ostream.

 *

 ** Function:	void			write_char

 *			PROTO_S ((OStreamP ostream, char c))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified character to the specified ostream.

 *

 ** Function:	void			write_escaped_char

 *			PROTO_S ((OStreamP ostream, char c))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified character to the specified ostream.

 * This differs from the ``write_char'' function, in that it will

 * `pretty-print' non-printing characters.

 *

 ** Function:	void			write_int

 *			PROTO_S ((OStreamP ostream, int i))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified integer to the specified ostream.

 *

 ** Function:	void			write_unsigned

 *			PROTO_S ((OStreamP ostream, unsigned i))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified unsigned integer to the specified

 * ostream.

 *

 ** Function:	void			write_cstring

 *			PROTO_S ((OStreamP ostream, CStringP cstring))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified C string to the specified ostream.

 *

 ** Function:	void			write_bytes

 *			PROTO_S ((OStreamP ostream, ByteP bytes,

 *				  unsigned length))

 ** Exceptions: XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified sequence of bytes (of the specified

 * length) to the specified ostream.

 *

 ** Function:	void			write_chars

 *			PROTO_S ((OStreamP ostream, CStringP chars,

 *				  unsigned length))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified sequence of characters (of the specified

 * length) to the specified ostream.

 *

 ** Function:	void			write_escaped_chars

 *			PROTO_S ((OStreamP ostream, CStringP chars,

 *				  unsigned length))

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes the specified sequence of characters (of the specified

 * length) to the specified ostream.  This differs from the ``write_chars''

 * function, in that it will `pretty-print' non-printing characters.

 *

 ** Function:	void			write_system_error

 *			PROTO_S ((OStreamP ostream));

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes a string containing a description of the current

 * system error (as defined by the ``errno'' global variable) to the specified

 * ostream.

 *

 ** Function:	void			write_pointer

 *			PROTO_S ((OStreamP ostream, GenericP pointer));

 ** Exceptions:	XX_dalloc_no_memory, XX_ostream_write_error

 *

 * This function writes a string containing the address of the object pointed

 * to by the pointer to the specified ostream.

 *

 ***=== EXCEPTIONS ===========================================================

 *

 ** Exception:	XX_ostream_write_error (CStringP name)

 *

 * This exception is raised if a write attempt fails.  The data thrown is a

 * copy of the name of the file on which the error occured.  The copy should

 * be deallocated when finished with.

 *

 **** Change Log:

 * $Log: ostream.h,v $

 * Revision 1.1.1.1  1998/01/17  15:57:18  release

 * First version to be checked into rolling release.

 *

 * Revision 1.2  1994/12/12  11:45:50  smf

 * Performing changes for 'CR94_178.sid+tld-update' - bringing in line with

 * OSSG C Coding Standards.

 *

 * Revision 1.1.1.1  1994/07/25  16:06:12  smf

 * Initial import of os-interface shared files.

 *

**/

/****************************************************************************/

#ifndef H_OSTREAM

#define H_OSTREAM

#include "os-interface.h"

#include "dalloc.h"

#include "exception.h"

/*--------------------------------------------------------------------------*/

typedef struct OStreamT {

    FILE		       *file;

    CStringP			name;

    unsigned			line;

} OStreamT, *OStreamP;

/*--------------------------------------------------------------------------*/

extern ExceptionP		XX_ostream_write_error;

extern OStreamT		 *const ostream_output;

extern OStreamT		 *const ostream_error;

/*--------------------------------------------------------------------------*/

extern void			ostream_setup

	PROTO_S ((void));

extern void			ostream_init

	PROTO_S ((OStreamP));

extern BoolT			ostream_open

	PROTO_S ((OStreamP, CStringP));

extern BoolT			ostream_is_open

	PROTO_S ((OStreamP));

extern void			ostream_buffer

	PROTO_S ((OStreamP));

extern void			ostream_unbuffer

	PROTO_S ((OStreamP));

extern void			ostream_close

	PROTO_S ((OStreamP));

extern void			ostream_flush

	PROTO_S ((OStreamP));

extern CStringP			ostream_name

	PROTO_S ((OStreamP));

extern unsigned			ostream_line

	PROTO_S ((OStreamP));

extern void			write_newline

	PROTO_S ((OStreamP));

extern void			write_tab

	PROTO_S ((OStreamP));

extern void			write_byte

	PROTO_S ((OStreamP, ByteT));

extern void			write_char

	PROTO_S ((OStreamP, char));

extern void			write_escaped_char

	PROTO_S ((OStreamP, char));

extern void			write_int

	PROTO_S ((OStreamP, int));

extern void			write_unsigned

	PROTO_S ((OStreamP, unsigned));

extern void			write_cstring

	PROTO_S ((OStreamP, CStringP));

extern void			write_bytes

	PROTO_S ((OStreamP, ByteP, unsigned));

extern void			write_chars

	PROTO_S ((OStreamP, CStringP, unsigned));

extern void			write_escaped_chars

	PROTO_S ((OStreamP, CStringP, unsigned));

extern void			write_system_error

	PROTO_S ((OStreamP));

extern void			write_pointer

	PROTO_S ((OStreamP, GenericP));

/*--------------------------------------------------------------------------*/

#ifdef FS_FAST

#define ostream_init(os) ((os)->name = NIL (CStringP))

#define ostream_is_open(os) ((os)->name != NIL (CStringP))

#define ostream_name(os) ((os)->name)

#define ostream_line(os) ((os)->line)

#endif /* defined (FS_FAST) */

#endif /* !defined (H_OSTREAM) */