File: loadfile.h

package info (click to toggle)
lookup 1.08b-5
  • links: PTS
  • area: contrib
  • in suites: woody
  • size: 1,108 kB
  • ctags: 1,305
  • sloc: ansic: 12,634; makefile: 236; perl: 174; sh: 53
file content (66 lines) | stat: -rw-r--r-- 2,034 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
#ifndef __LOADFILE_H__ /* file wrapper */
#define __LOADFILE_H__
/*
 * Jeffrey Friedl
 * Omron Corporation			ʳ
 * Nagaokakyoshi, Japan			617Ĺ
 *
 * jfriedl@nff.ncl.omron.co.jp
 *
 * This work is placed under the terms of the GNU General Purpose License
 * (the "GNU Copyleft").
 *
 * October 1993
 *
 * Routine to load a file and to load, create, and/or write an accompanying
 * index. WRT loadfile, a "file" is a rather high-level object that has
 * an index and other substructures associated with it.
 *
 * On a lower level is "readfile" which deals with filesystem files
 * as singular entities.
 */

#define loadfile_version 102 /* 1.02 */
#include "longlinenote.h"
#include "index.h"
#include "virtfile.h"

/*
 * Info about a loaded file. Here, a "file" is rather high-level concept.
 */
struct fileinfo
{
    VirtFile *v;                        /* pointer to virtual file */
    const char *short_filename;         /* short name of file */
    const struct index *index;		/* index for file */
    const char *indexfile;              /* name of file index was read from */
};


/*
 * Load a named text file, and automatically load or calculate an index
 * for it. Also can write the index to a file (these options controlled
 * by the FLAGS given below).
 */
extern struct fileinfo *
    loadfile(const char *filename, unsigned percent, unsigned flags);

/* These flags must be distinct from those in index.h */
#define LOADFILE_WRITEINDEX    0x00010000
#define LOADFILE_READINDEX     0x00020000
#define LOADFILE_NO_MEM_INDEX  0x00040000
#define LOADFILE_READifPRESENT 0x00080000
/*
 * File extension expected for index read and written by loadfile.
 */
#define LOADFILE_INDEX_EXTENTION   ".jin" /* jeff's index */


/*
 * Given the name of a text file, return the name of its associated index
 * file (or what it would be called were it to exist). The returned string
 * should eventually be free'd by the user.
 */
extern char *indexfile_name(const char *datafile_name);

#endif /* file wrapper */