/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 *

 */

// ciSymbol

//

// This class represents a symbolOop in the HotSpot virtual

// machine.

class ciSymbol : public ciObject {

  CI_PACKAGE_ACCESS

  friend class ciEnv;

  friend class ciInstanceKlass;

  friend class ciSignature;

  friend class ciMethod;

  friend class ciObjArrayKlass;

private:

  ciSymbol(symbolOop s) : ciObject(s) {}

  ciSymbol(symbolHandle s);   // for use with vmSymbolHandles

  const char* type_string() { return "ciSymbol"; }

  void print_impl(outputStream* st);

  jbyte*      base();

  // Make a ciSymbol from a C string (implementation).

  static ciSymbol* make_impl(const char* s);

public:

  // The text of the symbol as a null-terminated utf8 string.

  const char* as_utf8();

  int         utf8_length();

  // What kind of ciObject is this?

  bool is_symbol() { return true; }

  void print_symbol_on(outputStream* st);

  void print_symbol() {

    print_symbol_on(tty);

  }

  // Make a ciSymbol from a C string.

  // Consider adding to vmSymbols.hpp instead of using this constructor.

  // (Your code will be less subject to typographical bugs.)

  static ciSymbol* make(const char* s);

#define CI_SYMBOL_DECLARE(name, ignore_def) \

  static ciSymbol* name() { return ciObjectFactory::vm_symbol_at(vmSymbols::VM_SYMBOL_ENUM_NAME(name)); }

  VM_SYMBOLS_DO(CI_SYMBOL_DECLARE, CI_SYMBOL_DECLARE)

#undef CI_SYMBOL_DECLARE

};