본문으로 건너뛰기
토파즈6.0 · 출시 전
다운로드 →

문서 검색

명세 6.0

방향키로 결과를 고르고 Enter를 눌러 여세요.

API 이름, 진단 번호, 규칙 또는 프로젝트 주제를 입력하세요.

    라이브러리 · std.typeset

    BreakOpportunity.kind

    The reason for a classified boundary.

    BreakOpportunity.kind: BreakKind
    수신자
    BreakOpportunity
    최소 인자 수
    0
    최대 인자 수
    0

    Declaration and parameters

    링크

    사용 조건

    기본 포함 · 미정

    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.

    수신자

    BreakOpportunity

    매개변수 제약

    추가 계약은 미정입니다.

    BreakKind.CjkCluster() constructs the variant for the existing CJK and East Asian cluster classification. BreakKind.KoreanCluster() is absent and rejected.

    Renaming this variant preserves the classification predicates and the effect of the selected Unicode, locale, custom punctuation, and shaping-boundary policies.

    A CjkCluster category does not itself permit a break. classifyBreaks returns the opportunities admitted by its supplied policy.

    관련 규칙 · Name the CJK cluster break category →

    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.

    관련 규칙 · Classify measured clusters into an ordered boundary sequence →

    결과

    추가 계약은 미정입니다.

    The declared result type is BreakKind.

    효과

    미정

    실패

    미정

    Result and effects

    링크

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

    The category records how the boundary was classified. It does not supply a BreakRule. Preserve ForcedEnd boundaries by mapping them to Forced penalties when building paragraph items.

    Why

    링크

    A named break category lets planning apply the chosen cost policy to the same classified boundary. The category describes the boundary while the locale policy decides its admissibility.

    Related entries

    링크

    std.typeset →

    Name the CJK cluster break category

    링크
    규칙topaz.stdlib.contract.cjk-cluster.rule

    Name the CJK cluster break category

    BreakKind.CjkCluster() constructs the variant for the existing CJK and East Asian cluster classification. BreakKind.KoreanCluster() is absent and rejected.

    Renaming this variant preserves the classification predicates and the effect of the selected Unicode, locale, custom punctuation, and shaping-boundary policies.

    A CjkCluster category does not itself permit a break. classifyBreaks returns the opportunities admitted by its supplied policy.

    이유

    A break category names the text it classifies. CjkCluster covers the existing Chinese, Japanese, and Korean classification path and matches the module's CjkInterCharacter vocabulary. Locale policy continues to determine where a break is allowed.

    예제 Use the CJK cluster variant →Reject the former KoreanCluster name →

    진단 TPZ5006 →

    Use the CJK cluster variant

    링크

    check · checking · 검증 · 미실행

    main.tpzUse the CJK cluster variant플레이그라운드 열기 →
    1. import std.typeset as ts
    2. let kind: ts.BreakKind = ts.BreakKind.CjkCluster()
    기대 출력종료 코드 0
    표준 출력 없음.
    $ topaz check main.tpz --format json · 대상 제품 5.21.3
    기대 결과

    기대 결과

    검사가 프로그램을 받아들입니다. 종료 코드 0.

    표준 오류 출력 없음.

    표준 출력 없음.

    이 예제는 아직 실행하지 않았습니다.

    Reject the former KoreanCluster name

    링크

    reject · checking · 검증 · 미실행

    main.tpzReject the former KoreanCluster name플레이그라운드 열기 →
    1. import std.typeset as ts
    2. let kind = ts.BreakKind.KoreanCluster()
    기대 출력0이 아닌 종료 코드
    표준 출력 없음.
    $ topaz check main.tpz --format json · 대상 제품 5.21.3
    기대 결과

    기대 결과

    거절 단계 check. 종료 코드가 0이 아닙니다.

    • TPZ5006 →

      stdlib-removed-korean-cluster at main.tpz:2:12

    표준 출력 없음.

    이 예제는 아직 실행하지 않았습니다.

    Diagnostics

    링크

    Unknown member or field →

    Classify measured clusters into an ordered boundary sequence

    링크
    규칙topaz.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.

    이유

    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.

    예제 Classify atomic clusters in repeatable boundary order →Classify an empty cluster sequence →Reject a mask with the wrong number of entries →Reject negative measured and untracked cluster extents →Reject a masked paragraph end in every ruleset →Keep exact point measurements at the classifier boundary →

    Classify atomic clusters in repeatable boundary order

    링크

    run · running · 검증 · 미실행

    main.tpzClassify atomic clusters in repeatable boundary order플레이그라운드 열기 →
    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)
    기대 출력종료 코드 0
    0 1 CJK
