1 /* String intrinsics helper functions.
2 Copyright (C) 2002-2024 Free Software Foundation, Inc.
4 This file is part of the GNU Fortran runtime library (libgfortran).
6 Libgfortran is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public
8 License as published by the Free Software Foundation; either
9 version 3 of the License, or (at your option) any later version.
11 Libgfortran is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 Under Section 7 of GPL version 3, you are granted additional
17 permissions described in the GCC Runtime Library Exception, version
18 3.1, as published by the Free Software Foundation.
20 You should have received a copy of the GNU General Public License and
21 a copy of the GCC Runtime Library Exception along with this program;
22 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 <http://www.gnu.org/licenses/>. */
26 /* Rename the functions. */
27 #define concat_string SUFFIX(concat_string)
28 #define string_len_trim SUFFIX(string_len_trim)
29 #define adjustl SUFFIX(adjustl)
30 #define adjustr SUFFIX(adjustr)
31 #define string_index SUFFIX(string_index)
32 #define string_scan SUFFIX(string_scan)
33 #define string_verify SUFFIX(string_verify)
34 #define string_trim SUFFIX(string_trim)
35 #define string_minmax SUFFIX(string_minmax)
36 #define zero_length_string SUFFIX(zero_length_string)
37 #define compare_string SUFFIX(compare_string)
42 extern void concat_string (gfc_charlen_type
, CHARTYPE
*,
43 gfc_charlen_type
, const CHARTYPE
*,
44 gfc_charlen_type
, const CHARTYPE
*);
45 export_proto(concat_string
);
47 extern void adjustl (CHARTYPE
*, gfc_charlen_type
, const CHARTYPE
*);
48 export_proto(adjustl
);
50 extern void adjustr (CHARTYPE
*, gfc_charlen_type
, const CHARTYPE
*);
51 export_proto(adjustr
);
53 extern gfc_charlen_type
string_index (gfc_charlen_type
, const CHARTYPE
*,
54 gfc_charlen_type
, const CHARTYPE
*,
56 export_proto(string_index
);
58 extern gfc_charlen_type
string_scan (gfc_charlen_type
, const CHARTYPE
*,
59 gfc_charlen_type
, const CHARTYPE
*,
61 export_proto(string_scan
);
63 extern gfc_charlen_type
string_verify (gfc_charlen_type
, const CHARTYPE
*,
64 gfc_charlen_type
, const CHARTYPE
*,
66 export_proto(string_verify
);
68 extern void string_trim (gfc_charlen_type
*, CHARTYPE
**, gfc_charlen_type
,
70 export_proto(string_trim
);
72 extern void string_minmax (gfc_charlen_type
*, CHARTYPE
**, int, int, ...);
73 export_proto(string_minmax
);
76 /* Use for functions which can return a zero-length string. */
77 static CHARTYPE zero_length_string
= 0;
80 /* Strings of unequal length are extended with pad characters. */
83 compare_string (gfc_charlen_type len1
, const CHARTYPE
*s1
,
84 gfc_charlen_type len2
, const CHARTYPE
*s2
)
90 /* Placate the sanitizer. */
98 res
= MEMCMP (s1
, s2
, ((len1
< len2
) ? len1
: len2
));
108 s
= (UCHARTYPE
*) &s2
[len1
];
114 s
= (UCHARTYPE
*) &s1
[len2
];
132 iexport(compare_string
);
135 /* The destination and source should not overlap. */
138 concat_string (gfc_charlen_type destlen
, CHARTYPE
* dest
,
139 gfc_charlen_type len1
, const CHARTYPE
* s1
,
140 gfc_charlen_type len2
, const CHARTYPE
* s2
)
144 memcpy (dest
, s1
, destlen
* sizeof (CHARTYPE
));
147 memcpy (dest
, s1
, len1
* sizeof (CHARTYPE
));
153 memcpy (dest
, s2
, destlen
* sizeof (CHARTYPE
));
157 memcpy (dest
, s2
, len2
* sizeof (CHARTYPE
));
158 MEMSET (&dest
[len2
], ' ', destlen
- len2
);
162 /* Return string with all trailing blanks removed. */
165 string_trim (gfc_charlen_type
*len
, CHARTYPE
**dest
, gfc_charlen_type slen
,
168 *len
= string_len_trim (slen
, src
);
171 *dest
= &zero_length_string
;
174 /* Allocate space for result string. */
175 *dest
= xmallocarray (*len
, sizeof (CHARTYPE
));
177 /* Copy string if necessary. */
178 memcpy (*dest
, src
, *len
* sizeof (CHARTYPE
));
183 /* The length of a string not including trailing blanks. */
186 string_len_trim (gfc_charlen_type len
, const CHARTYPE
*s
)
191 const size_t long_len
= sizeof (unsigned long);
195 /* If we've got the standard (KIND=1) character type, we scan the string in
196 long word chunks to speed it up (until a long word is hit that does not
198 if (sizeof (CHARTYPE
) == 1 && i
>= long_len
)
201 unsigned long blank_longword
;
203 /* Handle the first characters until we're aligned on a long word
204 boundary. Actually, s + i + 1 must be properly aligned, because
205 s + i will be the last byte of a long word read. */
207 #ifdef __INTPTR_TYPE__
210 (s
+ i
+ 1)) % long_len
;
212 for (; starting
> 0; --starting
)
213 if (s
[i
+ starting
] != ' ')
214 return i
+ starting
+ 1;
216 /* Handle the others in a batch until first non-blank long word is
217 found. Here again, s + i is the last byte of the current chunk,
218 to it starts at s + i - sizeof (long) + 1. */
220 #if __SIZEOF_LONG__ == 4
221 blank_longword
= 0x20202020L
;
222 #elif __SIZEOF_LONG__ == 8
223 blank_longword
= 0x2020202020202020L
;
225 #error Invalid size of long!
228 while (i
>= long_len
)
231 if (*((unsigned long*) (s
+ i
+ 1)) != blank_longword
)
239 /* Simply look for the first non-blank character. */
250 /* Find a substring within a string. */
253 string_index (gfc_charlen_type slen
, const CHARTYPE
*str
,
254 gfc_charlen_type sslen
, const CHARTYPE
*sstr
,
257 gfc_charlen_type start
, last
, delta
, i
;
260 return back
? (slen
+ 1) : 1;
267 last
= slen
+ 1 - sslen
;
274 start
= slen
- sslen
;
278 for (; start
!= last
; start
+= delta
)
280 for (i
= 0; i
< sslen
; i
++)
282 if (str
[start
+ i
] != sstr
[i
])
292 /* Remove leading blanks from a string, padding at end. The src and dest
293 should not overlap. */
296 adjustl (CHARTYPE
*dest
, gfc_charlen_type len
, const CHARTYPE
*src
)
301 while (i
< len
&& src
[i
] == ' ')
305 memcpy (dest
, &src
[i
], (len
- i
) * sizeof (CHARTYPE
));
307 MEMSET (&dest
[len
- i
], ' ', i
);
311 /* Remove trailing blanks from a string. */
314 adjustr (CHARTYPE
*dest
, gfc_charlen_type len
, const CHARTYPE
*src
)
319 while (i
> 0 && src
[i
- 1] == ' ')
323 MEMSET (dest
, ' ', len
- i
);
324 memcpy (&dest
[len
- i
], src
, i
* sizeof (CHARTYPE
));
328 /* Scan a string for any one of the characters in a set of characters. */
331 string_scan (gfc_charlen_type slen
, const CHARTYPE
*str
,
332 gfc_charlen_type setlen
, const CHARTYPE
*set
, GFC_LOGICAL_4 back
)
334 gfc_charlen_type i
, j
;
336 if (slen
== 0 || setlen
== 0)
341 for (i
= slen
; i
!= 0; i
--)
343 for (j
= 0; j
< setlen
; j
++)
345 if (str
[i
- 1] == set
[j
])
352 for (i
= 0; i
< slen
; i
++)
354 for (j
= 0; j
< setlen
; j
++)
356 if (str
[i
] == set
[j
])
366 /* Verify that a set of characters contains all the characters in a
367 string by identifying the position of the first character in a
368 characters that does not appear in a given set of characters. */
371 string_verify (gfc_charlen_type slen
, const CHARTYPE
*str
,
372 gfc_charlen_type setlen
, const CHARTYPE
*set
,
375 gfc_charlen_type start
, last
, delta
, i
;
392 for (; start
!= last
; start
+= delta
)
394 for (i
= 0; i
< setlen
; i
++)
396 if (str
[start
] == set
[i
])
407 /* MIN and MAX intrinsics for strings. The front-end makes sure that
408 nargs is at least 2. */
411 string_minmax (gfc_charlen_type
*rlen
, CHARTYPE
**dest
, int op
, int nargs
, ...)
415 CHARTYPE
*next
, *res
;
416 gfc_charlen_type nextlen
, reslen
;
418 va_start (ap
, nargs
);
419 reslen
= va_arg (ap
, gfc_charlen_type
);
420 res
= va_arg (ap
, CHARTYPE
*);
424 runtime_error ("First argument of '%s' intrinsic should be present",
425 op
> 0 ? "MAX" : "MIN");
427 for (i
= 1; i
< nargs
; i
++)
429 nextlen
= va_arg (ap
, gfc_charlen_type
);
430 next
= va_arg (ap
, CHARTYPE
*);
435 runtime_error ("Second argument of '%s' intrinsic should be "
436 "present", op
> 0 ? "MAX" : "MIN");
444 if (op
* compare_string (reslen
, res
, nextlen
, next
) < 0)
453 *dest
= &zero_length_string
;
456 CHARTYPE
*tmp
= xmallocarray (*rlen
, sizeof (CHARTYPE
));
457 memcpy (tmp
, res
, reslen
* sizeof (CHARTYPE
));
458 MEMSET (&tmp
[reslen
], ' ', *rlen
- reslen
);