Annotation of libwww/Library/src/HTAtom.html, revision 2.9
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 "HTUtils.h"
36: #include "HTList.h"
37:
38: #ifdef SHORT_NAMES
39: #define HTAt_for HTAtom_for
40: #define HTAt_tMa HTAtom_templateMatches
2.7 frystyk 41: #endif
2.6 luotonen 42:
1.1 timbl 43: typedef struct _HTAtom HTAtom;
44: struct _HTAtom {
45: HTAtom * next;
46: char * name;
47: }; /* struct _HTAtom */
2.7 frystyk 48: </PRE>
49:
50: <H2>Public Functions</H2>
51:
52: The following methods are available for this class:
53:
54: <H3>Get an Atom</H3>
1.1 timbl 55:
2.7 frystyk 56: This function returns a representative value (an <CODE>atom</CODE>)
57: such that it will always (within one run of the program) return the
58: same value for the same given string.
1.1 timbl 59:
2.7 frystyk 60: <PRE>
2.8 frystyk 61: extern HTAtom * HTAtom_for PARAMS((CONST char * string));
2.7 frystyk 62: </PRE>
63:
64: <H3>Get Content of an Atom</H3>
1.1 timbl 65:
2.7 frystyk 66: <PRE>
1.2 timbl 67: #define HTAtom_name(a) ((a)->name)
2.7 frystyk 68: </PRE>
69:
70: This macro returns the string pointed to by the <CODE>atom</CODE>.
71:
72: <H3>Search For Atoms</H3>
73:
74: Returns a list of <CODE>atoms</CODE> which matches the template
75: given. It is especially made for MIME-types so that for example a
76: template like <CODE>text<slash><star></CODE> returns a
77: list of all MIME-types of type <CODE>text</CODE>.
78:
79: <PRE>
2.8 frystyk 80: extern HTList * HTAtom_templateMatches PARAMS((CONST char * templ));
1.1 timbl 81:
2.7 frystyk 82: #endif
1.1 timbl 83: </PRE>
2.7 frystyk 84:
85: End of HTAtom definition.
86:
87: </BODY>
88: </HTML>
89:
Webmaster