Qore Programming Language Reference Manual  0.8.13.8
QC_ProgramControl.dox.h
1 namespace Qore {
4 
14 struct StatementInfo {
16  int end_line;
18  string file;
20  int offset;
22  string source;
25 };
26 };
28 namespace Qore {
30 
42 
43 public:
45 /***/
46 nothing assignBreakpoint(Breakpoint bkpt);
47 
48 public:
50 
52  constructor();
53 
54 public:
56 
58  copy();
59 
60 public:
62 /***/
63 nothing deleteAllBreakpoints();
64 
65 public:
67 /***/
68  destructor();
69 
70 public:
72 
77 bool existsFunction(string name);
78 
79 public:
81 
87 int findFunctionStatementId(string function, *list params);
88 
89 public:
91 
97 list findFunctionVariants(string function);
98 
99 public:
101 
109 int findStatementId(string file, int line);
110 
111 public:
113 
116 
117 public:
119 /***/
121 
122 public:
124 
126 auto getDefine(string def);
127 
128 public:
130 
132 auto getGlobalVariable(string varname, *reference<bool> rexists);
133 
134 public:
136 
142 
143 public:
145 
147 int getParseOptions();
148 
149 public:
151 
156 int getProgramId();
157 
158 public:
160 
162 *string getScriptDir();
163 
164 public:
166 
168 *string getScriptName();
169 
170 public:
172 
174 *string getScriptPath();
175 
176 public:
178 
187 
188 public:
190 
199 
200 public:
202 
208 hash<StatementInfo> getStatementIdInfo(int statementId);
209 
210 public:
212 
217 list<int> getThreadList();
218 
219 public:
221 
224 
225 public:
227 
229 bool isDefined(string def);
230 
231 public:
233 
235 nothing setGlobalVarValue(string name, auto value);
236 
237 public:
239 
247 static list getAllPrograms();
248 
249 public:
251 
258 static ProgramControl getProgram();
259 
260 public:
262 
271 static ProgramControl resolveProgramId(int programId);
272 };
273 };
static ProgramControl resolveProgramId(int programId)
Get instance of program id.
int getParseOptions()
Returns the current binary-or&#39;ed parse option mask for the Program object.
TimeZone getTimeZone()
Returns the default local time zone for the object.
*string getScriptPath()
Returns the current script directory and filename if known, otherwise returns NOTHING.
list< int > getThreadList()
returns a list of thread IDs active in this Program
string file
refers to the label given when parsing the code
Definition: QC_ProgramControl.dox.h:18
int getProgramId()
Get program id.
nothing assignBreakpoint(Breakpoint bkpt)
Assign Breakpoint instance to Program. If breakpoint has been assigned to an program then is unassign...
statement information hash as returned by ProgramControl::getStatementIdInfo()
Definition: QC_ProgramControl.dox.h:14
nothing setGlobalVarValue(string name, auto value)
set the value of a global variable
hash getSourceFileNames()
Returns a list of file names registered to a statement when parsing source code.
*string getScriptName()
Returns the current script name as a string or NOTHING if not set.
hash getSourceLabels()
Get list of label names which has been registered to a statement when parsing source code...
destructor()
Dereferences the internal Program object and deletes the Qore object.
static list getAllPrograms()
Get instance of all programs.
constructor()
Throws an exception to prevent objects of this class being created from script.
int start_line
statement start line
Definition: QC_ProgramControl.dox.h:24
list list(...)
Returns an untyped list of the arguments passed at the top level.
The ProgramControl class provides safe information about a Qore program.
Definition: QC_ProgramControl.dox.h:41
auto getDefine(string def)
Retrieves the value of the given parse define in the current Program.
The TimeZone class provides access to time zone functionality.
Definition: QC_TimeZone.dox.h:6
*string getScriptDir()
Returns the current script directory as a string or NOTHING if not set.
hash getGlobalVars()
returns a hash of global variables
list findFunctionVariants(string function)
finds all variants of a function or class method and returns a list of the results ...
static ProgramControl getProgram()
Get control for instance of current program.
Breakpoint class supports breakpoint setting for particular Qore ProgramControl when debugging...
Definition: QC_Breakpoint.dox.h:26
hash< StatementInfo > getStatementIdInfo(int statementId)
get information related to statement id
bool existsFunction(string name)
Checks if a user function exists in the program object.
int end_line
statement end line
Definition: QC_ProgramControl.dox.h:16
auto getGlobalVariable(string varname, *reference< bool > rexists)
Returns a the value of the global variable identified by the first string argument.
int offset
the offset of the code in source
Definition: QC_ProgramControl.dox.h:20
nothing deleteAllBreakpoints()
delete all breakpoints from instance
*hash getAllDefines()
Retrieves all parse defines in the current Program.
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:2
copy()
Throws an exception to prevent objects of this class from being copied.
hash hash(object obj)
Returns a hash of an object&#39;s members.
int findStatementId(string file, int line)
Find statement related to position in file.
bool isDefined(string def)
Returns True if the given parse define is defined in the current Program (does not have to have a val...
list getBreakpoints()
get list of breakpoint assigned to program.
string source
refers to the actual file name or path of the source code (if the label does not provide this info) ...
Definition: QC_ProgramControl.dox.h:22
int findFunctionStatementId(string function, *list params)
Find the first statement for function entry point.