blob: 5f7850d2506d13736e5a1727bb0b77de7163eb73 [file] [log] [blame]
Emeric Vigier2f625822012-08-06 11:09:52 -04001// Copyright (C) 2001-2005 Open Source Telecom Corporation.
2// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.
3//
4// This program is free software; you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation; either version 2 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program; if not, write to the Free Software
16// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17//
18// As a special exception to the GNU General Public License, permission is
19// granted for additional uses of the text contained in its release
20// of Common C++.
21//
22// The exception is that, if you link the Common C++ library with other
23// files to produce an executable, this does not by itself cause the
24// resulting executable to be covered by the GNU General Public License.
25// Your use of that executable is in no way restricted on account of
26// linking the Common C++ library code into it.
27//
28// This exception does not however invalidate any other reasons why
29// the executable file might be covered by the GNU General Public License.
30//
31// This exception applies only to the code released under the
32// name Common C++. If you copy code from other releases into a copy of
33// Common C++, as the General Public License permits, the exception does
34// not apply to the code that you add in this way. To avoid misleading
35// anyone as to the status of such modified files, you must delete
36// this exception notice from them.
37//
38// If you write modifications of your own for Common C++, it is your choice
39// whether to permit this exception to apply to your modifications.
40// If you do not wish that, delete this exception notice.
41
42/**
43 * @file objlink.h
44 * @short Template for creating linked list of objects with lookup.
45 **/
46
47#ifndef CCXX_OBJLINK_H
48#define CCXX_OBJLINK_H
49#include <cstddef>
50
51#ifdef CCXX_NAMESPACES
52namespace ost {
53#endif
54
55/**
56 * Used to create and manage a single linked list of objects of a common
57 * type. The list of created objects can be examined to find a key by
58 * an identifier.
59 *
60 * @author David Sugar <dyfet@gnutelephony.org>
61 * @short single linked list searchable template chain.
62 */
63template <class T, typename K>
64class objList {
65protected:
66 static T* objFirst;
67 T* objNext;
68 const K objKey;
69
70 objList(const K key)
71 {
72 objKey = key;
73 objNext = objFirst;
74 objFirst = (T *)this;
75 }
76public:
77 static T* getObject(const K& key);
78};
79
80template <class T, typename K>
81T *objList<T, K>::objFirst = NULL;
82
83template <class T, typename K>
84T *objList<T, K>::getObject(const K& key)
85{
86 T *obj = objList<T, K>::objFirst;
87 while(obj) {
88 if(key == obj->objKey)
89 break;
90 obj = obj->objNext;
91 }
92 return obj;
93}
94
95#ifdef CCXX_NAMESPACES
96}
97#endif
98
99#endif