1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
John Hawthorn ebbe396d3c Use ident hash for top-level recursion check
We track recursion in order to not infinite loop in ==, inspect, and
similar methods by keeping a thread-local 1 or 2 level hash. This allows
us to track when we have seen the same object (ex. using inspect) or
same pair of objects (ex. using ==) in this stack before and to treat
that differently.

Previously both levels of this Hash used the object's memory_id as a key
(using object_id would be slow and wasteful). Unfortunately, prettyprint
(pp.rb) uses this thread local variable to "pretend" to be inspect and
inherit its same recursion behaviour.

This commit changes the top-level hash to be an identity hash and to use
objects as keys instead of their object_ids.

I'd like to have also converted the 2nd level hash to an ident hash, but
it would have prevented an optimization which avoids allocating a 2nd
level hash for only a single element, which we want to keep because it's
by far the most common case.

So the new format of this hash is:

{ object => true } (not paired)
{ lhs_object => rhs_object_memory_id } (paired, single object)
{ lhs_object => { rhs_object_memory_id => true, ... } } (paired, many objects)

We must also update pp.rb to match this (using identity hashes).
2019-11-04 15:27:15 -08:00
.github/workflows Simplify test tasks 2019-11-05 02:12:26 +09:00
basictest
benchmark
bin
bootstraptest
ccan
coroutine
coverage
cygwin
defs
doc [DOC] mentioned \R [ci skip] 2019-11-03 23:18:01 +09:00
enc
ext Adjust a fucntion signature 2019-11-05 02:05:46 +09:00
gems Updated minitest to 5.13.0 2019-11-05 02:14:31 +09:00
include
lib Use ident hash for top-level recursion check 2019-11-04 15:27:15 -08:00
libexec
man
misc
missing
sample
spec Fix warnings in Regexp#{match,match?} specs 2019-11-03 11:25:42 +01:00
template Share test-bundled-gems-run in common.mk 2019-11-05 00:05:38 +09:00
test [ruby/racc] Strip trailing whitespaces at the last line of actions 2019-11-04 09:28:01 +09:00
tool sync_default_gems.rb: Show the progress at fetching 2019-11-04 09:40:26 +09:00
win32 Share test-bundled-gems-run in common.mk 2019-11-05 00:05:38 +09:00
.dir-locals.el
.document
.drone.yml
.editorconfig
.gdbinit
.gitattributes
.gitignore
.indent.pro
.rspec_parallel
.travis.yml
aclocal.m4
addr2line.c
addr2line.h
appveyor.yml
array.c
ast.c
bignum.c
BSDL
class.c
common.mk Share test-bundled-gems-run in common.mk 2019-11-05 00:05:38 +09:00
compar.c
compile.c
complex.c
configure.ac
constant.h
cont.c Fix a typo [ci skip] 2019-11-04 17:12:18 +09:00
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 Fix zero free objects assertion 2019-11-04 08:58:52 -08:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c Put an empty line [ci skip] 2019-11-05 08:07:59 +09:00
hrtime.h
id_table.c
id_table.h
inits.c
insns.def
internal.h
io.c
iseq.c
iseq.h
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c
loadpath.c
localeinit.c
main.c
marshal.c
math.c
method.h
miniinit.c
mjit.c
mjit.h
mjit_compile.c
mjit_worker.c
NEWS Update NEWS entry for Feature #13083 2019-11-03 11:14:31 +01:00
node.c
node.h
numeric.c
object.c
pack.c
parse.y Fixed conditional expressions with only one void side 2019-11-05 01:32:26 +09:00
prelude.rb
probes.d
probes_helper.h
proc.c
process.c Use the dedicated function rb_io_check_io 2019-11-04 09:14:18 +09:00
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
safe.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 Use ident hash for top-level recursion check 2019-11-04 15:27:15 -08:00
thread_pthread.c
thread_pthread.h
thread_sync.c
thread_win32.c
thread_win32.h
time.c
timev.h
transcode.c
transcode_data.h
transient_heap.c
transient_heap.h
util.c
variable.c
version.c
version.h * 2019-11-05 [ci skip] 2019-11-05 00:07:22 +09:00
vm.c
vm_args.c
vm_backtrace.c
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
wercker.yml

Build Status wercker status Build status Build Status

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

https://www.ruby-lang.org/

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

  1. If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.

  2. If ./configure does not exist or is older than configure.ac, run autoconf to (re)generate configure.

  3. Run ./configure, which will generate config.h and Makefile.

    Some C compiler flags may be added by default depending on your environment. Specify optflags=.. and warnflags=.. as necessary to override them.

  4. Edit defines.h if you need. Usually this step will not be needed.

  5. Remove comment mark(#) before the module names from ext/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" in ext/Setup.

    Usually this step will not be needed.

  6. 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).
  7. 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).

  8. Optionally, run make update-gems and make extract-gems.

    If you want to install bundled gems, run make update-gems and make extract-gems before running make install.

  9. 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.

matz@ruby-lang.org