1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
//! This module provides all rendition control sequences of ecma-48.
use std::fmt::{Display, Formatter};
use crate::control::ControlSequence;
/// # ICH - Insert character
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, ICH is used to
/// prepare the insertion of n characters, by putting into the erased state the active presentation position and,
/// depending on the setting of the CHARACTER EDITING MODE (HEM), the n-1 preceding or following
/// character positions in the presentation component, where n equals the value of `n`. The previous contents
/// of the active presentation position and an adjacent string of character positions are shifted away from the
/// active presentation position. The contents of n character positions at the other end of the shifted part are
/// removed. The active presentation position is moved to the line home position in the active line. The line
/// home position is established by the parameter value of SET LINE HOME (SLH).
///
/// The extent of the shifted part is established by SELECT EDITING EXTENT (SEE).
///
/// The effect of ICH on the start or end of a selected area, the start or end of a qualified area, or a
/// tabulation stop in the shifted part, is not defined by this Standard.
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, ICH is used to prepare the
/// insertion of n characters, by putting into the erased state the active data position and, depending on the
/// setting of the CHARACTER EDITING MODE (HEM), the n-1 preceding or following character
/// positions in the data component, where n equals the value of `n`. The previous contents of the active data
/// position and an adjacent string of character positions are shifted away from the active data position. The
/// contents of n character positions at the other end of the shifted part are removed. The active data
/// position is moved to the line home position in the active line. The line home position is established by
/// the parameter value of SET LINE HOME (SLH).
pub fn insert_char(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "@")
}
/// # IL - Insert line
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, IL is used to
/// prepare the insertion of n lines, by putting into the erased state in the presentation component the active
/// line (the line that contains the active presentation position) and, depending on the setting of the LINE
/// EDITING MODE (VEM), the n-1 preceding or following lines, where n equals the value of `n`. The
/// previous contents of the active line and of adjacent lines are shifted away from the active line. The
/// contents of n lines at the other end of the shifted part are removed. The active presentation position is
/// moved to the line home position in the active line. The line home position is established by the
/// parameter value of SET LINE HOME (SLH).
///
/// The extent of the shifted part is established by SELECT EDITING EXTENT (SEE).
///
/// Any occurrences of the start or end of a selected area, the start or end of a qualified area, or a tabulation
/// stop in the shifted part, are also shifted.
///
/// If the TABULATION STOP MODE (TSM) is set to SINGLE, character tabulation stops are cleared in
/// the lines that are put into the erased state.
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, IL is used to prepare the
/// insertion of n lines, by putting into the erased state in the data component the active line (the line that
/// contains the active data position) and, depending on the setting of the LINE EDITING MODE (VEM),
/// the n-1 preceding or following lines, where n equals the value of `n`. The previous contents of the active
/// line and of adjacent lines are shifted away from the active line. The contents of n lines at the other end
/// of the shifted part are removed. The active data position is moved to the line home position in the active
/// line. The line home position is established by the parameter value of SET LINE HOME (SLH).
pub fn insert_line(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "K")
}
/// # DCH - Delete character
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, DCH causes the
/// contents of the active presentation position and, depending on the setting of the CHARACTER
/// EDITING MODE (HEM), the contents of the n-1 preceding or following character positions to be
/// removed from the presentation component, where n equals the value of `n`. The resulting gap is closed
/// by shifting the contents of the adjacent character positions towards the active presentation position. At
/// the other end of the shifted part, n character positions are put into the erased state.
///
/// The extent of the shifted part is established by SELECT EDITING EXTENT (SEE).
///
/// The effect of DCH on the start or end of a selected area, the start or end of a qualified area, or a
/// tabulation stop in the shifted part is not defined by this Standard.
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, DCH causes the contents of
/// the active data position and, depending on the setting of the CHARACTER EDITING MODE (HEM),
/// the contents of the n-1 preceding or following character positions to be removed from the data
/// component, where n equals the value of `n`. The resulting gap is closed by shifting the contents of the
/// adjacent character positions towards the active data position. At the other end of the shifted part, n
/// character positions are put into the erased state.
pub fn delete_char(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "P")
}
/// # DL - Delete line
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, DL causes the
/// contents of the active line (the line that contains the active presentation position) and, depending on the
/// setting of the LINE EDITING MODE (VEM), the contents of the n-1 preceding or following lines to be
/// removed from the presentation component, where n equals the value of `n`. The resulting gap is closed
/// by shifting the contents of a number of adjacent lines towards the active line. At the other end of the
/// shifted part, n lines are put into the erased state.
///
/// The active presentation position is moved to the line home position in the active line. The line home
/// position is established by the parameter value of SET LINE HOME (SLH). If the TABULATION STOP
/// MODE (TSM) is set to SINGLE, character tabulation stops are cleared in the lines that are put into the
/// erased state.
///
/// The extent of the shifted part is established by SELECT EDITING EXTENT (SEE).
///
/// Any occurrences of the start or end of a selected area, the start or end of a qualified area, or a tabulation
/// stop in the shifted part, are also shifted.
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, DL causes the contents of the
/// active line (the line that contains the active data position) and, depending on the setting of the LINE
/// EDITING MODE (VEM), the contents of the n-1 preceding or following lines to be removed from the
/// data component, where n equals the value of `n`. The resulting gap is closed by shifting the contents of a
/// number of adjacent lines towards the active line. At the other end of the shifted part, n lines are put into
/// the erased state. The active data position is moved to the line home position in the active line. The line
/// home position is established by the parameter value of SET LINE HOME (SLH).
pub fn delete_line(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "M")
}
/// # ECH - Erase character
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, ECH causes the
/// active presentation position and the n-1 following character positions in the presentation component to
/// be put into the erased state, where n equals the value of `n`.
///
/// If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, ECH causes the active data
/// position and the n-1 following character positions in the data component to be put into the erased state,
/// where n equals the value of `n`.
///
/// Whether the character positions of protected areas are put into the erased state, or the character positions
/// of unprotected areas only, depends on the setting of the ERASURE MODE (ERM).
pub fn erase_char(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "X")
}
/// # PP - Preceding page
///
/// PP causes the n-th preceding page in the presentation component to be displayed, where n equals the
/// value of `n`. The effect of this control function on the active presentation position is not defined by this
/// Standard.
pub fn previous_page(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "V")
}
/// # NP - Next page
///
/// NP causes the n-th following page in the presentation component to be displayed, where n equals the
/// value of `n`. The effect of this control function on the active presentation position is not defined by this Standard.
pub fn next_page(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "U")
}
/// # GSM - Graphic size modification
///
/// GSM is used to modify for subsequent text the height and/or the width of all primary and alternative
/// fonts identified by FONT SELECTION (FNT) and established by GRAPHIC SIZE SELECTION (GSS).
///
/// The established values remain in effect until the next occurrence of GSM or GSS in the data steam.
///
/// `height` and `width` are percentage of values established by GSS ([select_size]).
pub fn modify_size(height: usize, width: usize) -> ControlSequence {
ControlSequence::new(&[&height.to_string(), &width.to_string()], " B")
}
/// # GSS - Graphic size selection
///
/// GSS is used to establish for subsequent text the height and the width of all primary and alternative fonts
/// identified by FONT SELECTION (FNT). The established values remain in effect until the next
/// occurrence of GSS in the data stream.
///
/// `n` specifies the height, the width is implicitly defined by the height.
///
/// The unit in which the parameter value is expressed is that established by the parameter value of SELECT
/// SIZE UNIT (SSU).
pub fn select_size(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], " C")
}
#[derive(Copy, Clone)]
pub enum Expansion {
Normal,
Expanded,
Condensed,
}
impl Display for Expansion {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
Self::Normal => "0",
Self::Expanded => "1",
Self::Condensed => "2"
})
}
}
/// # PEC - Presentation expand or contract
///
/// PEC is used to establish the spacing and the extent of the graphic characters for subsequent text. The
/// spacing is specified in the line as multiples of the spacing established by the most recent occurrence of
/// SET CHARACTER SPACING (SCS) or of SELECT CHARACTER SPACING (SHS) or of SPACING
/// INCREMENT (SPI) in the data stream. The extent of the characters is implicitly established by these
/// control functions. The established spacing and the extent remain in effect until the next occurrence of
/// PEC, of SCS, of SHS or of SPI in the data stream.
pub fn expand_or_condense(expansion: Expansion) -> ControlSequence {
ControlSequence::new(&[&expansion.to_string()], " Z")
}
#[derive(Copy, Clone)]
pub enum Combination {
Two,
Start,
End,
}
impl Display for Combination {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
Self::Two => "0",
Self::Start => "1",
Self::End => "2"
})
}
}
/// # GCC - Graphic character combination
///
/// GCC is used to indicate that two or more graphic characters are to be imaged as one single graphic
/// symbol. GCC with a parameter value of 0 indicates that the following two graphic characters are to be
/// imaged as one single graphic symbol; GCC with a parameter value of 1 and GCC with a parameter value
/// of 2 indicate respectively the beginning and the end of a string of graphic characters which are to be
/// imaged as one single graphic symbol.
///
/// ### Note
/// GCC does not explicitly specify the relative sizes or placements of the component parts of a composite
/// graphic symbol. In the simplest case, two components may be "half-width" and side-by-side. For
/// example, in Japanese text a pair of characters may be presented side-by-side, and occupy the space of a
/// normal-size Kanji character.
pub fn character_combination(combination: Combination) -> ControlSequence {
ControlSequence::new(&[&combination.to_string()], " _")
}
pub enum Font {
Primary,
Alternative1,
Alternative2,
Alternative3,
Alternative4,
Alternative5,
Alternative6,
Alternative7,
Alternative8,
Alternative9,
}
impl Display for Font {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
Font::Primary => "0",
Font::Alternative1 => "1",
Font::Alternative2 => "2",
Font::Alternative3 => "3",
Font::Alternative4 => "4",
Font::Alternative5 => "5",
Font::Alternative6 => "6",
Font::Alternative7 => "7",
Font::Alternative8 => "8",
Font::Alternative9 => "9"
})
}
}
/// # FNT - Font selection
///
/// FNT is used to identify the character font to be selected as primary or alternative font by subsequent
/// occurrences of SELECT GRAPHIC RENDITION (SGR) in the data stream.
pub fn select_font(font: Font) -> ControlSequence {
ControlSequence::new(&[&font.to_string(), "0"], " D")
}
pub enum TextDelimiter {
End,
BeginPrincipal,
BeginSupplementary,
BeginSupplementaryPhoneticJapanese,
BeginSupplementaryPhoneticChinese,
EndPhonetic,
}
impl Display for TextDelimiter {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
TextDelimiter::End => "0",
TextDelimiter::BeginPrincipal => "1",
TextDelimiter::BeginSupplementary => "2",
TextDelimiter::BeginSupplementaryPhoneticJapanese => "3",
TextDelimiter::BeginSupplementaryPhoneticChinese => "4",
TextDelimiter::EndPhonetic => "5",
})
}
}
/// # PTX - Parallel texts
///
/// PTX is used to delimit strings of graphic characters that are communicated one after another in the data
/// stream but that are intended to be presented in parallel with one another, usually in adjacent lines.
///
/// PTX with a parameter value of 1 indicates the beginning of the string of principal text intended to be
/// presented in parallel with one or more strings of supplementary text.
///
/// PTX with a parameter value of 2, 3 or 4 indicates the beginning of a string of supplementary text that is
/// intended to be presented in parallel with either a string of principal text or the immediately preceding
/// string of supplementary text, if any; at the same time it indicates the end of the preceding string of
/// principal text or of the immediately preceding string of supplementary text, if any. The end of a string of
/// supplementary text is indicated by a subsequent occurrence of PTX with a parameter value other than 1.
/// PTX with a parameter value of 0 indicates the end of the strings of text intended to be presented in
/// parallel with one another.
///
///### Note
/// PTX does not explicitly specify the relative placement of the strings of principal and supplementary
/// parallel texts, or the relative sizes of graphic characters in the strings of parallel text. A string of
/// supplementary text is normally presented in a line adjacent to the line containing the string of principal
/// text, or adjacent to the line containing the immediately preceding string of supplementary text, if any.
/// The first graphic character of the string of principal text and the first graphic character of a string of
/// supplementary text are normally presented in the same position of their respective lines. However, a
/// string of supplementary text longer (when presented) than the associated string of principal text may be
/// centred on that string. In the case of long strings of text, such as paragraphs in different languages, the
/// strings may be presented in successive lines in parallel columns, with their beginnings aligned with one
/// another and the shorter of the paragraphs followed by an appropriate amount of "white space".
///
/// Japanese phonetic annotation typically consists of a few half-size or smaller Kana characters which
/// indicate the pronunciation or interpretation of one or more Kanji characters and are presented above
/// those Kanji characters if the character path is horizontal, or to the right of them if the character path is
/// vertical.
///
/// Chinese phonetic annotation typically consists of a few Pinyin characters which indicate the
/// pronunciation of one or more Hanzi characters and are presented above those Hanzi characters.
/// Alternatively, the Pinyin characters may be presented in the same line as the Hanzi characters and
/// following the respective Hanzi characters. The Pinyin characters will then be presented within enclosing
/// pairs of parentheses
pub fn parallel_texts(text_delimiter: TextDelimiter) -> ControlSequence {
ControlSequence::new(&[&text_delimiter.to_string()], "\\")
}
pub enum Layout {
FlushHome,
FlushHomeAndFill,
Center,
CenterAndFill,
FlushLimit,
FlushLimitAndFill,
FlushBoth,
}
impl Display for Layout {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
Layout::FlushHome => "0",
Layout::FlushHomeAndFill => "1",
Layout::Center => "2",
Layout::CenterAndFill => "3",
Layout::FlushLimit => "4",
Layout::FlushLimitAndFill => "5",
Layout::FlushBoth => "6",
})
}
}
/// # QUAD
///
/// QUAD is used to indicate the end of a string of graphic characters that are to be positioned on a single
/// line according to the layout specified.
///
/// The beginning of the string to be positioned is indicated by the preceding occurrence in the data stream
/// of either QUAD or one of the following formator functions: FORM FEED (FF), CHARACTER AND
/// LINE POSITION (HVP), LINE FEED (LF), NEXT LINE (NEL), PAGE POSITION ABSOLUTE (PPA),
/// PAGE POSITION BACKWARD (PPB), PAGE POSITION FORWARD (PPR), REVERSE LINE FEED
/// (RI), LINE POSITION ABSOLUTE (VPA), LINE POSITION BACKWARD (VPB), LINE POSITION
/// FORWARD (VPR), or LINE TABULATION (VT).
///
/// The line home position is established by the parameter value of SET LINE HOME (SLH). The line limit
/// position is established by the parameter value of SET LINE LIMIT (SLL).
pub fn quad(layouts: &[Layout]) -> ControlSequence {
let str_layouts: Vec<String> = layouts.iter()
.map(|mode| mode.to_string())
.collect();
let str_ref_modes: Vec<&str> = str_layouts.iter()
.map(AsRef::as_ref)
.collect();
ControlSequence::new(&str_ref_modes, " H")
}
/// # REP - Repeat
///
/// REP is used to indicate that the preceding character in the data stream, if it is a graphic character
/// (represented by one or more bit combinations) including SPACE, is to be repeated `n` times.
///
/// If the character preceding REP is a control function or part of a control function,
/// the effect of REP is not defined by this Standard.
pub fn repeat(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], "b")
}
/// # SACS - Set additional character separation
///
/// SACS is used to establish extra inter-character escapement for subsequent text. The established extra
/// escapement remains in effect until the next occurrence of SACS or of SET REDUCED CHARACTER
/// SEPARATION (SRCS) in the data stream or until it is reset to the default value by a subsequent
/// occurrence of CARRIAGE RETURN/LINE FEED (CR LF) or of NEXT LINE (NEL) in the data stream.
///
/// `n` specifies the number of units by which the inter-character escapement is enlarged.
///
/// The unit in which the parameter value is expressed is that established by the parameter value of SELECT
/// SIZE UNIT (SSU).
pub fn add_separation(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], " \\")
}
#[derive(Clone)]
pub struct PresentationVariant {
modes: Vec<String>,
}
impl PresentationVariant {
pub fn new() -> Self { Self { modes: vec![] } }
/// Default presentation (implementation-defined); cancels the effect of any preceding occurrence of
/// SAPV in the data stream.
pub fn default(&mut self) -> &mut Self { self.add("0") }
/// The decimal digits are presented by means of the graphic symbols used in the Latin script.
pub fn latin_decimal(&mut self) -> &mut Self { self.add("1") }
/// The decimal digits are presented by means of the graphic symbols used in the Arabic script, i.e. the Hindi symbols.
pub fn arabic_decimal(&mut self) -> &mut Self { self.add("2") }
/// When the direction of the character path is right-to-left, each of the graphic characters in the graphic
/// character set(s) in use which is one of a left/right-handed pair (parentheses, square brackets, curly
/// brackets, greater-than/less-than signs, etc.) is presented as "mirrored", i.e. as the other member of the
/// pair. For example, the coded graphic character given the name LEFT PARENTHESIS is presented as
/// RIGHT PARENTHESIS, and vice versa.
pub fn mirror_horizontal(&mut self) -> &mut Self { self.add("3") }
/// When the direction of the character path is right-to-left, all graphic characters which represent
/// operators and delimiters in mathematical formulae and which are not symmetrical about a vertical
/// axis are presented as mirrored about that vertical axis.
pub fn mirror_vertical(&mut self) -> &mut Self { self.add("4") }
/// The following graphic character is presented in its isolated form.
pub fn character_isolate(&mut self) -> &mut Self { self.add("5") }
/// The following graphic character is presented in its initial form.
pub fn character_initial(&mut self) -> &mut Self { self.add("6") }
/// The following graphic character is presented in its medial form.
pub fn character_medial(&mut self) -> &mut Self { self.add("7") }
/// The following graphic character is presented in its final form.
pub fn character_final(&mut self) -> &mut Self { self.add("8") }
/// Where the bit combination 0x2E is intended to represent a decimal mark in a decimal number it shall
/// be presented by means of the graphic symbol FULL STOP.
pub fn decimal_stop(&mut self) -> &mut Self { self.add("9") }
/// Where the bit combination 0x2E is intended to represent a decimal mark in a decimal number it shall
/// be presented by means of the graphic symbol COMMA.
pub fn decimal_comma(&mut self) -> &mut Self { self.add("10") }
/// Vowels are presented above or below the preceding character.
pub fn vowel_above_or_below(&mut self) -> &mut Self { self.add("11") }
/// Vowels are presented after the preceding character.
pub fn vowel_after(&mut self) -> &mut Self { self.add("12") }
/// Contextual shape determination of Arabic scripts, including the LAM-ALEPH ligature but excluding
/// all other Arabic ligatures.
pub fn arabic_ligature_aleph(&mut self) -> &mut Self { self.add("13") }
/// Contextual shape determination of Arabic scripts, excluding all Arabic ligatures.
pub fn arabic_ligature_none(&mut self) -> &mut Self { self.add("14") }
/// Cancels the effect of parameter values [Self::mirror_horizontal] and [Self::mirror_vertical].
pub fn no_mirror(&mut self) -> &mut Self { self.add("15") }
/// Vowels are not presented.
pub fn no_vowel(&mut self) -> &mut Self { self.add("16") }
/// When the string direction is right-to-left, the italicized characters are slanted to the left; when the
/// string direction is left-to-right, the italicized characters are slanted to the right.
pub fn italic_direction(&mut self) -> &mut Self { self.add("17") }
/// Contextual shape determination of Arabic scripts is not used, the graphic characters - including the
/// digits - are presented in the form they are stored (Pass-through).
pub fn arabic_no_context_with_digit(&mut self) -> &mut Self { self.add("18") }
/// Contextual shape determination of Arabic scripts is not used, the graphic characters - excluding the
/// digits - are presented in the form they are stored (Pass-through).
pub fn arabic_no_context(&mut self) -> &mut Self { self.add("19") }
/// The graphic symbols used to present the decimal digits are device dependent.
pub fn device_digit(&mut self) -> &mut Self { self.add("20") }
/// Establishes the effect of parameter values [Self::character_isolate], [Self::character_initial],
/// [Self::character_medial], and [Self::character_final] for the following graphic characters until
/// cancelled.
pub fn character_establish(&mut self) -> &mut Self { self.add("21") }
/// Cancels the effect of parameter value [Self::character_establish], i.e. re-establishes the effect
/// of parameter values [Self::character_isolate], [Self::character_initial],
/// [Self::character_medial], and [Self::character_final] for the next single graphic character only.
pub fn character_cancel(&mut self) -> &mut Self { self.add("22") }
pub fn get(&self) -> ControlSequence {
ControlSequence::new(&self.modes.iter().map(|s| s.as_str()).collect::<Vec<_>>(), " ]")
}
fn add(&mut self, s: &str) -> &mut Self {
self.modes.push(s.to_string());
self
}
}
/// # SAPV - Select alternative presentation variants
///
/// SAPV is used to specify one or more variants for the presentation of subsequent text.
pub fn select_alternative() -> PresentationVariant {
PresentationVariant::new()
}
impl Display for PresentationVariant {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.get())
}
}
pub enum Orientation {
/// 0°
North,
/// 45°
NorthWest,
/// 90°
West,
/// 135°
SouthWest,
/// 180°
South,
/// 225°
SouthEast,
/// 270°
East,
/// 315°
NorthEast,
}
impl Display for Orientation {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
Orientation::North => "0",
Orientation::NorthWest => "1",
Orientation::West => "2",
Orientation::SouthWest => "3",
Orientation::South => "4",
Orientation::SouthEast => "5",
Orientation::East => "6",
Orientation::NorthEast => "7",
})
}
}
/// # SCO - Select character orientation
///
/// SCO is used to establish the amount of rotation of the graphic characters following in the data stream.
/// The established value remains in effect until the next occurrence of SCO in the data stream.
///
///
pub fn character_orientation(orientation: Orientation) -> ControlSequence {
ControlSequence::new(&[&orientation.to_string()], " e")
}
pub enum CharacterPath {
/// left-to-right (in the case of horizontal line orientation), or top-to-bottom (in the case of vertical line
/// orientation).
LeftToRight,
/// right-to-left (in the case of horizontal line orientation), or bottom-to-top (in the case of vertical line
/// orientation).
RightToLeft,
}
impl Display for CharacterPath {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
CharacterPath::LeftToRight => "1",
CharacterPath::RightToLeft => "2",
})
}
}
pub enum PathEffect {
/// Implementation dependant.
Undefined,
/// The content of the active line in the presentation component (the line that contains the active
/// presentation position) is updated to correspond to the content of the active line in the data component
/// (the line that contains the active data position) according to the newly established character path
/// characteristics in the presentation component; the active data position is moved to the first character
/// position in the active line in the data component, the active presentation position in the presentation
/// component is updated accordingly.
UpdatePresentation,
/// The content of the active line in the data component (the line that contains the active data position) is
/// updated to correspond to the content of the active line in the presentation component (the line that
/// contains the active presentation position) according to the newly established character path
/// characteristics of the presentation component; the active presentation position is moved to the first
/// character position in the active line in the presentation component, the active data position in the data
/// component is updated accordingly.
UpdateData,
}
/// # SCP - Select character path
///
/// SCP is used to select the character path, relative to the line orientation, for the active line (the line that
/// contains the active presentation position) and subsequent lines in the presentation component. It is also
/// used to update the content of the active line in the presentation component and the content of the active
/// line (the line that contains the active data position) in the data component. This takes effect immediately.
pub fn character_path(character_path: CharacterPath, path_effect: PathEffect) -> ControlSequence {
ControlSequence::new(&[&character_path.to_string(), &path_effect.to_string()], " k")
}
impl Display for PathEffect {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
PathEffect::Undefined => "0",
PathEffect::UpdatePresentation => "1",
PathEffect::UpdateData => "2",
})
}
}
pub enum StringDirection {
End,
StartLeftToRight,
StartRightToLeft,
}
impl Display for StringDirection {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
StringDirection::End => "0",
StringDirection::StartLeftToRight => "1",
StringDirection::StartRightToLeft => "2",
})
}
}
/// # SDS - Start directed string
///
/// SDS is used to establish in the data component the beginning and the end of a string of characters as
/// well as the direction of the string. This direction may be different from that currently established. The
/// indicated string follows the preceding text. The established character progression is not affected.
///
/// The beginning of a directed string is indicated by SDS with a parameter value not equal to 0. A directed
/// string may contain one or more nested strings. These nested strings may be directed strings the
/// beginnings of which are indicated by SDS with a parameter value not equal to 0, or reversed strings the
/// beginnings of which are indicated by START REVERSED STRING (SRS) with a parameter value of 1.
///
/// Every beginning of such a string invokes the next deeper level of nesting.
///
/// This Standard does not define the location of the active data position within any such nested string.
///
/// The end of a directed string is indicated by SDS with a parameter value of 0. Every end of such a string
/// re-establishes the next higher level of nesting (the one in effect prior to the string just ended). The
/// direction is re-established to that in effect prior to the string just ended. The active data position is
/// moved to the character position following the characters of the string just ended.
///
/// ### Note 1
/// The effect of receiving a CVT, HT, SCP, SPD or VT control function within an SDS string is not defined
/// by this Standard.
///
/// ### Note 2
/// The control functions for area definition (DAQ, EPA, ESA, SPA, SSA) should not be used within an SDS
/// string.
pub fn directed(string_direction: StringDirection) -> ControlSequence {
ControlSequence::new(&[&string_direction.to_string()], "]")
}
#[derive(Clone)]
pub struct GraphicSelection {
modes: Vec<String>,
}
impl GraphicSelection {
pub fn new() -> Self { Self { modes: vec![] } }
/// Default rendition (implementation-defined), cancels the effect of any preceding occurrence of SGR in
/// the data stream regardless of the setting of the GRAPHIC RENDITION COMBINATION MODE (GRCM).
pub fn default(&mut self) -> &mut Self { self.add("0") }
/// Bold or increased intensity
pub fn bold(&mut self) -> &mut Self { self.add("1") }
/// Faint, decreased intensity or second color
pub fn faint(&mut self) -> &mut Self { self.add("2") }
pub fn italic(&mut self) -> &mut Self { self.add("3") }
pub fn underline(&mut self) -> &mut Self { self.add("4") }
/// Slowly blinking (less than 150/minute)
pub fn slow_blink(&mut self) -> &mut Self { self.add("5") }
/// Rapidly blinking (150/minute or more)
pub fn fast_blink(&mut self) -> &mut Self { self.add("6") }
pub fn negative(&mut self) -> &mut Self { self.add("7") }
pub fn conceal(&mut self) -> &mut Self { self.add("8") }
/// Crossed-out (characters still legible but marked as to be deleted)
pub fn cross(&mut self) -> &mut Self { self.add("9") }
pub fn primary_font(&mut self) -> &mut Self { self.add("10") }
pub fn alter1_font(&mut self) -> &mut Self { self.add("11") }
pub fn alter2_font(&mut self) -> &mut Self { self.add("12") }
pub fn alter3_font(&mut self) -> &mut Self { self.add("13") }
pub fn alter4_font(&mut self) -> &mut Self { self.add("14") }
pub fn alter5_font(&mut self) -> &mut Self { self.add("15") }
pub fn alter6_font(&mut self) -> &mut Self { self.add("16") }
pub fn alter7_font(&mut self) -> &mut Self { self.add("17") }
pub fn alter8_font(&mut self) -> &mut Self { self.add("18") }
pub fn alter9_font(&mut self) -> &mut Self { self.add("19") }
pub fn gothic_font(&mut self) -> &mut Self { self.add("20") }
pub fn double_underline(&mut self) -> &mut Self { self.add("21") }
/// Normal color or normal intensity
pub fn not_bold_or_faint(&mut self) -> &mut Self { self.add("22") }
/// Not italicized, not gothic font
pub fn not_italic(&mut self) -> &mut Self { self.add("23") }
/// Not underline (neither singly or doubly)
pub fn not_underline(&mut self) -> &mut Self { self.add("24") }
/// Steady (not blinking)
pub fn not_blink(&mut self) -> &mut Self { self.add("25") }
/// Positive image
pub fn not_negative(&mut self) -> &mut Self { self.add("27") }
/// Revealed characters
pub fn not_conceal(&mut self) -> &mut Self { self.add("28") }
pub fn not_cross(&mut self) -> &mut Self { self.add("29") }
pub fn fg_black(&mut self) -> &mut Self { self.add("30") }
pub fn fg_red(&mut self) -> &mut Self { self.add("31") }
pub fn fg_green(&mut self) -> &mut Self { self.add("32") }
pub fn fg_yellow(&mut self) -> &mut Self { self.add("33") }
pub fn fg_blue(&mut self) -> &mut Self { self.add("34") }
pub fn fg_magenta(&mut self) -> &mut Self { self.add("35") }
pub fn fg_cyan(&mut self) -> &mut Self { self.add("36") }
pub fn fg_gray(&mut self) -> &mut Self { self.add("37") }
pub fn fg_color(&mut self) -> &mut Self { self.add("38") }
pub fn fg_default(&mut self) -> &mut Self { self.add("39") }
pub fn bg_black(&mut self) -> &mut Self { self.add("40") }
pub fn bg_red(&mut self) -> &mut Self { self.add("41") }
pub fn bg_green(&mut self) -> &mut Self { self.add("42") }
pub fn bg_yellow(&mut self) -> &mut Self { self.add("43") }
pub fn bg_blue(&mut self) -> &mut Self { self.add("44") }
pub fn bg_magenta(&mut self) -> &mut Self { self.add("45") }
pub fn bg_cyan(&mut self) -> &mut Self { self.add("46") }
pub fn bg_gray(&mut self) -> &mut Self { self.add("47") }
pub fn bg_color(&mut self) -> &mut Self { self.add("48") }
pub fn bg_default(&mut self) -> &mut Self { self.add("49") }
pub fn frame(&mut self) -> &mut Self { self.add("51") }
pub fn encircle(&mut self) -> &mut Self { self.add("52") }
pub fn overline(&mut self) -> &mut Self { self.add("53") }
pub fn not_frame_not_encircle(&mut self) -> &mut Self { self.add("54") }
pub fn not_overline(&mut self) -> &mut Self { self.add("55") }
pub fn ideogram_underline(&mut self) -> &mut Self { self.add("60") }
pub fn ideogram_double_underline(&mut self) -> &mut Self { self.add("61") }
pub fn ideogram_overline(&mut self) -> &mut Self { self.add("62") }
pub fn ideogram_double_overline(&mut self) -> &mut Self { self.add("63") }
pub fn ideogram_stress_marking(&mut self) -> &mut Self { self.add("64") }
pub fn ideogram_cancel(&mut self) -> &mut Self { self.add("65") }
pub fn get(&self) -> ControlSequence {
ControlSequence::new(&self.modes.iter().map(|s| s.as_str()).collect::<Vec<_>>(), "m")
}
fn add(&mut self, s: &str) -> &mut Self {
self.modes.push(s.to_string());
self
}
}
/// # SGR - Select graphic rendition
///
/// SGR is used to establish one or more graphic rendition aspects for subsequent text. The established
/// aspects remain in effect until the next occurrence of SGR in the data stream, depending on the setting of
/// the GRAPHIC RENDITION COMBINATION MODE (GRCM).
///
/// ### Example
/// ```
/// use coded_chars::control::rendition::select_graphic;
///
/// // Direct format
/// println!("Hello {}{}{} !", select_graphic().fg_red().bold().underline(), "World", select_graphic().default());
/// ```
pub fn select_graphic() -> GraphicSelection {
GraphicSelection::new()
}
impl Display for GraphicSelection {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.get())
}
}
/// Format a string with the specified `SGR` sequence.
///
/// The string is terminated with the sequence `\x1b[0m` to reset the style.
///
/// ### Example
/// ```
/// use coded_chars::control::rendition::{format_str, select_graphic};
///
/// let formatted = format_str(
/// "World",
/// select_graphic().fg_red().bold().underline()
/// );
/// println!("Hello {} !", formatted);
/// ```
pub fn format_str(str: &str, format: &GraphicSelection) -> String {
format!("{}{}{}", format, str, select_graphic().default())
}
pub enum CharacterSpacing {
Per25mm10Chars,
Per25mm12Chars,
Per25mm15Chars,
Per25mm16Chars,
Per25mm3Chars,
Per50mm9Chars,
Per25mm4Chars,
}
impl Display for CharacterSpacing {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
CharacterSpacing::Per25mm10Chars => "0",
CharacterSpacing::Per25mm12Chars => "1",
CharacterSpacing::Per25mm15Chars => "2",
CharacterSpacing::Per25mm16Chars => "3",
CharacterSpacing::Per25mm3Chars => "4",
CharacterSpacing::Per50mm9Chars => "5",
CharacterSpacing::Per25mm4Chars => "6",
})
}
}
/// # SHS - Select character spacing
///
/// SHS is used to establish the character spacing for subsequent text. The established spacing remains in
/// effect until the next occurrence of SHS or of SET CHARACTER SPACING (SCS) or of SPACING
/// INCREMENT (SPI) in the data stream.
pub fn select_spacing(character_spacing: CharacterSpacing) -> ControlSequence {
ControlSequence::new(&[&character_spacing.to_string()], " K")
}
/// # SPI - Spacing increment
///
/// SPI is used to establish the line spacing and the character spacing for subsequent text. The established
/// line spacing remains in effect until the next occurrence of SPI or of SET LINE SPACING (SLS) or of
/// SELECT LINE SPACING (SVS) in the data stream. The established character spacing remains in effect
/// until the next occurrence of SET CHARACTER SPACING (SCS) or of SELECT CHARACTER
/// SPACING (SHS) in the data stream.
///
/// The unit in which the parameter values are expressed is that established by the parameter value of
/// SELECT SIZE UNIT (SSU).
pub fn spacing_increment(line_spacing: usize, character_spacing: usize) -> ControlSequence {
ControlSequence::new(&[&line_spacing.to_string(), &character_spacing.to_string()], " G")
}
/// # SRCS - Set reduced character separation
///
/// SRCS is used to establish reduced inter-character escapement for subsequent text. The established
/// reduced escapement remains in effect until the next occurrence of SRCS or of SET ADDITIONAL
/// CHARACTER SEPARATION (SACS) in the data stream or until it is reset to the default value by a
/// subsequent occurrence of CARRIAGE RETURN/LINE FEED (CR/LF) or of NEXT LINE (NEL) in the
/// data stream.
///
/// `n` specifies the number of units by which the inter-character escapement is reduced.
///
/// The unit in which the parameter value is expressed is that established by the parameter value of SELECT
/// SIZE UNIT (SSU).
pub fn reduce_separation(n: usize) -> ControlSequence {
ControlSequence::new(&[&n.to_string()], " f")
}
pub enum StringReversion {
End,
BeginReverse,
}
impl Display for StringReversion {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
Self::End => "0",
Self::BeginReverse => "1",
})
}
}
/// # SRS - Start reversed string
///
/// SRS is used to establish in the data component the beginning and the end of a string of characters as well
/// as the direction of the string. This direction is opposite to that currently established. The indicated string
/// follows the preceding text. The established character progression is not affected.
///
/// The beginning of a reversed string is indicated by SRS with a parameter value of 1. A reversed string
/// may contain one or more nested strings. These nested strings may be reversed strings the beginnings of
/// which are indicated by SRS with a parameter value of 1, or directed strings the beginnings of which are
/// indicated by START DIRECTED STRING (SDS) with a parameter value not equal to 0. Every
/// beginning of such a string invokes the next deeper level of nesting.
///
/// This Standard does not define the location of the active data position within any such nested string.
///
/// The end of a reversed string is indicated by SRS with a parameter value of 0. Every end of such a string
/// re-establishes the next higher level of nesting (the one in effect prior to the string just ended). The
/// direction is re-established to that in effect prior to the string just ended. The active data position is
/// moved to the character position following the characters of the string just ended.
///
/// ### Note 1
/// The effect of receiving a CVT, HT, SCP, SPD or VT control function within an SRS string is not defined
/// by this Standard.
///
/// ### Note 2
/// The control functions for area definition (DAQ, EPA, ESA, SPA, SSA) should not be used within an SRS
/// string.
pub fn reversed(string_reversion: StringReversion) -> ControlSequence {
ControlSequence::new(&[&string_reversion.to_string()], "[")
}
pub enum SizeUnit {
Character,
Millimeter,
ComputerDeciPoint,
DeciDidot,
Mil,
BasicMeasuringUnit,
Micrometer,
Pixel,
DeciPoint,
}
impl Display for SizeUnit {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", match self {
SizeUnit::Character => "0",
SizeUnit::Millimeter => "1",
SizeUnit::ComputerDeciPoint => "2",
SizeUnit::DeciDidot => "3",
SizeUnit::Mil => "4",
SizeUnit::BasicMeasuringUnit => "5",
SizeUnit::Micrometer => "6",
SizeUnit::Pixel => "7",
SizeUnit::DeciPoint => "8",
})
}
}
/// # SSU - Select size unit
///
/// SSU is used to establish the unit in which the numeric parameters of certain control functions are
/// expressed. The established unit remains in effect until the next occurrence of SSU in the data stream.
pub fn select_size_unit(size_unit: SizeUnit) -> ControlSequence {
ControlSequence::new(&[&size_unit.to_string()], " I")
}