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.13

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"
2.13    ! frystyk    28: HREF="http://www.w3.org/hypertext/WWW/Library/User/Guide/Guide.html">Library
2.7       frystyk    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: 
1.1       timbl      37: typedef struct _HTAtom HTAtom;
                     38: struct _HTAtom {
                     39:        HTAtom *        next;
                     40:        char *          name;
                     41: }; /* struct _HTAtom */
2.7       frystyk    42: </PRE>
                     43: 
                     44: <H2>Public Functions</H2>
                     45: 
                     46: The following methods are available for this class:
                     47: 
                     48: <H3>Get an Atom</H3>
1.1       timbl      49: 
2.7       frystyk    50: This function returns a representative value (an <CODE>atom</CODE>)
                     51: such that it will always (within one run of the program) return the
                     52: same value for the same given string.
1.1       timbl      53: 
2.7       frystyk    54: <PRE>
2.8       frystyk    55: extern HTAtom * HTAtom_for PARAMS((CONST char * string));
2.7       frystyk    56: </PRE>
                     57: 
                     58: <H3>Get Content of an Atom</H3>
1.1       timbl      59: 
2.7       frystyk    60: <PRE>
1.2       timbl      61: #define HTAtom_name(a) ((a)->name)
2.7       frystyk    62: </PRE>
                     63: 
                     64: This macro returns the string pointed to by the <CODE>atom</CODE>.
                     65: 
                     66: <H3>Search For Atoms</H3>
                     67: 
                     68: Returns a list of <CODE>atoms</CODE> which matches the template
                     69: given. It is especially made for MIME-types so that for example a
                     70: template like <CODE>text&lt;slash&gt;&lt;star&gt;</CODE> returns a
                     71: list of all MIME-types of type <CODE>text</CODE>.
                     72: 
                     73: <PRE>
2.8       frystyk    74: extern HTList * HTAtom_templateMatches PARAMS((CONST char * templ));
2.10      frystyk    75: </PRE>
                     76: 
                     77: <H3>Cleanup Memory</H3>
                     78: 
                     79: In order to cleanup memory, call this function. This is done
                     80: automaticly from the <A
                     81: HREF="HTAccess.html#Library">HTLibTerminate</A> function.
                     82: 
                     83: <PRE>
                     84: extern void HTAtom_deleteAll NOPARAMS;
1.1       timbl      85: 
2.7       frystyk    86: #endif
1.1       timbl      87: </PRE>
2.7       frystyk    88: 
                     89: End of HTAtom definition.
                     90: 
                     91: </BODY>
                     92: </HTML>
                     93:
Webmaster