GBBopen 1.5 Reference -- describe-event-printing

describe-event-printing

describe-event-printing [event-class-specifier [unit-class-or-instance-specifier]] &key slot-names paths [Function]

Purpose
Describe the printing of events for one or more event classes.

Package :gbbopen

Module :gbbopen-core

Arguments and values

event-class-specifier		An extended event-class specification (see below; default is `t`)
unit-class-or-instance-specifier		An extended unit-class or instance specification (see below; default is `t`)
slot-names or slot-name		A slot-name or list of slot-names (default is `t`)
paths or path		A space-instance path regular expression (default is `(*)`)

Detailed syntax

`event-class-specifier` ::=	`atomic-event-class` \| `(atomic-event-class subeventing-specifier)` \| `t`

`atomic-event-class` ::=	`event-class` \| `event-class-name`

`subeventing-specifier` ::=	`:plus-subevents` \| `:no-subevents` `+` \| `=`

The shorthand + subevents specifier is equivalent to :plus-subevents and = to :no-subevents.

`unit-class-or-instance-specifier` ::=	`unit-instance` \| `(unit-instance`*`)` \|
	`atomic-unit-class` \|
	`(atomic-unit-class subclassing-specifier)` \| `t`

`atomic-unit-class` ::=	`unit-class` \| `unit-class-name`

`subclassing-specifier` ::=	`:plus-subclasses` \| `:no-subclasses` \| `+` \| `=`

The shorthand + subclasses specifier is equivalent to :plus-subclasses and = to :no-subclasses.

Description
The paths argument is either the symbol t (indicating all space instances) or a list representing a regular expression where the following reserved symbols are interpreted as follows:

	`=`		matches one occurrence in a space-instance path
	`?`		matches zero or one occurrence in a space-instance path
	`+`		matches one or more occurrences in a space-instance path
	`*`		matches zero or more occurrences in a space-instance path
	`^`		move to parent

The description is printed to the *standard-output* stream.

Example
Describe all event printing:

  > (describe-event-printing 'instance-event)
  instance-event
    standard-unit-instance
    uc-2 [suspended]
    uc-1 [suspended]
    ksa
    ks
    standard-space-instance
  >

Note
Unit-instance-specific event functions are not yet implemented in GBBopen.

The GBBopen Project

describe-event-printing

`unit-class-or-instance-specifier` ::=	`unit-instance` \| `(unit-instance`*`)` \|
	`atomic-unit-class` \|
	`(atomic-unit-class subclassing-specifier)` \| `t`