Merge pull request #6543 from mruby/add-comments-dump-c-partial

Add descriptive comments to several functions in src/dump.c

This commit adds Doxygen-style comments to the following functions
in src/dump.c, ensuring "@brief" is not used:

Non-static functions (comments reviewed/updated):
- mrb_dump_irep
- mrb_dump_irep_binary
- mrb_dump_irep_cfunc

Static functions (new comments added):
- write_irep_header
- write_iseq_block
- dump_float (if compiled)
- get_pool_block_size
- write_pool_block
- get_syms_block_size
- write_syms_block
- get_irep_record_size

This work is part of a larger effort to document all non-trivial
functions in this file as per your feedback. The remaining functions
will be documented in subsequent commits.

error.c: add descriptive comments

The comments are written by Google Jules.

Merge pull request #6542 from mruby/add-symbol-comments

Add descriptive comments to MRB_API functions in src/symbol.c

This commit adds descriptive comments to all functions marked with MRB_API
in the `src/symbol.c` file. The comments explain the purpose, parameters,
and return values of these functions, improving code readability and
maintainability.

The following functions were commented:
- mrb_intern
- mrb_intern_static
- mrb_intern_cstr
- mrb_intern_str
- mrb_intern_check
- mrb_check_intern
- mrb_intern_check_cstr
- mrb_check_intern_cstr
- mrb_intern_check_str
- mrb_check_intern_str
- mrb_sym_name_len
- mrb_sym_str
- mrb_sym_name
- mrb_sym_dump

mruby-time (mrb_to_time_t): separate into smaller functions

The code was written by Google Jules.

mruby-time: add descriptive comments

The comments were written by Google Jules.

mruby-time: replace magic numbers to C macros

The code is written by Google Jules.

Merge pull request #6541 from mruby/add-api-comments-array

Add descriptive comments for MRB_API functions in src/array.c

This change adds C-style multiline comments to all functions
marked with MRB_API in the src/array.c file.

The comments explain each function's purpose, its parameters,
and what it returns, where applicable. This improves the
readability and maintainability of the C API for mruby arrays.

The `@brief` markup was intentionally avoided as per your
requirements.

Merge branch 'jules_wip_7626599795303680331'

hash.c: add descriptive comments to C-facing MRB_API hash functions

This commit adds C-style descriptive comments to MRB_API functions
in `src/hash.c` that are intended for use as part of mruby's C API.
The comments are targeted at C developers using these functions directly.

Comments were added or updated for the following functions:
- mrb_hash_new: Added comment.
- mrb_hash_new_capa: Updated existing comment to be more C API user-centric.
- mrb_hash_dup: Added comment.
- mrb_hash_get: Added comment.
- mrb_hash_fetch: Added comment.
- mrb_hash_set: Added comment.
- mrb_hash_delete_key: Added comment.
- mrb_hash_size: Added comment.
- mrb_hash_merge: Added comment.
- mrb_hash_foreach: Comment updated in a previous phase of work.

This work aligns with the guideline to comment C-facing MRB_API functions,
while avoiding adding new C-API comments to those MRB_API functions
that solely implement Ruby methods and already have extensive Ruby
method documentation (call-seq) in the source. The @brief markup
was avoided as per the original issue request.

Merge pull request #6538 from mruby/dependabot/bundler/rake-13.3.0

Merge pull request #6540 from mruby/add-comments-object-c

Merge pull request #6539 from mruby/add-string-comments

Add descriptive comments to MRB_API functions in object.c

This commit adds and updates C-style block comments for all functions marked with MRB_API in src/object.c.

The comments explain the purpose, parameters, and return values of these functions, adhering to the project's documentation style and avoiding the use of '@brief' markup.

Existing comments were also reviewed and updated for clarity and consistency.

Here's the rewritten message:

Add descriptive comments for MRB_API functions in src/string.c

This commit adds descriptive comments to various MRB_API functions
within the src/string.c file. These comments aim to improve code
readability and maintainability by explaining the purpose,
parameters, and return values of these functions.

build(deps): bump rake from 13.2.1 to 13.3.0

