diff options
Diffstat (limited to 'WWW/Library/Implementation/HTAccess.h')
| -rw-r--r-- | WWW/Library/Implementation/HTAccess.h | 96 |
1 files changed, 47 insertions, 49 deletions
diff --git a/WWW/Library/Implementation/HTAccess.h b/WWW/Library/Implementation/HTAccess.h index 32d8e562..3dc91793 100644 --- a/WWW/Library/Implementation/HTAccess.h +++ b/WWW/Library/Implementation/HTAccess.h @@ -1,12 +1,12 @@ /* HTAccess: Access manager for libwww ACCESS MANAGER - + This module keeps a list of valid protocol (naming scheme) specifiers with associated access code. It allows documents to be loaded given various combinations of - parameters. New access protocols may be registered at any time. - + parameters. New access protocols may be registered at any time. + Part of the libwww library . - + */ #ifndef HTACCESS_H #define HTACCESS_H @@ -32,16 +32,14 @@ extern char * use_this_url_instead; ** In general, positive codes are OK and negative ones are bad. */ -#define HT_NO_DATA -9999 /* return code: OK but no data was loaded */ - /* Typically, other app started or forked */ /* Default Addresses - These control the home page selection. To mess with these for normal browses is asking + These control the home page selection. To mess with these for normal browses is asking for user confusion. - + */ #define LOGICAL_DEFAULT "WWW_HOME" /* Defined to be the home page */ @@ -111,17 +109,17 @@ extern BOOL override_proxy PARAMS(( Load a document from relative name ON ENTRY, - + relative_name The relative address of the file to be accessed. - + here The anchor of the object being searched - + ON EXIT, - + returns YES Success in opening file - + NO Failure - + */ extern BOOL HTLoadRelative PARAMS(( CONST char * relative_name, @@ -133,25 +131,25 @@ extern BOOL HTLoadRelative PARAMS(( Load a document from absolute name ON ENTRY, - + addr The absolute address of the document to be accessed. - + filter_it if YES, treat document as HTML - + */ /* ON EXIT, - + */ /* returns YES Success in opening document - + NO Failure - + */ extern BOOL HTLoadAbsolute PARAMS((CONST DocAddress * addr)); @@ -161,19 +159,19 @@ extern BOOL HTLoadAbsolute PARAMS((CONST DocAddress * addr)); Load a document from absolute name to a stream ON ENTRY, - + addr The absolute address of the document to be accessed. - + filter_it if YES, treat document as HTML - + ON EXIT, - + returns YES Success in opening document - + NO Failure - + Note: This is equivalent to HTLoadDocument - + */ extern BOOL HTLoadToStream PARAMS((CONST char * addr, BOOL filter_it, HTStream * sink)); @@ -184,23 +182,23 @@ extern BOOL HTLoadToStream PARAMS((CONST char * addr, BOOL filter_it, Load if necessary, and select an anchor ON ENTRY, - + destination The child or parenet anchor to be loaded. - + */ /* ON EXIT, - + */ /* returns YES Success - + returns NO Failure - + */ @@ -213,13 +211,13 @@ extern BOOL HTLoadAnchor PARAMS((HTAnchor * destination)); Make a stream for Saving object back ON ENTRY, - + anchor is valid anchor which has previously beeing loaded - + ON EXIT, - + returns 0 if error else a stream to save the object to. - + */ @@ -230,15 +228,15 @@ extern HTStream * HTSaveStream PARAMS((HTParentAnchor * anchor)); Search - Performs a search on word given by the user. Adds the search words to the end of the + Performs a search on word given by the user. Adds the search words to the end of the current address and attempts to open the new address. - + ON ENTRY, - + *keywords space-separated keyword list or similar search list - + here The anchor of the object being searched - + */ extern BOOL HTSearch PARAMS((CONST char * keywords, HTParentAnchor* here)); @@ -247,15 +245,15 @@ extern BOOL HTSearch PARAMS((CONST char * keywords, HTParentAnchor* here)); Search Given Indexname - Performs a keyword search on word given by the user. Adds the keyword to the end of + Performs a keyword search on word given by the user. Adds the keyword to the end of the current address and attempts to open the new address. - + ON ENTRY, - + *keywords space-separated keyword list or similar search list - + *indexname is name of object search is to be done on. - + */ extern BOOL HTSearchAbsolute PARAMS(( CONST char * keywords, @@ -270,13 +268,13 @@ Register an access method typedef struct _HTProtocol { char * name; - + int (*load)PARAMS(( CONST char * full_address, HTParentAnchor * anchor, HTFormat format_out, HTStream* sink)); - + HTStream* (*saveStream)PARAMS((HTParentAnchor * anchor)); } HTProtocol; @@ -294,7 +292,7 @@ Generate the anchor for the home page As it involves file access, this should only be done once when the program first runs. This is a default algorithm -- browser don't HAVE to use this. - + */ extern HTParentAnchor * HTHomeAnchor NOPARAMS; |