d2c41b1bff
Previously, passing a keyword splat to a method always allocated a hash on the caller side, and accepting arbitrary keywords in a method allocated a separate hash on the callee side. Passing explicit keywords to a method that accepted a keyword splat did not allocate a hash on the caller side, but resulted in two hashes allocated on the callee side. This commit makes passing a single keyword splat to a method not allocate a hash on the caller side. Passing multiple keyword splats or a mix of explicit keywords and a keyword splat still generates a hash on the caller side. On the callee side, if arbitrary keywords are not accepted, it does not allocate a hash. If arbitrary keywords are accepted, it will allocate a hash, but this commit uses a callinfo flag to indicate whether the caller already allocated a hash, and if so, the callee can use the passed hash without duplicating it. So this commit should make it so that a maximum of a single hash is allocated during method calls. To set the callinfo flag appropriately, method call argument compilation checks if only a single keyword splat is given. If only one keyword splat is given, the VM_CALL_KW_SPLAT_MUT callinfo flag is not set, since in that case the keyword splat is passed directly and not mutable. If more than one splat is used, a new hash needs to be generated on the caller side, and in that case the callinfo flag is set, indicating the keyword splat is mutable by the callee. In compile_hash, used for both hash and keyword argument compilation, if compiling keyword arguments and only a single keyword splat is used, pass the argument directly. On the caller side, in vm_args.c, the callinfo flag needs to be recognized and handled. Because the keyword splat argument may not be a hash, it needs to be converted to a hash first if not. Then, unless the callinfo flag is set, the hash needs to be duplicated. The temporary copy of the callinfo flag, kw_flag, is updated if a hash was duplicated, to prevent the need to duplicate it again. If we are converting to a hash or duplicating a hash, we need to update the argument array, which can including duplicating the positional splat array if one was passed. CALLER_SETUP_ARG and a couple other places needs to be modified to handle similar issues for other types of calls. This includes fairly comprehensive tests for different ways keywords are handled internally, checking that you get equal results but that keyword splats on the caller side result in distinct objects for keyword rest parameters. Included are benchmarks for keyword argument calls. Brief results when compiled without optimization: def kw(a: 1) a end def kws(**kw) kw end h = {a: 1} kw(a: 1) # about same kw(**h) # 2.37x faster kws(a: 1) # 1.30x faster kws(**h) # 2.19x faster kw(a: 1, **h) # 1.03x slower kw(**h, **h) # about same kws(a: 1, **h) # 1.16x faster kws(**h, **h) # 1.14x faster |
||
---|---|---|
.github | ||
basictest | ||
benchmark | ||
bin | ||
bootstraptest | ||
ccan | ||
coroutine | ||
coverage | ||
cygwin | ||
defs | ||
doc | ||
enc | ||
ext | ||
gems | ||
include | ||
internal | ||
lib | ||
libexec | ||
man | ||
misc | ||
missing | ||
sample | ||
spec | ||
template | ||
test | ||
tool | ||
win32 | ||
.dir-locals.el | ||
.document | ||
.editorconfig | ||
.gdbinit | ||
.gitattributes | ||
.gitignore | ||
.rspec_parallel | ||
.travis.yml | ||
aclocal.m4 | ||
addr2line.c | ||
addr2line.h | ||
appveyor.yml | ||
array.c | ||
array.rb | ||
ast.c | ||
ast.rb | ||
bignum.c | ||
BSDL | ||
builtin.c | ||
builtin.h | ||
class.c | ||
common.mk | ||
compar.c | ||
compile.c | ||
complex.c | ||
configure.ac | ||
constant.h | ||
cont.c | ||
CONTRIBUTING.md | ||
COPYING | ||
COPYING.ja | ||
debug.c | ||
debug_counter.c | ||
debug_counter.h | ||
dir.c | ||
dln.c | ||
dln.h | ||
dln_find.c | ||
dmydln.c | ||
dmyenc.c | ||
dmyext.c | ||
encindex.h | ||
encoding.c | ||
enum.c | ||
enumerator.c | ||
error.c | ||
eval.c | ||
eval_error.c | ||
eval_intern.h | ||
eval_jump.c | ||
file.c | ||
gc.c | ||
gc.h | ||
gc.rb | ||
gem_prelude.rb | ||
golf_prelude.rb | ||
goruby.c | ||
GPL | ||
hash.c | ||
hrtime.h | ||
id_table.c | ||
id_table.h | ||
inits.c | ||
insns.def | ||
internal.h | ||
io.c | ||
io.rb | ||
iseq.c | ||
iseq.h | ||
kernel.rb | ||
KNOWNBUGS.rb | ||
LEGAL | ||
lex.c.blt | ||
load.c | ||
loadpath.c | ||
localeinit.c | ||
main.c | ||
marshal.c | ||
math.c | ||
method.h | ||
mini_builtin.c | ||
miniinit.c | ||
mjit.c | ||
mjit.h | ||
mjit_compile.c | ||
mjit_worker.c | ||
NEWS.md | ||
node.c | ||
node.h | ||
numeric.c | ||
object.c | ||
pack.c | ||
pack.rb | ||
parse.y | ||
prelude.rb | ||
probes.d | ||
probes_helper.h | ||
proc.c | ||
process.c | ||
random.c | ||
range.c | ||
rational.c | ||
re.c | ||
README.EXT | ||
README.EXT.ja | ||
README.ja.md | ||
README.md | ||
regcomp.c | ||
regenc.c | ||
regenc.h | ||
regerror.c | ||
regexec.c | ||
regint.h | ||
regparse.c | ||
regparse.h | ||
regsyntax.c | ||
ruby-runner.c | ||
ruby.c | ||
ruby_assert.h | ||
ruby_atomic.h | ||
rubystub.c | ||
signal.c | ||
siphash.c | ||
siphash.h | ||
sparc.c | ||
sprintf.c | ||
st.c | ||
strftime.c | ||
string.c | ||
struct.c | ||
symbol.c | ||
symbol.h | ||
thread.c | ||
thread_pthread.c | ||
thread_pthread.h | ||
thread_sync.c | ||
thread_win32.c | ||
thread_win32.h | ||
time.c | ||
timev.h | ||
trace_point.rb | ||
transcode.c | ||
transcode_data.h | ||
transient_heap.c | ||
transient_heap.h | ||
util.c | ||
variable.c | ||
variable.h | ||
version.c | ||
version.h | ||
vm.c | ||
vm_args.c | ||
vm_backtrace.c | ||
vm_callinfo.h | ||
vm_core.h | ||
vm_debug.h | ||
vm_dump.c | ||
vm_eval.c | ||
vm_exec.c | ||
vm_exec.h | ||
vm_insnhelper.c | ||
vm_insnhelper.h | ||
vm_method.c | ||
vm_opts.h | ||
vm_trace.c | ||
vsnprintf.c | ||
warning.rb |
What's Ruby
Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.
Features of Ruby
- Simple Syntax
- Normal Object-oriented Features (e.g. class, method calls)
- Advanced Object-oriented Features (e.g. mix-in, singleton-method)
- Operator Overloading
- Exception Handling
- Iterators and Closures
- Garbage Collection
- Dynamic Loading of Object Files (on some architectures)
- Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, Haiku, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#platform-maintainers
How to get Ruby
For a complete list of ways to install Ruby, including using third-party tools like rvm, see:
https://www.ruby-lang.org/en/downloads/
Git
The mirror of the Ruby source tree can be checked out with the following command:
$ git clone https://github.com/ruby/ruby.git
There are some other branches under development. Try the following command to see the list of branches:
$ git ls-remote https://github.com/ruby/ruby.git
You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.
Subversion
Stable branches for older Ruby versions can be checked out with the following command:
$ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby
Try the following command to see the list of branches:
$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/
Ruby home page
Mailing list
There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:
subscribe
in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.
How to compile and install
-
If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.
-
If
./configure
does not exist or is older thanconfigure.ac
, runautoconf
to (re)generate configure. -
Run
./configure
, which will generateconfig.h
andMakefile
.Some C compiler flags may be added by default depending on your environment. Specify
optflags=..
andwarnflags=..
as necessary to override them. -
Edit
include/ruby/defines.h
if you need. Usually this step will not be needed. -
Remove comment mark(
#
) before the module names fromext/Setup
(or add module names if not present), if you want to link modules statically.If you don't want to compile non static extension modules (probably on architectures which do not allow dynamic loading), remove comment mark from the line "
#option nodynamic
" inext/Setup
.Usually this step will not be needed.
-
Run
make
.- On Mac, set RUBY_CODESIGN environment variable with a signing identity.
It uses the identity to sign
ruby
binary. See also codesign(1).
- On Mac, set RUBY_CODESIGN environment variable with a signing identity.
It uses the identity to sign
-
Optionally, run '
make check
' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded
", your Ruby works as it should (hopefully). -
Run '
make install
'.This command will create the following directories and install files into them.
${DESTDIR}${prefix}/bin
${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
${DESTDIR}${prefix}/lib
${DESTDIR}${prefix}/lib/ruby
${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
${DESTDIR}${prefix}/lib/ruby/site_ruby
${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
${DESTDIR}${prefix}/lib/ruby/vendor_ruby
${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
${DESTDIR}${prefix}/share/man/man1
${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system
If Ruby's API version is 'x.y.z', the
${MAJOR}
is 'x', the${MINOR}
is 'y', and the${TEENY}
is 'z'.NOTE: teeny of the API version may be different from one of Ruby's program version
You may have to be a super user to install Ruby.
If you fail to compile Ruby, please send the detailed error report with the error log and machine/OS type, to help others.
Some extension libraries may not get compiled because of lack of necessary
external libraries and/or headers, then you will need to run 'make distclean-ext
'
to remove old configuration after installing them in such case.
Copying
See the file COPYING.
Feedback
Questions about the Ruby language can be asked on the Ruby-Talk mailing list (https://www.ruby-lang.org/en/community/mailing-lists) or on websites like (https://stackoverflow.com).
Bugs should be reported at https://bugs.ruby-lang.org. Read HowToReport for more information.
Contributing
See the file CONTRIBUTING.md
The Author
Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.