Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 46e822098a3ee9aff76181f0951951fdc3857adf (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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/*******************************************************************************
 * Copyright (c) 2006, 2011 Intel Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 * Intel Corporation - Initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.managedbuilder.internal.buildmodel;

import java.io.IOException;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.cdt.managedbuilder.buildmodel.BuildDescriptionManager;
import org.eclipse.cdt.managedbuilder.buildmodel.IBuildDescription;
import org.eclipse.cdt.managedbuilder.buildmodel.IBuildResource;
import org.eclipse.cdt.managedbuilder.buildmodel.IBuildStep;
import org.eclipse.cdt.managedbuilder.buildmodel.IStepVisitor;
import org.eclipse.cdt.managedbuilder.internal.core.ManagedMakeMessages;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;

/**
 *
 * This class implements the IBuildDescription building,
 * that is the build of the entire configuration/project
 * To perform a build, create an instance of this class
 * and invoke the build method
 *
 * NOTE: This class is subject to change and discuss,
 * and is currently available in experimental mode only
 *
 */
public class DescriptionBuilder implements IBuildModelBuilder {
	private static final String BUILDER_MSG_HEADER = "InternalBuilder.msg.header"; //$NON-NLS-1$
	private static final String BUILDER_NOTHING_TODO = "InternalBuilder.nothing.todo"; //$NON-NLS-1$
	private static final String LINE_SEPARATOR = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$

	private IBuildDescription fDes;
	private IPath fCWD;
	private boolean fBuildIncrementaly;
	private boolean fResumeOnErrs;
	private Map<IBuildStep, StepBuilder> fStepToStepBuilderMap = new HashMap<>();
	private int fNumCommands = -1;
	private GenDirInfo fDir;
	private IResourceRebuildStateContainer fRebuildStateContainer;

	private class BuildStepVisitor implements IStepVisitor {
		private OutputStream fOut;
		private OutputStream fErr;
		private IProgressMonitor fMonitor;
		private int fStatus;
		private boolean fBuild;

		public BuildStepVisitor(OutputStream out, OutputStream err, IProgressMonitor monitor) {
			this(out, err, monitor, true);
		}

		public BuildStepVisitor(OutputStream out, OutputStream err, IProgressMonitor monitor, boolean build) {
			fOut = out;
			fErr = err;
			fMonitor = monitor;
			fStatus = STATUS_OK;
			fBuild = build;
		}

		/* (non-Javadoc)
		 * @see org.eclipse.cdt.managedbuilder.builddescription.IStepVisitor#visit(org.eclipse.cdt.managedbuilder.builddescription.IBuildStep)
		 */
		@Override
		public int visit(IBuildStep action) throws CoreException {
			if (fMonitor.isCanceled())
				return VISIT_STOP;

			if (DbgUtil.DEBUG)
				DbgUtil.trace("visiting step " + DbgUtil.stepName(action)); //$NON-NLS-1$
			if (!action.isRemoved() && (!fBuildIncrementaly || action.needsRebuild())) {
				if (DbgUtil.DEBUG)
					DbgUtil.trace("step " + DbgUtil.stepName(action) + " needs rebuild"); //$NON-NLS-1$ //$NON-NLS-2$
				StepBuilder builder = getStepBuilder(action);//new StepBuilder(action, fCWD, fResumeOnErrs, fDir);

				if (fBuild) {
					switch (builder.build(fOut, fErr, new SubProgressMonitor(fMonitor, builder.getNumCommands()))) {
					case STATUS_OK:
						break;
					case STATUS_CANCELLED:
						fStatus = STATUS_CANCELLED;
						break;
					case STATUS_ERROR_BUILD:
					case STATUS_ERROR_LAUNCH:
					default:
						fStatus = STATUS_ERROR_BUILD;
						break;
					}
				} else {
					fNumCommands += builder.getNumCommands();
				}
			}

			if (fStatus != STATUS_CANCELLED && (fResumeOnErrs || fStatus == STATUS_OK))
				return VISIT_CONTINUE;
			return VISIT_STOP;
		}

	}

	public DescriptionBuilder(IBuildDescription des, IResourceRebuildStateContainer rs) {
		this(des, true, rs);
	}

	public DescriptionBuilder(IBuildDescription des, boolean buildIncrementaly, IResourceRebuildStateContainer rs) {
		this(des, buildIncrementaly, true, rs);
	}

	public DescriptionBuilder(IBuildDescription des, boolean buildIncrementaly, boolean resumeOnError,
			IResourceRebuildStateContainer rs) {
		this(des, buildIncrementaly, resumeOnError, null, rs);
	}

	public DescriptionBuilder(IBuildDescription des, boolean buildIncrementaly, boolean resumeOnErrs, IPath cwd,
			IResourceRebuildStateContainer rs) {
		fDes = des;
		fCWD = cwd;
		fBuildIncrementaly = buildIncrementaly;
		fResumeOnErrs = resumeOnErrs;
		fDir = new GenDirInfo(fDes.getConfiguration());

		if (fCWD == null)
			fCWD = fDes.getDefaultBuildDirLocation();

		fRebuildStateContainer = rs;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.cdt.managedbuilder.internal.builddescription.IBuildDescriptionBuilder#build(java.io.OutputStream, java.io.OutputStream, org.eclipse.core.runtime.IProgressMonitor)
	 */
	@Override
	public int build(OutputStream out, OutputStream err, IProgressMonitor monitor) {

		initRebuildStates();
		int num = getNumCommands();
		int status = STATUS_OK;

		//TODO: should we specify some task name here?
		monitor.beginTask("", num > 0 ? num : 1); //$NON-NLS-1$
		monitor.subTask(""); //$NON-NLS-1$

		if (num > 0) {
			BuildStepVisitor visitor = new BuildStepVisitor(out, err, monitor);
			try {
				BuildDescriptionManager.accept(visitor, fDes, true);
			} catch (CoreException e) {
				status = STATUS_ERROR_LAUNCH;
			}

			if (status == STATUS_OK)
				status = visitor.fStatus;
		} else {
			printMessage(ManagedMakeMessages.getFormattedString(BUILDER_NOTHING_TODO,
					fDes.getConfiguration().getOwner().getName()), out);
		}

		monitor.done();

		if (status == STATUS_OK)
			clearRebuildStates();

		return status;
	}

	public int getNumCommands() {
		if (fNumCommands == -1) {
			fNumCommands = 0;
			BuildStepVisitor visitor = new BuildStepVisitor(null, null, new NullProgressMonitor(), false);
			try {
				BuildDescriptionManager.accept(visitor, fDes, true);
			} catch (CoreException e) {
				//TODO: report an error
			}
			if (DbgUtil.DEBUG)
				DbgUtil.trace("Description Builder: total work = " + fNumCommands); //$NON-NLS-1$
		}
		return fNumCommands;
	}

	protected StepBuilder getStepBuilder(IBuildStep step) {
		StepBuilder b = fStepToStepBuilderMap.get(step);
		if (b == null) {
			b = new StepBuilder(step, fCWD, fResumeOnErrs, fDir, fRebuildStateContainer);
			fStepToStepBuilderMap.put(step, b);
		}
		return b;
	}

	protected void printMessage(String msg, OutputStream os) {
		if (os != null) {
			msg = ManagedMakeMessages.getFormattedString(BUILDER_MSG_HEADER, msg) + LINE_SEPARATOR;
			try {
				os.write(msg.getBytes());
				os.flush();
			} catch (IOException e) {
				// ignore;
			}
		}
	}

	private void initRebuildStates() {
		if (fRebuildStateContainer == null)
			return;

		fRebuildStateContainer.setState(0);

		IBuildResource[] rcs = fDes.getResources();
		putAll(fRebuildStateContainer, rcs, IRebuildState.NEED_REBUILD, true);
	}

	private void clearRebuildStates() {
		if (fRebuildStateContainer == null)
			return;

		fRebuildStateContainer.setState(0);

		//		IBuildResource[] rcs = fDes.getResources();
		//		putAll(fRebuildStateContainer, rcs, IRebuildState.NEED_REBUILD, true);
	}

	static void putAll(IResourceRebuildStateContainer cbs, IBuildResource[] rcs, int state, boolean rebuildRcOnly) {
		for (int i = 0; i < rcs.length; i++) {
			IBuildResource rc = rcs[i];
			if (rebuildRcOnly && !rc.needsRebuild())
				continue;

			if (!rc.isProjectResource())
				continue;
			IPath fullPath = rc.getFullPath();
			if (fullPath == null)
				continue;

			cbs.setStateForFullPath(fullPath, state);
		}
	}

}

Back to the top