/*
 * Copyright 2013 the original author or authors.
 *
 * 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 org.gradle.ide.visualstudio;

import org.gradle.api.Buildable;
import org.gradle.api.Incubating;
import org.gradle.api.Named;
import org.gradle.api.file.RegularFile;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.TaskDependency;
import org.gradle.internal.HasInternalProtocol;
import org.gradle.plugins.ide.IdeWorkspace;

/**
 * A visual studio solution, representing one or more native binaries in a build.
 * <p>
 *
 * The content and location of the generate solution file can be modified by the supplied methods:
 *
 * <pre class='autoTested'>
 *  apply plugin: "visual-studio"
 *  model {
 *      visualStudio {
 *          solution {
 *              solutionFile.location = "vs/${name}.sln"
 *              solutionFile.withContent { TextProvider content -&gt;
 *                  content.asBuilder().insert(0, "# GENERATED FILE: DO NOT EDIT\n")
 *                  content.text = content.text.replaceAll("HideSolutionNode = FALSE", "HideSolutionNode = TRUE")
 *              }
 *          }
 *      }
 *  }
 * </pre>
 */
@Incubating
@HasInternalProtocol
public interface VisualStudioSolution extends Named, Buildable, IdeWorkspace {
    /**
     * Configuration for the generated solution file.
     */
    @Internal
    TextConfigFile getSolutionFile();

    /**
     * Returns the location of the generated solution file.
     */
    @Override
    @Internal
    Provider<RegularFile> getLocation();

    @Override
    @Internal
    TaskDependency getBuildDependencies();

    @Override
    @Internal
    String getName();

    @Override
    @Internal
    String getDisplayName();
}
