generic/compiler/destroyinst.h

/*
 *  Ascend Instance Tree Killing
 *  by Tom Epperly
 *  8/16/89
 *  Version: $Revision: 1.6 $
 *  Version control file: $RCSfile: destroyinst.h,v $
 *  Date last modified: $Date: 1997/07/18 12:28:54 $
 *  Last modified by: $Author: mthomas $
 *
 *  This file is part of the Ascend Language Interpreter.
 *
 *  Copyright (C) 1996 Ben Allan
 *  based on instance.c
 *  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.
 */

/** @file
 *  Ascend Instance Tree Killing.
 *  <pre>
 *  When #including destroyinst.h, make sure these files are #included first:
 *         #include "utilities/ascConfig.h"
 *         #include "instance_enum.h"
 *  </pre>
 */

#ifndef __DESTROYINST_H_SEEN__
#define __DESTROYINST_H_SEEN__

ASC_DLLSPEC(void ) DestroyInstance(struct Instance *inst, struct Instance *parent);
/**<
 *  If parent is NULL, this will destroy all references to inst and deallocate
 *  the memory associated with inst.  It will delete inst's reference to its
 *  children.  If parent is not NULL, this will destroy parent's reference
 *  to inst.  If this is the only reference to inst, it will deallocate the
 *  memory associated with inst.<br><br>
 *
 *  DestroyInstance will modify the parent's of inst to remove the reference.
 */
/*
 *  void DestroyInstance(inst,parent)
 *  struct Instance *inst,*parent;
 */

#endif  /* __DESTROYINST_H_SEEN__ */

1	jds	54	/*
2	aw0a	1	* Ascend Instance Tree Killing
3			* by Tom Epperly
4			* 8/16/89
5			* Version: $Revision: 1.6 $
6			* Version control file: $RCSfile: destroyinst.h,v $
7			* Date last modified: $Date: 1997/07/18 12:28:54 $
8			* Last modified by: $Author: mthomas $
9			*
10			* This file is part of the Ascend Language Interpreter.
11			*
12			* Copyright (C) 1996 Ben Allan
13			* based on instance.c
14			* Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly
15			*
16			* The Ascend Language Interpreter is free software; you can redistribute
17			* it and/or modify it under the terms of the GNU General Public License as
18			* published by the Free Software Foundation; either version 2 of the
19			* License, or (at your option) any later version.
20			*
21			* The Ascend Language Interpreter is distributed in hope that it will be
22			* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24			* General Public License for more details.
25			*
26			* You should have received a copy of the GNU General Public License
27			* along with the program; if not, write to the Free Software Foundation,
28			* Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
29			* COPYING.
30			*/
31
32	jds	54	/** @file
33			* Ascend Instance Tree Killing.
34			* <pre>
35	aw0a	1	* When #including destroyinst.h, make sure these files are #included first:
36	jds	54	* #include "utilities/ascConfig.h"
37	aw0a	1	* #include "instance_enum.h"
38	jds	54	* </pre>
39	aw0a	1	*/
40
41	jds	54	#ifndef __DESTROYINST_H_SEEN__
42			#define __DESTROYINST_H_SEEN__
43	aw0a	1
44	johnpye	522	ASC_DLLSPEC(void ) DestroyInstance(struct Instance inst, struct Instance parent);
45	jds	54	/**<
46	aw0a	1	* If parent is NULL, this will destroy all references to inst and deallocate
47			* the memory associated with inst. It will delete inst's reference to its
48			* children. If parent is not NULL, this will destroy parent's reference
49			* to inst. If this is the only reference to inst, it will deallocate the
50	jds	54	* memory associated with inst.<br><br>
51	aw0a	1	*
52			* DestroyInstance will modify the parent's of inst to remove the reference.
53			*/
54	jds	54	/*
55			* void DestroyInstance(inst,parent)
56			* struct Instance inst,parent;
57			*/
58	aw0a	1
59	jds	54	#endif /* __DESTROYINST_H_SEEN__ */
60	aw0a	1