Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / lib / tt / lib / api / c / api_spec_map_ref.h
1 /*
2  * CDE - Common Desktop Environment
3  *
4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
5  *
6  * These libraries and programs are free software; you can
7  * redistribute them and/or modify them under the terms of the GNU
8  * Lesser General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * These libraries and programs are distributed in the hope that
13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with these librararies and programs; if not, write
20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21  * Floor, Boston, MA 02110-1301 USA
22  */
23 /*%%  (c) Copyright 1993, 1994 Hewlett-Packard Company                   */
24 /*%%  (c) Copyright 1993, 1994 International Business Machines Corp.     */
25 /*%%  (c) Copyright 1993, 1994 Sun Microsystems, Inc.                    */
26 /*%%  (c) Copyright 1993, 1994 Novell, Inc.                              */
27 /*%%  $XConsortium: api_spec_map_ref.h /main/3 1995/10/23 09:54:47 rswiston $                                                    */
28 /* -*-C++-*-
29  *
30  * api_spec_map_ref.h
31  *
32  * Copyright (c) 1990 by Sun Microsystems, Inc.
33  * 
34  * define a class which maps objids to specs (tt_db_objects)
35  */
36
37 #ifndef _API_SPEC_MAP_REF_H
38 #define _API_SPEC_MAP_REF_H
39
40 #include "api/c/api_objid_spec.h"
41
42 class _Tt_api_spec_map_ref : public _Tt_allocated {
43         public:
44                 _Tt_api_spec_map_ref();
45                 ~_Tt_api_spec_map_ref();
46
47                 // Add the supplied spec to the tt_db_object table.
48                 Tt_status addSpec(_Tt_objid_spec_ptr specP);
49
50                 // Delete the associated spec from the tt_db_object
51                 // table.
52                 void deleteSpec(_Tt_string objid);
53
54                 // Return the spec associated w/ supplied objid
55                 _Tt_objid_spec_ptr getSpec(_Tt_string objid);
56
57                 // de-allocate the table associated with apiSpecMapP
58                 // below, when tt_close() is called.
59                 static void flush();
60
61                 // hash function
62                 static _Tt_string apiSpecKey(_Tt_object_ptr &Obj);
63         private:
64                 static _Tt_objid_spec_table_ptr *apiSpecMapP;
65
66 };
67
68 #endif // _API_SPEC_MAP_REF_H