mclassinfo output
You can request output in raw format for parsing by a program.
You can also request standard output formatted for users, including verbose output that provides additional information. For the available options, see mclassinfo options.
Raw output format
The output consists of the class tree, optionally preceded by the enumeration definitions, as shown in the following figure. The enumeration definitions are reported as EnumInfo.
Raw output format for mclassinfo
EnumTypeInfo=EnumTypeName EnumValCount (EnumValName)*EnumValCount
The class tree is reported depth-first, left-to-right, as ClassInfo, as shown in the following figure.
Class tree for mclassinfo
ClassCompInfo=ClassName ClassFlags ClassSlotCount (ClassSlotInfo)*ClassSlotCount ClassInfo
ClassSlotInfo=ClassSlotName ClassSlotValType ClassSlotRepType ClassSlotFlags ClassSlotDefaultValueLength ClassSlotDefaultValueText
ClassSlotValType=ClassSlotStructCode ClassSlotTypeCode
ClassSlotStructCode=S | LClassSlotTypeCode=i | r | p | s | e:EnumerationTypeName
| c | c:BaseClass
| q | q:BaseClass
ClassSlotFlags=(r\|R) (k\|K) (p\|P) (d\|D) (h\|H)
Slot value types (ClassSlotValType) are encoded by two characters. The first one indicates whether it is a simple slot (S) or a list (L). List slots are defined in BAROC as LIST_OF. The second character determines the type of the slot value. It corresponds to the BAROC definition as listed in the following table.
Type of slot value for mclassinfo
Slot Type | Definition |
|---|---|
i | INTEGER |
r | REAL |
p | POINTER |
s | STRING |
e;EnumerationTypeName | Enumeration |
c:BaseClass | ECF of BaseClass |
q:BaseClass | QUERY of BaseClass |
A slot representation type (ClassSlotRepType) corresponds to the representation facet of the slot. If that facet is not specified, it is reported as an asterisk (*).
Flags contain Boolean facets of the slot. For every facet, one character is reported. An uppercase character means that the facet is TRUE; a lowercase character means that it is FALSE. The following tables list the facets that are reported:
Reported facets
Facet | Function |
|---|---|
r|R | read_only |
k|K | key |
p|P | parse |
d|D | dup_detect |
h|H | hidden |
Class flags
Flag | Function |
|---|---|
p|P | publishable class |
Standard output format for mclassinfo
Standard output format is formatted for end-users but does not report the counts and represents the tree structure through indentation.
Information amount for mclassinfo
The amount of reported information is limited as described in the following table:
Information amount limitation options for mclassinfo
Option | Description |
|---|---|
-a 0 | Reports only class names; no slot information is reported |
-a 1 | Reports slot names |
-a 2 | Adds slot names and representation type (default) |
-a 3 | Adds slot flags and default value |