1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
|
/* $Id$ */
/*
* Copyright (c) 1990-1996 Sam Leffler
* Copyright (c) 1991-1996 Silicon Graphics, Inc.
* HylaFAX is a trademark of Silicon Graphics
*
* Permission to use, copy, modify, distribute, and sell this software and
* its documentation for any purpose is hereby granted without fee, provided
* that (i) the above copyright notices and this permission notice appear in
* all copies of the software and related documentation, and (ii) the names of
* Sam Leffler and Silicon Graphics may not be used in any advertising or
* publicity relating to the software without the specific, prior written
* permission of Sam Leffler and Silicon Graphics.
*
* THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
* EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
* WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
*
* IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
* ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
* OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
* WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
* LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE.
*/
#ifndef _Array_
#define _Array_
#include <stdlib.h>
#include "Obj.h"
#include "Ptr.h"
// Here's what the declaration of an array class looks like to the user:
/*
class ARRAY<ITEM> : public fxArray {
public:
ARRAY();
ARRAY(u_int size);
ARRAY(ARRAY const &);
ARRAY& operator=(ARRAY const &);
ITEM & operator[](u_int index) const;
u_int length() const;
void append(ITEM const & item);
void append(ARRAY const & a);
void remove(u_int start, u_int leng=1);
ARRAY cut(u_int start, u_int leng=1);
void insert(ITEM const & item, u_int p);
void insert(ARRAY const & a, u_int posn);
void resize(u_int length);
ARRAY extract(u_int start, u_int len);
void head(u_int len);
void tail(u_int len);
u_int find(ITEM const & item) const;
void qsort(u_int start, u_int len);
void swap(u_int,u_int);
protected:
virtual void getmem();
virtual void expand();
virtual void createElements(void*, u_int numbytes);
virtual void destroyElements(void*, u_int numbytes);
virtual void copyElements(void const *src, void *dst, u_int numbytes);
virtual int compareElements(void const *elem1, void const *elem2);
};
*/
//
// There are three flavors of arrays:
// struct Arrays (in which the contents of the elements are not looked at)
// pointer Arrays (the elements are pointers to some memory)
// object Arrays (the elements are objects, which must be constructed and
// destructed)
//
// Macros exist for each of these fxArray flavors:
// fxDECLARE_Array (same as fxDECLARE_StructArray)
// fxDECLARE_PtrArray
// (acts like fxDECLARE_Array, except that pointers are
// initialized to nil when new elements are added)
// fxDECLARE_ObjArray
static const u_int fx_invalidArrayIndex = (u_int) -1;
class fxArray : public fxObj {
public:
u_int length() const;
u_int elementSize() const
{ return elementsize; }
void resize(u_int length);
void setMaxLength(u_int maxlength);
void qsort(u_int posn, u_int len);
void qsort();
void swap(u_int,u_int);
virtual char const *className() const = 0;
protected:
class fxAddress {
public:
fxAddress() { ptr = 0; }
fxAddress(void* p) { ptr = (char*) p; }
fxAddress operator+(u_long offset) const { return ptr + offset; }
bool operator==(const fxAddress& r) const { return ptr == r.ptr; }
bool operator!=(const fxAddress& r) const { return ptr != r.ptr; }
// NB: operator const void*() const does not work
operator void*() const { return ptr; }
protected:
char* ptr;
};
fxArray(u_short esize, u_int initlength=0);
fxArray(u_int esize, u_int num, void *data);
fxArray(fxArray const &);
virtual ~fxArray();
void * operator[](u_int index) { return data + elementsize*index; }
fxArray& operator=(fxArray const &);
void append(void const *item);
void append(fxArray const &);
void remove(u_int start, u_int length=1);
void insert(fxArray const &, u_int posn);
void insert(void const *item, u_int posn);
u_int find(void const *, u_int start=0) const;
// The objects in the array are stored sequentially at the
// location pointed to by data. The length of the known
// allocated segment is stored in maxi, in bytes. The
// length of the array is stored in num, in *bytes*. The
// size of an array element is stored in elementsize, in bytes.
// data is allowed to be nil iff (maxi==0)
fxAddress data;
// num <= maxi
u_int maxi,num;
u_short elementsize;
// These two methods control how the array class goes to
// fetch more memory.
virtual void getmem();
virtual void expand();
// The raw methods are used to
// implement methods which return an fxArray type.
void * raw_copy() const;
void * raw_extract(u_int start, u_int length) const;
void * raw_cut(u_int start, u_int length);
void * raw_head(u_int) const;
void * raw_tail(u_int) const;
void qsortInternal(u_int, u_int, void *);
void destroy();
// These three methods can be overridden to properly copy, delete,
// and create new array elements in the desired manner. By default
// `create' and `destroy' do nothing, and `copy' is a simple bcopy.
//
// The job of create is to take an area of uninitialized memory and
// create a series of valid objects in it. The job of destroy is to
// take a series of valid objects and destroy any resources they
// consume. The status of the memory after the destroy is irrelevant.
// The job of copy is to take a source array of objects, and copy
// them to an area of *uninitialized* memory. There will not be any
// objects stored there previous to the copy.
virtual void createElements(void *, u_int numbytes);
virtual void destroyElements(void *, u_int numbytes);
virtual void copyElements(void const *src, void *dst, u_int numbytes)
const;
virtual int compareElements(void const *, void const *) const;
};
#define fxArrayHeader(ARRAY,ITEM) \
ARRAY(); \
ARRAY(u_int size); \
ARRAY(ARRAY const&a); \
~ARRAY(); \
virtual const char* className() const; \
ARRAY& operator=(ARRAY const& a) { \
maxi = a.maxi; num = a.num; if (data) free(data); \
data = memmove(malloc(num), a.data, num); return (*this);} \
ITEM & operator[](u_int index) { \
fxAssert(index*sizeof(ITEM) < num, "Invalid Array[] index"); \
return *(ITEM *)((char *)((void *)data) + index*sizeof(ITEM)); \
} \
const ITEM & operator[](u_int index) const { \
fxAssert(index*sizeof(ITEM) < num, "Invalid Array[] index"); \
return *(const ITEM *)((char *)((void *)data) + index*sizeof(ITEM));\
} \
void append(ITEM const & item) { fxArray::append(&item); } \
void append(ARRAY const & a) { fxArray::append(a); } \
void remove(u_int start, u_int length=1) \
{ fxArray::remove(start,length); } \
ARRAY cut(u_int start, u_int len = 1); \
void insert(ARRAY const & a, u_int p) \
{ fxArray::insert(a,p); } \
void insert(ITEM const & item, u_int p) \
{ fxArray::insert(&item,p);} \
ARRAY extract(u_int start, u_int len); \
ARRAY head(u_int len = 1); \
ARRAY tail(u_int len = 1); \
int find(ITEM const& x, u_int start=0) const { \
return fxArray::find(&x,start); \
} \
protected: \
ARRAY(u_int esize, u_int num, void *data); \
public: \
__enddef__
#define fxArrayVirtuals \
protected: \
virtual void createElements(void *,u_int); \
virtual void destroyElements(void *,u_int); \
virtual void copyElements(void const*,void*,u_int) const; \
virtual int compareElements(void const *, void const *) const; \
__enddef__
//----------------------------------------------------------------------
// Declare an array containing items of type ITEM.
#define fxDECLARE_Array(ARRAY,ITEM) \
class ARRAY : public fxArray { \
public: \
fxArrayHeader(ARRAY,ITEM) \
}; \
fxDECLARE_Ptr(ARRAY); \
__enddef__
#define fxDECLARE_StructArray(ARRAY,ITEM) fxDECLARE_Array(ARRAY,ITEM)
#define fxDECLARE_PrimArray(ARRAY,ITEM) fxDECLARE_Array(ARRAY,ITEM)
#define fxDECLARE_ObjArray(ARRAY,ITEM) \
class ARRAY : public fxArray { \
public: \
fxArrayHeader(ARRAY,ITEM) \
fxArrayVirtuals \
}; \
fxDECLARE_Ptr(ARRAY); \
__enddef__
#define fxDECLARE_PtrArray(ARRAY, POINTER) \
class ARRAY : public fxArray { \
public: \
fxArrayHeader(ARRAY,POINTER) \
protected: \
virtual void createElements(void *, u_int); \
}; \
fxDECLARE_Ptr(ARRAY); \
__enddef__
//----------------------------------------------------------------------
// Various method implementations
#define fxIMPLEMENT_ArrayMethods(ARRAY,ITEM) \
ARRAY::ARRAY() : fxArray(sizeof(ITEM)) \
{ if (data) createElements(data,num); } \
ARRAY::ARRAY(ARRAY const& a) : fxArray(a.elementsize) \
{ maxi = a.maxi; num = a.num; data = a.raw_copy(); } \
ARRAY::ARRAY(u_int size) : fxArray(sizeof(ITEM),size) \
{ createElements(data,num); } \
ARRAY::~ARRAY() { destroy(); } \
const char* ARRAY::className() const { return fxQUOTE(ARRAY); } \
ARRAY ARRAY::cut(u_int start, u_int len) \
{return ARRAY(sizeof(ITEM), len*sizeof(ITEM),raw_cut(start,len));}\
ARRAY ARRAY::extract(u_int start, u_int len) \
{return ARRAY(sizeof(ITEM), len*sizeof(ITEM),raw_extract(start,len));}\
ARRAY ARRAY::head(u_int len) \
{return ARRAY(sizeof(ITEM), len*sizeof(ITEM),raw_head(len));} \
ARRAY ARRAY::tail(u_int len) \
{return ARRAY(sizeof(ITEM),len*sizeof(ITEM),raw_tail(len));} \
ARRAY::ARRAY(u_int esize, u_int num, void * data) \
: fxArray(esize,num,data) {} \
__enddef__
#define fxIMPLEMENT_ObjArrayMethods(ARRAY,ITEM) \
void ARRAY::createElements(void * start, u_int numbytes) { \
ITEM * ptr = (ITEM *)start; \
for (;;) { \
if (numbytes == 0) break; \
numbytes -= elementsize; \
ITEM * obj = new(ptr) ITEM; \
ptr++; \
(void) obj; \
} \
} \
void ARRAY::destroyElements(void * start, u_int numbytes) { \
ITEM * ptr = (ITEM *)start; \
while (numbytes) { \
numbytes -= elementsize; \
ptr->ITEM::~ITEM(); \
ptr++; \
} \
} \
void ARRAY::copyElements(void const * src, void * dst, \
u_int numbytes) const { \
if (src<dst) { \
src = (const char*)src + numbytes; \
dst = (char*)dst + numbytes; \
const ITEM * p = (const ITEM *)src - 1; \
ITEM * q = (ITEM *)dst - 1; \
while (numbytes > 0) { \
ITEM * obj = new(q) ITEM(*p); \
q--; p--; \
numbytes -= elementsize; \
(void) obj; \
} \
} else { \
const ITEM * p = (const ITEM *)src; \
ITEM * q = (ITEM *)dst; \
while (numbytes > 0) { \
ITEM * obj = new(q) ITEM(*p); \
q++; p++; \
numbytes -= elementsize; \
(void) obj; \
} \
} \
} \
int ARRAY::compareElements(void const *o1, void const *o2) const \
{ \
return ((const ITEM *)o1)->compare((const ITEM *)o2); \
} \
__enddef__
#define fxIMPLEMENT_PtrArrayMethods(ARRAY,POINTER) \
void ARRAY::createElements(void * start, u_int numbytes) { \
memset(start,0,numbytes); \
} \
__enddef__
//----------------------------------------------------------------------
// Implement various types of arrays
#define fxIMPLEMENT_Array(ARRAY,ITEM) \
fxIMPLEMENT_ArrayMethods(ARRAY,ITEM) \
__enddef__
#define fxIMPLEMENT_PrimArray(ARRAY,ITEM) \
fxIMPLEMENT_ArrayMethods(ARRAY,ITEM) \
__enddef__
#define fxIMPLEMENT_StructArray(ARRAY,ITEM) \
fxIMPLEMENT_ArrayMethods(ARRAY,ITEM) \
__enddef__
#define fxIMPLEMENT_ObjArray(ARRAY,ITEM) \
fxIMPLEMENT_ArrayMethods(ARRAY,ITEM) \
fxIMPLEMENT_ObjArrayMethods(ARRAY,ITEM) \
__enddef__
#define fxIMPLEMENT_PtrArray(ARRAY,POINTER) \
fxIMPLEMENT_Array(ARRAY,POINTER) \
fxIMPLEMENT_PtrArrayMethods(ARRAY,POINTER) \
__enddef__
#endif /* _ARRAY_ */
|