0 2 end
1 1 CJK
1 2 end
한
    $ topaz run main.tpz · 대상 제품 5.21.3
    기대 결과

    기대 결과

    실행을 마칩니다. 종료 코드 0.

    표준 오류 출력 없음.

    기대 표준 출력
    1. 0 1 CJK
    2. 0 2 end
    3. 1 1 CJK
    4. 1 2 end
    5. 한

    이 예제는 아직 실행하지 않았습니다.

    Classify an empty cluster sequence

    링크

    run · running · 검증 · 미실행

    main.tpzClassify an empty cluster sequence플레이그라운드 열기 →
    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}")
    기대 출력종료 코드 0
    0
    $ topaz run main.tpz · 대상 제품 5.21.3
    기대 결과

    기대 결과

    실행을 마칩니다. 종료 코드 0.

    표준 오류 출력 없음.

    기대 표준 출력
    1. 0

    이 예제는 아직 실행하지 않았습니다.

    Reject a mask with the wrong number of entries

    링크

    run · running · 검증 · 미실행

    main.tpzReject a mask with the wrong number of entries플레이그라운드 열기 →
    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)))
    기대 출력종료 코드 0
    InvalidInput
    $ topaz run main.tpz · 대상 제품 5.21.3
    기대 결과

    기대 결과

    실행을 마칩니다. 종료 코드 0.

    표준 오류 출력 없음.

    기대 표준 출력
    1. InvalidInput

    이 예제는 아직 실행하지 않았습니다.

    Reject negative measured and untracked cluster extents

    링크

    run · running · 검증 · 미실행

    main.tpzReject negative measured and untracked cluster extents플레이그라운드 열기 →
    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)))
    기대 출력종료 코드 0
    InvalidInput
InvalidInput
    $ topaz run main.tpz · 대상 제품 5.21.3
    기대 결과

    기대 결과

    실행을 마칩니다. 종료 코드 0.

    표준 오류 출력 없음.

    기대 표준 출력
    1. InvalidInput
    2. InvalidInput

    이 예제는 아직 실행하지 않았습니다.

    Reject a masked paragraph end in every ruleset

    링크

    run · running · 검증 · 미실행

    main.tpzReject a masked paragraph end in every ruleset플레이그라운드 열기 →
    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)))
    기대 출력종료 코드 0
    InvalidInput
InvalidInput
    $ topaz run main.tpz · 대상 제품 5.21.3
    기대 결과

    기대 결과

    실행을 마칩니다. 종료 코드 0.

    표준 오류 출력 없음.

    기대 표준 출력
    1. InvalidInput
    2. InvalidInput

    이 예제는 아직 실행하지 않았습니다.

    Keep exact point measurements at the classifier boundary

    링크

    run · running · 검증 · 미실행

    main.tpzKeep exact point measurements at the classifier boundary플레이그라운드 열기 →
    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. }
    기대 출력종료 코드 0
    1
2
    $ topaz run main.tpz · 대상 제품 5.21.3
    기대 결과

    기대 결과

    실행을 마칩니다. 종료 코드 0.

    표준 오류 출력 없음.

    기대 표준 출력
    1. 1
    2. 2

    이 예제는 아직 실행하지 않았습니다.

    메뉴

    다운로드 →