# frozen_string_literal: false
# notifier.rb - output methods used by irb
# $Release Version: 0.9.6$
# by Keiju ISHITSUKA(keiju@ruby-lang.org)
require_relative "output-method"
# An output formatter used internally by the lexer.
class ErrUndefinedNotifier < StandardError
super("undefined notifier level: #{val} is specified")
class ErrUnrecognizedLevel < StandardError
super("unrecognized notifier level: #{val} is specified")
# Define a new Notifier output source, returning a new CompositeNotifier
# with the given +prefix+ and +output_method+.
# The optional +prefix+ will be appended to all objects being inspected
# during output, using the given +output_method+ as the output source. If
# no +output_method+ is given, StdioOutputMethod will be used, and all
# expressions will be sent directly to STDOUT without any additional
def def_notifier(prefix = "", output_method = StdioOutputMethod.new)
CompositeNotifier.new(prefix, output_method)
module_function :def_notifier
# An abstract class, or superclass, for CompositeNotifier and
# LeveledNotifier to inherit. It provides several wrapper methods for the
# OutputMethod object used by the Notifier.
# Creates a new Notifier object
def initialize(prefix, base_notifier)
@base_notifier = base_notifier
# The +prefix+ for this Notifier, which is appended to all objects being
# inspected during output.
# A wrapper method used to determine whether notifications are enabled.
# See OutputMethod#print for more detail.
@base_notifier.print prefix, *opts if notify?
# See OutputMethod#printn for more detail.
@base_notifier.printn prefix, *opts if notify?
# See OutputMethod#printf for more detail.
def printf(format, *opts)
@base_notifier.printf(prefix + format, *opts) if notify?
# See OutputMethod#puts for more detail.
@base_notifier.puts(*objs.collect{|obj| prefix + obj.to_s})
# Same as #ppx, except it uses the #prefix given during object
# See OutputMethod#ppx for more detail.
@base_notifier.ppx @prefix, *objs
# Same as #pp, except it concatenates the given +prefix+ with the #prefix
# given during object initialization.
# See OutputMethod#ppx for more detail.
@base_notifier.ppx @prefix+prefix, *objs
# Execute the given block if notifications are enabled.
yield(@base_notifier) if notify?
# A class that can be used to create a group of notifier objects with the
# intent of representing a leveled notification system for irb.
# This class will allow you to generate other notifiers, and assign them
# the appropriate level for output.
# The Notifier class provides a class-method Notifier.def_notifier to
# create a new composite notifier. Using the first composite notifier
# object you create, sibling notifiers can be initialized with
class CompositeNotifier < AbstractNotifier
# Create a new composite notifier object with the given +prefix+, and
# +base_notifier+ to use for output.
def initialize(prefix, base_notifier)
@level_notifier = D_NOMSG
# List of notifiers in the group
# Creates a new LeveledNotifier in the composite #notifiers group.
# The given +prefix+ will be assigned to the notifier, and +level+ will
# be used as the index of the #notifiers Array.
# This method returns the newly created instance.
def def_notifier(level, prefix = "")
notifier = LeveledNotifier.new(self, level, prefix)
@notifiers[level] = notifier
# Returns the leveled notifier for this object
attr_reader :level_notifier
alias level level_notifier
# Sets the leveled notifier for this object.
# When the given +value+ is an instance of AbstractNotifier,
# #level_notifier is set to the given object.
# When an Integer is given, #level_notifier is set to the notifier at the
# index +value+ in the #notifiers Array.
# If no notifier exists at the index +value+ in the #notifiers Array, an
# ErrUndefinedNotifier exception is raised.
# An ErrUnrecognizedLevel exception is raised if the given +value+ is not
# found in the existing #notifiers Array, or an instance of
def level_notifier=(value)
raise ErrUndefinedNotifier, value unless l
raise ErrUnrecognizedLevel, value unless l
alias level= level_notifier=
# A leveled notifier is comparable to the composite group from
# CompositeNotifier#notifiers.
class LeveledNotifier < AbstractNotifier
# Create a new leveled notifier with the given +base+, and +prefix+ to
# send to AbstractNotifier.new
# The given +level+ is used to compare other leveled notifiers in the
# CompositeNotifier group to determine whether or not to output
def initialize(base, level, prefix)
# The current level of this notifier object
# Compares the level of this notifier object with the given +other+
# See the Comparable module for more information.
# Whether to output messages to the output method, depending on the level
# of this notifier object.
@base_notifier.level >= self
# NoMsgNotifier is a LeveledNotifier that's used as the default notifier
# when creating a new CompositeNotifier.
# This notifier is used as the +zero+ index, or level +0+, for
# CompositeNotifier#notifiers, and will not output messages of any sort.
class NoMsgNotifier < LeveledNotifier
# Creates a new notifier that should not be used to output messages.
# Ensures notifications are ignored, see AbstractNotifier#notify? for
D_NOMSG = NoMsgNotifier.new # :nodoc:
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
