1:- module(onepointfour_basics_dict_pp,
    2          [
    3           dict_pp/1    % dict_pp(+Dict)
    4          ,dict_pp/2    % dict_pp(+Dict,+SettingsDict)
    5          ,dict_pp/3    % dict_pp(+Dict,+SettingsDict,-Lines)
    6          ]).    7
    8:- use_module(library('onepointfour_basics/checks.pl')).    9:- use_module(library('onepointfour_basics/dict_pp/topmost.pl')).   10
   11:- use_module(library(apply)).           % meta-call predicates (slow)
   12:- use_module(library(apply_macros)).    % rewrite to avoid meta-calling (transforms the above into fast code)

?- dict_pp(_{a:1,b:2},_{},Lines).
Lines = ["a : 1","b : 2"].
true.

?- dict_pp(_{a:"hello world",b:"foo bar baz"},_{},Lines).
Lines = ["a : hello world","b : foo bar baz"].
true.

?- dict_pp(_{w: 0.25984759, ww: 1.4587598, www: 643764856, wwww: 400},
           _{justify_key:right,spec_float:f}).
   w : 0.259848
  ww : 1.458760
 www : 643764856
wwww : 400
true.

?- dict_pp(various{w: 0.25984759, ww: 1.4587598, www: 643764856, wwww: 400},
           _{justify_key:right,justify_value:right,spec_float:e}).
    various
   w : 2.598476e-01
  ww : 1.458760e+00
 www :    643764856
wwww :          400
true.

?- dict_pp(various{w: 0.25984759, ww: 1.4587598, www: 643764856, wwww: 400},
           _{border:true}).
+----------------+
|    various     |
+----------------+
|w    : 0.259848 |
|ww   : 1.458760 |
|www  : 643764856|
|wwww : 400      |
+----------------+
true.

?- dict_pp(various{w: 0.25984759, ww: 1.4587598, www: 643764856, wwww: 400},
           _{pad_left:5,pad_right:4,pad:true}).
         various
     w    : 0.259848
     ww   : 1.458760
     www  : 643764856
     wwww : 400
true.

?- dict_pp(various{w: 0.25984759, ww: 1.4587598, www: 643764856, wwww: 400},
           _{pad:true,pad_left:2,pad_top:1,pad_bottom:1,pad_right:2,
             border:true,justify_tag:left,justify_tag_full:false}).
+--------------------+
|  various           |
+--------------------+
|                    |
|  w    : 0.259848   |
|  ww   : 1.458760   |
|  www  : 643764856  |
|  wwww : 400        |
|                    |
+--------------------+
true.

?- dict_pp(alpha{w1: 10, w2: 200, w3: 3000,
                   w4: bravo{w1: 10, w2: 20,
                      w3: charlie{ a: 12, b: 13}}},
           _{border:true}).
+---------------------+
|        alpha        |
+---------------------+
|w1 : 10              |
|w2 : 200             |
|w3 : 3000            |
|w4 : +--------------+|
|     |    bravo     ||
|     +--------------+|
|     |w1 : 10       ||
|     |w2 : 20       ||
|     |w3 : +-------+||
|     |     |charlie|||
|     |     +-------+||
|     |     |a : 12 |||
|     |     |b : 13 |||
|     |     +-------+||
|     +--------------+|
+---------------------+
true.

?- dict_pp(alpha{w1: 10, w2: 200, w3: 3000,
                   w4: bravo{w1: 10, w2: 20,
                      w3: charlie{ a: 12, b: 13}}},
           _{border:true,tag:false}).
+--------------------+
|w1 : 10             |
|w2 : 200            |
|w3 : 3000           |
|w4 : +-------------+|
|     |w1 : 10      ||
|     |w2 : 20      ||
|     |w3 : +------+||
|     |     |a : 12|||
|     |     |b : 13|||
|     |     +------+||
|     +-------------+|
+--------------------+
true.

?- dict_pp(alpha{w1: 10, w2: 200, w3: 3000,
                   w4: bravo{w1: 10, w2: 20,
                      w3: charlie{ a: 12, b: 13}}},
           _{border:false,tag:true}).
      alpha
