ABAP offers plenty of options for processing character strings.
The options include ABAP statements (e. g. FIND
),
character string expressions
(concatenations and string templates)
and built-in string functions
(e. g. strlen
).
💡 Note
- Compared to statements, expressions and string functions can help make your ABAP code more concise and straightforward. For example, string operations can be done directly in operand position and, thus, you can avoid temporary variables.
- In ABAP statements, modification operations on strings are frequently done in read/write positions, meaning that the source field and the target fields of an operation are the same. When working with string functions, the source field is passed as an input parameter and the modified value is returned as a return value, meaning that the function itself does not modify the source field. Of course, you can assign the function to the source field to achieve its modification.
- In most cases, string functions offer the same functionality as the corresponding ABAP statements or even more. The return value of string functions that return character strings is always of type
string
.
ABAP mainly offers the following built-in data types for data objects that contain character strings. They can be distinguished as follows:
Type | Details | Length | Value Range | Initial Value |
---|---|---|---|---|
string |
For variable length character strings. Data objects of this type are dynamic data objects, i. e. the length of a variable can change during the execution of an ABAP program and thus it can contain character strings of different lengths. A data object of type string is called text string or, in short, just string. |
No standard length; length is variable | Any Unicode characters that can be encoded in ABAP language's code page UCS-2. The most common content are alphanumeric characters or special characters. | Empty string with length 0 |
c |
For fixed length character strings. Data objects of this type are static data objects, i. e. the length of a variable must be defined during its declaration and does not change during the execution of an ABAP program. Thus, it always contains character strings of the same length. A data object of type c is called text field. |
Data objects of this type can contain a string of fixed length (between 1 and 262143 characters); standard length: 1 | Same as for string |
A blank for each position |
Besides these main data types for character strings, there are some other fixed length data types with special meanings:
n
for fixed length numerical character strings
d
and t
for date and time fields
These data types are not covered further in this cheat sheet. The same is true for the byte-like data types x
and xstring
that are closely related to c
and string
but contain raw byte strings.
⚡ Differences between text strings (variable length) and text fields (fixed length)
- Initial value: The initial value of a text string is an empty string with length 0. A text field's initial value is represented by blanks for each position.
- Internal representation: Data objects of type
c
andstring
are both elementary data objects. However, while text fields occupy a block of memory according to their length, text strings are so-called deep data objects. Internally, they are managed by a reference that points to the actual character. This fact has restricting consequences for using strings as components of structures but can also boost the performance of assignments because of the concept of sharing of deep data objects.- Length: Theoretically, a text string can use up to 2 GB (one character occupies 2 bytes). The maximum length of a text field is 262143 characters.
- Trailing blanks: For text strings, trailing blanks are preserved in all operations. For text fields, it depends on the operand position whether trailing blanks are respected or not. In most operand positions, trailing blanks are truncated when working with text fields, even when using text field literals. For example, if a text field is assigned to a text string, the resulting target string never contains any trailing blanks. Note in this context the section Condensing Strings.
- Flexibility: Text strings are more flexible than text fields because you can easily shorten or extend them without worrying that, for example, parts of the character string are truncated when processing. On the other hand, when accessing substrings of a string, you must take care that the string is long enough, while for text fields you always know their length.
So, when to actually use what? Text fields make sense when actually determining a maximum or mandatory length, e. g. a country code that must consist of a maximum of two characters or input fields in forms that should not exceed a certain length. If restricting a string is not relevant, text strings are a good choice.
For working with character strings, you need character-like data objects, that are based on the above mentioned character-like types.
The simplest way of producing text in an ABAP program are character literals.
The following code snippet shows a global class implementing the interface if_oo_adt_classrun
. Using the write
method, you can display output in the ADT console. In the example, two untyped literals without a dedicated name (unnamed data object) are included. In the case below, the data type of the character literals are defined by the delimiters.
Text string literals are enclosed in backquotes (`...`
) and have the data type string
. Text field literals are enclosed in single quotes ('...'
) and have the data type c
. The literals can be (but should not according to the programming guidelines on literals (F1 docu for standard ABAP)) used like constants of these types in operand positions. They should be only used for start values when declaring named data objects.
CLASS zcl_some_test_class DEFINITION PUBLIC FINAL CREATE PUBLIC.
PUBLIC SECTION.
INTERFACES if_oo_adt_classrun.
ENDCLASS.
CLASS zcl_some_test_class IMPLEMENTATION.
METHOD if_oo_adt_classrun~main.
out->write( `I am a text string literal` ). "text string literal of type string
out->write( 'I am a text field literal' ). "text field literal of type c
ENDMETHOD.
ENDCLASS.
Named character-like data types and objects can be declared like other types and objects using TYPES
, DATA
CONSTANTS
and by referring to a character-like data type.
Furthermore, character-like data objects can be declared inline with the operators DATA
and, in newer ABAP releases, FINAL
as shown further down.
Syntax examples:
"Type declarations using built-in types
TYPES: c_type TYPE c LENGTH 3, "Explicit length specification
str_type TYPE string.
"Data object declarations using built-in, local and DDIC types
DATA: flag TYPE c LENGTH 1, "Built-in type
str1 TYPE string, "Built-in type
char1 TYPE c_type, "Local type
str2 LIKE str1, "Deriving type from a local data object
str3 TYPE str_type, "Local type
char2 TYPE s_toairp, "DDIC type (used e. g. for a field in a demo table)
char3 TYPE zdemo_abap_flsch-carrid. "Using the type of a DDIC table component
"You might also stumble upon declarations with type c and the length
"specified in parentheses. It is not recommended so as not to confuse
"with the use of parentheses in dynamic programming.
DATA char(4) TYPE c.
"Just a TYPE c specification without length means LENGTH 1.
DATA char_len_one TYPE c.
When declaring character-like data objects, you can directly provide
start values. For the assignment of values, you can, for example, use
the assignment operator
=
.
As mentioned above, character-like data objects can be declared inline with the operators DATA
or, in newer ABAP releases, FINAL
. You can use the operators at many write positions. Compared to the VALUE
addition of the declaration statements, inline declarations allow you to declare variables for results of expressions or in other positions where character strings are returned.
In the case below, a variable specified in parentheses preceded by
DATA
(or FINAL
) on the left side of the assignment operator automatically
derives a data type from the operand on the right. This helps make your
programs leaner.
Syntax examples:
"Data object declarations including default values with VALUE
DATA: flag TYPE c LENGTH 1 VALUE 'X',
str1 TYPE string VALUE `Hallo!`.
"Examples for type n
DATA zip_code TYPE n LENGTH 5 VALUE '12345'.
DATA isbn_number TYPE n LENGTH 13 VALUE '1234567890123'.
"Constant; content cannot be changed at runtime
CONSTANTS pi TYPE p LENGTH 8 DECIMALS 14 VALUE '3.14159265358979'.
"More data object declarations
DATA: char1 TYPE c LENGTH 5,
html TYPE string,
str2 LIKE html.
"Value assignments
char1 = 'ab123'.
html = `<p>hallo</p>`.
"Escaping backquotes in text string literals with another one
str1 = `This is a backquote: ``.`.
"If possible, avoid unnecessary type conversion; in principle, every
"convertible type can be specified
str2 = 'abc'. "Fixed length string assigned to data object of type string
DATA str3 TYPE string VALUE 'X'. "type c length 1
DATA str4 TYPE string VALUE -1. "type i
"Inline declarations
DATA(char2) = 'abcd'. "Type c length 4
DATA(str5) = `efgh`.
"In newer ABAP releases, you can use FINAL to create immutable variables.
FINAL(final_string) = `zyx`.
"Since char2 is of type c length 4 (the length is also derived),
"characters are truncated in the following example assignment
char2 = 'ijklmnopq'. "ijkl
"Trailing blanks after assigning fixed length to variable length string
DATA(char3) = 'ab '.
DATA(str6) = `cdefgh`.
str6 = char3. "'ab' (trailing blanks are not respected due to conversion rule)
When assigning strings, not only data objects can be placed on the right
side. Various expressions and strings can be chained using the
concatenation
operator
&&
. Alternatively, you might chain strings using string
templates
and as outlined in the section Concatenating Strings.
str5 = str3 && ` ` && str4 && `!`. "X 1-!
"Note the output for str4 that includes the conversion of type i to
"string above demonstrating a possibly inadvertent specification
"of an integer value for str4 that is of type string.
Note that there is also the literal
operator
&
that joins text string
literals,
however, with significant
differences
to &&
.
Using string templates, you can construct strings very elegantly from
literal text and - which is the primary use case - by also including
embedded ABAP
expression
within a pair of delimiter characters: |...|
if these expressions can be converted to string
. To embed expressions, you include them within curly brackets: { ... }
.
💡 Note
String templates form a string expression that is compiled at runtime. Hence, a string template that only contains literal text is handled like an expression which has impact on the performance. In such a case, using a text string literal with backquotes is preferable.
Syntax examples:
"Value assignment with string templates
"The expression must be convertible to a string. A blank (not within the curly brackets)
"means a blank in the resulting string.
DATA(s1) = |Hallo { cl_abap_context_info=>get_user_technical_name( ) }!|.
DATA(s2) = `How are you?`. "Literal text only with backquotes
DATA(s3) = |{ s1 } { s2 }|. "Hallo NAME! How are you?
"Chaining of string templates using &&
DATA(s4) = |{ s1 }| && ` ` && |{ s2 }|. "Hallo NAME! How are you?
String templates interpret certain character combinations as control
characters.
For example, \n
is interpreted as line feed. A new line is
set. Plus, string templates support various formatting
options.
Check the ABAP Keyword Documentation for all options.
Syntax examples:
"Control characters
s4 = |{ s1 }\n{ s2 }\nSee you.|. "\n is interpreted as a line feed
"Various formatting options
"Time and date
"Formatting according to the user master data
DATA(d) = |The date is { cl_abap_context_info=>get_system_date( ) DATE = USER }.|.
"Formatting in accordance with ISO 8601
DATA(tm) = |The time is { cl_abap_context_info=>get_system_time( ) TIME = ISO }.|.
"Formatting to UTC; date and time are represented in ISO 8601
DATA(ts) = |Timestamp: { utclong_current( ) TIMESTAMP = SPACE }.|.
"Lowercase and uppercase
s1 = |AbCdEfG|.
s2 = |{ s1 CASE = LOWER }|. "abcdefg
s2 = |{ s1 CASE = UPPER }|. "ABCDEFG
"Width and alignment
s1 = `##`.
s2 = |{ s1 WIDTH = 10 ALIGN = LEFT }<---|. "'## <---'
s2 = |{ s1 WIDTH = 10 ALIGN = CENTER }<---|. "' ## <---'
"PAD: Used to pad any surplus places in the result with the specified character.
s2 = |{ s1 WIDTH = 10 ALIGN = RIGHT PAD = `.` }<---|. "'........##<---'
"Numbers
s1 = |{ CONV decfloat34( - 1 / 3 ) DECIMALS = 3 }|. "'-0.333'
💡 Note
Escape\|{}
in string templates using\
, i. e.\\
means\
.
To determine the length of a string you can use the string function
strlen
.
Note that the result depends on the type of the string, i. e. the result
for a data object of type string
includes trailing blanks. A
fixed length string does not include them. To exclude trailing blanks in
all cases irrespective of the data type, you can use the built-in
function
numofchar
.
Syntax examples:
"strlen
DATA(len_c) = strlen( 'abc ' ). "3
DATA(len_str) = strlen( `abc ` ). "6
"numofchar
len_c = numofchar( 'abc ' ). "3
len_str = numofchar( `abc ` ). "3
Two or more strings can be concatenated using the concatenation operator
&&
and string templates. Alternatively, you can use
CONCATENATE
statements. It is also possible to concatenate lines of internal tables
into a string to avoid a loop. In a more modern way, you can make use of
the string function
concat_lines_of
.
Syntax examples:
"&& and string template
s1 = `AB` && `AP`. "ABAP
s2 = `ab` && `ap` && ` ` && s1. "abap ABAP
s3 = |{ s1 }. { s2 }!|. "ABAP. abap ABAP!
"CONCATENATE statements
CONCATENATE s1 s2 INTO s3. "ABAPabap ABAP
"Multiple data objects and target declared inline
CONCATENATE s1 ` ` s2 INTO DATA(s5). "ABAP abap ABAP
CONCATENATE s1 s2 s5 INTO DATA(s6). "ABAPabap ABAPABAP abap ABAP
"You can also add a separation sign using the addition SEPARATED BY
CONCATENATE s1 s2 INTO s3 SEPARATED BY ` `. "ABAP abap ABAP
CONCATENATE s1 s2 INTO s3 SEPARATED BY `#`. "ABAP#abap ABAP
"Keeping trailing blanks in the result when concatenating fixed length
"strings. The ones of variable length strings are respected by default.
CONCATENATE 'a ' 'b ' 'c ' INTO DATA(ch) RESPECTING BLANKS. "'a b c '
"Concatenating lines of internal tables into a string
CONCATENATE LINES OF itab INTO t SEPARATED BY ` `.
"Using concat_lines_of
s1 = concat_lines_of( table = itab ). "Without separator
s1 = concat_lines_of( table = itab sep = ` ` ). "With separator
You can use
SPLIT
statements to split strings in multiple segments. The result of the
splitting can be stored in separate data objects or internal tables that
have a character-like line type. Note that if the specified targets are
fewer than the segments retrieved by the splitting, the last target is
given the rest of the segments that have not yet been split. If there
are more targets specified, the targets not given a segment are
initialized. Hence, specifying individual targets with SPLIT
statements is useful if the number of expected segments is known.
Otherwise, splitting into tables is a good choice.
If you want to get the value of a specific segment, you can use the
string function
segment
.
Syntax examples:
s1 = `Hallo,world,123`.
SPLIT s1 AT `,` INTO s2 s3 s4. "s2 = Hallo / s3 = world / s4 = 123
"Less data objects than possible splittings
SPLIT s1 AT `,` INTO s2 s3. "s2 = Hallo / s3 = world,123
"Splitting into internal table
DATA itab TYPE TABLE OF string.
SPLIT s1 AT ',' INTO TABLE itab. "Strings are added to itab in individual lines without comma
"String function segment returning the occurrence of a segment
"index parameter: number of segment
s2 = segment( val = s1 index = 2 sep = `,` ). "world
Transforming to Lowercase and Uppercase
The string functions
to_lower
and
to_upper
transform characters of a string to either lowercase or uppercase and
store the result in a target variable. If the transformation should be
applied to the source directly, you can use
TRANSLATE
statements.
Syntax examples:
"String functions
s1 = to_upper( `abap` ). "ABAP
s1 = to_lower( `SOME_FILE.Txt` ). "some_file.txt
"TRANSLATE statements
s1 = `Hallo`.
TRANSLATE s1 TO UPPER CASE. "HALLO
TRANSLATE s1 TO LOWER CASE. "hallo
Shifting Content
You can shift content within a string to a specific position on the left
or right of a string.
SHIFT
statements have different additions for specific use cases.
In a more modern way, you can use the string functions
shift_left
and
shift_right
that store the result in a variable. These functions offer an additional
functionality. The sub
parameter can be used to specify a
substring. All substrings in the string that match the specified value
in sub
either on the left or right side of the string are
removed.
Syntax examples:
"SHIFT statements
"Note that all results below refer to s1 = `hallo`.
s1 = `hallo`. "Type string
SHIFT s1. "No addition; string shifted one place to the left: allo
SHIFT s1 BY 2 PLACES. "Without direction, left by default: llo
SHIFT s1 BY 3 PLACES RIGHT. "With direction, variable length strings are extended: ' hallo'
"Note that all results below refer to ch4 = 'hallo'.
DATA(ch4) = 'hallo'. "Type c length 5
SHIFT ch4 BY 3 PLACES RIGHT. "Fixed length string: ' ha'
"CIRCULAR addition: characters that are moved out of the string are
"added at the other end again
SHIFT ch4 BY 3 PLACES LEFT CIRCULAR. "lohal
SHIFT ch4 UP TO `ll`. "Shift characters up to a specific character set: llo
"Deleting leading and trailing characters
s2 = ` hallo `.
s3 = s2.
SHIFT s2 LEFT DELETING LEADING ` `. "'hallo '
SHIFT s3 RIGHT DELETING TRAILING ` `. "' hallo' (length is kept)
"Removing trailing blanks in strings without leading blanks;
"you can use the following sequence of statements
s4 = `hallo `.
SHIFT s4 RIGHT DELETING TRAILING ` `. "' hallo'
SHIFT s4 LEFT DELETING LEADING ` `. "'hallo'
"String functions with parameters
s1 = `hallo`.
s2 = shift_left( val = s1 places = 3 ). "lo
s2 = shift_left( val = s1 circular = 2 ). "lloha
"Note that shift_right does not extend a variable length string.
s2 = shift_right( val = s1 places = 3 ). "ha
s2 = shift_right( val = `abc ` sub = ` ` ). "'abc'
s2 = shift_right( val = `abc ` ). "'abc' (same result as above)
Condensing Strings
You can use
CONDENSE
statements or the string function
condense
to remove blanks in strings. The advantage of using the string function
is that you can also specify any characters to be removed and not only
blanks.
Syntax examples:
"CONDENSE statements
s1 = ` ab cd `.
s2 = ` ef gh ij `.
s3 = ` kl mn op `.
CONDENSE s1. "Trailing and leading blanks are removed: 'ab cd'
CONDENSE s2. "It also replaces sequences of multiple blanks with a single blank: 'ef gh ij'
CONDENSE s3 NO-GAPS. "Removes all blanks: 'klmnop'
"String function condense
s1 = ` ab cd `.
"No parameters specified, i. e. their default values are provided.
"Works like CONDENSE statement without the NO-GAPS addition.
s2 = condense( s1 ). "ab cd
"Parameters del/to not specified. from parameter with initial string
"(could also be a text field literal: from = ' '). This way, leading and
"trailing blanks are removed.
s2 = condense( val = s1 from = `` ). "ab cd
"Parameter to specified with an initial string. No other parameters.
"Works like CONDENSE statement with the NO-GAPS addition.
s2 = condense( val = s1 to = `` ). "abcd
"Parameter del specifies the leading/trailing characters to be removed.
s2 = condense( val = `##see###you##` del = `#` ). "see###you
"If from and to are specified along with del, leading/trailing
"characters specified in del are first removed. Then, in the remaining string, all
"substrings composed of characters specified in from are replaced with
"the first character of the string specified in the to parameter
s2 = condense( val = ` Rock'xxx'Roller`
del = `re `
from = `x`
to = `n` ). "Rock'n'Roll
Reversing Strings
The string function
reverse
reverses a string:
"Result: 'abap'
s1 = reverse( `paba` ).
Inserting Content
The string function
insert
inserts a substring into any position within a given string. Using
various parameters, you can construct your desired string:
val
: Original string.sub
: Substring.off
: Optionally sets the offset, i. e. the position where to add the substring. The default value is 0. When using the function with the default value, the result is like concatenating a string with &&
(like res = sub && text
).Syntax examples:
"Result: 'abcdefghi'
s1 = insert( val = `abcghi` sub = `def` off = 3 ).
"Result: 'defabcghi'
s1 = insert( val = `abcghi` sub = `def` ).
Using the string function
substring
,
you can specify the position (parameter off
) and the length
(len
) of a substring that should be extracted from a given
string (val
). At least one of the two parameters off
or len
must be specified. The default value of off
is 0, i. e. when using the default value, the substring is extracted
from the beginning of the string. Not specifying len
means
that the rest of the remaining characters are respected. If the offset
and length are greater than the actual length of the string, the
exception CX_SY_RANGE_OUT_OF_BOUNDS
is raised.
You might also stumble on the syntax for accessing substrings via offset
and length specification using the +
character after a variable. Here, the
length is specified within parentheses. Providing an asterisk (*
) means
that the rest of the remaining string is respected. This syntax option
even enables write access on substrings for fixed length strings. Read
access is possible for both fixed length and variable length strings.
However, this syntax might be confused with the use of tokens in the
context of dynamic programming.
There are further string functions available to deal with substrings,
for example,
substring_after
,
substring_before
,
substring_from
and
substring_to
.
These functions offer more options in terms of parameters, for example, using PCRE regular expressions, which are dealt with further down.
Syntax examples:
s1 = `Lorem ipsum dolor sit amet`. "Type string
"Extracting substring starting at a specific position
"'len' not specified means the rest of the remaining characters are
"respected
s2 = substring( val = s1 off = 6 ). "ipsum dolor sit amet
"Extracting substring with a specific length
"'off' is not specified and has the default value 0.
s2 = substring( val = s1 len = 5 ). "Lorem
"Specifying both off and len parameters
s2 = substring( val = s1 off = 6 len = 5 ). "ipsum
DATA(txt) = 'Lorem ipsum dolor sit amet'. "Type c
"Offset and length specification using the + sign after a variable
DATA(ch6) = txt+0(5). "Lorem
"* means respecting the rest of the remaining string
DATA(ch7) = txt+12(*). "dolor sit amet
CLEAR txt+11(*). "Lorem ipsum
txt+0(5) = 'Hallo'. "Hallo ipsum dolor sit amet
"Further string functions
s1 = `aa1bb2aa3bb4`.
"Extracting a substring ...
"... after a specified substring
s2 = substring_after( val = s1 sub = `aa` ). "1bb2aa3bb4 (only the first occurrence is respected)
"... after a specified substring specifying the occurence in a string
"and restricting the length
s2 = substring_after( val = s1 sub = `aA` occ = 2 len = 4 case = abap_false ). "3bb4
"... before a specified substring
s2 = substring_before( val = s1 sub = `b2` ). "aa1b
"... from a specified substring on. It includes the substring specified
"in sub. len/off and other parameters are possible.
s2 = substring_from( val = s1 sub = `a3` ). "a3bb4
"... up to a specified substring. It includes the substring specified
"in sub. len/off and other parameters are possible.
s2 = substring_to( val = s1 sub = `3b` ). "aa1bb2aa3b
In ABAP, there are a lot of options to carry out search and replace
operations with strings. This includes the use of comparison
operators
or the prominent ABAP statements
FIND
and
REPLACE
,
or the more modern built-in string functions
find
and
replace
,
among others, with their considerable amount of additions or parameters
respectively. Many of these options support rather simple operations
with respect to only single characters or more complex, pattern-based
operations on character sequences using PCRE regular
expressions.
CA
(contains any) or its negation
NA
(contains not any) in comparison
expressions
to determine if any character of a given character set is contained
in a string. Such an expression is true if at least one character is
found.
sy-fdpos
contains the offset of
the first found character. If nothing is found,
sy-fdpos
contains the length of the string.find_any_of
or its negation
find_any_not_of
return the offset of the occurrence of any character contained in a
substring.
occ
determines the search
direction, i. e. a positive value means the search is performed
from left to right. A negative value means searching from right
to left.count_any_of
or its negation
count_any_not_of
.CO
(contains only) or its negation
CN
(contains not only) in comparison expressions.
CO
, a comparison is true if the left operand
only contains characters that are also contained in the right
operand. If the comparison returns false, you can get the position
of the first character from text that is not contained in the
character set via sy-fdpos
. Regarding CN
, a
comparison is true if a string not only contains characters from
the character set.Syntax examples:
s1 = `cheers`.
IF s1 CA `aeiou` ... "true, sy-fdpos = 2
IF s1 NA `xyz`... "true, sy-fdpos = 6
s2 = find_any_of( val = s1 sub = `aeiou` ). "2
s2 = find_any_not_of( val = s1 sub = `c` ). "1
s2 = count_any_of( val = s1 sub = `e` ). "2
s2 = count_any_not_of( val = s1 sub = `s` ). "5
IF s1 CO `rs` ... "false, sy-fdpos = 0
IF s1 CN `cheers` ... "false, sy-fdpos = 6
You can use the string function
translate
to replace specific characters by others. Here, the parameter
from
denotes the characters to be placed in a string and
to
specifies the target characters. Note: The
replacement is done as follows: Each character specified in
from
is replaced by the character in to
that is on
the same position, i. e. the second character in from
is
replaced by the second character specified in to
. If there is
no equivalent in to
, the character in from
is
removed from the result.
Using
TRANSLATE
statements, you can carry out replacements directly on the source field.
Syntax examples:
s1 = `___abc_def_____ghi_`.
s2 = translate( val = s1 from = `hi_` to = `##` ). "abcdefg##
s2 = translate( val = s1 from = `_` to = `##` ). "###abc#def#####ghi#
"TRANSLATE statement. The value after USING is interpreted as a string composed of character pairs.
"Starting with the first pair, a search is performed in text for the
"first character in every pair and each occurrence is replaced with the
"second character of the pair.
TRANSLATE s1 USING `_.a#g+`. "...#bc.def.....+hi.
CS
(contains string) or its negation
NS
(contains no string) in comparison
expressions.
Here, the search is not case-sensitive. The system variable
sy-fdpos
contains the offset of the found substring. If
the substring is not found, sy-fdpos
contains the length
of the searched string.FIND
statements or the string function
find
.
If you are only interested in the offset of a substring within a
string, the string function offers more options than using the
logical operator, for example, you can specify if the search should
be case-sensitive or not. You can also further restrict the search
using parameters.count
.
Special variants are available:
count_any_of
,
count_any_not_of
.find
is derived from the ABAP
statement FIND
, FIND
covers the same
functionality as mentioned above and beyond using the many addition
options.Syntax examples:
s3 = `cheers`.
IF s3 CS `rs` ... "true, sy-fdpos = 4
IF s3 NA `xyz`... "false, sy-fdpos = 6
"String function find
s1 = `Pieces of cakes.`.
s2 = find( val = s1 sub = `OF` case = abap_false ). "7
s2 = find( val = s1 sub = `hallo` ). "-1 (no occurrence returns -1)
s2 = find( val = s1 sub = `ce` off = 1 len = 7 ). "3
"Parameter occ: Positive value means the nth position from the left,
"a negative value the nth position from the right
s2 = find( val = s1 sub = `es` occ = -1 ). "13
"String function count
s2 = count( val = s1 sub = `es` ). "2
"FIND statements with selected additions
s1 = `abc def ghi abc`.
FIND `def` IN s1.
IF sy-subrc = 0. "If there is an occurrence, sy-subrc is set to 0.
... "Some action
ENDIF.
"Addition SUBSTRING is optional; same as above
FIND SUBSTRING `abc` IN s1.
"Case-insensitive search; same as above
FIND `aBC` IN s1 IGNORING CASE.
"Case-sensitive search; here, sy-subrc is 4 since `aBC` is not found
FIND `aBC` IN s1 RESPECTING CASE.
"MATCH additions can be specified individually or combined
"All occurrences
FIND ALL OCCURRENCES OF `abc` IN s1
MATCH COUNT DATA(fcnt). "2 (number of occurrences)
"Finding the first occurrence
FIND FIRST OCCURRENCE OF `abc` IN s1
MATCH OFFSET DATA(foff) "0
MATCH LENGTH DATA(flen). "3
"All occurrences
FIND ALL OCCURRENCES OF `abc` IN s1
MATCH COUNT DATA(fcnt2) "2 (number of occurrences)
MATCH OFFSET DATA(foff2) "12 (Note: offset of last occurrence only)
MATCH LENGTH DATA(flen2). "3 (Note: length of last occurrence only)
"Returning offset/length information in a table for all occurrences
"The internal table following the RESULTS keyword includes more information
"as shown further down.
FIND ALL OCCURRENCES OF `abc` IN s1 RESULTS DATA(fres).
"Restricting the search area (OFFSET/LENGTH can be specified individually)
FIND `abc` IN SECTION OFFSET 4 LENGTH 11 OF s1
MATCH OFFSET foff. "12
"Searching in internal tables; search results are returned in an internal table.
"Here, the search is case-sensitive.
DATA(str_table) = VALUE string_table( ( `ZxZ` ) ( `yZ` ) ( `Zz` ) ).
FIND ALL OCCURRENCES OF `Z` IN TABLE str_table RESULTS
DATA(findings) RESPECTING CASE.
Using the string function
replace
,
you can store the result of a substring replacement in a separate
variable. What makes it very powerful in particular is the fact that it
returns a value and can, thus, be used in almost all read
positions.
Using
REPLACE
statements, you can carry out replacements on strings directly
(including substrings, which is not possible with the string function).
Regarding the multiple additions REPLACE
offers,
REPLACE
is syntactically similar to FIND
. Regarding
the parameters of replace
:
with
: The replacement text.sub
: Specifies the substring to be replaced.case
: Sets the case sensitivity.occ
: Specifies the number of occurrences of a substring. The default value is 1
, i. e. the first occurrence starting from the left. Setting occ
to 0
means that all occurrences are respected for the replacement.Syntax examples:
s1 = `abc def ghi abc`.
s2 = replace( val = s1 sub = `def` with = `###` ). "abc ### ghi abc
s2 = replace( val = s1 sub = `ABC` with = `###` case = abap_false occ = 2 ). "abc def ghi ###
s2 = replace( val = s1 sub = `abc` with = `###` occ = 0 ). "### def ghi ###
"REPLACE statements with selected additions
"Note that all results below refer to s1 = `abc def ghi abc`.
REPLACE `def` IN s1 WITH `###`. "abc ### ghi abc
REPLACE FIRST OCCURRENCE OF `abc` IN s1 WITH `###`. "### def ghi abc
REPLACE `abc` IN s1 WITH `###`. "### def ghi abc (first found is replaced)
REPLACE SUBSTRING `abc` IN s1 WITH `###`. "### def ghi abc (SUBSTRING is optional)
REPLACE ALL OCCURRENCES OF `abc` IN s1 WITH `###`. "### def ghi ###
REPLACE `aBC` IN s1 WITH `###` IGNORING CASE. "### def ghi abc
"REPLACEMENT additions; can be specified individually or combined
REPLACE ALL OCCURRENCES OF `abc` IN s1 WITH `###` "### def ghi ###
REPLACEMENT COUNT DATA(cnt) "2 (number of replacements)
REPLACEMENT OFFSET DATA(off) "12 (offset of last replacement)
REPLACEMENT LENGTH DATA(len). "3 (length of last substring inserted)
"Returning all of these pieces of information in a table for all replacements
REPLACE ALL OCCURRENCES OF `abc` IN s1 WITH `###`
RESULTS DATA(res). "### def ghi ###
"Position-based replacement (OFFSET/LENGTH can be specified individually )
REPLACE SECTION OFFSET 4 LENGTH 7 OF s1 WITH `###`. "abc ### abc
"Replacements in internal tables
DATA(str_tab) = VALUE string_table( ( `ZxZ` ) ( `yZ` ) ( `Zz` ) ).
REPLACE ALL OCCURRENCES OF `Z`
IN TABLE str_tab WITH ``
RESPECTING CASE. "x / y / z
You can carry out complex search and replace operations based on patterns. PCRE regular expressions help you process strings effectively.
💡 Note
Do not use POSIX regular expressions any more since they are obsolete.
For simple patterns, you can use the comparison
operators
CP
(conforms to pattern) or its negation
NP
(does not conform to pattern) in comparison
expressions
to determine if a set of characters is contained in a string that
matches a certain pattern. For the patterns, you can use the following
special characters:
Special Character | Details |
---|---|
* |
Any character sequence (including blanks). |
+ |
Any character (only one character, including blanks). |
# |
Escape character. The following character is marked for an exact comparison. |
Patterns are not case-sensitive except for characters marked by
#
. If a pattern is found, the system variable
sy-fdpos
returns the offset of the first occurrence.
Otherwise, it contains the length of the searched string.
s1 = `abc_def_ghi`.
"Pattern: f is preceded by any character sequence, must be followed
"by '_' and then followed by any character sequence
IF s1 CP `*f#_*`. ... "true; sy-fdpos = 6
"Pattern: 'i' is not followed by another character
IF s1 NP `i+`. ... "true; sy-fdpos = 11 (length of searched string)
Excursion: Common Regular Expressions
There are various options to carry out complex searching in strings using PCRE expressions. They can be fairly complex. The following overview shows common PCRE expressions with simple examples.
Characters and character types
Expression | Represents | Example | Matches | Does not Match |
---|---|---|---|---|
. |
Any single character | . |
a, 9, Ä, #, a blank | aa, bbb |
\d |
Any digit (0-9) | \d |
1, 3, 7 | A, b, c |
\D |
Any character that is not a digit, equivalent to [^0-9] |
\D |
D, e, f | 4, 5, 8 |
\s |
Any whitespace character such as a blank, tab and new line | \s (example string: hi there) |
the blank in between | hi |
\S |
Any character that is not a whitespace | \S (example string: a 1) |
a, 1 | the blank in between |
\w |
Any word character (letter, digit or the underscore), equivalent to [a-zA-Z0-9_] |
\w (example string: ab 12) |
a, b, 1, 2 | the blank in between |
\W |
Any character that is not a word character, equivalent to [^a-zA-Z0-9_] |
\W (example string: cd 34) |
the blank in between | c, d, 3, 4 |
\ |
To include special characters like [] \ / ^ , use \ to escape them. Use \. to match a period ("."). |
\\ |
\ |
/ |
Repetitions and Alternatives
Expression | Represents | Example | Matches | Does not Match |
---|---|---|---|---|
r* |
Zero or more repetitions of r |
ab* |
a, ab, abb, abbb | b, aba |
r+ |
One or more repetitions of r |
ab+ |
ab, abb, abbb | a, b, aba |
r{m,n} |
Between m and n repetitions |
a{2,4} |
aa, aaa, aaaa | a, aaaaa, aba |
r{m} |
Exactly m repetitions |
a{3} |
aaa | a, aa, aaaa, bbb |
r? |
Optional r |
ab?a |
aa, aba | abba, aca |
r|s |
Matching alternatives, i. e. r or s |
a+|b+ |
a, b, aa, bb, aaa | ab, aabb |
Character Sets, Ranges, Subgroups and Lookarounds
Expression | Represents | Example | Matches | Does not Match |
---|---|---|---|---|
[aA1-] |
Character set, matches a single character present in the list | [aA1-] |
a, A, 1, - | b, B, cc, 3 |
[a-z0-9] |
Character range, matches a single character in the specified range, note that ranges may be locale-dependent | [a-c0-5] |
b, c, 2, 4 | d, Z, x, 9 |
[^aA1] |
Negation, matches any single character not present in the list | [^aA1] |
b, C, 3, - | a, A, 1 |
[^0-9] |
Negation, matches any single character not within the range | [^0-9] |
a, B, c | 1, 2, 3 |
(...) |
Capturing group to group parts of patterns together | a(b|c)a |
aba, aca | aa, abca |
(?=...) |
Positive lookahead, returns characters that are followed by a specified pattern without including this pattern | a(?=b) (example string: abc ade) |
the first a | the second a |
(?!...) |
Negative lookahead, returns characters that are not followed by a specified pattern without including this pattern | a(?!b) (example string: abc ade) |
the second a | the first a |
(?<=...) |
Positive lookbehind, returns characters that are preceded by a specified pattern without including this pattern | (?<=\s)c (example string: ab c abcd) |
the first c since it is preceded by a blank | the second c |
(?<!...) |
Negative lookbehind, returns characters that are not preceded by a specified pattern without including this pattern | (?<!\s)c example string: ab c abcd) |
the second c since it is not preceded by a blank | the first c |
💡 Note
Subgroups are handy in replacements. Using an expression with$
and a number, e. g.$1
, you can refer to a particular group. For example, you have a stringabcde
. A PCRE expression might be(ab|xy)c(d.)
, i. e. there are two subgroups specified within two pairs of parentheses. In a replacement pattern, you can refer to the first group using$1
and the second group using$2
. Hence, the replacement pattern$2Z$1
results indeZab
.
Anchors and Positions
Expression | Represents | Example | Matches | Does not Match |
---|---|---|---|---|
^ |
Beginning of line, alternative: \A |
^a. (example string: abcde) |
ab | bc |
$ |
End of line, alternative: \Z |
$ (example string: abcde) |
the position right after e | any other position |
\b |
beginning and end of word | 1) \ba\d 2) \Dd\b (example string: abcd a12d) |
1) a1 2) cd |
1) ab 2) 2d |
Multiple string functions support PCRE expressions by offering the
parameter pcre
with which you can specify such an expression.
FIND
and REPLACE
statements support regular
expressions with the PCRE
addition.
The string function
match
exclusively works with regular expressions. It returns a substring that
matches a regular expression within a string. For comparisons, you could
also use the predicate
function
matches
that returns true or false if a string matches a given pattern or not.
Syntax examples:
s1 = `Cathy's black cat on the mat played with Matt.`.
"Determining the position of the first occurrence
"Here, the parameter occ is 1 by default.
s2 = find( val = s1 pcre = `at.` ). "1
"Determining the number of all occurrences.
"Respects all 'a' characters not followed by 't', all 'at' plus 'att'
s2 = count( val = s1 pcre = `at*` ). "6
"Respects all 'at' plus 'att'
s2 = count( val = s1 pcre = `at+` ). "4
"Extracting a substring matching a given pattern
s1 = `The email address is jon.doe@email.com.`.
s2 = match( val = s1
pcre = `\w+(\.\w+)*@(\w+\.)+(\w{2,4})` ). "jon.doe@email.com
"Predicate function matches
"Checking the validitiy of an email address
s1 = `jon.doe@email.com`.
IF matches( val = s1
pcre = `\w+(\.\w+)*@(\w+\.)+(\w{2,4})` ). "true
...
ENDIF.
"Examples with the FIND statement
"Storing submatches in variables.
"Pattern: anything before and after ' on '
FIND PCRE `(.*)\son\s(.*)` IN s1 IGNORING CASE SUBMATCHES DATA(a) DATA(b).
"a = 'Cathy's black cat' / b = 'the mat played with Matt'.
"Determinging the number of letters in a string
FIND ALL OCCURRENCES OF PCRE `[A-Za-z]` IN s1 MATCH COUNT DATA(c). "36
"Searching in an internal table and retrieving line, offset, length information
DATA(itab) = value string_table( ( `Cathy's black cat on the mat played with the friend of Matt.` ) ).
"Pattern: 't' at the beginning of a word followed by another character
FIND FIRST OCCURRENCE OF PCRE `\bt.` IN TABLE itab
IGNORING CASE MATCH LINE DATA(d) MATCH OFFSET DATA(e) MATCH LENGTH DATA(f). "d: 1, e: 21, f: 2
To carry out replacement operations using regular expressions both
string function replace
and REPLACE
statements can
be used with the pcre
parameter or the PCRE
addition
respectively. Similar to the find
function, among others, and
FIND
statements, the replace
function and
REPLACE
statements offer a variety of parameters or additions
respectively to further restrict the area to be replaced. Check the ABAP
Keyword Documentation for a more detailed insight. The executable
example covers numerous PCRE expressions listed above with the
replace
function.
Syntax examples:
s1 = `ab apppc app`.
"Replaces 'p' with 2 - 4 repetitions, all occurences
s2 = replace( val = s1 pcre = `p{2,4}` with = `#` occ = 0 ). "ab a#c a#
"Replaces any single character not present in the list, all occurences)
s2 = replace( val = s1 pcre = `[^ac]` with = `#` occ = 0 ). " "a##a###c#a##
"Replaces first occurence of a blank
s2 = replace( val = s1 pcre = `\s` with = `#` ). "ab#apppc app
"Greedy search
"The pattern matches anything before 'p'. The matching is carried out as
"often as possible. Hence, in this example the search stretches until the
"end of the string since 'p' is the final character, i. e. this 'p' and
"anything before is replaced.
s2 = replace( val = s1 pcre = `(.*)p` with = `#` ). "#
"Non-greedy search (denoted by '?' below)
"The pattern matches anything before 'p'. The matching proceeds until
"the first 'p' is found and does not go beyond. It matches as few as
"possible. Hence, the first found 'p' including the content before
"is replaced.
s2 = replace( val = s1 pcre = `(.*?)p` with = `#` ). "#ppc app
"Replacements with subgroups
"Replaces 'pp' (case-insensitive here) with '#', the content before and after 'pp' is switched
s2 = replace( val = s1
pcre = `(.*?)PP(.*)`
with = `$2#$1`
case = abap_false ). "pc app#ab a
"Changing the source field directly with a REPLACE statement; same as above
REPLACE PCRE `(.*?)PP(.*)` IN s1 WITH `$2#$1` IGNORING CASE. "pc app#ab a
Note the steps outlined here about how to import and run the code.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。