/[ascend]/trunk/tcltk98/generic/interface/ScriptProc.h
ViewVC logotype

Diff of /trunk/tcltk98/generic/interface/ScriptProc.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 17 by aw0a, Tue Dec 7 17:37:58 2004 UTC revision 54 by jds, Tue Aug 2 11:20:09 2005 UTC
# Line 27  Line 27 
27   *  COPYING.  COPYING is found in ../compiler.   *  COPYING.  COPYING is found in ../compiler.
28   */   */
29    
30    /** @file
31     *  Script procedures.
32     *  <pre>
33     *  Requires:     #include "tcl.h"
34     *                #include "utilities/ascConfig.h"
35     *  </pre>
36     */
37    
38  #ifndef ScriptProc_module_loaded  #ifndef ScriptProc_module_loaded
39  #define ScriptProc_module_loaded  #define ScriptProc_module_loaded
40    
41  extern int Asc_ScriptInterrupt;  extern int Asc_ScriptInterrupt;
42  /* The C variable corresponding to the script being interrupted  /**<
43     * The C variable corresponding to the script being interrupted
44   * by an interactive user or call with a trapped exception.   * by an interactive user or call with a trapped exception.
45   */   */
46    
47  extern int Asc_ScriptConfigureInterrupt(int, Tcl_Interp *interp);  extern int Asc_ScriptConfigureInterrupt(int bool, Tcl_Interp *interp);
48  /*  /**<
49   * err = Asc_ScriptConfigureInterrupt(bool,interp);   * <!--  err = Asc_ScriptConfigureInterrupt(bool,interp);              -->
50   * int err,bool;   * <!--  int err,bool;                                                 -->
  * interp is the interpretter the ascend application is running in.  
  * err is 0 if the call is ok, err is 1 if the call is not ok.  
  * bool is 1 at startup and 0 at shutdown.  
51   * Configures the script variable ascScripVect(menubreak) to   * Configures the script variable ascScripVect(menubreak) to
52   * shadow the C int Asc_ScriptInterrupt.   * shadow the C int Asc_ScriptInterrupt.
53   * Tcl makes sure changes to ascScripVect(menubreak)   * Tcl makes sure changes to ascScripVect(menubreak)
54   * are reflected in the C variable.   * are reflected in the C variable.
55   * See the man pages of Tcl_LinkVar, Tcl_UnlinkVar, Tcl_UpdateLinkedVar   * See the man pages of Tcl_LinkVar, Tcl_UnlinkVar, Tcl_UpdateLinkedVar
56   * for details.   * for details.
57     *
58     * @param interp The interpretter the ascend application is running in.
59     * @param bool   Is 1 at startup and 0 at shutdown.
60     * @return Returns 0 if the call is ok, 1 if the call is not ok.
61   */   */
62    
63  extern int Asc_ScriptEvalCmd(ClientData cdata, Tcl_Interp *interp,  extern int Asc_ScriptEvalCmd(ClientData cdata, Tcl_Interp *interp,
64                               int argc, CONST84 char *argv[]);                               int argc, CONST84 char *argv[]);
65  /*  /**<
66   *  int Asc_ScriptEvalCmd;   *  <!--  int Asc_ScriptEvalCmd;                                       -->
67   *  Comments :   *  Attempts to evaluate in the global sphere rather than locally.<br><br>
68     *
69   *  Registered as : \"script_eval\" string";   *  Registered as : \"script_eval\" string";
  *  Attempts to evaluate in the global spher rather than locally.  
70   */   */
71    
72  extern int Asc_ScriptRefineCmd(ClientData cdata, Tcl_Interp *interp,  extern int Asc_ScriptRefineCmd(ClientData cdata, Tcl_Interp *interp,
73                                 int argc, CONST84 char *argv[]);                                 int argc, CONST84 char *argv[]);
74  /*  /**<
75   *  syntax: srefine <type> search <qlfdid>   *  Refines the qlfdid given to type if possible. if qlfdid exists and
76   *  refines the qlfdid given to type if possible. if qlfdid exists and   *  is none null, return will be as Asc_BrowInstanceRefineCmd().<br><br>
77   *  is none null, return will be as Asc_BrowInstanceRefineCmd.   *
78     *  Registered as: srefine <type> search <qlfdid>
79   */   */
80    
81  extern int Asc_ScriptMergeCmd(ClientData cdata, Tcl_Interp *interp,  extern int Asc_ScriptMergeCmd(ClientData cdata, Tcl_Interp *interp,
82                                int argc, CONST84 char *argv[]);                                int argc, CONST84 char *argv[]);
83  /*  /**<
84   *  syntax: smerge <qlfdid> <qlfdid>   *  Merges the qlfdid if possible.<br><br>
85   *  merges the qlfdid if possible.   *
86     *  Registered as: smerge <qlfdid> <qlfdid>
87   */   */
88    
89  extern int Asc_FastRaiseCmd(ClientData cdata, Tcl_Interp *interp,  extern int Asc_FastRaiseCmd(ClientData cdata, Tcl_Interp *interp,
90                              int argc, CONST84 char *argv[]);                              int argc, CONST84 char *argv[]);
91  /*  /**<
92   *  asc_raise windowname   *  Calls XRaiseWindow rather than the big tk spew which is so slow.<br><br>
93   *  calls XRaiseWindow rather than the big tk spew which is so slow.   *
94     *  Registered as:  asc_raise windowname
95   */   */
96    
97  STDHLF_H(Asc_TimeCmd);  STDHLF_H(Asc_TimeCmd);
98    
99  extern int Asc_TimeCmd(ClientData cdata, Tcl_Interp *interp,  extern int Asc_TimeCmd(ClientData cdata, Tcl_Interp *interp,
100                         int argc, CONST84 char *argv[]);                         int argc, CONST84 char *argv[]);
101  /*  /**<
102   *  usage:   *  Timing function.
  *  asc_clock <string> [n]  
103   *  string is a valid tcl script to be evaluated globally as script_eval.   *  string is a valid tcl script to be evaluated globally as script_eval.
104   *  n is the number of times to evaluate the script for an average time.   *  n is the number of times to evaluate the script for an average time.
105   *  n defaults to 1 since many ASCEND scripts are not repeatable.   *  n defaults to 1 since many ASCEND scripts are not repeatable.<br><br>
106     *
107     *  Registered as:  asc_clock <string> [n]
108   */   */
109    
110    /** Long help text part 1 */
111  #define Asc_TimeCmdHL1 \  #define Asc_TimeCmdHL1 \
112  "\  "\
113   *  Returns a list of numbers: \n\   *  Returns a list of numbers: \n\
# Line 99  extern int Asc_TimeCmd(ClientData cdata, Line 115  extern int Asc_TimeCmd(ClientData cdata,
115   *  real_time_avg- average real seconds consumed per evaluation of string. \n\   *  real_time_avg- average real seconds consumed per evaluation of string. \n\
116   *  time_avg- average cpu seconds consumed per evaluation of string. \n\   *  time_avg- average cpu seconds consumed per evaluation of string. \n\
117  "  "
118    /** Long help text part 2 */
119  #define Asc_TimeCmdHL2 \  #define Asc_TimeCmdHL2 \
120  "\  "\
121   *  clock_avg- average clock units consumed per evaluation of string. \n\   *  clock_avg- average clock units consumed per evaluation of string. \n\
# Line 106  extern int Asc_TimeCmd(ClientData cdata, Line 123  extern int Asc_TimeCmd(ClientData cdata,
123   *  clock_min- least clock units consumed by a single call \n\   *  clock_min- least clock units consumed by a single call \n\
124   *  CPS- CLOCKS_PER_SEC value by which times are computed from clocks. \n\   *  CPS- CLOCKS_PER_SEC value by which times are computed from clocks. \n\
125  "  "
 /*  
  */  
126    
127  extern int Asc_StringCompact(ClientData cdata, Tcl_Interp *interp,  extern int Asc_StringCompact(ClientData cdata, Tcl_Interp *interp,
128                               int argc, CONST84 char *argv[]);                               int argc, CONST84 char *argv[]);
129  /*  /**<
  *  stringcompact <string>  
130   *  Takes a string and eats away any extra blanks or tabs that are   *  Takes a string and eats away any extra blanks or tabs that are
131   *  not protected by matched {}. replaces unprotected tabs with a   *  not protected by matched {}. replaces unprotected tabs with a
132   *  single space. trims leading/trailing blanks/tabs. Doesn't   *  single space. trims leading/trailing blanks/tabs. Doesn't
133   *  treat \n as a special character.   *  treat \n as a special character.<br><br>
134     *
135     *  Registered as:  stringcompact <string>
136   */   */
137    
138    #endif  /* ScriptProc_module_loaded */
139    
 #endif /* ScriptProc_module_loaded */  

Legend:
Removed from v.17  
changed lines
  Added in v.54

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22