/ORK/IF_SI_ABAP_STRING

Reference

/ORK/SINGLETON

Interface

/ORK/IF_SI_ABAP_STRING

ABAP String Functions (Singleton)

Package: /ORK/SINGLETON
Members: 44

Description

Comprehensive utility interface for string manipulation, searching, splitting, formatting and line/offset handling.

Designed to be used via a singleton implementation.

34 items

Methods

substring

Method

Public

Returns substring using offset and length.

Parameters

Name

Description

str

Source string

off

Start offset (0-based)

len

Length, -1 = until end

result

Extracted substring

Signature

METHODS substring IMPORTING str TYPE string
                              !off TYPE i DEFAULT 0
                              !len TYPE i DEFAULT -1
                    RETURNING VALUE(result) TYPE string.

split

Method

Public

Splits string at delimiter.

Parameters

Name

Description

str

Source string

at

Delimiter

result

Split parts

Signature

METHODS split IMPORTING str TYPE string
                          !at TYPE string
                RETURNING VALUE(result) TYPE string_table.

split_extended

Method

Public

Advanced splitting with optional behavior control.

Parameters

Name

Description

str

Source string

at

Delimiter (optional)

remove_empties

Remove empty tokens

trim_entries

Trim each token

case_sensitive

Case sensitive delimiter match

result

Split parts

Signature

METHODS split_extended IMPORTING str TYPE string
                                   !at TYPE string OPTIONAL
                                   remove_empties TYPE abap_bool DEFAULT abap_false
                                   trim_entries TYPE abap_bool DEFAULT abap_false
                                   case_sensitive TYPE abap_bool DEFAULT abap_false
                         RETURNING VALUE(result) TYPE string_table.

split_regex

Method

Public

Splits string using regular expression pattern.

Parameters

Name

Description

str

Source string

pattern

Regex separator

case_sensitive

Case sensitivity

result

Split parts

Signature

METHODS split_regex IMPORTING str TYPE string
                                !pattern TYPE string
                                case_sensitive TYPE abap_bool DEFAULT abap_true
                      RETURNING VALUE(result) TYPE string_table.

split_to_lines

Method

Public

Splits string into lines.

Parameters

Name

Description

str

Source string

use_cr_lf

Explicit CRLF handling

result

Lines

Signature

METHODS split_to_lines IMPORTING str TYPE string
                                   use_cr_lf TYPE abap_bool DEFAULT abap_undefined
                         RETURNING VALUE(result) TYPE string_table.

trim

Method

Public

Trims whitespace from both ends.

Parameters

Name

Description

str

Source string

result

Trimmed string

Signature

METHODS trim IMPORTING str TYPE string
               RETURNING VALUE(result) TYPE string.

trim_start

Method

Public

Trims characters from start.

Parameters

Name

Description

str

Source string

chars

Characters to remove (default whitespace)

result

Trimmed string

Signature

METHODS trim_start IMPORTING str TYPE string
                               chars TYPE string OPTIONAL
                     RETURNING VALUE(result) TYPE string.

trim_end

Method

Public

Trims characters from end.

Parameters

Name

Description

str

Source string

chars

Characters to remove (default whitespace)

result

Trimmed string

Signature

METHODS trim_end IMPORTING str TYPE string
                             chars TYPE string OPTIONAL
                   RETURNING VALUE(result) TYPE string.

pad_left

Method

Public

Pads string on left to total length.

Parameters

Name

Description

str

Source string

total_len

Target total length

char

Padding character

result

Padded string

Signature

METHODS pad_left IMPORTING str TYPE string
                             total_len TYPE i
                             !char TYPE ty-char1
                   RETURNING VALUE(result) TYPE string.

pad_right

Method

Public

Pads string on right to total length.

Parameters

Name

Description

str

Source string

total_len

Target total length

char

Padding character

result

Padded string

Signature

METHODS pad_right IMPORTING str TYPE string
                              total_len TYPE i
                              !char TYPE ty-char1
                    RETURNING VALUE(result) TYPE string.

pad_both

Method

Public

Pads string on both sides to total length.

Parameters

Name

Description

str

Source string

total_len

Target total length

char

Padding character

result

Padded string

Signature

