/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * 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.intellij.codeInsight;

import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiFile;
import org.jetbrains.annotations.NotNull;
import consulo.annotations.DeprecationInfo;
import consulo.annotations.RequiredDispatchThread;
import consulo.annotations.RequiredWriteAction;

public interface CodeInsightActionHandler {
  abstract class WriteActionAdapter implements CodeInsightActionHandler{
    @Override
    @RequiredDispatchThread
    public final void invoke(@NotNull final Project project, @NotNull final Editor editor, @NotNull final PsiFile file) {
      ApplicationManager.getApplication().runWriteAction(new Runnable() {
        @Override
        public void run() {
          invokeInWriteAction(project, editor, file);
        }
      });
    }

    @RequiredWriteAction
    public abstract void invokeInWriteAction(@NotNull Project project, @NotNull Editor editor, @NotNull PsiFile file);

    @Override
    public final boolean startInWriteAction() {
      return false;
    }
  }

  @RequiredDispatchThread
  void invoke(@NotNull Project project, @NotNull Editor editor, @NotNull PsiFile file);

  @Deprecated
  @DeprecationInfo("Please return 'false' always, if u need wrap into write action - use WriteActionAdapter")
  boolean startInWriteAction();
}