Module: PP::PPMethods
- Included in:
- PP, SingleLine
- Defined in:
- lib/pp.rb
Constant Summary collapse
- PointerMask =
(1 << ([""].pack("p").size * 8)) - 1
Instance Method Summary collapse
- #check_inspect_key(id) ⇒ Object
-
#comma_breakable ⇒ Object
A convenience method which is same as follows:.
- #guard_inspect_key ⇒ Object
- #object_address_group(obj, &block) ⇒ Object
-
#object_group(obj, &block) ⇒ Object
A convenience method which is same as follows:.
- #pop_inspect_key(id) ⇒ Object
-
#pp(obj) ⇒ Object
Adds
obj
to the pretty printing buffer using Object#pretty_print or Object#pretty_print_cycle. - #pp_hash(obj) ⇒ Object
- #pp_object(obj) ⇒ Object
- #push_inspect_key(id) ⇒ Object
-
#seplist(list, sep = nil, iter_method = :each) ⇒ Object
Adds a separated list.
Instance Method Details
#check_inspect_key(id) ⇒ Object
128 129 130 131 132 |
# File 'lib/pp.rb', line 128 def check_inspect_key(id) Thread.current[:__recursive_key__] && Thread.current[:__recursive_key__][:inspect] && Thread.current[:__recursive_key__][:inspect].include?(id) end |
#comma_breakable ⇒ Object
A convenience method which is same as follows:
text ','
breakable
186 187 188 189 |
# File 'lib/pp.rb', line 186 def comma_breakable text ',' breakable end |
#guard_inspect_key ⇒ Object
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/pp.rb', line 109 def guard_inspect_key if Thread.current[:__recursive_key__] == nil Thread.current[:__recursive_key__] = {}.untrust end if Thread.current[:__recursive_key__][:inspect] == nil Thread.current[:__recursive_key__][:inspect] = {}.untrust end save = Thread.current[:__recursive_key__][:inspect] begin Thread.current[:__recursive_key__][:inspect] = {}.untrust yield ensure Thread.current[:__recursive_key__][:inspect] = save end end |
#object_address_group(obj, &block) ⇒ Object
177 178 179 180 |
# File 'lib/pp.rb', line 177 def object_address_group(obj, &block) id = PointerFormat % (obj.object_id * 2 & PointerMask) group(1, "\#<#{obj.class}:0x#{id}", '>', &block) end |
#object_group(obj, &block) ⇒ Object
A convenience method which is same as follows:
group(1, '#<' + obj.class.name, '>') { ... }
164 165 166 |
# File 'lib/pp.rb', line 164 def object_group(obj, &block) # :yield: group(1, '#<' + obj.class.name, '>', &block) end |
#pop_inspect_key(id) ⇒ Object
136 137 138 |
# File 'lib/pp.rb', line 136 def pop_inspect_key(id) Thread.current[:__recursive_key__][:inspect].delete id end |
#pp(obj) ⇒ Object
Adds obj
to the pretty printing buffer using Object#pretty_print or Object#pretty_print_cycle.
Object#pretty_print_cycle is used when obj
is already printed, a.k.a the object reference chain has a cycle.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/pp.rb', line 145 def pp(obj) id = obj.object_id if check_inspect_key(id) group {obj.pretty_print_cycle self} return end begin push_inspect_key(id) group {obj.pretty_print self} ensure pop_inspect_key(id) unless PP.sharing_detection end end |
#pp_hash(obj) ⇒ Object
243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/pp.rb', line 243 def pp_hash(obj) group(1, '{', '}') { seplist(obj, nil, :each_pair) {|k, v| group { pp k text '=>' group(1) { breakable '' pp v } } } } end |
#pp_object(obj) ⇒ Object
228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/pp.rb', line 228 def pp_object(obj) object_address_group(obj) { seplist(obj.pretty_print_instance_variables, lambda { text ',' }) {|v| breakable v = v.to_s if Symbol === v text v text '=' group(1) { breakable '' pp(obj.instance_eval(v)) } } } end |
#push_inspect_key(id) ⇒ Object
133 134 135 |
# File 'lib/pp.rb', line 133 def push_inspect_key(id) Thread.current[:__recursive_key__][:inspect][id] = true end |
#seplist(list, sep = nil, iter_method = :each) ⇒ Object
Adds a separated list. The list is separated by comma with breakable space, by default.
#seplist iterates the list
using iter_method
. It yields each object to the block given for #seplist. The procedure separator_proc
is called between each yields.
If the iteration is zero times, separator_proc
is not called at all.
If separator_proc
is nil or not given, lambda { comma_breakable } is used. If iter_method
is not given, :each is used.
For example, following 3 code fragments has similar effect.
q.seplist([1,2,3]) {|v| xxx v }
q.seplist([1,2,3], lambda { q.comma_breakable }, :each) {|v| xxx v }
xxx 1
q.comma_breakable
xxx 2
q.comma_breakable
xxx 3
215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/pp.rb', line 215 def seplist(list, sep=nil, iter_method=:each) # :yield: element sep ||= lambda { comma_breakable } first = true list.__send__(iter_method) {|*v| if first first = false else sep.call end yield(*v) } end |