generic/interface/typelex.h

/*
 *  Typelex.h
 *  by Kirk Abbott and Ben Allan
 *  Created: 1/94
 *  Version: $Revision: 1.6 $
 *  Version control file: $RCSfile: typelex.h,v $
 *  Date last modified: $Date: 2003/08/23 18:43:09 $
 *  Last modified by: $Author: ballan $
 *
 *  This file is part of the ASCEND Tcl/Tk interface
 *
 *  Copyright 1997, Carnegie Mellon University
 *
 *  The ASCEND Tcl/Tk interface 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 Tcl/Tk interface 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.  COPYING is found in ../compiler.
 */

/** @file
 *  Lexical scanner.
 *  <pre>
 *  Requires:     #include "tcl.h"
 *                #include "utilities/ascConfig.h"
 *  </pre>
 */

#ifndef ASCTK_TYPELEX_H
#define ASCTK_TYPELEX_H

STDHLF_H(Asc_ExtractType);
/**< Help long string function. */

extern int Asc_ExtractType(ClientData cdata, Tcl_Interp *interp,
                           int argc, CONST84 char **argv);
/**<
 *  <!--  int Asc_ExtractType(cdata, interp, argc, argv)               -->
 *  <!--      ClientData cdata;   --client data, not used              -->
 *  <!--      Tcl_Interp *interp; --tcl interpreter, not used          -->
 *  <!--      int argc;           --the number of arguments            -->
 *  <!--      char **argv;        --the array of arguments             -->
 *
 *  This is the Tcl callback for the type extractor command.
 */
/**  Registered as */
#define Asc_ExtractTypeHN "libr_extract_type"
/** Usage */
#define Asc_ExtractTypeHU \
    Asc_ExtractTypeHN " [-c] <type> [source_file] [-s,destination_file]"
/** Short help text */
#define Asc_ExtractTypeHS \
    "Returns the ASCEND code that defines an ATOM or MODEL"
/** Long help text part 1 */
#define Asc_ExtractTypeHL1 "\
 *  Extracts the definition of the ATOM or MODEL <type> from the specified\n\
 *  source file (or stdin if not specified) and writes it to the specified\n\
 *  destination file (or stdout if not specified).  Comments are stripped\n\
"
/** Long help text part 2 */
#define Asc_ExtractTypeHL2 "\
 *  from the code unless the -c flag is given.  Returns TCL_OK if successful\n\
 *  If unsuccessful, returns TCL_ERROR and puts the error message into\n\
 *  interp->result. If -s is given instead of destination, output to interp.\n\
 *  source_file may be an interactive string module when in ASCEND.\n\
"

/**<
extern void Asc_PutCode(char *s, FILE *fp);
 * Intended for internal use only. Puts the echoed code out to
 * file or string as determined by -s instead of output file.
 *
 *  NOTES:
 *  Maybe we should consider returning the type definition in
 *  interp->result.  Assumes source-file contains valid ASCEND code.
 *  When looking for the type `foo', the tokens ``END foo'' inside of a
 *  singlely or doubly quoted string will be registered as the end of the
 *  MODEL or ATOM.  The tokens ``END foo'' may safely appear in a comment
 *  or the text of a NOTE.
 */

#endif  /* ASCTK_TYPELEX_H */

1	/*
2	* Typelex.h
3	* by Kirk Abbott and Ben Allan
4	* Created: 1/94
5	* Version: $Revision: 1.6 $
6	* Version control file: $RCSfile: typelex.h,v $
7	* Date last modified: $Date: 2003/08/23 18:43:09 $
8	* Last modified by: $Author: ballan $
9	*
10	* This file is part of the ASCEND Tcl/Tk interface
11	*
12	* Copyright 1997, Carnegie Mellon University
13	*
14	* The ASCEND Tcl/Tk interface is free software; you can redistribute
15	* it and/or modify it under the terms of the GNU General Public License as
16	* published by the Free Software Foundation; either version 2 of the
17	* License, or (at your option) any later version.
18	*
19	* The ASCEND Tcl/Tk interface is distributed in hope that it will be
20	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22	* General Public License for more details.
23	*
24	* You should have received a copy of the GNU General Public License
25	* along with the program; if not, write to the Free Software Foundation,
26	* Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
27	* COPYING. COPYING is found in ../compiler.
28	*/
29
30	/** @file
31	* Lexical scanner.
32	* <pre>
33	* Requires: #include "tcl.h"
34	* #include "utilities/ascConfig.h"
35	* </pre>
36	*/
37
38	#ifndef ASCTK_TYPELEX_H
39	#define ASCTK_TYPELEX_H
40
41	STDHLF_H(Asc_ExtractType);
42	/*< Help long string function. /
43
44	extern int Asc_ExtractType(ClientData cdata, Tcl_Interp *interp,
45	int argc, CONST84 char **argv);
46	/**<
47	* <!-- int Asc_ExtractType(cdata, interp, argc, argv) -->
48	* <!-- ClientData cdata; --client data, not used -->
49	* <!-- Tcl_Interp *interp; --tcl interpreter, not used -->
50	* <!-- int argc; --the number of arguments -->
51	* <!-- char **argv; --the array of arguments -->
52	*
53	* This is the Tcl callback for the type extractor command.
54	*/
55	/** Registered as */
56	#define Asc_ExtractTypeHN "libr_extract_type"
57	/** Usage */
58	#define Asc_ExtractTypeHU \
59	Asc_ExtractTypeHN " [-c] <type> [source_file] [-s,destination_file]"
60	/** Short help text */
61	#define Asc_ExtractTypeHS \
62	"Returns the ASCEND code that defines an ATOM or MODEL"
63	/** Long help text part 1 */
64	#define Asc_ExtractTypeHL1 "\
65	* Extracts the definition of the ATOM or MODEL <type> from the specified\n\
66	* source file (or stdin if not specified) and writes it to the specified\n\
67	* destination file (or stdout if not specified). Comments are stripped\n\
68	"
69	/** Long help text part 2 */
70	#define Asc_ExtractTypeHL2 "\
71	* from the code unless the -c flag is given. Returns TCL_OK if successful\n\
72	* If unsuccessful, returns TCL_ERROR and puts the error message into\n\
73	* interp->result. If -s is given instead of destination, output to interp.\n\
74	* source_file may be an interactive string module when in ASCEND.\n\
75	"
76
77	/**<
78	extern void Asc_PutCode(char s, FILE fp);
79	* Intended for internal use only. Puts the echoed code out to
80	* file or string as determined by -s instead of output file.
81	*
82	* NOTES:
83	* Maybe we should consider returning the type definition in
84	* interp->result. Assumes source-file contains valid ASCEND code.
85	* When looking for the type `foo', the tokens ``END foo'' inside of a
86	* singlely or doubly quoted string will be registered as the end of the
87	* MODEL or ATOM. The tokens ``END foo'' may safely appear in a comment
88	* or the text of a NOTE.
89	*/
90
91	#endif /* ASCTK_TYPELEX_H */
92