METHODS pad_both IMPORTING str TYPE string
                             total_len TYPE i
                             !char TYPE ty-char1
                   RETURNING VALUE(result) TYPE string.

join

Method

Public

Joins string table using separator.

Parameters

Name

Description

strs

Strings to join

sep

Separator string

result

Joined string

Signature

METHODS join IMPORTING strs TYPE string_table
                         sep TYPE string
               RETURNING VALUE(result) TYPE string.

any_to_string

Method

Public

Converts any value to string representation.

Parameters

Name

Description

any

Value to convert

format

Formatting mask

format_provider

External formatter

type

Explicit type descriptor

result

String representation

Signature

METHODS any_to_string IMPORTING !any TYPE any
                                  !format TYPE csequence OPTIONAL
                                  format_provider TYPE REF TO /ork/if_format_provider OPTIONAL
                                  !type TYPE REF TO cl_abap_datadescr OPTIONAL
                        RETURNING VALUE(result) TYPE string.

find

Method

Public

Finds all occurrences of pattern.

Parameters

Name

Description

str

Source string

pattern

Search pattern

case_sensitive

Case sensitive search

result

Match positions

Signature

METHODS find IMPORTING str TYPE string
                         !pattern TYPE string
                         case_sensitive TYPE abap_bool DEFAULT abap_true
               RETURNING VALUE(result) TYPE match_result_tab.

find_contains_any_gapless

Method

Public

Finds occurrences of any specified characters with gapless position handling.

Searches the source string for characters contained in the provided set. Match positions are normalized to a gapless coordinate system. Positions that fall into logical gaps are marked using the specified gap indicator.

Parameters

Name

Description

str

Source string to search

chars

Set of characters to match

gap_indicator

Value used to mark gap positions

result

Match positions in gapless representation

Signature

METHODS find_contains_any_gapless IMPORTING str TYPE string
                                              chars TYPE string
                                              gap_indicator TYPE i DEFAULT /ork/if_si_abap_string=>cm_default_gap_indicator
                                    RETURNING VALUE(result) TYPE match_result_tab.

find_contains_any

Method

Public

Finds occurrences of any specified characters.

Searches the source string for characters contained in the provided set. Each occurrence of any matching character is returned as a match position.

Parameters

Name

Description

str

Source string to search

chars

Set of characters to match

result

Match positions

Signature

METHODS find_contains_any IMPORTING str TYPE string
                                      chars TYPE string
                            RETURNING VALUE(result) TYPE match_result_tab.

find_first

Method

Public

Finds first occurrence of pattern.

Parameters

Name

Description

str

Source string

pattern

Search pattern

case_sensitive

Case sensitive search

result

First match position

Signature

METHODS find_first IMPORTING str TYPE string
                               !pattern TYPE string
                               case_sensitive TYPE abap_bool DEFAULT abap_true
                     RETURNING VALUE(result) TYPE match_result.

find_gapless

Method

Public

Finds all occurrences of pattern with gapless position handling.

Searches the source string for the specified pattern. Match positions are normalized to a gapless coordinate system. Positions that fall into logical gaps are marked using the specified gap indicator.

Parameters

Name

Description

str

Source string to search

pattern

Search pattern

gap_indicator

Value used to mark gap positions

case_sensitive

Case sensitive search

result

Match positions in gapless representation

Signature

METHODS find_gapless IMPORTING str TYPE string
                                 !pattern TYPE string
                                 gap_indicator TYPE i DEFAULT /ork/if_si_abap_string=>cm_default_gap_indicator
                                 case_sensitive TYPE abap_bool DEFAULT abap_true
                       RETURNING VALUE(result) TYPE match_result_tab.

find_regex

Method

Public

Regex search returning match positions.

Parameters

Name

Description

str

Source string

pattern

Regular expression

case_sensitive

Case sensitive matching

result

Match positions

Signature

METHODS find_regex IMPORTING str TYPE string
                               !pattern TYPE string
                               case_sensitive TYPE abap_bool DEFAULT abap_true
                     RETURNING VALUE(result) TYPE match_result_tab.

find_regex_first

Method

Public

Regex search returning first match.

Parameters

Name

Description

str

Source string

pattern

