1/* Part of SWI-Prolog 2 3 Author: Jan Wielemaker 4 E-mail: J.Wielemaker@vu.nl 5 WWW: http://www.swi-prolog.org 6 Copyright (c) 2010-2023, VU University Amsterdam 7 CWI, Amsterdam 8 SWI-Prolog Solutions b.v. 9 All rights reserved. 10 11 Redistribution and use in source and binary forms, with or without 12 modification, are permitted provided that the following conditions 13 are met: 14 15 1. Redistributions of source code must retain the above copyright 16 notice, this list of conditions and the following disclaimer. 17 18 2. Redistributions in binary form must reproduce the above copyright 19 notice, this list of conditions and the following disclaimer in 20 the documentation and/or other materials provided with the 21 distribution. 22 23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 25 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 26 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 27 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 28 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 29 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 30 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 31 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 33 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 34 POSSIBILITY OF SUCH DAMAGE. 35*/ 36 37:- module(ansi_term, 38 [ ansi_format/3, % +Attr, +Format, +Args 39 ansi_get_color/2, % +Which, -rgb(R,G,B) 40 ansi_hyperlink/2, % +Stream,+Location 41 ansi_hyperlink/3 % +Stream,+URL,+Label 42 ]). 43:- autoload(library(error), [domain_error/2, must_be/2, instantiation_error/1]). 44:- autoload(library(lists), [append/3]). 45:- autoload(library(utf8), [utf8_codes/3]).
70:- multifile 71 prolog:console_color/2, % +Term, -AnsiAttrs 72 supports_get_color/0, 73 hyperlink/2. % +Stream, +Spec 74 75 76color_term_flag_default(true) :- 77 stream_property(user_input, tty(true)), 78 stream_property(user_error, tty(true)), 79 stream_property(user_output, tty(true)), 80 \+ getenv('TERM', dumb), 81 !. 82color_term_flag_default(false). 83 84init_color_term_flag :- 85 color_term_flag_default(Default), 86 create_prolog_flag(color_term, Default, 87 [ type(boolean), 88 keep(true) 89 ]), 90 create_prolog_flag(hyperlink_term, false, 91 [ type(boolean), 92 keep(true) 93 ]). 94 95:- init_color_term_flag. 96 97 98:- meta_predicate 99 keep_line_pos(, ). 100 101:- multifile 102 user:message_property/2.
current_output is a
terminal, it adds ANSI escape sequences according to Attributes.
For example, to print a text in bold cyan, do
?- ansi_format([bold,fg(cyan)], 'Hello ~w', [world]).
Attributes is either a single attribute, a list thereof or a term that is mapped to concrete attributes based on the current theme (see prolog:console_color/2). The attribute names are derived from the ANSI specification. See the source for sgr_code/2 for details. Some commonly used attributes are:
fg(Color) and bg(Color), the colour name can be '#RGB' or
'#RRGGBB'h(Color)
or an integer 0..255.
Defined color constants are below. default can be used to
access the default color of the terminal.
ANSI sequences are sent if and only if
current_output has the property tty(true) (see
stream_property/2).color_term is true.144ansi_format(Attr, Format, Args) :- 145 ansi_format(current_output, Attr, Format, Args). 146 147ansi_format(Stream, Class, Format, Args) :- 148 stream_property(Stream, tty(true)), 149 current_prolog_flag(color_term, true), 150 !, 151 class_attrs(Class, Attr), 152 phrase(sgr_codes_ex(Attr), Codes), 153 atomic_list_concat(Codes, ;, Code), 154 with_output_to( 155 Stream, 156 ( keep_line_pos(current_output, format('\e[~wm', [Code])), 157 format(Format, Args), 158 keep_line_pos(current_output, format('\e[0m')) 159 ) 160 ), 161 flush_output. 162ansi_format(Stream, _Attr, Format, Args) :- 163 format(Stream, Format, Args). 164 165sgr_codes_ex(X) --> 166 { var(X), 167 !, 168 instantiation_error(X) 169 }. 170sgr_codes_ex([]) --> 171 !. 172sgr_codes_ex([H|T]) --> 173 !, 174 sgr_codes_ex(H), 175 sgr_codes_ex(T). 176sgr_codes_ex(Attr) --> 177 ( { sgr_code(Attr, Code) } 178 -> ( { is_list(Code) } 179 -> list(Code) 180 ; [Code] 181 ) 182 ; { domain_error(sgr_code, Attr) } 183 ). 184 185list([]) --> []. 186list([H|T]) --> [H], list(T).
| reset | all attributes off |
| bold | |
| faint | |
| italic | |
| underline | |
blink(slow) | |
blink(rapid) | |
| negative | |
| conceal | |
| crossed_out | |
font(primary) | |
font(N) | Alternate font (1..8) |
| fraktur | |
underline(double) | |
intensity(normal) | |
fg(Name) | Color name |
bg(Name) | Color name |
| framed | |
| encircled | |
| overlined | |
ideogram(underline) | |
| right_side_line | |
ideogram(underline(double)) | |
right_side_line(double) | |
ideogram(overlined) | |
| left_side_line | |
ideogram(stress_marking) | |
| -Off | Switch attributes off |
hfg(Name) | Color name |
hbg(Name) | Color name |
228sgr_code(reset, 0). 229sgr_code(bold, 1). 230sgr_code(faint, 2). 231sgr_code(italic, 3). 232sgr_code(underline, 4). 233sgr_code(blink(slow), 5). 234sgr_code(blink(rapid), 6). 235sgr_code(negative, 7). 236sgr_code(conceal, 8). 237sgr_code(crossed_out, 9). 238sgr_code(font(primary), 10) :- !. 239sgr_code(font(N), C) :- 240 C is 10+N. 241sgr_code(fraktur, 20). 242sgr_code(underline(double), 21). 243sgr_code(intensity(normal), 22). 244sgr_code(fg(Name), C) :- 245 ( ansi_color(Name, N) 246 -> C is N+30 247 ; rgb(Name, R, G, B) 248 -> sgr_code(fg(R,G,B), C) 249 ). 250sgr_code(bg(Name), C) :- 251 !, 252 ( ansi_color(Name, N) 253 -> C is N+40 254 ; rgb(Name, R, G, B) 255 -> sgr_code(bg(R,G,B), C) 256 ). 257sgr_code(framed, 51). 258sgr_code(encircled, 52). 259sgr_code(overlined, 53). 260sgr_code(ideogram(underline), 60). 261sgr_code(right_side_line, 60). 262sgr_code(ideogram(underline(double)), 61). 263sgr_code(right_side_line(double), 61). 264sgr_code(ideogram(overlined), 62). 265sgr_code(left_side_line, 62). 266sgr_code(ideogram(stress_marking), 64). 267sgr_code(-X, Code) :- 268 off_code(X, Code). 269sgr_code(hfg(Name), C) :- 270 ansi_color(Name, N), 271 C is N+90. 272sgr_code(hbg(Name), C) :- 273 !, 274 ansi_color(Name, N), 275 C is N+100. 276sgr_code(fg8(Name), [38,5,N]) :- 277 ansi_color8(Name, N). 278sgr_code(bg8(Name), [48,5,N]) :- 279 ansi_color8(Name, N). 280sgr_code(fg(R,G,B), [38,2,R,G,B]) :- 281 between(0, 255, R), 282 between(0, 255, G), 283 between(0, 255, B). 284sgr_code(bg(R,G,B), [48,2,R,G,B]) :- 285 between(0, 255, R), 286 between(0, 255, G), 287 between(0, 255, B). 288 289off_code(italic_and_franktur, 23). 290off_code(underline, 24). 291off_code(blink, 25). 292off_code(negative, 27). 293off_code(conceal, 28). 294off_code(crossed_out, 29). 295off_code(framed, 54). 296off_code(overlined, 55). 297 298ansi_color8(h(Name), N) :- 299 !, 300 ansi_color(Name, N0), 301 N is N0+8. 302ansi_color8(Name, N) :- 303 atom(Name), 304 !, 305 ansi_color(Name, N). 306ansi_color8(N, N) :- 307 between(0, 255, N). 308 309ansi_color(black, 0). 310ansi_color(red, 1). 311ansi_color(green, 2). 312ansi_color(yellow, 3). 313ansi_color(blue, 4). 314ansi_color(magenta, 5). 315ansi_color(cyan, 6). 316ansi_color(white, 7). 317ansi_color(default, 9). 318 319rgb(Name, R, G, B) :- 320 atom_codes(Name, [0'#,R1,R2,G1,G2,B1,B2]), 321 hex_color(R1,R2,R), 322 hex_color(G1,G2,G), 323 hex_color(B1,B2,B). 324rgb(Name, R, G, B) :- 325 atom_codes(Name, [0'#,R1,G1,B1]), 326 hex_color(R1,R), 327 hex_color(G1,G), 328 hex_color(B1,B). 329 330hex_color(D1,D2,V) :- 331 code_type(D1, xdigit(V1)), 332 code_type(D2, xdigit(V2)), 333 V is 16*V1+V2. 334 335hex_color(D1,V) :- 336 code_type(D1, xdigit(V1)), 337 V is 16*V1+V1.
boot/messages.pl.
350 /******************************* 351 * HOOK * 352 *******************************/
ansi(+Attr, +Fmt, +Args) in
message specifications.359prolog:message_line_element(S, ansi(Class, Fmt, Args)) :- 360 class_attrs(Class, Attr), 361 ansi_format(S, Attr, Fmt, Args). 362prolog:message_line_element(S, ansi(Class, Fmt, Args, Ctx)) :- 363 class_attrs(Class, Attr), 364 ansi_format(S, Attr, Fmt, Args), 365 ( nonvar(Ctx), 366 Ctx = ansi(_, RI-RA) 367 -> keep_line_pos(S, format(S, RI, RA)) 368 ; true 369 ). 370prolog:message_line_element(S, url(Location)) :- 371 ansi_hyperlink(S, Location). 372prolog:message_line_element(S, url(URL, Label)) :- 373 ansi_hyperlink(S, URL, Label). 374prolog:message_line_element(S, begin(Level, Ctx)) :- 375 level_attrs(Level, Attr), 376 stream_property(S, tty(true)), 377 current_prolog_flag(color_term, true), 378 !, 379 ( is_list(Attr) 380 -> sgr_codes(Attr, Codes), 381 atomic_list_concat(Codes, ;, Code) 382 ; sgr_code(Attr, Code) 383 ), 384 keep_line_pos(S, format(S, '\e[~wm', [Code])), 385 Ctx = ansi('\e[0m', '\e[0m\e[~wm'-[Code]). 386prolog:message_line_element(S, end(Ctx)) :- 387 nonvar(Ctx), 388 Ctx = ansi(Reset, _), 389 keep_line_pos(S, write(S, Reset)). 390 391sgr_codes([], []). 392sgr_codes([H0|T0], [H|T]) :- 393 sgr_code(H0, H), 394 sgr_codes(T0, T). 395 396level_attrs(Level, Attrs) :- 397 user:message_property(Level, color(Attrs)), 398 !. 399level_attrs(Level, Attrs) :- 400 class_attrs(message(Level), Attrs). 401 402class_attrs(Class, Attrs) :- 403 user:message_property(Class, color(Attrs)), 404 !. 405class_attrs(Class, Attrs) :- 406 prolog:console_color(Class, Attrs), 407 !. 408class_attrs(Class, Attrs) :- 409 '$messages':default_theme(Class, Attrs), 410 !. 411class_attrs(Attrs, Attrs).
L before the line.
``file://AbsFileName[#LLine[:Column]]``
425ansi_hyperlink(Stream, Location) :- 426 hyperlink(Stream, url(Location)), 427 !. 428ansi_hyperlink(Stream, Location) :- 429 location_label(Location, Label), 430 ansi_hyperlink(Stream, Location, Label). 431 432location_label(File:Line:Column, Label) => 433 format(string(Label), '~w:~w:~w', [File,Line,Column]). 434location_label(File:Line, Label) => 435 format(string(Label), '~w:~w', [File,Line]). 436location_label(File, Label) => 437 format(string(Label), '~w', [File]). 438 439ansi_hyperlink(Stream, Location, Label), 440 hyperlink(Stream, url(Location, Label)) => 441 true. 442ansi_hyperlink(Stream, File:Line:Column, Label) => 443 ( url_file_name(URI, File) 444 -> format(Stream, '\e]8;;~w#~d:~d\e\\~w\e]8;;\e\\', 445 [ URI, Line, Column, Label ]) 446 ; format(Stream, '~w', [Label]) 447 ). 448ansi_hyperlink(Stream, File:Line, Label) => 449 !, 450 ( url_file_name(URI, File) 451 -> format(Stream, '\e]8;;~w#~w\e\\~w\e]8;;\e\\', 452 [ URI, Line, Label ]) 453 ; format(Stream, '~w', [Label]) 454 ). 455ansi_hyperlink(Stream, File, Label) => 456 ( url_file_name(URI, File) 457 -> format(Stream, '\e]8;;~w\e\\~w\e]8;;\e\\', 458 [ URI, Label ]) 459 ; format(Stream, '~w', [Label]) 460 ). 461 462is_url(URL) :- 463 ( atom(URL) 464 -> true 465 ; string(URL) 466 ), 467 url_prefix(Prefix), 468 sub_string(URL, 0, _, _, Prefix). 469 470url_prefix('http://'). 471url_prefix('https://'). 472url_prefix('file://').
clib package and its foreign support.480url_file_name(URL, File) :- 481 is_url(File), !, 482 URL = File. 483url_file_name(URL, File) :- 484 current_prolog_flag(hyperlink_term, true), 485 absolute_file_name(File, AbsFile), 486 ensure_leading_slash(AbsFile, AbsFile1), 487 url_encode_path(AbsFile1, Encoded), 488 format(string(URL), 'file://~s', [Encoded]). 489 490ensure_leading_slash(Path, SlashPath) :- 491 ( sub_atom(Path, 0, _, _, /) 492 -> SlashPath = Path 493 ; atom_concat(/, Path, SlashPath) 494 ). 495 496url_encode_path(Name, Encoded) :- 497 atom_codes(Name, Codes), 498 phrase(utf8_codes(Codes), UTF8), 499 phrase(encode(UTF8), Encoded). 500 501encode([]) --> []. 502encode([H|T]) --> encode1(H), encode(T). 503 504encode1(C) --> 505 { reserved(C), 506 !, 507 format(codes([C1,C2]), '~`0t~16r~2|', [C]) 508 }, 509 "%", [C1,C2]. 510encode1(C) --> 511 [C]. 512 513reserved(C) :- C =< 0'\s. 514reserved(C) :- C >= 127. 515reserved(0'#).
line_pos notion.523keep_line_pos(S, G) :- 524 stream_property(S, position(Pos)), 525 !, 526 setup_call_cleanup( 527 stream_position_data(line_position, Pos, LPos), 528 G, 529 set_stream(S, line_position(LPos))). 530keep_line_pos(_, G) :- 531 call(G).
foreground and background. This predicate sends a request to the
console (user_output) and reads the reply. This assumes an xterm
compatible terminal.
544ansi_get_color(Which0, RGB) :- 545 stream_property(user_input, tty(true)), 546 stream_property(user_output, tty(true)), 547 stream_property(user_error, tty(true)), 548 supports_get_color, 549 ( color_alias(Which0, Which) 550 -> true 551 ; must_be(between(0,15),Which0) 552 -> Which = Which0 553 ), 554 catch(keep_line_pos(user_output, 555 ansi_get_color_(Which, RGB)), 556 error(timeout_error(_,_), _), 557 no_xterm). 558 559supports_get_color :- 560 getenv('TERM', Term), 561 sub_atom(Term, 0, _, _, xterm), 562 \+ getenv('TERM_PROGRAM', 'Apple_Terminal'). 563 564color_alias(foreground, 10). 565color_alias(background, 11). 566 567ansi_get_color_(Which, rgb(R,G,B)) :- 568 format(codes(Id), '~w', [Which]), 569 hex4(RH), 570 hex4(GH), 571 hex4(BH), 572 phrase(("\e]", , ";rgb:", , "/", , "/", , "\a"), Pattern), 573 stream_property(user_input, timeout(Old)), 574 setup_call_cleanup( 575 set_stream(user_input, timeout(0.05)), 576 with_tty_raw(exchange_pattern(Which, Pattern)), 577 set_stream(user_input, timeout(Old))), 578 !, 579 hex_val(RH, R), 580 hex_val(GH, G), 581 hex_val(BH, B). 582 583no_xterm :- 584 print_message(warning, ansi(no_xterm_get_colour)), 585 fail. 586 587hex4([_,_,_,_]). 588 589hex_val([D1,D2,D3,D4], V) :- 590 code_type(D1, xdigit(V1)), 591 code_type(D2, xdigit(V2)), 592 code_type(D3, xdigit(V3)), 593 code_type(D4, xdigit(V4)), 594 V is (V1<<12)+(V2<<8)+(V3<<4)+V4. 595 596exchange_pattern(Which, Pattern) :- 597 format(user_output, '\e]~w;?\a', [Which]), 598 flush_output(user_output), 599 read_pattern(user_input, Pattern, []). 600 601read_pattern(From, Pattern, NotMatched0) :- 602 copy_term(Pattern, TryPattern), 603 append(Skip, Rest, NotMatched0), 604 append(Rest, RestPattern, TryPattern), 605 !, 606 echo(Skip), 607 try_read_pattern(From, RestPattern, NotMatched, Done), 608 ( Done == true 609 -> Pattern = TryPattern 610 ; read_pattern(From, Pattern, NotMatched) 611 ).
615try_read_pattern(_, [], [], true) :- 616 !. 617try_read_pattern(From, [H|T], [C|RT], Done) :- 618 get_code(C), 619 ( C = H 620 -> try_read_pattern(From, T, RT, Done) 621 ; RT = [], 622 Done = false 623 ). 624 625echo([]). 626echo([H|T]) :- 627 put_code(user_output, H), 628 echo(T). 629 630:- multifile prolog:message//1. 631 632prologmessage(ansi(no_xterm_get_colour)) --> 633 [ 'Terminal claims to be xterm compatible,'-[], nl, 634 'but does not report colour info'-[] 635 ]
Print decorated text to ANSI consoles
This library allows for exploiting the color and attribute facilities of most modern terminals using ANSI escape sequences. This library provides the following:
The behavior of this library is controlled by two Prolog flags:
true, activate the color output for this library. Otherwise simply call format/3.url(Location)andurl(URL, Label)elements of Prolog messages.