/*
 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
 * 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 *
 */

#ifndef SHARE_RUNTIME_FIELDTYPE_HPP
#define SHARE_RUNTIME_FIELDTYPE_HPP

#include "memory/allocation.hpp"
#include "oops/symbol.hpp"

// Note: FieldType should be based on the SignatureIterator (or vice versa).
//       In any case, this structure should be re-thought at some point.

// A FieldType is used to determine the type of a field from a signature string.

// Information returned by get_array_info, which is scoped to decrement
// reference count if a Symbol is created in the case of T_OBJECT
class FieldArrayInfo : public StackObj {
  friend class FieldType;  // field type can set these fields.
  int       _dimension;
  Symbol*   _object_key;
 public:
  int       dimension()    { return _dimension; }
  Symbol*   object_key()   { return _object_key; }
  // basic constructor
  FieldArrayInfo() : _dimension(0), _object_key(NULL) {}
  // destructor decrements object key's refcount if created
  ~FieldArrayInfo() { if (_object_key != NULL) _object_key->decrement_refcount(); }
};


class FieldType: public AllStatic {
 private:
  static bool is_valid_array_signature(Symbol* signature);
 public:

  // Return basic type
  static BasicType basic_type(Symbol* signature);

  // Testing
  static bool is_array(Symbol* signature) { return signature->utf8_length() > 1 &&
                                                   signature->char_at(0) == JVM_SIGNATURE_ARRAY &&
                                                   is_valid_array_signature(signature); }

  static bool is_obj(Symbol* signature) {
     int sig_length = signature->utf8_length();
     // Must start with 'L' and end with ';'
     return (sig_length >= 2 &&
             (signature->char_at(0) == JVM_SIGNATURE_CLASS) &&
             (signature->char_at(sig_length - 1) == JVM_SIGNATURE_ENDCLASS));
  }

  // Parse field and extract array information. Works for T_ARRAY only.
  static BasicType get_array_info(Symbol* signature, FieldArrayInfo& ai, TRAPS);
};

#endif // SHARE_RUNTIME_FIELDTYPE_HPP