Bioplib
Protein Structure C Library
 All Data Structures Files Functions Variables Typedefs Macros Pages
BuffInp.h
Go to the documentation of this file.
1 /************************************************************************/
2 /**
3 
4  \file BuffInp.h
5 
6  \version V1.3
7  \date 14.08.14
8  \brief Header file for BuffInp.c
9 
10  \copyright (c) UCL / Dr. Andrew C. R. Martin 1994-2014
11  \author Dr. Andrew C. R. Martin
12  \par
13  Institute of Structural & Molecular Biology,
14  University College London,
15  Gower Street,
16  London.
17  WC1E 6BT.
18  \par
19  andrew@bioinf.org.uk
20  andrew.martin@ucl.ac.uk
21 
22 **************************************************************************
23 
24  This code is NOT IN THE PUBLIC DOMAIN, but it may be copied
25  according to the conditions laid out in the accompanying file
26  COPYING.DOC.
27 
28  The code may be modified as required, but any modifications must be
29  documented so that the person responsible can be identified.
30 
31  The code may not be sold commercially or included as part of a
32  commercial product except as described in the file COPYING.DOC.
33 
34 **************************************************************************
35 
36  Description:
37  ============
38 
39 
40 **************************************************************************
41 
42  Usage:
43  ======
44 
45 **************************************************************************
46 
47  Revision History:
48  =================
49 
50 - V1.1 07.07.14 Use bl prefix for functions By: CTP
51 - V1.2 31.07.14 Updated deprecation: Removed deprecated.h and added
52  prototypes for renamed functions. By: CTP
53 - V1.3 14.08.14 Moved deprecated function prototypes to deprecated.h
54  By: CTP
55 
56 *************************************************************************/
57 #ifndef _BUFFINPUT_H
58 #define _BUFFINPUT_H
59 
60 /************************************************************************/
61 /* Includes
62 */
63 #include <stdio.h>
64 #include "SysDefs.h"
65 
66 /************************************************************************/
67 /* Defines
68 */
69 typedef struct
70 {
71  FILE *fp;
72  char *buffer;
73  int nlines,
74  maxstr;
75 } INBUFFER;
76 
77 /************************************************************************/
78 /* Prototypes
79 */
80 INBUFFER *blOpenBufferedFile(char *filename, int maxstr);
81 BOOL blReadBufferedFile(INBUFFER *bfp, char *string, int length);
82 BOOL blProbeBufferedFile(INBUFFER *bfp, char *string, int length);
83 
84 /************************************************************************/
85 /* Include deprecated functions */
86 #define _BUFFINPUT_H_DEPRECATED
87 #include "deprecated.h"
88 /************************************************************************/
89 
90 #endif
INBUFFER::fp
FILE * fp
Definition: BuffInp.h:71
blReadBufferedFile
BOOL blReadBufferedFile(INBUFFER *bfp, char *string, int length)
Definition: BuffInp.c:161
blOpenBufferedFile
INBUFFER * blOpenBufferedFile(char *filename, int maxstr)
Definition: BuffInp.c:115
BOOL
short BOOL
Definition: SysDefs.h:64
blProbeBufferedFile
BOOL blProbeBufferedFile(INBUFFER *bfp, char *string, int length)
Definition: BuffInp.c:217
deprecated.h
Redirect calls to deprecated functions.
INBUFFER::buffer
char * buffer
Definition: BuffInp.h:72
INBUFFER::nlines
int nlines
Definition: BuffInp.h:73
SysDefs.h
System-type variable type definitions.
Generated on Tue Oct 24 2017 10:57:04 for Bioplib by   doxygen 1.8.8