(892c46283a5ea4179500d951c9d4866c0051f27b)
Public APIs related to rb_cSymbol. More...
#include "ruby/internal/attr/const.h"#include "ruby/internal/attr/nonnull.h"#include "ruby/internal/dllexport.h"#include "ruby/internal/value.h"
Go to the source code of this file.
Functions | |
| ID | rb_id_attrset (ID id) |
| Calculates an ID of attribute writer. More... | |
| int | rb_is_const_id (ID id) |
| Classifies the given ID, then sees if it is a constant. More... | |
| int | rb_is_global_id (ID id) |
| Classifies the given ID, then sees if it is a global variable. More... | |
| int | rb_is_instance_id (ID id) |
| Classifies the given ID, then sees if it is an instance variable. More... | |
| int | rb_is_attrset_id (ID id) |
| Classifies the given ID, then sees if it is an attribute writer. More... | |
| int | rb_is_class_id (ID id) |
| Classifies the given ID, then sees if it is a class variable. More... | |
| int | rb_is_local_id (ID id) |
| Classifies the given ID, then sees if it is a local variable. More... | |
| int | rb_is_junk_id (ID) |
| Classifies the given ID, then sees if it is a junk ID. More... | |
| int | rb_symname_p (const char *str) |
| Sees if the passed C string constructs a valid syntactic symbol. More... | |
| VALUE | rb_backref_get (void) |
Queries the last match, or Regexp.last_match, or the $~. More... | |
| void | rb_backref_set (VALUE md) |
Updates $~. More... | |
| VALUE | rb_lastline_get (void) |
Queries the last line, or the $_. More... | |
| void | rb_lastline_set (VALUE str) |
Updates $_. More... | |
| VALUE | rb_sym_all_symbols (void) |
| Collects every single bits of symbols that have ever interned in the entire history of the current process. More... | |
Detailed Description
Public APIs related to rb_cSymbol.
- Copyright
- This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.
- Warning
- Symbols prefixed with either
RBIMPLorrbimplare implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.
- Note
- To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance
__VA_ARGS__is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.
Definition in file parse.h.
Function Documentation
◆ rb_backref_get()
| VALUE rb_backref_get | ( | void | ) |
Queries the last match, or Regexp.last_match, or the $~.
You don't have to use it, because in reality you can get $~ using rb_gv_get() as usual.
- Return values
-
RUBY_Qnil The method has not ran a regular expression. otherwise An instance of rb_cMatch.
Definition at line 1826 of file vm.c.
Referenced by rb_f_global_variables().
◆ rb_backref_set()
| void rb_backref_set | ( | VALUE | md | ) |
Updates $~.
You don't have to use it, because in reality you can set $~ using rb_gv_set() as usual.
- Parameters
-
[in] md Arbitrary Ruby object.
- Postcondition
- The passed object is assigned to
$~.
Definition at line 1832 of file vm.c.
Referenced by rb_reg_match2().
◆ rb_id_attrset()
◆ rb_is_attrset_id()
| int rb_is_attrset_id | ( | ID | id | ) |
◆ rb_is_class_id()
| int rb_is_class_id | ( | ID | id | ) |
◆ rb_is_const_id()
| int rb_is_const_id | ( | ID | id | ) |
Classifies the given ID, then sees if it is a constant.
In case an ID is in Unicode (likely), its "constant"-ness is determined if its first character is either upper case or title case. Otherwise it is detected if case- folding the first character changes its case or not.
- Parameters
-
[in] id An id to classify.
- Return values
-
1 It is a constant. 0 It isn't.
Definition at line 1063 of file symbol.c.
Referenced by rb_define_const().
◆ rb_is_global_id()
| int rb_is_global_id | ( | ID | id | ) |
◆ rb_is_instance_id()
| int rb_is_instance_id | ( | ID | id | ) |
◆ rb_is_junk_id()
| int rb_is_junk_id | ( | ID | id | ) |
◆ rb_is_local_id()
| int rb_is_local_id | ( | ID | id | ) |
Classifies the given ID, then sees if it is a local variable.
A local variable starts with a lowercase character, followed by some alphanumeric characters or _, then ends with anything other than !, ?, or =.
- Parameters
-
[in] id An id to classify.
- Return values
-
1 It is a local variable. 0 It isn't.
◆ rb_lastline_get()
| VALUE rb_lastline_get | ( | void | ) |
Queries the last line, or the $_.
You don't have to use it, because in reality you can get $_ using rb_gv_get() as usual.
- Return values
-
RUBY_Qnil There has never been a "line" yet. otherwise The last set $_value.
Definition at line 1838 of file vm.c.
Referenced by rb_io_print(), and rb_reg_match2().
◆ rb_lastline_set()
| void rb_lastline_set | ( | VALUE | str | ) |
Updates $_.
You don't have to use it, because in reality you can set $_ using rb_gv_set() as usual.
- Parameters
-
[in] str Arbitrary Ruby object.
- Postcondition
- The passed object is assigned to
$_.
Definition at line 1844 of file vm.c.
Referenced by rb_gets().
◆ rb_sym_all_symbols()
| VALUE rb_sym_all_symbols | ( | void | ) |
◆ rb_symname_p()
| int rb_symname_p | ( | const char * | str | ) |
