R/altrep_backend-search_replace_4.R

In charr: String Processing Reimagined for 'ALTREP' Strings

# Copied from stringi; stri_* renamed to ci_*.
# kate: default-dictionary en_US

## This file is part of the 'stringi' package for R.
## Copyright (c) 2013-2025, Marek Gagolewski <https://www.gagolewski.com/>
## All rights reserved.
##
## Redistribution and use in source and binary forms, with or without
## modification, are permitted provided that the following conditions are met:
##
## 1. Redistributions of source code must retain the above copyright notice,
## this list of conditions and the following disclaimer.
##
## 2. Redistributions in binary form must reproduce the above copyright notice,
## this list of conditions and the following disclaimer in the documentation
## and/or other materials provided with the distribution.
##
## 3. Neither the name of the copyright holder nor the names of its
## contributors may be used to endorse or promote products derived from
## this software without specific prior written permission.
##
## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
## 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
## BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
## FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
## HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
## PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
## OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
## WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
## OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
## EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


# @title
# Replace Pattern Occurrences
#
# @description
# These functions replace, with the given replacement string, every/first/last
# substring of the input that matches the specified \code{pattern}.
#
# @details
# By default, all the functions are vectorized over
# \code{str}, \code{pattern}, \code{replacement} (with recycling
# of the elements in the shorter vector if necessary).
# Input that is not part of any match is left unchanged;
# each match is replaced in the result by the replacement string.
#
# However, for \code{ci_replace_all*}, if \code{vectorize_all} is \code{FALSE},
# then each substring matching any of the supplied \code{pattern}s
# is replaced by a corresponding \code{replacement} string.
# In such a case, the vectorization is over \code{str},
# and - independently - over \code{pattern} and \code{replacement}.
# In other words, this is equivalent to something like
# \code{for (i in 1:npatterns) str <- ci_replace_all(str, pattern[i], replacement[i]}.
# Note that you must set \code{length(pattern) >= length(replacement)}.
#
# In case of \code{ci_replace_*_regex},
# the replacement string may contain references to capture groups
# (in round parentheses).
# References are of the form \code{$n}, where \code{n} is the number
# of the capture group (\code{$1} denotes the first group).
# For the literal \code{$},
# escape it with a backslash.
# Moreover, \code{${name}} are used for named capture groups.
#
# Note that \code{ci_replace_last_regex} searches from start to end,
# but skips overlapping matches, see the example below.
#
# \code{ci_replace}, \code{ci_replace_all}, \code{ci_replace_first},
# and \code{ci_replace_last} are convenience functions; they just call
# \code{ci_replace_*_*} variants, depending on the arguments used.
#
# If you wish to remove white-spaces from the start or end
# of a string, see \code{\link{ci_trim}}.
#
# @param str character vector; strings to search in
# @param pattern,regex,fixed,coll,charclass character vector;
#     search patterns; for more details refer to \link{stringi-search}
# @param replacement character vector with replacements for matched patterns
# @param opts_collator,opts_fixed,opts_regex a named list used to tune up
# the search engine's settings; see
# \code{\link{ci_opts_collator}}, \code{\link{ci_opts_fixed}},
# and \code{\link{ci_opts_regex}}, respectively; \code{NULL}
# for the defaults
# @param merge single logical value;
# should consecutive matches be merged into one string;
# \code{ci_replace_all_charclass} only
# @param vectorize_all single logical value;
# should each occurrence of a pattern in every string
# be replaced by a corresponding replacement string?;
# \code{ci_replace_all_*} only
# @param vectorise_all alias of \code{vectorize_all}
# @param mode single string;
# one of: \code{'first'} (the default), \code{'all'}, \code{'last'}
# @param ... supplementary arguments passed to the underlying functions,
# including additional settings for \code{opts_collator}, \code{opts_regex},
# \code{opts_fixed}, and so on
#
# @return All the functions return a character vector.
#
# @examples
# ci_replace_all_charclass('aaaa', '[a]', 'b', merge=c(TRUE, FALSE))
#
# ci_replace_all_charclass('a\nb\tc   d', '\\p{WHITE_SPACE}', ' ')
# ci_replace_all_charclass('a\nb\tc   d', '\\p{WHITE_SPACE}', ' ', merge=TRUE)
#
# s <- 'Lorem ipsum dolor sit amet, consectetur adipisicing elit.'
# ci_replace_all_fixed(s, ' ', '#')
# ci_replace_all_fixed(s, 'o', '0')
#
# ci_replace_all_fixed(c('1', 'NULL', '3'), 'NULL', NA)
#
# ci_replace_all_regex(s, ' .*? ', '#')
# ci_replace_all_regex(s, '(el|s)it', '1234')
# ci_replace_all_regex('abaca', 'a', c('!', '*'))
# ci_replace_all_regex('123|456|789', '(\\p{N}).(\\p{N})', '$2-$1')
# ci_replace_all_regex(c('stringi R', 'REXAMINE', '123'), '( R|R.)', ' r ')
#
# # named capture groups are available since ICU 55
# \dontrun{
# ci_replace_all_regex('words 123 and numbers 456',
#    '(?<numbers>[0-9]+)', '!${numbers}!')
# }
#
# # Compare the results:
# ci_replace_all_fixed('The quick brown fox jumped over the lazy dog.',
#      c('quick', 'brown', 'fox'), c('slow',  'black', 'bear'), vectorize_all=TRUE)
# ci_replace_all_fixed('The quick brown fox jumped over the lazy dog.',
#      c('quick', 'brown', 'fox'), c('slow',  'black', 'bear'), vectorize_all=FALSE)
#
# # Compare the results:
# ci_replace_all_fixed('The quicker brown fox jumped over the lazy dog.',
#      c('quick', 'brown', 'fox'), c('slow',  'black', 'bear'), vectorize_all=FALSE)
# ci_replace_all_regex('The quicker brown fox jumped over the lazy dog.',
#      '\\b'%s+%c('quick', 'brown', 'fox')%s+%'\\b', c('slow',  'black', 'bear'), vectorize_all=FALSE)
#
# # Searching for the last occurrence:
# # Note the difference - regex searches left to right, with no overlaps.
# ci_replace_last_fixed("agAGA", "aga", "*", case_insensitive=TRUE)
# ci_replace_last_regex("agAGA", "aga", "*", case_insensitive=TRUE)
#
# @family search_replace
# @export
# @rdname ci_replace


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace
ci_replace_all_charclass <- function(str, pattern, replacement, merge = FALSE,
    vectorize_all = TRUE, vectorise_all = vectorize_all)
{
    if (!missing(vectorise_all))
        vectorize_all <- vectorise_all

    .Call(C_ci_replace_all_charclass, str, pattern, replacement, merge, vectorize_all)
}


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace
ci_replace_all_coll <- function(str, pattern, replacement,
    vectorize_all = TRUE, vectorise_all = vectorize_all, ..., opts_collator = NULL)
{
    if (!missing(vectorise_all))
        vectorize_all <- vectorise_all
    if (!missing(...))
        opts_collator <- do.call(ci_opts_collator, as.list(c(opts_collator, ...)))
    .Call(C_ci_replace_all_coll, str, pattern, replacement, vectorize_all, opts_collator)
}


