###############################################################################
# Copyright (c) 2005, 2007 IBM Corporation and others.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License v. 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0.
#
# SPDX-License-Identifier: EPL-2.0
#

###############################################################################
# =====================
# Exception information
# =====================

# $!
ei_exception_name=$!
ei_exception_type=Exception
ei_exception_doc=The exception object passed to raise.

# $@
ei_backtrace_name=$@
ei_backtrace_type=Array
ei_backtrace_doc=The stack backtrace generated by the last exception.

# ==========================
# Pattern matching variables
# ==========================

# $&
pmv_match_name=$&
pmv_match_type=String
pmv_match_doc=The string matched (following a successful pattern match). This variable is local to the current scope.

# $+
pmv_highestgroup_name=$+
pmv_highestgroup_type=String
pmv_highestgroup_doc=The contents of the highest-numbered group matched following a successful pattern match. This variable is local to the current scope.

# $`
pmv_precedingmatch_name=$`
pmv_precedingmatch_type=String
pmv_precedingmatch_doc=The string preceding the match in a successful pattern match. This variable is local to the current scope.

# $'
pmv_followingmatch_name=$'
pmv_followingmatch_type=String
pmv_followingmatch_doc=The string following the match in a successful pattern match. This variable is local to the current scope.

# $=
pmv_caseinsensitive_name=$=
pmv_caseinsensitive_type=Object
pmv_caseinsensitive_doc=Deprecated. If set to any value apart from nil or false, all pattern matches will be case insensitive, string comparisons will ignore case, and string hash values will be case insensitive.

# $1
pmv_group1_name=$1
pmv_group1_type=String
pmv_group1_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $2
pmv_group2_name=$2
pmv_group2_type=String
pmv_group2_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $3
pmv_group3_name=$3
pmv_group3_type=String
pmv_group3_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $4
pmv_group4_name=$4
pmv_group4_type=String
pmv_group4_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $5
pmv_group5_name=$5
pmv_group5_type=String
pmv_group5_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $6
pmv_group6_name=$6
pmv_group6_type=String
pmv_group6_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $7
pmv_group7_name=$7
pmv_group7_type=String
pmv_group7_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $8
pmv_group8_name=$8
pmv_group8_type=String
pmv_group8_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $9
pmv_group9_name=$9
pmv_group9_type=String
pmv_group9_doc=The contents of successive groups matched in a successful pattern match. This variable is local to the current scope.

# $~
pmv_patmatch_name=$~
pmv_patmatch_type=MatchData
pmv_patmatch_doc=An object that encapsulates the results of a successful pattern match. The variables $&, $`, $', and $1 to $9 are all derived from $~. Assigning to $~ changes the values of these derived variables. This variable is local to the current scope.

# ======================
# Input/Output variables
# ======================

# $/
io_inputrecsep_name=$/
io_inputrecsep_type=String
io_inputrecsep_doc=The input record separator (newline by default). This is the value that routines such as Kernel#gets use to determine record boundaries. If set to nil, gets will read the entire file.

# $0
io_inputrecsep2_name=$0
io_inputrecsep2_type=String
io_inputrecsep2_doc=Synonym for $/.

# $\
io_appendstr_name=$\
io_appendstr_type=String
io_appendstr_doc=The string appended to the output of every call to methods such as Kernel#print and IO#write. The default value is nil.

# $,
io_paramsep_name=$,
io_paramsep_type=String
io_paramsep_doc=The separator string output between the parameters to methods such as Kernel#print and Array#join. Defaults to nil, which adds no text.

# $.
io_lastline_name=$.
io_lastline_type=Fixnum
io_lastline_doc=The number of the last line read from the current input file.

# $;
io_defaultsep_name=$;
io_defaultsep_type=String
io_defaultsep_doc=The default separator pattern used by String#split. May be set from the command line using the F flag.

# $<
io_xinput_name=$<
io_xinput_type=Object
io_xinput_doc=An object that provides access to the concatenation of the contents of all the files given as command-line arguments or $stdin (in the case where there are no arguments).

# $>
io_xoutput_name=$>
io_xoutput_type=IO
io_xoutput_doc=The destination of output for Kernel#print and Kernel#printf. The default value is $stdout.

