rbs-relaxed 3.9.0.1

data/core/trace_point.rbs

@@ -0,0 +1,477 @@
+# <!-- rdoc-file=trace_point.rb -->
+# A class that provides the functionality of Kernel#set_trace_func in a
+# well-structured Object-Oriented API.
+#
+# ## Example
+#
+# Use TracePoint to gather information specifically for exceptions:
+#
+#     trace = TracePoint.new(:raise) do |tp|
+#       p [tp.lineno, tp.event, tp.raised_exception]
+#     end
+#     #=> #<TracePoint:disabled>
+#
+#     trace.enable  #=> false
+#
+#     0 / 0
+#     #=> [5, :raise, #<ZeroDivisionError: divided by 0>]
+#
+# ## Events
+#
+# 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 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.
+#
+# `:class`
+# :   Start a class or module definition.
+#
+# `:end`
+# :   Finish a class or module definition.
+#
+# `:call`
+# :   Call a Ruby method.
+#
+# `:return`
+# :   Return from a Ruby method.
+#
+# `:c_call`
+# :   Call a C-language routine.
+#
+# `:c_return`
+# :   Return from a C-language routine.
+#
+# `:raise`
+# :   Raise an exception.
+#
+# `:rescue`
+# :   Rescue an exception.
+#
+# `:b_call`
+# :   Event hook at block entry.
+#
+# `:b_return`
+# :   Event hook at block ending.
+#
+# `:a_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`).
+#
+# `:thread_begin`
+# :   Event hook at thread beginning.
+#
+# `:thread_end`
+# :   Event hook at thread ending.
+#
+# `:fiber_switch`
+# :   Event hook at fiber switch.
+#
+# `:script_compiled`
+# :   New Ruby code compiled (with `eval`, `load`, or `require`).
+#
+class TracePoint
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - TracePoint.new(*events) { |tp| block } -> tp
+  # -->
+  # Returns a new TracePoint object, not enabled by default.
+  #
+  # 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]
+  #     end
+  #     #=> #<TracePoint:disabled>
+  #
+  #     trace.enable  #=> false
+  #
+  #     puts "Hello, TracePoint!"
+  #     # ...
+  #     # [48, IRB::Notifier::AbstractNotifier, :printf, :call]
+  #     # ...
+  #
+  # 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.
+  #
+  # 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
+  #     end
+  #     #=> RuntimeError: 'raised_exception' not supported by this event
+  #
+  # If the trace method is called outside a block, a RuntimeError is raised.
+  #
+  #     TracePoint.trace(:line) do |tp|
+  #       $tp = tp
+  #     end
+  #     $tp.lineno #=> access from outside (RuntimeError)
+  #
+  # Access from other threads is also forbidden.
+  #
+  def self.new: (*_ToSym events) { (instance tp) -> void } -> instance
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - TracePoint.allow_reentry { block }
+  # -->
+  # 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
+  #     # ---------------
+  #
+  #     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
+  #
+  #     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
+  #   - TracePoint.stat -> obj
+  # -->
+  # Returns internal information of TracePoint.
+  #
+  # The contents of the returned value are implementation-specific and may change
+  # in the future.
+  #
+  # This method is only for debugging TracePoint itself.
+  #
+  def self.stat: () -> untyped
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - TracePoint.trace(*events) { |tp| block } -> obj
+  # -->
+  # 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
+  #
+  def self.trace: (*_ToSym events) { (instance tp) -> void } -> instance
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - binding()
+  # -->
+  # Returns the generated binding object from the event.
+  #
+  # Note that for `:c_call` and `:c_return` events, the method returns `nil`,
+  # since C methods themselves do not have bindings.
+  #
+  def binding: () -> Binding?
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - callee_id()
+  # -->
+  # Returns the called name of the method being called.
+  #
+  def callee_id: () -> Symbol?
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - defined_class()
+  # -->
+  # Returns the class or module of the method being called.
+  #
+  #     class C; def foo; end; end
+  #     trace = TracePoint.new(:call) do |tp|
+  #       p tp.defined_class #=> C
+  #     end.enable do
+  #       C.new.foo
+  #     end
+  #
+  # If the method is defined by a module, then that module is returned.
+  #
+  #     module M; def foo; end; 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 the 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.**
+  #
+  #     class C; def self.foo; end; end
+  #     trace = TracePoint.new(:call) do |tp|
+  #       p tp.defined_class #=> #<Class:C>
+  #     end.enable do
+  #       C.foo
+  #     end
+  #
+  def defined_class: () -> (Class | Module)?
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - trace.disable -> true or false
+  #   - trace.disable { block } -> obj
+  # -->
+  # Deactivates the trace.
+  #
+  # 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
+  #
+  # If a block is given, the trace will only be disabled within the scope of the
+  # block.
+  #
+  #     trace.enabled?  #=> true
+  #
+  #     trace.disable do
+  #       trace.enabled?
+  #       # Only disabled for this block
+  #     end
+  #
+  #     trace.enabled?  #=> true
+  #
+  # Note: You cannot access event hooks within the block.
+  #
+  #     trace.disable { p tp.lineno }
+  #     #=> RuntimeError: access from outside
+  #
+  def disable: () -> bool
+             | [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: :default) { block } -> obj
+  # -->
+  # Activates the trace.
+  #
+  # Returns `true` if the trace was enabled. Returns `false` if the trace was
+  # disabled.
+  #
+  #     trace.enabled?  #=> false
+  #     trace.enable    #=> false (previous state)
+  #                     #   trace is enabled
+  #     trace.enabled?  #=> true
+  #     trace.enable    #=> true (previous state)
+  #                     #   trace is still enabled
+  #
+  # 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.enable do
+  #       trace.enabled?
+  #       # Only enabled for this block and thread
+  #     end
+  #
+  #     trace.enabled?  #=> false
+  #
+  # 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 }
+  #
+  #     def m1
+  #       p 1
+  #     end
+  #
+  #     def m2
+  #       p 2
+  #     end
+  #
+  #     t.enable(target: method(:m1))
+  #
+  #     m1
+  #     # Prints #<TracePoint:line test.rb:4 in `m1'>
+  #     m2
+  #     # 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 | 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
+  # -->
+  # Returns the current status of the trace.
+  #
+  def enabled?: () -> bool
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - event()
+  # -->
+  # Returns the type of event.
+  #
+  # See TracePoint@Events for more information.
+  #
+  def event: () -> ::Symbol
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - trace.inspect -> string
+  # -->
+  # Returns a string containing a human-readable TracePoint status.
+  #
+  def inspect: () -> String
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - lineno()
+  # -->
+  # Returns the line number of the event.
+  #
+  def lineno: () -> Integer
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - method_id()
+  # -->
+  # Returns the name at the definition of the method being called.
+  #
+  def method_id: () -> Symbol?
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - path()
+  # -->
+  # Returns the path of the file being executed.
+  #
+  def path: () -> String
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - 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: () -> Method::param_types?
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - raised_exception()
+  # -->
+  # Returns the exception raised on the `:raise` event or rescued on the `:rescue`
+  # event.
+  #
+  def raised_exception: () -> Exception
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - return_value()
+  # -->
+  # Returns the return value from `:return`, `:c_return`, and `:b_return` events.
+  #
+  def return_value: () -> untyped
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - self()
+  # -->
+  # Returns the trace object during the event.
+  #
+  # Similar to the following, but it returns the correct object (the method
+  # receiver) for `:c_call` and `:c_return` events:
+  #
+  #     trace.binding.eval('self')
+  #
+  def self: () -> untyped
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - eval_script()
+  # -->
+  # 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?
+
+  # <!--
+  #   rdoc-file=trace_point.rb
+  #   - instruction_sequence()
+  # -->
+  # Returns the compiled instruction sequence represented by a
+  # RubyVM::InstructionSequence instance on the `:script_compiled` event.
+  #
+  # Note that this method is CRuby-specific.
+  #
+  def instruction_sequence: () -> RubyVM::InstructionSequence
+end

