/*
 * Copyright 2000-2011 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.execution.configuration;

import com.intellij.execution.ExecutionException;
import com.intellij.execution.Location;
import com.intellij.execution.configurations.GeneralCommandLine;
import com.intellij.execution.configurations.RunConfigurationBase;
import com.intellij.execution.configurations.RunnerSettings;
import com.intellij.execution.process.ProcessHandler;
import com.intellij.openapi.options.SettingsEditor;
import com.intellij.openapi.util.InvalidDataException;
import com.intellij.openapi.util.WriteExternalException;
import org.jdom.Element;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * @author traff
 */
public abstract class RunConfigurationExtensionBase<T extends RunConfigurationBase> {
  @NotNull
  protected abstract String getSerializationId();

  protected abstract void readExternal(@NotNull final T runConfiguration,
                                       @NotNull final Element element) throws InvalidDataException;

  protected abstract void writeExternal(@NotNull final T runConfiguration,
                                        @NotNull final Element element) throws WriteExternalException;

  @Nullable
  protected abstract <P extends T> SettingsEditor<P> createEditor(@NotNull final P configuration);

  @Nullable
  protected abstract String getEditorTitle();

  /**
   * @param configuration Run configuration
   * @return True if extension in general applicable to given run configuration - just to attach settings tab, etc. But extension may be
   *         turned off in it's settings. E.g. RCov in general available for given run configuration, but may be turned off.
   */
  protected abstract boolean isApplicableFor(@NotNull final T configuration);

  /**
   *
   * @param applicableConfiguration Applicable run configuration
   * @param runnerSettings
   * @return True if extension is tuned on in configuration extension settings.
   *         E.g. RCov is turned on for given run configuration.
   */
  protected abstract boolean isEnabledFor(@NotNull final T applicableConfiguration, @Nullable RunnerSettings runnerSettings);

  protected abstract void patchCommandLine(@NotNull final T configuration,
                                           RunnerSettings runnerSettings, @NotNull final GeneralCommandLine cmdLine,
                                           @NotNull final String runnerId) throws ExecutionException;

  /**
   * Validate extensions after general configuration validation passed
   *
   * @param configuration
   * @param isExecution
   * @param <T>
   * @throws com.intellij.execution.ExecutionException
   *
   */
  protected abstract void validateConfiguration(@NotNull final T configuration,
                                                final boolean isExecution) throws Exception;

  /**
   * Setup extension settings for created run configuration
   *
   * @param configuration Configuration
   * @param location
   */
  protected abstract void extendCreatedConfiguration(@NotNull final T configuration,
                                                     @NotNull final Location location);

  protected abstract void extendTemplateConfiguration(@NotNull final T configuration);

  protected abstract void attachToProcess(@NotNull final T configuration,
                                          @NotNull final ProcessHandler handler,
                                          RunnerSettings runnerSettings);
}