Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / programs / dtinfo / DtMmdb / dstr / void_ptr_array.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 /*
24  * $XConsortium: void_ptr_array.h /main/4 1996/07/18 14:31:24 drk $
25  *
26  * Copyright (c) 1993 HAL Computer Systems International, Ltd.
27  * All rights reserved.  Unpublished -- rights reserved under
28  * the Copyright Laws of the United States.  USE OF A COPYRIGHT
29  * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
30  * OR DISCLOSURE.
31  * 
32  * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
33  * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
34  * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
35  * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
36  * INTERNATIONAL, LTD.
37  * 
38  *                         RESTRICTED RIGHTS LEGEND
39  * Use, duplication, or disclosure by the Government is subject
40  * to the restrictions as set forth in subparagraph (c)(l)(ii)
41  * of the Rights in Technical Data and Computer Software clause
42  * at DFARS 252.227-7013.
43  *
44  *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
45  *                  1315 Dell Avenue
46  *                  Campbell, CA  95008
47  * 
48  */
49
50
51
52 #ifndef _void_ptr_array_h
53 #define _void_ptr_array_h 1
54
55 #include  "utility/funcs.h"
56 #include  "utility/buffer.h"
57
58 //**************************************************************
59 //
60 // an void_ptr_array class
61 // holding voidPtr elements in range [0, count()-1]
62 //
63 //**************************************************************
64
65 class void_ptr_array : public buffer 
66 {
67
68 public:
69    void_ptr_array(int exp_size) ;
70    void_ptr_array(void_ptr_array&) ;
71    virtual ~void_ptr_array() {};
72
73    Boolean expandWith(int extra_void_ptrs);
74
75    Boolean insert(void* element, int i) ;
76
77    void reset_vptr(voidPtr value);  // set all cells to value
78
79    inline void reset_elmts(int i) { v_elmts = i; };  
80    inline int no_elmts() { return v_elmts; };    
81
82    inline int count() {
83       return (buf_sz() / sizeof(voidPtr) );
84    };
85
86 // terminate value: -1
87    inline int first() {
88       return ( count() == 0 ) ? -1 : 0;
89    };
90    inline virtual void* operator [](int i) {
91       return ((voidPtr*)(v_base))[i] ;
92    };
93    inline void next(int& ind) {
94       if ( ind == count() -1 )
95       ind = -1;
96    else
97       ind++;
98    };
99
100    friend ostream& operator <<(ostream&, void_ptr_array&);
101
102 protected:
103
104    int v_elmts;
105 };
106
107 #endif