Subversion Repositories tendra.SVN

Rev

Rev 5 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 7u83 1 
/*
6 7u83 2 
 * Copyright (c) 2002-2006 The TenDRA Project <http://www.tendra.org/>.
3 
 * All rights reserved.
4 
 *
5 
 * Redistribution and use in source and binary forms, with or without
6 
 * modification, are permitted provided that the following conditions are met:
7 
 *
8 
 * 1. Redistributions of source code must retain the above copyright notice,
9 
 *    this list of conditions and the following disclaimer.
10 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 
 *    this list of conditions and the following disclaimer in the documentation
12 
 *    and/or other materials provided with the distribution.
13 
 * 3. Neither the name of The TenDRA Project nor the names of its contributors
14 
 *    may be used to endorse or promote products derived from this software
15 
 *    without specific, prior written permission.
16 
 *
17 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
18 
 * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19 
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
21 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 
 * EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
 *
29 
 * $Id$
30 
 */
31 
/*
2 7u83 32 
    		 Crown Copyright (c) 1997
6 7u83 33 
 
2 7u83 34 
    This TenDRA(r) Computer Program is subject to Copyright
35 
    owned by the United Kingdom Secretary of State for Defence
36 
    acting through the Defence Evaluation and Research Agency
37 
    (DERA).  It is made available to Recipients with a
38 
    royalty-free licence for its use, reproduction, transfer
39 
    to other parties and amendment for any purpose not excluding
40 
    product development provided that any such use et cetera
41 
    shall be deemed to be acceptance of the following conditions:-
6 7u83 42 
 
2 7u83 43 
        (1) Its Recipients shall ensure that this Notice is
44 
        reproduced upon any copies or amended versions of it;
6 7u83 45 
 
2 7u83 46 
        (2) Any amended version of it shall be clearly marked to
47 
        show both the nature of and the organisation responsible
48 
        for the relevant amendment or amendments;
6 7u83 49 
 
2 7u83 50 
        (3) Its onward transfer from a recipient to another
51 
        party shall be deemed to be that party's acceptance of
52 
        these conditions;
6 7u83 53 
 
2 7u83 54 
        (4) DERA gives no warranty or assurance as to its
55 
        quality or suitability for any purpose and DERA accepts
56 
        no liability whatsoever in relation to any use to which
57 
        it may be put.
58 
*/
59 
 
60 
 
61 
/**** nstring-list.h --- String list ADT.
62 
 *
63 
 ** Author: Steve Folkes <smf@hermes.mod.uk>
64 
 *
65 
 **** Commentary:
66 
 *
67 
 ***=== INTRODUCTION =========================================================
68 
 *
69 
 * This file specifies the interface to a string list facility.  This
70 
 * particular facility allows lists of nstrings (defined in the files
71 
 * "dstring.[ch]") to be created.
72 
 *
73 
 ***=== TYPES ================================================================
74 
 *
75 
 ** Type:	NStringListEntryT
76 
 ** Type:	NStringListEntryP
77 
 ** Repr:	<private>
78 
 *
79 
 * This is the nstring list entry type.
80 
 *
81 
 ** Type:	NStringListT
82 
 ** Type:	NStringListP
83 
 ** Repr:	<private>
84 
 *
85 
 * This is the nstring list type.
86 
 *
87 
 ***=== FUNCTIONS ============================================================
88 
 *
6 7u83 89 
 ** Function:	void nstring_list_init(NStringListP list)
2 7u83 90 
 ** Exceptions:
91 
 *
92 
 * This function initialises the specified nstring list to be an empty list.
93 
 *
6 7u83 94 
 ** Function:	void nstring_list_append(NStringListP list, NStringP nstring)
2 7u83 95 
 ** Exceptions:	XX_dalloc_no_memory
96 
 *
97 
 * This function appends the specified nstring onto the specified list.
98 
 *
6 7u83 99 
 ** Function:	NStringListEntryP nstring_list_head(NStringListP list)
2 7u83 100 
 ** Exceptions:
101 
 *
102 
 * This function returns a pointer to the first entry in the specified list.
103 
 *
6 7u83 104 
 ** Function:	NStringP nstring_list_entry_string(NStringListEntryP entry)
2 7u83 105 
 ** Exceptions:
106 
 *
107 
 * This function returns a pointer to the nstring stored in the specified
108 
 * list entry.
109 
 *
6 7u83 110 
 ** Function:	NStringListEntryP
111 
 *		    nstring_list_entry_deallocate(NStringListEntryP entry)
2 7u83 112 
 ** Exceptions:
113 
 *
114 
 * This function deallocates the specified list entry (without deallocating
115 
 * the string - this must be done by the calling function) and returns a
116 
 * pointer to the next entry in the list.  Once this function has been called,
117 
 * the state of the list that the entry is a member of is undefined.  It is
118 
 * only useful for deallocating the entire list in a loop.
119 
 *
120 
 **** Change log:
121 
 * $Log: nstring-list.h,v $
122 
 * Revision 1.1.1.1  1998/01/17  15:57:17  release
123 
 * First version to be checked into rolling release.
124 
 *
125 
 * Revision 1.2  1994/12/12  11:44:49  smf
126 
 * Performing changes for 'CR94_178.sid+tld-update' - bringing in line with
127 
 * OSSG C Coding Standards.
128 
 *
129 
 * Revision 1.1.1.1  1994/07/25  16:05:53  smf
130 
 * Initial import of library shared files.
131 
 *
132 
**/
133 
 
134 
/****************************************************************************/
135 
 
136 
#ifndef H_NSTRING_LIST
137 
#define H_NSTRING_LIST
138 
 
139 
#include "os-interface.h"
140 
#include "dalloc.h"
141 
#include "dstring.h"
142 
 
143 
/*--------------------------------------------------------------------------*/
144 
 
145 
typedef struct NStringListEntryT {
146 
    struct NStringListEntryT   *next;
147 
    NStringT			string;
148 
} NStringListEntryT, *NStringListEntryP;
149 
 
150 
typedef struct NStringListT {
151 
    NStringListEntryP		head;
152 
    NStringListEntryP	       *tail;
153 
} NStringListT, *NStringListP;
154 
 
155 
/*--------------------------------------------------------------------------*/
156 
 
157 
extern void			nstring_list_init
6 7u83 158 
(NStringListP);
2 7u83 159 
extern void			nstring_list_append
6 7u83 160 
(NStringListP, NStringP);
2 7u83 161 
extern NStringListEntryP	nstring_list_head
6 7u83 162 
(NStringListP);
2 7u83 163 
extern NStringP			nstring_list_entry_string
6 7u83 164 
(NStringListEntryP);
2 7u83 165 
extern NStringListEntryP	nstring_list_entry_deallocate
6 7u83 166 
(NStringListEntryP);
2 7u83 167 
 
168 
#endif /* !defined (H_NSTRING_LIST) */
169 
 
170 
/*
171 
 * Local variables(smf):
172 
 * eval: (include::add-path-entry "../os-interface" "../generated")
173 
 * end:
174 
**/