VisualStudioProject.java

/*
 * 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.BuildableComponentSpec;
import org.gradle.api.Incubating;
import org.gradle.nativeplatform.NativeComponentSpec;

/**
 * A visual studio project, created from one or more {@link org.gradle.nativeplatform.NativeBinary} instances.
 *
 * <p/>
 *
 * The content and location of the generate project file can be modified by the supplied methods:
 *
 * <pre autoTested="true">
 *  apply plugin: "visual-studio"
 *  model {
 *      visualStudio {
 *          projects.all {
 *              projectFile.location = "vs/${name}.vcxproj"
 *              projectFile.withXml {
 *                  asNode().appendNode('PropertyGroup', [Label: 'Custom'])
 *                          .appendNode('ProjectDetails', "Project is named ${project.name}")
 *              }
 *          }
 *      }
 *  }
 * </pre>
 */
@Incubating
public interface VisualStudioProject extends BuildableComponentSpec {
    /**
     * The component that this project represents.
     */
    NativeComponentSpec getComponent();

    /**
     * Configuration for the generated project file.
     */
    XmlConfigFile getProjectFile();

    /**
     * Configuration for the generated filters file.
     */
    XmlConfigFile getFiltersFile();
}