libwww/Library/src/HTAtom.html - annotate

Return to HTAtom.html CVS log
Up to [Public] / libwww / Library / src
Annotation of libwww/Library/src/HTAtom.html, revision 2.10.2.1

2.7       frystyk     1: <HTML>
                      2: <HEAD>
                      3: <TITLE>Atoms - an easy way of organizing strings</TITLE>
                      4: </HEAD>
                      5: <BODY>
                      6: 
                      7: <H1>Atoms</H1>
2.9       frystyk     8: 
                      9: <PRE>
                     10: /*
                     11: **     (c) COPYRIGHT CERN 1994.
                     12: **     Please first read the full copyright statement in the file COPYRIGH.
                     13: */
                     14: </PRE>
2.7       frystyk    15: 
                     16: <CODE>Atoms</CODE> are strings which are given representative pointer
                     17: values so that they can be stored more efficiently, and compaisons for
                     18: equality done more efficiently. The list of <CODE>atoms</CODE> are
                     19: stored in a has table, so when asking for a new atom you might infact
                     20: get back an existing one.<P>
                     21: 
                     22: There are a whole bunch of <A
                     23: HREF="HTFormat.html#FormatTypes">MIME-types</A> defined as
                     24: <CODE>atoms</CODE>, so please use them! <P>
                     25: 
                     26: This module is implemented by <A HREF="HTAtom.c">HTAtom.c</A>, and it
                     27: is a part of the <A NAME="z10"
                     28: HREF="http://info.cern.ch/hypertext/WWW/Library/User/Guide/Guide.html">Library
                     29: of Common Code</A>. <P>
                     30: 
1.1       timbl      31: <PRE>
                     32: #ifndef HTATOM_H
                     33: #define HTATOM_H
                     34: 
2.6       luotonen   35: #include "HTList.h"
                     36: 
                     37: #ifdef SHORT_NAMES
                     38: #define HTAt_for       HTAtom_for
                     39: #define HTAt_tMa       HTAtom_templateMatches
2.7       frystyk    40: #endif
2.6       luotonen   41: 
1.1       timbl      42: typedef struct _HTAtom HTAtom;
                     43: struct _HTAtom {
                     44:        HTAtom *        next;
                     45:        char *          name;
                     46: }; /* struct _HTAtom */
2.7       frystyk    47: </PRE>
                     48: 
                     49: <H2>Public Functions</H2>
                     50: 
                     51: The following methods are available for this class:
                     52: 
                     53: <H3>Get an Atom</H3>
1.1       timbl      54: 
2.7       frystyk    55: This function returns a representative value (an <CODE>atom</CODE>)
                     56: such that it will always (within one run of the program) return the
                     57: same value for the same given string.
1.1       timbl      58: 
2.7       frystyk    59: <PRE>
2.8       frystyk    60: extern HTAtom * HTAtom_for PARAMS((CONST char * string));
2.7       frystyk    61: </PRE>
                     62: 
                     63: <H3>Get Content of an Atom</H3>
1.1       timbl      64: 
2.7       frystyk    65: <PRE>
1.2       timbl      66: #define HTAtom_name(a) ((a)->name)
2.7       frystyk    67: </PRE>
                     68: 
                     69: This macro returns the string pointed to by the <CODE>atom</CODE>.
                     70: 
                     71: <H3>Search For Atoms</H3>
                     72: 
                     73: Returns a list of <CODE>atoms</CODE> which matches the template
                     74: given. It is especially made for MIME-types so that for example a
                     75: template like <CODE>text&lt;slash&gt;&lt;star&gt;</CODE> returns a
                     76: list of all MIME-types of type <CODE>text</CODE>.
                     77: 
                     78: <PRE>
2.8       frystyk    79: extern HTList * HTAtom_templateMatches PARAMS((CONST char * templ));
2.10      frystyk    80: </PRE>
                     81: 
                     82: <H3>Cleanup Memory</H3>
                     83: 
                     84: In order to cleanup memory, call this function. This is done
                     85: automaticly from the <A
                     86: HREF="HTAccess.html#Library">HTLibTerminate</A> function.
                     87: 
                     88: <PRE>
                     89: extern void HTAtom_deleteAll NOPARAMS;
1.1       timbl      90: 
2.7       frystyk    91: #endif
1.1       timbl      92: </PRE>
2.7       frystyk    93: 
                     94: End of HTAtom definition.
                     95: 
                     96: </BODY>
                     97: </HTML>
                     98:
Webmaster