namespace pretty

--****

-- == Pretty Printing

--

-- <>

--

-- pretty print variables

integer pretty_end_col, pretty_chars, pretty_start_col, pretty_level,

pretty_file, pretty_ascii, pretty_indent, pretty_ascii_min,

pretty_ascii_max, pretty_line_count, pretty_line_max, pretty_dots,

pretty_line_breaks, pretty_printing

sequence pretty_fp_format, pretty_int_format, pretty_line

-- Output text, keeping track of line length.

-- Buffering lines speeds up Windows console output.

end if

else

end if

-- check for time to do line break

end if

end if

-- indent the display of a sequence

else

end if

pretty_level * pretty_indent))

end if

-- show escaped characters

case'\t' then

case'\n' then

case'\r' then

case'\\' then

case'"' then

case else

end switch

end function

-- recursively print a Euphoria object

sequence sbuff

integer multi_line, all_ascii

-- replace number with display character?

end if

else -- pretty ascii 1 or 2

-- add display character to number?

end if

end if

end if

else

end if

else

-- sequence

end if

(a[i] < pretty_ascii_min and

(pretty_ascii < 2 or not find(a[i], "\t\r\n\\"))) or

a[i] > pretty_ascii_max then

end if

else

end if

end if

else

end if

end if

end if

end if

end if

else

end if

end if

elsedef

public constant PRETTY_DEFAULT = {1, 2, 1, 78, "%d", "%.10g", 32, 127, 1000000000, 1}

end ifdef

public enum

--****

-- === Routines

end if

-- set options

--**

-- Print an object to a file or device, using braces { , , , }, indentation, and multiple lines

-- to show the structure.

--

-- Parameters:

-- # ##fn## : an integer, the file/device number to write to

-- # ##x## : the object to display/convert to printable form

-- # ##options## : is an (up to) 10-element options sequence.

--

-- Comments:

--

-- Pass {} in ##options## to select the defaults, or set options as below:

-- # display ASCII characters:

-- ** 0 ~-- never

-- ** 1 ~-- alongside any integers in printable ASCII range (default)

-- ** 2 ~-- display as "string" when all integers of a sequence

-- are in ASCII range

-- ** 3 ~-- show strings, and quoted characters (only) for any integers

-- in ASCII range as well as the characters: \t \r \n

-- # amount to indent for each level of sequence nesting ~-- default: 2

-- # column we are starting at ~-- default: 1

-- # approximate column to wrap at ~-- default: 78

-- # format to use for integers ~-- default: "%d"

-- # format to use for floating-point numbers ~-- default: "%.10g"

-- # minimum value for printable ASCII ~-- default 32

-- # maximum value for printable ASCII ~-- default 127

-- # maximum number of lines to output

-- # line breaks between elements ~-- default 1 (0 = no line breaks, -1 = line breaks to wrap only)

--

-- If the length is less than 10, unspecified options at

-- the end of the sequence will keep the default values.

-- e.g. {0, 5} will choose "never display ASCII",

-- plus 5-character indentation, with defaults for everything else.

--

-- The default options can be applied using the public constant ##PRETTY_DEFAULT##, and the

-- elements may be accessed using the following public enum~:

--

-- # ##DISPLAY_ASCII##

-- # ##INDENT##

-- # ##START_COLUMN##

-- # ##WRAP##

-- # ##INT_FORMAT##

-- # ##FP_FORMAT##

-- # ##MIN_ASCII##

-- # ##MAX_ASCII##

-- # ##MAX_LINES##

-- # ##LINE_BREAKS##

--

-- The display will start at the current cursor position. Normally you will want to call

-- ##pretty_print##() when the cursor is in column 1 (after printing a \n character).

-- If you want to start in a different column, you should call ##position##() and specify a value

-- for option [3]. This will ensure that the first and last braces in a sequence line up

-- vertically.

--

-- When specifying the format to use for integers and floating-point numbers, you can add

-- some decoration, e.g. "(%d)" or "$ %.2f"

--

-- Example 1:

--

-- pretty_print(1, "ABC", {})

--

-- {65'A',66'B',67'C'}

--

--

-- Example 2:

--

-- pretty_print(1, {{1,2,3}, {4,5,6}}, {})

--

-- {

-- {1,2,3},

-- {4,5,6}

-- }

--

--

-- Example 3:

--

-- pretty_print(1, {"Euphoria", "Programming", "Language"}, {2})

--

-- {

-- "Euphoria",

-- "Programming",

-- "Language"

-- }

--

--

-- Example 4:

--

-- puts(1, "word_list = ") -- moves cursor to column 13

-- pretty_print(1,

-- {{"Euphoria", 8, 5.3},

-- {"Programming", 11, -2.9},

-- {"Language", 8, 9.8}},

-- {2, 4, 13, 78, "%03d", "%.3f"}) -- first 6 of 8 options

--

-- word_list = {

-- {

-- "Euphoria",

-- 008,

-- 5.300

-- },

-- {

-- "Programming",

-- 011,

-- -2.900

-- },

-- {

-- "Language",

-- 008,

-- 9.800

-- }

-- }

--

--

-- See Also:

-- [[:print]], [[:sprint]], [[:printf]], [[:sprintf]], [[:pretty_sprint]]

--

--**

-- Format an object using braces { , , , }, indentation, and multiple lines to show the structure.

--

-- Parameters:

-- # ##x## : the object to display

-- # ##options## : is an (up to) 10-element options sequence: Pass {} to select the defaults, or

-- set options

--

-- Returns:

-- A **sequence**, of printable characters, representing ##x## in an human-readable form.

--

-- Comments:

--

-- This function formats objects the same as [[:pretty_print]](), but returns the sequence obtained instead of sending it to some file..

--

-- See Also:

-- [[:pretty_print]], [[:sprint]]

end function