w1 : 10
w2 : 200
w3 : 3000
w4 :    bravo
     w1 : 10
     w2 : 20
     w3 : charlie
          a : 12
          b : 13

 dict_pp(+Dict:dict)

Prettyprint Dict directly using format/2, writing to the stream given by current_output. An empty Dict does not lead to failure but to no output.

Wrap this goal with with_output_to/2 to redirect the output to a stream of your choice.

Behaves as dict_pp/3 called with default settings, followed by immediate printing of the resulting Lines.

See also

- dict_pp/3

  206dict_pp(Dict) :-
  207   dict_pp(Dict,_{}).

 dict_pp(+Dict:dict, +SettingsDict:dict)

Prettyprint Dict directly using format/2, writing to the stream given by current_output. An empty Dict does not lead to failure but to no output.

Instructions on how to format the output can be given by SettingsDict. The tag of that dict is arbitrary. Default settings are requested by giving an empty dict here.

Wrap this goal with with_output_to/2 to redirect the output to a stream of your choice.

Behaves as dict_pp/3, followed by immediate printing of the resulting lines.

See also

- dict_pp/3

  225dict_pp(Dict,SettingsDict) :-
  226   dict_pp(Dict,SettingsDict,LinesOut),
  227   maplist([Line]>>format("~s~n",[Line]),LinesOut). % All the lines are strings.

 dict_pp(+Dict:dict, +SettingsDict:dict, -LinesOut:list(string))

Prettyprint Dict by generating strings that are accumulated into the list LinesOut, maybe for later emission to an output stream. The lines do not have a newline at their end. An empty Dict does not lead to failure but to an empty list (or a nonempty list, depending on SettingsDict).

Instructions on how to format the output can be given by SettingsDict. The tag of that dict is arbitrary. Default settings are requested by giving an empty dict here.

The following settings are understood. Anything not recognized is disregarded, if a setting is missing when it is needed, the default value is assumed.

key	value	default	explainer
border	true, false	false	Decorate outermost dict with an ASCII border.
sub_border	true, false, inherit	inherit	Whether to decorate subdicts with an ASCII border, too.
tag	true, false	true	Print the tag of the outermost dict. If the tag is an unbound variable, it is never printed.
sub_tag	true, false, inherit	inherit	Whether to display the tags of subdicts, too.
justify_key	left, right, center	left	How to justify the keys inside the key column.
justify_value	left, right, center	left	How to justify the values inside the values column.
justify_tag	left, right, center	center	How to justify the tag inside the tag line. f stands for "full".
justify_tag_full	true, false	true	Left and right padding is considered as being part of the tag field.
spec_float	see format/2	f	A format/2 specifier used for floats. Passed to format/3 "as is".
spec_int	see format/2	d	A format/2 specifier used for integers. Passed to format/3 "as is".
depth_limit	int >= 0	10	"subdict depth" at which prettyprinting switches to a "one-liner". 0 means even the root dict is printed as a oneliner.
pad	true, false	false	Switch on padding according to pad_left etc. Note that if pad is true (and border is false), and none of the pad_X values has been given, then the output is a rectangle filled to rectangle-ness with whitespace.
sub_pad	true, false, inherit	inherit	Whether to pad subdicts with whitespace, too.
pad_left	int >= 0	0	Pad with whitespace on the left depending on pad and sub_pad (inside the ASCII border if any).
pad_right	int >= 0	0	As above, on the right.
pad_top	int >= 0	0	As above, on top (underneath the tag, if any).
pad_bottom	int >= 0	0	As above, on the bottom.

  269dict_pp(Dict,SettingsDict,LinesOut) :-
  270   assertion(check_that(LinesOut,break(var),hard(list))),      % Maybe Lines is a given; that would be extraordinary
  271   assertion(check_that(Dict,hard(dict))),
  272   assertion(check_that(SettingsDict,hard(dict))),
  273   put_dict(depth,SettingsDict,0,SettingsDict2),               % Start tracking depth of recursion via 'depth' entry in SettingsDict
  274   pp_if_shallow_enough(Dict,SettingsDict2,LinesOut),
  275   assertion(check_that(LinesOut,hard(proper_list),hard(passall(string))))