# $_
io_lastline_name=$_
io_lastline_type=String
io_lastline_doc=The last line read by Kernel#gets or Kernel#readline. Many stringrelated functions in the Kernel module operate on $_ by default. The variable is local to the current scope.

# $defout
io_defoutput_name=$defout
io_defoutput_type=IO
io_defoutput_doc=Synonym for $>. Obsolete: use $stdout.

# $deferr
io_deferr_name=$deferr
io_deferr_type=IO
io_deferr_doc=Synonym for STDERR. Obsolete: use $stderr.

# $F
io_defaultsep2_name=$F
io_defaultsep2_type=String
io_defaultsep2_doc=Synonym for $;.

# $stderr
io_stderr_name=$stderr
io_stderr_type=IO
io_stderr_doc=The current standard error output.

# $stdin
io_stdin_name=$stdin
io_stdin_type=IO
io_stdin_doc=The current standard input.

# $stdout
io_stdout_name=$stdout
io_stdout_type=IO
io_stdout_doc=The current standard output. Assignment to $stdout is deprecated: use $stdout.reopen instead.

# ===============================
# Execution environment variables
# ===============================

# $0
eev_programname_name=$0
eev_programname_type=String
eev_programname_doc=The name of the top-level Ruby program being executed.

# $*
eev_cloptions_name=$*
eev_cloptions_type=Array
eev_cloptions_doc=An array of strings containing the command-line options from the invocation of the program.

# $"
eev_requreloaded_name=$"
eev_requreloaded_type=Array
eev_requreloaded_doc=An array containing the filenames of modules loaded by require.

# $$
eev_processnum_name=$$
eev_processnum_type=Fixnum
eev_processnum_doc=The process number of the program being executed.

# $?
eev_childstatus_name=$?
eev_childstatus_type=Process::Status
eev_childstatus_doc=The exit status of the last child process to terminate.

# $:
eev_libpath_name=$:
eev_libpath_type=Array
eev_libpath_doc=An array of strings, where each string specifies a directory to be searched for Ruby scripts and binary extensions used by the load and require methods.

# $-a
eev_optiona_name=$-a
eev_optiona_type=Object
eev_optiona_doc=True if the -a option is specified on the command line.

# $-d
eev_optiond_name=$-d
eev_optiond_type=Object
eev_optiond_doc=Synonym for $DEBUG.

# $DEBUG
eev_debug_name=$DEBUG
eev_debug_type=Object
eev_debug_doc=Set to true if the -d command-line option is specified.

# __FILE__
eev_file_name=__FILE__
eev_file_type=String
eev_file_doc=The name of the current source file.

# $F
eev_splitcl_name=$F
eev_splitcl_type=Array
eev_splitcl_doc=The array that receives the split input line if the a command-line option is used.

# $FILENAME
eev_filename_name=$FILENAME
eev_filename_type=String
eev_filename_doc=The name of the current input file. Equivalent to $<.filename.

# $-i
eev_optioni_name=$-i
eev_optioni_type=String
eev_optioni_doc=If in-place edit mode is enabled (perhaps using the -i command-line option), $-i holds the extension used when creating the backup file. If you set a value into $-i, enables in-place edit mode.

# $-I
eev_optioni2_name=$-I
eev_optioni2_type=Array
eev_optioni2_doc=Synonym for $:.

# $-K
eev_optionk_name=$-K
eev_optionk_type=String
eev_optionk_doc=Sets the multibyte coding system for strings and regular expressions. Equivalent to the -K command-line option.

# $-l
eev_optionl_name=$-l
eev_optionl_type=Object
eev_optionl_doc=Set to true if the -l option (which enables line-end processing) is present on the command line.

# __LINE__
eev_line_name=__LINE__
eev_line_type=String
eev_line_doc=The current line number in the source file.

# $LOAD_PATH
eev_loadpath_name=$LOAD_PATH
eev_loadpath_type=Array
eev_loadpath_doc=A synonym for $:.

# $-p
eev_optionp_name=$-p
eev_optionp_type=Object
eev_optionp_doc=Set to true if the -p option (which puts an implicit while gets ... end loop around your program) is present on the command line.

