diff options
Diffstat (limited to 'lib/pp.rb')
-rw-r--r-- | lib/pp.rb | 135 |
1 files changed, 92 insertions, 43 deletions
@@ -46,6 +46,7 @@ require 'prettyprint' # # To define a customized pretty printing function for your classes, # redefine method <code>#pretty_print(pp)</code> in the class. +# Note that <code>require 'pp'</code> is needed before redefining <code>#pretty_print(pp)</code>. # # <code>#pretty_print</code> takes the +pp+ argument, which is an instance of the PP class. # The method uses #text, #breakable, #nest, #group and #pp to print the @@ -61,15 +62,38 @@ require 'prettyprint' # Tanaka Akira <akr@fsij.org> class PP < PrettyPrint + + VERSION = "0.5.0" + + # Returns the usable width for +out+. + # As the width of +out+: + # 1. If +out+ is assigned to a tty device, its width is used. + # 2. Otherwise, or it could not get the value, the +COLUMN+ + # environment variable is assumed to be set to the width. + # 3. If +COLUMN+ is not set to a non-zero number, 80 is assumed. + # + # And finally, returns the above width value - 1. + # * This -1 is for Windows command prompt, which moves the cursor to + # the next line if it reaches the last column. + def PP.width_for(out) + begin + require 'io/console' + _, width = out.winsize + rescue LoadError, NoMethodError, SystemCallError + end + (width || ENV['COLUMNS']&.to_i&.nonzero? || 80) - 1 + end + # Outputs +obj+ to +out+ in pretty printed format of # +width+ columns in width. # # If +out+ is omitted, <code>$></code> is assumed. - # If +width+ is omitted, 79 is assumed. + # If +width+ is omitted, the width of +out+ is assumed (see + # width_for). # # PP.pp returns +out+. - def PP.pp(obj, out=$>, width=79) - q = PP.new(out, width) + def PP.pp(obj, out=$>, width=width_for(out)) + q = new(out, width) q.guard_inspect_key {q.pp obj} q.flush #$pp = q @@ -262,16 +286,21 @@ class PP < PrettyPrint group(1, '{', '}') { seplist(obj, nil, :each_pair) {|k, v| group { - pp k - text '=>' - group(1) { - breakable '' - pp v - } + pp_hash_pair k, v } } } end + + # A pretty print for a pair of Hash + def pp_hash_pair(k, v) + pp k + text '=>' + group(1) { + breakable '' + pp v + } + end end include PPMethods @@ -396,9 +425,31 @@ class Struct # :nodoc: end end +class Data # :nodoc: + def pretty_print(q) # :nodoc: + class_name = PP.mcall(self, Kernel, :class).name + class_name = " #{class_name}" if class_name + q.group(1, "#<data#{class_name}", '>') { + q.seplist(PP.mcall(self, Kernel, :class).members, lambda { q.text "," }) {|member| + q.breakable + q.text member.to_s + q.text '=' + q.group(1) { + q.breakable '' + q.pp public_send(member) + } + } + } + end + + def pretty_print_cycle(q) # :nodoc: + q.text sprintf("#<data %s:...>", PP.mcall(self, Kernel, :class).name) + end +end if defined?(Data.define) + class Range # :nodoc: def pretty_print(q) # :nodoc: - q.pp self.begin + q.pp self.begin if self.begin q.breakable '' q.text(self.exclude_end? ? '...' : '..') q.breakable '' @@ -424,7 +475,7 @@ end class File < IO # :nodoc: class Stat # :nodoc: def pretty_print(q) # :nodoc: - require 'etc.so' + require 'etc' q.object_group(self) { q.breakable q.text sprintf("dev=0x%x", self.dev); q.comma_breakable @@ -530,37 +581,39 @@ class MatchData # :nodoc: end end -class RubyVM::AbstractSyntaxTree::Node - def pretty_print_children(q, names = []) - children.zip(names) do |c, n| - if n - q.breakable - q.text "#{n}:" - end - q.group(2) do - q.breakable - q.pp c +if defined?(RubyVM::AbstractSyntaxTree) + class RubyVM::AbstractSyntaxTree::Node + def pretty_print_children(q, names = []) + children.zip(names) do |c, n| + if n + q.breakable + q.text "#{n}:" + end + q.group(2) do + q.breakable + q.pp c + end end end - end - def pretty_print(q) - q.group(1, "(#{type}@#{first_lineno}:#{first_column}-#{last_lineno}:#{last_column}", ")") { - case type - when :SCOPE - pretty_print_children(q, %w"tbl args body") - when :ARGS - pretty_print_children(q, %w[pre_num pre_init opt first_post post_num post_init rest kw kwrest block]) - when :DEFN - pretty_print_children(q, %w[mid body]) - when :ARYPTN - pretty_print_children(q, %w[const pre rest post]) - when :HSHPTN - pretty_print_children(q, %w[const kw kwrest]) - else - pretty_print_children(q) - end - } + def pretty_print(q) + q.group(1, "(#{type}@#{first_lineno}:#{first_column}-#{last_lineno}:#{last_column}", ")") { + case type + when :SCOPE + pretty_print_children(q, %w"tbl args body") + when :ARGS + pretty_print_children(q, %w[pre_num pre_init opt first_post post_num post_init rest kw kwrest block]) + when :DEFN + pretty_print_children(q, %w[mid body]) + when :ARYPTN + pretty_print_children(q, %w[const pre rest post]) + when :HSHPTN + pretty_print_children(q, %w[const kw kwrest]) + else + pretty_print_children(q) + end + } + end end end @@ -587,10 +640,6 @@ end module Kernel # Returns a pretty printed object as a string. # - # In order to use this method you must first require the PP module: - # - # require 'pp' - # # See the PP module for more information. def pretty_inspect PP.pp(self, ''.dup) |