summaryrefslogtreecommitdiffhomepage
path: root/doc
AgeCommit message (Collapse)Author
2021-12-12Add `Array#{repeated_combination,repeated_permutation}` methodsdearblue
Ruby 1.9.2 feature. ref: https://docs.ruby-lang.org/ja/3.1.0/method/Array/i/repeated_combination.html ref: https://docs.ruby-lang.org/ja/3.1.0/method/Array/i/repeated_permutation.html
2021-11-20doc/internal/opcode.md: moved from doc/opcode.mdYukihiro "Matz" Matsumoto
2021-11-20doc/opcode.md: update according to #5579Yukihiro "Matz" Matsumoto
2021-11-14doc/internal/boxing.md: describe how `mrb_value` represents values.Yukihiro "Matz" Matsumoto
2021-11-06mruby3.1.md: update.Yukihiro "Matz" Matsumoto
2021-11-05mruby3.1.md: update new methods description.Yukihiro "Matz" Matsumoto
2021-10-24doc/mruby3.1.h: separate mruby3.0 changes and mruby3.1 changes.Yukihiro "Matz" Matsumoto
2021-10-20doc/mruby3.md: updated to the most recent mruby3.1 (to be).Yukihiro "Matz" Matsumoto
2021-10-14Fix grammar in doc/guides/mrbgems.mdJohn Bampton
2021-10-12Support Ruby3.0 keyword arguments.Yukihiro "Matz" Matsumoto
The Difference Since Ruby1.9, the keyword arguments were emulated by Ruby using the hash object at the bottom of the arguments. But we have gradually moved toward keyword arguments separated from normal (positinal) arguments. At the same time, we value compatibility, so that Ruby3.0 keyword arguments are somewhat compromise. Basically, keyword arguments are separated from positional arguments, except when the method does not take any formal keyword arguments, given keyword arguments (packed in the hash object) are considered as the last argument. And we also allow non symbol keys in the keyword arguments. In that case, those keys are just passed in the `**` hash (or raise `ArgumentError` for unknown keys). The Instruction Changes We have changed `OP_SEND` instruction. `OP_SEND` instruction used to take 3 operands, the register, the symbol, the number of (positional) arguments. The meaning of the third operand has been changed. It is now considered as `n|(nk<<4)`, where `n` is the number of positional arguments, and `nk` is the number of keyword arguments, both occupies 4 bits in the operand. The number `15` in both `n` and `nk` means variable sized arguments are packed in the object. Positional arguments will be packed in the array, and keyword arguments will be packed in the hash object. That means arguments more than 14 values are always packed in the object. Arguments information for other instructions (`OP_SENDB` and `OP_SUPER`) are also changed. It works as the third operand of `OP_SEND`. the difference between `OP_SEND` and `OP_SENDB` is just trivial. It assigns `nil` to the block hidden arguments (right after arguments). The instruction `OP_SENDV` and `OP_SENDVB` are removed. Those instructions are replaced by `OP_SEND` and `OP_SENDB` respectively with the `15` (variable sized) argument information. Calling Convention When calling a method, the stack elements shall be in the order of the receiver of the method, positional arguments, keyword arguments and the block argument. If the number of positional or keyword arugument (`n` or `nk`) is zero, corresponding arguments will be empty. So when `n=0` and `nk=0` the stack layout (from bottom to top) will be: +-----------------------+ | recv | block (or nil) | +-----------------------+ The last elements `block` should be explicitly filled before `OP_SEND` or assigned to `nil` by `OP_SENDB` internally. In other words, the following have exactly same behavior: OP_SENDB clears `block` implicitly: ``` OP_SENDB reg sym 0 ``` OP_SEND clears `block` implicitly: ``` OP_LOADNIL R2 OP_SEND R2 sym 0 ``` When calling a method with only positional arguments (n=0..14) without keyword arguments, the stack layout will be like following: +--------------------------------------------+ | recv | arg1 | ... | arg_n | block (or nil) | +--------------------------------------------+ When calling a method with arguments packed in the array (n=15) which means argument splat (*) is used in the actual arguments, or more than 14 arguments are passed the stack layout will be like following: +-------------------------------+ | recv | array | block (or nil) | +-------------------------------+ The number of the actual arguments is determined by the length of the argument array. When keyword arguments are given (nk>0), keyword arguments are passed between positional arguments and the block argument. For example, when we pass one positional argument `1` and one keyword argument `a: 2`, the stack layout will be like: +------------------------------------+ | recv | 1 | :a | 2 | block (or nil) | +------------------------------------+ Note that keyword arguments consume `2*nk` elements in the stack when `nk=0..14` (unpacked). When calling a method with keyword arguments packed in the hash object (nk=15) which means keyword argument splat (**) is used or more than 14 keyword arguments in the actual arguments, the stack layout will be like: +------------------------------+ | recv | hash | block (or nil) | +------------------------------+ Note for mruby/c When mruby/c authors try to support new keyword arguments, they need to handle the new meaning of the argument information operand. If they choose not to support keyword arguments in mruby/c, it just raise error when `nk` (taken by `(c>>4)&0xf`) is not zero. And combine `OP_SENDV` behavior with `OP_SEND` when `n` is `15`. If they want to support keyword arguments seriously, contact me at <[email protected]> or `@yukihiro_matz`. I can help you.
2021-09-19codegen.c: unify `OP_ARYPUSH` and `OP_ARYPUSH_N`.Yukihiro "Matz" Matsumoto
- `OP_ARYPUSH` now takes operand for the number of pushing elements - the code generator consume the stack no more than `64` for `mruby/c`
2021-09-17ops.h: add `OP_ARYPUSH_N` instruction.Yukihiro "Matz" Matsumoto
Add n elements at once. Reduces instructions for huge array initialization. In addition, `gen_value` function in `codegen.c` was refactored and clarified.
2021-09-10ops.h: update `OP_HASHADD` description.Yukihiro "Matz" Matsumoto
2021-09-09doc/guides/mrbconf.rb: add `RO_DATA` configuration description; #5547Yukihiro "Matz" Matsumoto
2021-08-26value.h: reconstruct `mrb_ro_data_p()`.Yukihiro "Matz" Matsumoto
* use predefined `mrb_ro_data_p()` for user-mode Linux and macOS * define `MRB_LINK_TIME_RO_DATA_P` if predefined one is used * configure macro `MRB_USE_LINK_TIME_RO_DATA_P` is no longer used * contributions for new platforms are welcome
2021-07-03ops.h: made terms consistent.Yukihiro "Matz" Matsumoto
- `Lit` -> `Pool` - `SEQ` -> `Irep`
2021-07-03doc/opcode.md: table reformatted.Yukihiro "Matz" Matsumoto
2021-07-03vm.c: `OP_DEF` to push a symbol to `a` register.Yukihiro "Matz" Matsumoto
The code generator no longer need to emit `OP_LOADSYM` after `OP_DEF`. `doc/opcode.md` is also updated.
2021-06-30Revert "Remove `OP_EXT[123]` from operands."Yukihiro "Matz" Matsumoto
This reverts commit fd10c7231906ca48cb35892d2a86460004b62249. I thought it was OK to restrict index value within 1 byte, but in some cases index value could be 16 bits (2 bytes). I had several ideas to address the issue, but reverting `fd10c72` is the easiest way. The biggest reason is `mruby/c` still supports `OP_EXT[123]`, so that they don't need any additional work.
2021-06-22Enable markdownlint rules MD003,MD005,MD007John Bampton
Lint Markdown https://github.com/DavidAnson/markdownlint#rules--aliases
2021-06-19Enable markdownlint rule MD046 code-block-styleJohn Bampton
Fix C Markdown code block style
2021-06-17Standardize commands inside backticksJohn Bampton
Remove whitespace
2021-06-16Run pre-commit with GitHub ActionsJohn Bampton
Running pre-commit with GitHub Actions now gives us more tests and coverage Remove duplicate GitHub Actions for merge conflicts and trailing whitespace Remove duplicate checks for markdownlint and yamllint from the GitHub Super-Linter Add new custom pre-commit hook running with a shell script to sort alphabetically and uniquify codespell.txt Add new pre-commit hook to check spelling with codespell https://github.com/codespell-project/codespell Fix spelling
2021-05-11Remove the obsolete term `Fixnum`.Yukihiro "Matz" Matsumoto
Except for compatibility code.
2021-05-10doc/limitation.md: update the limitation.Yukihiro "Matz" Matsumoto
- `puts` behavior changed as CRuby - fix wrong behavior in re-raising in `rescue`
2021-05-05Extend the tab with 8 whitespacedearblue
This work was done as follows: - check: `git grep $'\011' -- :^oss-fuzz` - convert: `ruby -pi -e 'nil while $_.sub!(/^(.*?)\t/) { $1 + " " * (8 - $1.size % 8) }'` The `doc/guide/{compile,mrbgems}.md` file adds and removes whitespace to make the directory tree look the same. In `mrbgems/mruby-socket/src/socket.c`, there is a part where the indent is changed from 4 to 2 at the same time as the tab is changed.
2021-05-02Enclose the table contents of `opcode.md` as codedearblue
2021-04-28doc/opcode.md: stop reversed link syntax check from markdownlint.Yukihiro "Matz" Matsumoto
2021-04-16feat(CI): add the GitHub Super LinterJohn Bampton
The GitHub Super Linter is a more robust and better supported tool than the current GitHub Actions we are using. Running these checks: ERROR_ON_MISSING_EXEC_BIT: true VALIDATE_BASH: true VALIDATE_BASH_EXEC: true VALIDATE_EDITORCONFIG: true VALIDATE_MARKDOWN: true VALIDATE_SHELL_SHFMT: true VALIDATE_YAML: true https://github.com/marketplace/actions/super-linter https://github.com/github/super-linter Added the GitHub Super Linter badge to the README. Also updated the pre-commit framework and added more documentation on pre-commit. Added one more pre-commit check: check-executables-have-shebangs Added one extra check for merge conflicts to our GitHub Actions. EditorConfig and Markdown linting. Minor grammar and spelling fixes. Update linter.yml
2021-04-06doc/link.md: update `mruby-config` description.Yukihiro "Matz" Matsumoto
2021-04-06Merge pull request #5405 from shuujii/fix-heading-level-in-doc-guides-link.mdYukihiro "Matz" Matsumoto
Fix heading level in `doc/guides/link.md` [ci skip]
2021-04-06Fix heading level in `doc/guides/link.md` [ci skip]KOBAYASHI Shuji
2021-04-06Fix typo in `doc/guides/link.md` [ci skip]KOBAYASHI Shuji
2021-04-05link.md: add new document for linking `libmruby`; ref #5393Yukihiro "Matz" Matsumoto
2021-03-09chore: fix grammarJohn Bampton
2021-03-05Merge pull request #5373 from mruby/stableYukihiro "Matz" Matsumoto
Merge mruby 3.0.0
2021-03-05Update version and release date. (mruby 3.0.0 (2021-03-05))3.0.0mimaki
2021-03-04Update minimal build configuration [ci skip]KOBAYASHI Shuji
2021-02-21Updated `doc/opcode.md` to match `include/mruby/ops.h` [ci skip]dearblue
2021-02-13chore: fix spellingJohn Bampton
Normally a single spell checker can't find all the mistakes or check all types of code. These mistakes were found by another spell checker inside my editor with a more manual sift / find.
2021-02-13Update compile prerequisites in `doc/guides/compile.md` [ci skip]KOBAYASHI Shuji
Bison and gperf are optional.
2021-02-12doc/mruby3.md: use relative path.Yukihiro "Matz" Matsumoto
2021-02-12Update `docs/guides/mrbgems.md`; ref #5210Yukihiro "Matz" Matsumoto
Binary gems description added, along with a few cosmetic changes.
2021-02-12Update `docs/guides/compile.md`.Yukihiro "Matz" Matsumoto
Especially description regarding the build process and `build` directory structures, along with some typo fixes and cosmetic changes.
2021-02-09Upgrade supported Ruby version to 2.5.Yukihiro "Matz" Matsumoto
Ruby 2.5 is the oldest maintained version.
2021-01-28Update `limitation.md` for integer division change in 3.0.Yukihiro "Matz" Matsumoto
2021-01-28Stop mentioning `MRB_NO_PRESYM` in the doc.Yukihiro "Matz" Matsumoto
It's for internal use. Please use `conf.disable_presym`.
2021-01-28Describe disabling preallocated symbols in the doc.Yukihiro "Matz" Matsumoto
2021-01-26Adjust spaces after list markers.Yukihiro "Matz" Matsumoto
2021-01-26Update `doc/mruby3.md`.Yukihiro "Matz" Matsumoto