/home/doxygen/libascend/compiler/freestore.h

Go to the documentation of this file.

/*
 *  Implementation of Free Store Module
 *  Kirk A. Abbott
 *  Created Dec 18, 1994
 *  Version: $Revision: 1.5 $
 *  Version control file: $RCSfile: freestore.h,v $
 *  Date last modified: $Date: 1998/06/16 16:36:27 $
 *  Last modified by: $Author: mthomas $
 *
 *  This file is part of the Ascend Language Interpreter.
 *
 *  Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly
 *
 *  The Ascend Language Interpreter is free software; you can
 *  redistribute it and/or modify it under the terms of the GNU
 *  General Public License as published by the Free Software
 *  Foundation; either version 2 of the License, or (at your option)
 *  any later version.
 *
 *  The Ascend Language Interpreter is distributed in 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with the program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139 USA.  Check
 *  the file named COPYING.
 */

#ifndef ASC_FREESTORE_H
#define ASC_FREESTORE_H

struct FreeStore {
  union RelationTermUnion **root;     
  union RelationTermUnion *next_free; 
  struct gs_stack_t *returned;        
  int n_buffers;                      
  int buffer_length;                  
  int row;                            
  int col;                            
};

extern long FreeStore_UnitsAllocated();
extern void FreeStore__Statistics(FILE *fp, struct FreeStore *store);
extern void FreeStore__BlastMem(struct FreeStore *store);
/*
 *  These are the normal user level routines.
 *
 *  Known Bugs:
 *  The blocks returned the user are never anything but the size of
 *  a relation token. This is not highly reuseable.
 *
 *  Features?:
 *  This module runs a stack of free_stores, which is sometimes
 *  handy, to avoid passing around a free_store pointer. Note,
 *  however, that it costs just as much to dereference the global
 *  variables as it does to pass the store pointer.
 */

extern struct FreeStore *FreeStore_Create(int n_buffers, int buffer_length);
extern void FreeStore_ReInit(struct FreeStore *store);
extern union RelationTermUnion *GetMem();
extern void FreeMem(union RelationTermUnion *term);
extern union RelationTermUnion
*FreeStoreCheckMem(union RelationTermUnion *term);
extern void FreeStore_SetFreeStore(struct FreeStore *store);
extern struct FreeStore *FreeStore_GetFreeStore(void);
/* @} */

#endif /* ASC_FREESTORE_H */

---