Description Jeff Johnston 2006-08-14 15:29:52 EDT

Currently the CDT creates a build console that is used to display the results of make.  In dealing with Autotools projects, there is a separate step to configure and create the Makefile.  The results of this configure can be pages in length and is useful information should something go wrong.

To save this information, we created a sub-console page.  Initially we hijacked the internal CDT BuildConsole code to do this and simply change the submenuid when creating the menu.

From BuildConsolePage.java (createControl):

		MenuManager manager = new MenuManager("#MessageConsole", #MessageConsole); //$NON-NLS-1$ //$NON-NLS-2$
 
We essentially just changed the 2nd parameter to get a 2nd console.  This 2nd console can be displayed by hitting the console icon in the view.

Rather than copying the internal code, I looked into adding support directly into the CDT.  The results is the patch attached.  Note that the patch was designed to leave existing BuildConsole usage as-is.

With the patch, any builder can simply add a sub-console to save the results.  The following code is our C Configure console implementation that uses the org.eclipse.cdt.core.CBuildConsole extension point along with the attached CDT patch applied.  Note how simple the implementation is.  The results of the configure step are saved and available for inspection by the user.  Conceivably, any number of sub-consoles could be easily added for other uses.

Comments?

/*******************************************************************************
 * Copyright (c) 2002, 2004 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
 *
 * Contributors:
 * QNX Software Systems - Initial API and implementation
 *******************************************************************************/
package com.redhat.eclipse.cdt.autotools.internal.ui;

import org.eclipse.cdt.core.ConsoleOutputStream;
import org.eclipse.cdt.core.resources.IConsole;
import org.eclipse.cdt.ui.CUIPlugin;
import org.eclipse.cdt.ui.IBuildConsoleManager;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;

public class CConfigureConsole implements IConsole {
	IProject project;
	IBuildConsoleManager fConsoleManager;
	
	private static final String MENU_ID = "com.redhat.eclipse.cdt.autotools.configureConsole";  //$NON-NLS-1$
	private static final String CONTEXT_MENU_ID = "CAutotoolsConfigureConsole"; //$NON-NLS-1$
	
	public CConfigureConsole() {
		String consoleName = ConsoleMessages.getString("ConfigureConsole.configureConsole"); //$NON-NLS-1$
		fConsoleManager = CUIPlugin.getDefault().getSubConsoleManager(consoleName, 
				MENU_ID, CONTEXT_MENU_ID);
	}
	
//	/**
//	 * Constructor for ConfigureConsole.
//	 */
//	public CConfigureConsole() {
//		fConsoleManager = AutotoolsPlugin.getDefault().getConsoleManager();
//	}
//

	public void start(IProject project ) {
		this.project = project;
		fConsoleManager.getConsole(project).start(project);
	}
	
	/**
	 * @throws CoreException
	 * @see org.eclipse.cdt.core.resources.IConsole#getOutputStream()
	 */
	public ConsoleOutputStream getOutputStream() throws CoreException {
		return fConsoleManager.getConsole(project).getOutputStream();
	}

	public ConsoleOutputStream getInfoStream() throws CoreException {
		return fConsoleManager.getConsole(project).getInfoStream();
	}

	public ConsoleOutputStream getErrorStream() throws CoreException {
		return fConsoleManager.getConsole(project).getErrorStream();
	}
}