Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: dc622120fe951d1cf53db4687104080aad50027d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*******************************************************************************
 * Copyright (c) 2016 QNX Software Systems and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package org.eclipse.cdt.core.build;

import java.util.Map;

import org.eclipse.cdt.core.envvar.IEnvironmentVariable;
import org.eclipse.cdt.core.model.IBinary;
import org.eclipse.cdt.core.parser.IScannerInfoProvider;
import org.eclipse.cdt.core.resources.IConsole;
import org.eclipse.core.resources.IBuildConfiguration;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IProgressMonitor;

/**
 * This is the root interface for "new style" CDT build configurations. Adapting
 * IBuildConfiguration to this interface will get you one of these. From here,
 * adapt to the specific interface that you need and the configuration will
 * provide one.
 * 
 * @since 6.0
 */
public interface ICBuildConfiguration extends IAdaptable, IScannerInfoProvider {

	/**
	 * CDT doesn't like that the Platform default config name is an empty string.
	 * It needs a real name for the name of the build directory, for example.
	 */
	public static String DEFAULT_NAME = "default";
	
	/**
	 * Returns the resources build configuration that this CDT build
	 * configuration is associated with.
	 * 
	 * @return resources build configuration
	 */
	IBuildConfiguration getBuildConfiguration() throws CoreException;

	/**
	 * Build Configurations are configurations for a given toolchain.
	 * 
	 * @return the toolchain for this build configuration
	 */
	IToolChain getToolChain() throws CoreException;
	
	String getBinaryParserId() throws CoreException;

	IEnvironmentVariable getVariable(String name) throws CoreException;

	IEnvironmentVariable[] getVariables() throws CoreException;

	IProject[] build(int kind, Map<String, String> args, IConsole console, IProgressMonitor monitor) throws CoreException;

	void clean(IConsole console, IProgressMonitor monitor) throws CoreException;

	/**
	 * @return build output IContainer
	 * @throws CoreException
	 * @since 6.1
	 */
	default IBinary[] getBuildOutput() throws CoreException {
		return null;
	}

	/**
	 * 
	 * @param env
	 * @since 6.1
	 */
	default void setBuildEnvironment(Map<String, String> env) {
	}
}

Back to the top