/*
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html.
 *
 * This file is a derivative of code released under the terms listed below.
 *
 */
/*
 *
 * Copyright (c) 2009-2012,
 *
 *  Jonathan Bardin     <astrosus@gmail.com>
 *  Steve Suh           <suhsteve@gmail.com>
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The names of the contributors may not be used to endorse or promote
 * products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *
 */

package com.ibm.wala.dalvik.classLoader;

import static org.jf.dexlib2.AccessFlags.*;

import com.ibm.wala.classLoader.IClass;
import com.ibm.wala.classLoader.IField;
import com.ibm.wala.ipa.cha.IClassHierarchy;
import com.ibm.wala.types.FieldReference;
import com.ibm.wala.types.TypeName;
import com.ibm.wala.types.TypeReference;
import com.ibm.wala.types.annotations.Annotation;
import com.ibm.wala.util.strings.Atom;
import java.util.Collection;
import org.jf.dexlib2.iface.Field;

public class DexIField implements IField {

  /*
   * The EncodedFied object for which this DexIField is a wrapper
   */
  private final Field eField;

  /** The declaring class for this method. */
  private final DexIClass myClass;

  // /** name of the return type for this method, construct in the get return type method. */
  // private TypeReference typeReference;

  /**
   * canonical FieldReference corresponding to this method, construct in the getReference method.
   */
  private FieldReference fieldReference, myFieldRef;

  private Atom name;

  public DexIField(Field encodedField, DexIClass klass) {
    // public DexIField(EncodedField encodedField) {
    eField = encodedField;
    myClass = klass;
    String fieldName = eField.getName();
    name = Atom.findOrCreateUnicodeAtom(fieldName);

    String fieldType = eField.getType();
    TypeName T = DexUtil.getTypeName(fieldType);
    TypeReference type = TypeReference.findOrCreate(myClass.getClassLoader().getReference(), T);
    myFieldRef = FieldReference.findOrCreate(myClass.getReference(), name, type);
  }

  @Override
  public TypeReference getFieldTypeReference() {

    // compute the typeReference from the EncodedField
    //      if (typeReference == null) {
    //          typeReference = TypeReference.findOrCreate(myClass.getClassLoader()
    //                  .getReference(), eField.field.getFieldType().getTypeDescriptor());
    //      }
    //      return typeReference;
    return myFieldRef.getFieldType();
  }

  @Override
  public FieldReference getReference() {

    if (fieldReference == null) {
      //          fieldReference = FieldReference.findOrCreate(myClass.getReference(),
      //                  eField.field.getContainingClass().getTypeDescriptor(),
      // eField.field.getFieldName().getStringValue(),
      //                  eField.field.getFieldType().getTypeDescriptor());
      fieldReference =
          FieldReference.findOrCreate(myClass.getReference(), getName(), getFieldTypeReference());
    }

    return fieldReference;
  }

  @Override
  public Atom getName() {
    return name;
  }

  @Override
  public boolean isFinal() {
    return (eField.getAccessFlags() & FINAL.getValue()) != 0;
  }

  @Override
  public boolean isPrivate() {
    return (eField.getAccessFlags() & PRIVATE.getValue()) != 0;
  }

  @Override
  public boolean isProtected() {
    return (eField.getAccessFlags() & PROTECTED.getValue()) != 0;
  }

  @Override
  public boolean isPublic() {
    return (eField.getAccessFlags() & PUBLIC.getValue()) != 0;
  }

  @Override
  public boolean isStatic() {
    return (eField.getAccessFlags() & STATIC.getValue()) != 0;
  }

  @Override
  public IClass getDeclaringClass() {
    return myClass;
  }

  @Override
  public boolean isVolatile() {
    return (eField.getAccessFlags() & VOLATILE.getValue()) != 0;
  }

  @Override
  public IClassHierarchy getClassHierarchy() {
    return myClass.getClassHierarchy();
  }

  @Override
  public Collection<Annotation> getAnnotations() {
    return myClass.getAnnotations(eField);
  }
}