data/core/true_class.rbs

@@ -0,0 +1,98 @@
+# <!-- rdoc-file=object.c -->
+# The class of the singleton object `true`.
+#
+# Several of its methods act as operators:
+#
+# *   #&
+# *   #|
+# *   #===
+# *   #^
+#
+# One other method:
+#
+# *   #to_s and its alias #inspect.
+#
+class TrueClass
+  def !: () -> false
+
+  # <!--
+  #   rdoc-file=object.c
+  #   - true & object -> true or false
+  # -->
+  # Returns `false` if `object` is `false` or `nil`, `true` otherwise:
+  #
+  # true & Object.new # => true true & false      # => false true & nil        #
+  # => false
+  #
+  def &: (false | nil) -> false
+       | (untyped obj) -> bool
+
+  # <!--
+  #   rdoc-file=object.c
+  #   - true === other -> true or false
+  #   - false === other -> true or false
+  #   - nil === other -> true or false
+  # -->
+  # Returns `true` or `false`.
+  #
+  # Like Object#==, if `object` is an instance of Object (and not an instance of
+  # one of its many subclasses).
+  #
+  # This method is commonly overridden by those subclasses, to provide meaningful
+  # semantics in `case` statements.
+  #
+  def ===: (true) -> true
+         | (untyped obj) -> bool
+
+  # <!--
+  #   rdoc-file=object.c
+  #   - true ^ object -> !object
+  # -->
+  # Returns `true` if `object` is `false` or `nil`, `false` otherwise:
+  #
+  #     true ^ Object.new # => false
+  #     true ^ false      # => true
+  #     true ^ nil        # => true
+  #
+  def ^: (false | nil) -> true
+       | (untyped obj) -> bool
+
+  # <!-- rdoc-file=object.c -->
+  # Returns string `'true'`:
+  #
+  #     true.to_s # => "true"
+  #
+  # TrueClass#inspect is an alias for TrueClass#to_s.
+  #
+  alias inspect to_s
+
+  # <!--
+  #   rdoc-file=object.c
+  #   - true.to_s -> 'true'
+  # -->
+  # Returns string `'true'`:
+  #
+  #     true.to_s # => "true"
+  #
+  # TrueClass#inspect is an alias for TrueClass#to_s.
+  #
+  def to_s: () -> "true"
+
+  # <!--
+  #   rdoc-file=object.c
+  #   - true | object -> true
+  # -->
+  # Returns `true`:
+  #
+  #     true | Object.new # => true
+  #     true | false      # => true
+  #     true | nil        # => true
+  #
+  # Argument `object` is evaluated. This is different from `true` with the
+  # short-circuit operator, whose operand is evaluated only if necessary:
+  #
+  #     true | raise # => Raises RuntimeError.
+  #     true || raise # => true
+  #
+  def |: (untyped obj) -> true
+end