Skip to content
Topaz6.0 · Before release
Download

Search documentation

Specification 6.0 · Not released · Tested product 5.21.3

Use arrow keys to choose a result. Press Enter to open.

Type an API name, diagnostic number, rule, or project topic.

    Library · std.typeset

    BreakCluster.advance

    The measured point advance including trailing tracking.

    BreakCluster.advance: Length<Pt>
    Receiver
    BreakCluster
    Minimum arity
    0
    Maximum arity
    0

    Declaration and parameters

    Link

    Availability

    Included by default: Pending

    Import std.typeset in language mode 5.21.

    The current compiler selects std/typeset.tpz for this language mode. Availability in other released editions and inclusion in each installed distribution are Pending.

    Source evidence

    Receiver

    BreakCluster

    Parameter constraints

    Additional contracts are Pending.

    Public measurement fields use Length<Pt>. Widths, advances, tracking, stretch, shrink, physical targets, insets, font sizes, and optional width limits keep that type across input and output records. Explicit Length conversion functions remain the integer interchange boundary.

    Box.width, Box.trackingAfter, Glue.width, Glue.trackingAfter, Glue.stretch, Glue.shrink, and Penalty.width have type Length<Pt>.

    BreakCluster.advance, BreakCluster.trackingAfter, BreakPolicy.narrowestWordTarget, and BreakPolicy.bodyWordTarget have type Length<Pt>.

    LatinSpacing.fontSizePt, JustificationPolicy.maxAdjustment, and JustificationPolicy.maxGapAdjustment have type Length<Pt>.

    LineGeometry.bodyTarget, LineGeometry.firstTarget, and LineGeometry.dropCapInset have type Length<Pt>.

    PlanLine.target, PlanLine.rawTextWidth, PlanLine.trimmedTextWidth, PlanLine.costTextWidth, and PlanLine.selectedPenaltyWidth have type Length<Pt>. PlanLine.postValidationWidthLimit has type Option<Length<Pt>>.

    An int, a float, or a Length with another unit marker is not an implicit point-length argument. Convert physical units explicitly with toPt() before constructing a typesetting record.

    Indices, counts, penalties, costs, and dimensionless ratios retain their declared types. LatinSpacing.maxLetterSpacingEm is a relative Length<Em>. Resolve it to Length<Pt> with fontSizePt before selecting the computation grid.

    Paragraph.grid selects quantization at the computation boundary. ScaledPoint uses the exact scaled-point integer. MilliPoint uses the existing nearest-even conversion to millipoints. The selected grid never changes the physical interpretation of a public Length<Pt> value.

    Returned distances are converted from the computation grid into Length<Pt> at the output boundary. ParagraphPlan.grid reports the computation policy and is not needed to interpret its distances.

    The public type change preserves the selected cost model. FixedPoint retains its MilliPoint computation requirement. Word-space and CJK ratio calculations keep their independent floor rules. The relative letter-spacing distance is resolved and quantized through the shared Length conversions before it contributes to capacity.

    The public line-badness entry point also receives width, target, and hyphen advance as Length<Pt>. It converts those distances to millipoints at entry and preserves its existing integer cost calculation.

    Related rule: Give public typesetting distances a point-length type

    classifyBreaks reads measured clusters in array order and returns Result<Array<BreakOpportunity>, TypesetError>. It does not shape text, normalize strings, split a cluster, or change any supplied record or array.

    Each BreakCluster.text is the scalar string for one indivisible measured unit. Empty text still occupies one cluster index. advance includes trackingAfter. A span width sums its advances and removes the trackingAfter of its final cluster.

    advance and advance minus trackingAfter must be nonnegative point lengths. Zero advance and signed trackingAfter are accepted. Invalid extents return TypesetError.InvalidInput. Length arithmetic follows the common Length contract.

    classifyBreaks sums stored point ticks and compares them with the stored point targets. It has no DistanceGrid argument and does not quantize to a paragraph grid. Exact equality with a target counts as fitting.

    boundaryAllowed has exactly one entry for each cluster. Entry i governs the boundary after cluster i. The last entry must be true for nonempty input. A wrong mask length or a false last entry returns TypesetError.InvalidInput.

    Validation checks mask length and terminal permission, word targets, forbidBefore, forbidAfter, generated hyphen indices, and measured extents in that order. Array checks visit entries in input order. Unicode mandatory crossings are checked before boundary conflicts are visited in increasing cluster order. An empty result follows successful structural and policy validation.

    An empty cluster array with a valid empty boundary mask returns Ok with an empty opportunity array. It does not create a synthetic unit or terminal opportunity.

    Successful nonempty results contain increasing, unique unitEnd values from one through the cluster count. unitEnd is an exclusive cluster index rather than a byte or scalar offset. The final opportunity has unitEnd equal to the cluster count and kind ForcedEnd.

    Repeated calls with equal cluster values and equal policies produce the same ordered opportunities and categories. Validation and classification do not read host locale, perform I/O, invoke caller callbacks, or mutate input values. Argument expressions use the ordinary language evaluation order.

    A BreakOpportunity carries a boundary and its category. It does not carry a penalty width or BreakRule. A caller preserving mandatory boundaries maps every ForcedEnd opportunity to a Forced penalty before calling breakParagraph.

    Related rule: Classify measured clusters into an ordered boundary sequence

    Result

    Additional contracts are Pending.

    The declared result type is Length<Pt>.

    Effects

    Pending

    Failures

    Pending

    Result and effects

    Link

    Select this field from a value of its named type without call parentheses.

    Supply a nonnegative point length that includes trackingAfter. The advance minus trackingAfter must also be nonnegative. Span measurement removes the final cluster tracking from the sum of advances.

    Why

    Link

    A physical distance carries the same Length<Pt> type in application geometry and paragraph planning. The type prevents a grid selector or an unlabelled scalar from silently changing the distance.

    Related entries

    Link

    std.typeset

    Give public typesetting distances a point-length type

    Link
    Ruletopaz.stdlib.contract.typeset-length-pt.rule

    Give public typesetting distances a point-length type

    Public measurement fields use Length<Pt>. Widths, advances, tracking, stretch, shrink, physical targets, insets, font sizes, and optional width limits keep that type across input and output records. Explicit Length conversion functions remain the integer interchange boundary.

    Box.width, Box.trackingAfter, Glue.width, Glue.trackingAfter, Glue.stretch, Glue.shrink, and Penalty.width have type Length<Pt>.

    BreakCluster.advance, BreakCluster.trackingAfter, BreakPolicy.narrowestWordTarget, and BreakPolicy.bodyWordTarget have type Length<Pt>.

    LatinSpacing.fontSizePt, JustificationPolicy.maxAdjustment, and JustificationPolicy.maxGapAdjustment have type Length<Pt>.

    LineGeometry.bodyTarget, LineGeometry.firstTarget, and LineGeometry.dropCapInset have type Length<Pt>.

    PlanLine.target, PlanLine.rawTextWidth, PlanLine.trimmedTextWidth, PlanLine.costTextWidth, and PlanLine.selectedPenaltyWidth have type Length<Pt>. PlanLine.postValidationWidthLimit has type Option<Length<Pt>>.

    An int, a float, or a Length with another unit marker is not an implicit point-length argument. Convert physical units explicitly with toPt() before constructing a typesetting record.

    Indices, counts, penalties, costs, and dimensionless ratios retain their declared types. LatinSpacing.maxLetterSpacingEm is a relative Length<Em>. Resolve it to Length<Pt> with fontSizePt before selecting the computation grid.

    Paragraph.grid selects quantization at the computation boundary. ScaledPoint uses the exact scaled-point integer. MilliPoint uses the existing nearest-even conversion to millipoints. The selected grid never changes the physical interpretation of a public Length<Pt> value.

    Returned distances are converted from the computation grid into Length<Pt> at the output boundary. ParagraphPlan.grid reports the computation policy and is not needed to interpret its distances.

    The public type change preserves the selected cost model. FixedPoint retains its MilliPoint computation requirement. Word-space and CJK ratio calculations keep their independent floor rules. The relative letter-spacing distance is resolved and quantized through the shared Length conversions before it contributes to capacity.

    The public line-badness entry point also receives width, target, and hyphen advance as Length<Pt>. It converts those distances to millipoints at entry and preserves its existing integer cost calculation.

    Why

    A physical distance carries the same Length<Pt> type in application geometry and paragraph planning. The type prevents a grid selector or an unlabelled scalar from silently changing the distance.

    Examples Use point lengths in BoxReject untyped physical distances in BoxUse point lengths in GlueReject untyped physical distances in GlueUse point lengths in PenaltyReject untyped physical distances in PenaltyUse point lengths in BreakPolicyReject untyped physical distances in BreakPolicyUse point lengths in BreakClusterReject untyped physical distances in BreakClusterUse point lengths in LatinSpacingReject untyped physical distances in LatinSpacingUse point lengths in JustificationPolicyReject untyped physical distances in JustificationPolicyUse point lengths in LineGeometryReject untyped physical distances in LineGeometryUse point lengths in PlanLineReject untyped physical distances in PlanLinePass typed distances to the line-cost functionReject raw distances at the line-cost boundary

    Diagnostics TPZ5001

    Source evidence

    Use point lengths in Box

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in BoxOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.Box = ts.Box {
    3. unitIndex: 0,
    4. text: "A",
    5. width: 12pt,
    6. trackingAfter: 0pt
    7. }
    8. let distance: Length<Pt> = value.width
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in Box

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in BoxOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.Box = ts.Box {
    3. unitIndex: 0,
    4. text: "A",
    5. width: 12,
    6. trackingAfter: 0
    7. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:5:10

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in Glue

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in GlueOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.Glue = ts.Glue {
    3. unitIndex: 1,
    4. text: " ",
    5. width: 3pt,
    6. trackingAfter: 0pt,
    7. stretch: 1pt,
    8. shrink: 1pt
    9. }
    10. let distance: Length<Pt> = value.width
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in Glue

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in GlueOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.Glue = ts.Glue {
    3. unitIndex: 1,
    4. text: " ",
    5. width: 3,
    6. trackingAfter: 0,
    7. stretch: 1,
    8. shrink: 1
    9. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:5:10

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in Penalty

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in PenaltyOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.Penalty = ts.Penalty {
    3. unitEnd: 1,
    4. width: 0pt,
    5. rule: ts.BreakRule.Forced(),
    6. kind: ts.BreakKind.ForcedEnd(),
    7. flagged: false
    8. }
    9. let distance: Length<Pt> = value.width
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in Penalty

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in PenaltyOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.Penalty = ts.Penalty {
    3. unitEnd: 1,
    4. width: 0,
    5. rule: ts.BreakRule.Forced(),
    6. kind: ts.BreakKind.ForcedEnd(),
    7. flagged: false
    8. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:4:10

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in BreakPolicy

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in BreakPolicyOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.BreakPolicy = ts.BreakPolicy {
    3. mode: ts.BreakMode.Character(),
    4. rules: ts.KinsokuRules.Unicode16Ja(),
    5. forbidBefore: [],
    6. forbidAfter: [],
    7. boundaryAllowed: [true],
    8. generatedHyphenEnds: [],
    9. protectFittingLatin: true,
    10. preserveShortWords: true,
    11. narrowestWordTarget: 12pt,
    12. bodyWordTarget: 24pt
    13. }
    14. let distance: Length<Pt> = value.narrowestWordTarget
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in BreakPolicy

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in BreakPolicyOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.BreakPolicy = ts.BreakPolicy {
    3. mode: ts.BreakMode.Character(),
    4. rules: ts.KinsokuRules.Unicode16Ja(),
    5. forbidBefore: [],
    6. forbidAfter: [],
    7. boundaryAllowed: [true],
    8. generatedHyphenEnds: [],
    9. protectFittingLatin: true,
    10. preserveShortWords: true,
    11. narrowestWordTarget: 12,
    12. bodyWordTarget: 24
    13. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:11:24

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in BreakCluster

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in BreakClusterOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.BreakCluster = ts.BreakCluster {
    3. text: "A",
    4. advance: 12pt,
    5. trackingAfter: 0pt
    6. }
    7. let distance: Length<Pt> = value.advance
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in BreakCluster

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in BreakClusterOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.BreakCluster = ts.BreakCluster {
    3. text: "A",
    4. advance: 12,
    5. trackingAfter: 0
    6. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:4:12

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in LatinSpacing

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in LatinSpacingOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.LatinSpacing = ts.LatinSpacing {
    3. minWordSpaceRatio: 0.8,
    4. maxWordSpaceRatio: 1.33,
    5. maxLetterSpacingEm: 0.01em,
    6. fontSizePt: 12pt
    7. }
    8. let distance: Length<Pt> = value.fontSizePt
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in LatinSpacing

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in LatinSpacingOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.LatinSpacing = ts.LatinSpacing {
    3. minWordSpaceRatio: 0.8,
    4. maxWordSpaceRatio: 1.33,
    5. maxLetterSpacingEm: 0.01em,
    6. fontSizePt: 12.0
    7. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:6:15

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in JustificationPolicy

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in JustificationPolicyOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.JustificationPolicy = ts.JustificationPolicy {
    3. mode: ts.JustificationMode.Unjustified(),
    4. minGapCount: 0,
    5. minLineWidthRatioM: 0,
    6. minFinalLineWidthRatioM: None(),
    7. maxAdjustment: 12pt,
    8. maxGapAdjustment: 3pt,
    9. maxGapRatioR: 0,
    10. latinSpacing: None(),
    11. cjkStretchRatio: 0.0
    12. }
    13. let distance: Length<Pt> = value.maxAdjustment
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in JustificationPolicy

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in JustificationPolicyOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.JustificationPolicy = ts.JustificationPolicy {
    3. mode: ts.JustificationMode.Unjustified(),
    4. minGapCount: 0,
    5. minLineWidthRatioM: 0,
    6. minFinalLineWidthRatioM: None(),
    7. maxAdjustment: 12,
    8. maxGapAdjustment: 3,
    9. maxGapRatioR: 0,
    10. latinSpacing: None(),
    11. cjkStretchRatio: 0.0
    12. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:7:18

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in LineGeometry

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in LineGeometryOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.LineGeometry = ts.LineGeometry {
    3. bodyTarget: 24pt,
    4. firstTarget: 20pt,
    5. dropCapSpan: 0,
    6. dropCapInset: 0pt
    7. }
    8. let distance: Length<Pt> = value.bodyTarget
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in LineGeometry

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in LineGeometryOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.LineGeometry = ts.LineGeometry {
    3. bodyTarget: 24,
    4. firstTarget: 20,
    5. dropCapSpan: 0,
    6. dropCapInset: 0
    7. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:3:15

    No stdout.

    This exact example has not been executed.

    Source evidence

    Use point lengths in PlanLine

    Link

    check · checking · Verification: not-run

    main.tpzUse point lengths in PlanLineOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.PlanLine = ts.PlanLine {
    3. start: 0,
    4. endExclusive: 1,
    5. trimmedEndExclusive: 1,
    6. displayTextScalarLength: 1,
    7. kind: ts.BreakKind.ForcedEnd(),
    8. target: 12pt,
    9. rawTextWidth: 10pt,
    10. trimmedTextWidth: 10pt,
    11. costTextWidth: 10pt,
    12. selectedPenaltyWidth: 0pt,
    13. postValidationWidthLimit: Some(13pt),
    14. cost: 0,
    15. adjustmentRatioR: 0
    16. }
    17. let distance: Length<Pt> = value.target
    18. let limit: Option<Length<Pt>> = value.postValidationWidthLimit
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject untyped physical distances in PlanLine

    Link

    reject · checking · Verification: not-run

    main.tpzReject untyped physical distances in PlanLineOpen in Playground
    1. import std.typeset as ts
    2. let value: ts.PlanLine = ts.PlanLine {
    3. start: 0,
    4. endExclusive: 1,
    5. trimmedEndExclusive: 1,
    6. displayTextScalarLength: 1,
    7. kind: ts.BreakKind.ForcedEnd(),
    8. target: 12,
    9. rawTextWidth: 10,
    10. trimmedTextWidth: 10,
    11. costTextWidth: 10,
    12. selectedPenaltyWidth: 0,
    13. postValidationWidthLimit: Some(13),
    14. cost: 0,
    15. adjustmentRatioR: 0
    16. }
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:8:11

    No stdout.

    This exact example has not been executed.

    Source evidence

    Pass typed distances to the line-cost function

    Link

    check · checking · Verification: not-run

    main.tpzPass typed distances to the line-cost functionOpen in Playground
    1. import std.typeset as ts
    2. let value = ts.lineBadness(20pt, 20pt, 4, 1, ts.BreakKind.ForcedEnd(), false, 0, 0pt)
    Expected outputexit 0
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Checking accepts the program. Exit code 0.

    No stderr.

    No stdout.

    This exact example has not been executed.

    Source evidence

    Reject raw distances at the line-cost boundary

    Link

    reject · checking · Verification: not-run

    main.tpzReject raw distances at the line-cost boundaryOpen in Playground
    1. import std.typeset as ts
    2. let value = ts.lineBadness(20, 20, 4, 1, ts.BreakKind.ForcedEnd(), false, 0, 0)
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:2:28

    No stdout.

    This exact example has not been executed.

    Source evidence

    Diagnostics

    Link

    TPZ5001

    Classify measured clusters into an ordered boundary sequence

    Link
    Ruletopaz.stdlib.contract.typeset-break-inputs.rule

    Classify measured clusters into an ordered boundary sequence

    classifyBreaks reads measured clusters in array order and returns Result<Array<BreakOpportunity>, TypesetError>. It does not shape text, normalize strings, split a cluster, or change any supplied record or array.

    Each BreakCluster.text is the scalar string for one indivisible measured unit. Empty text still occupies one cluster index. advance includes trackingAfter. A span width sums its advances and removes the trackingAfter of its final cluster.

    advance and advance minus trackingAfter must be nonnegative point lengths. Zero advance and signed trackingAfter are accepted. Invalid extents return TypesetError.InvalidInput. Length arithmetic follows the common Length contract.

    classifyBreaks sums stored point ticks and compares them with the stored point targets. It has no DistanceGrid argument and does not quantize to a paragraph grid. Exact equality with a target counts as fitting.

    boundaryAllowed has exactly one entry for each cluster. Entry i governs the boundary after cluster i. The last entry must be true for nonempty input. A wrong mask length or a false last entry returns TypesetError.InvalidInput.

    Validation checks mask length and terminal permission, word targets, forbidBefore, forbidAfter, generated hyphen indices, and measured extents in that order. Array checks visit entries in input order. Unicode mandatory crossings are checked before boundary conflicts are visited in increasing cluster order. An empty result follows successful structural and policy validation.

    An empty cluster array with a valid empty boundary mask returns Ok with an empty opportunity array. It does not create a synthetic unit or terminal opportunity.

    Successful nonempty results contain increasing, unique unitEnd values from one through the cluster count. unitEnd is an exclusive cluster index rather than a byte or scalar offset. The final opportunity has unitEnd equal to the cluster count and kind ForcedEnd.

    Repeated calls with equal cluster values and equal policies produce the same ordered opportunities and categories. Validation and classification do not read host locale, perform I/O, invoke caller callbacks, or mutate input values. Argument expressions use the ordinary language evaluation order.

    A BreakOpportunity carries a boundary and its category. It does not carry a penalty width or BreakRule. A caller preserving mandatory boundaries maps every ForcedEnd opportunity to a Forced penalty before calling breakParagraph.

    Why

    A measured cluster is the unit that shaping can safely keep together. Exclusive indices connect classification to paragraph items without converting through text offsets. A complete terminal boundary and deterministic order make the output suitable for reproducible layout.

    Examples Classify atomic clusters in repeatable boundary orderClassify an empty cluster sequenceReject a mask with the wrong number of entriesReject negative measured and untracked cluster extentsReject a masked paragraph end in every rulesetKeep exact point measurements at the classifier boundary

    Source evidence

    Classify atomic clusters in repeatable boundary order

    Link

    run · running · Verification: not-run

    main.tpzClassify atomic clusters in repeatable boundary orderOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. import std.test
    5. let clusters = [ts.BreakCluster { text: "한", advance: 1pt, trackingAfter: 0pt }, ts.BreakCluster { text: "글", advance: 1pt, trackingAfter: 0pt }]
    6. let selected = ts.BreakPolicy {
    7. mode: ts.BreakMode.Character(),
    8. rules: ts.KinsokuRules.AtlasDefault(),
    9. forbidBefore: [],
    10. forbidAfter: [],
    11. boundaryAllowed: [true, true],
    12. generatedHyphenEnds: [],
    13. protectFittingLatin: false,
    14. preserveShortWords: false,
    15. narrowestWordTarget: 0pt,
    16. bodyWordTarget: 0pt
    17. }
    18. for pass in ([0, 1]) {
    19. let breaks = test.assertOk(ts.classifyBreaks(clusters, selected))
    20. for boundary in (breaks) {
    21. let category = match (boundary.kind) {
    22. case CjkCluster() => "CJK"
    23. case ForcedEnd() => "end"
    24. case _ => "unexpected kind"
    25. }
    26. io.writeLine("{pass} {boundary.unitEnd} {category}")
    27. }
    28. }
    29. io.writeLine(clusters[0].text)
    Expected outputexit 0
    0 1 CJK
0 2 end
1 1 CJK
1 2 end
한
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    No stderr.

    Expected stdout
    1. 0 1 CJK
    2. 0 2 end
    3. 1 1 CJK
    4. 1 2 end
    5. 한

    This exact example has not been executed.

    Source evidence

    Classify an empty cluster sequence

    Link

    run · running · Verification: not-run

    main.tpzClassify an empty cluster sequenceOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. import std.test
    5. let clusters: Array<ts.BreakCluster> = []
    6. let selected = ts.BreakPolicy {
    7. mode: ts.BreakMode.Character(),
    8. rules: ts.KinsokuRules.AtlasDefault(),
    9. forbidBefore: [],
    10. forbidAfter: [],
    11. boundaryAllowed: [],
    12. generatedHyphenEnds: [],
    13. protectFittingLatin: false,
    14. preserveShortWords: false,
    15. narrowestWordTarget: 0pt,
    16. bodyWordTarget: 0pt
    17. }
    18. let breaks = test.assertOk(ts.classifyBreaks(clusters, selected))
    19. io.writeLine("{breaks.length}")
    Expected outputexit 0
    0
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    No stderr.

    Expected stdout
    1. 0

    This exact example has not been executed.

    Source evidence

    Reject a mask with the wrong number of entries

    Link

    run · running · Verification: not-run

    main.tpzReject a mask with the wrong number of entriesOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. import std.test
    5. function outcome(value: Result<Array<ts.BreakOpportunity>, ts.TypesetError>) -> string {
    6. match (value) {
    7. case Ok(_) => "Ok"
    8. case Err(InvalidInput(_)) => "InvalidInput"
    9. case Err(InvalidPolicy(_)) => "InvalidPolicy"
    10. case Err(_) => "unexpected error"
    11. }
    12. }
    14. let clusters = [ts.BreakCluster { text: "a", advance: 1pt, trackingAfter: 0pt }]
    15. let selected = ts.BreakPolicy {
    16. mode: ts.BreakMode.Character(),
    17. rules: ts.KinsokuRules.AtlasDefault(),
    18. forbidBefore: [],
    19. forbidAfter: [],
    20. boundaryAllowed: [],
    21. generatedHyphenEnds: [],
    22. protectFittingLatin: false,
    23. preserveShortWords: false,
    24. narrowestWordTarget: 0pt,
    25. bodyWordTarget: 0pt
    26. }
    27. io.writeLine(outcome(ts.classifyBreaks(clusters, selected)))
    Expected outputexit 0
    InvalidInput
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    No stderr.

    Expected stdout
    1. InvalidInput

    This exact example has not been executed.

    Source evidence

    Reject negative measured and untracked cluster extents

    Link

    run · running · Verification: not-run

    main.tpzReject negative measured and untracked cluster extentsOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. import std.test
    5. function outcome(value: Result<Array<ts.BreakOpportunity>, ts.TypesetError>) -> string {
    6. match (value) {
    7. case Ok(_) => "Ok"
    8. case Err(InvalidInput(_)) => "InvalidInput"
    9. case Err(InvalidPolicy(_)) => "InvalidPolicy"
    10. case Err(_) => "unexpected error"
    11. }
    12. }
    14. let selected = ts.BreakPolicy {
    15. mode: ts.BreakMode.Character(),
    16. rules: ts.KinsokuRules.AtlasDefault(),
    17. forbidBefore: [],
    18. forbidAfter: [],
    19. boundaryAllowed: [true],
    20. generatedHyphenEnds: [],
    21. protectFittingLatin: false,
    22. preserveShortWords: false,
    23. narrowestWordTarget: 0pt,
    24. bodyWordTarget: 0pt
    25. }
    26. io.writeLine(outcome(ts.classifyBreaks([ts.BreakCluster { text: "a", advance: -1pt, trackingAfter: 0pt }], selected)))
    27. io.writeLine(outcome(ts.classifyBreaks([ts.BreakCluster { text: "b", advance: 1pt, trackingAfter: 2pt }], selected)))
    Expected outputexit 0
    InvalidInput
InvalidInput
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    No stderr.

    Expected stdout
    1. InvalidInput
    2. InvalidInput

    This exact example has not been executed.

    Source evidence

    Reject a masked paragraph end in every ruleset

    Link

    run · running · Verification: not-run

    main.tpzReject a masked paragraph end in every rulesetOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. import std.test
    5. function outcome(value: Result<Array<ts.BreakOpportunity>, ts.TypesetError>) -> string {
    6. match (value) {
    7. case Ok(_) => "Ok"
    8. case Err(InvalidInput(_)) => "InvalidInput"
    9. case Err(InvalidPolicy(_)) => "InvalidPolicy"
    10. case Err(_) => "unexpected error"
    11. }
    12. }
    14. let clusters = [ts.BreakCluster { text: "a", advance: 1pt, trackingAfter: 0pt }]
    15. let atlas = ts.BreakPolicy {
    16. mode: ts.BreakMode.Character(),
    17. rules: ts.KinsokuRules.AtlasDefault(),
    18. forbidBefore: [],
    19. forbidAfter: [],
    20. boundaryAllowed: [false],
    21. generatedHyphenEnds: [],
    22. protectFittingLatin: false,
    23. preserveShortWords: false,
    24. narrowestWordTarget: 0pt,
    25. bodyWordTarget: 0pt
    26. }
    27. let unicode = ts.BreakPolicy {
    28. mode: ts.BreakMode.Character(),
    29. rules: ts.KinsokuRules.Unicode16Ja(),
    30. forbidBefore: [],
    31. forbidAfter: [],
    32. boundaryAllowed: [false],
    33. generatedHyphenEnds: [],
    34. protectFittingLatin: false,
    35. preserveShortWords: false,
    36. narrowestWordTarget: 0pt,
    37. bodyWordTarget: 0pt
    38. }
    39. io.writeLine(outcome(ts.classifyBreaks(clusters, atlas)))
    40. io.writeLine(outcome(ts.classifyBreaks(clusters, unicode)))
    Expected outputexit 0
    InvalidInput
InvalidInput
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    No stderr.

    Expected stdout
    1. InvalidInput
    2. InvalidInput

    This exact example has not been executed.

    Source evidence

    Keep exact point measurements at the classifier boundary

    Link

    run · running · Verification: not-run

    main.tpzKeep exact point measurements at the classifier boundaryOpen in Playground
    1. import std.typeset as ts
    2. import std.test
    3. import std.io
    5. let clusters = [
    6. ts.BreakCluster { text: "a", advance: 0.5002pt, trackingAfter: 0pt },
    7. ts.BreakCluster { text: "b", advance: 0.5002pt, trackingAfter: 0pt }
    8. ]
    9. let policy = ts.BreakPolicy {
    10. mode: ts.BreakMode.Word(), rules: ts.KinsokuRules.AtlasDefault(),
    11. forbidBefore: [], forbidAfter: [], boundaryAllowed: [true, true],
    12. generatedHyphenEnds: [], protectFittingLatin: false, preserveShortWords: false,
    13. narrowestWordTarget: 0pt, bodyWordTarget: 1pt
    14. }
    15. let result = test.assertOk(ts.classifyBreaks(clusters, policy))
    16. for boundary in (result) {
    17. io.writeLine("{boundary.unitEnd}")
    18. }
    Expected outputexit 0
    1
2
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    No stderr.

    Expected stdout
    1. 1
    2. 2

    This exact example has not been executed.

    Source evidence

    Menu

    Download