-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor pretty-printing; implement wcswidth
Closes #88 The implementation of wcswidth is taken from the corresponding Python library (https://github.com/jquast/wcwidth) which seems to have the most updated list of wide characters. However, note that there are still some emoji that aren't recognised correctly; see e.g. jquast/wcwidth#57. At some point in time, the wcswidth implementation should be refactored into its own library.
- Loading branch information
1 parent
36255d3
commit 68bfc69
Showing
7 changed files
with
1,249 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| (** Module for terminal pretty-printing utilities *) | ||
|
|
||
| open Utf8 | ||
| module ANSI = ANSITerminal | ||
|
|
||
| (** ----- String manipulation ---------- *) | ||
|
|
||
| (** Encase a string in a box *) | ||
| let make_box (s : string) : string = | ||
| let n = wcswidth s in | ||
| let top_and_bottom_row = "+" ^ String.make (n + 2) '-' ^ "+" in | ||
| let middle_row = "| " ^ s ^ " |" in | ||
| String.concat "\n" [ top_and_bottom_row; middle_row; top_and_bottom_row ] | ||
| ;; | ||
|
|
||
| (** Right-pad a string to a length of [n] with the character [fill_char]. For | ||
| example: [pad 'a' 10 'hello' -> 'helloaaaaa]. *) | ||
| let pad ?(fill_char = ' ') (n : int) (s : string) : string = | ||
| let len = wcswidth s in | ||
| if len >= n then s else s ^ String.make (n - len) fill_char | ||
| ;; | ||
|
|
||
| (** Left-pad a string to a length of [n] with the character [fill_char]. For | ||
| example: [pad_left 'a' 10 'hello' -> 'aaaaahello']. *) | ||
| let pad_left ?(fill_char = ' ') (n : int) (s : string) : string = | ||
| let len = wcswidth s in | ||
| if len >= n then s else String.make (n - len) fill_char ^ s | ||
| ;; | ||
|
|
||
| (** Pad a string on both sides to a length of [n] with the character | ||
| [fill_char]. If the number of padding characters needed is odd, the left | ||
| padding is arbitrarily chosen to be shorter. For example: [pad_center 'a' 10 | ||
| 'hello' -> 'aahelloaaa']. *) | ||
| let pad_center ?(fill_char = ' ') (n : int) (s : string) : string = | ||
| let len = wcswidth s in | ||
| if len >= n | ||
| then s | ||
| else ( | ||
| let left_pad = (n - len) / 2 in | ||
| let right_pad = n - len - left_pad in | ||
| String.make left_pad fill_char ^ s ^ String.make right_pad fill_char) | ||
| ;; | ||
|
|
||
| (** Construct a table from a list of lists. Each nested list is one row of the | ||
| table. The number of columns of the resulting table will correspond to the | ||
| length of the longest nested list. *) | ||
| let make_table | ||
| ?(header_rows : int = 0) | ||
| ?(column_padding : int = 0) | ||
| (rows : string list list) | ||
| : string | ||
| = | ||
| (* First pad all rows to the same length *) | ||
| let lengths = List.map List.length rows in | ||
| let n_columns = Utils.max_by ~default:0 Fun.id lengths in | ||
| let padded_rows = | ||
| List.map | ||
| (fun row -> | ||
| if List.length row < n_columns | ||
| then row @ List.init (n_columns - List.length row) (fun _ -> "") | ||
| else row) | ||
| rows | ||
| in | ||
|
|
||
| (* Then determine widths of each column *) | ||
| let columns = Utils.transpose padded_rows in | ||
| let widths = List.map (Utils.max_by ~default:0 wcswidth) columns in | ||
| let padded_widths = List.map (fun w -> w + (2 * column_padding)) widths in | ||
|
|
||
| (* Finally, construct the table *) | ||
| let horizontal_border = | ||
| "+" ^ String.concat "+" (List.map (fun w -> String.make w '-') padded_widths) ^ "+" | ||
| in | ||
| let make_row row = | ||
| "|" | ||
| ^ String.concat | ||
| "|" | ||
| (List.map2 | ||
| (fun w s -> | ||
| String.make column_padding ' ' | ||
| ^ pad ~fill_char:' ' w s | ||
| ^ String.make column_padding ' ') | ||
| widths | ||
| row) | ||
| ^ "|" | ||
| in | ||
| let headers, remainder = Utils.split_at header_rows padded_rows in | ||
| String.concat | ||
| "\n" | ||
| ([ horizontal_border ] | ||
| @ List.map make_row headers | ||
| @ [ horizontal_border ] | ||
| @ List.map make_row remainder | ||
| @ [ horizontal_border ]) | ||
| ;; | ||
|
|
||
| (** ----- Printing --------------------- *) | ||
|
|
||
| (** Prints a string to standard output. If ~use_color is true, then the string | ||
| is printed with the given styles. *) | ||
| let prout ~(use_color : bool) (styles : ANSI.style list) (string : string) : unit = | ||
| if use_color then ANSI.print_string styles string else print_string string | ||
| ;; | ||
|
|
||
| (** Prints a string to standard error. If ~use_color is true, then the string | ||
| is printed with the given styles. *) | ||
| let prerr ~(use_color : bool) (styles : ANSI.style list) (string : string) : unit = | ||
| if use_color then ANSI.prerr_string styles string else prerr_string string | ||
| ;; | ||
|
|
||
| (** Print a bold, underlined heading *) | ||
| let print_heading ~(use_color : bool) (heading : string) : unit = | ||
| let n = wcswidth heading in | ||
| prout ~use_color [ ANSI.Bold ] (heading ^ "\n"); | ||
| prout ~use_color [ ANSI.Bold ] (String.make n '-' ^ "\n") | ||
| ;; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.