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