rbs 2.8.4 → 3.8.1

data/core/trace_point.rbs

@@ -1,107 +1,121 @@
 # <!-- rdoc-file=trace_point.rb -->
-# Document-class: TracePoint
-#
-# A class that provides the functionality of Kernel#set_trace_func in a nice
-# Object-Oriented API.
+# A class that provides the functionality of Kernel#set_trace_func in a
+# well-structured Object-Oriented API.
 #
 # ## Example
 #
-# We can use TracePoint to gather information specifically for exceptions:
+# Use TracePoint to gather information specifically for exceptions:
 #
 #     trace = TracePoint.new(:raise) do |tp|
-#         p [tp.lineno, tp.event, tp.raised_exception]
+#       p [tp.lineno, tp.event, tp.raised_exception]
 #     end
 #     #=> #<TracePoint:disabled>
 #
-#     trace.enable
-#     #=> false
+#     trace.enable  #=> false
 #
 #     0 / 0
 #     #=> [5, :raise, #<ZeroDivisionError: divided by 0>]
 #
 # ## Events
 #
-# If you don't specify the type of events you want to listen for, TracePoint
+# If you don't specify the types of events you want to listen for, TracePoint
 # will include all available events.
 #
-# **Note** do not depend on current event set, as this list is subject to
-# change. Instead, it is recommended you specify the type of events you want to
+# **Note:** Do not depend on the current event set, as this list is subject to
+# change. Instead, it is recommended to specify the types of events you want to
 # use.
 #
 # To filter what is traced, you can pass any of the following as `events`:
 #
 # `:line`
-# :   execute an expression or statement on a new line
+# :   Execute an expression or statement on a new line.
+#
 # `:class`
-# :   start a class or module definition
+# :   Start a class or module definition.
+#
 # `:end`
-# :   finish a class or module definition
+# :   Finish a class or module definition.
+#
 # `:call`
-# :   call a Ruby method
+# :   Call a Ruby method.
+#
 # `:return`
-# :   return from a Ruby method
+# :   Return from a Ruby method.
+#
 # `:c_call`
-# :   call a C-language routine
+# :   Call a C-language routine.
+#
 # `:c_return`
-# :   return from a C-language routine
+# :   Return from a C-language routine.
+#
 # `:raise`
-# :   raise an exception
+# :   Raise an exception.
+#
+# `:rescue`
+# :   Rescue an exception.
+#
 # `:b_call`
-# :   event hook at block entry
+# :   Event hook at block entry.
+#
 # `:b_return`
-# :   event hook at block ending
+# :   Event hook at block ending.
+#
 # `:a_call`
-# :   event hook at all calls (`call`, `b_call`, and `c_call`)
+# :   Event hook at all calls (`call`, `b_call`, and `c_call`).
+#
 # `:a_return`
-# :   event hook at all returns (`return`, `b_return`, and `c_return`)
+# :   Event hook at all returns (`return`, `b_return`, and `c_return`).
+#
 # `:thread_begin`
-# :   event hook at thread beginning
+# :   Event hook at thread beginning.
+#
 # `:thread_end`
-# :   event hook at thread ending
+# :   Event hook at thread ending.
+#
 # `:fiber_switch`
-# :   event hook at fiber switch
+# :   Event hook at fiber switch.
+#
 # `:script_compiled`
-# :   new Ruby code compiled (with `eval`, `load` or `require`)
+# :   New Ruby code compiled (with `eval`, `load`, or `require`).
 #
-class TracePoint < Object
+class TracePoint
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - TracePoint.new(*events) { |obj| block }         -> obj
+  #   - TracePoint.new(*events) { |tp| block } -> tp
   # -->
   # Returns a new TracePoint object, not enabled by default.
   #
-  # Next, in order to activate the trace, you must use TracePoint#enable
+  # To activate the TracePoint object, use TracePoint#enable:
   #
   #     trace = TracePoint.new(:call) do |tp|
