File: headertypes.h

package info (click to toggle)
robodoc 4.99.34-3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 1,468 kB
  • ctags: 1,009
  • sloc: ansic: 14,040; sh: 3,635; makefile: 163; perl: 155
file content (49 lines) | stat: -rw-r--r-- 1,379 bytes parent folder | download
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
#ifndef ROBODOC_HEADERTYPES_H
#define ROBODOC_HEADERTYPES_H

/****s* Headers/RB_HeaderType
 * NAME
 *   RB_HeaderType -- Information about a header type
 * ATTRIBUTES
 *   o typeCharacter -- The character used to indicate it 
 *   o indexName     -- The name used for the master index 
 *   o fileName      -- The name of the file use to store 
 *                      the master index for this type of headers.
 *   o priority      -- The sorting priority of this header.
 *                      Higher priorities appear first
 * SOURCE
 */

struct RB_HeaderType
{
    unsigned char       typeCharacter;
    char               *indexName;
    char               *fileName;
    unsigned int        priority;
};

/*******/

#define HT_SOURCEHEADERTYPE ((unsigned char)1)
#define HT_MASTERINDEXTYPE  ((unsigned char)2)

#define MIN_HEADER_TYPE 1       /* ' ' */
#define MAX_HEADER_TYPE 127


int                 RB_AddHeaderType(
    unsigned int typeCharacter,
    char *indexName,
    char *indexFile,
    unsigned int priority );
struct RB_HeaderType *RB_FindHeaderType(
    unsigned char typeCharacter );
void                RB_InitHeaderTypes(
    void );
int                 RB_IsInternalHeader(
    unsigned char type_character );
int                 RB_CompareHeaderTypes(
    struct RB_HeaderType *ht1,
    struct RB_HeaderType *ht2 );

#endif /* ROBODOC_HEADERTYPES_H */