1 /*
 2  * Copyright (c) 2014, 2026, Oracle and/or its affiliates. All rights reserved.
 3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 4  *
 5  * This code is free software; you can redistribute it and/or modify it
 6  * under the terms of the GNU General Public License version 2 only, as
 7  * published by the Free Software Foundation.
 8  *
 9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  *
23  */
24 
25 #ifndef SHARE_UTILITIES_STRINGUTILS_HPP
26 #define SHARE_UTILITIES_STRINGUTILS_HPP
27 
28 #include "memory/allStatic.hpp"
29 #include "utilities/globalDefinitions.hpp"
30 
31 class StringUtils : AllStatic {
32 public:
33   // Replace the substring <from> with another string <to>. <to> must be
34   // no longer than <from>. The input string is modified in-place.
35   //
36   // Replacement is done in a single pass left-to-right. So replace_no_expand("aaa", "aa", "a")
37   // will result in "aa", not "a".
38   //
39   // Returns the count of substrings that have been replaced.
40   static int replace_no_expand(char* string, const char* from, const char* to);
41 
42   // Compute string similarity based on Dice's coefficient
43   static double similarity(const char* str1, size_t len1, const char* str2, size_t len2);
44 
45   // Find needle in haystack, case insensitive.
46   // Custom implementation of strcasestr, as it is not available on windows.
47   static const char* strstr_nocase(const char* haystack, const char* needle);
48 
49   // Check if str matches the star_pattern.
50   // eg. str "_abc____def__" would match pattern "abc*def".
51   // The matching is case insensitive.
52   static bool is_star_match(const char* star_pattern, const char* str);
53 
54   class CommaSeparatedStringIterator {
55   private:
56     char* _token;
57     char* _saved_ptr;
58     char* _list;
59 
60   public:
61     CommaSeparatedStringIterator(ccstrlist option) {
62       // Immediately make a private copy of option, and
63       // replace spaces and newlines with comma.
64       _list = (char*) canonicalize(option);
65       _saved_ptr = _list;
66       _token = strtok_r(_saved_ptr, ",", &_saved_ptr);
67     }
68 
69     ~CommaSeparatedStringIterator();
70 
71     const char* operator*() const { return _token; }
72 
73     CommaSeparatedStringIterator& operator++() {
74       _token = strtok_r(nullptr, ",", &_saved_ptr);
75       return *this;
76     }
77 
78     ccstrlist canonicalize(ccstrlist option_value);
79   };
80 };
81 
82 #endif // SHARE_UTILITIES_STRINGUTILS_HPP