This is HTAnchor.h in view mode; [Download] [Up]
/* /Net/dxcern/userd/timbl/hypertext/WWW/Library/Implementation/HTAnchor.html
*/
/* 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.
*/
#ifndef HTANCHOR_H
#define HTANCHOR_H
/* Version 0 (TBL) written in Objective-C for the NeXT browser */
/* Version 1 of 24-Oct-1991 (JFG), written in C, browser-independant */
#include "HTList.h"
#include "HTAtom.h"
#include "UCDefs.h"
#ifdef SHORT_NAMES
#define HTAnchor_findChild HTAnFiCh
#define HTAnchor_findChildAndLink HTAnFiLi
#define HTAnchor_findAddress HTAnFiAd
#define HTAnchor_delete HTAnDele
#define HTAnchor_makeLastChild HTAnMaLa
#define HTAnchor_parent HTAnPare
#define HTAnchor_setDocument HTAnSeDo
#define HTAnchor_document HTAnDocu
#define HTAnchor_setFormat HTAnSeFo
#define HTAnchor_format HTAnForm
#define HTAnchor_setIndex HTAnSeIn
#define HTAnchor_setPrompt HTAnSePr
#define HTAnchor_isIndex HTAnIsIn
#define HTAnchor_address HTAnAddr
#define HTAnchor_hasChildren HTAnHaCh
#define HTAnchor_title HTAnTitl
#define HTAnchor_setTitle HTAnSeTi
#define HTAnchor_appendTitle HTAnApTi
#define HTAnchor_link HTAnLink
#define HTAnchor_followMainLink HTAnFoMa
#define HTAnchor_followTypedLink HTAnFoTy
#define HTAnchor_makeMainLink HTAnMaMa
#define HTAnchor_setProtocol HTAnSePr
#define HTAnchor_protocol HTAnProt
#define HTAnchor_physical HTAnPhys
#define HTAnchor_setPhysical HTAnSePh
#define HTAnchor_methods HtAnMeth
#endif /* SHORT_NAMES */
/* Main definition of anchor
** =========================
*/
typedef struct _HyperDoc HyperDoc; /* Ready for forward references */
typedef struct _HTAnchor HTAnchor;
typedef struct _HTParentAnchor HTParentAnchor;
/* After definition of HTFormat: */
#include "HTFormat.h"
typedef HTAtom HTLinkType;
typedef struct {
HTAnchor * dest; /* The anchor to which this leads */
HTLinkType * type; /* Semantics of this link */
} HTLink;
struct _HTAnchor { /* Generic anchor : just links */
HTLink mainLink; /* Main (or default) destination of this */
HTList * links; /* List of extra links from this, if any */
/* We separate the first link from the others to avoid too many small mallocs
involved by a list creation. Most anchors only point to one place. */
HTParentAnchor * parent; /* Parent of this anchor (self for adults) */
};
struct _HTParentAnchor {
/* Common part from the generic anchor structure */
HTLink mainLink; /* Main (or default) destination of this */
HTList * links; /* List of extra links from this, if any */
HTParentAnchor * parent; /* Parent of this anchor (self) */
/* ParentAnchor-specific information */
HTList * children; /* Subanchors of this, if any */
HTList * sources; /* List of anchors pointing to this, if any */
HyperDoc * document; /* The document within which this is an anchor */
char * address; /* Absolute address of this node */
char * post_data; /* Posting data */
char * post_content_type; /* Type of post data */
char * bookmark; /* Bookmark filname */
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 */
HTList* methods; /* Methods available as HTAtoms */
void * protocol; /* Protocol object */
char * physical; /* Physical address */
BOOL underway; /* Document about to be attached to it */
BOOL isISMAPScript; /* Script for clickable image map */
BOOL isHEAD; /* Document is headers from a HEAD request */
BOOL safe; /* Safe */
char * FileCache; /* Path to a disk-cached copy */
char * SugFname; /* Suggested filename */
char * cache_control; /* Cache-Control */
BOOL no_cache; /* Cache-Control, Pragma or META "no-cache"? */
char * content_type; /* Content-Type */
char * content_language; /* Content-Language */
char * content_encoding; /* Compression algorithm */
char * content_base; /* Content-Base */
char * content_disposition; /* Content-Dispositon */
char * content_location; /* Content-Location */
char * content_md5; /* Content-MD5 */
int content_length; /* Content-Length */
char * date; /* Date */
char * expires; /* Expires */
char * last_modified; /* Last-Modified */
char * server; /* Server */
UCAnchorInfo *UCStages;
};
typedef struct {
/* Common part from the generic anchor structure */
HTLink mainLink; /* Main (or default) destination of this */
HTList * links; /* List of extra links from this, if any */
HTParentAnchor * parent; /* Parent of this anchor */
/* ChildAnchor-specific information */
char * tag; /* Address of this anchor relative to parent */
} HTChildAnchor;
/*
** 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;
char * post_data;
char * post_content_type;
char * bookmark;
BOOL isHEAD;
BOOL safe;
} DocAddress;
/* Create new or find old sub-anchor
** ---------------------------------
**
** This one is for a new anchor being edited into an existing
** document. The parent anchor must already exist.
*/
extern HTChildAnchor * HTAnchor_findChild PARAMS((
HTParentAnchor * parent,
CONST char * tag));
/* 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 PARAMS((
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 named 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 HTAnchor * HTAnchor_findAddress PARAMS((
CONST DocAddress * address));
/* 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 parent and children are deleted, and this anchor
** is removed from the sources list of all its targets.
** We also try to delete the targets whose documents are not loaded.
** If this anchor's source list is empty, we delete it and its children.
*/
extern BOOL HTAnchor_delete PARAMS((
HTParentAnchor * me));
/* Move an anchor to the head of the list of its siblings
** ------------------------------------------------------
**
** This is to ensure that an anchor which might have already existed
** is put in the correct order as we load the document.
*/
extern void HTAnchor_makeLastChild PARAMS((
HTChildAnchor * me));
/* Data access functions
** ---------------------
*/
extern HTParentAnchor * HTAnchor_parent PARAMS((
HTAnchor * me));
extern void HTAnchor_setDocument PARAMS((
HTParentAnchor * me,
HyperDoc * doc));
extern HyperDoc * HTAnchor_document PARAMS((
HTParentAnchor * me));
/* We don't want code to change an address after anchor creation... yet ?
extern void HTAnchor_setAddress PARAMS((
HTAnchor * me,
char * addr));
*/
/* 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 PARAMS((
HTAnchor * me));
extern void HTAnchor_setFormat PARAMS((
HTParentAnchor * me,
HTFormat form));
extern HTFormat HTAnchor_format PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setIndex PARAMS((
HTParentAnchor * me,
char * address));
extern void HTAnchor_setPrompt PARAMS((
HTParentAnchor * me,
char * prompt));
extern BOOL HTAnchor_isIndex PARAMS((
HTParentAnchor * me));
extern BOOL HTAnchor_isISMAPScript PARAMS((
HTAnchor * me));
extern BOOL HTAnchor_hasChildren PARAMS((
HTParentAnchor * me));
/* Title handling.
*/
extern CONST char * HTAnchor_title PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setTitle PARAMS((
HTParentAnchor * me,
CONST char * title));
extern void HTAnchor_appendTitle PARAMS((
HTParentAnchor * me,
CONST char * title));
/* Bookmark handling.
*/
extern CONST char * HTAnchor_bookmark PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setBookmark PARAMS((
HTParentAnchor * me,
CONST char * bookmark));
/* Owner handling.
*/
extern CONST char * HTAnchor_owner PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setOwner PARAMS((
HTParentAnchor * me,
CONST char * owner));
/* TITLE handling in LINKs with REV="made" or REV="owner". - FM
*/
extern CONST char * HTAnchor_RevTitle PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setRevTitle PARAMS((
HTParentAnchor * me,
CONST char * title));
/* 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 PARAMS((
HTParentAnchor * me));
/* Content-Type handling. - FM
*/
extern CONST char * HTAnchor_content_type PARAMS((
HTParentAnchor * me));
/* Content-Encoding handling. - FM
** (will be loaded if we had a Content-Encoding
** header.)
*/
extern CONST char * HTAnchor_content_encoding PARAMS((
HTParentAnchor * me));
/* Last-Modified header handling. - FM
*/
extern CONST char * HTAnchor_last_modified PARAMS((
HTParentAnchor * me));
/* Date header handling. - FM
*/
extern CONST char * HTAnchor_date PARAMS((
HTParentAnchor * me));
/* Server header handling. - FM
*/
extern CONST char * HTAnchor_server PARAMS((
HTParentAnchor * me));
/* Safe header handling. - FM
*/
extern BOOL HTAnchor_safe PARAMS((
HTParentAnchor * me));
/* Content-Base header handling. - FM
*/
extern CONST char * HTAnchor_content_base PARAMS((
HTParentAnchor * me));
/* Content-Location header handling. - FM
*/
extern CONST char * HTAnchor_content_location PARAMS((
HTParentAnchor * me));
/* Link this Anchor to another given one
** -------------------------------------
*/
extern BOOL HTAnchor_link PARAMS((
HTAnchor * source,
HTAnchor * destination,
HTLinkType * type));
/* Manipulation of links
** ---------------------
*/
extern HTAnchor * HTAnchor_followMainLink PARAMS((
HTAnchor * me));
extern HTAnchor * HTAnchor_followTypedLink PARAMS((
HTAnchor * me,
HTLinkType * type));
extern BOOL HTAnchor_makeMainLink PARAMS((
HTAnchor * me,
HTLink * movingLink));
/* Read and write methods
** ----------------------
*/
extern HTList * HTAnchor_methods PARAMS((
HTParentAnchor * me));
/* Protocol
** --------
*/
extern void * HTAnchor_protocol PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setProtocol PARAMS((
HTParentAnchor * me,
void * protocol));
/* Physical address
** ----------------
*/
extern char * HTAnchor_physical PARAMS((
HTParentAnchor * me));
extern void HTAnchor_setPhysical PARAMS((
HTParentAnchor * me,
char * protocol));
extern LYUCcharset * HTAnchor_getUCInfoStage PARAMS((
HTParentAnchor * me,
int which_stage));
extern int HTAnchor_getUCLYhndl PARAMS((
HTParentAnchor * me,
int which_stage));
extern LYUCcharset * HTAnchor_setUCInfoStage PARAMS((
HTParentAnchor * me,
int LYhndl,
int which_stage,
int set_by));
extern LYUCcharset * HTAnchor_setUCInfoStage PARAMS((
HTParentAnchor * me,
int LYhndl,
int which_stage,
int set_by));
extern LYUCcharset * HTAnchor_resetUCInfoStage PARAMS((
HTParentAnchor * me,
int LYhndl,
int which_stage,
int set_by));
extern LYUCcharset * HTAnchor_copyUCInfoStage PARAMS((
HTParentAnchor * me,
int to_stage,
int from_stage,
int set_by));
#endif /* HTANCHOR_H */
/*
*/
These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.