| HiLMAs reference | ||
|---|---|---|
| Back |
|
Next |
In the next pages, for every Hilmas statement, every detail is reported to allow an easy use by a programmer (I hope).
Here, we show a brief explanation of every section of a page.
STATEMENT
STATEMENT param1,param2[,param3,PADCHAR=]
With a title and this following "informal" syntactical explanation we show briefly the use and the parameters of the instruction; Hilmas statements have a very simple form, so I think isn't necessary a more formal or complex syntactical diagram.
With square bracket we always mean optional parameters; in this manual we consider "statement" and "instruction" like synonyms, and we mean the macro name.
Description
In this section we describe the mean and the use of this instruction, pointing out, if necessary, exeptions or some environment limitations of its use.
Parameter specifications
Parameter Name Mode Type coding Remark 1 param1 Output Integer F or H 2 param2 Input String C or X or const. String to measure; max length 255 char. 3 param2 Input String C or X or const. String to measure; max length 255 char. PADCHAR='c' Input Character
constantMust be a single character in quotes
In this table we give a detailed reference of the mean and type of every parameter used by the statement; so we have (from left to right):
- order number, if parameter is positional
- parameter name referencing to previous "informal" syntactical diagram
- mode, that is if parameter brings an Input, an Output or an Input/Output data for the statement; Input must be setted befor use of the statement, Output is a variable that is filled by statement and Input/Output is a variable that is used and modified by the statement.
Generally first parameter(s) are the output for statements simulating a function like A=FUNC(B,C), that is written in Hilmas as FUNC A,B,C, but this isn't a rule: for example, all conversion statements (statements in the form xxx2yyy) first parameter is the Input and second is the Output.- type, written as a generic type
- type coding, that is the admitted assembler variable definitions for this parameter; const. mean that constants are admitted: a numeric constant (if parameter type is numeric) or a string enclosed in quotes (if parameter is a string), Obviously, if a parameter is an output parameter, cannot be a constant.
- short remark for the parameter
Optional parameters are shaded, at the bottom of the table there are possible not-positional parameters (in this example PADCHAR).
Examples
One or more code fragments explain the use of the statement.
To see more examples, you can search them in the sources that can be downloaded in the same Hilmas site.