package org.jetbrains.plugins.cucumber.psi;

import com.intellij.lang.ASTNode;
import com.intellij.pom.PomTarget;
import com.intellij.psi.PsiNamedElement;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.plugins.cucumber.CucumberBundle;
import org.jetbrains.plugins.cucumber.steps.AbstractStepDefinition;

import java.util.Collection;
import java.util.List;
import java.util.Set;

/**
 * @author yole
 */
public interface GherkinStep extends GherkinPsiElement, GherkinSuppressionHolder, PomTarget, PsiNamedElement {
  GherkinStep[] EMPTY_ARRAY = new GherkinStep[0];
  /**
   * Message to display if step can't be renamed. (to be used as result of {@link #isRenameAllowed(String)} with null argument)
   *
   * @see #isRenameAllowed(String)
   */
  String RENAME_DISABLED_MESSAGE = CucumberBundle.message("cucumber.refactor.rename.disabled");

  /**
   * Message to display if step can't be renamed due to bad symbols. (to be used as result of {@link #isRenameAllowed(String)} with name argument)
   *
   * @see #isRenameAllowed(String)
   */
  String RENAME_BAD_SYMBOLS_MESSAGE = CucumberBundle.message("cucumber.refactor.rename.bad_symbols");

  ASTNode getKeyword();

  String getStepName();

  @Nullable
  GherkinTable getTable();

  @Nullable
  GherkinPystring getPystring();

  GherkinStepsHolder getStepHolder();

  /**
   * @return List with not empty unique possible substitutions names
   */
  List<String> getParamsSubstitutions();

  @Nullable
  String getSubstitutedName();

  @NotNull
  Set<String> getSubstitutedNameList();


  /**
   * @return all step definitions (may be heavy). Works just like {@link org.jetbrains.plugins.cucumber.steps.reference.CucumberStepReference#resolveToDefinition()}
   * @see org.jetbrains.plugins.cucumber.steps.reference.CucumberStepReference#resolveToDefinition()
   */
  @NotNull
  Collection<AbstractStepDefinition> findDefinitions();


  /**
   * Checks if step can be renamed (actually, all definitions are asked).
   * See {@link org.jetbrains.plugins.cucumber.steps.AbstractStepDefinition#supportsRename(String)}.
   * Show {@link #RENAME_DISABLED_MESSAGE} or {@link #RENAME_BAD_SYMBOLS_MESSAGE}
   *
   * @param newName new name (to check if renaming to it is supported) or null to check if step could be renamed at all.
   *                Steps with out of defintiions can't be renamed as well.
   * @return true it could be
   * @see #RENAME_BAD_SYMBOLS_MESSAGE
   * @see #RENAME_DISABLED_MESSAGE
   */
  boolean isRenameAllowed(@Nullable String newName);
}