# $SAFE
eev_safelevel_name=$SAFE
eev_safelevel_type=Fixnum
eev_safelevel_doc=The current safe level. This variable's value may never be reduced by assignment.

# $VERBOSE
eev_verbose_name=$VERBOSE
eev_verbose_type=Object
eev_verbose_doc=Set to true if the -v, --version, -W, or -w option is specified on the command line. Set to false if no option, or -W1 is given. Set to nil if -W0 was specified.

# $-v
eev_verbose2_name=$-v
eev_verbose2_type=Object
eev_verbose2_doc=Synonym for $VERBOSE.

# $-w
eev_verbose3_name=$-w
eev_verbose3_type=Object
eev_verbose3_doc=Synonym for $VERBOSE.

# ================
# Standard objects
# ================

# ARGF
so_argf_name=ARGF
so_argf_ Object
so_argf_A synonym for $<.

# ARGV
so_argv_name=ARGV
so_argv_type=Array
so_argv_doc=A synonym for $*.

# ENV
so_env_name=ENV
so_env_type=Object
so_env_doc=A hash-like object containing the program's environment variables. An instance of class Object, ENV implements the full set of Hash methods. Used to query and set the value of an environment variable, as in ENV["PATH"] and ENV["term"]="ansi".

# false
so_false_name=false
so_false_type=FalseClass
so_false_doc=Singleton instance of class FalseClass.

# nil
so_nil_name=nil
so_nil_type=NilClass
so_nil_doc=The singleton instance of class NilClass. The value of uninitialized instance and global variables.

# self
so_self_name=self
so_self_type=Object
so_self_doc=The receiver (object) of the current method.

# true
so_true_name=true
so_true_type=TrueClass
so_true_doc=Singleton instance of class TrueClass.

# ================
# Global constants
# ================

# DATA
gc_data_name=DATA
gc_data_type=IO
gc_data_doc=If the the main program file contains the directive __END__, then the constant DATA will be initialized so that reading from it will return lines following __END__ from the source file.

# FALSE
gc_false_name=FALSE
gc_false_type=FalseClass
gc_false_doc=Synonym for false.

# NIL
gc_nil_name=NIL
gc_nil_type=NilClass
gc_nil_doc=Synonym for nil.

# RUBY_PLATFORM
gc_rubyplatform_name=RUBY_PLATFORM
gc_rubyplatform_type=String
gc_rubyplatform_doc=The identifier of the platform running this program. This string is in the same form as the platform identifier used by the GNU configure utility (which is not a coincidence).

# RUBY_RELEASE_DATE
gc_rubyreleasedate_name=RUBY_RELEASE_DATE
gc_rubyreleasedate_type=String
gc_rubyreleasedate_doc=The date of this release.

# RUBY_VERSION
gc_rubyversion_name=RUBY_VERSION
gc_rubyversion_type=String
gc_rubyversion_doc=The version number of the interpreter.

# STDERR
gc_stderr_name=STDERR
gc_stderr_type=IO
gc_stderr_doc=The actual standard error stream for the program. The initial value of $stderr.

# STDIN
gc_stdin_name=STDIN
gc_stdin_type=IO
gc_stdin_doc=The actual standard input stream for the program. The initial value of $stdin.

# STDOUT
gc_stdout_name=STDOUT
gc_stdout_type=IO
gc_stdout_doc=The actual standard output stream for the program. The initial value of $stdout.

# SCRIPT_LINES__
gc_scriptlines_name=SCRIPT_LINES__
gc_scriptlines_type=Hash
gc_scriptlines_doc=If a constant SCRIPT_LINES__ is defined and references a Hash, Ruby will store an entry containing the contents of each file it parses, with the file's name as the key and an array of strings as the value.

# TOPLEVEL_BINDING
gc_toplevelbinding_type=TOPLEVEL_BINDING
gc_toplevelbinding_type=Binding
gc_toplevelbinding_type=A Binding object representing the binding at Ruby's top level-the level where programs are initially executed.

# TRUE
gc_true_name=TRUE
gc_true_type=TrueClass
gc_true_doc=Synonym for true.