BuffInp.h File Reference

Header file for BuffInp.c. More...

#include <stdio.h>
#include "SysDefs.h"
#include "deprecated.h"

Go to the source code of this file.

Data Structures
struct	INBUFFER

Macros
#define	_BUFFINPUT_H_DEPRECATED

Functions
INBUFFER *	blOpenBufferedFile (char *filename, int maxstr)
BOOL	blReadBufferedFile (INBUFFER *bfp, char *string, int length)
BOOL	blProbeBufferedFile (INBUFFER *bfp, char *string, int length)

Detailed Description

Header file for BuffInp.c.

Version

V1.3

Date

14.08.14

Copyright

(c) UCL / Dr. Andrew C. R. Martin 1994-2014

Author

Dr. Andrew C. R. Martin

Institute of Structural & Molecular Biology, University College London, Gower Street, London. WC1E 6BT.

andre.nosp@m.w@bi.nosp@m.oinf..nosp@m.org..nosp@m.uk andre.nosp@m.w.ma.nosp@m.rtin@.nosp@m.ucl..nosp@m.ac.uk

This code is NOT IN THE PUBLIC DOMAIN, but it may be copied according to the conditions laid out in the accompanying file COPYING.DOC.

The code may be modified as required, but any modifications must be documented so that the person responsible can be identified.

The code may not be sold commercially or included as part of a commercial product except as described in the file COPYING.DOC.

Description:

Usage:

Revision History:

• V1.1 07.07.14 Use bl prefix for functions By: CTP
• V1.2 31.07.14 Updated deprecation: Removed deprecated.h and added prototypes for renamed functions. By: CTP
• V1.3 14.08.14 Moved deprecated function prototypes to deprecated.h By: CTP

Definition in file BuffInp.h.

Macro Definition Documentation

#define _BUFFINPUT_H_DEPRECATED

Definition at line 86 of file BuffInp.h.

Function Documentation

INBUFFER* blOpenBufferedFile	(	char *	filename,
		int	maxstr
	)

Parameters

[in]	*filename	File name
[in]	maxstr	Max string length in file for buffering

Returns

Pointer to a buffered file

Open a file for buffered input. This allows probe-ahead to look at the contents of the next line without removing it from the input stream.

• 28.02.94 Original By: ACRM
• 03.03.94 If filename is NULL, make file stdin
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 115 of file BuffInp.c.

BOOL blProbeBufferedFile	(	INBUFFER *	bfp,
		char *	string,
		int	length
	)

Parameters

[in]	*bfp	Pointer to a buffered file structure
[in]	length	Size of output string
[out]	*string	Output string read from file

Returns

TRUE: Successful read FALSE: End of file (or error)

Read the next line from a buffered file without removing it from the input stream. Repeated calls will thus return the same string. The next call to ReadBufferedFile will also output the same string, but will remove the line from the input stream. Blank lines in the file will be skipped.

• 28.02.94 Original By: ACRM
• 07.03.94 Added code to skip blank lines
• 10.03.94 Added call to RePrompt() after blank line
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 217 of file BuffInp.c.

BOOL blReadBufferedFile	(	INBUFFER *	bfp,
		char *	string,
		int	length
	)

Parameters

[in]	*bfp	Pointer to a buffered file structure
[in]	length	Size of output string
[out]	*string	Output string read from file

Returns

TRUE: Successful read FALSE: End of file (or error)

Reads a line from a buffered file (like fgets()). Blank lines in the file will be skipped.

• 28.02.94 Original By: ACRM
• 07.03.94 Added code to skip blank lines
• 10.03.94 Added call to RePrompt() if we're reading from stdin and we get a blank line
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 161 of file BuffInp.c.