generic/compiler/findpath.h

/*  ASCEND modelling environment
    Copyright (C) 2006 Benjamin Andrew Allan
    Copyright (C) 2006 Carnegie Mellon University

    This program 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, or (at your option)
    any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//** @file
 *  Ascend Instance Tree Name Search Routines.
 *  <pre>
 *  When #including find.h, make sure these files are #included first:
 *         #include "utilities/ascConfig.h"
 *         #include "fractions.h"
 *         #include "compiler.h"
 *         #include "instance_enum.h"
 *         #include "dimen.h"
 *         #include "expr_types.h"
 *         #include "find.h"
 *  </pre>
*//*
    by Ben Allan
    Created: 10/3/2006
*/

#ifndef ASC_FINDPATH_H
#define ASC_FINDPATH_H

/** addtogroup compiler Compiler
    @{
*/

extern struct gl_list_t *FindInstancesPaths(CONST struct Instance *i,
                                       CONST struct Name *n,
                                       enum find_errors *err);
/**<
 *  Return the list of Names expanded from n that have instances.
 *  Don't forget to destroy the names in the list before destroying list.
 *  If this returns NULL,
 *  it indicates that it couldn't find something in the name.
 *  Check err to discover why.
 */

/* @} */

#endif /* ASC_FINDPATH_H */

1	johnpye	1031	/* ASCEND modelling environment
2			Copyright (C) 2006 Benjamin Andrew Allan
3			Copyright (C) 2006 Carnegie Mellon University
4
5			This program is free software; you can redistribute it and/or modify
6			it under the terms of the GNU General Public License as published by
7			the Free Software Foundation; either version 2, or (at your option)
8			any later version.
9
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			GNU General Public License for more details.
14
15			You should have received a copy of the GNU General Public License
16			along with this program; if not, write to the Free Software
17			Foundation, Inc., 59 Temple Place - Suite 330,
18			Boston, MA 02111-1307, USA.
19			//* @file
20			* Ascend Instance Tree Name Search Routines.
21			* <pre>
22			* When #including find.h, make sure these files are #included first:
23			* #include "utilities/ascConfig.h"
24			* #include "fractions.h"
25			* #include "compiler.h"
26			* #include "instance_enum.h"
27			* #include "dimen.h"
28			* #include "expr_types.h"
29			* #include "find.h"
30			* </pre>
31			//
32			by Ben Allan
33			Created: 10/3/2006
34			*/
35
36			#ifndef ASC_FINDPATH_H
37			#define ASC_FINDPATH_H
38
39	johnpye	1066	/** addtogroup compiler Compiler
40			@{
41			*/
42
43	johnpye	1031	extern struct gl_list_t FindInstancesPaths(CONST struct Instance i,
44			CONST struct Name *n,
45			enum find_errors *err);
46			/**<
47			* Return the list of Names expanded from n that have instances.
48			* Don't forget to destroy the names in the list before destroying list.
49			* If this returns NULL,
50			* it indicates that it couldn't find something in the name.
51			* Check err to discover why.
52			*/
53
54	johnpye	1066	/* @} */
55
56	johnpye	1031	#endif /* ASC_FINDPATH_H */
57