1 /* 2 * Copyright (c) 1999, 2010, 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_VM_CI_CISYMBOL_HPP 26 #define SHARE_VM_CI_CISYMBOL_HPP 27 28 #include "ci/ciObject.hpp" 29 #include "ci/ciObjectFactory.hpp" 30 #include "classfile/vmSymbols.hpp" 31 #include "oops/symbolOop.hpp" 32 33 // ciSymbol 34 // 35 // This class represents a symbolOop in the HotSpot virtual 36 // machine. 37 class ciSymbol : public ciObject { 38 CI_PACKAGE_ACCESS 39 // These friends all make direct use of get_symbolOop: 40 friend class ciEnv; 41 friend class ciInstanceKlass; 42 friend class ciSignature; 43 friend class ciMethod; 44 friend class ciObjArrayKlass; 45 46 private: 47 const vmSymbols::SID _sid; 48 DEBUG_ONLY( bool sid_ok() { return vmSymbols::find_sid(get_symbolOop()) == _sid; } ) 49 50 ciSymbol(symbolOop s); // normal case, for symbols not mentioned in vmSymbols 51 ciSymbol(symbolHandle s, vmSymbols::SID sid); // for use with vmSymbolHandles 52 53 symbolOop get_symbolOop() const { return (symbolOop)get_oop(); } 54 55 const char* type_string() { return "ciSymbol"; } 56 57 void print_impl(outputStream* st); 58 59 // This is public in symbolOop but private here, because the base can move: 60 jbyte* base(); 61 62 // Make a ciSymbol from a C string (implementation). 63 static ciSymbol* make_impl(const char* s); 64 65 public: 66 // The enumeration ID from vmSymbols, or vmSymbols::NO_SID if none. 67 vmSymbols::SID sid() const { return _sid; } 68 69 // The text of the symbol as a null-terminated utf8 string. 70 const char* as_utf8(); 71 int utf8_length(); 72 73 // Return the i-th utf8 byte, where i < utf8_length 74 int byte_at(int i); 75 76 // Tests if the symbol starts with the given prefix. 77 bool starts_with(const char* prefix, int len) const; 78 79 // Determines where the symbol contains the given substring. 80 int index_of_at(int i, const char* str, int len) const; 81 82 // What kind of ciObject is this? 83 bool is_symbol() { return true; } 84 85 void print_symbol_on(outputStream* st); 86 void print_symbol() { 87 print_symbol_on(tty); 88 } 89 90 // Make a ciSymbol from a C string. 91 // Consider adding to vmSymbols.hpp instead of using this constructor. 92 // (Your code will be less subject to typographical bugs.) 93 static ciSymbol* make(const char* s); 94 95 #define CI_SYMBOL_DECLARE(name, ignore_def) \ 96 static ciSymbol* name() { return ciObjectFactory::vm_symbol_at(vmSymbols::VM_SYMBOL_ENUM_NAME(name)); } 97 VM_SYMBOLS_DO(CI_SYMBOL_DECLARE, CI_SYMBOL_DECLARE) 98 #undef CI_SYMBOL_DECLARE 99 }; 100 101 #endif // SHARE_VM_CI_CISYMBOL_HPP