1 /*
 2  * Copyright (c) 2014, 2024, 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 
30 #ifdef _WINDOWS
31   // strtok_s is the Windows thread-safe equivalent of POSIX strtok_r
32 # define strtok_r strtok_s
33 #endif
34 
35 class StringUtils : AllStatic {
36 public:
37   // Replace the substring <from> with another string <to>. <to> must be
38   // no longer than <from>. The input string is modified in-place.
39   //
40   // Replacement is done in a single pass left-to-right. So replace_no_expand("aaa", "aa", "a")
41   // will result in "aa", not "a".
42   //
43   // Returns the count of substrings that have been replaced.
44   static int replace_no_expand(char* string, const char* from, const char* to);
45 
46   // Compute string similarity based on Dice's coefficient
47   static double similarity(const char* str1, size_t len1, const char* str2, size_t len2);
48 
49   // Match a wildcarded class list to a proposed class name (in internal form).
50   // Commas separate multiple possible matches; stars are shell-style wildcards.
51   static bool class_list_match(const char* class_list, const char* class_name);
52 
53   // Find needle in haystack, case insensitive.
54   // Custom implementation of strcasestr, as it is not available on windows.
55   static const char* strstr_nocase(const char* haystack, const char* needle);
56 
57   // Check if str matches the star_pattern.
58   // eg. str "_abc____def__" would match pattern "abc*def".
59   // The matching is case insensitive.
60   static bool is_star_match(const char* star_pattern, const char* str);
61 
62   class CommaSeparatedStringIterator {
63   private:
64     char* _token;
65     char* _saved_ptr;
66     char* _list;
67 
68   public:
69     CommaSeparatedStringIterator(ccstrlist option) {
70       // Immediately make a private copy of option, and
71       // replace spaces and newlines with comma.
72       _list = (char*) canonicalize(option);
73       _saved_ptr = _list;
74       _token = strtok_r(_saved_ptr, ",", &_saved_ptr);
75     }
76 
77     ~CommaSeparatedStringIterator();
78 
79     const char* operator*() const { return _token; }
80 
81     CommaSeparatedStringIterator& operator++() {
82       _token = strtok_r(nullptr, ",", &_saved_ptr);
83       return *this;
84     }
85 
86     ccstrlist canonicalize(ccstrlist option_value);
87   };
88 };
89 
90 #endif // SHARE_UTILITIES_STRINGUTILS_HPP