iPXE
Data Fields
ansiesc_handler Struct Reference

A handler for an escape sequence. More...

#include <ansiesc.h>

Data Fields

unsigned int function
 The control function identifier.
void(* handle )(struct ansiesc_context *ctx, unsigned int count, int params[])
 Handle escape sequence.

Detailed Description

A handler for an escape sequence.

Definition at line 34 of file ansiesc.h.


Field Documentation

The control function identifier.

The control function identifier consists of the Intermediate Bytes (if any) and the Final Byte. In practice, no more than one immediate byte is ever used, so the byte combination can be efficiently expressed as a single integer, in the obvious way (with the Final Byte being the least significant byte).

Definition at line 44 of file ansiesc.h.

Referenced by ansiesc_call_handler().

void( * ansiesc_handler::handle)(struct ansiesc_context *ctx, unsigned int count, int params[])

Handle escape sequence.

Parameters:
ctxANSI escape context
countParameter count
paramsParameter list

A negative parameter value indicates that the parameter was omitted and that the default value for this control function should be used.

Since all parameters are optional, there is no way to distinguish between "zero parameters" and "single parameter omitted". Consequently, the parameter list will always contain at least one item.

Definition at line 60 of file ansiesc.h.

Referenced by ansiesc_call_handler().


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