Expand description
ZPL command specification tables.
Defines the data structures for ZPL command metadata, including command entries, argument schemas, constraints, and an opcode trie for fast command recognition. These tables are deserialized from the generated JSON spec and consumed by the parser and validator.
Structs§
- Arg
- Rich metadata for a single command argument.
- Command
Entry - Metadata for a single ZPL command (or group of aliased commands).
- Composite
- Composite parameter group — combines multiple args into a single path-like
parameter in the signature (e.g.,
d:o.xfor^XG). - Conditional
Range - A numeric range that applies only when a predicate is satisfied.
- Conditional
Rounding - A rounding policy that applies only when a predicate is satisfied.
- Constraint
- A command-level validation constraint.
- Constraint
Defaults - Default values for command-level constraints.
- Effects
- Describes which cross-command state a command sets.
- Example
- An executable/documentation example for a command.
- Field
Data Rules - Validation rules for field data content associated with a barcode command.
- Opcode
Trie Node - A node in the opcode trie used for longest-match command recognition.
- Parser
Tables - Top-level container for all ZPL command spec tables.
- Placement
- Placement rules that refine command location semantics.
- Profile
Constraint - Data-driven profile constraint on an arg value. Replaces hardcoded checks like “^PW <= profile.page.width_dots”.
- Rounding
Policy - Policy for rounding or quantizing a numeric argument value.
- Signature
- Describes the parameter signature of a ZPL command.
- Split
Rule - Rule for splitting a parameter into multiple parts by character count.
- Structural
Rule Index - Generated structural rule pre-index keyed by kind, trigger, and effect.
Enums§
- ArgPresence
- Declares how firmware interprets argument presence/emptiness.
- ArgUnion
- A command argument definition — either a single
Argor aoneOfunion. - Command
Category - Functional category for a command.
- Command
Scope - Command scope — determines the lifecycle boundary of the command’s effect.
- Comparison
Op - Comparison operators for profile constraints.
- Constraint
Kind - Constraint kinds for command-level constraints.
- Constraint
Scope - Evaluation scope for command-level constraints.
- Constraint
Severity - Severity level for constraint diagnostics.
- Enum
Value - An allowed enum value — either a plain string or a rich object with gates.
- Font
Reference Action - Action variant for font-reference structural rules.
- Media
Modes Target - Target variant for media-modes structural rules.
- Note
Audience - Audience/surface for note diagnostics.
- Plane
- Command plane — determines where in the ZPL hierarchy the command operates.
- Position
Bounds Action - Action variant for position-bounds structural rules.
- Resource
Kind - Resource family for
resourceRefarguments. - Rounding
Mode - Rounding modes for numeric arguments.
- Spacing
Policy - Opcode spacing policy between command code and first argument.
- Stability
- Stability level for a command.
- Structural
Rule - Schema-declared structural validation rule payload.
- Structural
Rule Kind - Schema-declared structural validator rule kinds.
- Structural
Trigger - Trigger flags used to pre-index structural rule applicability.
Constants§
- TABLE_
FORMAT_ VERSION - Current format version for the spec table JSON schema.