NVBIO
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mFILE.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2005-2006, 2008-2009 Genome Research Ltd.
3 Author: James Bonfield <jkb@sanger.ac.uk>
4 
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
7 
8  1. Redistributions of source code must retain the above copyright notice,
9 this list of conditions and the following disclaimer.
10 
11  2. Redistributions in binary form must reproduce the above copyright notice,
12 this list of conditions and the following disclaimer in the documentation
13 and/or other materials provided with the distribution.
14 
15  3. Neither the names Genome Research Ltd and Wellcome Trust Sanger
16 Institute nor the names of its contributors may be used to endorse or promote
17 products derived from this software without specific prior written permission.
18 
19 THIS SOFTWARE IS PROVIDED BY GENOME RESEARCH LTD AND CONTRIBUTORS "AS IS" AND
20 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL GENOME RESEARCH LTD OR CONTRIBUTORS BE LIABLE
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 
31 #ifndef _MFILE_H_
32 #define _MFILE_H_
33 
34 #include <stdio.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 typedef struct {
41  FILE *fp;
42  char *data;
43  size_t alloced;
44  int eof;
45  int mode; /* open mode in MF_?? define bit pattern */
46  size_t size;
47  size_t offset;
48  size_t flush_pos;
49 } mFILE;
50 
51 #define MF_READ 1
52 #define MF_WRITE 2
53 #define MF_APPEND 4
54 #define MF_BINARY 8
55 #define MF_TRUNC 16
56 #define MF_MODEX 32
57 
58 mFILE *mfreopen(const char *path, const char *mode, FILE *fp);
59 mFILE *mfopen(const char *path, const char *mode);
60 int mfdetach(mFILE *mf);
61 int mfclose(mFILE *mf);
62 int mfdestroy(mFILE *mf);
63 int mfseek(mFILE *mf, long offset, int whence);
64 long mftell(mFILE *mf);
65 void mrewind(mFILE *mf);
66 void mftruncate(mFILE *mf, long offset);
67 int mfeof(mFILE *mf);
68 size_t mfread(void *ptr, size_t size, size_t nmemb, mFILE *mf);
69 size_t mfwrite(void *ptr, size_t size, size_t nmemb, mFILE *mf);
70 int mfgetc(mFILE *mf);
71 int mungetc(int c, mFILE *mf);
72 mFILE *mfcreate(char *data, int size);
73 mFILE *mfcreate_from(const char *path, const char *mode_str, FILE *fp);
74 void mfrecreate(mFILE *mf, char *data, int size);
75 void *mfsteal(mFILE *mf, size_t *size_out);
76 char *mfgets(char *s, int size, mFILE *mf);
77 int mfflush(mFILE *mf);
78 int mfprintf(mFILE *mf, char *fmt, ...);
79 mFILE *mstdin(void);
80 mFILE *mstdout(void);
81 mFILE *mstderr(void);
82 void mfascii(mFILE *mf);
83 
84 #ifdef __cplusplus
85 }
86 #endif
87 
88 #endif /* _MFILE_H_ */