-  #         p [tp.lineno, tp.defined_class, tp.method_id, tp.event]
+  #       p [tp.lineno, tp.defined_class, tp.method_id, tp.event]
   #     end
   #     #=> #<TracePoint:disabled>
   #
-  #     trace.enable
-  #     #=> false
+  #     trace.enable  #=> false
   #
   #     puts "Hello, TracePoint!"
   #     # ...
   #     # [48, IRB::Notifier::AbstractNotifier, :printf, :call]
   #     # ...
   #
-  # When you want to deactivate the trace, you must use TracePoint#disable
+  # To deactivate the trace, use TracePoint#disable.
   #
   #     trace.disable
   #
   # See TracePoint@Events for possible events and more information.
   #
-  # A block must be given, otherwise an ArgumentError is raised.
+  # A block must be given; otherwise, an ArgumentError is raised.
   #
   # If the trace method isn't included in the given events filter, a RuntimeError
   # is raised.
   #
   #     TracePoint.trace(:line) do |tp|
-  #         p tp.raised_exception
+  #       p tp.raised_exception
   #     end
   #     #=> RuntimeError: 'raised_exception' not supported by this event
   #
-  # If the trace method is called outside block, a RuntimeError is raised.
+  # If the trace method is called outside a block, a RuntimeError is raised.
   #
   #     TracePoint.trace(:line) do |tp|
   #       $tp = tp
@@ -110,21 +124,68 @@ class TracePoint < Object
   #
   # Access from other threads is also forbidden.
   #
-  def initialize: (*Symbol events) { (TracePoint tp) -> void } -> void
+  def self.new: (*_ToSym events) { (instance tp) -> void } -> instance
 
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - TracePoint.allow_reentry
+  #   - TracePoint.allow_reentry { block }
   # -->
-  # In general, while a TracePoint callback is running, other registered callbacks
-  # are not called to avoid confusion by reentrance. This method allows the
-  # reentrance in a given block. This method should be used carefully, otherwise
-  # the callback can be easily called infinitely.
+  # Generally, while a TracePoint callback is running, other registered callbacks
+  # are not called to avoid confusion from reentrance. This method allows
+  # reentrance within a given block. Use this method carefully to avoid infinite
+  # callback invocation.
+  #
+  # If called when reentrance is already allowed, it raises a RuntimeError.
+  #
+  # **Example:**
+  #
+  #     # Without reentry
+  #     # ---------------
   #
-  # If this method is called when the reentrance is already allowed, it raises a
-  # RuntimeError.
+  #     line_handler = TracePoint.new(:line) do |tp|
+  #       next if tp.path != __FILE__ # Only works in this file
+  #       puts "Line handler"
+  #       binding.eval("class C; end")
+  #     end.enable
   #
