extra/terminfo/terminfo.factor

   1 ! Copyright (C) 2013 John Benediktsson.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3
   4 USING: accessors assocs combinators formatting endian fry
   5 grouping hashtables io io.directories io.encodings.binary
   6 io.files io.files.types io.pathnames kernel math math.parser
   7 memoize pack sequences sequences.generalizations splitting
   8 strings system ;
   9
  10 IN: terminfo
  11
  12 ! Reads compiled terminfo files
  13 ! typically located in any of the directories below.
  14 CONSTANT: TERMINFO-DIRS {
  15     "~/.terminfo"
  16     "/etc/terminfo"
  17     "/lib/terminfo"
  18     "/usr/share/terminfo"
  19 }
  20
  21 <PRIVATE
  22
  23 CONSTANT: MAGIC 0o432
  24
  25 ERROR: bad-magic ;
  26
  27 : check-magic ( n -- )
  28     MAGIC = [ bad-magic ] unless ;
  29
  30 TUPLE: terminfo-header names-bytes boolean-bytes #numbers
  31 #strings string-bytes ;
  32
  33 C: <terminfo-header> terminfo-header
  34
  35 : read-header ( -- header )
  36     12 read "ssssss" unpack-le unclip check-magic
  37     5 firstn <terminfo-header> ;
  38
  39 : read-names ( header -- names )
  40     names-bytes>> read but-last "|" split [ >string ] map ;
  41
  42 : read-booleans ( header -- booleans )
  43     boolean-bytes>> read [ 1 = ] { } map-as ;
  44
  45 : read-shorts ( n -- seq' )
  46     2 * read 2 <groups> [ signed-le> dup 0 < [ drop f ] when ] map ;
  47
  48 : align-even-bytes ( header -- )
  49     [ names-bytes>> ] [ boolean-bytes>> ] bi + odd?
  50     [ read1 drop ] when ;
  51
  52 : read-numbers ( header -- numbers )
  53     [ align-even-bytes ] [ #numbers>> read-shorts ] bi ;
  54
  55 : string-offset ( from seq -- str )
  56     0 2over index-from swap subseq >string ;
  57
  58 : read-strings ( header -- strings )
  59     [ #strings>> read-shorts ] [ string-bytes>> read ] bi
  60     '[ [ _ string-offset ] [ f ] if* ] map ;
  61
  62 TUPLE: terminfo names booleans numbers strings ;
  63
  64 C: <terminfo> terminfo
  65
  66 : read-terminfo ( -- terminfo )
  67     read-header {
  68         [ read-names ]
  69         [ read-booleans ]
  70         [ read-numbers ]
  71         [ read-strings ]
  72     } cleave <terminfo> ;
  73
  74 PRIVATE>
  75
  76 : file>terminfo ( path -- terminfo )
  77     binary [ read-terminfo ] with-file-reader ;
  78
  79 HOOK: terminfo-relative-path os ( name -- path )
  80
  81 M: macosx terminfo-relative-path ( name -- path )
  82     [ first >hex ] keep "%s/%s" sprintf ;
  83
  84 M: linux terminfo-relative-path ( name -- path )
  85     [ first ] keep "%c/%s" sprintf ;
  86
  87 : terminfo-path ( name -- path )
  88     terminfo-relative-path TERMINFO-DIRS [ swap append-path ] with map
  89     [ file-exists? ] find nip ;
  90
  91 : terminfo-names-for-path ( path -- names )
  92     [
  93         [ type>> +directory+ = ] filter
  94         [ name>> directory-files ] map concat
  95     ] with-directory-entries ;
  96
  97 MEMO: terminfo-names ( -- names )
  98     TERMINFO-DIRS [ file-exists? ] filter
  99     [ terminfo-names-for-path ] map concat ;
 100
 101 <PRIVATE
 102
 103 CONSTANT: boolean-names {
 104     "auto_left_margin" "auto_right_margin" "no_esc_ctlc"
 105     "ceol_standout_glitch" "eat_newline_glitch"
 106     "erase_overstrike" "generic_type" "hard_copy" "has_meta_key"
 107     "has_status_line" "insert_null_glitch" "memory_above"
 108     "memory_below" "move_insert_mode" "move_standout_mode"
 109     "over_strike" "status_line_esc_ok" "dest_tabs_magic_smso"
 110     "tilde_glitch" "transparent_underline" "xon_xoff"
 111     "needs_xon_xoff" "prtr_silent" "hard_cursor" "non_rev_rmcup"
 112     "no_pad_char" "non_dest_scroll_region" "can_change"
 113     "back_color_erase" "hue_lightness_saturation"
 114     "col_addr_glitch" "cr_cancels_micro_mode" "has_print_wheel"
 115     "row_addr_glitch" "semi_auto_right_margin" "cpi_changes_res"
 116     "lpi_changes_res" "backspaces_with_bs" "crt_no_scrolling"
 117     "no_correctly_working_cr" "gnu_has_meta_key"
 118     "linefeed_is_newline" "has_hardware_tabs"
 119     "return_does_clr_eol"
 120 }
 121
 122 CONSTANT: number-names {
 123     "columns" "init_tabs" "lines" "lines_of_memory"
 124     "magic_cookie_glitch" "padding_baud_rate" "virtual_terminal"
 125     "width_status_line" "num_labels" "label_height"
 126     "label_width" "max_attributes" "maximum_windows"
 127     "max_colors" "max_pairs" "no_color_video" "buffer_capacity"
 128     "dot_vert_spacing" "dot_horz_spacing" "max_micro_address"
 129     "max_micro_jump" "micro_col_size" "micro_line_size"
 130     "number_of_pins" "output_res_char" "output_res_line"
 131     "output_res_horz_inch" "output_res_vert_inch" "print_rate"
 132     "wide_char_size" "buttons" "bit_image_entwining"
 133     "bit_image_type" "magic_cookie_glitch_ul"
 134     "carriage_return_delay" "new_line_delay" "backspace_delay"
 135     "horizontal_tab_delay" "number_of_function_keys"
 136 }
 137
 138 CONSTANT: string-names {
 139     "back_tab" "bell" "carriage_return" "change_scroll_region"
 140     "clear_all_tabs" "clear_screen" "clr_eol" "clr_eos"
 141     "column_address" "command_character" "cursor_address"
 142     "cursor_down" "cursor_home" "cursor_invisible" "cursor_left"
 143     "cursor_mem_address" "cursor_normal" "cursor_right"
 144     "cursor_to_ll" "cursor_up" "cursor_visible"
 145     "delete_character" "delete_line" "dis_status_line"
 146     "down_half_line" "enter_alt_charset_mode" "enter_blink_mode"
 147     "enter_bold_mode" "enter_ca_mode" "enter_delete_mode"
 148     "enter_dim_mode" "enter_insert_mode" "enter_secure_mode"
 149     "enter_protected_mode" "enter_reverse_mode"
 150     "enter_standout_mode" "enter_underline_mode" "erase_chars"
 151     "exit_alt_charset_mode" "exit_attribute_mode" "exit_ca_mode"
 152     "exit_delete_mode" "exit_insert_mode" "exit_standout_mode"
 153     "exit_underline_mode" "flash_screen" "form_feed"
 154     "from_status_line" "init_1string" "init_2string"
 155     "init_3string" "init_file" "insert_character" "insert_line"
 156     "insert_padding" "key_backspace" "key_catab" "key_clear"
 157     "key_ctab" "key_dc" "key_dl" "key_down" "key_eic" "key_eol"
 158     "key_eos" "key_f0" "key_f1" "key_f10" "key_f2" "key_f3"
 159     "key_f4" "key_f5" "key_f6" "key_f7" "key_f8" "key_f9"
 160     "key_home" "key_ic" "key_il" "key_left" "key_ll" "key_npage"
 161     "key_ppage" "key_right" "key_sf" "key_sr" "key_stab"
 162     "key_up" "keypad_local" "keypad_xmit" "lab_f0" "lab_f1"
 163     "lab_f10" "lab_f2" "lab_f3" "lab_f4" "lab_f5" "lab_f6"
 164     "lab_f7" "lab_f8" "lab_f9" "meta_off" "meta_on" "newline"
 165     "pad_char" "parm_dch" "parm_delete_line" "parm_down_cursor"
 166     "parm_ich" "parm_index" "parm_insert_line"
 167     "parm_left_cursor" "parm_right_cursor" "parm_rindex"
 168     "parm_up_cursor" "pkey_key" "pkey_local" "pkey_xmit"
 169     "print_screen" "prtr_off" "prtr_on" "repeat_char"
 170     "reset_1string" "reset_2string" "reset_3string" "reset_file"
 171     "restore_cursor" "row_address" "save_cursor"
 172     "scroll_forward" "scroll_reverse" "set_attributes" "set_tab"
 173     "set_window" "tab" "to_status_line" "underline_char"
 174     "up_half_line" "init_prog" "key_a1" "key_a3" "key_b2"
 175     "key_c1" "key_c3" "prtr_non" "char_padding" "acs_chars"
 176     "plab_norm" "key_btab" "enter_xon_mode" "exit_xon_mode"
 177     "enter_am_mode" "exit_am_mode" "xon_character"
 178     "xoff_character" "ena_acs" "label_on" "label_off" "key_beg"
 179     "key_cancel" "key_close" "key_command" "key_copy"
 180     "key_create" "key_end" "key_enter" "key_exit" "key_find"
 181     "key_help" "key_mark" "key_message" "key_move" "key_next"
 182     "key_open" "key_options" "key_previous" "key_print"
 183     "key_redo" "key_reference" "key_refresh" "key_replace"
 184     "key_restart" "key_resume" "key_save" "key_suspend"
 185     "key_undo" "key_sbeg" "key_scancel" "key_scommand"
 186     "key_scopy" "key_screate" "key_sdc" "key_sdl" "key_select"
 187     "key_send" "key_seol" "key_sexit" "key_sfind" "key_shelp"
 188     "key_shome" "key_sic" "key_sleft" "key_smessage" "key_smove"
 189     "key_snext" "key_soptions" "key_sprevious" "key_sprint"
 190     "key_sredo" "key_sreplace" "key_sright" "key_srsume"
 191     "key_ssave" "key_ssuspend" "key_sundo" "req_for_input"
 192     "key_f11" "key_f12" "key_f13" "key_f14" "key_f15" "key_f16"
 193     "key_f17" "key_f18" "key_f19" "key_f20" "key_f21" "key_f22"
 194     "key_f23" "key_f24" "key_f25" "key_f26" "key_f27" "key_f28"
 195     "key_f29" "key_f30" "key_f31" "key_f32" "key_f33" "key_f34"
 196     "key_f35" "key_f36" "key_f37" "key_f38" "key_f39" "key_f40"
 197     "key_f41" "key_f42" "key_f43" "key_f44" "key_f45" "key_f46"
 198     "key_f47" "key_f48" "key_f49" "key_f50" "key_f51" "key_f52"
 199     "key_f53" "key_f54" "key_f55" "key_f56" "key_f57" "key_f58"
 200     "key_f59" "key_f60" "key_f61" "key_f62" "key_f63" "clr_bol"
 201     "clear_margins" "set_left_margin" "set_right_margin"
 202     "label_format" "set_clock" "display_clock" "remove_clock"
 203     "create_window" "goto_window" "hangup" "dial_phone"
 204     "quick_dial" "tone" "pulse" "flash_hook" "fixed_pause"
 205     "wait_tone" "user0" "user1" "user2" "user3" "user4" "user5"
 206     "user6" "user7" "user8" "user9" "orig_pair" "orig_colors"
 207     "initialize_color" "initialize_pair" "set_color_pair"
 208     "set_foreground" "set_background" "change_char_pitch"
 209     "change_line_pitch" "change_res_horz" "change_res_vert"
 210     "define_char" "enter_doublewide_mode" "enter_draft_quality"
 211     "enter_italics_mode" "enter_leftward_mode"
 212     "enter_micro_mode" "enter_near_letter_quality"
 213     "enter_normal_quality" "enter_shadow_mode"
 214     "enter_subscript_mode" "enter_superscript_mode"
 215     "enter_upward_mode" "exit_doublewide_mode"
 216     "exit_italics_mode" "exit_leftward_mode" "exit_micro_mode"
 217     "exit_shadow_mode" "exit_subscript_mode"
 218     "exit_superscript_mode" "exit_upward_mode"
 219     "micro_column_address" "micro_down" "micro_left"
 220     "micro_right" "micro_row_address" "micro_up" "order_of_pins"
 221     "parm_down_micro" "parm_left_micro" "parm_right_micro"
 222     "parm_up_micro" "select_char_set" "set_bottom_margin"
 223     "set_bottom_margin_parm" "set_left_margin_parm"
 224     "set_right_margin_parm" "set_top_margin"
 225     "set_top_margin_parm" "start_bit_image" "start_char_set_def"
 226     "stop_bit_image" "stop_char_set_def" "subscript_characters"
 227     "superscript_characters" "these_cause_cr" "zero_motion"
 228     "char_set_names" "key_mouse" "mouse_info" "req_mouse_pos"
 229     "get_mouse" "set_a_foreground" "set_a_background"
 230     "pkey_plab" "device_type" "code_set_init" "set0_des_seq"
 231     "set1_des_seq" "set2_des_seq" "set3_des_seq" "set_lr_margin"
 232     "set_tb_margin" "bit_image_repeat" "bit_image_newline"
 233     "bit_image_carriage_return" "color_names"
 234     "define_bit_image_region" "end_bit_image_region"
 235     "set_color_band" "set_page_length" "display_pc_char"
 236     "enter_pc_charset_mode" "exit_pc_charset_mode"
 237     "enter_scancode_mode" "exit_scancode_mode" "pc_term_options"
 238     "scancode_escape" "alt_scancode_esc"
 239     "enter_horizontal_hl_mode" "enter_left_hl_mode"
 240     "enter_low_hl_mode" "enter_right_hl_mode"
 241     "enter_top_hl_mode" "enter_vertical_hl_mode"
 242     "set_a_attributes" "set_pglen_inch" "termcap_init2"
 243     "termcap_reset" "linefeed_if_not_lf" "backspace_if_not_bs"
 244     "other_non_function_keys" "arrow_key_map" "acs_ulcorner"
 245     "acs_ll_corner" "acs_urcorner" "acs_lrcorner" "acs_ltee"
 246     "acs_rtee" "acs_btee" "acs_ttee" "acs_hline" "acs_vline"
 247     "acs_plus" "memory_lock" "memory_unlock" "box_chars_1"
 248 }
 249
 250 : zip-names ( seq names -- assoc )
 251     swap 2dup [ length ] bi@ - f <repetition> append zip ;
 252
 253 PRIVATE>
 254
 255 : term-capabilities ( name -- assoc )
 256     terminfo-path file>terminfo {
 257         [ booleans>> boolean-names zip-names ]
 258         [ numbers>> number-names zip-names ]
 259         [ strings>> string-names zip-names ]
 260     } cleave 3append >hashtable ;