Programmer Guide/Command Reference/CHECKIT: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
{|class="einrahmen" | {|class="einrahmen" | ||
!option!!description!!result on success!!result on failure | !option!!description!!result on success!!result on failure | ||
|- | |||
|<code>/Trace</code> | |||
|returns a semicolon seperated list of the call stack at the current line; <var>arg</var> can be the number of levels (including current level) or the name of a macro where the traceback should stop | |||
| <var>shellid; macro:line; macro:line; ...</var> | |||
|- | |- | ||
|<code>/Executable</code> | |<code>/Executable</code> | ||
|check if <var>arg</var> is executable, i.e., if it is a command, instance, macro, or class | |check if <var>arg</var> is executable, i.e., if it is a command, instance, macro, or class | ||
| <code> | | <code>1</code> if <var>arg</var> is executable | ||
| <code> | | <code>0</code> otherwise | ||
|- | |- | ||
|<code>/Item</code> | |<code>/Item</code> | ||
Line 18: | Line 22: | ||
|<code>/Code</code> | |<code>/Code</code> | ||
| get type of the source code <var>arg</var> | | get type of the source code <var>arg</var> | ||
| <code> | | <code>macro</code>, <code>class</code>, or <code>spu</code> if <var>arg</var> is a source code macro, class, or SPU. | ||
| empty string otherwise | | empty string otherwise | ||
|- | |- | ||
|<code>/Visible</code> | |<code>/Visible</code> | ||
| check if <var>arg</var> is a visible source code | | check if <var>arg</var> is a visible source code | ||
| | | 1 if it is | ||
| | | 0 if it is not | ||
|- | |- | ||
| <code>/File</code> | | <code>/File</code> | ||
| get full sourcefile path of source code <var>arg</var> | | get full sourcefile path of source code <var>arg</var> | ||
| | | full path if <var>arg</var> is a source code | ||
| empty string otherwise | | empty string otherwise | ||
|- | |- | ||
| <code>/Style</code> | | <code>/Style</code> | ||
| get style of sourcecode <var>arg</var> | | get style of sourcecode <var>arg</var> | ||
| <code> | | <code>local</code>, <code>main</code>, <code>shell</code>, <code>sys</code>, <code>msgHandler</code>, or <code>global</code> if <var>arg</var> is a source code of the respective type. | ||
Note: <code> | Note: <code>global</code> is the default codestyle if none is specified in the code header | ||
| empty string otherwise | | empty string otherwise | ||
|- | |- | ||
| no option at all | | no option at all | ||
| get type of shell item or source code <var>arg</var> | | get type of shell item or source code <var>arg</var> | ||
| | | item type (cf. [[Programmer_Guide/Shell_Items|shell item types]]) or code type (<code>macro</code>, <code>class</code>, or <code>spu</code>) if <var>arg</var> is a shell item, or a source code | ||
| empty string otherwise | | empty string otherwise | ||
|} | |} |
Latest revision as of 11:57, 31 January 2019
var := CHECKIT arg [option]
with option
being either empty, in which case the type of the shell item or of the sourcecode item arg will be returned, or one out of the following keywords:
option | description | result on success | result on failure |
---|---|---|---|
/Trace
|
returns a semicolon seperated list of the call stack at the current line; arg can be the number of levels (including current level) or the name of a macro where the traceback should stop | shellid; macro:line; macro:line; ... | |
/Executable
|
check if arg is executable, i.e., if it is a command, instance, macro, or class | 1 if arg is executable
|
0 otherwise
|
/Item
|
get type of the shell item arg | type of the shell item (cf. shell item types) if arg is a shell item | empty string otherwise |
/Code
|
get type of the source code arg | macro , class , or spu if arg is a source code macro, class, or SPU.
|
empty string otherwise |
/Visible
|
check if arg is a visible source code | 1 if it is | 0 if it is not |
/File
|
get full sourcefile path of source code arg | full path if arg is a source code | empty string otherwise |
/Style
|
get style of sourcecode arg | local , main , shell , sys , msgHandler , or global if arg is a source code of the respective type.
Note: |
empty string otherwise |
no option at all | get type of shell item or source code arg | item type (cf. shell item types) or code type (macro , class , or spu ) if arg is a shell item, or a source code
|
empty string otherwise |