-  def self.allow_reentry: () { () -> void } -> void
+  #     class_handler = TracePoint.new(:class) do |tp|
+  #       puts "Class handler"
+  #     end.enable
+  #
+  #     class B
+  #     end
+  #
+  #     # This script will print "Class handler" only once: when inside the :line
+  #     # handler, all other handlers are ignored.
+  #
+  #     # With reentry
+  #     # ------------
+  #
+  #     line_handler = TracePoint.new(:line) do |tp|
+  #       next if tp.path != __FILE__ # Only works in this file
+  #       next if (__LINE__..__LINE__+3).cover?(tp.lineno) # Prevent infinite calls
+  #       puts "Line handler"
+  #       TracePoint.allow_reentry { binding.eval("class C; end") }
+  #     end.enable
+  #
+  #     class_handler = TracePoint.new(:class) do |tp|
+  #       puts "Class handler"
+  #     end.enable
+  #
+  #     class B
+  #     end
+  #
+  #     # This will print "Class handler" twice: inside the allow_reentry block in the :line
+  #     # handler, other handlers are enabled.
+  #
+  # Note that the example shows the principal effect of the method, but its
+  # practical usage is for debugging libraries that sometimes require other
+  # libraries' hooks to not be affected by the debugger being inside trace point
+  # handling. Precautions should be taken against infinite recursion in this case
+  # (note that we needed to filter out calls by itself from the :line handler,
+  # otherwise it would call itself infinitely).
+  #
+  def self.allow_reentry: [T] () { (nil) -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -132,8 +193,8 @@ class TracePoint < Object
   # -->
   # Returns internal information of TracePoint.
   #
-  # The contents of the returned value are implementation specific. It may be
-  # changed in future.
+  # The contents of the returned value are implementation-specific and may change
+  # in the future.
   #
   # This method is only for debugging TracePoint itself.
   #
@@ -141,43 +202,42 @@ class TracePoint < Object
 
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - TracePoint.trace(*events) { |obj| block }        -> obj
+  #   - TracePoint.trace(*events) { |tp| block } -> obj
   # -->
-  # A convenience method for TracePoint.new, that activates the trace
+  # A convenience method for TracePoint.new that activates the trace
   # automatically.
   #
   #     trace = TracePoint.trace(:call) { |tp| [tp.lineno, tp.event] }
   #     #=> #<TracePoint:enabled>
   #
-  #     trace.enabled? #=> true
+  #     trace.enabled?  #=> true
   #
-  def self.trace: (*Symbol events) { (TracePoint tp) -> void } -> TracePoint
+  def self.trace: (*_ToSym events) { (instance tp) -> void } -> instance
 
   # <!--
   #   rdoc-file=trace_point.rb
   #   - binding()
   # -->
-  # Return the generated binding object from event.
+  # Returns the generated binding object from the event.
   #
-  # Note that for `c_call` and `c_return` events, the binding returned is the
-  # binding of the nearest Ruby method calling the C method, since C methods
-  # themselves do not have bindings.
+  # Note that for `:c_call` and `:c_return` events, the method returns `nil`,
+  # since C methods themselves do not have bindings.
   #
-  def binding: () -> Binding
+  def binding: () -> Binding?
 
   # <!--
   #   rdoc-file=trace_point.rb
   #   - callee_id()
   # -->
-  # Return the called name of the method being called
+  # Returns the called name of the method being called.
   #
-  def callee_id: () -> Symbol
+  def callee_id: () -> Symbol?
 
   # <!--
   #   rdoc-file=trace_point.rb
   #   - defined_class()
   # -->
-  # Return class or module of the method being called.
+  # Returns the class or module of the method being called.
   #
   #     class C; def foo; end; end
   #     trace = TracePoint.new(:call) do |tp|
@@ -186,20 +246,20 @@ class TracePoint < Object
   #       C.new.foo
   #     end
   #
-  # If method is defined by a module, then that module is returned.
+  # If the method is defined by a module, then that module is returned.
   #
   #     module M; def foo; end; end
-  #     class C; include M; end;
+  #     class C; include M; end
   #     trace = TracePoint.new(:call) do |tp|
   #       p tp.defined_class #=> M
   #     end.enable do
   #       C.new.foo
   #     end
   #
-  # **Note:** #defined_class returns singleton class.
+  # **Note:** #defined_class returns the singleton class.
   #
-  # 6th block parameter of Kernel#set_trace_func passes original class of attached
-  # by singleton class.
+  # The 6th block parameter of Kernel#set_trace_func passes the original class
+  # attached by the singleton class.
   #
   # **This is a difference between Kernel#set_trace_func and TracePoint.**
   #
@@ -210,35 +270,34 @@ class TracePoint < Object
   #       C.foo
   #     end
   #
-  def defined_class: () -> Module
+  def defined_class: () -> (Class | Module)?
 
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - trace.disable               -> true or false
+  #   - trace.disable -> true or false
   #   - trace.disable { block } -> obj
   # -->
-  # Deactivates the trace
+  # Deactivates the trace.
   #
-  # Return true if trace was enabled. Return false if trace was disabled.
+  # Returns `true` if the trace was enabled. Returns `false` if the trace was
+  # disabled.
   #
-  #     trace.enabled?      #=> true
-  #     trace.disable       #=> true (previous status)
-  #     trace.enabled?      #=> false
-  #     trace.disable       #=> false
+  #     trace.enabled?  #=> true
+  #     trace.disable   #=> true (previous status)
+  #     trace.enabled?  #=> false
+  #     trace.disable   #=> false
   #
-  # If a block is given, the trace will only be disable within the scope of the
+  # If a block is given, the trace will only be disabled within the scope of the
   # block.
   #
-  #     trace.enabled?
-  #     #=> true
+  #     trace.enabled?  #=> true
   #
   #     trace.disable do
-  #         trace.enabled?
-  #         # only disabled for this block
+  #       trace.enabled?
+  #       # Only disabled for this block
   #     end
   #
-  #     trace.enabled?
-  #     #=> true
+  #     trace.enabled?  #=> true
   #
   # Note: You cannot access event hooks within the block.
   #
@@ -246,16 +305,17 @@ class TracePoint < Object
   #     #=> RuntimeError: access from outside
   #
   def disable: () -> bool
-             | () { () -> void } -> void
+             | [T] () { () -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - trace.enable(target: nil, target_line: nil, target_thread: nil)    -> true or false
-  #   - trace.enable(target: nil, target_line: nil, target_thread: nil) { block }  -> obj
+  #   - trace.enable(target: nil, target_line: nil, target_thread: nil) -> true or false
+  #   - trace.enable(target: nil, target_line: nil, target_thread: :default) { block } -> obj
   # -->
   # Activates the trace.
   #
-  # Returns `true` if trace was enabled. Returns `false` if trace was disabled.
+  # Returns `true` if the trace was enabled. Returns `false` if the trace was
+  # disabled.
   #
   #     trace.enabled?  #=> false
   #     trace.enable    #=> false (previous state)
@@ -264,23 +324,22 @@ class TracePoint < Object
   #     trace.enable    #=> true (previous state)
   #                     #   trace is still enabled
   #
-  # If a block is given, the trace will only be enabled within the scope of the
-  # block.
+  # If a block is given, the trace will only be enabled during the block
+  # execution. If target and target_line are both nil, then target_thread will
+  # default to the current thread if a block is given.
   #
-  #     trace.enabled?
-  #     #=> false
+  #     trace.enabled?  #=> false
   #
   #     trace.enable do
   #       trace.enabled?
-  #       # only enabled for this block
+  #       # Only enabled for this block and thread
   #     end
   #
-  #     trace.enabled?
-  #     #=> false
+  #     trace.enabled?  #=> false
   #
-  # `target`, `target_line` and `target_thread` parameters are used to limit
-  # tracing only to specified code objects. `target` should be a code object for
-  # which RubyVM::InstructionSequence.of will return an instruction sequence.
+  # The `target`, `target_line`, and `target_thread` parameters are used to limit
+  # tracing to specified code objects. `target` should be a code object for which
+  # RubyVM::InstructionSequence.of will return an instruction sequence.
   #
   #     t = TracePoint.new(:line) { |tp| p tp }
   #
@@ -295,23 +354,23 @@ class TracePoint < Object
   #     t.enable(target: method(:m1))
   #
   #     m1
-  #     # prints #<TracePoint:line test.rb:4 in `m1'>
+  #     # Prints #<TracePoint:line test.rb:4 in `m1'>
   #     m2
-  #     # prints nothing
+  #     # Prints nothing
   #
   # Note: You cannot access event hooks within the `enable` block.
   #
   #     trace.enable { p tp.lineno }
   #     #=> RuntimeError: access from outside
   #
-  def enable:     (?target: (Method | UnboundMethod | Proc)?, ?target_line: Integer?, ?target_thread: Thread?) -> bool
-            | [R] (?target: (Method | UnboundMethod | Proc)?, ?target_line: Integer?, ?target_thread: Thread?) { () -> R } -> R
+  def enable: (?target: Method | UnboundMethod | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) -> bool
+            | [T] (?target: Method | UnboundMethod | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) { () -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - trace.enabled?          -> true or false
+  #   - trace.enabled? -> true or false
   # -->
-  # The current status of the trace
+  # Returns the current status of the trace.
   #
   def enabled?: () -> bool
 
@@ -319,7 +378,7 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - event()
   # -->
-  # Type of event
+  # Returns the type of event.
   #
   # See TracePoint@Events for more information.
   #
@@ -327,9 +386,9 @@ class TracePoint < Object
 
   # <!--
   #   rdoc-file=trace_point.rb
-  #   - trace.inspect  -> string
+  #   - trace.inspect -> string
   # -->
-  # Return a string containing a human-readable TracePoint status.
+  # Returns a string containing a human-readable TracePoint status.
   #
   def inspect: () -> String
 
@@ -337,7 +396,7 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - lineno()
   # -->
-  # Line number of the event
+  # Returns the line number of the event.
   #
   def lineno: () -> Integer
 
@@ -345,15 +404,15 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - method_id()
   # -->
-  # Return the name at the definition of the method being called
+  # Returns the name at the definition of the method being called.
   #
-  def method_id: () -> Symbol
+  def method_id: () -> Symbol?
 
   # <!--
   #   rdoc-file=trace_point.rb
   #   - path()
   # -->
-  # Path of the file being run
+  # Returns the path of the file being executed.
   #
   def path: () -> String
 
@@ -361,24 +420,25 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - parameters()
   # -->
-  # Return the parameters definition of the method or block that the current hook
-  # belongs to. Format is the same as for Method#parameters
+  # Returns the parameter definitions of the method or block that the current hook
+  # belongs to. The format is the same as for Method#parameters.
   #
-  def parameters: () -> ::Array[[ :req | :opt | :rest | :keyreq | :key | :keyrest | :block, Symbol ] | [ :rest | :keyrest ]]
+  def parameters: () -> Method::param_types?
 
   # <!--
   #   rdoc-file=trace_point.rb
   #   - raised_exception()
   # -->
-  # Value from exception raised on the `:raise` event
+  # Returns the exception raised on the `:raise` event or rescued on the `:rescue`
+  # event.
   #
-  def raised_exception: () -> untyped
+  def raised_exception: () -> Exception
 
   # <!--
   #   rdoc-file=trace_point.rb
   #   - return_value()
   # -->
-  # Return value from `:return`, `c_return`, and `b_return` event
+  # Returns the return value from `:return`, `:c_return`, and `:b_return` events.
   #
   def return_value: () -> untyped
 
@@ -386,10 +446,10 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - self()
   # -->
-  # Return the trace object during event
+  # Returns the trace object during the event.
   #
-  # Same as the following, except it returns the correct object (the method
-  # receiver) for `c_call` and `c_return` events:
+  # Similar to the following, but it returns the correct object (the method
+  # receiver) for `:c_call` and `:c_return` events:
   #
   #     trace.binding.eval('self')
   #
@@ -399,8 +459,8 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - eval_script()
   # -->
-  # Compiled source code (String) on *eval methods on the `:script_compiled`
-  # event. If loaded from a file, it will return nil.
+  # Returns the compiled source code (String) from eval methods on the
+  # `:script_compiled` event. If loaded from a file, it returns `nil`.
   #
   def eval_script: () -> String?
 
@@ -408,10 +468,10 @@ class TracePoint < Object
   #   rdoc-file=trace_point.rb
   #   - instruction_sequence()
   # -->
-  # Compiled instruction sequence represented by a RubyVM::InstructionSequence
-  # instance on the `:script_compiled` event.
+  # Returns the compiled instruction sequence represented by a
+  # RubyVM::InstructionSequence instance on the `:script_compiled` event.
   #
-  # Note that this method is MRI specific.
+  # Note that this method is CRuby-specific.
   #
   def instruction_sequence: () -> RubyVM::InstructionSequence
 end