/*
 * Copyright 2008 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.gwt.dev.jjs.impl;

import com.google.gwt.dev.jjs.ast.HasName;
import com.google.gwt.dev.jjs.ast.JClassType;
import com.google.gwt.dev.jjs.ast.JDeclaredType;
import com.google.gwt.dev.jjs.ast.JField;
import com.google.gwt.dev.jjs.ast.JMethod;
import com.google.gwt.dev.js.ast.JsName;
import com.google.gwt.dev.js.ast.JsStatement;
import com.google.gwt.thirdparty.guava.common.collect.ImmutableList;
import com.google.gwt.thirdparty.guava.common.collect.ImmutableMap;

/**
 * A map between chunks of JavaScript to chunks of Java.
 */
public interface JavaToJavaScriptMap {

  JavaToJavaScriptMap EMPTY = new JavaToJavaScriptMapImpl(
      ImmutableList.<JDeclaredType>of(), ImmutableMap.<HasName, JsName>of(),
      ImmutableMap.<JsStatement, JDeclaredType>of(), ImmutableMap.<JsStatement, JMethod>of());

  /**
   * Return the JavaScript name corresponding to a Java field.
   */
  JsName nameForField(JField field);
  /**
   * Return the JavaScript name corresponding to a Java method.
   */
  JsName nameForMethod(JMethod method);

  /**
   * Return the JavaScript name corresponding to a Java type.
   */
  JsName nameForType(JDeclaredType type);

  /**
   * If <code>name</code> is the name of a
   * <code>var<code> that corresponds to a Java
   * static field, then return that field. Otherwise, return null.
   */
  JField nameToField(JsName name);

  /**
   * If <code>name</code> is the name of a function that corresponds to a Java
   * method, then return that method. Otherwise, return null.
   */
  JMethod nameToMethod(JsName name);

  /**
   * If <code>name</code> is the name of a constructor function corresponding to
   * a Java type, then return that type. Otherwise, return <code>null</code>.
   */
  JClassType nameToType(JsName name);

  /**
   * If <code>statement</code> is used to set up the definition of some type, return
   * that class. Otherwise, return null.
   */
  JDeclaredType typeForStatement(JsStatement statement);

  /**
   * If <code>stat</code> is used to set up the definion for some method implementation, then
   * return that method. Otherwise return null.
   */
  JMethod methodForStatement(JsStatement statement);
}