Bumps [rake](https://github.com/ruby/rake) from 13.2.1 to 13.3.0.
- [Release notes](https://github.com/ruby/rake/releases)
- [Changelog](https://github.com/ruby/rake/blob/master/History.rdoc)
- [Commits](https://github.com/ruby/rake/compare/v13.2.1...v13.3.0)

---
updated-dependencies:
- dependency-name: rake
  dependency-version: 13.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Merge pull request #6537 from mruby/add-cdump-comments

Merge pull request #6536 from mruby/add-debug-comments

The comments in `cdump.c` have been updated to remove the `@brief` tag from the Doxygen-style comment for the `mrb_dump_irep_cstruct` function. This change was made based on your feedback.

The rest of the comment, which details the function's purpose, parameters, return values, and conditional compilation, remains unchanged.

Merge pull request #6535 from mruby/add-mempool-comments

Merge pull request #6534 from mruby/add-readfloat-comment

Add descriptive comments to public functions in src/debug.c

This change adds Doxygen-style comments to the public API functions
in `src/debug.c`, including mrb_packed_int_len, mrb_packed_int_encode,
and mrb_packed_int_decode. The comments explain the purpose of each function,
its parameters, and its return value. This improves the readability
and maintainability of the code.

I've added descriptive comments for functions/macros in src/mempool.c.

This commit adds Doxygen-style comments to the public functions,
internal static functions, and structs within the `src/mempool.c` file.
These comments clarify the purpose, parameters, and return values (where applicable)
of these code elements, improving code readability and maintainability.

The following elements were commented:
- struct mempool_page
- struct mempool
- ALIGN_PADDING macro
- mempool_open()
- mempool_close()
- page_alloc()
- mempool_alloc()
- mempool_realloc()

Add descriptive comment to mrb_read_float function

This commit adds a descriptive comment at the beginning of the `mrb_read_float` function in `src/readfloat.c`.

The comment explains the function's purpose, its parameters (`str`, `endp`, `fp`), and its return value (`TRUE` or `FALSE`). This improves code readability and understanding.

Merge pull request #6533 from katafrakt/fix-extended-callback

class.c: Remove MRB_INLINE_METHOD_CACHE support from mt_tbl

The sorted array binary search implementation no longer uses the inline
cache array, so remove all MRB_INLINE_METHOD_CACHE definitions and
related code.

class.c: Switch mt_tbl to sorted array binary search for method lookups

By replacing the open‐addressing hash with a sorted array and binary
search, we eliminate tombstone management and improve cache locality of
method entries. This preserves the original contiguous values+keys
layout and peak memory usage, while simplifying growth logic and
delivering lookup performance gains.

Fix calling `extended` callback

The callback of extending module should be called, not of a singleton
class of an extended object.

variable.c (iv_copy): just memcpy sorted array; no iv_put

variable.c (iv_rehash): just memcpy sorted array; no need to call iv_put

variable.c: use binary search for iv_tbl lookups

Preserve the original iv_tbl heap layout and allocation pattern, but
switch iv_put to maintain sorted keys and iv_get/iv_del to perform
binary search. This eliminates extra probing overhead, improves
read-heavy lookup performance for small tables, and incurs zero
additional allocations.

variable.c (iv_size): refactor the function

Along with removing an obsolete comment line.

variable.c (mrb_mod_cv_get): initialize local variable

To silence compiler warning.

array.c: remove unnecessary blank line

Merge pull request #6532 from mruby/improve-mt-hash-load-factor

I've reverted method table optimizations to prioritize memory savings for you.

My previous attempts to improve method table (mt_tbl) performance by introducing a load factor and adjusting the initial allocation size unfortunately led to undesirable increases in memory consumption.

Given that memory usage is a primary concern, I've reverted the following changes:
- Removed the load factor based rehashing logic.
- Removed the related definitions for the load factor.
- Ensured the initial allocation size is 8.

This restores the method table to its original behavior, where it rehashes only when the table is completely full or during initial allocation. This should bring memory usage back to its baseline level prior to these optimization attempts.

Merge pull request #6531 from mruby/improve-mt-hash-load-factor

Improve method table performance by rehashing at 75% load factor.

The method table (mt_tbl) in src/class.c previously only rehashed when it became completely full. With linear probing, this could lead to significant performance degradation for lookups and insertions as the table approached full capacity.

This change introduces a load factor (MT_LOAD_FACTOR_NUM/MT_LOAD_FACTOR_DEN, set to 3/4 or 0.75). The mt_put function now checks if adding a new element would cause the table's size to meet or exceed this load factor relative to its allocated capacity. If so, it triggers a rehash before inserting the new element.

This helps maintain more empty slots in the hash table, improving the average-case performance of linear probing and reducing the likelihood of worst-case scenarios. The existing initial allocation size and doubling strategy for rehashing are retained.

string.c (popcount): support when sizeof(int) == 4

This function is used when the compiler does not support builtin
popcount operation (namely VC++).

vm.c (stack_init): clear initial stack

mruby-rational (int_lshift): check before actual left bit shift

mruby-rational (int_lshift): exponential may be bigger than int bits

mruby-eval (binding_eval_error_check): re-raise Exception in parsing

error.c (mrb_vformat): prevent SEGV from %s with NULL

mruby-compiler (gen_move): avoid unnecessary goto's

mruby-compiler (gen_move): avoid optimization of ADDI/SUBI

ADDI/SUBI may fall back to method call that may clear block argument
place holder, which may be a live register. So we cannot directly call
ADDI/SUBI over local variables.

codedump.c: remove unnecessary tab character from OP_MOVE

codedump.c: skip string body if it's empty

codedump.c: output format for OP_ARRAY has changed

range.c (range_num_to_a): C++ compiler eagerly warns goto statement

range.c (range_num_to_a): support big integer beg/end in ranges

range.c (range_num_to_a): improved float support

mruby-io: provide Kernel#p in this gem

To prevent ordering instability when output from mruby-io and Kernel#p
mixed.

Merge pull request #6530 from dearblue/visibility

mruby-compiler: add y.tab.c in the repository again; close #6515

Since we have introduced lrama, everyone can generate same `y.tab.c`
on any platform, without installing Bison. That was the reason we have
removed `y.tab.c` from the repository. But this change cause #6515 and
bothered out-of-tree builds. So we (reluctantly) added `y.tab.c` again.

.gitignore: no longer ignore y.tab.c; ref #6515

mruby-compiler: remove mrb_free dependency from codegen.c

mruby-compiler: remove mrb_calloc dependency from parse.y

mruby-compiler: removed mrb_state dependency from two functions

- mrb_ccontext_partial_hook
- mrb_ccontext_cleanup_local_variables

stdlib.gembox: add mruby-catch to the gembox

Revert "class.c (find_visibility_scope): when callinfo returns, *ep == NULL; #6512"

This reverts commit 3879b95a6223846bc6763d84cb8c0282a6792d31.

This is because the code first reported in #6494 no longer works.

Add more test code for method visibility

This test corresponds to the first issue of #6494.
Complement to #6512.

Merge pull request #6529 from mruby/dependabot/github_actions/super-linter/super-linter-7.4.0

build(deps): bump super-linter/super-linter from 7.3.0 to 7.4.0

Bumps [super-linter/super-linter](https://github.com/super-linter/super-linter) from 7.3.0 to 7.4.0.
- [Release notes](https://github.com/super-linter/super-linter/releases)
- [Changelog](https://github.com/super-linter/super-linter/blob/main/CHANGELOG.md)
- [Commits](https://github.com/super-linter/super-linter/compare/v7.3.0...v7.4.0)

---
updated-dependencies:
- dependency-name: super-linter/super-linter
  dependency-version: 7.4.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

stdlib.gembox: add mruby-enum-chain gem

metaprog.gembox: add two binding gems

- mruby-binding
- mruby-proc-binding

math.gembox: exclude mruby-cmath from math gembox

Merge pull request #6528 from jbampton/fix-grammar-spelling

Merge pull request #6418 from jbampton/add-ls-lint

misc: fix spelling

Add `ls-lint` with GitHub Actions

Rename files in the `mrbgems` directory

Merge pull request #6526 from vickash/luckfox-pico

mruby-compiler: use mrb_basic_alloc_func() directly from compiler

As a side effect, memory allocation failure may cause segmentation
fault. Maybe we have to add error detection later.

mruby-compiler: use new mempool API

mempool.c (mempool_open): avoid using old API in mempool.c

Merge pull request #6525 from hasse09052/skip-empty-mirb-history

compile.h: change `struct mrb_mempool` to `mrb_mempool`

So that compatibility layer can be used without macro definition.

Luckfox Pico config: Use realpath, comment flags and cmath exclusion

Add build config for Luckfox Pico embedded SBC

mempool.c: remove mrb_state dependency from mempool library

mempool.h provide compatibility layer so that existing programs does not
need to update (but update recommended anyway, since compatibility layer
takes mrb_state that is not used at all).

class.c (mt_rehash): Fix mrb_calloc argument order

Since mrb_calloc() (along with mrb_calloc) takes two arguments: nmemb
which is number of array elements, and size which is size of the array.
Of course, revsersing does not change the behavior, but we'd like to
respect the original design intention of calloc(3).

Merge pull request #6521 from jbampton/add-codespell-config

mruby-bin-mirb: skip adding empty input to mirb history

doc/guides/memory.md: update the document

- new API
- detailed hook description
- migration path from old API

allocf.c: update and enhance documentation in the comment

mruby.h: remove mrb_allocf type

As a result, we removed (already obsoleted) `mrb_open_allocf()', and
made `mrb_open_core()` take no argument. [incompatible changes]

allocf.c (mrb_basic_alloc_func): remove ud argument

allocf.c: rename mrb_default_alloc to mrb_basic_alloc_func

Along with removing mrb_state first argument from the function. From
mruby 3.2, this function is *not* the default function, but the entry
point that can be redefined for the application. The function in
`src/allocf.c` is the default *implementation* (using malloc / realloc /
free) of the function.

Add codespell config file `.codespellrc`

Add `.codespellrc` to the GitHub labeler

Can now run codespell from the command line standalone and it will use
our standard config file. Running codespell with pre-commit will also use this config.

Useful when regenerating the ignored words file on the command line.

https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file

https://github.com/codespell-project/codespell?tab=readme-ov-file#pre-commit-hook

mruby.h: remove allocf and allocf_ud from mrb_state

This is preparation for memory allocation restructuring.

mruby-random: Random#rand(nil) should raise TypeError

mruby-random: update error messages to be compatible with CRuby; #6523

test/kernel.rb: disable some Kernel#p tests; ref #6524

Merge pull request #6523 from leviongit/rand-range

Merge pull request #6524 from hasumikin/fix/Kernel#p

Merge pull request #6522 from jbampton/label-more-files

class.c (find_visibility_scope): when callinfo returns, *ep == NULL; #6512

class.c (find_visibility_scope): rename the function; ref #6512

Since the function returns either callinfo or env, thus the name does
not describe the current behavior. In addition, we did some refactoring
on the function.