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