File size: 13,661 Bytes
10f2621 | 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 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | /**
* @defgroup Vset Vset class
* @brief A dynamic set object.
*/
/**
* @file vset.h
* @ingroup Vset
* @brief Class Vset: a dynamic set object.
* @author Michael Holst
* @note None
* @version $Id: vset.h,v 1.20 2010/08/12 05:40:37 fetk Exp $
*
* @attention
* @verbatim
*
* MALOC = < Minimal Abstraction Layer for Object-oriented C >
* Copyright (C) 1994-- Michael Holst
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @endverbatim
*/
#ifndef _VSET_H_
#define _VSET_H_
#include <maloc/maloc_base.h>
#include <maloc/vnm.h>
#include <maloc/vmem.h>
/*
* ***************************************************************************
* Class Vset: Parameters and datatypes
* ***************************************************************************
*/
/**
* @ingroup Vset
* @author Michael Holst
* @brief Contains public data members for Vset class
*/
struct sVset {
/** @brief the memory manager */
Vmem *vmem;
/** @brief did i make vmem or was it inherited */
int iMadeVmem;
/** @brief the current "T" object in our collection */
int curT;
/** @brief name of object we are managing */
char nameT[VMAX_ARGLEN];
/** @brief size of the object in bytes */
int sizeT;
/** @brief total number of allocated blocks */
int numBlocks;
/** @brief the global "T" counter -- how many "T"s in list */
int numT;
/** @brief for i/o at appropriate block creation/deletion */
int prtT;
/** @brief number of objects to manage (user specified) */
int maxObjects;
/** @brief power of 2 for blocksize (e.g., =10, or =16) */
int blockPower;
/** @brief blocksize is 2^(blockPower) */
int blockSize;
/** @brief num blocks = blockMax=(maxObjects/blockSize) */
int blockMax;
/** @brief =blockSize-1; for determining which block fast */
int blockModulo;
/** @brief list of pointers to blocks of storage we manage */
char **table;
};
/**
* @brief Declaration of the Vset class as the Vset structure
* @ingroup Vset
* @author Michael Holst
*/
typedef struct sVset Vset;
/****************************************************************/
/* Class Vset: Inlineable method (vset.c) */
/****************************************************************/
#if !defined(VINLINE_MALOC)
/**
* @ingroup Vset
* @brief Return the number of things currently in the list.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the number of things currently in the list.
* @param thee Pointer to the Vset object
*/
VEXTERNC int Vset_num(Vset *thee);
/**
* @ingroup Vset
* @brief Access an object in an arbitrary place in the list.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return list of pointers to blocks of storage we manage
* @param thee Pointer to the Vset object
* @param i index of the object
*/
VEXTERNC char *Vset_access(Vset *thee, int i);
/**
* @ingroup Vset
* @brief Create an object on the end of the list.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return Pointer to a created Vset object on the end of the list
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_create(Vset *thee);
/**
* @ingroup Vset
* @brief Return the first object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the first object in the set
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_first(Vset *thee);
/**
* @ingroup Vset
* @brief Return the last object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the last object in the set.
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_last(Vset *thee);
/**
* @ingroup Vset
* @brief Return the next object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the next object in the set.
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_next(Vset *thee);
/**
* @ingroup Vset
* @brief Return the prev object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the prev object in the set
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_prev(Vset *thee);
/**
* @ingroup Vset
* @brief Return the first object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the first object in the set
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_peekFirst(Vset *thee);
/**
* @ingroup Vset
* @brief Return the last object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the last object in the set.
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_peekLast(Vset *thee);
/**
* @ingroup Vset
* @brief Delete an object from the end of the list.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
VEXTERNC void Vset_destroy(Vset *thee);
#else /* if defined(VINLINE_MALOC) */
/**
* @ingroup Vset
* @brief the global "T" counter -- how many "T"s in list
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
# define Vset_num(thee) ((thee)->numT)
/**
* @ingroup Vset
* @brief Access an object in an arbitrary place in the list.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return list of pointers to blocks of storage we manage
* @param thee Pointer to the Vset object
* @param i index of the object
*/
# define Vset_access(thee,i) ( \
((i >= 0) && (i < thee->numT)) \
? &((thee)->table[ (i)>>(thee)->blockPower ] \
[ (thee)->sizeT*((i)&(thee)->blockModulo) ]) \
: VNULL \
)
/**
* @ingroup Vset
* @brief Create an object on the end of the list.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return Pointer to a created Vset object on the end of the list
* @param thee Pointer to the Vset object
*/
# define Vset_create(thee) ( \
( ((((thee)->numT)>>(thee)->blockPower) >= (thee)->numBlocks) \
|| ((((thee)->numT+1)%(thee)->prtT) == 0) ) \
? (Vset_createLast((thee))) \
: (++((thee)->numT), (Vset_access((thee),(thee)->numT-1))) \
)
/**
* @ingroup Vset
* @brief Return the first object in the set
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the first object in the set
* @param thee Pointer to the Vset object
*/
# define Vset_first(thee) ( \
(thee)->curT = 0, \
Vset_access((thee), (thee)->curT) \
)
/**
* @ingroup Vset
* @brief Return the last object in the set
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the last object in the set
* @param thee Pointer to the Vset object
*/
# define Vset_last(thee) ( \
(thee)->curT = (thee)->numT-1, \
Vset_access((thee), (thee)->curT) \
)
/**
* @ingroup Vset
* @brief Return the next object in the set
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the next object in the set
* @param thee Pointer to the Vset object
*/
# define Vset_next(thee) ( \
(thee)->curT++, \
((thee)->curT < (thee)->numT) \
? Vset_access((thee), (thee)->curT) \
: VNULL \
)
/**
* @ingroup Vset
* @brief Return the prev object in the set
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the prev object in the set
* @param thee Pointer to the Vset object
*/
# define Vset_prev(thee) ( \
(thee)->curT--, \
((thee)->curT >= 0) \
? Vset_access((thee), (thee)->curT) \
: VNULL \
)
/**
* @ingroup Vset
* @brief Return the first object in the set.
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the first object in the set.
* @param thee Pointer to the Vset object
*/
# define Vset_peekFirst(thee) ( \
Vset_access((thee), 0) \
)
/**
* @ingroup Vset
* @brief Return the last object in the set
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return the last object in the set
* @param thee Pointer to the Vset object
*/
# define Vset_peekLast(thee) ( \
Vset_access((thee), (thee)->numT-1) \
)
/**
* @ingroup Vset
* @brief Free up the object currently on the end of the list
* @author Michael Holst
* @note Class Vset: Inlineable method (vset.c)
* @return no return
* @param thee Pointer to the Vset object
*/
# define Vset_destroy(thee) ( \
( ((((thee)->numT-1)>>(thee)->blockPower) < (thee)->numBlocks-1) \
|| ((thee)->numT == 1) || ((((thee)->numT)%(thee)->prtT) == 0) ) \
? (Vset_destroyLast((thee))) : (void)(((thee)->numT)--) \
)
#endif /* if !defined(VINLINE_MALOC) */
/**
* @ingroup Vset
* @brief Construct the set object.
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return Pointer to a new allocated Vset object
* @param vmem Memory management object
* @param tname name of object we are managing
* @param tsize size of the object in bytes
* @param tmaxNum number of objects to manage (user specified)
* @param ioKey index for i/o
*/
VEXTERNC Vset* Vset_ctor(Vmem *vmem,
const char *tname, int tsize, int tmaxNum, int ioKey);
/**
* @ingroup Vset
* @brief Destroy the set object.
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
VEXTERNC void Vset_dtor(Vset **thee);
/**
* @ingroup Vset
* @brief Create an object on the end of the list
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return Pointer to the created Vset object
* @param thee Pointer to the Vset object
*/
VEXTERNC char *Vset_createLast(Vset *thee);
/**
* @ingroup Vset
* @brief Free up the object currently on the end of the list.
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
VEXTERNC void Vset_destroyLast(Vset *thee);
/**
* @ingroup Vset
* @brief Initialize the Vset data (thee).
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
VEXTERNC void Vset_initData(Vset *thee);
/**
* @ingroup Vset
* @brief Release all Ram controlled by this (thee) and re-initialize.
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
VEXTERNC void Vset_reset(Vset *thee);
/**
* @ingroup Vset
* @brief Get and return the RAM Control Block (thee) information.
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
* @param tnum the global "T" counter -- how many "T"s in list
* @param tsize size of the object in bytes
* @param tVecUse size of the total objects
* @param tVecMal size of the total RAM Control Block
* @param tVecOhd maximal size of RAM Control Block
*/
VEXTERNC void Vset_check(Vset *thee,
int *tnum, int *tsize, int *tVecUse, int *tVecMal, int *tVecOhd);
/**
* @ingroup Vset
* @brief Print the exact current malloc usage.
* @author Michael Holst
* @note Class Vset: Non-Inlineable method (vset.c)
* @return None
* @param thee Pointer to the Vset object
*/
VEXTERNC void Vset_memChk(Vset *thee);
#endif /* _VSET_H_ */
|