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