(0989400a925cd201defdca9eb28eb87200b30785)

#include "ruby/internal/config.h"
#include <stdio.h>
#include "ruby/onigmo.h"
#include "ruby/regex.h"
#include "ruby/internal/core/rmatch.h"
#include "ruby/internal/dllexport.h"

Include dependency graph for re.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
VALUE	rb_reg_regcomp (VALUE str)
	Creates a new instance of rb_cRegexp. More...

long	rb_reg_search (VALUE re, VALUE str, long pos, int dir)
	Runs the passed regular expression over the passed string. More...

VALUE	rb_reg_regsub (VALUE repl, VALUE src, struct re_registers *regs, VALUE rexp)
	Substitution. More...

long	rb_reg_adjust_startpos (VALUE re, VALUE str, long pos, int dir)
	Tell us if this is a wrong idea, but it seems this function has no usage at all. More...

VALUE	rb_reg_quote (VALUE str)
	Escapes any characters that would have special meaning in a regular expression. More...

regex_t *	rb_reg_prepare_re (VALUE re, VALUE str)
	Exercises various checks and preprocesses so that the given regular expression can be applied to the given string. More...

OnigPosition	rb_reg_onig_match (VALUE re, VALUE str, OnigPosition(match)(regex_t reg, VALUE str, struct re_registers regs, void args), void args, struct re_registers regs)
	Runs a regular expression match using function `match`. More...

int	rb_reg_region_copy (struct re_registers dst, const struct re_registers src)
	Duplicates a match data. More...

Detailed Description

Author: $Author$

Date: Thu Sep 30 14:18:32 JST 1993

Copyright: Copyright (C) 1993-2007 Yukihiro Matsumoto; 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.

Definition in file re.h.

Function Documentation

◆ rb_reg_adjust_startpos()

long rb_reg_adjust_startpos	(	VALUE	re,
		VALUE	str,
		long	pos,
		int	dir
	)

Tell us if this is a wrong idea, but it seems this function has no usage at all.

Just remains here for theoretical backwards compatibility.

Parameters

[in]	re	Regular expression to execute.
[in]	str	Target string to search.
[in]	pos	Offset in `str` to start searching, in bytes.
[in]	dir	`pos`' direction; 0 means left-to-right, 1 for the opposite.

Returns: Adjusted nearest offset to pos inside of str, where is a character boundary.

Definition at line 1739 of file re.c.

◆ rb_reg_onig_match()

OnigPosition rb_reg_onig_match	(	VALUE	re,
		VALUE	str,
		OnigPosition()(regex_t reg, VALUE str, struct re_registers regs, void args)	match,
		void *	args,
		struct re_registers *	regs
	)

Runs a regular expression match using function match.

Performs preparation, error handling, and memory cleanup.

Parameters

[in]	re	Target regular expression.
[in]	str	What `re` is about to run on.
[in]	match	The function to run to match `str` against `re`.
[in]	args	Pointer to arguments to pass into `match`.
[out]	regs	Registers on a successful match.

Exceptions

rb_eArgError	`re` does not fit for `str`.
rb_eEncCompatError	`re` and `str` are incompatible.
rb_eRegexpError	`re` is malformed.

Returns: Match position on a successful match, ONIG_MISMATCH otherwise.

Definition at line 1703 of file re.c.

◆ rb_reg_prepare_re()

regex_t* rb_reg_prepare_re	(	VALUE	re,
		VALUE	str
	)

Exercises various checks and preprocesses so that the given regular expression can be applied to the given string.

The preprocess here includes (but not limited to) for instance encoding conversion.

Parameters

[in]	re	Target regular expression.
[in]	str	What `re` is about to run on.

Exceptions

rb_eArgError	`re` does not fit for `str`.
rb_eEncCompatError	`re` and `str` are incompatible.
rb_eRegexpError	`re` is malformed.

Returns: A preprocessesed pattern buffer ready to be applied to str.

Note: The return value is manages by our GC. Don't free.

Definition at line 1635 of file re.c.

Referenced by rb_reg_onig_match().

◆ rb_reg_quote()

VALUE rb_reg_quote ( VALUE str )

Escapes any characters that would have special meaning in a regular expression.

Parameters

[in] str Target string to escape.

Returns: A copy of str whose contents are escaped.

Definition at line 4078 of file re.c.

◆ rb_reg_regcomp()

VALUE rb_reg_regcomp ( VALUE str )

Creates a new instance of rb_cRegexp.

It can be seen as a specialised version of rb_reg_new_str() where it does not take options.

Parameters

[in] str Source code in String.

Returns: Allocated new instance of rb_cRegexp.

Definition at line 3479 of file re.c.

◆ rb_reg_region_copy()

int rb_reg_region_copy	(	struct re_registers *	dst,
		const struct re_registers *	src
	)

Duplicates a match data.

This is roughly the same as onig_region_copy(), except it tries to GC when there is not enough memory.

Parameters

[out]	dst	Target registers to fill.
[in]	src	Source registers to duplicate.

Exceptions

rb_eNoMemError Not enough memory.

Return values

0	Successful
ONIGERR_MEMORY	Not enough memory, even after GC (unlikely).

Postcondition: dst has identical contents to src.

Definition at line 984 of file re.c.

◆ rb_reg_regsub()

VALUE rb_reg_regsub	(	VALUE	repl,
		VALUE	src,
		struct re_registers *	regs,
		VALUE	rexp
	)

Substitution.

This is basically the implementation of String#sub. Also String#gsub repeatedly calls this function.

Parameters

[in]	repl	Replacement string, e.g. `"\\1\\2"`
[in]	src	Source string, to be replaced.
[in]	regs	Matched data generated by applying `rexp` to `src`.
[in]	rexp	Regular expression.

Returns: A substituted string.

Definition at line 4442 of file re.c.

◆ rb_reg_search()

long rb_reg_search	(	VALUE	re,
		VALUE	str,
		long	pos,
		int	dir
	)

Runs the passed regular expression over the passed string.

Unlike rb_reg_search() this function also takes position and direction of the search, which make it possible for this function to run from in middle of the string.

Parameters

[in]	re	Regular expression to execute.
[in]	str	Target string to search.
[in]	pos	Offset in `str` to start searching, in bytes.
[in]	dir	`pos`' direction; 0 means left-to-right, 1 for the opposite.

Exceptions

rb_eArgError	`re` is broken.
rb_eRegexpError	`re` is malformed.

Return values

-1	Match failed.
otherwise	Offset of first such byte where match happened.

Postcondition: Regexp.last_match is updated.; $&, $~, etc., are updated.

Definition at line 1844 of file re.c.

Referenced by rb_reg_match2().

(0989400a925cd201defdca9eb28eb87200b30785)

Functions

Detailed Description

Function Documentation

◆ rb_reg_adjust_startpos()

◆ rb_reg_onig_match()

◆ rb_reg_prepare_re()

◆ rb_reg_quote()

◆ rb_reg_regcomp()

◆ rb_reg_region_copy()

◆ rb_reg_regsub()

◆ rb_reg_search()