1 /*
2 * Copyright (c) 1999, 2022, 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_CI_CISYMBOL_HPP
26 #define SHARE_CI_CISYMBOL_HPP
27
28 #include "ci/ciBaseObject.hpp"
29 #include "ci/ciObject.hpp"
30 #include "oops/symbol.hpp"
31 #include "utilities/vmEnums.hpp"
32
33 // ciSymbol
34 //
35 // This class represents a Symbol* in the HotSpot virtual
36 // machine.
37 class ciSymbol : public ciBaseObject {
38 Symbol* _symbol;
39
40 CI_PACKAGE_ACCESS
41 // These friends all make direct use of get_symbol:
42 friend class ciEnv;
43 friend class ciInstanceKlass;
44 friend class ciSignature;
45 friend class ciMethod;
46 friend class ciField;
47 friend class ciObjArrayKlass;
48 friend class ciFlatArrayKlass;
49
50 private:
51 const vmSymbolID _sid;
52
53 ciSymbol(Symbol* s, vmSymbolID sid);
54
55 DEBUG_ONLY(bool sid_ok();)
56
57 const char* type_string() { return "ciSymbol"; }
58
59 void print_impl(outputStream* st);
60
61 // This is public in Symbol* but private here, because the base can move:
62 const u1* base();
63
64 // Make a ciSymbol from a C string (implementation).
65 static ciSymbol* make_impl(const char* s);
66
67 public:
68 // The enumeration ID from vmSymbols, or vmSymbolID::NO_SID if none.
69 vmSymbolID sid() const { return _sid; }
70
71 // The text of the symbol as a null-terminated utf8 string.
72 const char* as_utf8();
73 int utf8_length();
74
75 // The text of the symbol as ascii with all non-printable characters quoted as \u####
76 const char* as_quoted_ascii();
77
78 // Return the i-th utf byte as a char, where i < utf8_length
79 char char_at(int i);
80
81 // Tests if the symbol starts with the given prefix.
82 bool starts_with(const char* prefix, int len) const;
83 bool starts_with(char prefix_char) const;
84
85 // Tests if the symbol ends with the given suffix.
86 bool ends_with(const char* suffix, int len) const;
87 bool ends_with(char suffix_char) const;
88
89 // Determines where the symbol contains the given substring.
90 int index_of_at(int i, const char* str, int len) const;
91
92 void print_symbol_on(outputStream* st);
93 void print_symbol() {
94 print_symbol_on(tty);
95 }
96 const char* as_klass_external_name() const;
97
98 // Make a ciSymbol from a C string.
99 // Consider adding to vmSymbols.hpp instead of using this constructor.
100 // (Your code will be less subject to typographical bugs.)
101 static ciSymbol* make(const char* s);
102
103 void print() {
104 _symbol->print();
105 }
106
107 virtual bool is_symbol() const { return true; }
108
109 // Are two ciSymbols equal?
110 bool equals(ciSymbol* obj) { return this->_symbol == obj->get_symbol(); }
111
112 bool is_signature_polymorphic_name() const;
113
114 Symbol* get_symbol() const { return _symbol; }
115
116 };
117
118 #endif // SHARE_CI_CISYMBOL_HPP