Ruby 4.1.0dev (2026-11-18 revision e5e6cd45db456b2a4d368f2a34598641319df630)
rregexp.h File Reference

(e5e6cd45db456b2a4d368f2a34598641319df630)

Defines struct RRegexp. More...

Include dependency graph for rregexp.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  RRegexp
 Ruby's regular expression. More...

Macros

#define RREGEXP(obj)
 Convenient casting macro.

Functions

static struct re_pattern_buffer * RREGEXP_PTR (VALUE rexp)
 Convenient getter function.
static VALUE RREGEXP_SRC (VALUE rexp)
 Convenient getter function.
static char * RREGEXP_SRC_PTR (VALUE rexp)
 Convenient getter function.
static rb_len_t RREGEXP_SRC_LEN (VALUE rexp)
 Convenient getter function.
static char * RREGEXP_SRC_END (VALUE rexp)
 Convenient getter function.

Detailed Description

Defines struct RRegexp.

Author
Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org
Warning
Symbols prefixed with either RBIMPL or rbimpl are 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 rregexp.h.

Macro Definition Documentation

◆ RREGEXP

#define RREGEXP ( obj)
Value:
RBIMPL_CAST((struct RRegexp *)(obj))
Ruby's regular expression.
Definition rregexp.h:51

Convenient casting macro.

Parameters
objAn object, which is in fact an RRegexp.
Returns
The passed object casted to RRegexp.

Definition at line 37 of file rregexp.h.

Referenced by rb_enc_reg_new(), and RREGEXP_SRC().

Function Documentation

◆ RREGEXP_PTR()

struct re_pattern_buffer * RREGEXP_PTR ( VALUE rexp)
inlinestatic

Convenient getter function.

Parameters
[in]rexpThe regular expression in question.
Returns
The pattern buffer of the regular expression.
Precondition
rexp must be of RRegexp.

Definition at line 77 of file rregexp.h.

Referenced by RREGEXP_PTR().

◆ RREGEXP_SRC()

VALUE RREGEXP_SRC ( VALUE rexp)
inlinestatic

Convenient getter function.

Parameters
[in]rexpThe regular expression in question.
Returns
The source code of the regular expression.
Precondition
rexp must be of RRegexp.

Definition at line 93 of file rregexp.h.

Referenced by RREGEXP_SRC(), RREGEXP_SRC_END(), RREGEXP_SRC_LEN(), and RREGEXP_SRC_PTR().

◆ RREGEXP_SRC_END()

char * RREGEXP_SRC_END ( VALUE rexp)
inlinestatic

Convenient getter function.

Parameters
[in]rexpThe regular expression in question.
Returns
The end of the source code of the regular expression.
Precondition
rexp must be of RRegexp.

Definition at line 153 of file rregexp.h.

Referenced by RREGEXP_SRC_END().

◆ RREGEXP_SRC_LEN()

rb_len_t RREGEXP_SRC_LEN ( VALUE rexp)
inlinestatic

Convenient getter function.

Parameters
[in]rexpThe regular expression in question.
Returns
The length of the source code of the regular expression.
Precondition
rexp must be of RRegexp.

Definition at line 134 of file rregexp.h.

Referenced by rb_reg_regcomp(), and RREGEXP_SRC_LEN().

◆ RREGEXP_SRC_PTR()

char * RREGEXP_SRC_PTR ( VALUE rexp)
inlinestatic

Convenient getter function.

Parameters
[in]rexpThe regular expression in question.
Returns
The source code of the regular expression, in C's string.
Precondition
rexp must be of RRegexp.

Definition at line 115 of file rregexp.h.

Referenced by rb_reg_regcomp(), and RREGEXP_SRC_PTR().