# @export
# @rdname ci_replace
ci_replace_first_coll <- function(str, pattern, replacement, ..., opts_collator = NULL)
{
    if (!missing(...))
        opts_collator <- do.call(ci_opts_collator, as.list(c(opts_collator, ...)))
    .Call(C_ci_replace_first_coll, str, pattern, replacement, opts_collator)
}


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace
ci_replace_all_fixed <- function(str, pattern, replacement,
    vectorize_all = TRUE, vectorise_all = vectorize_all, ..., opts_fixed = NULL)
{
    if (!missing(vectorise_all))
        vectorize_all <- vectorise_all
    if (!missing(...))
        opts_fixed <- do.call(ci_opts_fixed, as.list(c(opts_fixed, ...)))
    .Call(C_ci_replace_all_fixed, str, pattern, replacement, vectorize_all, opts_fixed)
}


# @export
# @rdname ci_replace
ci_replace_first_fixed <- function(str, pattern, replacement, ..., opts_fixed = NULL)
{
    if (!missing(...))
        opts_fixed <- do.call(ci_opts_fixed, as.list(c(opts_fixed, ...)))
    .Call(C_ci_replace_first_fixed, str, pattern, replacement, opts_fixed)
}


# @export
# @rdname ci_replace


# @export
# @rdname ci_replace
ci_replace_all_regex <- function(str, pattern, replacement,
    vectorize_all = TRUE, vectorise_all = vectorize_all, ..., opts_regex = NULL)
{
    if (!missing(vectorise_all))
        vectorize_all <- vectorise_all
    if (!missing(...))
        opts_regex <- do.call(ci_opts_regex, as.list(c(opts_regex, ...)))
    .Call(C_ci_replace_all_regex, str, pattern, replacement, vectorize_all, opts_regex)
}


# @export
# @rdname ci_replace
ci_replace_first_regex <- function(str, pattern, replacement, ..., opts_regex = NULL)
{
    if (!missing(...))
        opts_regex <- do.call(ci_opts_regex, as.list(c(opts_regex, ...)))
    .Call(C_ci_replace_first_regex, str, pattern, replacement, opts_regex)
}


# @export
# @rdname ci_replace


# Convert gsub-Style Replacement Strings
#
# @description
# Converts a \code{\link[base]{gsub}}-style replacement strings
# to those which can be used in \code{\link{ci_replace}}.
# In particular, \code{$} becomes \code{\\$} and \code{\\1} becomes \code{$1}.
#
# @param x character vector
#
# @return Returns a character vector.
#
# @family search_replace
# @export