somusar/Sisendel: Reference Guide

We Generate Your Software.

Products

Services

Company

The Somusar/SoProTech[tm] Booklet Series Volume V "somusar/Sisendel: Reference Guide" Printer friendly

Contents
1. Introduction
2. Entity Files
3. Comment Lines
4. Section `CORE`
5. Entity Identifier
6. Field List
7. Basic Types
8. User Types
9. Section `DEFS`
9.1	Purpose
9.2	Usage
9.3	Description
9.3.1	Range Definition
9.3.2	Enumeration Definition
9.3.3	Function Definition
10. Section `DB`
11. Section `LOGIC`
12. Section `UI`
13. Section `ADJUST`
14. Further Reading

Chapter 9 - Section `DEFS`

9.1 - Purpose top

Define specific characteristics of entity fields, according to their <type>.

9.2 - Usage top

A <definitions-section> is structured as follows:

   <optional-section-delimiter>DEFS
   <field-specifier-list>

The <optional-section-delimiter> is a string of blanks, tabs, and dashes -, and can be used to improve readability of entity files.

The <field-specifier-list> consists of zero or more <field-specifier>'s, each defined as follows:

   <field-identifier>:
   <specifier-definition>

A <specifier-definition> can be one of the following:

9.3 - Description top

A <specifier-definition> depends on the type of the entity field that it refers to by means of the <field-identifier> in the <field-specifier>.

9.3.1 - Range Definition top

A <range-definition> must be specified for a field of type range and may optionally be specified for a field of type float, according to the following rule:

   <lower-bound>/<upper-bound>

Numeric values for <lower-bound> and <upper-bound> must be expressed in decimal notation, can be positive or negative values, and must be integer if they refer to a field of type range. The value of <lower-bound> must be smaller than the value of <upper-bound>.

9.3.2 - Enumeration Definition top

An <enumeration-definition> must be specified for a field of type enum, and consists of one or more logical lines, each defining one <enumeration-value> as follows:

   <identifier> <optional-value-specifier> <label>

An <optional-value-specifier> can be either an integer number or a single character enclosed in single quotes '.
If the <optional-value-specifier> is omitted, Sisendel automatically defines incremental positive numeric enumeration values starting from zero.
An <enumeration-definition> must contain <enumeration-value>'s of only one type, that is, all <enumeration-value>'s must either have, or not have, <optional-value-specifier>'s.

9.3.3 - Function Definition top

A <function-definition> must be specified for a field of type function, and consists of one or more logical lines, each defining one <function-signature> as follows:

   <parameter-list> -> <return-value-type>

The <parameter-list> consists of a comma-separated list of one or more <field-identifier>'s; alternatively, a void parameter list can be specified using the digit 0 (zero).
The <return-value-type> consists of exactly one <field-identifier>; alternatively, a void return value can be specified using the digit 0 (zero).
At least one <function-signature> must be defined for each entity field of type function; it is possible to define more than one <function-signature> per function, independent of one another.

[Previous chapter] [Next chapter] [Back to top]