/*
 * Copyright (c) 2013, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.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.eclipse.org/legal/epl-v10.html
 * 
 * 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.dart.tools.ui.internal.text.dart;

import com.google.dart.engine.ast.CompilationUnit;
import com.google.dart.engine.context.AnalysisContext;
import com.google.dart.engine.source.Source;
import com.google.dart.tools.core.analysis.model.Project;

import org.eclipse.swt.events.DisposeListener;

/**
 * Interface used by {@link DartReconcilingStrategy} to interact with the editor.
 */
public interface DartReconcilingEditor {

  /**
   * Add a listener to be notified when the editor's viewer is disposed.
   * 
   * @param listener the listener to be notified (not {@code null})
   */
  void addViewerDisposeListener(DisposeListener listener);

  /**
   * Update the editor to use the specified compilation unit.
   * 
   * @param unit the unit or {@code null} if none
   */
  void applyResolvedUnit(CompilationUnit unit);

  /**
   * Answer the analysis context to be used when resolving the source displayed in the editor.
   * 
   * @return the {@link AnalysisContext} corresponding to this editor or {@code null} if none
   */
  AnalysisContext getInputAnalysisContext();

  /**
   * Answer the full path of the file being displayed in this editor.
   * 
   * @return the full path or {@code null} if none
   */
  String getInputFilePath();

  /**
   * Answer the project containing the source being displayed in this editor.
   * 
   * @return the {@link Project} or {@code null} if none
   */
  Project getInputProject();

  /**
   * Answer the source being displayed in this editor.
   * 
   * @return the {@link Source} or {@code null} if none
   */
  Source getInputSource();

  /**
   * Answer the short name for the file being edited
   * 
   * @return the title or {@code null}
   */
  String getTitle();

  /**
   * Returns whether the contents of this editor is dirty.
   */
  boolean isDirty();

  /**
   * Set the reconciling strategy associated with this editor
   * 
   * @param dartReconcilingStrategy the strategy or {@code null} if none
   */
  void setDartReconcilingStrategy(DartReconcilingStrategy dartReconcilingStrategy);
}