diff options
Diffstat (limited to 'WWW/Library/Implementation/HTAnchor.h')
| -rw-r--r-- | WWW/Library/Implementation/HTAnchor.h | 514 |
1 files changed, 229 insertions, 285 deletions
diff --git a/WWW/Library/Implementation/HTAnchor.h b/WWW/Library/Implementation/HTAnchor.h index bd29fede..22a9c323 100644 --- a/WWW/Library/Implementation/HTAnchor.h +++ b/WWW/Library/Implementation/HTAnchor.h @@ -2,11 +2,11 @@ */ /* Hypertext "Anchor" Object HTAnchor.h -** ========================== -** -** An anchor represents a region of a hypertext document which is linked -** to another anchor in the same or a different document. -*/ + * ========================== + * + * An anchor represents a region of a hypertext document which is linked + * to another anchor in the same or a different document. + */ #ifndef HTANCHOR_H #define HTANCHOR_H @@ -21,10 +21,10 @@ #include <UCDefs.h> /* Main definition of anchor -** ========================= -*/ + * ========================= + */ -typedef struct _HyperDoc HyperDoc; /* Ready for forward references */ +typedef struct _HyperDoc HyperDoc; /* Ready for forward references */ typedef struct _HTAnchor HTAnchor; typedef struct _HTParentAnchor HTParentAnchor; typedef struct _HTParentAnchor0 HTParentAnchor0; @@ -32,26 +32,25 @@ typedef struct _HTParentAnchor0 HTParentAnchor0; /* After definition of HTFormat: */ #include <HTFormat.h> - struct _HTAnchor { /* Generic anchor */ - HTParentAnchor0 * parent; /* Parent of this anchor (self for adults) */ + HTParentAnchor0 *parent; /* Parent of this anchor (self for adults) */ }; struct _HTParentAnchor0 { /* One for adult_table, * generally not used outside HTAnchor.c */ - /* Common part from the generic anchor structure */ - HTParentAnchor0 * parent; /* (self) */ + /* Common part from the generic anchor structure */ + HTParentAnchor0 *parent; /* (self) */ - /* ParentAnchor0-specific information */ - char * address; /* Absolute address of this node */ - HTParentAnchor * info; /* additional info, allocated on demand */ + /* ParentAnchor0-specific information */ + char *address; /* Absolute address of this node */ + HTParentAnchor *info; /* additional info, allocated on demand */ - HTBTree * children; /* Subanchors <a name="tag">, sorted by tag */ - HTList sources; /* List of anchors pointing to this, if any */ + HTBTree *children; /* Subanchors <a name="tag">, sorted by tag */ + HTList sources; /* List of anchors pointing to this, if any */ - HTList _add_adult; /* - just a memory for list entry:) */ - short adult_hash; /* adult list number */ - BOOL underway; /* Document about to be attached to it */ + HTList _add_adult; /* - just a memory for list entry:) */ + short adult_hash; /* adult list number */ + BOOL underway; /* Document about to be attached to it */ }; /* @@ -62,387 +61,332 @@ struct _HTParentAnchor0 { /* One for adult_table, * in HTAnchor_findAddress() and HTAnchor_parent()]. */ struct _HTParentAnchor { - /* Common part from the generic anchor structure */ - HTParentAnchor0 * parent; /* Parent of this anchor */ - - /* ParentAnchor-specific information */ - HTList children_notag; /* Subanchors <a href=...>, tag is NULL */ - HyperDoc * document; /* The document within which this is an anchor*/ - - char * address; /* parent->address, a pointer */ - bstring * post_data; /* Posting data */ - char * post_content_type; /* Type of post data */ - char * bookmark; /* Bookmark filename */ - HTFormat format; /* Pointer to node format descriptor */ - char * charset; /* Pointer to character set (kludge, for now */ - BOOL isIndex; /* Acceptance of a keyword search */ - char * isIndexAction; /* URL of isIndex server */ - char * isIndexPrompt; /* Prompt for isIndex query */ - char * title; /* Title of document */ - char * owner; /* Owner of document */ - char * RevTitle; /* TITLE in REV="made" or REV="owner" LINK */ - char * citehost; /* Citehost from REL="citehost" LINK */ + /* Common part from the generic anchor structure */ + HTParentAnchor0 *parent; /* Parent of this anchor */ + + /* ParentAnchor-specific information */ + HTList children_notag; /* Subanchors <a href=...>, tag is NULL */ + HyperDoc *document; /* The document within which this is an anchor */ + + char *address; /* parent->address, a pointer */ + bstring *post_data; /* Posting data */ + char *post_content_type; /* Type of post data */ + char *bookmark; /* Bookmark filename */ + HTFormat format; /* Pointer to node format descriptor */ + char *charset; /* Pointer to character set (kludge, for now */ + BOOL isIndex; /* Acceptance of a keyword search */ + char *isIndexAction; /* URL of isIndex server */ + char *isIndexPrompt; /* Prompt for isIndex query */ + char *title; /* Title of document */ + char *owner; /* Owner of document */ + char *RevTitle; /* TITLE in REV="made" or REV="owner" LINK */ + char *citehost; /* Citehost from REL="citehost" LINK */ #ifdef USE_COLOR_STYLE - char * style; + char *style; #endif - HTList* methods; /* Methods available as HTAtoms */ - void * protocol; /* Protocol object */ - char * physical; /* Physical address */ - BOOL isISMAPScript; /* Script for clickable image map */ - BOOL isHEAD; /* Document is headers from a HEAD request */ - BOOL safe; /* Safe */ + HTList *methods; /* Methods available as HTAtoms */ + void *protocol; /* Protocol object */ + char *physical; /* Physical address */ + BOOL isISMAPScript; /* Script for clickable image map */ + BOOL isHEAD; /* Document is headers from a HEAD request */ + BOOL safe; /* Safe */ #ifdef USE_SOURCE_CACHE - char * source_cache_file; - HTChunk * source_cache_chunk; + char *source_cache_file; + HTChunk *source_cache_chunk; #endif - char * FileCache; /* Path to a disk-cached copy (see src/HTFWriter.c) */ - char * SugFname; /* Suggested filename */ - char * cache_control; /* Cache-Control */ - BOOL no_cache; /* Cache-Control, Pragma or META "no-cache"? */ - BOOL inBASE; /* duplicated from HTStructured (HTML.c/h) */ - char * content_type; /* Content-Type */ - char * content_language; /* Content-Language */ - char * content_encoding; /* Compression algorithm */ - char * content_base; /* Content-Base */ - char * content_disposition; /* Content-Disposition */ - char * content_location; /* Content-Location */ - char * content_md5; /* Content-MD5 */ - char * message_id; /* Message-ID */ - char * subject; /* Subject */ - int content_length; /* Content-Length */ - char * date; /* Date */ - char * expires; /* Expires */ - char * last_modified; /* Last-Modified */ - char * ETag; /* ETag (HTTP1.1 cache validator) */ - char * server; /* Server */ - UCAnchorInfo *UCStages; /* chartrans stages */ - HTList * imaps; /* client side image maps */ + char *FileCache; /* Path to a disk-cached copy (see src/HTFWriter.c) */ + char *SugFname; /* Suggested filename */ + char *cache_control; /* Cache-Control */ + BOOL no_cache; /* Cache-Control, Pragma or META "no-cache"? */ + BOOL inBASE; /* duplicated from HTStructured (HTML.c/h) */ + char *content_type; /* Content-Type */ + char *content_language; /* Content-Language */ + char *content_encoding; /* Compression algorithm */ + char *content_base; /* Content-Base */ + char *content_disposition; /* Content-Disposition */ + char *content_location; /* Content-Location */ + char *content_md5; /* Content-MD5 */ + char *message_id; /* Message-ID */ + char *subject; /* Subject */ + int content_length; /* Content-Length */ + char *date; /* Date */ + char *expires; /* Expires */ + char *last_modified; /* Last-Modified */ + char *ETag; /* ETag (HTTP1.1 cache validator) */ + char *server; /* Server */ + UCAnchorInfo *UCStages; /* chartrans stages */ + HTList *imaps; /* client side image maps */ }; typedef HTAtom HTLinkType; typedef struct { - /* Common part from the generic anchor structure */ - HTParentAnchor0 * parent; /* Parent of this anchor */ + /* Common part from the generic anchor structure */ + HTParentAnchor0 *parent; /* Parent of this anchor */ - /* ChildAnchor-specific information */ - char * tag; /* #fragment, relative to the parent */ + /* ChildAnchor-specific information */ + char *tag; /* #fragment, relative to the parent */ - HTAnchor * dest; /* The anchor to which this leads */ - HTLinkType * type; /* Semantics of this link */ + HTAnchor *dest; /* The anchor to which this leads */ + HTLinkType *type; /* Semantics of this link */ - HTList _add_children_notag; /* - just a memory for list entry:) */ - HTList _add_sources; /* - just a memory for list entry:) */ + HTList _add_children_notag; /* - just a memory for list entry:) */ + HTList _add_sources; /* - just a memory for list entry:) */ } HTChildAnchor; /* -** DocAddress structure is used for loading an absolute anchor with all -** needed information including posting data and post content type. -*/ + * DocAddress structure is used for loading an absolute anchor with all + * needed information including posting data and post content type. + */ typedef struct _DocAddress { - char * address; - bstring * post_data; - char * post_content_type; - char * bookmark; - BOOL isHEAD; - BOOL safe; + char *address; + bstring *post_data; + char *post_content_type; + char *bookmark; + BOOL isHEAD; + BOOL safe; } DocAddress; /* "internal" means "within the same document, with certainty". */ -extern HTLinkType * HTInternalLink; +extern HTLinkType *HTInternalLink; /* Create or find a child anchor with a possible link -** -------------------------------------------------- -** -** Create new anchor with a given parent and possibly -** a name, and possibly a link to a _relatively_ named anchor. -** (Code originally in ParseHTML.h) -*/ -extern HTChildAnchor * HTAnchor_findChildAndLink ( - HTParentAnchor * parent, /* May not be 0 */ - const char * tag, /* May be "" or 0 */ - const char * href, /* May be "" or 0 */ - HTLinkType * ltype); /* May be 0 */ + * -------------------------------------------------- + * + * Create new anchor with a given parent and possibly + * a name, and possibly a link to a _relatively_ named anchor. + * (Code originally in ParseHTML.h) + */ +extern HTChildAnchor *HTAnchor_findChildAndLink(HTParentAnchor *parent, /* May not be 0 */ + const char *tag, /* May be "" or 0 */ + const char *href, /* May be "" or 0 */ + HTLinkType *ltype); /* May be 0 */ /* Create new or find old parent anchor -** ------------------------------------ -** -** This one is for a reference which is found in a document, and might -** not be already loaded. -** Note: You are not guaranteed a new anchor -- you might get an old one, -** like with fonts. -*/ -extern HTParentAnchor * HTAnchor_findAddress ( - const DocAddress * address); + * ------------------------------------ + * + * This one is for a reference which is found in a document, and might + * not be already loaded. + * Note: You are not guaranteed a new anchor -- you might get an old one, + * like with fonts. + */ +extern HTParentAnchor *HTAnchor_findAddress(const DocAddress *address); /* Create new or find old named anchor - simple form -** ------------------------------------------------- -** -** Like the previous one, but simpler to use for simple cases. -** No post data etc. can be supplied. - kw -*/ -extern HTParentAnchor * HTAnchor_findSimpleAddress ( - const char * url); + * ------------------------------------------------- + * + * Like the previous one, but simpler to use for simple cases. + * No post data etc. can be supplied. - kw + */ +extern HTParentAnchor *HTAnchor_findSimpleAddress(const char *url); /* Delete an anchor and possibly related things (auto garbage collection) -** -------------------------------------------- -** -** The anchor is only deleted if the corresponding document is not loaded. -** All outgoing links from children are deleted, and children are -** removed from the sources lists of their targets. -** We also try to delete the targets whose documents are not loaded. -** If this anchor's sources list is empty, we delete it and its children. -*/ -extern BOOL HTAnchor_delete ( - HTParentAnchor0 * me); + * -------------------------------------------- + * + * The anchor is only deleted if the corresponding document is not loaded. + * All outgoing links from children are deleted, and children are + * removed from the sources lists of their targets. + * We also try to delete the targets whose documents are not loaded. + * If this anchor's sources list is empty, we delete it and its children. + */ +extern BOOL HTAnchor_delete(HTParentAnchor0 *me); /* * Unnamed children (children_notag) have no sense without HText - * delete them and their links if we are about to free HText. * Document currently exists. Called within HText_free(). */ -extern void HTAnchor_delete_links ( - HTParentAnchor * me); +extern void HTAnchor_delete_links(HTParentAnchor *me); #ifdef USE_SOURCE_CACHE -extern void HTAnchor_clearSourceCache ( - HTParentAnchor * me); +extern void HTAnchor_clearSourceCache(HTParentAnchor *me); #endif /* Data access functions -** --------------------- -*/ -extern HTParentAnchor * HTAnchor_parent ( - HTAnchor * me); + * --------------------- + */ +extern HTParentAnchor *HTAnchor_parent(HTAnchor * me); -extern void HTAnchor_setDocument ( - HTParentAnchor * me, - HyperDoc * doc); +extern void HTAnchor_setDocument(HTParentAnchor *me, + HyperDoc *doc); -extern HyperDoc * HTAnchor_document ( - HTParentAnchor * me); +extern HyperDoc *HTAnchor_document(HTParentAnchor *me); /* Returns the full URI of the anchor, child or parent -** as a malloc'd string to be freed by the caller. -*/ -extern char * HTAnchor_address ( - HTAnchor * me); + * as a malloc'd string to be freed by the caller. + */ +extern char *HTAnchor_address(HTAnchor * me); -extern void HTAnchor_setFormat ( - HTParentAnchor * me, - HTFormat form); +extern void HTAnchor_setFormat(HTParentAnchor *me, + HTFormat form); -extern HTFormat HTAnchor_format ( - HTParentAnchor * me); +extern HTFormat HTAnchor_format(HTParentAnchor *me); -extern void HTAnchor_setIndex ( - HTParentAnchor * me, - const char * address); +extern void HTAnchor_setIndex(HTParentAnchor *me, + const char *address); -extern void HTAnchor_setPrompt ( - HTParentAnchor * me, - const char * prompt); +extern void HTAnchor_setPrompt(HTParentAnchor *me, + const char *prompt); -extern BOOL HTAnchor_isIndex ( - HTParentAnchor * me); +extern BOOL HTAnchor_isIndex(HTParentAnchor *me); -extern BOOL HTAnchor_isISMAPScript ( - HTAnchor * me); +extern BOOL HTAnchor_isISMAPScript(HTAnchor * me); #if defined(USE_COLOR_STYLE) -extern const char * HTAnchor_style ( - HTParentAnchor * me); +extern const char *HTAnchor_style(HTParentAnchor *me); -extern void HTAnchor_setStyle ( - HTParentAnchor * me, - const char * style); +extern void HTAnchor_setStyle(HTParentAnchor *me, + const char *style); #endif /* Title handling. */ -extern const char * HTAnchor_title ( - HTParentAnchor * me); +extern const char *HTAnchor_title(HTParentAnchor *me); -extern void HTAnchor_setTitle ( - HTParentAnchor * me, - const char * title); +extern void HTAnchor_setTitle(HTParentAnchor *me, + const char *title); -extern void HTAnchor_appendTitle ( - HTParentAnchor * me, - const char * title); +extern void HTAnchor_appendTitle(HTParentAnchor *me, + const char *title); /* Bookmark handling. */ -extern const char * HTAnchor_bookmark ( - HTParentAnchor * me); +extern const char *HTAnchor_bookmark(HTParentAnchor *me); -extern void HTAnchor_setBookmark ( - HTParentAnchor * me, - const char * bookmark); +extern void HTAnchor_setBookmark(HTParentAnchor *me, + const char *bookmark); /* Owner handling. */ -extern const char * HTAnchor_owner ( - HTParentAnchor * me); +extern const char *HTAnchor_owner(HTParentAnchor *me); -extern void HTAnchor_setOwner ( - HTParentAnchor * me, - const char * owner); +extern void HTAnchor_setOwner(HTParentAnchor *me, + const char *owner); /* TITLE handling in LINKs with REV="made" or REV="owner". - FM */ -extern const char * HTAnchor_RevTitle ( - HTParentAnchor * me); +extern const char *HTAnchor_RevTitle(HTParentAnchor *me); -extern void HTAnchor_setRevTitle ( - HTParentAnchor * me, - const char * title); +extern void HTAnchor_setRevTitle(HTParentAnchor *me, + const char *title); /* Citehost for bibp links from LINKs with REL="citehost". - RDC */ -extern const char * HTAnchor_citehost ( - HTParentAnchor * me); +extern const char *HTAnchor_citehost(HTParentAnchor *me); -extern void HTAnchor_setCitehost ( - HTParentAnchor * me, - const char * citehost); +extern void HTAnchor_setCitehost(HTParentAnchor *me, + const char *citehost); /* Suggested filename handling. - FM -** (will be loaded if we had a Content-Disposition -** header or META element with filename=name.suffix) -*/ -extern const char * HTAnchor_SugFname ( - HTParentAnchor * me); + * (will be loaded if we had a Content-Disposition + * header or META element with filename=name.suffix) + */ +extern const char *HTAnchor_SugFname(HTParentAnchor *me); /* Content-Type handling. - FM */ -extern const char * HTAnchor_content_type ( - HTParentAnchor * me); +extern const char *HTAnchor_content_type(HTParentAnchor *me); /* Content-Encoding handling. - FM -** (will be loaded if we had a Content-Encoding -** header.) -*/ -extern const char * HTAnchor_content_encoding ( - HTParentAnchor * me); + * (will be loaded if we had a Content-Encoding + * header.) + */ +extern const char *HTAnchor_content_encoding(HTParentAnchor *me); /* Last-Modified header handling. - FM */ -extern const char * HTAnchor_last_modified ( - HTParentAnchor * me); +extern const char *HTAnchor_last_modified(HTParentAnchor *me); /* Date header handling. - FM */ -extern const char * HTAnchor_date ( - HTParentAnchor * me); +extern const char *HTAnchor_date(HTParentAnchor *me); /* Server header handling. - FM */ -extern const char * HTAnchor_server ( - HTParentAnchor * me); +extern const char *HTAnchor_server(HTParentAnchor *me); /* Safe header handling. - FM */ -extern BOOL HTAnchor_safe ( - HTParentAnchor * me); +extern BOOL HTAnchor_safe(HTParentAnchor *me); /* Content-Base header handling. - FM */ -extern const char * HTAnchor_content_base ( - HTParentAnchor * me); +extern const char *HTAnchor_content_base(HTParentAnchor *me); /* Content-Location header handling. - FM */ -extern const char * HTAnchor_content_location ( - HTParentAnchor * me); +extern const char *HTAnchor_content_location(HTParentAnchor *me); /* Message-ID, used for mail replies - kw */ -extern const char * HTAnchor_messageID ( - HTParentAnchor * me); +extern const char *HTAnchor_messageID(HTParentAnchor *me); -extern BOOL HTAnchor_setMessageID ( - HTParentAnchor * me, - const char * messageid); +extern BOOL HTAnchor_setMessageID(HTParentAnchor *me, + const char *messageid); /* Subject, used for mail replies - kw */ -extern const char * HTAnchor_subject ( - HTParentAnchor * me); +extern const char *HTAnchor_subject(HTParentAnchor *me); -extern BOOL HTAnchor_setSubject ( - HTParentAnchor * me, - const char * subject); +extern BOOL HTAnchor_setSubject(HTParentAnchor *me, + const char *subject); /* Manipulation of links -** --------------------- -*/ -extern HTAnchor * HTAnchor_followLink ( - HTChildAnchor * me); + * --------------------- + */ +extern HTAnchor *HTAnchor_followLink(HTChildAnchor *me); -extern HTAnchor * HTAnchor_followTypedLink ( - HTChildAnchor * me, - HTLinkType * type); +extern HTAnchor *HTAnchor_followTypedLink(HTChildAnchor *me, + HTLinkType *type); /* Read and write methods -** ---------------------- -*/ -extern HTList * HTAnchor_methods ( - HTParentAnchor * me); + * ---------------------- + */ +extern HTList *HTAnchor_methods(HTParentAnchor *me); /* Protocol -** -------- -*/ -extern void * HTAnchor_protocol ( - HTParentAnchor * me); + * -------- + */ +extern void *HTAnchor_protocol(HTParentAnchor *me); -extern void HTAnchor_setProtocol ( - HTParentAnchor * me, - void * protocol); +extern void HTAnchor_setProtocol(HTParentAnchor *me, + void *protocol); /* Physical address -** ---------------- -*/ -extern char * HTAnchor_physical ( - HTParentAnchor * me); - -extern void HTAnchor_setPhysical ( - HTParentAnchor * me, - char * protocol); - -extern LYUCcharset * HTAnchor_getUCInfoStage ( - HTParentAnchor * me, - int which_stage); - -extern int HTAnchor_getUCLYhndl ( - HTParentAnchor * me, - int which_stage); - -extern LYUCcharset * HTAnchor_setUCInfoStage ( - HTParentAnchor * me, - int LYhndl, - int which_stage, - int set_by); - -extern LYUCcharset * HTAnchor_setUCInfoStage ( - HTParentAnchor * me, - int LYhndl, - int which_stage, - int set_by); - -extern LYUCcharset * HTAnchor_resetUCInfoStage ( - HTParentAnchor * me, - int LYhndl, - int which_stage, - int set_by); - -extern LYUCcharset * HTAnchor_copyUCInfoStage ( - HTParentAnchor * me, - int to_stage, - int from_stage, - int set_by); - -extern void ImageMapList_free (HTList * list); + * ---------------- + */ +extern char *HTAnchor_physical(HTParentAnchor *me); + +extern void HTAnchor_setPhysical(HTParentAnchor *me, + char *protocol); + +extern LYUCcharset *HTAnchor_getUCInfoStage(HTParentAnchor *me, + int which_stage); + +extern int HTAnchor_getUCLYhndl(HTParentAnchor *me, + int which_stage); + +extern LYUCcharset *HTAnchor_setUCInfoStage(HTParentAnchor *me, + int LYhndl, + int which_stage, + int set_by); + +extern LYUCcharset *HTAnchor_setUCInfoStage(HTParentAnchor *me, + int LYhndl, + int which_stage, + int set_by); + +extern LYUCcharset *HTAnchor_resetUCInfoStage(HTParentAnchor *me, + int LYhndl, + int which_stage, + int set_by); + +extern LYUCcharset *HTAnchor_copyUCInfoStage(HTParentAnchor *me, + int to_stage, + int from_stage, + int set_by); + +extern void ImageMapList_free(HTList *list); #endif /* HTANCHOR_H */ |