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