Message for SWEVT_MONITOR event. More...

#include "monevent.h"

Data Fields
uint8 *	text

size_t	length

sw_tl_ref	timeline

sw_mon_channel	channel

sw_mon_type	type

Detailed Description

Message for SWEVT_MONITOR event.

The text of a Monitor Event message is UTF-8 encoded Unicode. It can be zero length. Typically it will consist of a complete line with a terminating newline character, but this is not guaranteed.

The Monitor Event Device Type allows PostScript operators such as print and = to output text through the Monitor Event. It can be configured with the appropriate metadata for the Event, and optionally with an Encoding from which to transcode to UTF-8.

Typically the pseudo-file 'stdout' is connected to the PS Device 'output' which is configured as:

/DeviceType 52    % Monitor Event Device Type
/Password 0
/Enable true
/Channel /Monitor % MON_CHANNEL_MONITOR
/UID 16#20000000  % MON_INFO_JOB
/Timeline 0       % 0 means current interpreter Timeline

and the pdeudo-file 'stderr' is connected to the PS Device 'errors' which is configured as:

/DeviceType 52    % Monitor Event Device Type
/Password 0
/Enable true
/Channel /stderr  % MON_CHANNEL_STDERR
/UID 16#48000000  % MON_WARNING
/Timeline 0       % 0 means current interpreter Timeline

If these are also configured with an /Encoding, with a string value equal to one of the known ICU encodings, the Monitor Event Device Type will also transcode the text before issuing the Monitor Event.

If there is no configured Encoding then the default behaviour is to preserve the bytes emitted by print or =. This is achieved by leaving the low "ASCII" bytes alone, and mapping the high bytes to the Private Use Area EC80..ECFF range. These are mapped back to the original bytes by the Compatibility Handler before being written to the legacy Monitor Device %monitor%. This is for backwards compatibility reasons only - OEMs are encouraged to configure the Monitor Event Devices appropriately, and the Monitor Device and Progress Device are now marked as obsolescent.

Field Documentation

◆ channel

sw_mon_channel SWMSG_MONITOR::channel

Top 8 bits are OEM number

◆ length

size_t SWMSG_MONITOR::length

The length of the above message, or zero

◆ text

uint8* SWMSG_MONITOR::text

Pointer to UTF-8 text message.

◆ timeline

sw_tl_ref SWMSG_MONITOR::timeline

The Timeline this message is associated with or 0 for unattributed messages

◆ type

sw_mon_type SWMSG_MONITOR::type

Identifier for this message - see above

The documentation for this struct was generated from the following file:

lib/interface/monevent.h