Regular expression

case_sensitive

Case sensitive matching

result

First match position

Signature

METHODS find_regex_first IMPORTING str TYPE string
                                     !pattern TYPE string
                                     case_sensitive TYPE abap_bool DEFAULT abap_true
                           RETURNING VALUE(result) TYPE match_result.

find_regex_gapless

Method

Public

Performs regular expression search with gapless position handling.

Matches are determined using the specified regular expression. The resulting match positions are normalized to a gapless coordinate system. Positions that correspond to logical gaps are marked using the specified gap indicator.

Parameters

Name

Description

str

Source string to search

pattern

Regular expression pattern

gap_indicator

Value used to mark gap positions

case_sensitive

Case sensitive matching

result

Match positions in gapless representation

Signature

METHODS find_regex_gapless IMPORTING str TYPE string
                                       !pattern TYPE string
                                       gap_indicator TYPE i DEFAULT /ork/if_si_abap_string=>cm_default_gap_indicator
                                       case_sensitive TYPE abap_bool DEFAULT abap_true
                             RETURNING VALUE(result) TYPE match_result_tab.

find_begin_of_line

Method

Public

Returns offset of line start for given offset.

Parameters

Name

Description

str

Multiline text

offset

Absolute offset

result

Offset of line start

Signature

METHODS find_begin_of_line IMPORTING str TYPE string
                                       !offset TYPE i
                             RETURNING VALUE(result) TYPE i.

match_result_to_gapless

Method

Public

Converts match positions into gapless representation.

Transforms match results so that their offsets refer to a logical gapless coordinate system. Positions that fall into gaps or cannot be mapped are marked using the specified gap indicator.

This method is typically used after performing searches on text that contains removed or ignored segments which must not contribute to positional indexing.

Parameters

Name

Description

match_tab

Original match result table

text_len

Length of the original text used as positional reference

gap_indicator

Value used to mark gap positions

result

Match results normalized to gapless representation

Signature

METHODS match_result_to_gapless IMPORTING match_tab TYPE match_result_tab
                                            text_len TYPE i
                                            gap_indicator TYPE i DEFAULT /ork/if_si_abap_string=>cm_default_gap_indicator
                                  RETURNING VALUE(result) TYPE match_result_tab.

match_regex

Method

Public

Returns substrings matching regex.

Parameters

Name

Description

str

Source string

pattern

Regular expression

case_sensitive

Case sensitive matching

result

Matched substrings

Signature

METHODS match_regex IMPORTING str TYPE string
                                !pattern TYPE string
                                case_sensitive TYPE abap_bool DEFAULT abap_true
                      RETURNING VALUE(result) TYPE string_table.

index_of

Method

Public

Finds index of substring.

Parameters

Name

Description

str

Source string

search_str

Substring to search

ignore_case

Case insensitive search

start_index

Start search index

length

Search length (-1 = full string)

find_last

Search from end

result

Found index or negative if not found

Signature

METHODS index_of IMPORTING str TYPE string
                             search_str TYPE string
                             ignore_case TYPE abap_bool DEFAULT abap_false
                             start_index TYPE i DEFAULT 0
                             !length TYPE i DEFAULT -1
                             find_last TYPE abap_bool DEFAULT abap_false
                   RETURNING VALUE(result) TYPE i.

replace

Method

Public

Replaces first occurrence of substring.

Parameters

Name

Description

str

Source string

search_str

Substring to replace

replace_str

Replacement text

ignore_case

Case insensitive replacement

result

Modified string

Signature

METHODS replace IMPORTING str TYPE string
                            search_str TYPE string
                            replace_str TYPE string
                            ignore_case TYPE abap_bool DEFAULT abap_false
                  RETURNING VALUE(result) TYPE string.

replace_all

Method

Public

Replaces all occurrences of substring.

Parameters

Name

Description

str

Source string

search_str

Substring to replace

replace_str

Replacement text

ignore_case

Case insensitive replacement

result

Modified string

Signature

METHODS replace_all IMPORTING str TYPE string
                                search_str TYPE string
                                replace_str TYPE string
                                ignore_case TYPE abap_bool DEFAULT abap_false
                      RETURNING VALUE(result) TYPE string.

