More debianization
[erwise] / Cl / WWWLibrary / HTAccess.h
1 /*              Access Manager                                  HTAccess.h
2 **              ==============
3 */
4
5 #ifndef HTACCESS_H
6 #define HTACCESS_H
7
8 /*      Flag to allow source to be loaded as text
9 */
10 extern int HTDiag;
11
12 /*      Open a file descriptor for a document
13 **      -------------------------------------
14 **
15 ** On entry,
16 **      addr            must point to the fully qualified hypertext reference.
17 **
18 ** On exit,
19 **      returns         <0      Error has occured.
20 **                      >=0     Value of file descriptor or socket to be used
21 **                               to read data.
22 **      *pFormat        Set to the format of the file, if known.
23 **                      (See WWW.h)
24 **
25 ** No longer public -- only used internally.
26 */
27 /* extern int HTOpen PARAMS((CONST char * addr, HTFormat * format)); */
28
29
30 /*      Close socket opened for reading a file
31 **      --------------------------------------
32 **
33 */
34 extern int HTClose PARAMS((int soc));
35
36
37 /*              Load a document
38 **              ---------------
39 **
40 **    On Entry,
41 **        anchor            is the node_anchor for the document
42 **        full_address      The address of the file to be accessed.
43 **
44 **    On Exit,
45 **        returns    YES     Success in opening file
46 **                   NO      Failure 
47 **
48 */
49
50 extern BOOL HTLoadDocument PARAMS((HTParentAnchor * anchor,
51         CONST char * full_address,
52         BOOL    filter));
53
54
55
56 /*              Load a document from relative name
57 **              ---------------
58 **
59 **    On Entry,
60 **        relative_name     The relative address of the file to be accessed.
61 **
62 **    On Exit,
63 **        returns    YES     Success in opening file
64 **                   NO      Failure 
65 **
66 **
67 */
68
69 extern  BOOL HTLoadRelative PARAMS((CONST char * relative_name));
70
71 /*              Load a document from relative name
72 **              ---------------
73 **
74 **    On Entry,
75 **        relative_name     The relative address of the file to be accessed.
76 **
77 **    On Exit,
78 **        returns    YES     Success in opening file
79 **                   NO      Failure 
80 **
81 **
82 */
83
84 extern BOOL HTLoadAbsolute PARAMS((CONST char * addr, BOOL filter));
85
86
87 /*              Load if necessary, and select an anchor
88 **              --------------------------------------
89 **
90 **    On Entry,
91 **        destination               The child or parenet anchor to be loaded.
92 **
93 **    On Exit,
94 **        returns    YES     Success
95 **                   NO      Failure 
96 **
97 */
98
99 extern BOOL HTLoadAnchor PARAMS((HTAnchor * destination));
100
101 /*              Search
102 **              ------
103 **  Performs a keyword search on word given by the user. Adds the keyword to 
104 **  the end of the current address and attempts to open the new address.
105 **
106 **  On Entry,
107 **       *keywords      space-separated keyword list or similar search list
108 **      HTMainAnchor    global must be valid.
109 */
110
111 extern BOOL HTSearch PARAMS((char * keywords));
112
113
114 #endif /* HTACCESS_H */