starts_with

Method

Public

Checks whether string starts with substring.

Parameters

Name

Description

str

Source string

sub

Prefix to test

ignore_case

Case insensitive comparison

result

abap_true if prefix matches

Signature

METHODS starts_with IMPORTING str TYPE string
                                sub TYPE string
                                ignore_case TYPE abap_bool DEFAULT abap_false
                      RETURNING VALUE(result) TYPE abap_bool.

ends_with

Method

Public

Checks whether string ends with substring.

Parameters

Name

Description

str

Source string

sub

Suffix to test

ignore_case

Case insensitive comparison

result

abap_true if suffix matches

Signature

METHODS ends_with
    IMPORTING str TYPE string
              sub TYPE string
              ignore_case TYPE abap_bool DEFAULT abap_false
    RETURNING VALUE(result) TYPE abap_bool.

get_line_offset

Method

Public

Returns offset within current line.

Parameters

Name

Description

text

Multiline text

offset

Absolute offset

result

Offset within line

Signature

METHODS get_line_offset IMPORTING !text TYPE string
                                    !offset TYPE i
                          RETURNING VALUE(result) TYPE i.

get_line_number

Method

Public

Returns line number for offset.

Parameters

Name

Description

text

Multiline text

offset

Absolute offset

result

Line number (1-based)

Signature

METHODS get_line_number IMPORTING !text TYPE string
                                    !offset TYPE i
                          RETURNING VALUE(result) TYPE i.

get_line_pos

Method

Public

Provides information about the line number and position in the respective line for a position in the text

Parameters

Name

Description

text

Multiline text

offset

Absolute offset

result

Line and position information

Signature

METHODS get_line_pos IMPORTING !text TYPE string
                                 !offset TYPE i
                       RETURNING VALUE(result) TYPE /ork/if_si_abap_string=>ty_s_line_pos.

char_from_unicode

Method

Public

Returns character for Unicode code point.

Parameters

Name

Description

uccp

Unicode code point

result

Character string

Signature

METHODS char_from_unicode IMPORTING uccp TYPE i
                            RETURNING VALUE(result) TYPE string.

char_to_unicode

Method

Public

Returns Unicode code point for character.

Parameters

Name

Description

char

Character string

length

Character length

result

Unicode code point

Signature

METHODS char_to_unicode
    IMPORTING !char TYPE csequence
    EXPORTING !length TYPE i
    RETURNING VALUE(result) TYPE i.

8 items

Types

ty_ta

Type

Public

Generic table types for string collections.

Signature

TYPES ty_ta TYPE ANY TABLE OF string.

ty_tt

Type

Public

Signature

TYPES ty_tt TYPE STANDARD TABLE OF string WITH EMPTY KEY.

ty_th

Type

Public

Signature

TYPES ty_th TYPE HASHED TABLE OF string WITH UNIQUE KEY table_line.

ty_ts

Type

Public

Signature

TYPES ty_ts TYPE SORTED TABLE OF string WITH NON-UNIQUE KEY table_line.

ty_t_range

Type

Public

Range types for string values.

Signature

TYPES ty_t_range TYPE RANGE OF string.

ty_s_range

Type

Public

Signature

TYPES ty_s_range TYPE LINE OF ty_t_range.

Type

Public

Signature

TYPES: BEGIN OF ty,
           char1 TYPE c LENGTH 1,
           char2 TYPE c LENGTH 2,
           char3 TYPE c LENGTH 3,
         END OF ty.

ty_s_line_pos

Type

Public

Information about the line number and position

... in the respective line

Signature

BEGIN OF ty_s_line_pos,
      "! Line number, 1-based
      line TYPE i,
      "! Position within the line, 0-based
      pos TYPE i,
    END OF ty_s_line_pos.

1 item

Constants

cm_default_gap_indicator

Constant

Public

Default indicator for gap positions used by gapless matching.

Signature

CONSTANTS cm_default_gap_indicator TYPE i VALUE -999999 ##NO_TEXT.

1 item

Data

Public

Predicate helper interface providing classification checks.

Signature

DATA is TYPE REF TO /ork/if_si_abap_string_is READ-ONLY.

Repository

11 packages · 113 objects

124 items