diff --git a/build/org.eclipse.cdt.make.core.tests/META-INF/MANIFEST.MF b/build/org.eclipse.cdt.make.core.tests/META-INF/MANIFEST.MF index 1cb128cd491..76c77948d90 100644 --- a/build/org.eclipse.cdt.make.core.tests/META-INF/MANIFEST.MF +++ b/build/org.eclipse.cdt.make.core.tests/META-INF/MANIFEST.MF @@ -5,7 +5,8 @@ Bundle-SymbolicName: org.eclipse.cdt.make.core.tests;singleton:=true Bundle-Version: 7.0.0.qualifier Bundle-Activator: org.eclipse.cdt.make.core.tests.MakeTestsPlugin Export-Package: org.eclipse.cdt.make.builder.tests, - org.eclipse.cdt.make.core.tests + org.eclipse.cdt.make.core.tests, + org.eclipse.cdt.make.scannerdiscovery;x-internal:=true Require-Bundle: org.eclipse.core.runtime, org.junit, org.eclipse.cdt.make.core, diff --git a/build/org.eclipse.cdt.make.core.tests/plugin.xml b/build/org.eclipse.cdt.make.core.tests/plugin.xml new file mode 100644 index 00000000000..e1239de8486 --- /dev/null +++ b/build/org.eclipse.cdt.make.core.tests/plugin.xml @@ -0,0 +1,14 @@ + + + + + + + + diff --git a/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/AllLanguageSettingsProvidersMakeCoreTests.java b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/AllLanguageSettingsProvidersMakeCoreTests.java new file mode 100644 index 00000000000..511adb8428f --- /dev/null +++ b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/AllLanguageSettingsProvidersMakeCoreTests.java @@ -0,0 +1,27 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.make.scannerdiscovery; + +import junit.framework.TestSuite; + +public class AllLanguageSettingsProvidersMakeCoreTests extends TestSuite { + + public static TestSuite suite() { + return new AllLanguageSettingsProvidersMakeCoreTests(); + } + + public AllLanguageSettingsProvidersMakeCoreTests() { + super(AllLanguageSettingsProvidersMakeCoreTests.class.getName()); + + addTestSuite(GCCBuildCommandParserTest.class); + addTestSuite(BuiltinSpecsDetectorTest.class); + } +} diff --git a/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/BuiltinSpecsDetectorTest.java b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/BuiltinSpecsDetectorTest.java new file mode 100644 index 00000000000..2985f1ff23b --- /dev/null +++ b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/BuiltinSpecsDetectorTest.java @@ -0,0 +1,421 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + package org.eclipse.cdt.make.scannerdiscovery; + +import java.io.IOException; +import java.io.OutputStream; +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.ErrorParserManager; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.CIncludeFileEntry; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CLibraryFileEntry; +import org.eclipse.cdt.core.settings.model.CLibraryPathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.CMacroFileEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuiltinSpecsDetector; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.jobs.Job; +import org.w3c.dom.Document; +import org.w3c.dom.Element; + +public class BuiltinSpecsDetectorTest extends BaseTestCase { + private static final String PROVIDER_ID = "provider.id"; + private static final String PROVIDER_NAME = "provider name"; + private static final String LANGUAGE_ID = "language.test.id"; + private static final String CUSTOM_PARAMETER = "customParameter"; + private static final String ELEM_TEST = "test"; + + // those attributes must match that in AbstractBuiltinSpecsDetector + private static final String ATTR_CONSOLE = "console"; //$NON-NLS-1$ + + private class MockBuiltinSpecsDetector extends AbstractBuiltinSpecsDetector { + @Override + protected void startupForLanguage(String languageId) throws CoreException { + super.startupForLanguage(languageId); + } + @Override + protected void shutdownForLanguage() { + super.shutdownForLanguage(); + } + @Override + protected List parseForOptions(String line) { + return null; + } + @Override + protected AbstractOptionParser[] getOptionParsers() { + return null; + } + } + + private class MockBuiltinSpecsDetectorExecutedFlag extends AbstractBuiltinSpecsDetector { + @Override + protected List parseForOptions(String line) { + return null; + } + @Override + protected AbstractOptionParser[] getOptionParsers() { + return null; + } + @Override + protected void execute() { + super.execute(); + } + protected boolean isExecuted() { + return isExecuted; + } + } + + private class MockConsoleBuiltinSpecsDetector extends AbstractBuiltinSpecsDetector { + @SuppressWarnings("nls") + private final AbstractOptionParser[] optionParsers = { + new MacroOptionParser("#define (\\S*) *(\\S*)", "$1", "$2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + }; + @Override + protected boolean runProgram(String command, String[] env, IPath workingDirectory, IProgressMonitor monitor, + OutputStream consoleOut, OutputStream consoleErr) throws CoreException, IOException { + printLine(consoleOut, "#define MACRO VALUE"); + consoleOut.close(); + consoleErr.close(); + return true; + } + @Override + protected IStatus runForEachLanguage(ICConfigurationDescription cfgDescription, IPath workingDirectory, + String[] env, IProgressMonitor monitor) { + return super.runForEachLanguage(cfgDescription, workingDirectory, env, monitor); + } + @Override + protected List parseForOptions(final String line) { + return new ArrayList() {{ add(line); }}; + } + @Override + protected AbstractOptionParser[] getOptionParsers() { + return optionParsers; + } + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + Job.getJobManager().join(AbstractBuiltinSpecsDetector.JOB_FAMILY_BUILTIN_SPECS_DETECTOR, null); + super.tearDown(); + } + + private ICConfigurationDescription[] getConfigurationDescriptions(IProject project) { + CoreModel coreModel = CoreModel.getDefault(); + ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager(); + // project description + ICProjectDescription projectDescription = mngr.getProjectDescription(project, false); + assertNotNull(projectDescription); + assertEquals(1, projectDescription.getConfigurations().length); + // configuration description + ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations(); + return cfgDescriptions; + } + + public void testAbstractBuiltinSpecsDetector_GettersSetters() throws Exception { + // define mock detector + MockBuiltinSpecsDetectorExecutedFlag detector = new MockBuiltinSpecsDetectorExecutedFlag(); + + detector.configureProvider(PROVIDER_ID, PROVIDER_NAME, null, null, null); + assertEquals(PROVIDER_ID, detector.getId()); + assertEquals(PROVIDER_NAME, detector.getName()); + assertEquals(null, detector.getLanguageScope()); + assertEquals(null, detector.getSettingEntries(null, null, null)); + assertEquals(null, detector.getCustomParameter()); + assertEquals(false, detector.isExecuted()); + + List languages = new ArrayList(); + languages.add(LANGUAGE_ID); + List entries = new ArrayList(); + ICLanguageSettingEntry entry = new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + entries.add(entry); + + detector.configureProvider(PROVIDER_ID, PROVIDER_NAME, languages, entries, CUSTOM_PARAMETER); + assertEquals(PROVIDER_ID, detector.getId()); + assertEquals(PROVIDER_NAME, detector.getName()); + assertEquals(languages, detector.getLanguageScope()); + assertEquals(entries, detector.getSettingEntries(null, null, null)); + assertEquals(CUSTOM_PARAMETER, detector.getCustomParameter()); + assertEquals(false, detector.isExecuted()); + + detector.execute(); + assertEquals(true, detector.isExecuted()); + } + + public void testAbstractBuiltinSpecsDetector_CloneAndEquals() throws Exception { + // define mock detector + class MockDetectorCloneable extends MockBuiltinSpecsDetectorExecutedFlag implements Cloneable { + @Override + public MockDetectorCloneable clone() throws CloneNotSupportedException { + return (MockDetectorCloneable) super.clone(); + } + @Override + public MockDetectorCloneable cloneShallow() throws CloneNotSupportedException { + return (MockDetectorCloneable) super.cloneShallow(); + } + } + + // create instance to compare to + MockDetectorCloneable detector = new MockDetectorCloneable(); + + List languages = new ArrayList(); + languages.add(LANGUAGE_ID); + List entries = new ArrayList(); + ICLanguageSettingEntry entry = new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + entries.add(entry); + + // check clone after initialization + MockDetectorCloneable clone0 = detector.clone(); + assertTrue(detector.equals(clone0)); + + // configure provider + detector.configureProvider(PROVIDER_ID, PROVIDER_NAME, languages, entries, CUSTOM_PARAMETER); + assertEquals(false, detector.isConsoleEnabled()); + detector.setConsoleEnabled(true); + detector.execute(); + assertEquals(true, detector.isExecuted()); + assertFalse(detector.equals(clone0)); + + // check another clone after configuring + { + MockDetectorCloneable clone = detector.clone(); + assertTrue(detector.equals(clone)); + } + + // check custom parameter + { + MockDetectorCloneable clone = detector.clone(); + clone.setCustomParameter("changed"); + assertFalse(detector.equals(clone)); + } + + // check language scope + { + MockDetectorCloneable clone = detector.clone(); + clone.setLanguageScope(null); + assertFalse(detector.equals(clone)); + } + + // check console flag + { + MockDetectorCloneable clone = detector.clone(); + boolean isConsoleEnabled = clone.isConsoleEnabled(); + clone.setConsoleEnabled( ! isConsoleEnabled ); + assertFalse(detector.equals(clone)); + } + + // check isExecuted flag + { + MockDetectorCloneable clone = detector.clone(); + assertEquals(true, clone.isExecuted()); + clone.clear(); + assertEquals(false, clone.isExecuted()); + assertFalse(detector.equals(clone)); + } + + // check entries + { + MockDetectorCloneable clone = detector.clone(); + clone.setSettingEntries(null, null, null, null); + assertFalse(detector.equals(clone)); + } + + // check cloneShallow() + { + MockDetectorCloneable detector2 = detector.clone(); + MockDetectorCloneable clone = detector2.cloneShallow(); + assertEquals(false, clone.isExecuted()); + assertFalse(detector2.equals(clone)); + + detector2.setSettingEntries(null, null, null, null); + assertFalse(detector2.equals(clone)); + + clone.execute(); + assertTrue(detector2.equals(clone)); + } + } + + /** + */ + public void testAbstractBuiltinSpecsDetector_Serialize() throws Exception { + { + // create empty XML + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + + // load it to new provider + MockBuiltinSpecsDetectorExecutedFlag detector = new MockBuiltinSpecsDetectorExecutedFlag(); + detector.load(rootElement); + assertEquals(false, detector.isConsoleEnabled()); + } + + Element elementProvider; + { + // define mock detector + MockBuiltinSpecsDetectorExecutedFlag detector = new MockBuiltinSpecsDetectorExecutedFlag(); + assertEquals(false, detector.isConsoleEnabled()); + + // redefine the settings + detector.setConsoleEnabled(true); + assertEquals(true, detector.isConsoleEnabled()); + + // serialize in XML + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = detector.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + + assertTrue(xmlString.contains(ATTR_CONSOLE)); + } + { + // create another instance of the provider + MockBuiltinSpecsDetectorExecutedFlag detector = new MockBuiltinSpecsDetectorExecutedFlag(); + assertEquals(false, detector.isConsoleEnabled()); + + // load element + detector.load(elementProvider); + assertEquals(true, detector.isConsoleEnabled()); + } + } + + public void testAbstractBuiltinSpecsDetector_Nulls() throws Exception { + { + // test AbstractBuiltinSpecsDetector.processLine(...) flow + MockBuiltinSpecsDetector detector = new MockBuiltinSpecsDetector(); + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine(null, null); + detector.shutdownForLanguage(); + detector.shutdown(); + } + { + // test AbstractBuiltinSpecsDetector.processLine(...) flow + MockConsoleBuiltinSpecsDetector detector = new MockConsoleBuiltinSpecsDetector(); + detector.runForEachLanguage(null, null, null, null); + } + } + + public void testAbstractBuiltinSpecsDetector_RunConfiguration() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + MockConsoleBuiltinSpecsDetector detector = new MockConsoleBuiltinSpecsDetector(); + detector.setLanguageScope(new ArrayList() {{add(LANGUAGE_ID);}}); + + detector.runForEachLanguage(cfgDescription, null, null, null); + assertFalse(detector.isEmpty()); + + List noentries = detector.getSettingEntries(null, null, null); + assertNull(noentries); + + List entries = detector.getSettingEntries(cfgDescription, null, LANGUAGE_ID); + ICLanguageSettingEntry expected = new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + assertEquals(expected, entries.get(0)); + } + + public void testAbstractBuiltinSpecsDetector_RunGlobal() throws Exception { + MockConsoleBuiltinSpecsDetector detector = new MockConsoleBuiltinSpecsDetector(); + detector.setLanguageScope(new ArrayList() {{add(LANGUAGE_ID);}}); + + detector.runForEachLanguage(null, null, null, null); + assertFalse(detector.isEmpty()); + + List entries = detector.getSettingEntries(null, null, LANGUAGE_ID); + ICLanguageSettingEntry expected = new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + assertEquals(expected, entries.get(0)); + } + + public void testAbstractBuiltinSpecsDetector_GroupSettings() throws Exception { + // define benchmarks + final CIncludePathEntry includePath_1 = new CIncludePathEntry("/include/path_1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CIncludePathEntry includePath_2 = new CIncludePathEntry("/include/path_2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CIncludeFileEntry includeFile_1 = new CIncludeFileEntry(new Path("/include.file1"), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CIncludeFileEntry includeFile_2 = new CIncludeFileEntry(new Path("/include.file2"), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CMacroEntry macro_1 = new CMacroEntry("MACRO_1", "", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CMacroEntry macro_2 = new CMacroEntry("MACRO_2", "", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY |ICSettingEntry.UNDEFINED); + final CMacroFileEntry macroFile_1 = new CMacroFileEntry(new Path("/macro.file1"), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CMacroFileEntry macroFile_2 = new CMacroFileEntry(new Path("/macro.file2"), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CLibraryPathEntry libraryPath_1 = new CLibraryPathEntry(new Path("/lib/path_1"), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CLibraryPathEntry libraryPath_2 = new CLibraryPathEntry(new Path("/lib/path_2"), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CLibraryFileEntry libraryFile_1 = new CLibraryFileEntry("lib_1.a", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + final CLibraryFileEntry libraryFile_2 = new CLibraryFileEntry("lib_2.a", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY); + + // Define mock detector adding unorganized entries + MockBuiltinSpecsDetector detector = new MockBuiltinSpecsDetector() { + @Override + public boolean processLine(String line, ErrorParserManager epm) { + detectedSettingEntries.add(libraryFile_1); + detectedSettingEntries.add(libraryPath_1); + detectedSettingEntries.add(macroFile_1); + detectedSettingEntries.add(macro_1); + detectedSettingEntries.add(includeFile_1); + detectedSettingEntries.add(includePath_1); + + detectedSettingEntries.add(includePath_2); + detectedSettingEntries.add(includeFile_2); + detectedSettingEntries.add(macro_2); + detectedSettingEntries.add(macroFile_2); + detectedSettingEntries.add(libraryPath_2); + detectedSettingEntries.add(libraryFile_2); + return true; + } + }; + + // run specs detector + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + // compare benchmarks, expected well-sorted + List entries = detector.getSettingEntries(null, null, null); + + int i=0; + assertEquals(includePath_1, entries.get(i++)); + assertEquals(includePath_2, entries.get(i++)); + assertEquals(includeFile_1, entries.get(i++)); + assertEquals(includeFile_2, entries.get(i++)); + assertEquals(macro_1, entries.get(i++)); + assertEquals(macro_2, entries.get(i++)); + assertEquals(macroFile_1, entries.get(i++)); + assertEquals(macroFile_2, entries.get(i++)); + assertEquals(libraryPath_1, entries.get(i++)); + assertEquals(libraryPath_2, entries.get(i++)); + assertEquals(libraryFile_1, entries.get(i++)); + assertEquals(libraryFile_2, entries.get(i++)); + + assertEquals(12, entries.size()); + } +} diff --git a/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/GCCBuildCommandParserTest.java b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/GCCBuildCommandParserTest.java new file mode 100644 index 00000000000..e6f11f55714 --- /dev/null +++ b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/GCCBuildCommandParserTest.java @@ -0,0 +1,1935 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.make.scannerdiscovery; + +import java.net.URI; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.eclipse.cdt.core.ErrorParserManager; +import org.eclipse.cdt.core.dom.ast.gnu.cpp.GPPLanguage; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.CIncludeFileEntry; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CLibraryFileEntry; +import org.eclipse.cdt.core.settings.model.CLibraryPathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.CMacroFileEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSetting; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.settings.model.CProjectDescriptionManager; +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuildCommandParser; +import org.eclipse.cdt.make.internal.core.scannerconfig.GCCBuildCommandParser; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Platform; +import org.eclipse.core.runtime.content.IContentType; +import org.eclipse.core.runtime.content.IContentTypeManager; +import org.eclipse.core.runtime.content.IContentTypeSettings; +import org.eclipse.core.runtime.jobs.Job; +import org.w3c.dom.Document; +import org.w3c.dom.Element; + +public class GCCBuildCommandParserTest extends BaseTestCase { + // ID of the parser taken from the extension point + private static final String GCC_BUILD_COMMAND_PARSER_EXT = "org.eclipse.cdt.make.core.build.command.parser.gcc"; //$NON-NLS-1$ + + private static final String ELEM_TEST = "test"; + private static final String LANG_CPP = GPPLanguage.ID; + + // those attributes must match that in AbstractBuiltinSpecsDetector + private static final String ATTR_EXPAND_RELATIVE_PATHS = "expand-relative-paths"; //$NON-NLS-1$ + + private class MockBuildCommandParser extends AbstractBuildCommandParser implements Cloneable { + @Override + protected AbstractOptionParser[] getOptionParsers() { + return new AbstractOptionParser[] {}; + } + @Override + public MockBuildCommandParser cloneShallow() throws CloneNotSupportedException { + return (MockBuildCommandParser) super.cloneShallow(); + } + @Override + public MockBuildCommandParser clone() throws CloneNotSupportedException { + return (MockBuildCommandParser) super.clone(); + } + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + Job.getJobManager().join(AbstractBuildCommandParser.JOB_FAMILY_BUILD_COMMAND_PARSER, null); + super.tearDown(); + } + + private ICConfigurationDescription[] getConfigurationDescriptions(IProject project) { + CoreModel coreModel = CoreModel.getDefault(); + ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager(); + // project description + ICProjectDescription projectDescription = mngr.getProjectDescription(project, false); + assertNotNull(projectDescription); + assertEquals(1, projectDescription.getConfigurations().length); + // configuration description + ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations(); + return cfgDescriptions; + } + + /** + * Sets build working directory for DefaultSettingConfiguration being tested. + */ + private void setBuilderCWD(IProject project, IPath buildCWD) throws CoreException { + CProjectDescriptionManager manager = CProjectDescriptionManager.getInstance(); + { + ICProjectDescription prjDescription = manager.getProjectDescription(project, true); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + cfgDescription.getBuildSetting().setBuilderCWD(buildCWD); + manager.setProjectDescription(project, prjDescription); + // doublecheck builderCWD + IPath actualBuildCWD = cfgDescription.getBuildSetting().getBuilderCWD(); + assertEquals(buildCWD, actualBuildCWD); + } + { + // triplecheck builderCWD for different project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, false); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + } + } + + private void setReference(IProject project, final IProject projectReferenced) throws CoreException { + { + CoreModel coreModel = CoreModel.getDefault(); + ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager(); + // project description + ICProjectDescription projectDescription = mngr.getProjectDescription(project); + assertNotNull(projectDescription); + assertEquals(1, projectDescription.getConfigurations().length); + // configuration description + ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + final ICConfigurationDescription cfgDescriptionReferenced = getConfigurationDescriptions(projectReferenced)[0]; + cfgDescription.setReferenceInfo(new HashMap() {{ put(projectReferenced.getName(), cfgDescriptionReferenced.getId()); }}); + coreModel.setProjectDescription(project, projectDescription); + } + + { + // doublecheck that it's set as expected + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + Map refs = cfgDescription.getReferenceInfo(); + assertEquals(1, refs.size()); + Set referencedProjectsNames = new LinkedHashSet(refs.keySet()); + assertEquals(projectReferenced.getName(), referencedProjectsNames.toArray()[0]); + } + + } + + + public void testAbstractBuildCommandParser_CloneAndEquals() throws Exception { + // create instance to compare to + MockBuildCommandParser parser = new MockBuildCommandParser(); + assertEquals(true, parser.isResolvingPaths()); + + // check clone after initialization + MockBuildCommandParser clone0 = parser.clone(); + assertTrue(parser.equals(clone0)); + + // configure provider + parser.setResolvingPaths(false); + assertFalse(parser.equals(clone0)); + + // check another clone after configuring + { + MockBuildCommandParser clone = parser.clone(); + assertTrue(parser.equals(clone)); + } + + // check 'expand relative paths' flag + { + MockBuildCommandParser clone = parser.clone(); + boolean expandRelativePaths = clone.isResolvingPaths(); + clone.setResolvingPaths( ! expandRelativePaths ); + assertFalse(parser.equals(clone)); + } + + // check cloneShallow() + { + MockBuildCommandParser parser2 = parser.clone(); + MockBuildCommandParser clone = parser2.cloneShallow(); + assertTrue(parser2.equals(clone)); + } + + } + + public void testAbstractBuildCommandParser_Serialize() throws Exception { + { + // create empty XML + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + + // load it to new provider + MockBuildCommandParser parser = new MockBuildCommandParser(); + parser.load(rootElement); + assertEquals(true, parser.isResolvingPaths()); + } + + Element elementProvider; + { + // define mock parser + MockBuildCommandParser parser = new MockBuildCommandParser(); + assertEquals(true, parser.isResolvingPaths()); + + // redefine the settings + parser.setResolvingPaths(false); + assertEquals(false, parser.isResolvingPaths()); + + // serialize in XML + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = parser.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + + assertTrue(xmlString.contains(ATTR_EXPAND_RELATIVE_PATHS)); + } + { + // create another instance of the provider + MockBuildCommandParser parser = new MockBuildCommandParser(); + assertEquals(true, parser.isResolvingPaths()); + + // load element + parser.load(elementProvider); + assertEquals(false, parser.isResolvingPaths()); + } + } + + public void testAbstractBuildCommandParser_Nulls() throws Exception { + MockBuildCommandParser parser = new MockBuildCommandParser(); + parser.startup(null); + parser.processLine(null); + parser.shutdown(); + + List entries = parser.getSettingEntries(null, null, null); + assertNull(entries); + } + + public void testAbstractBuildCommandParser_Basic() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + final IFile file=ResourceHelper.createFile(project, "file.cpp"); + + // create test class + AbstractBuildCommandParser parser = new MockBuildCommandParser() { + @Override + public boolean processLine(String line, ErrorParserManager epm) { + // pretending that we parsed the line + currentResource = file; + List entries = new ArrayList(); + ICLanguageSettingEntry entry = new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN); + entries.add(entry); + setSettingEntries(entries); + return true; + } + }; + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -DMACRO=VALUE file.cpp"); + parser.shutdown(); + + // sanity check that it does not return same values for all inputs + List noentries = parser.getSettingEntries(null, null, null); + assertNull(noentries); + + // check populated entries + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + CMacroEntry expected = new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN); + assertEquals(expected, entries.get(0)); + } + +// public void testGCCBuildCommandParser_Nulls() throws Exception { +// GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); +// parser.startup(null); +// parser.processLine(null); +// parser.shutdown(); +// +// List entries = parser.getSettingEntries(null, null, null); +// assertNull(entries); +// } + + /** + */ + public void testOneEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + IPath path = new Path("/path0").setDevice(project.getLocation().getDevice()); + CIncludePathEntry expected = new CIncludePathEntry(path, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + } + + /** + */ + public void testGccFlavors() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file1=ResourceHelper.createFile(project, "file1.cpp"); + IFile file2=ResourceHelper.createFile(project, "file2.cpp"); + IFile file3=ResourceHelper.createFile(project, "file3.cpp"); + IFile file4=ResourceHelper.createFile(project, "file4.cpp"); + IFile file5=ResourceHelper.createFile(project, "file5.cpp"); + IFile file6=ResourceHelper.createFile(project, "file6.cpp"); + IFile file7=ResourceHelper.createFile(project, "file7.cpp"); + IFile file8=ResourceHelper.createFile(project, "file8.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file1.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 file1.cpp"); + parser.processLine("gcc-4.2 -I/path0 file2.cpp"); + parser.processLine("g++ -I/path0 file3.cpp"); + parser.processLine("c++ -I/path0 file4.cpp"); + parser.processLine("\"gcc\" -I/path0 file5.cpp"); + parser.processLine("/absolute/path/gcc -I/path0 file6.cpp"); + parser.processLine(" \"/absolute/path/gcc\" -I/path0 file7.cpp"); + parser.processLine("../relative/path/gcc -I/path0 file8.cpp"); + parser.shutdown(); + + // check populated entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(cfgDescription, file1, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file2, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file3, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file4, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file5, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file6, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file7, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + { + List entries = parser.getSettingEntries(cfgDescription, file8, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + } + } + + /** + */ + public void testCIncludePathEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc" + // regular + + " -I/path0 " + // space after -I + + " -I /path1 " + // unknown option, should be ignored + + " -? " + // double-quoted path with spaces + + " -I\"/path with spaces\"" + // single-quoted path with spaces + + " -I'/path with spaces2'" + // second single-quoted and space after -I + + " -I '/path with spaces3'" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + IPath path = new Path("/path0").setDevice(project.getLocation().getDevice()); + CIncludePathEntry expected = new CIncludePathEntry(path, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + { + IPath path = new Path("/path1").setDevice(project.getLocation().getDevice()); + CIncludePathEntry expected = new CIncludePathEntry(path, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(1); + assertEquals(expected, entry); + } + { + IPath path = new Path("/path with spaces").setDevice(project.getLocation().getDevice()); + CIncludePathEntry expected = new CIncludePathEntry(path, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(2); + assertEquals(expected, entry); + } + { + IPath path = new Path("/path with spaces2").setDevice(project.getLocation().getDevice()); + CIncludePathEntry expected = new CIncludePathEntry(path, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(3); + assertEquals(expected, entry); + } + { + IPath path = new Path("/path with spaces3").setDevice(project.getLocation().getDevice()); + CIncludePathEntry expected = new CIncludePathEntry(path, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(4); + assertEquals(expected, entry); + } + } + + /** + */ + public void testCMacroEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -DMACRO0" + + " -DMACRO1=value" + + " -DMACRO2=\"value with spaces\"" + + " -DMACRO3='value with spaces'" + + " -DMACRO4='\"quoted value\"'" + + " -D'MACRO5=\"quoted value\"'" + + " -DMACRO6=\\\"escape-quoted value\\\"" + + " -DMACRO7=\"'single-quoted value'\"" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + CMacroEntry expected = new CMacroEntry("MACRO0", "", 0); + CMacroEntry entry = (CMacroEntry)entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO1", "value", 0); + CMacroEntry entry = (CMacroEntry)entries.get(1); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO2", "value with spaces", 0); + CMacroEntry entry = (CMacroEntry)entries.get(2); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO3", "value with spaces", 0); + CMacroEntry entry = (CMacroEntry)entries.get(3); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO4", "\"quoted value\"", 0); + CMacroEntry entry = (CMacroEntry)entries.get(4); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO5", "\"quoted value\"", 0); + CMacroEntry entry = (CMacroEntry)entries.get(5); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO6", "\"escape-quoted value\"", 0); + CMacroEntry entry = (CMacroEntry)entries.get(6); + assertEquals(expected, entry); + } + { + CMacroEntry expected = new CMacroEntry("MACRO7", "'single-quoted value'", 0); + CMacroEntry entry = (CMacroEntry)entries.get(7); + assertEquals(expected, entry); + } + } + + /** + */ + public void testCMacroEntry_undef() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -UMACRO" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CMacroEntry("MACRO", null, ICSettingEntry.UNDEFINED), entries.get(0)); + } + } + + /** + */ + public void testCIncludeFileEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -include /include.file1" + + " -include '/include.file with spaces'" + + " -include ../../include.file2" + + " -include include.file3" + + " -include ../../include-file-with-dashes" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + IPath incFile = new Path("/include.file1").setDevice(project.getLocation().getDevice()); + CIncludeFileEntry expected = new CIncludeFileEntry(incFile, 0); + CIncludeFileEntry entry = (CIncludeFileEntry)entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + + { + IPath incFile = new Path("/include.file with spaces").setDevice(project.getLocation().getDevice()); + assertEquals(new CIncludeFileEntry(incFile, 0), entries.get(1)); + } + { + assertEquals(new CIncludeFileEntry(project.getLocation().removeLastSegments(2).append("include.file2"), 0), entries.get(2)); + assertEquals(new CIncludeFileEntry(project.getFullPath().append("include.file3"), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(3)); + assertEquals(new CIncludeFileEntry(project.getLocation().removeLastSegments(2).append("include-file-with-dashes"), 0), entries.get(4)); + } + } + + /** + */ + public void testCMacroFileEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -macros macro.file file.cpp"); + parser.processLine("gcc " + + " -macros /macro.file" + + " -macros '/macro.file with spaces'" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + IPath path = new Path("/macro.file").setDevice(project.getLocation().getDevice()); + CMacroFileEntry expected = new CMacroFileEntry(path, 0); + CMacroFileEntry entry = (CMacroFileEntry)entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + { + IPath path = new Path("/macro.file with spaces").setDevice(project.getLocation().getDevice()); + CMacroFileEntry expected = new CMacroFileEntry(path, 0); + CMacroFileEntry entry = (CMacroFileEntry)entries.get(1); + assertEquals(expected, entry); + } + } + + /** + */ + public void testCLibraryPathEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -L/path0" + + " -L'/path with spaces'" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + IPath path = new Path("/path0").setDevice(project.getLocation().getDevice()); + CLibraryPathEntry expected = new CLibraryPathEntry(path, 0); + CLibraryPathEntry entry = (CLibraryPathEntry)entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + { + IPath path = new Path("/path with spaces").setDevice(project.getLocation().getDevice()); + CLibraryPathEntry expected = new CLibraryPathEntry(path, 0); + CLibraryPathEntry entry = (CLibraryPathEntry)entries.get(1); + assertEquals(expected, entry); + } + } + + /** + */ + public void testCLibraryFileEntry() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -ldomain file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + CLibraryFileEntry expected = new CLibraryFileEntry("libdomain.a", 0); + CLibraryFileEntry entry = (CLibraryFileEntry) entries.get(0); + assertEquals(expected.getName(), entry.getName()); + assertEquals(expected.getValue(), entry.getValue()); + assertEquals(expected.getKind(), entry.getKind()); + assertEquals(expected.getFlags(), entry.getFlags()); + assertEquals(expected, entry); + } + + /** + */ + public void testMixedSettingEntries() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc" + + " -I/path0 " + + " -DMACRO1=value" + + " -v" + + " -ldomain" + + " -E" + + " -I /path1 " + + " -DMACRO2=\"value with spaces\"" + + " -I\"/path with spaces\"" + + " -o file.exe" + + " -L/usr/lib" + + " file.cpp" + + " -mtune=pentiumpro" + ); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + String device = project.getLocation().getDevice(); +// + " -I/path0 " + assertEquals(new CIncludePathEntry(new Path("/path0").setDevice(device), 0), entries.get(0)); +// + " -I /path1 " + assertEquals(new CIncludePathEntry(new Path("/path1").setDevice(device), 0), entries.get(1)); +// + " -I\"/path with spaces\"" + assertEquals(new CIncludePathEntry(new Path("/path with spaces").setDevice(device), 0), entries.get(2)); +// + " -DMACRO1=value" + assertEquals(new CMacroEntry("MACRO1", "value", 0), entries.get(3)); +// + " -DMACRO2=\"value with spaces\"" + assertEquals(new CMacroEntry("MACRO2", "value with spaces", 0), entries.get(4)); +// + " -L/usr/lib" + assertEquals(new CLibraryPathEntry(new Path("/usr/lib").setDevice(device), 0), entries.get(5)); +// + " -ldomain" + assertEquals(new CLibraryFileEntry("libdomain.a", 0), entries.get(6)); + assertEquals(7, entries.size()); + } + + /** + */ + public void testFileMissing() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 missing.cpp"); + parser.shutdown(); + + // check entries + assertTrue(parser.isEmpty()); + } + + /** + */ + public void testFileAbsolutePath() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + "-I/path0 " + + "-I. " + + file.getLocation().toOSString()); + parser.shutdown(); + + // check entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + assertEquals(new CIncludePathEntry(project.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + } + } + + /** + */ + public void testFileAbsolutePath_NoProject() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(null); + parser.processLine("gcc " + + "-I/path0 " + + "-I. " + + file.getLocation().toOSString()); + parser.shutdown(); + + // check entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(null, file, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + assertEquals(new CIncludePathEntry(file.getParent().getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + } + } + + /** + */ + public void testFileWithSpaces() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file1=ResourceHelper.createFile(project, "file with spaces 1.cpp"); + IFile file2=ResourceHelper.createFile(project, "file with spaces 2.cpp"); + IFile file3=ResourceHelper.createFile(project, "file with spaces 3.cpp"); + IFile file4=ResourceHelper.createFile(project, "file with spaces 4.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file1.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 'file with spaces 1.cpp'"); + parser.processLine("gcc -I/path0 \"file with spaces 2.cpp\""); + parser.processLine("gcc -I/path0 'file with spaces 3.cpp'\n"); + parser.processLine("gcc -I/path0 'file with spaces 4.cpp'\r\n"); + parser.shutdown(); + + // check populated entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + // in single quotes + List entries = parser.getSettingEntries(cfgDescription, file1, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + assertEquals(expected, entries.get(0)); + } + { + // in double quotes + List entries = parser.getSettingEntries(cfgDescription, file2, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + assertEquals(expected, entries.get(0)); + } + { + // Unix EOL + List entries = parser.getSettingEntries(cfgDescription, file3, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + assertEquals(expected, entries.get(0)); + } + { + // Windows EOL + List entries = parser.getSettingEntries(cfgDescription, file4, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + assertEquals(expected, entries.get(0)); + } + } + + /** + */ + public void testFileIgnoreWrongBuildDir() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + IFolder folder1=ResourceHelper.createFolder(project, "Folder1"); + IFile file=ResourceHelper.createFile(project, "Folder1/Folder2/file.cpp"); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + // Shift build directory, that could happen if Make Target from folder1 was run + IFolder buildDir = folder1; + epm.pushDirectoryURI(buildDir.getLocationURI()); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + "-I/path0 " + + "-I. " + + "Folder1/Folder2/file.cpp", + epm); + parser.shutdown(); + + // check entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + assertEquals(new CIncludePathEntry(path0, 0), entries.get(0)); + // Information from build output should take precedence over build dir + assertEquals(new CIncludePathEntry(project.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + } + } + + /** + */ + public void testEndOfLine() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file0=ResourceHelper.createFile(project, "file0.cpp"); + IFile file1=ResourceHelper.createFile(project, "file1.cpp"); + IFile file2=ResourceHelper.createFile(project, "file2.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file0.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 file0.cpp"); + parser.processLine("gcc -I/path0 file1.cpp\n"); + parser.processLine("gcc -I/path0 file2.cpp\r\n"); + parser.shutdown(); + + // check populated entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(cfgDescription, file0, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(0); + assertEquals(expected, entry); + } + { + List entries = parser.getSettingEntries(cfgDescription, file1, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(0); + assertEquals(expected, entry); + } + { + List entries = parser.getSettingEntries(cfgDescription, file2, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + CIncludePathEntry entry = (CIncludePathEntry)entries.get(0); + assertEquals(expected, entry); + } + } + + /** + */ + public void testPathEntry_DriveLetter() throws Exception { + // do not test on non-windows systems where drive letters are not supported + if (! Platform.getOS().equals(Platform.OS_WIN32)) + return; + + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + parser.setResolvingPaths(true); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -IX:\\path" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + assertEquals(new CIncludePathEntry(new Path("X:\\path"), 0), entries.get(0)); + } + + /** + */ + public void testPathEntry_ExpandRelativePath() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + IFolder folder=ResourceHelper.createFolder(project, "Folder"); + IFolder folderComposite=ResourceHelper.createFolder(project, "Folder-Icomposite"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + parser.setResolvingPaths(true); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -I.." + + " -IFolder" + + " -IFolder-Icomposite" // to test case when "-I" is a part of folder name + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + // check that relative paths are relative to CWD which is the location of the project + assertEquals(new CIncludePathEntry(project.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(project.getLocation().removeLastSegments(1), 0), entries.get(1)); + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(2)); + assertEquals(new CIncludePathEntry(folderComposite.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(3)); + } + } + + /** + */ + public void testPathEntry_DoNotExpandRelativePath() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + @SuppressWarnings("unused") + IFolder folder=ResourceHelper.createFolder(project, "Folder"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser with expandRelativePaths=false + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + parser.setResolvingPaths(false); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -I.." + + " -IFolder" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(".", 0), entries.get(0)); + assertEquals(new CIncludePathEntry("..", 0), entries.get(1)); + assertEquals(new CIncludePathEntry("Folder", 0), entries.get(2)); + } + } + + /** + */ + public void testPathEntry_DuplicatePath() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + IFolder folder=ResourceHelper.createFolder(project, "Folder"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + parser.setResolvingPaths(true); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -IFolder" + + " -IFolder" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(1, entries.size()); + } + } + + /** + */ + public void testPathEntry_FollowCWD() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFolder buildDir=ResourceHelper.createFolder(project, "BuildDir"); + IFolder folder=ResourceHelper.createFolder(project, "BuildDir/Folder"); + IFile file=ResourceHelper.createFile(project, "BuildDir/file.cpp"); + @SuppressWarnings("unused") + IFile fakeFile=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + epm.pushDirectoryURI(buildDir.getLocationURI()); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -I.." + + " -I../../.." + + " -IFolder" + + " -IMissingFolder" + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(buildDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(buildDir.getFullPath().removeLastSegments(1), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + assertEquals(new CIncludePathEntry(buildDir.getLocation().removeLastSegments(3), 0), entries.get(2)); + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(3)); + assertEquals(new CIncludePathEntry(buildDir.getFullPath().append("MissingFolder"), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(4)); + } + } + + /** + */ + public void testPathEntry_GuessCWD() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFolder folder=ResourceHelper.createFolder(project, "BuildDir/Folder"); + IFile file=ResourceHelper.createFile(project, "BuildDir/file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -IFolder" + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + } + + /** + */ + public void testPathEntry_NonExistentCWD_Workspace() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFolder buildDir=project.getFolder("Missing/Folder"); + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + ErrorParserManager epm = new ErrorParserManager(project, null); + epm.pushDirectoryURI(buildDir.getLocationURI()); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -I.." + + " -IFolder" + + " ../file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(buildDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(buildDir.getFullPath().removeLastSegments(1), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + assertEquals(new CIncludePathEntry(buildDir.getFullPath().append("Folder"), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(2)); + } + } + + /** + */ + public void testPathEntry_NonExistentCWD_Filesystem() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + ErrorParserManager epm = new ErrorParserManager(project, null); + URI uriBuildDir = new URI("file:/non-existing/path"); + epm.pushDirectoryURI(uriBuildDir); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -I.." + + " -IFolder" + + " ../file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + IPath buildPath = new Path(uriBuildDir.getPath()).setDevice(project.getLocation().getDevice()); + assertEquals(new CIncludePathEntry(buildPath, 0), entries.get(0)); + assertEquals(new CIncludePathEntry(buildPath.removeLastSegments(1), 0), entries.get(1)); + assertEquals(new CIncludePathEntry(buildPath.append("Folder"), 0), entries.get(2)); + } + } + + /** + */ + public void testPathEntry_MappedRemoteFolder() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFolder buildDir=ResourceHelper.createFolder(project, "Local/BuildDir"); + IFolder folder=ResourceHelper.createFolder(project, "Local/BuildDir/Folder"); + IFolder folder2=ResourceHelper.createFolder(project, "Local/BuildDir/Folder2"); + IFile file=ResourceHelper.createFile(project, "Local/BuildDir/file.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + ErrorParserManager epm = new ErrorParserManager(project, null); + URI uriBuildDir = new URI("file:/BuildDir"); + epm.pushDirectoryURI(uriBuildDir); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -I/BuildDir/Folder" + + " -I../BuildDir/Folder2" + + " -I/BuildDir/MissingFolder" + + " -I../BuildDir/MissingFolder2" + + " /BuildDir/file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(buildDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + assertEquals(new CIncludePathEntry(folder2.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(2)); + assertEquals(new CIncludePathEntry(buildDir.getFullPath().append("MissingFolder"), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(3)); + assertEquals(new CIncludePathEntry(buildDir.getFullPath().append("MissingFolder2"), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(4)); + } + } + + /** + */ + public void testPathEntry_MappedFolderInProject() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "BuildDir/file.cpp"); + IFolder mappedFolder=ResourceHelper.createFolder(project, "Mapped/Folder"); + IFolder folder=ResourceHelper.createFolder(project, "Mapped/Folder/Subfolder"); + @SuppressWarnings("unused") + IFolder ambiguousFolder1=ResourceHelper.createFolder(project, "One/Ambiguous/Folder"); + @SuppressWarnings("unused") + IFolder ambiguousFolder2=ResourceHelper.createFolder(project, "Another/Ambiguous/Folder"); + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I/Folder/Subfolder" + + " -I/Mapped/Folder" + + " -I/Ambiguous/Folder" + + " -I/Missing/Folder" + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(mappedFolder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + } + { + IPath path = new Path("/Ambiguous/Folder").setDevice(file.getLocation().getDevice()); + assertEquals(new CIncludePathEntry(path, 0), entries.get(2)); + } + { + IPath path = new Path("/Missing/Folder").setDevice(file.getLocation().getDevice()); + assertEquals(new CIncludePathEntry(path, 0), entries.get(3)); + } + } + + /** + */ + public void testPathEntry_MappedFolderInAnotherProject() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create files and folders + IFile file=ResourceHelper.createFile(project, "file.cpp"); + // another project + IProject anotherProject = ResourceHelper.createCDTProjectWithConfig(projectName+"-another"); + IFolder folder=ResourceHelper.createFolder(anotherProject, "Mapped/Folder/Subfolder"); + @SuppressWarnings("unused") + IFolder ambiguousFolder1=ResourceHelper.createFolder(anotherProject, "One/Ambiguous/Folder"); + @SuppressWarnings("unused") + IFolder ambiguousFolder2=ResourceHelper.createFolder(anotherProject, "Another/Ambiguous/Folder"); + + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I/Folder/Subfolder" + + " -I/Ambiguous/Folder" + + " -I/Missing/Folder" + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + } + { + IPath path = new Path("/Ambiguous/Folder").setDevice(file.getLocation().getDevice()); + assertEquals(new CIncludePathEntry(path, 0), entries.get(1)); + } + { + IPath path = new Path("/Missing/Folder").setDevice(file.getLocation().getDevice()); + assertEquals(new CIncludePathEntry(path, 0), entries.get(2)); + } + } + + /** + */ + public void testPathEntry_MappedFolderInReferencedProject() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + + // create main project + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + IFile file=ResourceHelper.createFile(project, "file.cpp"); + + // create another project (non-referenced) + IProject anotherProject = ResourceHelper.createCDTProjectWithConfig(projectName+"-another"); + @SuppressWarnings("unused") + IFolder folderInAnotherProject=ResourceHelper.createFolder(anotherProject, "Mapped/Folder/Subfolder"); + + // create referenced project + IProject referencedProject = ResourceHelper.createCDTProjectWithConfig(projectName+"-referenced"); + IFolder folderInReferencedProject=ResourceHelper.createFolder(referencedProject, "Mapped/Folder/Subfolder"); + @SuppressWarnings("unused") + IFolder ambiguousFolder1=ResourceHelper.createFolder(referencedProject, "One/Ambiguous/Folder"); + @SuppressWarnings("unused") + IFolder ambiguousFolder2=ResourceHelper.createFolder(referencedProject, "Another/Ambiguous/Folder"); + + setReference(project, referencedProject); + + // get cfgDescription and language to work with + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I/Folder/Subfolder" + + " -I/Ambiguous/Folder" + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(folderInReferencedProject.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + + IPath path = new Path("/Ambiguous/Folder").setDevice(file.getLocation().getDevice()); + assertEquals(new CIncludePathEntry(path, 0), entries.get(1)); + } + } + + /** + */ + public void testPathEntry_NavigateSymbolicLinkUpAbsolute() throws Exception { + // do not test on systems where symbolic links are not supported + if (!ResourceHelper.isSymbolicLinkSupported()) + return; + + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + String languageId = LANG_CPP; + IFile file=ResourceHelper.createFile(project, "file.cpp"); + + // create link on the filesystem + IPath dir1 = ResourceHelper.createTemporaryFolder(); + IPath dir2 = dir1.removeLastSegments(1); + IPath linkPath = dir1.append("linked"); + ResourceHelper.createSymbolicLink(linkPath, dir2); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + // "../" should navigate along filesystem path, not along the link itself + parser.processLine("gcc -I"+linkPath.toString()+"/.."+" file.cpp", epm); + parser.shutdown(); + + // check populated entries + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + CIncludePathEntry expected = new CIncludePathEntry(dir2.removeLastSegments(1), 0); + assertEquals(expected, entries.get(0)); + } + } + + /** + */ + public void testPathEntry_NavigateSymbolicLinkUpRelative() throws Exception { + // do not test on systems where symbolic links are not supported + if (!ResourceHelper.isSymbolicLinkSupported()) + return; + + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + String languageId = LANG_CPP; + IFile file=ResourceHelper.createFile(project, "file.cpp"); + + // create link + IFolder folder = ResourceHelper.createFolder(project, "folder"); + IFolder subfolder = ResourceHelper.createFolder(project, "folder/subfolder"); + IPath linkPath = project.getLocation().append("linked"); + ResourceHelper.createSymbolicLink(linkPath, subfolder.getLocation()); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + // "../" should navigate along filesystem path, not along the link itself + parser.processLine("gcc -Ilinked/.."+" file.cpp", epm); + parser.shutdown(); + + // check populated entries + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + CIncludePathEntry expected = new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED); + assertEquals(expected, entries.get(0)); + } + } + + /** + */ + public void testPathEntry_BuildDirDefinedByConfiguration_RelativePath() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + // Create resources trying to confuse the parser + @SuppressWarnings("unused") + IFile fileInProjectRoot=ResourceHelper.createFile(project, "file.cpp"); + @SuppressWarnings("unused") + IFolder includeDirInProjectRoot=ResourceHelper.createFolder(project, "include"); + // Create resources meant to be found + IFolder buildDir=ResourceHelper.createFolder(project, "BuildDir"); + IFile file=ResourceHelper.createFile(project, "BuildDir/file.cpp"); + IFolder includeDir=ResourceHelper.createFolder(project, "BuildDir/include"); + // Change build dir + setBuilderCWD(project, buildDir.getLocation()); + + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -Iinclude" + + " file.cpp"); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(buildDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(includeDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + } + } + + /** + */ + public void testPathEntry_BuildDirDefinedByConfiguration_AbsolutePath() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + // Create resources trying to confuse the parser + @SuppressWarnings("unused") + IFile fileInProjectRoot=ResourceHelper.createFile(project, "file.cpp"); + @SuppressWarnings("unused") + IFolder includeDirInProjectRoot=ResourceHelper.createFolder(project, "include"); + // Create resources meant to be found + IFolder buildDir=ResourceHelper.createFolder(project, "BuildDir"); + IFile file=ResourceHelper.createFile(project, "BuildDir/file.cpp"); + IFolder includeDir=ResourceHelper.createFolder(project, "BuildDir/include"); + // Change build dir + setBuilderCWD(project, buildDir.getLocation()); + + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I." + + " -Iinclude" + + " " + file.getLocation().toOSString() + ); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + assertEquals(new CIncludePathEntry(buildDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(includeDir.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(1)); + } + + } + + public void testContentType_None() throws Exception { + MockBuildCommandParser parser = new MockBuildCommandParser() { + @Override + protected String parseForResourceName(String line) { + return "file.wrong-content-type"; + } + }; + parser.startup(null); + parser.processLine("gcc file.wrong-content-type"); + parser.shutdown(); + + List entries = parser.getSettingEntries(null, null, null); + assertNull(entries); + } + + /** + */ + public void testContentType_Mismatch() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + ResourceHelper.createFile(project, "file.c"); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + // restrict the parser's language scope to C++ only + parser.setLanguageScope(new ArrayList() {{add(LANG_CPP);}}); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 file.c"); + parser.shutdown(); + + assertTrue(parser.isEmpty()); + } + + /** + */ + public void testContentType_FileExtensions() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + String languageId = LANG_CPP; + // add custom extension to C++ content type + IContentTypeManager manager = Platform.getContentTypeManager(); + IContentType contentType = manager.findContentTypeFor("file.cpp"); + contentType.addFileSpec("x++", IContentTypeSettings.FILE_EXTENSION_SPEC); + + IFile file=ResourceHelper.createFile(project, "file.x++"); + IContentType contentTypeX = manager.findContentTypeFor("file.x++"); + assertEquals(contentType, contentTypeX); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 file.x++"); + parser.shutdown(); + + // check populated entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + assertEquals(expected, entries.get(0)); + } + } + + /** + */ + public void testUpperCase() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + String languageId = LANG_CPP; + + IFile file=ResourceHelper.createFile(project, "file.cpp"); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc -I/path0 FILE.CPP", epm); + parser.shutdown(); + + // check populated entries + IPath path0 = new Path("/path0").setDevice(project.getLocation().getDevice()); + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + CIncludePathEntry expected = new CIncludePathEntry(path0, 0); + assertEquals(expected, entries.get(0)); + } + } + + /** + */ + public void testBoostBjam() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + IFile file=ResourceHelper.createFile(project, "libs/python/src/numeric.cpp"); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + + // parse line + parser.startup(cfgDescription); + // "g++" -ftemplate-depth-128 -O0 -fno-inline -Wall -g -mthreads -DBOOST_ALL_NO_LIB=1 -DBOOST_PYTHON_SOURCE -DBOOST_PYTHON_STATIC_LIB -I"." -I"/Python25/Include" -c -o "bin.v2/libs/python/build/gcc-mingw-3.4.5/debug/link-static/threading-multi/numeric.o" "libs/python/src/numeric.cpp" + parser.processLine(" \"g++\"" + + " -ftemplate-depth-128 -O0 -fno-inline -Wall -g -mthreads" + + " -DBOOST_ALL_NO_LIB=1" + + " -DBOOST_PYTHON_SOURCE" + + " -DBOOST_PYTHON_STATIC_LIB" + + " -I\".\"" + + " -I\"/Python1025/Include\"" + + " -c -o \"bin.v2/libs/python/build/gcc-mingw-3.4.5/debug/link-static/threading-multi/numeric.o\"" + + " libs/python/src/numeric.cpp"); + parser.shutdown(); + + // check populated entries + { + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + assertEquals(new CIncludePathEntry(project.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(new Path("/Python1025/Include").setDevice(project.getLocation().getDevice()), 0), entries.get(1)); + assertEquals(new CMacroEntry("BOOST_ALL_NO_LIB", "1", 0), entries.get(2)); + assertEquals(new CMacroEntry("BOOST_PYTHON_SOURCE", "", 0), entries.get(3)); + assertEquals(new CMacroEntry("BOOST_PYTHON_STATIC_LIB", "", 0), entries.get(4)); + assertEquals(5, entries.size()); + } + } + + /** + */ + public void testPathEntry_Efs() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create folder structure + @SuppressWarnings("unused") + IFolder buildDir=ResourceHelper.createEfsFolder(project, "BuildDir", new URI("mem:/EfsProject/BuildDir")); + IFolder folder=ResourceHelper.createEfsFolder(project, "BuildDir/Folder", new URI("mem:/EfsProject/BuildDir/Folder")); + IFile file=ResourceHelper.createEfsFile(project, "BuildDir/file.cpp", new URI("mem:/EfsProject/BuildDir/file.cpp")); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -IFolder" + + " -I/Absolute/Folder" + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + String device = project.getLocation().getDevice(); + assertEquals(new CIncludePathEntry(folder.getFullPath(), ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED), entries.get(0)); + assertEquals(new CIncludePathEntry(new Path("/Absolute/Folder").setDevice(device), 0), entries.get(1)); + } + } + + /** + */ + public void testPathEntry_EfsMappedFolder() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create folder structure + @SuppressWarnings("unused") + IFolder buildDir=ResourceHelper.createEfsFolder(project, "BuildDir", new URI("mem:/MappedEfsProject/BuildDir")); + @SuppressWarnings("unused") + IFolder folder=ResourceHelper.createEfsFolder(project, "BuildDir/Folder", new URI("mem:/MappedEfsProject/BuildDir/Folder")); + IFile file=ResourceHelper.createEfsFile(project, "BuildDir/file.cpp", new URI("mem:/MappedEfsProject/BuildDir/file.cpp")); + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(file.getProjectRelativePath(), true); + String languageId = ls.getLanguageId(); + + // create GCCBuildCommandParser + GCCBuildCommandParser parser = (GCCBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(GCC_BUILD_COMMAND_PARSER_EXT); + ErrorParserManager epm = new ErrorParserManager(project, null); + + // parse line + parser.startup(cfgDescription); + parser.processLine("gcc " + + " -I/BeingMappedFrom/Folder" // mapped to local folder in EFSExtensionProvider extension point + + " file.cpp", + epm); + parser.shutdown(); + + // check populated entries + List entries = parser.getSettingEntries(cfgDescription, file, languageId); + { + String device = project.getLocation().getDevice(); + assertEquals(new CIncludePathEntry(new Path("/LocallyMappedTo/Folder").setDevice(device), 0), entries.get(0)); + } + } + +} diff --git a/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/ScannerDiscoveryTests.java b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/ScannerDiscoveryTests.java index 973802190a0..75eed421b16 100644 --- a/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/ScannerDiscoveryTests.java +++ b/build/org.eclipse.cdt.make.core.tests/src/org/eclipse/cdt/make/scannerdiscovery/ScannerDiscoveryTests.java @@ -1,12 +1,12 @@ /******************************************************************************* - * Copyright (c) 2007, 2009 Wind River Systems, Inc. and others. + * Copyright (c) 2007, 2009 Andrew Gvozdev 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: - * Markus Schorn - initial API and implementation + * Andrew Gvozdev - initial API and implementation *******************************************************************************/ package org.eclipse.cdt.make.scannerdiscovery; diff --git a/build/org.eclipse.cdt.make.core/plugin.xml b/build/org.eclipse.cdt.make.core/plugin.xml index 36067e63368..ecdb0eb306f 100644 --- a/build/org.eclipse.cdt.make.core/plugin.xml +++ b/build/org.eclipse.cdt.make.core/plugin.xml @@ -182,5 +182,14 @@ class="org.eclipse.cdt.make.internal.core.dataprovider.MakeConfigurationDataProvider" /> + + + + diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractBuildCommandParser.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractBuildCommandParser.java new file mode 100644 index 00000000000..b0dff614c2d --- /dev/null +++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractBuildCommandParser.java @@ -0,0 +1,220 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.core.scannerconfig; + +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.ErrorParserManager; +import org.eclipse.cdt.core.ICConsoleParser; +import org.eclipse.cdt.core.IErrorParser; +import org.eclipse.cdt.core.IErrorParser2; +import org.eclipse.cdt.core.IMarkerGenerator; +import org.eclipse.cdt.core.errorparsers.RegexErrorParser; +import org.eclipse.cdt.core.errorparsers.RegexErrorPattern; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.internal.core.ConsoleOutputSniffer; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.cdt.make.core.MakeCorePlugin; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.ISchedulingRule; +import org.eclipse.core.runtime.jobs.Job; + +/** + * TODO - class description + * + * Note: IErrorParser interface is used here to work around {@link ConsoleOutputSniffer} having + * no access from CDT core to build packages. TODO - elaborate? + */ +public abstract class AbstractBuildCommandParser extends AbstractLanguageSettingsOutputScanner + implements ICConsoleParser, IErrorParser { + + public static final Object JOB_FAMILY_BUILD_COMMAND_PARSER = "org.eclipse.cdt.make.core.scannerconfig.AbstractBuildCommandParser"; + + private static final String LEADING_PATH_PATTERN = "\\S+[/\\\\]"; //$NON-NLS-1$ + private static final Pattern OPTIONS_PATTERN = Pattern.compile("-[^\\s\"']*(\\s*((\".*?\")|('.*?')|([^-\\s][^\\s]+)))?"); //$NON-NLS-1$ + private static final int OPTION_GROUP = 0; + + /** + * Note: design patterns to keep file group the same and matching {@link #FILE_GROUP} + */ + @SuppressWarnings("nls") + private static final String[] PATTERN_TEMPLATES = { + "${COMPILER_PATTERN}.*\\s" + "()([^'\"\\s]*\\.${EXTENSIONS_PATTERN})(\\s.*)?[\r\n]*", // compiling unquoted file + "${COMPILER_PATTERN}.*\\s" + "(['\"])(.*\\.${EXTENSIONS_PATTERN})\\${COMPILER_GROUPS+1}(\\s.*)?[\r\n]*" // compiling quoted file + }; + private static final int FILE_GROUP = 2; + + + @SuppressWarnings("nls") + private String getCompilerCommandPattern() { + String parameter = getCustomParameter(); + return "\\s*\"?("+LEADING_PATH_PATTERN+")?(" + parameter + ")\"?"; + } + + private int adjustFileGroup() { + return countGroups(getCompilerCommandPattern()) + FILE_GROUP; + } + + private String makePattern(String template) { + @SuppressWarnings("nls") + String pattern = template + .replace("${COMPILER_PATTERN}", getCompilerCommandPattern()) + .replace("${EXTENSIONS_PATTERN}", getPatternFileExtensions()) + .replace("${COMPILER_GROUPS+1}", new Integer(countGroups(getCompilerCommandPattern()) + 1).toString()); + return pattern; + } + + @Override + protected String parseForResourceName(String line) { + if (line==null) { + return null; + } + + for (String template : PATTERN_TEMPLATES) { + String pattern = makePattern(template); + Matcher fileMatcher = Pattern.compile(pattern).matcher(line); + if (fileMatcher.matches()) { + int fileGroup = adjustFileGroup(); + String sourceFileName = fileMatcher.group(fileGroup); + return sourceFileName; + } + } + return null; + } + + @Override + protected List parseForOptions(String line) { + if (line==null || currentResource==null) { + return null; + } + + List options = new ArrayList(); + Matcher optionMatcher = OPTIONS_PATTERN.matcher(line); + while (optionMatcher.find()) { + String option = optionMatcher.group(OPTION_GROUP); + if (option!=null) { + options.add(option); + } + } + return options; + } + + @Override + public boolean processLine(String line) { + return processLine(line, null); + } + + // This is redundant but let us keep it here to navigate in java code easier + @Override + public boolean processLine(String line, ErrorParserManager epm) { + return super.processLine(line, epm); + } + + @Override + public void shutdown() { + scheduleSerializingJob(currentCfgDescription); + super.shutdown(); + } + + + private void scheduleSerializingJob(final ICConfigurationDescription cfgDescription) { + Job job = new Job("Serialize CDT language settings entries") { + @Override + protected IStatus run(IProgressMonitor monitor) { + // FIXME - remove thread name reassigning + Thread thread = getThread(); + String oldName = thread.getName(); + thread.setName("CDT LSP Serializer,BOP"); + + IStatus status = null; + try { + if (cfgDescription != null) { + LanguageSettingsProvidersSerializer.serializeLanguageSettings(cfgDescription.getProjectDescription()); + } else { + LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace(); + } + } catch (CoreException e) { + status = new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, IStatus.ERROR, "Error serializing language settings", e); + MakeCorePlugin.log(status); + } + + if (status == null) + status = Status.OK_STATUS; + + thread.setName(oldName); + return status; + } + @Override + public boolean belongsTo(Object family) { + return family == JOB_FAMILY_BUILD_COMMAND_PARSER; + } + }; + + ISchedulingRule rule = null; + if (currentProject != null) { + IFolder settingsFolder = currentProject.getFolder(".settings"); + if (!settingsFolder.exists()) { + try { + settingsFolder.create(true, true, null); + if (settingsFolder.isAccessible()) + rule = currentProject.getFile(".settings/language.settings.xml"); + } catch (CoreException e) { + CCorePlugin.log(e); + } + } + } + if (rule == null) { + rule = ResourcesPlugin.getWorkspace().getRoot(); + } + job.setRule(rule); + job.schedule(); + } + + /** + * Trivial Error Parser which allows highlighting of output lines matching the patterns + * of this parser. Intended for better troubleshooting experience. + * Implementers are supposed to add the error parser as an extension. Initialize with + * build command parser extension ID. + */ + protected static abstract class AbstractBuildCommandPatternHighlighter extends RegexErrorParser implements IErrorParser2 { + public AbstractBuildCommandPatternHighlighter(String buildCommandParserPluginExtension) { + init(buildCommandParserPluginExtension); + } + + protected void init(String buildCommandParserId) { + AbstractBuildCommandParser buildCommandParser = (AbstractBuildCommandParser) LanguageSettingsManager.getExtensionProviderCopy(buildCommandParserId); + for (String template : PATTERN_TEMPLATES) { + String pattern = buildCommandParser.makePattern(template); + String fileExpr = "$"+buildCommandParser.adjustFileGroup(); //$NON-NLS-1$ + String descExpr = "$0"; //$NON-NLS-1$ + addPattern(new RegexErrorPattern(pattern, fileExpr, null, descExpr, null, IMarkerGenerator.SEVERITY_WARNING, true)); + } + } + + @Override + public int getProcessLineBehaviour() { + return KEEP_LONGLINES; + } + } + + +} diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractBuiltinSpecsDetector.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractBuiltinSpecsDetector.java new file mode 100644 index 00000000000..b4a5c97e452 --- /dev/null +++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractBuiltinSpecsDetector.java @@ -0,0 +1,760 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.core.scannerconfig; + +import java.io.IOException; +import java.io.OutputStream; +import java.net.URI; +import java.net.URL; +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.CommandLauncher; +import org.eclipse.cdt.core.ErrorParserManager; +import org.eclipse.cdt.core.ICConsoleParser; +import org.eclipse.cdt.core.ICommandLauncher; +import org.eclipse.cdt.core.IConsoleParser; +import org.eclipse.cdt.core.IMarkerGenerator; +import org.eclipse.cdt.core.ProblemMarkerInfo; +import org.eclipse.cdt.core.index.IIndexManager; +import org.eclipse.cdt.core.language.settings.providers.ICListenerRegisterer; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.model.ICElement; +import org.eclipse.cdt.core.model.ICProject; +import org.eclipse.cdt.core.model.ILanguage; +import org.eclipse.cdt.core.model.ILanguageDescriptor; +import org.eclipse.cdt.core.model.LanguageManager; +import org.eclipse.cdt.core.resources.IConsole; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.internal.core.ConsoleOutputSniffer; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsLogger; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.cdt.make.core.MakeCorePlugin; +import org.eclipse.cdt.make.internal.core.MakeMessages; +import org.eclipse.cdt.make.internal.core.StreamMonitor; +import org.eclipse.cdt.utils.CommandLineUtil; +import org.eclipse.cdt.utils.PathUtil; +import org.eclipse.core.resources.IMarker; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.IWorkspaceRoot; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.MultiStatus; +import org.eclipse.core.runtime.NullProgressMonitor; +import org.eclipse.core.runtime.OperationCanceledException; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Platform; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.SubProgressMonitor; +import org.eclipse.core.runtime.content.IContentType; +import org.eclipse.core.runtime.jobs.ISchedulingRule; +import org.eclipse.core.runtime.jobs.Job; +import org.w3c.dom.Element; + +public abstract class AbstractBuiltinSpecsDetector extends AbstractLanguageSettingsOutputScanner implements ICListenerRegisterer { + public static final Object JOB_FAMILY_BUILTIN_SPECS_DETECTOR = "org.eclipse.cdt.make.core.scannerconfig.AbstractBuiltinSpecsDetector"; + + private static final int TICKS_STREAM_MONITOR = 100; + private static final int TICKS_CLEAN_MARKERS = 1; + private static final int TICKS_RUN_FOR_ONE_LANGUAGE = 10; + private static final int TICKS_SERIALIZATION = 1; + private static final int TICKS_SCALE = 100; + private static final String NEWLINE = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$ + private static final String PLUGIN_CDT_MAKE_UI_ID = "org.eclipse.cdt.make.ui"; //$NON-NLS-1$ + private static final String GMAKE_ERROR_PARSER_ID = "org.eclipse.cdt.core.GmakeErrorParser"; //$NON-NLS-1$ + private static final String PATH_ENV = "PATH"; //$NON-NLS-1$ + private static final String ATTR_CONSOLE = "console"; //$NON-NLS-1$ + + protected static final String COMPILER_MACRO = "${COMMAND}"; //$NON-NLS-1$ + protected static final String SPEC_FILE_MACRO = "${INPUTS}"; //$NON-NLS-1$ + protected static final String SPEC_EXT_MACRO = "${EXT}"; //$NON-NLS-1$ + protected static final String SPEC_FILE_BASE = "spec"; //$NON-NLS-1$ + + private String currentCommandResolved = null; + protected List detectedSettingEntries = null; + + protected boolean isExecuted = false; + protected int collected = 0; + + private boolean isConsoleEnabled = false; + protected java.io.File specFile = null; + protected boolean preserveSpecFile = false; + + protected URI mappedRootURI = null; + protected URI buildDirURI = null; + + private class SDMarkerGenerator implements IMarkerGenerator { + protected static final String SCANNER_DISCOVERY_PROBLEM_MARKER = MakeCorePlugin.PLUGIN_ID + ".scanner.discovery.problem"; //$NON-NLS-1$ + protected static final String PROVIDER = "provider"; //$NON-NLS-1$ + + @Override + public void addMarker(IResource file, int lineNumber, String errorDesc, int severity, String errorVar) { + ProblemMarkerInfo info = new ProblemMarkerInfo(file, lineNumber, errorDesc, severity, errorVar); + addMarker(info); + } + + @Override + public void addMarker(final ProblemMarkerInfo problemMarkerInfo) { + final String providerName = getName(); + final String providerId = getId(); + // we have to add the marker in the job or we can deadlock other + // threads that are responding to a resource delta by doing something + // that accesses the project description + Job markerJob = new Job("Adding Scanner Discovery markers") { + @Override + protected IStatus run(IProgressMonitor monitor) { + // Try to find matching markers and don't put in duplicates + try { + IMarker[] cur = problemMarkerInfo.file.findMarkers(SDMarkerGenerator.SCANNER_DISCOVERY_PROBLEM_MARKER, false, IResource.DEPTH_ZERO); + if ((cur != null) && (cur.length > 0)) { + for (int i = 0; i < cur.length; i++) { + int sev = ((Integer) cur[i].getAttribute(IMarker.SEVERITY)).intValue(); + String mesg = (String) cur[i].getAttribute(IMarker.MESSAGE); + if (sev == problemMarkerInfo.severity && mesg.equals(problemMarkerInfo.description)) { + return Status.OK_STATUS; + } + } + } + } catch (CoreException e) { + return new Status(Status.ERROR, MakeCorePlugin.getUniqueIdentifier(), "Error removing markers.", e); + } + + // add new marker + try { + IMarker marker = problemMarkerInfo.file.createMarker(SDMarkerGenerator.SCANNER_DISCOVERY_PROBLEM_MARKER); + marker.setAttribute(IMarker.MESSAGE, problemMarkerInfo.description); + marker.setAttribute(IMarker.SEVERITY, problemMarkerInfo.severity); + marker.setAttribute(SDMarkerGenerator.PROVIDER, providerId); + + if (problemMarkerInfo.file instanceof IWorkspaceRoot) { + marker.setAttribute(IMarker.LOCATION, "SD90 Providers, [" + providerName + "] options in Preferences"); + } else { + marker.setAttribute(IMarker.LOCATION, "SD90 Providers, [" + providerName + "] options in project properties"); + } + } catch (CoreException e) { + return new Status(Status.ERROR, MakeCorePlugin.getUniqueIdentifier(), "Error adding markers.", e); + } + + return Status.OK_STATUS; + } + }; + + markerJob.setRule(problemMarkerInfo.file); + markerJob.schedule(); + } + + } + + /** + * This ICConsoleParser handles each individual run for one language from + * {@link AbstractBuiltinSpecsDetector#runForEachLanguage(ICConfigurationDescription, IPath, String[], IProgressMonitor)} + * + */ + private class ConsoleParser implements ICConsoleParser { + @Override + public void startup(ICConfigurationDescription cfgDescription) throws CoreException { + // not used here, see instead startupForLanguage() in AbstractBuiltinSpecsDetector.runForEachLanguage(...) + } + @Override + public boolean processLine(String line) { + return AbstractBuiltinSpecsDetector.this.processLine(line, errorParserManager); + } + @Override + public void shutdown() { + // not used here, see instead shutdownForLanguage() in AbstractBuiltinSpecsDetector.runForEachLanguage(...) + } + } + + public void setConsoleEnabled(boolean enable) { + isConsoleEnabled = enable; + } + + public boolean isConsoleEnabled() { + return isConsoleEnabled; + } + + protected String resolveCommand(String languageId) throws CoreException { + String cmd = getCustomParameter(); + if (cmd!=null && (cmd.contains(COMPILER_MACRO) || cmd.contains(SPEC_FILE_MACRO) || cmd.contains(SPEC_EXT_MACRO))) { + if (cmd.contains(COMPILER_MACRO)) { + String compiler = getCompilerCommand(languageId); + if (compiler!=null) + cmd = cmd.replace(COMPILER_MACRO, compiler); + } + if (cmd.contains(SPEC_FILE_MACRO)) { + String specFileName = getSpecFile(languageId); + if (specFileName!=null) + cmd = cmd.replace(SPEC_FILE_MACRO, specFileName); + } + if (cmd.contains(SPEC_EXT_MACRO)) { + String specFileExt = getSpecFileExtension(languageId); + if (specFileExt!=null) + cmd = cmd.replace(SPEC_EXT_MACRO, specFileExt); + } + } + return cmd; + } + + /** + * TODO + */ + @Override + protected String parseForResourceName(String line) { + // This works as if workspace-wide + return null; + } + + @Override + protected String determineLanguage() { + // language id is supposed to be set by run(), just return it + return currentLanguageId; + } + + @Override + protected URI getMappedRootURI(IResource sourceFile, String parsedResourceName) { + if (mappedRootURI==null) { + mappedRootURI = super.getMappedRootURI(sourceFile, parsedResourceName); + } + return mappedRootURI; + } + + @Override + protected URI getBuildDirURI(URI mappedRootURI) { + if (buildDirURI==null) { + buildDirURI = super.getBuildDirURI(mappedRootURI); + } + return buildDirURI; + } + + @Override + public void registerListener(ICConfigurationDescription cfgDescription) { + LanguageSettingsLogger.logInfo(getPrefixForLog() + "registerListener [" + System.identityHashCode(this) + "] " + this); + + currentCfgDescription = cfgDescription; + execute(); + } + + @Override + public void unregisterListener() { + LanguageSettingsLogger.logInfo(getPrefixForLog() + "unregisterListener [" + System.identityHashCode(this) + "] " + this); + } + + protected void execute() { + if (isExecuted) { +// // TODO - remove me +// CCorePlugin.log(new Status(IStatus.INFO,CCorePlugin.PLUGIN_ID, +// getPrefixForLog() + "Already executed [" + System.identityHashCode(this) + "] " + this)); + return; + } + isExecuted = true; + + Job job = new Job("Discover compiler's built-in language settings") { + @Override + protected IStatus run(IProgressMonitor monitor) { + return runForEachLanguage(currentCfgDescription, null, null, monitor); + } + @Override + public boolean belongsTo(Object family) { + return family == JOB_FAMILY_BUILTIN_SPECS_DETECTOR; + } + }; + + IProject ownerProject = null; + if (currentCfgDescription != null) { + ICProjectDescription prjDescription = currentCfgDescription.getProjectDescription(); + if (prjDescription != null) { + ownerProject = prjDescription.getProject(); + } + } + ISchedulingRule rule = null; + if (ownerProject != null) { + rule = ownerProject.getFile(".settings/language.settings.xml"); + } + if (rule == null) { + rule = ResourcesPlugin.getWorkspace().getRoot(); + } + job.setRule(rule); + job.schedule(); + + // TODO - remove me + LanguageSettingsLogger.logInfo(getPrefixForLog() + "Execution scheduled [" + System.identityHashCode(this) + "] " + this); + } + + /** + * TODO + */ + protected IStatus runForEachLanguage(ICConfigurationDescription cfgDescription, IPath workingDirectory, + String[] env, IProgressMonitor monitor) { + + try { + startup(cfgDescription); + } catch (CoreException e) { + IStatus status = new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, IStatus.ERROR, "Error preparing to run Builtin Specs Detector", e); + MakeCorePlugin.log(status); + return status; + } + + MultiStatus status = new MultiStatus(MakeCorePlugin.PLUGIN_ID, IStatus.OK, "Problem running CDT Scanner Discovery provider " + getId(), null); + + boolean isChanged = false; + mappedRootURI = null; + buildDirURI = null; + + if (monitor == null) { + monitor = new NullProgressMonitor(); + } + + try { + + List languageIds = getLanguageScope(); + if (languageIds != null) { + int totalWork = TICKS_CLEAN_MARKERS + languageIds.size()*TICKS_RUN_FOR_ONE_LANGUAGE + TICKS_SERIALIZATION; + monitor.beginTask("CDT Scanner Discovery", totalWork * TICKS_SCALE); + + IResource markersResource = currentProject!= null ? currentProject : ResourcesPlugin.getWorkspace().getRoot(); + + // clear old markers + monitor.subTask("Clearing stale markers"); + try { + IMarker[] cur = markersResource.findMarkers(SDMarkerGenerator.SCANNER_DISCOVERY_PROBLEM_MARKER, false, IResource.DEPTH_ZERO); + for (IMarker marker : cur) { + if (getId().equals(marker.getAttribute(SDMarkerGenerator.PROVIDER))) { + marker.delete(); + } + } + } catch (CoreException e) { + MakeCorePlugin.log(e); + } + + if (monitor.isCanceled()) + throw new OperationCanceledException(); + + monitor.worked(TICKS_CLEAN_MARKERS * TICKS_SCALE); + + for (String languageId : languageIds) { + List oldEntries = getSettingEntries(cfgDescription, null, languageId); + try { + startupForLanguage(languageId); + if (monitor.isCanceled()) + throw new OperationCanceledException(); + + runForLanguage(workingDirectory, env, new SubProgressMonitor(monitor, TICKS_RUN_FOR_ONE_LANGUAGE * TICKS_SCALE)); + if (monitor.isCanceled()) + throw new OperationCanceledException(); + } catch (CoreException e) { + IStatus s = new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, IStatus.ERROR, "Error running Builtin Specs Detector", e); + MakeCorePlugin.log(s); + status.merge(s); + } finally { + shutdownForLanguage(); + } + List newEntries = getSettingEntries(cfgDescription, null, languageId); + isChanged = isChanged || newEntries != oldEntries; + + } + } + + monitor.subTask("Serializing results"); + if (isChanged) { // avoids resource and settings change notifications + try { + if (currentCfgDescription != null) { + LanguageSettingsProvidersSerializer.serializeLanguageSettings(currentCfgDescription.getProjectDescription()); + } else { + LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace(); + } + } catch (CoreException e) { + IStatus s = new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, IStatus.ERROR, "Error serializing language settings", e); + MakeCorePlugin.log(s); + status.merge(s); + } + + // AG: FIXME - rather send event that ls settings changed + if (currentCfgDescription != null) { + ICProject icProject = CoreModel.getDefault().create(currentProject); + ICElement[] tuSelection = new ICElement[] {icProject}; + try { + CCorePlugin.getIndexManager().update(tuSelection, IIndexManager.UPDATE_ALL | IIndexManager.UPDATE_EXTERNAL_FILES_FOR_PROJECT); + } catch (CoreException e) { + IStatus s = new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, IStatus.ERROR, "Error updating CDT index", e); + MakeCorePlugin.log(s); + status.merge(s); + } + } else { + // TODO + } + } + if (monitor.isCanceled()) + throw new OperationCanceledException(); + + monitor.worked(TICKS_SERIALIZATION * TICKS_SCALE); + } catch (OperationCanceledException e) { + if (!status.isOK()) { + MakeCorePlugin.log(status); + } + status.merge(new Status(IStatus.CANCEL, MakeCorePlugin.PLUGIN_ID, IStatus.OK, "Operation cancelled by user", e)); + } finally { + monitor.done(); + + // release resources + buildDirURI = null; + mappedRootURI = null; + shutdown(); + currentCfgDescription = cfgDescription; // current description gets cleared in super.shutdown(), keep it + } + + return status; + } + + protected void startupForLanguage(String languageId) throws CoreException { + currentLanguageId = languageId; + + specFile = null; // can get set in resolveCommand() + currentCommandResolved = resolveCommand(currentLanguageId); + + detectedSettingEntries = new ArrayList(); + collected = 0; + } + + protected void shutdownForLanguage() { + if (detectedSettingEntries != null && detectedSettingEntries.size() > 0) { + collected = detectedSettingEntries.size(); + + LanguageSettingsLogger.logInfo(getPrefixForLog() + + getClass().getSimpleName() + " collected " + detectedSettingEntries.size() + " entries" + " for language " + currentLanguageId); + + setSettingEntries(currentCfgDescription, currentResource, currentLanguageId, detectedSettingEntries); + } + detectedSettingEntries = null; + + currentCommandResolved = null; + if (specFile!=null && !preserveSpecFile) { + specFile.delete(); + specFile = null; + } + + currentLanguageId = null; + } + + /** + * TODO: test case for this function + */ + private void runForLanguage(IPath workingDirectory, String[] env, IProgressMonitor monitor) throws CoreException { + IConsole console; + if (isConsoleEnabled) { + console = startProviderConsole(); + } else { + // that looks in extension points registry and won't find the id, this console is not shown + console = CCorePlugin.getDefault().getConsole(MakeCorePlugin.PLUGIN_ID + ".console.hidden"); //$NON-NLS-1$ + } + console.start(currentProject); + OutputStream cos = console.getOutputStream(); + + // Using GMAKE_ERROR_PARSER_ID as it can handle shell error messages + errorParserManager = new ErrorParserManager(currentProject, new SDMarkerGenerator(), new String[] {GMAKE_ERROR_PARSER_ID}); + errorParserManager.setOutputStream(cos); + + if (monitor == null) { + monitor = new NullProgressMonitor(); + } + + try { + // StreamMonitor will do monitor.beginTask(...) + StreamMonitor streamMon = new StreamMonitor(monitor, errorParserManager, TICKS_STREAM_MONITOR); + OutputStream stdout = streamMon; + OutputStream stderr = streamMon; + + String msg = "Running scanner discovery: " + getName(); + printLine(stdout, "**** " + msg + " ****" + NEWLINE); + + ConsoleParser consoleParser = new ConsoleParser(); + ConsoleOutputSniffer sniffer = new ConsoleOutputSniffer(stdout, stderr, new IConsoleParser[] { consoleParser }, errorParserManager); + OutputStream consoleOut = sniffer.getOutputStream(); + OutputStream consoleErr = sniffer.getErrorStream(); + + boolean isSuccess = false; + try { + isSuccess = runProgram(currentCommandResolved, env, workingDirectory, monitor, consoleOut, consoleErr); + } catch (Exception e) { + MakeCorePlugin.log(e); + } + if (!isSuccess) { + try { + consoleOut.close(); + } catch (IOException e) { + MakeCorePlugin.log(e); + } + try { + consoleErr.close(); + } catch (IOException e) { + MakeCorePlugin.log(e); + } + } + } finally { + // ensure monitor.done() is called in cases when StreamMonitor fails to do that + monitor.done(); + } + } + + /** + * TODO + * Note that progress monitor life cycle is handled elsewhere. This method assumes that + * monitor.beginTask(...) has already been called. + */ + protected boolean runProgram(String command, String[] env, IPath workingDirectory, IProgressMonitor monitor, + OutputStream consoleOut, OutputStream consoleErr) throws CoreException, IOException { + + if (command==null || command.trim().length()==0) { + return false; + } + + String errMsg = null; + ICommandLauncher launcher = new CommandLauncher(); + + launcher.setProject(currentProject); + + // Print the command for visual interaction. + launcher.showCommand(true); + + String[] cmdArray = CommandLineUtil.argumentsToArray(command); + IPath program = new Path(cmdArray[0]); + String[] args = new String[0]; + if (cmdArray.length>1) { + args = new String[cmdArray.length-1]; + System.arraycopy(cmdArray, 1, args, 0, args.length); + } + + if (monitor==null) { + monitor = new NullProgressMonitor(); + } + Process p = launcher.execute(program, args, env, workingDirectory, monitor); + + if (p != null) { + // Before launching give visual cues via the monitor + monitor.subTask("Invoking command " + command); + if (launcher.waitAndRead(consoleOut, consoleErr, monitor) != ICommandLauncher.OK) { + errMsg = launcher.getErrorMessage(); + } + } else { + errMsg = launcher.getErrorMessage(); + } + if (errMsg!=null) { + String errorPrefix = MakeMessages.getString("ExternalScannerInfoProvider.Error_Prefix"); //$NON-NLS-1$ + + String msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Provider_Error", command); + printLine(consoleErr, errorPrefix + msg + NEWLINE); + + // Launching failed, trying to figure out possible cause + String envPath = getEnvVar(env, PATH_ENV); + if (!program.isAbsolute() && PathUtil.findProgramLocation(program.toString(), envPath) == null) { + printLine(consoleErr, errMsg); + msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Working_Directory", workingDirectory); //$NON-NLS-1$ + msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Program_Not_In_Path", program); //$NON-NLS-1$ + printLine(consoleErr, errorPrefix + msg + NEWLINE); + printLine(consoleErr, PATH_ENV + "=[" + envPath + "]" + NEWLINE); //$NON-NLS-1$ //$NON-NLS-2$ + } else { + printLine(consoleErr, errorPrefix + errMsg); + msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Working_Directory", workingDirectory); //$NON-NLS-1$ + printLine(consoleErr, PATH_ENV + "=[" + envPath + "]" + NEWLINE); //$NON-NLS-1$ //$NON-NLS-2$ + } + return false; + } + + printLine(consoleOut, NEWLINE + "**** Collected " + detectedSettingEntries.size() + " entries. ****"); + return true; + } + + /** + * TODO + */ + @Override + protected void setSettingEntries(List entries) { + // Builtin specs detectors collect entries not per line but for the whole output + if (entries!=null) + detectedSettingEntries.addAll(entries); + } + + private IConsole startProviderConsole() { + String extConsoleId; + if (currentProject != null) { + extConsoleId = "org.eclipse.cdt.make.internal.ui.scannerconfig.ScannerDiscoveryConsole"; + } else { + extConsoleId = "org.eclipse.cdt.make.internal.ui.scannerconfig.ScannerDiscoveryGlobalConsole"; + } + ILanguage ld = LanguageManager.getInstance().getLanguage(currentLanguageId); + String consoleId = MakeCorePlugin.PLUGIN_ID + '.' + getId() + '.' + currentLanguageId; + String consoleName = getName() + ", " + ld.getName(); + URL defaultIcon = Platform.getBundle(PLUGIN_CDT_MAKE_UI_ID).getEntry("icons/obj16/inspect_system.gif"); + + IConsole console = CCorePlugin.getDefault().getConsole(extConsoleId, consoleId, consoleName, defaultIcon); + return console; + } + + private String getEnvVar(String[] envStrings, String envVar) { + String envPath = null; + if (envStrings!=null) { + String varPrefix = envVar+'='; + for (String envStr : envStrings) { + boolean found = false; + // need to convert "Path" to "PATH" on Windows + if (Platform.getOS().equals(Platform.OS_WIN32)) { + found = envStr.substring(0,varPrefix.length()).toUpperCase().startsWith(varPrefix); + } else { + found = envStr.startsWith(varPrefix); + } + if (found) { + envPath = envStr.substring(varPrefix.length()); + break; + } + } + } else { + envPath = System.getenv(envVar); + } + return envPath; + } + + protected String getCompilerCommand(String languageId) { + IStatus status = new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, "Provider "+getId() + +" unable to find the compiler tool for language " + languageId); + MakeCorePlugin.log(new CoreException(status)); + return null; + } + + protected String getSpecFile(String languageId) { + String specExt = getSpecFileExtension(languageId); + String ext = ""; //$NON-NLS-1$ + if (specExt != null) { + ext = '.' + specExt; + } + + String specFileName = SPEC_FILE_BASE + ext; + IPath workingLocation = MakeCorePlugin.getWorkingDirectory(); + IPath fileLocation = workingLocation.append(specFileName); + + specFile = new java.io.File(fileLocation.toOSString()); + // will preserve spec file if it was already there otherwise will delete upon finishing + preserveSpecFile = specFile.exists(); + if (!preserveSpecFile) { + try { + specFile.createNewFile(); + } catch (IOException e) { + MakeCorePlugin.log(e); + } + } + + return fileLocation.toString(); + } + + /** + * Determine file extension by language id. This implementation retrieves first extension + * from the list as there could be multiple extensions associated with the given language. + * + * @param languageId - given language ID. + * @return file extension associated with the language or {@code null} if not found. + */ + protected String getSpecFileExtension(String languageId) { + String ext = null; + ILanguageDescriptor langDescriptor = LanguageManager.getInstance().getLanguageDescriptor(languageId); + if (langDescriptor != null) { + IContentType[] contentTypes = langDescriptor.getContentTypes(); + if (contentTypes != null && contentTypes.length > 0) { + String[] fileExtensions = contentTypes[0].getFileSpecs(IContentType.FILE_EXTENSION_SPEC); + if (fileExtensions != null && fileExtensions.length > 0) { + ext = fileExtensions[0]; + } + } + } + + if (ext == null) { + MakeCorePlugin.log(new Status(IStatus.ERROR, MakeCorePlugin.PLUGIN_ID, "Unable to find file extension for language "+languageId)); + } + return ext; + } + + protected void printLine(OutputStream stream, String msg) { + try { + stream.write((msg + NEWLINE).getBytes()); + stream.flush(); + } catch (IOException e) { + MakeCorePlugin.log(e); + } + } + + @Override + public Element serializeAttributes(Element parentElement) { + Element elementProvider = super.serializeAttributes(parentElement); + elementProvider.setAttribute(ATTR_CONSOLE, Boolean.toString(isConsoleEnabled)); + return elementProvider; + } + + @Override + public void loadAttributes(Element providerNode) { + super.loadAttributes(providerNode); + + String consoleValue = XmlUtil.determineAttributeValue(providerNode, ATTR_CONSOLE); + if (consoleValue!=null) + isConsoleEnabled = Boolean.parseBoolean(consoleValue); + } + + @Override + public void loadEntries(Element providerNode) { + super.loadEntries(providerNode); + // TODO - test case for that or maybe introduce "isExecuted" attribute in XML? + if (!isEmpty()) + isExecuted = true; + } + + @Override + public void clear() { + super.clear(); + isExecuted = false; + } + + @Override + protected AbstractBuiltinSpecsDetector cloneShallow() throws CloneNotSupportedException { + AbstractBuiltinSpecsDetector clone = (AbstractBuiltinSpecsDetector) super.cloneShallow(); + clone.isExecuted = false; + return clone; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = super.hashCode(); + result = prime * result + (isConsoleEnabled ? 1231 : 1237); + result = prime * result + (isExecuted ? 1231 : 1237); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (!super.equals(obj)) + return false; + if (!(obj instanceof AbstractBuiltinSpecsDetector)) + return false; + AbstractBuiltinSpecsDetector other = (AbstractBuiltinSpecsDetector) obj; + if (isConsoleEnabled != other.isConsoleEnabled) + return false; + if (isExecuted != other.isExecuted) + return false; + return true; + } +} diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractLanguageSettingsOutputScanner.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractLanguageSettingsOutputScanner.java new file mode 100644 index 00000000000..69366a058e5 --- /dev/null +++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/AbstractLanguageSettingsOutputScanner.java @@ -0,0 +1,866 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.core.scannerconfig; + +import java.io.File; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.ErrorParserManager; +import org.eclipse.cdt.core.cdtvariables.CdtVariableException; +import org.eclipse.cdt.core.cdtvariables.ICdtVariableManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.settings.model.util.CDataUtil; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsLogger; +import org.eclipse.cdt.make.core.MakeCorePlugin; +import org.eclipse.cdt.utils.EFSExtensionManager; +import org.eclipse.core.filesystem.EFS; +import org.eclipse.core.resources.IContainer; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.IWorkspaceRoot; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Platform; +import org.eclipse.core.runtime.content.IContentType; +import org.eclipse.core.runtime.content.IContentTypeManager; +import org.w3c.dom.Element; + +public abstract class AbstractLanguageSettingsOutputScanner extends LanguageSettingsSerializable { + + protected static final String ATTR_EXPAND_RELATIVE_PATHS = "expand-relative-paths"; //$NON-NLS-1$ + + protected ICConfigurationDescription currentCfgDescription = null; + protected IProject currentProject = null; + protected IResource currentResource = null; + protected String currentLanguageId = null; + + protected ErrorParserManager errorParserManager = null; + protected String parsedResourceName = null; + protected boolean isResolvingPaths = true; + + protected static abstract class AbstractOptionParser { + protected final Pattern pattern; + protected final String patternStr; + protected String nameExpression; + protected String valueExpression; + protected int extraFlag = 0; + protected int kind = 0; + private String parsedName; + private String parsedValue; + + public AbstractOptionParser(int kind, String pattern, String nameExpression, String valueExpression, int extraFlag) { + this.kind = kind; + this.patternStr = pattern; + this.nameExpression = nameExpression; + this.valueExpression = valueExpression; + this.extraFlag = extraFlag; + + this.pattern = Pattern.compile(pattern); + } + + public ICLanguageSettingEntry createEntry(String name, String value, int flag) { + return (ICLanguageSettingEntry) CDataUtil.createEntry(kind, name, value, null, flag | extraFlag); + } + + /** + * TODO: explain + */ + protected String extractOption(String input) { + @SuppressWarnings("nls") + String option = input.replaceFirst("(" + patternStr + ").*", "$1"); + return option; + } + + protected String parseStr(Matcher matcher, String str) { + if (str != null) + return matcher.replaceAll(str); + return null; + } + + protected boolean isPathKind() { + return kind == ICSettingEntry.INCLUDE_PATH || kind == ICSettingEntry.INCLUDE_FILE + || kind == ICSettingEntry.MACRO_FILE || kind == ICSettingEntry.LIBRARY_PATH; + } + + public boolean parseOption(String option) { + String opt = extractOption(option); + Matcher matcher = pattern.matcher(opt); + boolean isMatch = matcher.matches(); + if (isMatch) { + parsedName = parseStr(matcher, nameExpression); + parsedValue = parseStr(matcher, valueExpression); + } + return isMatch; + } + + } + + protected static class IncludePathOptionParser extends AbstractOptionParser { + public IncludePathOptionParser(String pattern, String nameExpression) { + super(ICLanguageSettingEntry.INCLUDE_PATH, pattern, nameExpression, nameExpression, 0); + } + public IncludePathOptionParser(String pattern, String nameExpression, int extraFlag) { + super(ICLanguageSettingEntry.INCLUDE_PATH, pattern, nameExpression, nameExpression, extraFlag); + } + } + + protected static class IncludeFileOptionParser extends AbstractOptionParser { + public IncludeFileOptionParser(String pattern, String nameExpression) { + super(ICLanguageSettingEntry.INCLUDE_FILE, pattern, nameExpression, nameExpression, 0); + } + public IncludeFileOptionParser(String pattern, String nameExpression, int extraFlag) { + super(ICLanguageSettingEntry.INCLUDE_FILE, pattern, nameExpression, nameExpression, extraFlag); + } + } + + protected static class MacroOptionParser extends AbstractOptionParser { + public MacroOptionParser(String pattern, String nameExpression, String valueExpression) { + super(ICLanguageSettingEntry.MACRO, pattern, nameExpression, valueExpression, 0); + } + public MacroOptionParser(String pattern, String nameExpression, String valueExpression, int extraFlag) { + super(ICLanguageSettingEntry.MACRO, pattern, nameExpression, valueExpression, extraFlag); + } + public MacroOptionParser(String pattern, String nameExpression, int extraFlag) { + super(ICLanguageSettingEntry.MACRO, pattern, nameExpression, null, extraFlag); + } + } + + protected static class MacroFileOptionParser extends AbstractOptionParser { + public MacroFileOptionParser(String pattern, String nameExpression) { + super(ICLanguageSettingEntry.MACRO_FILE, pattern, nameExpression, nameExpression, 0); + } + public MacroFileOptionParser(String pattern, String nameExpression, int extraFlag) { + super(ICLanguageSettingEntry.MACRO_FILE, pattern, nameExpression, nameExpression, extraFlag); + } + } + + protected static class LibraryPathOptionParser extends AbstractOptionParser { + public LibraryPathOptionParser(String pattern, String nameExpression) { + super(ICLanguageSettingEntry.LIBRARY_PATH, pattern, nameExpression, nameExpression, 0); + } + public LibraryPathOptionParser(String pattern, String nameExpression, int extraFlag) { + super(ICLanguageSettingEntry.LIBRARY_PATH, pattern, nameExpression, nameExpression, extraFlag); + } + } + + protected static class LibraryFileOptionParser extends AbstractOptionParser { + public LibraryFileOptionParser(String pattern, String nameExpression) { + super(ICLanguageSettingEntry.LIBRARY_FILE, pattern, nameExpression, nameExpression, 0); + } + public LibraryFileOptionParser(String pattern, String nameExpression, int extraFlag) { + super(ICLanguageSettingEntry.LIBRARY_FILE, pattern, nameExpression, nameExpression, extraFlag); + } + } + + /** + * Parse the line returning the resource name as appears in the output. + * This is the resource where {@link ICLanguageSettingEntry} list is being added. + * + * @param line - one input line from the output stripped from end of line characters. + * @return the resource name as appears in the output or {@code null}. + * Note that {@code null} can have different semantics and can mean "no resource found" + * or "applicable to any resource". By default "no resource found" is used in this + * abstract class but extenders can handle otherwise. + */ + protected abstract String parseForResourceName(String line); + + /** + * Parse the line returning the list of substrings to be treated each as input to + * the option parsers. It is assumed that each substring presents one + * {@link ICLanguageSettingEntry} (for example compiler options {@code -I/path} or + * {@code -DMACRO=1}. + * + * @param line - one input line from the output stripped from end of line characters. + * @return list of substrings representing language settings entries. + */ + protected abstract List parseForOptions(String line); + + /** + * @return array of option parsers defining how to parse a string to + * {@link ICLanguageSettingEntry}. + * See {@link AbstractOptionParser} and its specific extenders. + */ + protected abstract AbstractOptionParser[] getOptionParsers(); + + public boolean isResolvingPaths() { + return isResolvingPaths; + } + + public void setResolvingPaths(boolean resolvePaths) { + this.isResolvingPaths = resolvePaths; + } + + + public void startup(ICConfigurationDescription cfgDescription) throws CoreException { + currentCfgDescription = cfgDescription; + currentProject = cfgDescription != null ? cfgDescription.getProjectDescription().getProject() : null; + } + + public void shutdown() { + // release resources for garbage collector + currentCfgDescription = null; + currentProject = null; + currentResource = null; + currentLanguageId = null; + + errorParserManager = null; + parsedResourceName = null; + } + + public boolean processLine(String line, ErrorParserManager epm) { + errorParserManager = epm; + parsedResourceName = parseForResourceName(line); + currentResource = findResource(parsedResourceName); + + currentLanguageId = determineLanguage(); + if (!isLanguageInScope(currentLanguageId)) + return false; + + /** + * URI of directory where the build is happening. This URI could point to a remote filesystem + * for remote builds. Most often it is the same filesystem as for currentResource but + * it can be different filesystem (and different URI schema). + */ + URI buildDirURI = null; + + /** + * Where source tree starts if mapped. This kind of mapping is useful for example in cases when + * the absolute path to the source file on the remote system is simulated inside a project in the + * workspace. + * This URI is rooted on the same filesystem where currentResource resides. In general this filesystem + * (or even URI schema) does not have to match that of buildDirURI. + */ + URI mappedRootURI = null; + + if (isResolvingPaths) { + mappedRootURI = getMappedRootURI(currentResource, parsedResourceName); + buildDirURI = getBuildDirURI(mappedRootURI); + } + + List entries = new ArrayList(); + + List options = parseForOptions(line); + if (options!=null) { + for (String option : options) { + @SuppressWarnings("unused") + int i =0; + for (AbstractOptionParser optionParser : getOptionParsers()) { + try { + if (optionParser.parseOption(option)) { + ICLanguageSettingEntry entry = null; + if (isResolvingPaths && optionParser.isPathKind()) { + URI baseURI = new Path(optionParser.parsedName).isAbsolute() ? mappedRootURI : buildDirURI; + entry = createResolvedPathEntry(optionParser, optionParser.parsedName, 0, baseURI); + } else { + entry = optionParser.createEntry(optionParser.parsedName, optionParser.parsedValue, 0); + } + + if (entry != null && !entries.contains(entry)) { + entries.add(entry); + break; + } + } + } catch (Throwable e) { + // protect from rogue parsers extending this class + MakeCorePlugin.log(e); + } + } + } + if (entries.size() > 0) { + setSettingEntries(entries); + } else { + setSettingEntries(null); + } + } + return false; + } + + // TODO - remove me + @Deprecated + protected String getPrefixForLog() { + String str; + if (currentCfgDescription!= null) { + IProject ownerProject = currentCfgDescription.getProjectDescription().getProject(); + str = ownerProject + ":" + currentCfgDescription.getName(); + } else { + str = "[global]"; + } + return str + ": "; + } + + protected void setSettingEntries(List entries) { + setSettingEntries(currentCfgDescription, currentResource, currentLanguageId, entries); + + LanguageSettingsLogger.logInfo(getPrefixForLog() + + getClass().getSimpleName() + " collected " + (entries!=null ? ("" + entries.size()) : "null") + " entries for " + currentResource); + } + + protected String determineLanguage() { + IResource rc = currentResource; + if (rc == null && currentProject != null && parsedResourceName != null) { + String fileName = new Path(parsedResourceName).lastSegment().toString(); + // use handle; resource does not need to exist + rc = currentProject.getFile("__" + fileName); + } + + if (rc == null) + return null; + + List languageIds = LanguageSettingsManager.getLanguages(rc, currentCfgDescription); + if (languageIds.isEmpty()) + return null; + + return languageIds.get(0); + } + + protected boolean isLanguageInScope(String languageId) { + List languageIds = getLanguageScope(); + return languageIds == null || languageIds.contains(languageId); + } + + protected String getPatternFileExtensions() { + IContentTypeManager manager = Platform.getContentTypeManager(); + + Set fileExts = new HashSet(); + + IContentType contentTypeCpp = manager.getContentType("org.eclipse.cdt.core.cxxSource"); //$NON-NLS-1$ + fileExts.addAll(Arrays.asList(contentTypeCpp.getFileSpecs(IContentType.FILE_EXTENSION_SPEC))); + + IContentType contentTypeC = manager.getContentType("org.eclipse.cdt.core.cSource"); //$NON-NLS-1$ + fileExts.addAll(Arrays.asList(contentTypeC.getFileSpecs(IContentType.FILE_EXTENSION_SPEC))); + + String pattern = expressionLogicalOr(fileExts); + + return pattern; + } + + private ICLanguageSettingEntry createResolvedPathEntry(AbstractOptionParser optionParser, + String parsedPath, int flag, URI baseURI) { + + ICLanguageSettingEntry entry; + String resolvedPath = null; + + URI uri = determineMappedURI(parsedPath, baseURI); + IResource rc = null; + if (uri != null && uri.isAbsolute()) { + rc = findResourceForLocationURI(uri, optionParser.kind, currentProject); + } + if (rc != null) { + IPath path = rc.getFullPath(); + resolvedPath = path.toString(); + flag = flag | ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED; + } else { + IPath path = getFilesystemLocation(uri); + if (path != null && new File(path.toString()).exists()) { + resolvedPath = path.toString(); + } + if (resolvedPath == null) { + Set referencedProjectsNames = new LinkedHashSet(); + if (currentCfgDescription!=null) { + Map refs = currentCfgDescription.getReferenceInfo(); + referencedProjectsNames.addAll(refs.keySet()); + } + IResource resource = resolveResourceInWorkspace(parsedPath, currentProject, referencedProjectsNames); + if (resource != null) { + path = resource.getFullPath(); + resolvedPath = path.toString(); + flag = flag | ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED; + } + } + if (resolvedPath==null && path!=null) { + resolvedPath = path.toString(); + } + } + + if (resolvedPath==null) { + resolvedPath = parsedPath; + } + + entry = optionParser.createEntry(resolvedPath, resolvedPath, flag); + return entry; + } + + private IResource findResource(String parsedResourceName) { + if (parsedResourceName==null) + return null; + + IResource sourceFile = null; + + // try ErrorParserManager + if (errorParserManager != null) { + sourceFile = errorParserManager.findFileName(parsedResourceName); + } + // try to find absolute path in the workspace + if (sourceFile == null && new Path(parsedResourceName).isAbsolute()) { + URI uri = org.eclipse.core.filesystem.URIUtil.toURI(parsedResourceName); + sourceFile = findFileForLocationURI(uri, currentProject); + } + // try path relative to build dir from configuration + if (sourceFile == null && currentCfgDescription != null) { + IPath builderCWD = currentCfgDescription.getBuildSetting().getBuilderCWD(); + if (builderCWD!=null) { + IPath path = builderCWD.append(parsedResourceName); + URI uri = org.eclipse.core.filesystem.URIUtil.toURI(path); + sourceFile = findFileForLocationURI(uri, currentProject); + } + } + // try path relative to the project + if (sourceFile == null && currentProject != null) { + sourceFile = currentProject.findMember(parsedResourceName); + } + return sourceFile; + } + + protected URI getBuildDirURI(URI mappedRootURI) { + URI buildDirURI = null; + + URI cwdURI = null; + if (currentResource!=null && parsedResourceName!=null && !new Path(parsedResourceName).isAbsolute()) { + cwdURI = findBaseLocationURI(currentResource.getLocationURI(), parsedResourceName); + } + if (cwdURI == null && errorParserManager != null) { + cwdURI = errorParserManager.getWorkingDirectoryURI(); + } + + String cwdPath = cwdURI != null ? EFSExtensionManager.getDefault().getPathFromURI(cwdURI) : null; + if (cwdPath != null && mappedRootURI != null) { + buildDirURI = EFSExtensionManager.getDefault().append(mappedRootURI, cwdPath); + } else { + buildDirURI = cwdURI; + } + + if (buildDirURI == null && currentCfgDescription != null) { + IPath pathBuilderCWD = currentCfgDescription.getBuildSetting().getBuilderCWD(); + if (pathBuilderCWD != null) { + String builderCWD = pathBuilderCWD.toString(); + try { + // TODO - here is a hack to overcome ${workspace_loc:/prj-name} returned by builder + ICdtVariableManager vmanager = CCorePlugin.getDefault().getCdtVariableManager(); + builderCWD = vmanager.resolveValue(builderCWD, "", null, currentCfgDescription); + } catch (CdtVariableException e) { + MakeCorePlugin.log(e); + } + buildDirURI = org.eclipse.core.filesystem.URIUtil.toURI(builderCWD); + } + } + + if (buildDirURI == null && currentProject != null) { + buildDirURI = currentProject.getLocationURI(); + } + + if (buildDirURI == null && currentResource != null) { + IContainer container; + if (currentResource instanceof IContainer) { + container = (IContainer) currentResource; + } else { + container = currentResource.getParent(); + } + buildDirURI = container.getLocationURI(); + } + return buildDirURI; + } + + /** + * Determine URI on the local filesystem considering possible mapping. + * + * @param pathStr - path to the resource, can be absolute or relative + * @param baseURI - base {@link URI} where path to the resource is rooted + * @return {@link URI} of the resource + */ + private static URI determineMappedURI(String pathStr, URI baseURI) { + URI uri = null; + + if (baseURI==null) { + if (new Path(pathStr).isAbsolute()) { + uri = resolvePathFromBaseLocation(pathStr, Path.ROOT); + } + } else if (baseURI.getScheme().equals(EFS.SCHEME_FILE)) { + // location on the local filesystem + IPath baseLocation = org.eclipse.core.filesystem.URIUtil.toPath(baseURI); + // careful not to use Path here but 'pathStr' as String as we want to properly navigate symlinks + uri = resolvePathFromBaseLocation(pathStr, baseLocation); + } else { + // location on a remote filesystem + IPath path = new Path(pathStr); // use canonicalized path here, in particular replace all '\' with '/' for Windows paths + URI remoteUri = EFSExtensionManager.getDefault().append(baseURI, path.toString()); + if (remoteUri!=null) { + String localPath = EFSExtensionManager.getDefault().getMappedPath(remoteUri); + if (localPath!=null) { + uri = org.eclipse.core.filesystem.URIUtil.toURI(localPath); + } + } + } + + if (uri == null) { + // if everything fails just wrap string to URI + uri = org.eclipse.core.filesystem.URIUtil.toURI(pathStr); + } + return uri; + } + + private static IResource resolveResourceInWorkspace(String parsedName, IProject preferredProject, Set referencedProjectsNames) { + IPath path = new Path(parsedName); + if (path.equals(new Path(".")) || path.equals(new Path(".."))) { //$NON-NLS-1$ //$NON-NLS-2$ + return null; + } + + // prefer current project + if (preferredProject!=null) { + List result = findPathInFolder(path, preferredProject); + int size = result.size(); + if (size==1) { // found the one + return result.get(0); + } else if (size>1) { // ambiguous + return null; + } + } + + IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot(); + + // then prefer referenced projects + if (referencedProjectsNames.size() > 0) { + IResource rc = null; + for (String prjName : referencedProjectsNames) { + IProject prj = root.getProject(prjName); + if (prj.isOpen()) { + List result = findPathInFolder(path, prj); + int size = result.size(); + if (size==1 && rc==null) { + rc = result.get(0); + } else if (size > 0) { + // ambiguous + rc = null; + break; + } + } + } + if (rc!=null) { + return rc; + } + } + + // then check all other projects in workspace + IProject[] projects = root.getProjects(); + if (projects.length > 0) { + IResource rc = null; + for (IProject prj : projects) { + if (!prj.equals(preferredProject) && !referencedProjectsNames.contains(prj.getName()) && prj.isOpen()) { + List result = findPathInFolder(path, prj); + int size = result.size(); + if (size==1 && rc==null) { + rc = result.get(0); + } else if (size > 0) { + // ambiguous + rc = null; + break; + } + } + } + if (rc!=null) { + return rc; + } + } + + // not found or ambiguous + return null; + } + + private static List findPathInFolder(IPath path, IContainer folder) { + List paths = new ArrayList(); + IResource resource = folder.findMember(path); + if (resource != null) { + paths.add(resource); + } + + try { + for (IResource res : folder.members()) { + if (res instanceof IContainer) { + paths.addAll(findPathInFolder(path, (IContainer) res)); + } + } + } catch (CoreException e) { + // ignore + } + + return paths; + } + + private static IResource findFileForLocationURI(URI uri, IProject preferredProject) { + IResource sourceFile; + IResource result = null; + IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot(); + IResource[] resources = root.findFilesForLocationURI(uri); + if (resources.length > 0) { + result = resources[0]; + if (preferredProject!=null) { + for (IResource rc : resources) { + if (rc.getProject().equals(preferredProject)) { + result = rc; + break; + } + } + } + } + sourceFile = result; + return sourceFile; + } + + private static URI findBaseLocationURI(URI fileURI, String relativeFileName) { + URI cwdURI = null; + String path = fileURI.getPath(); + + String[] segments = relativeFileName.split("[/\\\\]"); //$NON-NLS-1$ + + // start removing segments from the end of the path + for (int i = segments.length - 1; i >= 0; i--) { + String lastSegment = segments[i]; + if (lastSegment.length() > 0 && !lastSegment.equals(".")) { //$NON-NLS-1$ + if (lastSegment.equals("..")) { //$NON-NLS-1$ + // navigating ".." in the other direction is ambiguous, bailing out + return null; + } else { + if (path.endsWith("/" + lastSegment)) { //$NON-NLS-1$ + int pos = path.lastIndexOf("/" + lastSegment); //$NON-NLS-1$ + path = path.substring(0, pos); + continue; + } else { + // ouch, relativeFileName does not match fileURI, bailing out + return null; + } + } + } + } + + try { + cwdURI = new URI(fileURI.getScheme(), fileURI.getUserInfo(), fileURI.getHost(), + fileURI.getPort(), path + '/', fileURI.getQuery(), fileURI.getFragment()); + } catch (URISyntaxException e) { + // It should be valid URI here or something is wrong + MakeCorePlugin.log(e); + } + + return cwdURI; + } + + /** + * In case when absolute path is mapped to the source tree in a project + * this function will try to figure mapping and return "mapped root", + * i.e URI where the root path would be mapped. The mapped root will be + * used to prepend to other "absolute" paths where appropriate. + * + * @param sourceFile - a resource referred by parsed path + * @param parsedResourceName - path as appears in the output + * @return mapped path as URI + */ + protected URI getMappedRootURI(IResource sourceFile, String parsedResourceName) { + if (currentResource==null) { + return null; + } + + URI fileURI = sourceFile.getLocationURI(); + String mappedRoot = "/"; //$NON-NLS-1$ + + if (parsedResourceName!=null) { + IPath parsedSrcPath = new Path(parsedResourceName); + if (parsedSrcPath.isAbsolute()) { + IPath absPath = sourceFile.getLocation(); + int absSegmentsCount = absPath.segmentCount(); + int relSegmentsCount = parsedSrcPath.segmentCount(); + if (absSegmentsCount >= relSegmentsCount) { + IPath ending = absPath.removeFirstSegments(absSegmentsCount - relSegmentsCount); + ending = ending.setDevice(parsedSrcPath.getDevice()).makeAbsolute(); + if (ending.equals(parsedSrcPath.makeAbsolute())) { + mappedRoot = absPath.removeLastSegments(relSegmentsCount).toString(); + } + } + } + } + URI uri = EFSExtensionManager.getDefault().createNewURIFromPath(fileURI, mappedRoot); + return uri; + } + + /** + * The manipulations here are done to resolve "../" navigation for symbolic links where "link/.." cannot + * be collapsed as it must follow the real filesystem path. {@link java.io.File#getCanonicalPath()} deals + * with that correctly but {@link Path} or {@link URI} try to normalize the path which would be incorrect + * here. + */ + private static URI resolvePathFromBaseLocation(String name, IPath baseLocation) { + String pathName = name; + if (baseLocation != null && !baseLocation.isEmpty()) { + pathName = pathName.replace(File.separatorChar, '/'); + String device = new Path(pathName).getDevice(); + if (device==null || device.equals(baseLocation.getDevice())) { + if (device != null && device.length() > 0) { + pathName = pathName.substring(device.length()); + } + + baseLocation = baseLocation.addTrailingSeparator(); + if (pathName.startsWith("/")) { //$NON-NLS-1$ + pathName = pathName.substring(1); + } + pathName = baseLocation.toString() + pathName; + } + } + + try { + File file = new File(pathName); + file = file.getCanonicalFile(); + return file.toURI(); + } catch (IOException e) { + // if error just leave it as is + } + + URI uri = org.eclipse.core.filesystem.URIUtil.toURI(pathName); + return uri; + } + + private static IResource findResourceForLocationURI(URI uri, int kind, IProject preferredProject) { + if (uri==null) + return null; + + IResource resource = null; + + switch (kind) { + case ICSettingEntry.INCLUDE_PATH: + case ICSettingEntry.LIBRARY_PATH: + resource = findContainerForLocationURI(uri, preferredProject); + break; + case ICSettingEntry.INCLUDE_FILE: + case ICSettingEntry.MACRO_FILE: + resource = findFileForLocationURI(uri, preferredProject); + break; + } + + return resource; + } + + private static IResource findContainerForLocationURI(URI uri, IProject preferredProject) { + IResource resource = null; + IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot(); + IResource[] resources = root.findContainersForLocationURI(uri); + if (resources.length > 0) { + for (IResource rc : resources) { + if ((rc instanceof IProject || rc instanceof IFolder)) { // treat IWorkspaceRoot as non-workspace path + IProject prj = rc instanceof IProject ? (IProject)rc : rc.getProject(); + if (prj.equals(preferredProject)) { + resource = rc; + break; + } + if (resource==null) { + resource=rc; // to be deterministic the first qualified resource has preference + } + } + } + } + return resource; + } + + private static IPath getFilesystemLocation(URI uri) { + if (uri==null) + return null; + + // EFSExtensionManager mapping + String pathStr = EFSExtensionManager.getDefault().getMappedPath(uri); + uri = org.eclipse.core.filesystem.URIUtil.toURI(pathStr); + + try { + File file = new java.io.File(uri); + String canonicalPathStr = file.getCanonicalPath(); + return new Path(canonicalPathStr); + } catch (Exception e) { + MakeCorePlugin.log(e); + } + return null; + } + + @SuppressWarnings("nls") + private static String expressionLogicalOr(Set fileExts) { + String pattern = "("; + for (String ext : fileExts) { + if (pattern.length() != 1) + pattern += "|"; + pattern += "(" + Pattern.quote(ext) + ")"; + ext = ext.toUpperCase(); + if (!fileExts.contains(ext)) { + pattern += "|(" + Pattern.quote(ext) + ")"; + } + } + pattern += ")"; + return pattern; + } + + protected static int countGroups(String str) { + @SuppressWarnings("nls") + int count = str.replaceAll("[^\\(]", "").length(); + return count; + } + + @Override + public Element serializeAttributes(Element parentElement) { + Element elementProvider = super.serializeAttributes(parentElement); + elementProvider.setAttribute(ATTR_EXPAND_RELATIVE_PATHS, Boolean.toString(isResolvingPaths)); + return elementProvider; + } + + @Override + public void loadAttributes(Element providerNode) { + super.loadAttributes(providerNode); + + String expandRelativePathsValue = XmlUtil.determineAttributeValue(providerNode, ATTR_EXPAND_RELATIVE_PATHS); + if (expandRelativePathsValue!=null) + isResolvingPaths = Boolean.parseBoolean(expandRelativePathsValue); + } + + @Override + public int hashCode() { + final int prime = 31; + int result = super.hashCode(); + result = prime * result + (isResolvingPaths ? 1231 : 1237); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (!super.equals(obj)) + return false; + if (getClass() != obj.getClass()) + return false; + AbstractLanguageSettingsOutputScanner other = (AbstractLanguageSettingsOutputScanner) obj; + if (isResolvingPaths != other.isResolvingPaths) + return false; + return true; + } + +} diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/ScannerConfigBuilder.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/ScannerConfigBuilder.java index 304a6c78e10..86328c85459 100644 --- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/ScannerConfigBuilder.java +++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/ScannerConfigBuilder.java @@ -13,6 +13,8 @@ package org.eclipse.cdt.make.core.scannerconfig; import java.util.Map; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; +import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.resources.ACBuilder; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescription; @@ -75,6 +77,11 @@ public class ScannerConfigBuilder extends ACBuilder { buildInfo2 = ScannerConfigProfileManager.createScannerConfigBuildInfo2(getProject()); autodiscoveryEnabled2 = buildInfo2.isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + ICProjectDescription projDesc = CoreModel.getDefault().getProjectDescription(getProject()); + ICConfigurationDescription cfgDescription = projDesc.getActiveConfiguration(); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } if (autodiscoveryEnabled2) { monitor.beginTask(MakeMessages.getString("ScannerConfigBuilder.Invoking_Builder"), 100); //$NON-NLS-1$ @@ -129,6 +136,11 @@ public class ScannerConfigBuilder extends ACBuilder { protected boolean build(IProject project, InfoContext context, IScannerConfigBuilderInfo2 buildInfo2, IProgressMonitor monitor){ boolean autodiscoveryEnabled2 = buildInfo2.isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + ICProjectDescription projDesc = CoreModel.getDefault().getProjectDescription(getProject()); + ICConfigurationDescription cfgDescription = projDesc.getActiveConfiguration(); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } if (autodiscoveryEnabled2) { monitor.beginTask(MakeMessages.getString("ScannerConfigBuilder.Invoking_Builder"), 100); //$NON-NLS-1$ diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/GCCBuildCommandParser.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/GCCBuildCommandParser.java new file mode 100644 index 00000000000..3c544f7d960 --- /dev/null +++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/GCCBuildCommandParser.java @@ -0,0 +1,72 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.make.internal.core.scannerconfig; + + +import org.eclipse.cdt.core.errorparsers.RegexErrorPattern; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuildCommandParser; + +public class GCCBuildCommandParser extends AbstractBuildCommandParser implements ILanguageSettingsEditableProvider { + @SuppressWarnings("nls") + static final AbstractOptionParser[] optionParsers = { + new IncludePathOptionParser("-I\\s*([\"'])(.*)\\1", "$2"), + new IncludePathOptionParser("-I\\s*([^\\s\"']*)", "$1"), + new IncludeFileOptionParser("-include\\s*([\"'])(.*)\\1", "$2"), + new IncludeFileOptionParser("-include\\s*([^\\s\"']*)", "$1"), + new MacroOptionParser("-D\\s*([\"'])([^=]*)(=(.*))?\\1", "$2", "$4"), + new MacroOptionParser("-D\\s*([^\\s=\"']*)=(\\\\([\"']))(.*?)\\2", "$1", "$3$4$3"), + new MacroOptionParser("-D\\s*([^\\s=\"']*)=([\"'])(.*?)\\2", "$1", "$3"), + new MacroOptionParser("-D\\s*([^\\s=\"']*)(=([^\\s\"']*))?", "$1", "$3"), + new MacroOptionParser("-U\\s*([^\\s=\"']*)", "$1", ICSettingEntry.UNDEFINED), + new MacroFileOptionParser("-macros\\s*([\"'])(.*)\\1", "$2"), + new MacroFileOptionParser("-macros\\s*([^\\s\"']*)", "$1"), + new LibraryPathOptionParser("-L\\s*([\"'])(.*)\\1", "$2"), + new LibraryPathOptionParser("-L\\s*([^\\s\"']*)", "$1"), + new LibraryFileOptionParser("-l\\s*([^\\s\"']*)", "lib$1.a"), }; + + @Override + protected AbstractOptionParser[] getOptionParsers() { + return optionParsers; + } + + @Override + public GCCBuildCommandParser cloneShallow() throws CloneNotSupportedException { + return (GCCBuildCommandParser) super.cloneShallow(); + } + + @Override + public GCCBuildCommandParser clone() throws CloneNotSupportedException { + return (GCCBuildCommandParser) super.clone(); + } + + public static class GCCBuildCommandPatternHighlighter extends AbstractBuildCommandParser.AbstractBuildCommandPatternHighlighter { + // ID of the parser taken from the existing extension point + private static final String GCC_BUILD_COMMAND_PARSER_EXT = "org.eclipse.cdt.make.core.build.command.parser.gcc"; //$NON-NLS-1$ + + public GCCBuildCommandPatternHighlighter() { + super(GCC_BUILD_COMMAND_PARSER_EXT); + } + + @Override + public Object clone() throws CloneNotSupportedException { + GCCBuildCommandPatternHighlighter that = new GCCBuildCommandPatternHighlighter(); + that.setId(getId()); + that.setName(getName()); + for (RegexErrorPattern pattern : getPatterns()) { + that.addPattern((RegexErrorPattern)pattern.clone()); + } + return that; + } + } + +} diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/ScannerInfoConsoleParserFactory.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/ScannerInfoConsoleParserFactory.java index 0bd3ebaf6b6..369a5cd3ef5 100644 --- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/ScannerInfoConsoleParserFactory.java +++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/ScannerInfoConsoleParserFactory.java @@ -14,6 +14,10 @@ package org.eclipse.cdt.make.internal.core.scannerconfig; import java.io.OutputStream; import org.eclipse.cdt.core.IMarkerGenerator; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; import org.eclipse.cdt.internal.core.ConsoleOutputSniffer; import org.eclipse.cdt.make.core.MakeBuilder; import org.eclipse.cdt.make.core.MakeBuilderUtil; @@ -118,23 +122,29 @@ public class ScannerInfoConsoleParserFactory { // builder not installed or disabled } } - if (scBuildInfo != null && - scBuildInfo.isAutoDiscoveryEnabled() && - scBuildInfo.isBuildOutputParserEnabled()) { - // get the make builder console parser - SCProfileInstance profileInstance = ScannerConfigProfileManager.getInstance(). - getSCProfileInstance(currentProject, context, scBuildInfo.getSelectedProfileId()); - IScannerInfoConsoleParser clParser = profileInstance.createBuildOutputParser(); - if (collector == null) { - collector = profileInstance.getScannerInfoCollector(); - } - if(clParser != null){ - clParser.startup(currentProject, workingDirectory, collector, - scBuildInfo.isProblemReportingEnabled() ? markerGenerator : null); - // create an output stream sniffer - return new ConsoleOutputSniffer(outputStream, errorStream, new - IScannerInfoConsoleParser[] {clParser}); - } + if (scBuildInfo != null) { + boolean autodiscoveryEnabled2 = scBuildInfo.isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + ICProjectDescription projDesc = CoreModel.getDefault().getProjectDescription(currentProject); + ICConfigurationDescription cfgDescription = projDesc.getActiveConfiguration(); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } + if (autodiscoveryEnabled2 && scBuildInfo.isBuildOutputParserEnabled()) { + // get the make builder console parser + SCProfileInstance profileInstance = ScannerConfigProfileManager.getInstance(). + getSCProfileInstance(currentProject, context, scBuildInfo.getSelectedProfileId()); + IScannerInfoConsoleParser clParser = profileInstance.createBuildOutputParser(); + if (collector == null) { + collector = profileInstance.getScannerInfoCollector(); + } + if(clParser != null){ + clParser.startup(currentProject, workingDirectory, collector, + scBuildInfo.isProblemReportingEnabled() ? markerGenerator : null); + // create an output stream sniffer + return new ConsoleOutputSniffer(outputStream, errorStream, new + IScannerInfoConsoleParser[] {clParser}); + } + } } } // } diff --git a/build/org.eclipse.cdt.make.ui/META-INF/MANIFEST.MF b/build/org.eclipse.cdt.make.ui/META-INF/MANIFEST.MF index dfc8152316b..1986bb3259e 100644 --- a/build/org.eclipse.cdt.make.ui/META-INF/MANIFEST.MF +++ b/build/org.eclipse.cdt.make.ui/META-INF/MANIFEST.MF @@ -35,7 +35,8 @@ Require-Bundle: org.eclipse.ui.ide;bundle-version="[3.2.0,4.0.0)", org.eclipse.debug.ui;bundle-version="[3.2.0,4.0.0)", org.eclipse.ui.navigator;bundle-version="[3.2.0,4.0.0)";resolution:=optional, org.eclipse.compare;bundle-version="[3.3.0,4.0.0)", - org.eclipse.core.filesystem;bundle-version="1.2.0" + org.eclipse.core.filesystem;bundle-version="1.2.0", + org.eclipse.ui.console;bundle-version="3.5.100" Bundle-ActivationPolicy: lazy Bundle-RequiredExecutionEnvironment: JavaSE-1.6 Import-Package: com.ibm.icu.text diff --git a/build/org.eclipse.cdt.make.ui/icons/obj16/inspect_system.gif b/build/org.eclipse.cdt.make.ui/icons/obj16/inspect_system.gif new file mode 100644 index 00000000000..d68100a7488 Binary files /dev/null and b/build/org.eclipse.cdt.make.ui/icons/obj16/inspect_system.gif differ diff --git a/build/org.eclipse.cdt.make.ui/icons/obj16/log_obj.gif b/build/org.eclipse.cdt.make.ui/icons/obj16/log_obj.gif new file mode 100644 index 00000000000..aebeab820d8 Binary files /dev/null and b/build/org.eclipse.cdt.make.ui/icons/obj16/log_obj.gif differ diff --git a/build/org.eclipse.cdt.make.ui/icons/obj16/search.gif b/build/org.eclipse.cdt.make.ui/icons/obj16/search.gif new file mode 100644 index 00000000000..d540a01f4d9 Binary files /dev/null and b/build/org.eclipse.cdt.make.ui/icons/obj16/search.gif differ diff --git a/build/org.eclipse.cdt.make.ui/plugin.properties b/build/org.eclipse.cdt.make.ui/plugin.properties index 21b341f00ec..4db795b46c4 100644 --- a/build/org.eclipse.cdt.make.ui/plugin.properties +++ b/build/org.eclipse.cdt.make.ui/plugin.properties @@ -44,6 +44,9 @@ PreferenceBuildSettings.name=Settings ErrorParsersTab.name=Error Parsers ErrorParsersTab.tooltip=Error Parsers scan build output and report errors in Problems view +LanguageSettingsProvidersTab.name=Discovery +LanguageSettingsProvidersTab.tooltip=Language settings providers + PreferenceMakeProject.name=New Make Projects PreferenceMake.name=Make Targets PreferenceMakefileEditor.name=Makefile Editor diff --git a/build/org.eclipse.cdt.make.ui/plugin.xml b/build/org.eclipse.cdt.make.ui/plugin.xml index 002d57859e9..3c02054c2da 100644 --- a/build/org.eclipse.cdt.make.ui/plugin.xml +++ b/build/org.eclipse.cdt.make.ui/plugin.xml @@ -470,6 +470,14 @@ tooltip="%ErrorParsersTab.tooltip" weight="020"> + + + + + + + + + + + + + + + + diff --git a/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/preferences/GCCBuildCommandParserOptionPage.java b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/preferences/GCCBuildCommandParserOptionPage.java new file mode 100644 index 00000000000..f1d169a92c6 --- /dev/null +++ b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/preferences/GCCBuildCommandParserOptionPage.java @@ -0,0 +1,223 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.internal.ui.preferences; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.internal.ui.language.settings.providers.AbstractLanguageSettingProviderOptionPage; +import org.eclipse.cdt.internal.ui.newui.StatusMessageLine; +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuildCommandParser; +import org.eclipse.cdt.utils.ui.controls.ControlFactory; +import org.eclipse.core.runtime.Assert; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.jface.dialogs.Dialog; +import org.eclipse.swt.SWT; +import org.eclipse.swt.events.ModifyEvent; +import org.eclipse.swt.events.ModifyListener; +import org.eclipse.swt.events.SelectionAdapter; +import org.eclipse.swt.events.SelectionEvent; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Button; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Label; +import org.eclipse.swt.widgets.Text; + +/** + * Options page for TODO + * + */ +public final class GCCBuildCommandParserOptionPage extends AbstractLanguageSettingProviderOptionPage { + private boolean fEditable; + + private Text inputCommand; + + private StatusMessageLine fStatusLine; + private Button runOnceRadioButton; + private Button runEveryBuildRadioButton; + private Button expandRelativePathCheckBox; + private Button applyToProjectCheckBox; + + + /* + * (non-Javadoc) + * + * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite) + */ + @Override + public void createControl(Composite parent) { +// Composite optionsPageComposite = new Composite(composite, SWT.NULL); + fEditable = parent.isEnabled(); + + final Composite composite = new Composite(parent, SWT.NONE); + { + GridLayout layout = new GridLayout(); + layout.numColumns = 2; + layout.marginWidth = 1; + layout.marginHeight = 1; + layout.marginRight = 1; + composite.setLayout(layout); + composite.setLayoutData(new GridData(GridData.FILL_BOTH)); + Dialog.applyDialogFont(composite); + + GridData gd = new GridData(GridData.FILL_HORIZONTAL); + gd.horizontalSpan = 2; + composite.setLayoutData(gd); + } + + AbstractBuildCommandParser provider = getRawProvider(); + + // Compiler specs command + { + Label label = ControlFactory.createLabel(composite, "Compiler command pattern:"); + GridData gd = new GridData(); + gd.horizontalSpan = 1; + label.setLayoutData(gd); + label.setEnabled(fEditable); + } + + { + inputCommand = ControlFactory.createTextField(composite, SWT.SINGLE | SWT.BORDER); + String customParameter = provider.getCustomParameter(); + inputCommand.setText(customParameter!=null ? customParameter : ""); + + GridData gd = new GridData(); + gd.horizontalSpan = 1; + gd.grabExcessHorizontalSpace = true; + gd.horizontalAlignment = SWT.FILL; + inputCommand.setLayoutData(gd); + inputCommand.setEnabled(fEditable); + + inputCommand.addModifyListener(new ModifyListener() { + public void modifyText(ModifyEvent e) { + String text = inputCommand.getText(); + AbstractBuildCommandParser provider = getRawProvider(); + if (!text.equals(provider.getCustomParameter())) { + AbstractBuildCommandParser selectedProvider = getWorkingCopy(providerId); + selectedProvider.setCustomParameter(text); + providerTab.refreshItem(selectedProvider); + } + } + }); + } + +// { +// Button button = ControlFactory.createPushButton(composite, "Browse..."); +// button.setEnabled(fEditable); +// button.addSelectionListener(new SelectionAdapter() { +// +// @Override +// public void widgetSelected(SelectionEvent evt) { +//// handleAddr2LineButtonSelected(); +// //updateLaunchConfigurationDialog(); +// } +// +// }); +// +// } + + { + expandRelativePathCheckBox = new Button(composite, SWT.CHECK); + expandRelativePathCheckBox.setText("Use heuristics to resolve paths"); + GridData gd = new GridData(GridData.FILL_HORIZONTAL); + gd.horizontalSpan = 2; + expandRelativePathCheckBox.setLayoutData(gd); + + expandRelativePathCheckBox.setSelection(provider.isResolvingPaths()); + expandRelativePathCheckBox.setEnabled(fEditable); + expandRelativePathCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean enabled = expandRelativePathCheckBox.getSelection(); + AbstractBuildCommandParser provider = getRawProvider(); + if (enabled != provider.isResolvingPaths()) { + AbstractBuildCommandParser selectedProvider = getWorkingCopy(providerId); + selectedProvider.setResolvingPaths(enabled); + providerTab.refreshItem(selectedProvider); + } + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + + }); + + } + + { + applyToProjectCheckBox = new Button(composite, SWT.CHECK); + applyToProjectCheckBox.setText("Apply discovered settings on project level"); + GridData gd = new GridData(GridData.FILL_HORIZONTAL); + gd.horizontalSpan = 2; + applyToProjectCheckBox.setLayoutData(gd); + +// applyToProjectCheckBox.setSelection(provider.isExpandRelativePaths()); +// applyToProjectCheckBox.setEnabled(fEditable); + applyToProjectCheckBox.setSelection(false); + applyToProjectCheckBox.setEnabled(false); + applyToProjectCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean enabled = applyToProjectCheckBox.getSelection(); + AbstractBuildCommandParser provider = getRawProvider(); + if (enabled != provider.isResolvingPaths()) { + AbstractBuildCommandParser selectedProvider = getWorkingCopy(providerId); + selectedProvider.setResolvingPaths(enabled); + providerTab.refreshItem(selectedProvider); + } + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + + }); + + } + +// // Status line +// if (fEditable) { +// fStatusLine = new StatusMessageLine(composite, SWT.LEFT, 2); +// IStatus status = new Status(IStatus.WARNING, CUIPlugin.PLUGIN_ID, "Note that currently not all options are persisted (FIXME)"); +// fStatusLine.setErrorStatus(status); +// } + + setControl(composite); + } + + private AbstractBuildCommandParser getRawProvider() { + ILanguageSettingsProvider provider = LanguageSettingsManager.getRawProvider(providerTab.getProvider(providerId)); + Assert.isTrue(provider instanceof AbstractBuildCommandParser); + return (AbstractBuildCommandParser) provider; + } + + private AbstractBuildCommandParser getWorkingCopy(String providerId) { + ILanguageSettingsProvider provider = providerTab.getWorkingCopy(providerId); + Assert.isTrue(provider instanceof AbstractBuildCommandParser); + return (AbstractBuildCommandParser) provider; + } + + @Override + public void performApply(IProgressMonitor monitor) throws CoreException { + // handled by LanguageSettingsProviderTab + } + + @Override + public void performDefaults() { + // handled by LanguageSettingsProviderTab + } + +} diff --git a/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/BuiltinSpecsDetectorOptionPage.java b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/BuiltinSpecsDetectorOptionPage.java new file mode 100644 index 00000000000..f4bca39a44a --- /dev/null +++ b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/BuiltinSpecsDetectorOptionPage.java @@ -0,0 +1,261 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.internal.ui.scannerconfig; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.internal.ui.language.settings.providers.AbstractLanguageSettingProviderOptionPage; +import org.eclipse.cdt.internal.ui.newui.StatusMessageLine; +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuiltinSpecsDetector; +import org.eclipse.cdt.utils.ui.controls.ControlFactory; +import org.eclipse.core.runtime.Assert; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.jface.dialogs.Dialog; +import org.eclipse.swt.SWT; +import org.eclipse.swt.events.ModifyEvent; +import org.eclipse.swt.events.ModifyListener; +import org.eclipse.swt.events.SelectionAdapter; +import org.eclipse.swt.events.SelectionEvent; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Button; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Group; +import org.eclipse.swt.widgets.Label; +import org.eclipse.swt.widgets.Text; + +/** + * Options page for TODO + * + */ +public final class BuiltinSpecsDetectorOptionPage extends AbstractLanguageSettingProviderOptionPage { + private boolean fEditable; + + private Text inputCommand; + + private StatusMessageLine fStatusLine; + private Button allocateConsoleCheckBox; + + /* + * (non-Javadoc) + * + * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite) + */ + @Override + public void createControl(Composite parent) { +// Composite optionsPageComposite = new Composite(composite, SWT.NULL); + fEditable = parent.isEnabled(); + + Composite composite = new Composite(parent, SWT.NONE); + { + GridLayout layout = new GridLayout(); + layout.numColumns = 2; + layout.marginWidth = 1; + layout.marginHeight = 1; + layout.marginRight = 1; + composite.setLayout(layout); + composite.setLayoutData(new GridData(GridData.FILL_BOTH)); + Dialog.applyDialogFont(composite); + + GridData gd = new GridData(GridData.FILL_HORIZONTAL); + gd.horizontalSpan = 2; + composite.setLayoutData(gd); + } + + AbstractBuiltinSpecsDetector provider = getRawProvider(); + + // Compiler specs command + { + Label label = ControlFactory.createLabel(composite, "Command to get compiler specs:"); + GridData gd = new GridData(); + gd.horizontalSpan = 2; + label.setLayoutData(gd); + label.setEnabled(fEditable); + } + + { + inputCommand = ControlFactory.createTextField(composite, SWT.SINGLE | SWT.BORDER); + String customParameter = provider.getCustomParameter(); + inputCommand.setText(customParameter!=null ? customParameter : ""); + inputCommand.setEnabled(fEditable); + inputCommand.addModifyListener(new ModifyListener() { + public void modifyText(ModifyEvent e) { + String text = inputCommand.getText(); + AbstractBuiltinSpecsDetector provider = getRawProvider(); + if (!text.equals(provider.getCustomParameter())) { + AbstractBuiltinSpecsDetector selectedProvider = getWorkingCopy(providerId); + selectedProvider.setCustomParameter(text); + providerTab.refreshItem(selectedProvider); + } + } + }); + } + + { + Button button = ControlFactory.createPushButton(composite, "Browse..."); + button.setEnabled(fEditable); + button.addSelectionListener(new SelectionAdapter() { + + @Override + public void widgetSelected(SelectionEvent evt) { +// handleAddr2LineButtonSelected(); + //updateLaunchConfigurationDialog(); + } + + }); + + } + +// { +// final Button button = new Button(composite, SWT.PUSH); +// button.setFont(parent.getFont()); +// String text = fProvider.isEmpty() ? "Run Now (TODO)" : "Clear"; +// button.setText(text); +//// button.addSelectionListener(this); +// GridData data = new GridData(); +// data.horizontalSpan = 2; +//// data.horizontalAlignment = GridData.BEGINNING; +//// data.widthHint = 60; +// button.setLayoutData(data); +// // TODO +// button.setEnabled(fEditable && !fProvider.isEmpty()); +// +// button.addSelectionListener(new SelectionAdapter() { +// +// @Override +// public void widgetSelected(SelectionEvent evt) { +// if (fProvider.isEmpty()) { +// // TODO +// } else { +// fProvider.clear(); +// } +// // TODO +// button.setEnabled(fEditable && !fProvider.isEmpty()); +// String text = fProvider.isEmpty() ? "Run Now (TODO)" : "Clear"; +// button.setText(text); +// button.pack(); +// } +// +// }); +// +// } + +// // Compiler specs command +// { +// Label label = ControlFactory.createLabel(composite, "Parsing rules:"); +// GridData gd = new GridData(); +// gd.horizontalSpan = 2; +// label.setLayoutData(gd); +//// Label newLabel = new Label(composite, SWT.NONE); +////// ((GridData) newLabel.getLayoutData()).horizontalSpan = 1; +//// newLabel.setText("Command to get compiler specs:"); +// } + + +// createPatternsTable(group, composite); + + + + + + + + +// Group group = new Group(parent, SWT.SHADOW_ETCHED_IN); +// group.setText(DialogsMessages.RegexErrorParserOptionPage_Title); +// +// GridLayout gridLayout = new GridLayout(2, true); +// gridLayout.makeColumnsEqualWidth = false; +// gridLayout.marginRight = -10; +// gridLayout.marginLeft = -4; +// group.setLayout(gridLayout); +// group.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); +// +// Composite composite = new Composite(group, SWT.NONE); +// GridLayout layout = new GridLayout(); +// layout.numColumns = 2; +// layout.marginWidth = 1; +// layout.marginHeight = 1; +// layout.marginRight = 1; +// composite.setLayout(layout); +// composite.setLayoutData(new GridData(GridData.FILL_BOTH)); +// Dialog.applyDialogFont(composite); +// +// if (!fEditable) +// createLinkToPreferences(composite); +// +// createPatternsTable(group, composite); +// +// if (fEditable) { +// createButtons(composite); +// } + + { + allocateConsoleCheckBox = new Button(composite, SWT.CHECK); + allocateConsoleCheckBox.setText("Allocate console in the Console View"); + allocateConsoleCheckBox.setSelection(provider.isConsoleEnabled()); + allocateConsoleCheckBox.setEnabled(fEditable); + allocateConsoleCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean enabled = allocateConsoleCheckBox.getSelection(); + AbstractBuiltinSpecsDetector provider = getRawProvider(); + if (enabled != provider.isConsoleEnabled()) { + AbstractBuiltinSpecsDetector selectedProvider = getWorkingCopy(providerId); + selectedProvider.setConsoleEnabled(enabled); + providerTab.refreshItem(selectedProvider); + } + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + + }); + + } + +// // Status line +// if (fEditable) { +// fStatusLine = new StatusMessageLine(composite, SWT.LEFT, 2); +// IStatus status = new Status(IStatus.WARNING, CUIPlugin.PLUGIN_ID, "Note that currently not all options are persisted (FIXME)"); +// fStatusLine.setErrorStatus(status); +// } + + setControl(composite); + } + + private AbstractBuiltinSpecsDetector getRawProvider() { + ILanguageSettingsProvider provider = LanguageSettingsManager.getRawProvider(providerTab.getProvider(providerId)); + Assert.isTrue(provider instanceof AbstractBuiltinSpecsDetector); + return (AbstractBuiltinSpecsDetector) provider; + } + + private AbstractBuiltinSpecsDetector getWorkingCopy(String providerId) { + ILanguageSettingsProvider provider = providerTab.getWorkingCopy(providerId); + Assert.isTrue(provider instanceof AbstractBuiltinSpecsDetector); + return (AbstractBuiltinSpecsDetector) provider; + } + + @Override + public void performApply(IProgressMonitor monitor) throws CoreException { + // handled by LanguageSettingsProviderTab + } + + @Override + public void performDefaults() { + // handled by LanguageSettingsProviderTab + } + +} diff --git a/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/ScannerDiscoveryConsole.java b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/ScannerDiscoveryConsole.java new file mode 100644 index 00000000000..e5590d9fd43 --- /dev/null +++ b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/ScannerDiscoveryConsole.java @@ -0,0 +1,39 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.internal.ui.scannerconfig; + +import java.net.URL; + +import org.eclipse.cdt.internal.ui.buildconsole.CBuildConsole; +import org.eclipse.cdt.internal.ui.language.settings.providers.LanguageSettingsProviderAssociation; + +public class ScannerDiscoveryConsole extends CBuildConsole { + + /** + * {@inheritDoc} + * @param consoleId - a console ID is expected here which then is used as menu context ID. + * @param defaultIconUrl - if {@code LanguageSettingsProviderAssociation} extension point + * defines URL by provider id, {@code defaultIconUrl} will be ignored and the URL from the extension + * point will be used. If not, supplied {@code defaultIconUrl} will be used. + */ + @Override + public void init(String consoleId, String name, URL defaultIconUrl) { + URL iconUrl = LanguageSettingsProviderAssociation.getImageUrl(consoleId); + if (iconUrl==null) { + iconUrl = defaultIconUrl; + } + + super.init(consoleId, name, iconUrl); + } + + +} diff --git a/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/ScannerDiscoveryGlobalConsole.java b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/ScannerDiscoveryGlobalConsole.java new file mode 100644 index 00000000000..9a12186664c --- /dev/null +++ b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/internal/ui/scannerconfig/ScannerDiscoveryGlobalConsole.java @@ -0,0 +1,102 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.make.internal.ui.scannerconfig; + +import java.io.IOException; +import java.net.URL; + +import org.eclipse.cdt.core.ConsoleOutputStream; +import org.eclipse.cdt.internal.core.ICConsole; +import org.eclipse.cdt.internal.ui.language.settings.providers.LanguageSettingsProviderAssociation; +import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.runtime.Assert; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.ui.console.ConsolePlugin; +import org.eclipse.ui.console.IConsole; +import org.eclipse.ui.console.IConsoleManager; +import org.eclipse.ui.console.MessageConsole; +import org.eclipse.ui.console.MessageConsoleStream; + +public class ScannerDiscoveryGlobalConsole implements ICConsole { + private MessageConsole console; + private ConsoleOutputStreamAdapter stream; + + private class ConsoleOutputStreamAdapter extends ConsoleOutputStream { + private MessageConsoleStream fConsoleStream; + public ConsoleOutputStreamAdapter(MessageConsoleStream stream) { + fConsoleStream = stream; + } + @Override + public void write(int arg0) throws IOException { + fConsoleStream.write(arg0); + } + @Override + public synchronized void write(byte[] b, int off, int len) throws IOException { + fConsoleStream.write(b, off, len); + } + + @Override + public void flush() throws IOException { + fConsoleStream.flush(); + } + + @Override + public void close() throws IOException { + fConsoleStream.close(); + } + } + + public void start(IProject project) { + Assert.isTrue(project == null); + } + + public ConsoleOutputStream getOutputStream() throws CoreException { + return stream; + } + + public ConsoleOutputStream getInfoStream() throws CoreException { + return stream; + } + + public ConsoleOutputStream getErrorStream() throws CoreException { + return stream; + } + + public void init(String consoleId, String name, URL defaultIconUrl) { + console = null; + + IConsoleManager consoleManager = ConsolePlugin.getDefault().getConsoleManager(); + IConsole[] allConsoles = consoleManager.getConsoles(); + for (IConsole con : allConsoles) { + if (name.equals(con.getName()) && con instanceof MessageConsole) { + console = (MessageConsole) con; + console.clearConsole(); + break; + } + } + + if (console==null) { + URL iconUrl = LanguageSettingsProviderAssociation.getImageUrl(consoleId); + if (iconUrl==null) { + iconUrl = defaultIconUrl; + } + + console = new MessageConsole(name, CDTSharedImages.getImageDescriptor(iconUrl.toString())); + console.activate(); + consoleManager.addConsoles(new IConsole[]{ console }); + } + + stream = new ConsoleOutputStreamAdapter(console.newMessageStream()); + } + +} diff --git a/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/ui/dialogs/DiscoveryOptionsBlock.java b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/ui/dialogs/DiscoveryOptionsBlock.java index 56e44b3efec..e454eeaa0f7 100644 --- a/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/ui/dialogs/DiscoveryOptionsBlock.java +++ b/build/org.eclipse.cdt.make.ui/src/org/eclipse/cdt/make/ui/dialogs/DiscoveryOptionsBlock.java @@ -15,10 +15,13 @@ import java.util.Arrays; import java.util.Iterator; import java.util.List; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.CModelException; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.model.ICProject; import org.eclipse.cdt.core.model.IPathEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; import org.eclipse.cdt.make.core.MakeCorePlugin; import org.eclipse.cdt.make.core.MakeProjectNature; import org.eclipse.cdt.make.core.scannerconfig.IScannerConfigBuilderInfo2; @@ -180,8 +183,14 @@ public class DiscoveryOptionsBlock extends AbstractDiscoveryOptionsBlock { ((GridData)scEnabledButton.getLayoutData()).horizontalSpan = numColumns; ((GridData)scEnabledButton.getLayoutData()).grabExcessHorizontalSpace = true; // VMIR* old projects will have discovery disabled by default - scEnabledButton.setSelection(needsSCNature ? false - : (getBuildInfo().isAutoDiscoveryEnabled() + boolean autodiscoveryEnabled2 = getBuildInfo().isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + ICProjectDescription projDesc = CoreModel.getDefault().getProjectDescription(getProject()); + ICConfigurationDescription cfgDescription = projDesc.getActiveConfiguration(); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } + scEnabledButton.setSelection(needsSCNature ? false + : (autodiscoveryEnabled2 && !getBuildInfo().getSelectedProfileId().equals(ScannerConfigProfileManager.NULL_PROFILE_ID))); scEnabledButton.addSelectionListener(new SelectionAdapter() { @Override diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/META-INF/MANIFEST.MF b/build/org.eclipse.cdt.managedbuilder.core.tests/META-INF/MANIFEST.MF index 8c5591f6aa4..e3f95fe6e79 100644 --- a/build/org.eclipse.cdt.managedbuilder.core.tests/META-INF/MANIFEST.MF +++ b/build/org.eclipse.cdt.managedbuilder.core.tests/META-INF/MANIFEST.MF @@ -6,7 +6,8 @@ Bundle-Version: 8.1.0.qualifier Bundle-Activator: org.eclipse.cdt.managedbuilder.testplugin.CTestPlugin Bundle-Vendor: Eclipse CDT Bundle-Localization: plugin -Export-Package: org.eclipse.cdt.managedbuilder.core.tests, +Export-Package: org.eclipse.cdt.build.core.scannerconfig.tests;x-internal:=true, + org.eclipse.cdt.managedbuilder.core.tests, org.eclipse.cdt.managedbuilder.templateengine.tests, org.eclipse.cdt.managedbuilder.testplugin, org.eclipse.cdt.managedbuilder.tests.suite, diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/resources/depCalcProjects/test1DepCalc2/test1DepCalc2.zip b/build/org.eclipse.cdt.managedbuilder.core.tests/resources/depCalcProjects/test1DepCalc2/test1DepCalc2.zip old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/resources/depCalcProjects/test1DepCalc3/test1DepCalc3.zip b/build/org.eclipse.cdt.managedbuilder.core.tests/resources/depCalcProjects/test1DepCalc3/test1DepCalc3.zip old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/resources/depCalcProjects/test1DepCalcPreBuild/test1DepCalcPreBuild.zip b/build/org.eclipse.cdt.managedbuilder.core.tests/resources/depCalcProjects/test1DepCalcPreBuild/test1DepCalcPreBuild.zip old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/suite/org/eclipse/cdt/managedbuilder/tests/suite/AllManagedBuildTests.java b/build/org.eclipse.cdt.managedbuilder.core.tests/suite/org/eclipse/cdt/managedbuilder/tests/suite/AllManagedBuildTests.java index 65fdaadca1d..6ea149057a4 100644 --- a/build/org.eclipse.cdt.managedbuilder.core.tests/suite/org/eclipse/cdt/managedbuilder/tests/suite/AllManagedBuildTests.java +++ b/build/org.eclipse.cdt.managedbuilder.core.tests/suite/org/eclipse/cdt/managedbuilder/tests/suite/AllManagedBuildTests.java @@ -16,6 +16,7 @@ import junit.framework.Test; import junit.framework.TestSuite; import org.eclipse.cdt.build.core.scannerconfig.tests.CfgScannerConfigProfileManagerTests; +import org.eclipse.cdt.build.core.scannerconfig.tests.GCCBuiltinSpecsDetectorTest; import org.eclipse.cdt.build.core.scannerconfig.tests.GCCSpecsConsoleParserTest; import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.dom.IPDOMManager; @@ -59,6 +60,7 @@ public class AllManagedBuildTests { // build.core.scannerconfig.tests suite.addTest(CfgScannerConfigProfileManagerTests.suite()); suite.addTestSuite(GCCSpecsConsoleParserTest.class); + suite.addTestSuite(GCCBuiltinSpecsDetectorTest.class); // managedbuilder.core.tests suite.addTest(ManagedBuildCoreTests20.suite()); diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/build/core/scannerconfig/tests/AllLanguageSettingsProvidersMBSTests.java b/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/build/core/scannerconfig/tests/AllLanguageSettingsProvidersMBSTests.java new file mode 100644 index 00000000000..c521b01d261 --- /dev/null +++ b/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/build/core/scannerconfig/tests/AllLanguageSettingsProvidersMBSTests.java @@ -0,0 +1,29 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.build.core.scannerconfig.tests; + +import org.eclipse.cdt.build.core.scannerconfig.tests.GCCBuiltinSpecsDetectorTest; + +import junit.framework.TestSuite; + +public class AllLanguageSettingsProvidersMBSTests extends TestSuite { + + public static TestSuite suite() { + return new AllLanguageSettingsProvidersMBSTests(); + } + + public AllLanguageSettingsProvidersMBSTests() { + super(AllLanguageSettingsProvidersMBSTests.class.getName()); + + addTestSuite(GCCBuiltinSpecsDetectorTest.class); + } +} diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/build/core/scannerconfig/tests/GCCBuiltinSpecsDetectorTest.java b/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/build/core/scannerconfig/tests/GCCBuiltinSpecsDetectorTest.java new file mode 100644 index 00000000000..da2257694e4 --- /dev/null +++ b/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/build/core/scannerconfig/tests/GCCBuiltinSpecsDetectorTest.java @@ -0,0 +1,410 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + package org.eclipse.cdt.build.core.scannerconfig.tests; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.dom.ast.gnu.c.GCCLanguage; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.managedbuilder.internal.scannerconfig.GCCBuiltinSpecsDetector; +import org.eclipse.cdt.managedbuilder.internal.scannerconfig.GCCBuiltinSpecsDetectorCygwin; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.Path; + +public class GCCBuiltinSpecsDetectorTest extends BaseTestCase { + private static final String LANGUAGE_ID_C = GCCLanguage.ID; + + class MockGCCBuiltinSpecsDetector extends GCCBuiltinSpecsDetector { + @Override + public void startupForLanguage(String languageId) throws CoreException { + super.startupForLanguage(languageId); + } + @Override + public void shutdownForLanguage() { + super.shutdownForLanguage(); + } + } + + class MockGCCBuiltinSpecsDetectorCygwin extends GCCBuiltinSpecsDetectorCygwin { + @Override + public void startupForLanguage(String languageId) throws CoreException { + super.startupForLanguage(languageId); + } + @Override + public void shutdownForLanguage() { + super.shutdownForLanguage(); + } + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + super.tearDown(); + } + + private ICConfigurationDescription[] getConfigurationDescriptions(IProject project) { + CoreModel coreModel = CoreModel.getDefault(); + ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager(); + // project description + ICProjectDescription projectDescription = mngr.getProjectDescription(project); + assertNotNull(projectDescription); + assertEquals(1, projectDescription.getConfigurations().length); + // configuration description + ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations(); + return cfgDescriptions; + } + + public void testGCCBuiltinSpecsDetector_ResolvedCommand() throws Exception { + class MockGCCBuiltinSpecsDetectorLocal extends GCCBuiltinSpecsDetector { + @Override + public String resolveCommand(String languageId) throws CoreException { + return super.resolveCommand(languageId); + } + } + { + MockGCCBuiltinSpecsDetectorLocal detector = new MockGCCBuiltinSpecsDetectorLocal(); + detector.setLanguageScope(new ArrayList() {{add(LANGUAGE_ID_C);}}); + detector.setCustomParameter("${COMMAND} -E -P -v -dD ${INPUTS}"); + + String resolvedCommand = detector.resolveCommand(LANGUAGE_ID_C); + assertTrue(resolvedCommand.startsWith("gcc -E -P -v -dD ")); + assertTrue(resolvedCommand.endsWith("spec.c")); + } + { + MockGCCBuiltinSpecsDetectorLocal detector = new MockGCCBuiltinSpecsDetectorLocal(); + detector.setLanguageScope(new ArrayList() {{add(LANGUAGE_ID_C);}}); + detector.setCustomParameter("${COMMAND} -E -P -v -dD file.${EXT}"); + + String resolvedCommand = detector.resolveCommand(LANGUAGE_ID_C); + assertTrue(resolvedCommand.startsWith("gcc -E -P -v -dD ")); + assertTrue(resolvedCommand.endsWith("file.c")); + } + } + + public void testGCCBuiltinSpecsDetector_Macro_NoValue() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO", null, ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_Simple() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO VALUE", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_Const() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO (3)", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO", "(3)", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_WhiteSpaces() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define \t MACRO_1 VALUE", null); + detector.processLine("#define MACRO_2 \t VALUE", null); + detector.processLine("#define MACRO_3 VALUE \t", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + int index = 0; + assertEquals(new CMacroEntry("MACRO_1", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CMacroEntry("MACRO_2", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CMacroEntry("MACRO_3", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(index, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_EmptyArgList() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO() VALUE", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO()", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_ParamUnused() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO(X) VALUE", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO(X)", "VALUE", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_ParamSpace() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO(P1, P2) VALUE(P1, P2)", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO(P1, P2)", "VALUE(P1, P2)", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_ArgsNoValue() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define MACRO(P1, P2) ", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CMacroEntry("MACRO(P1, P2)", null, ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Macro_Args_WhiteSpaces() throws Exception { + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#define \t MACRO_1(P1, P2) VALUE(P1, P2)", null); + detector.processLine("#define MACRO_2(P1, P2) \t VALUE(P1, P2)", null); + detector.processLine("#define MACRO_3(P1, P2) VALUE(P1, P2) \t", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + int index = 0; + assertEquals(new CMacroEntry("MACRO_1(P1, P2)", "VALUE(P1, P2)", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CMacroEntry("MACRO_2(P1, P2)", "VALUE(P1, P2)", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CMacroEntry("MACRO_3(P1, P2)", "VALUE(P1, P2)", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(index, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Includes() throws Exception { + // Create model project and folders to test + String projectName = getName(); + IProject project = ResourceHelper.createCDTProject(projectName); + IPath tmpPath = ResourceHelper.createTemporaryFolder(); + ResourceHelper.createFolder(project, "/misplaced/include1"); + ResourceHelper.createFolder(project, "/local/include"); + ResourceHelper.createFolder(project, "/usr/include"); + ResourceHelper.createFolder(project, "/usr/include2"); + ResourceHelper.createFolder(project, "/misplaced/include2"); + ResourceHelper.createFolder(project, "/System/Library/Frameworks"); + ResourceHelper.createFolder(project, "/Library/Frameworks"); + ResourceHelper.createFolder(project, "/misplaced/include3"); + String loc = tmpPath.toString(); + + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + detector.startup(null); + detector.startupForLanguage(null); + + detector.processLine(" "+loc+"/misplaced/include1", null); + detector.processLine("#include \"...\" search starts here:", null); + detector.processLine(" "+loc+"/local/include", null); + detector.processLine("#include <...> search starts here:", null); + detector.processLine(" "+loc+"/usr/include", null); + detector.processLine(" "+loc+"/usr/include/../include2", null); + detector.processLine(" "+loc+"/missing/folder", null); + detector.processLine(" "+loc+"/Library/Frameworks (framework directory)", null); + detector.processLine("End of search list.", null); + detector.processLine(" "+loc+"/misplaced/include2", null); + detector.processLine("Framework search starts here:", null); + detector.processLine(" "+loc+"/System/Library/Frameworks", null); + detector.processLine("End of framework search list.", null); + detector.processLine(" "+loc+"/misplaced/include3", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + int index = 0; + assertEquals(new CIncludePathEntry(loc+"/local/include", ICSettingEntry.LOCAL | ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/usr/include", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/usr/include2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/missing/folder", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/Library/Frameworks", ICSettingEntry.FRAMEWORKS_MAC | ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/System/Library/Frameworks", ICSettingEntry.FRAMEWORKS_MAC | ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(index, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Includes_WhiteSpaces() throws Exception { + String loc = ResourceHelper.createTemporaryFolder().toString(); + + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + detector.startup(null); + detector.startupForLanguage(null); + + detector.processLine("#include \"...\" search starts here:", null); + detector.processLine(" \t "+loc+"/local/include", null); + detector.processLine("#include <...> search starts here:", null); + detector.processLine(loc+"/usr/include", null); + detector.processLine(" "+loc+"/Library/Frameworks \t (framework directory)", null); + detector.processLine("End of search list.", null); + detector.processLine("Framework search starts here:", null); + detector.processLine(" "+loc+"/System/Library/Frameworks \t ", null); + detector.processLine("End of framework search list.", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + List entries = detector.getSettingEntries(null, null, null); + int index = 0; + assertEquals(new CIncludePathEntry(loc+"/local/include", ICSettingEntry.LOCAL | ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/usr/include", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/Library/Frameworks", ICSettingEntry.FRAMEWORKS_MAC | ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(new CIncludePathEntry(loc+"/System/Library/Frameworks", ICSettingEntry.FRAMEWORKS_MAC | ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(index++)); + assertEquals(index, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Includes_SymbolicLinkUp() throws Exception { + // do not test on systems where symbolic links are not supported + if (!ResourceHelper.isSymbolicLinkSupported()) + return; + + // Create model project and folders to test + String projectName = getName(); + @SuppressWarnings("unused") + IProject project = ResourceHelper.createCDTProject(projectName); + // create link on the filesystem + IPath dir1 = ResourceHelper.createTemporaryFolder(); + IPath dir2 = dir1.removeLastSegments(1); + IPath linkPath = dir1.append("linked"); + ResourceHelper.createSymbolicLink(linkPath, dir2); + + MockGCCBuiltinSpecsDetector detector = new MockGCCBuiltinSpecsDetector(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#include <...> search starts here:", null); + detector.processLine(" "+linkPath.toString()+"/..", null); + detector.processLine("End of search list.", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + // check populated entries + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CIncludePathEntry(dir2.removeLastSegments(1), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Cygwin_NoProject() throws Exception { + String windowsLocation; + String cygwinLocation = "/usr/include"; + try { + windowsLocation = ResourceHelper.cygwinToWindowsPath(cygwinLocation); + } catch (UnsupportedOperationException e) { + // Skip the test if Cygwin is not available. + return; + } + assertTrue("windowsLocation=["+windowsLocation+"]", new Path(windowsLocation).getDevice()!=null); + + MockGCCBuiltinSpecsDetectorCygwin detector = new MockGCCBuiltinSpecsDetectorCygwin(); + + detector.startup(null); + detector.startupForLanguage(null); + detector.processLine("#include <...> search starts here:", null); + detector.processLine(" /usr/include", null); + detector.processLine("End of search list.", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + // check populated entries + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CIncludePathEntry(new Path(windowsLocation), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + + public void testGCCBuiltinSpecsDetector_Cygwin_Configuration() throws Exception { + String windowsLocation; + String cygwinLocation = "/usr/include"; + try { + windowsLocation = ResourceHelper.cygwinToWindowsPath(cygwinLocation); + } catch (UnsupportedOperationException e) { + // Skip the test if Cygwin is not available. + return; + } + assertTrue("windowsLocation=["+windowsLocation+"]", new Path(windowsLocation).getDevice()!=null); + + // Create model project and folders to test + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + MockGCCBuiltinSpecsDetectorCygwin detector = new MockGCCBuiltinSpecsDetectorCygwin(); + + detector.startup(cfgDescription); + detector.startupForLanguage(null); + detector.processLine("#include <...> search starts here:", null); + detector.processLine(" /usr/include", null); + detector.processLine("End of search list.", null); + detector.shutdownForLanguage(); + detector.shutdown(); + + // check populated entries + List entries = detector.getSettingEntries(null, null, null); + assertEquals(new CIncludePathEntry(new Path(windowsLocation), ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), entries.get(0)); + assertEquals(1, entries.size()); + } + +} diff --git a/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/managedbuilder/core/tests/ManagedBuildDependencyCalculatorTests.java b/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/managedbuilder/core/tests/ManagedBuildDependencyCalculatorTests.java index 3ee59d21068..9b840d527a8 100644 --- a/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/managedbuilder/core/tests/ManagedBuildDependencyCalculatorTests.java +++ b/build/org.eclipse.cdt.managedbuilder.core.tests/tests/org/eclipse/cdt/managedbuilder/core/tests/ManagedBuildDependencyCalculatorTests.java @@ -239,4 +239,4 @@ public class ManagedBuildDependencyCalculatorTests extends TestCase { buildProjects(projects, makefiles); } -} \ No newline at end of file +} diff --git a/build/org.eclipse.cdt.managedbuilder.core/plugin.xml b/build/org.eclipse.cdt.managedbuilder.core/plugin.xml index a34109351c3..29e3713b30a 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/plugin.xml +++ b/build/org.eclipse.cdt.managedbuilder.core/plugin.xml @@ -308,13 +308,14 @@ + id="org.eclipse.cdt.build.core.prefbase.cfg" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;${Toolchain}" + name="%cfg1_base"> + + + + + + + + + + + + + + + + + + + + - The semi-colon separated list of the default error parsers to be used with this configuration. The list is ordered with the first error parser on the list invoked first, the second error parser second, and so on. The list may contain the error parsers defined by CDT and/or other installed error parser extensions. The list of error parsers to be used may be changed by the user on a per-configuration basis. When specified, this overrides the tool-chain errorParsers attribute. + The semi-colon separated list of the default error parsers to be used with this configuration. The list is ordered with the first error parser on the list invoked first, the second error parser second, and so on. The list may contain the error parsers defined by CDT and/or other installed error parser extensions. The list of error parsers to be used may be changed by the user on a per-configuration basis. When specified, this overrides the tool-chain errorParsers attribute. + + + + + + + Semicolon-separated list of providers ID implementing ILanguageSettingProvider interface. +This field could be amended with toolchain-level providers list by using ${Toolchain} keyword. Provider ID can be prefixed with "*", in this case shared instance of the provider defined on workspace level is used. Also provider ID can be prefixed with "-" which will cause id to be removed from the preceeding list including providers defined with ${Toolchain} keyword. +If this field is not specified, "*org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider" (MBS Language Settings Provider) is used by default. @@ -405,7 +414,15 @@ Specifying this attribute is fully equivalent to specifying the "org.eclips - The semi-colon separated list of the default error parsers to be used with this tool-chain. The list is ordered with the first error parser on the list invoked first, the second error parser second, and so on. The list may contain the error parsers defined by CDT and/or other installed error parser extensions. When specified, this overrides the tool errorParsers attributes of the tool children of the tool-chain and the builder child of the tool-chain. + The semi-colon separated list of the default error parsers to be used with this tool-chain. The list is ordered with the first error parser on the list invoked first, the second error parser second, and so on. The list may contain the error parsers defined by CDT and/or other installed error parser extensions. When specified, this overrides the tool errorParsers attributes of the tool children of the tool-chain and the builder child of the tool-chain. + + + + + + + Semicolon-separated list of providers ID implementing ILanguageSettingProvider interface. Provider ID can be prefixed with "*", in this case shared instance of the provider defined on workspace level is used. +This list could be adjusted on configuration level in the corresponding attribute. @@ -732,14 +749,14 @@ The pathConverter of a toolchain applies for all tools of the toolchain except i - Specifies whether this Tool represents a user-define custom build step. The default is false. When True, the default value of the commandLinePattern attribute changes to “$(command)”. + Specifies whether this Tool represents a user-define custom build step. The default is false. When True, the default value of the commandLinePattern attribute changes to “$(command)�. - Specifies a string that is written to the build output prior to each invocation of the tool. The default value is “Invoking tool-name (tool-id)…” + Specifies a string that is written to the build output prior to each invocation of the tool. The default value is “Invoking tool-name (tool-id)…� @@ -1066,7 +1083,7 @@ Overrides language id specified with the languageId attribute. - The id of the input type that is used in determining the build “rules” for the output type and for the default name of the output file. The default is the input type with primaryInput == true. + The id of the input type that is used in determining the build “rules� for the output type and for the default name of the output file. The default is the input type with primaryInput == true. @@ -1080,7 +1097,7 @@ Overrides language id specified with the languageId attribute. - Some tools produce files with a special prefix that must be specified. For example, a librarian on POSIX systems expects the output to be libtarget.a, so 'lib' would be the prefix. The default is to use the Tool “outputPrefix” attribute if primaryOutput is True, otherwise the default is an empty string. This attribute supports MBS configuration context macros. + Some tools produce files with a special prefix that must be specified. For example, a librarian on POSIX systems expects the output to be libtarget.a, so 'lib' would be the prefix. The default is to use the Tool “outputPrefix� attribute if primaryOutput is True, otherwise the default is an empty string. This attribute supports MBS configuration context macros. @@ -2035,11 +2052,11 @@ If the "buildPathResolver" attribute is specified, the "pathDelim Represents the applicability type for this enablement. Can contain the following values: -UI_VISIBILITY – the given enablement expression specifies whether the option is to be visible in UI, -UI_ENABLEMENT – the given enablement expression specifies the enable state of the controls that represent the option in UI, -CMD_USAGE – the given enablement expression specifies whether the option is to be used in command line +UI_VISIBILITY – the given enablement expression specifies whether the option is to be visible in UI, +UI_ENABLEMENT – the given enablement expression specifies the enable state of the controls that represent the option in UI, +CMD_USAGE – the given enablement expression specifies whether the option is to be used in command line CONTAINER_ATTRIBUTE - the given enablement expressions specifies thecontainer attribute value -ALL – this value means the combination of all the above values. +ALL – this value means the combination of all the above values. Several types could be specified simultaneously using the "|" as a delimiter, e.g.: type="UI_VISIBILITY|CMD_USAGE" @@ -2173,7 +2190,7 @@ Default value is true. - Specifies the expected value. If the current option value matches the value specified in this attribute, the checkOption element is treated as true, otherwise – as false. + Specifies the expected value. If the current option value matches the value specified in this attribute, the checkOption element is treated as true, otherwise – as false. The expected value could be specified either as a string that may contain build macros or as a regular expression. During the comparison, the build macros are resolved and the option value is checked to match the resulting string or regular expression. The way the expected value is specified and treated depends on the value of the isRegex attribute @@ -2188,14 +2205,14 @@ The expected value could be specified either as a string that may contain build - The id of the option which is to be compared with the option specified with the “optionId” attribute. The default is the id of the option that holds this expression. If the “value” attribute is specified, both the “otherOptionId” and the “otherHolderId” attributes are ignored. When searching for the option to be checked, MBS will examine all the options the holder contains along with all superclasses of each option to find the option with the specified id. + The id of the option which is to be compared with the option specified with the “optionId� attribute. The default is the id of the option that holds this expression. If the “value� attribute is specified, both the “otherOptionId� and the “otherHolderId� attributes are ignored. When searching for the option to be checked, MBS will examine all the options the holder contains along with all superclasses of each option to find the option with the specified id. - The option holder id that holds the option specified with the “otherOptionId” attribute. The default is the id of the holder that holds the container of this expression. If the “value” attribute is specified, both the “otherOptionId” and the “otherHolderId” attributes are ingnored. When searching for the needed holder, MBS will examine all the holders the current configuration contains along with all superclasses of each holder in order to find the holder with the specified id. + The option holder id that holds the option specified with the “otherOptionId� attribute. The default is the id of the holder that holds the container of this expression. If the “value� attribute is specified, both the “otherOptionId� and the “otherHolderId� attributes are ingnored. When searching for the needed holder, MBS will examine all the holders the current configuration contains along with all superclasses of each holder in order to find the holder with the specified id. @@ -2219,7 +2236,7 @@ The expected value could be specified either as a string that may contain build - Specifies the expected value. If the current string specified in the “string” attribute matches the value specified in this attribute, the checkString element is treated as true, otherwise – as false. + Specifies the expected value. If the current string specified in the “string� attribute matches the value specified in this attribute, the checkString element is treated as true, otherwise – as false. The expected value could be specified either as a string that might contain the build macros or as a regular expression. The way the value is specified and treated depends on the value of the isRegex attribute. diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigBuilder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigBuilder.java index e20b258eb67..d58dd7b3563 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigBuilder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigBuilder.java @@ -20,6 +20,7 @@ import org.eclipse.cdt.build.internal.core.scannerconfig2.CfgScannerConfigProfil import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.envvar.IEnvironmentVariable; import org.eclipse.cdt.core.envvar.IEnvironmentVariableManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.resources.ACBuilder; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; @@ -180,7 +181,11 @@ public class ScannerConfigBuilder extends ACBuilder { public static SCProfileInstance build(CfgInfoContext context, IScannerConfigBuilderInfo2 buildInfo2, int flags, Properties env, IProgressMonitor monitor) throws CoreException{ IConfiguration cfg = context.getConfiguration(); IProject project = cfg.getOwner().getProject(); - boolean autodiscoveryEnabled2 = buildInfo2.isAutoDiscoveryEnabled(); + boolean autodiscoveryEnabled2 = buildInfo2.isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + ICConfigurationDescription cfgDescription = ManagedBuildManager.getDescriptionForConfiguration(cfg); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } if (autodiscoveryEnabled2 || ((flags & FORCE_DISCOVERY) != 0)) { monitor.beginTask(MakeMessages.getString("ScannerConfigBuilder.Invoking_Builder"), 100); //$NON-NLS-1$ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/CfgScannerConfigUtil.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/CfgScannerConfigUtil.java index 6c27670a7b6..bc1bf490785 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/CfgScannerConfigUtil.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/CfgScannerConfigUtil.java @@ -159,7 +159,12 @@ public class CfgScannerConfigUtil { Set profiles = new TreeSet(); if (toolchain!=null) { - String toolchainProfileId = toolchain.getScannerConfigDiscoveryProfileId(); + String toolchainProfileId = null; + if (toolchain instanceof ToolChain) { + toolchainProfileId = ((ToolChain) toolchain).getLegacyScannerConfigDiscoveryProfileId(); + } else { + toolchainProfileId = toolchain.getScannerConfigDiscoveryProfileId(); + } if (toolchainProfileId!=null && toolchainProfileId.length()>0) { profiles.add(toolchainProfileId); } @@ -227,7 +232,7 @@ public class CfgScannerConfigUtil { Set profiles = new TreeSet(); - String attribute = ((InputType) inputType).getDiscoveryProfileIdAttribute(); + String attribute = ((InputType) inputType).getLegacyDiscoveryProfileIdAttribute(); if (attribute!=null) { // FIXME: temporary; we should add new method to IInputType instead of that for (String profileId : attribute.split("\\|")) { //$NON-NLS-1$ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig2/CfgScannerConfigInfoFactory2.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig2/CfgScannerConfigInfoFactory2.java index 1ef7c4dae84..11b95300b08 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig2/CfgScannerConfigInfoFactory2.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig2/CfgScannerConfigInfoFactory2.java @@ -19,6 +19,7 @@ import java.util.Map.Entry; import org.eclipse.cdt.build.core.scannerconfig.CfgInfoContext; import org.eclipse.cdt.build.core.scannerconfig.ICfgScannerConfigBuilderInfo2Set; import org.eclipse.cdt.build.internal.core.scannerconfig.CfgScannerConfigUtil; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescription; import org.eclipse.cdt.make.core.MakeCorePlugin; @@ -36,6 +37,7 @@ import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; import org.eclipse.cdt.managedbuilder.core.ManagedBuilderCorePlugin; import org.eclipse.cdt.managedbuilder.internal.core.Configuration; import org.eclipse.cdt.managedbuilder.internal.dataprovider.BuildConfigurationData; +import org.eclipse.core.resources.IProject; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.Preferences; import org.eclipse.core.runtime.QualifiedName; @@ -213,7 +215,12 @@ public class CfgScannerConfigInfoFactory2 { } } if (id == null) { - id = CfgScannerConfigUtil.getDefaultProfileId(context, true); + // Language Settings Providers are meant to replace legacy scanner discovery + // so do not try to find default profile + IProject project = cfg.getOwner().getProject(); + if (!ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(project)) { + id = CfgScannerConfigUtil.getDefaultProfileId(context, true); + } } InfoContext baseContext = context.toInfoContext(); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ExternalBuildRunner.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ExternalBuildRunner.java index 42940a74288..36e2fb59281 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ExternalBuildRunner.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ExternalBuildRunner.java @@ -25,15 +25,22 @@ import org.eclipse.cdt.build.core.scannerconfig.ICfgScannerConfigBuilderInfo2Set import org.eclipse.cdt.build.internal.core.scannerconfig2.CfgScannerConfigProfileManager; import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.ErrorParserManager; +import org.eclipse.cdt.core.ICConsoleParser; import org.eclipse.cdt.core.ICommandLauncher; +import org.eclipse.cdt.core.IConsoleParser; import org.eclipse.cdt.core.IMarkerGenerator; import org.eclipse.cdt.core.envvar.IEnvironmentVariable; import org.eclipse.cdt.core.envvar.IEnvironmentVariableManager; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.ICModelMarker; import org.eclipse.cdt.core.resources.IConsole; import org.eclipse.cdt.core.resources.RefreshScopeManager; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; import org.eclipse.cdt.internal.core.ConsoleOutputSniffer; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; import org.eclipse.cdt.make.core.scannerconfig.IScannerConfigBuilderInfo2; import org.eclipse.cdt.make.core.scannerconfig.IScannerInfoCollector; import org.eclipse.cdt.make.core.scannerconfig.IScannerInfoConsoleParser; @@ -114,6 +121,18 @@ public class ExternalBuildRunner extends AbstractBuildRunner { break; } + URI workingDirectoryURI = ManagedBuildManager.getBuildLocationURI(configuration, builder); + final String pathFromURI = EFSExtensionManager.getDefault().getPathFromURI(workingDirectoryURI); + if(pathFromURI == null) { + throw new CoreException(new Status(IStatus.ERROR, ManagedBuilderCorePlugin.PLUGIN_ID, ManagedMakeMessages.getString("ManagedMakeBuilder.message.error"), null)); //$NON-NLS-1$ + } + + IPath workingDirectory = new Path(pathFromURI); + + // Set the environment + Map envMap = getEnvironment(builder); + String[] env = getEnvStrings(envMap); + consoleHeader[1] = configuration.getName(); consoleHeader[2] = project.getName(); buf.append(NEWLINE); @@ -135,14 +154,6 @@ public class ExternalBuildRunner extends AbstractBuildRunner { if (markers != null) workspace.deleteMarkers(markers); - URI workingDirectoryURI = ManagedBuildManager.getBuildLocationURI(configuration, builder); - final String pathFromURI = EFSExtensionManager.getDefault().getPathFromURI(workingDirectoryURI); - if(pathFromURI == null) { - throw new CoreException(new Status(IStatus.ERROR, ManagedBuilderCorePlugin.PLUGIN_ID, ManagedMakeMessages.getString("ManagedMakeBuilder.message.error"), null)); //$NON-NLS-1$ - } - - IPath workingDirectory = new Path(pathFromURI); - String[] targets = getTargets(kind, builder); if (targets.length != 0 && targets[targets.length - 1].equals(builder.getCleanBuildTarget())) isClean = true; @@ -153,9 +164,6 @@ public class ExternalBuildRunner extends AbstractBuildRunner { // Print the command for visual interaction. launcher.showCommand(true); - // Set the environment - Map envMap = getEnvironment(builder); - String[] env = getEnvStrings(envMap); String[] buildArguments = targets; String[] newArgs = CommandLineUtil.argumentsToArray(builder.getBuildArguments()); @@ -175,9 +183,15 @@ public class ExternalBuildRunner extends AbstractBuildRunner { OutputStream stderr = streamMon; // Sniff console output for scanner info - ConsoleOutputSniffer sniffer = createBuildOutputSniffer(stdout, stderr, project, configuration, workingDirectory, markerGenerator, null); - OutputStream consoleOut = (sniffer == null ? stdout : sniffer.getOutputStream()); - OutputStream consoleErr = (sniffer == null ? stderr : sniffer.getErrorStream()); + OutputStream consoleOut = stdout; + OutputStream consoleErr = stderr; + if (kind!=IncrementalProjectBuilder.CLEAN_BUILD) { + ConsoleOutputSniffer sniffer = createBuildOutputSniffer(stdout, stderr, project, configuration, workingDirectory, markerGenerator, null, epm); + if (sniffer!=null) { + consoleOut = sniffer.getOutputStream(); + consoleErr = sniffer.getErrorStream(); + } + } Process p = launcher.execute(buildCommand, buildArguments, env, workingDirectory, monitor); if (p != null) { try { @@ -337,10 +351,11 @@ public class ExternalBuildRunner extends AbstractBuildRunner { IConfiguration cfg, IPath workingDirectory, IMarkerGenerator markerGenerator, - IScannerInfoCollector collector){ + IScannerInfoCollector collector, + ErrorParserManager epm){ ICfgScannerConfigBuilderInfo2Set container = CfgScannerConfigProfileManager.getCfgScannerConfigBuildInfo(cfg); Map map = container.getInfoMap(); - List clParserList = new ArrayList(); + List clParserList = new ArrayList(); if(container.isPerRcTypeDiscovery()){ for (IResourceInfo rcInfo : cfg.getResourceInfos()) { @@ -370,9 +385,25 @@ public class ExternalBuildRunner extends AbstractBuildRunner { contributeToConsoleParserList(project, map, new CfgInfoContext(cfg), workingDirectory, markerGenerator, collector, clParserList); } + ICConfigurationDescription cfgDescription = ManagedBuildManager.getDescriptionForConfiguration(cfg); + List lsProviders = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider lsProvider : lsProviders) { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(lsProvider); + if (rawProvider instanceof ICConsoleParser) { + ICConsoleParser consoleParser = (ICConsoleParser) rawProvider; + try { + consoleParser.startup(cfgDescription); + clParserList.add(consoleParser); + } catch (CoreException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + } + if(clParserList.size() != 0){ - return new ConsoleOutputSniffer(outputStream, errorStream, - clParserList.toArray(new IScannerInfoConsoleParser[clParserList.size()])); + IConsoleParser[] parsers = clParserList.toArray(new IConsoleParser[clParserList.size()]); + return new ConsoleOutputSniffer(outputStream, errorStream, parsers, epm); } return null; @@ -385,36 +416,41 @@ public class ExternalBuildRunner extends AbstractBuildRunner { IPath workingDirectory, IMarkerGenerator markerGenerator, IScannerInfoCollector collector, - List parserList){ + List parserList){ IScannerConfigBuilderInfo2 info = map.get(context); InfoContext ic = context.toInfoContext(); boolean added = false; - if (info != null && - info.isAutoDiscoveryEnabled() && - info.isBuildOutputParserEnabled()) { + if (info != null) { + boolean autodiscoveryEnabled2 = info.isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + IConfiguration cfg = context.getConfiguration(); + ICConfigurationDescription cfgDescription = ManagedBuildManager.getDescriptionForConfiguration(cfg); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } + if (autodiscoveryEnabled2 && info.isBuildOutputParserEnabled()) { - String id = info.getSelectedProfileId(); - ScannerConfigProfile profile = ScannerConfigProfileManager.getInstance().getSCProfileConfiguration(id); - if(profile.getBuildOutputProviderElement() != null){ - // get the make builder console parser - SCProfileInstance profileInstance = ScannerConfigProfileManager.getInstance(). - getSCProfileInstance(project, ic, id); + String id = info.getSelectedProfileId(); + ScannerConfigProfile profile = ScannerConfigProfileManager.getInstance().getSCProfileConfiguration(id); + if(profile.getBuildOutputProviderElement() != null){ + // get the make builder console parser + SCProfileInstance profileInstance = ScannerConfigProfileManager.getInstance(). + getSCProfileInstance(project, ic, id); - IScannerInfoConsoleParser clParser = profileInstance.createBuildOutputParser(); - if (collector == null) { - collector = profileInstance.getScannerInfoCollector(); - } - if(clParser != null){ - clParser.startup(project, workingDirectory, collector, - info.isProblemReportingEnabled() ? markerGenerator : null); - parserList.add(clParser); - added = true; - } + IScannerInfoConsoleParser clParser = profileInstance.createBuildOutputParser(); + if (collector == null) { + collector = profileInstance.getScannerInfoCollector(); + } + if(clParser != null){ + clParser.startup(project, workingDirectory, collector, + info.isProblemReportingEnabled() ? markerGenerator : null); + parserList.add(clParser); + added = true; + } + } } } return added; } - } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java index 8b7f0499dce..3ab54cf1ec7 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java @@ -46,6 +46,7 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont // Schema element names public static final String CONFIGURATION_ELEMENT_NAME = "configuration"; //$NON-NLS-1$ public static final String ERROR_PARSERS = "errorParsers"; //$NON-NLS-1$ + public static final String LANGUAGE_SETTINGS_PROVIDERS = "languageSettingsProviders"; public static final String EXTENSION = "artifactExtension"; //$NON-NLS-1$ public static final String PARENT = "parent"; //$NON-NLS-1$ @@ -170,6 +171,8 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont */ public String[] getErrorParserList(); + public String getDefaultLanguageSettingsProvidersIds(); + /** * Projects have C or CC natures. Tools can specify a filter so they are not * misapplied to a project. This method allows the caller to retrieve a list diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java index 57cba447fca..34a1a4331b7 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java @@ -53,6 +53,8 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { // The attribute name for the scanner info collector public static final String SCANNER_CONFIG_PROFILE_ID = "scannerConfigDiscoveryProfileId"; //$NON-NLS-1$ + public static final String LANGUAGE_SETTINGS_PROVIDERS = "languageSettingsProviders"; + /** * Returns the configuration that is the parent of this tool-chain. * @@ -261,6 +263,13 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { */ public void setErrorParserIds(String ids); + /** + * Returns the default language settings providers IDs. + * + * @return the default language settings providers IDs separated by semicolon or {@code null} if none. + */ + public String getDefaultLanguageSettingsProvidersIds(); + /** * Returns the scanner config discovery profile id or null if none. * diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/InternalBuildRunner.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/InternalBuildRunner.java index f50ce9993aa..0efc2b6724f 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/InternalBuildRunner.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/InternalBuildRunner.java @@ -13,14 +13,25 @@ package org.eclipse.cdt.managedbuilder.core; import java.io.IOException; import java.io.OutputStream; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.ConsoleOutputStream; import org.eclipse.cdt.core.ErrorParserManager; import org.eclipse.cdt.core.IMarkerGenerator; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.model.ICModelMarker; import org.eclipse.cdt.core.resources.IConsole; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuildCommandParser; import org.eclipse.cdt.managedbuilder.buildmodel.BuildDescriptionManager; import org.eclipse.cdt.managedbuilder.buildmodel.IBuildDescription; +import org.eclipse.cdt.managedbuilder.internal.buildmodel.BuildDescription; import org.eclipse.cdt.managedbuilder.internal.buildmodel.BuildStateManager; import org.eclipse.cdt.managedbuilder.internal.buildmodel.DescriptionBuilder; import org.eclipse.cdt.managedbuilder.internal.buildmodel.IBuildModelBuilder; @@ -35,6 +46,7 @@ import org.eclipse.core.resources.IResourceDelta; import org.eclipse.core.resources.IWorkspace; import org.eclipse.core.resources.IncrementalProjectBuilder; import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.NullProgressMonitor; @@ -61,6 +73,21 @@ public class InternalBuildRunner extends AbstractBuildRunner { private static final String NOTHING_BUILT = "ManagedMakeBuilder.message.no.build"; //$NON-NLS-1$ private static final String BUILD_ERROR = "ManagedMakeBuilder.message.error"; //$NON-NLS-1$ + + // TODO: same function is present in CommandBuilder and BuildProcessManager + private String[] mapToStringArray(Map map){ + if(map == null) + return null; + + List list = new ArrayList(); + + for (Entry entry : map.entrySet()) { + list.add(entry.getKey() + '=' + entry.getValue()); + } + + return list.toArray(new String[list.size()]); + } + @Override public boolean invokeBuild(int kind, IProject project, IConfiguration configuration, IBuilder builder, IConsole console, IMarkerGenerator markerGenerator, @@ -96,6 +123,16 @@ public class InternalBuildRunner extends AbstractBuildRunner { // Get a build console for the project StringBuffer buf = new StringBuffer(); + + IBuildDescription des = BuildDescriptionManager.createBuildDescription(configuration, cBS, delta, flags); + + IPath workingDirectory = des.getDefaultBuildDirLocation(); + String[] env = null; + if (des instanceof BuildDescription) { + Map envMap = ((BuildDescription)des).getEnvironment(); + env = mapToStringArray(envMap); + } + consoleOutStream = console.getOutputStream(); String[] consoleHeader = new String[3]; if(buildIncrementaly) @@ -119,11 +156,27 @@ public class InternalBuildRunner extends AbstractBuildRunner { buf.append(System.getProperty("line.separator", "\n")); //$NON-NLS-1$ //$NON-NLS-2$ buf.append(System.getProperty("line.separator", "\n")); //$NON-NLS-1$ //$NON-NLS-2$ } + + if (kind!=IncrementalProjectBuilder.CLEAN_BUILD) { + // TODO - AG - sanity check? elaborate + ICConfigurationDescription cfgDescription = ManagedBuildManager.getDescriptionForConfiguration(configuration); + List providers = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider provider : providers) { + if (provider instanceof AbstractBuildCommandParser) { + buf.append(System.getProperty("line.separator", "\n")); //$NON-NLS-1$ //$NON-NLS-2$ + String msg = ManagedMakeMessages.getFormattedString("BOP Language Settings Provider [{0}] is not supported by Internal Builder.", provider.getName()); + buf.append("**** "+msg+" ****"); + buf.append(System.getProperty("line.separator", "\n")); //$NON-NLS-1$ //$NON-NLS-2$ + buf.append(System.getProperty("line.separator", "\n")); //$NON-NLS-1$ //$NON-NLS-2$ + + ManagedBuilderCorePlugin.error(msg); + } + } + } + consoleOutStream.write(buf.toString().getBytes()); consoleOutStream.flush(); - IBuildDescription des = BuildDescriptionManager.createBuildDescription(configuration, cBS, delta, flags); - DescriptionBuilder dBuilder = null; if (!isParallel) dBuilder = new DescriptionBuilder(des, buildIncrementaly, resumeOnErr, cBS); @@ -192,6 +245,7 @@ public class InternalBuildRunner extends AbstractBuildRunner { consoleOutStream.flush(); epmOutputStream.close(); epmOutputStream = null; + // Generate any error markers that the build has discovered monitor.subTask(ManagedMakeMessages.getResourceString(MARKERS)); @@ -238,5 +292,4 @@ public class InternalBuildRunner extends AbstractBuildRunner { } return false; } - } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java index 7c3d89a5367..345492d08f3 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java @@ -49,6 +49,9 @@ import javax.xml.transform.stream.StreamResult; import org.eclipse.cdt.core.AbstractCExtension; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager_TBD; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.model.CoreModelUtil; import org.eclipse.cdt.core.parser.IScannerInfo; @@ -149,6 +152,7 @@ import org.w3c.dom.ProcessingInstruction; */ public class ManagedBuildManager extends AbstractCExtension { + public static final String MBS_LANGUAGE_SETTINGS_PROVIDER = "org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider"; // private static final QualifiedName buildInfoProperty = new QualifiedName(ManagedBuilderCorePlugin.PLUGIN_ID, "managedBuildInfo"); //$NON-NLS-1$ private static final String ROOT_NODE_NAME = "ManagedProjectBuildInfo"; //$NON-NLS-1$ public static final String SETTINGS_FILE_NAME = ".cdtbuild"; //$NON-NLS-1$ @@ -4721,4 +4725,86 @@ public class ManagedBuildManager extends AbstractCExtension { return true; // no target platform - nothing to check. } + private static String getLanguageSettingsProvidersStr(IToolChain toolchain) { + for (;toolchain!=null;toolchain=toolchain.getSuperClass()) { + String providersIdsStr = toolchain.getDefaultLanguageSettingsProvidersIds(); + if (providersIdsStr!=null) { + return providersIdsStr; + } + } + return ""; + } + + private static String getLanguageSettingsProvidersStr(IConfiguration cfg) { + for (;cfg!=null;cfg=cfg.getParent()) { + String providersIdsStr = cfg.getDefaultLanguageSettingsProvidersIds(); + if (providersIdsStr!=null) { + return providersIdsStr; + } + } + return ""; + } + + public static List getLanguageSettingsProviders(IConfiguration cfg) { + List providers = new ArrayList(); + + String providersIdsStr = getLanguageSettingsProvidersStr(cfg); + if (providersIdsStr!=null) { + if (providersIdsStr.contains("${Toolchain}")) { + IToolChain toolchain = cfg.getToolChain(); + String toolchainProvidersIds = getLanguageSettingsProvidersStr(toolchain); + if (toolchainProvidersIds==null) { + toolchainProvidersIds=""; + } + providersIdsStr = providersIdsStr.replaceAll("\\$\\{Toolchain\\}", toolchainProvidersIds); + } + List providersIds = Arrays.asList(providersIdsStr.split(String.valueOf(LanguageSettingsManager_TBD.PROVIDER_DELIMITER))); + for (String id : providersIds) { + id = id.trim(); + ILanguageSettingsProvider provider = null; + if (id.startsWith("*")) { + id = id.substring(1); + provider = LanguageSettingsManager.getWorkspaceProvider(id); + } else if (id.startsWith("-")) { + id = id.substring(1); + for (ILanguageSettingsProvider pr : providers) { + if (pr.getId().equals(id)) { + providers.remove(pr); + // Has to break as the collection is invalidated + // TODO: remove all elements or better use unique list + break; + } + } + } else if (id.length()>0){ + provider = LanguageSettingsManager.getExtensionProviderCopy(id); + } + if (provider!=null) { + providers.add(provider); + } + } + } + + if (providers.isEmpty()) { + // Add MBS provider for unsuspecting toolchains (backward compatibility) + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(MBS_LANGUAGE_SETTINGS_PROVIDER); + providers.add(provider); + } + + if (!isProviderThere(providers, LanguageSettingsManager_TBD.PROVIDER_UI_USER)) { + ILanguageSettingsProvider provider = LanguageSettingsManager.getExtensionProviderCopy(LanguageSettingsManager_TBD.PROVIDER_UI_USER); + providers.add(0, provider); + } + + return providers; + } + + private static boolean isProviderThere(List providers, String id) { + for (ILanguageSettingsProvider provider : providers) { + if (provider.getId().equals(id)) { + return true; + } + } + return false; + } + } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java index e1f9d58adae..3142d88b458 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java @@ -26,6 +26,8 @@ import java.util.Set; import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.ConsoleOutputStream; import org.eclipse.cdt.core.ProblemMarkerInfo; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager_TBD; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.resources.ACBuilder; import org.eclipse.cdt.core.resources.IConsole; @@ -145,6 +147,7 @@ public class CommonBuilder extends ACBuilder { private final IConfiguration fCfg; private final IBuilder fBuilder; private IConsole fConsole; + CfgBuildInfo(IBuilder builder, boolean isForegound){ this.fBuilder = builder; this.fCfg = builder.getParent().getParent(); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Configuration.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Configuration.java index 011aa7ccbe4..d5ce4df6687 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Configuration.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Configuration.java @@ -105,6 +105,7 @@ public class Configuration extends BuildObject implements IConfiguration, IBuild private String cleanCommand; private String artifactExtension; private String errorParserIds; + private String defaultLanguageSettingsProvidersIds; private String prebuildStep; private String postbuildStep; private String preannouncebuildStep; @@ -784,6 +785,9 @@ public class Configuration extends BuildObject implements IConfiguration, IBuild // Get the semicolon separated list of IDs of the error parsers errorParserIds = SafeStringInterner.safeIntern(element.getAttribute(ERROR_PARSERS)); + // Get the initial/default language setttings providers IDs + defaultLanguageSettingsProvidersIds = SafeStringInterner.safeIntern(element.getAttribute(LANGUAGE_SETTINGS_PROVIDERS)); + // Get the artifact extension artifactExtension = SafeStringInterner.safeIntern(element.getAttribute(EXTENSION)); @@ -1456,6 +1460,10 @@ public class Configuration extends BuildObject implements IConfiguration, IBuild return set; } + public String getDefaultLanguageSettingsProvidersIds() { + return defaultLanguageSettingsProvidersIds; + } + /* (non-Javadoc) * @see org.eclipse.cdt.managedbuilder.core.IConfiguration#setArtifactExtension(java.lang.String) */ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/InputType.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/InputType.java index 7932e7b2f39..a706a2d0b00 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/InputType.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/InputType.java @@ -17,6 +17,7 @@ import java.util.List; import java.util.StringTokenizer; import java.util.Vector; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.ILanguage; import org.eclipse.cdt.core.model.LanguageManager; import org.eclipse.cdt.core.settings.model.ICStorageElement; @@ -24,6 +25,7 @@ import org.eclipse.cdt.core.settings.model.util.CDataUtil; import org.eclipse.cdt.internal.core.SafeStringInterner; import org.eclipse.cdt.managedbuilder.core.IAdditionalInput; import org.eclipse.cdt.managedbuilder.core.IBuildObject; +import org.eclipse.cdt.managedbuilder.core.IConfiguration; import org.eclipse.cdt.managedbuilder.core.IFileInfo; import org.eclipse.cdt.managedbuilder.core.IInputOrder; import org.eclipse.cdt.managedbuilder.core.IInputType; @@ -37,6 +39,7 @@ import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; import org.eclipse.cdt.managedbuilder.internal.enablement.OptionEnablementExpression; import org.eclipse.cdt.managedbuilder.makegen.IManagedDependencyGeneratorType; import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IConfigurationElement; import org.eclipse.core.runtime.IPath; @@ -1838,9 +1841,56 @@ public class InputType extends BuildObject implements IInputType { return id; } + /** + * Temporary method to support compatibility during SD transition. + */ + private boolean isLanguageSettingsProvidersFunctionalityEnabled() { + boolean isLanguageSettingsProvidersEnabled = false; + ITool tool = getParent(); + if (tool!=null) { + IBuildObject bo = tool.getParent(); + if (bo instanceof IToolChain) { + IConfiguration cfg = ((IToolChain) bo).getParent(); + if (cfg!=null) { + IResource rc = cfg.getOwner(); + if (rc!=null) { + IProject project = rc.getProject(); + isLanguageSettingsProvidersEnabled = ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(project); + } + } + } + } + return isLanguageSettingsProvidersEnabled; + } + + /** + * Temporary method to support compatibility during SD transition. + * @noreference This method is not intended to be referenced by clients. + */ + public String getLegacyDiscoveryProfileIdAttribute(){ + String profileId = buildInfoDicsoveryProfileId; + if (profileId == null) { + profileId = ScannerDiscoveryLegacySupport.getDeprecatedLegacyProfiles(id); + if (profileId == null && superClass instanceof InputType) { + profileId = ((InputType)superClass).getLegacyDiscoveryProfileIdAttribute(); + } + } + return profileId; + } + public String getDiscoveryProfileIdAttribute(){ - if(buildInfoDicsoveryProfileId == null && superClass != null) - return ((InputType)superClass).getDiscoveryProfileIdAttribute(); + if (!isLanguageSettingsProvidersFunctionalityEnabled()) + return getLegacyDiscoveryProfileIdAttribute(); + + return getDiscoveryProfileIdAttributeInternal(); + } + + /** + * Method extracted temporarily to support compatibility during SD transition. + */ + private String getDiscoveryProfileIdAttributeInternal(){ + if(buildInfoDicsoveryProfileId == null && superClass instanceof InputType) + return ((InputType)superClass).getDiscoveryProfileIdAttributeInternal(); return buildInfoDicsoveryProfileId; } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/MultiConfiguration.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/MultiConfiguration.java index 0b1f6c233e5..c3e3fc4c404 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/MultiConfiguration.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/MultiConfiguration.java @@ -440,6 +440,11 @@ public class MultiConfiguration extends MultiItemsHolder implements return s; } + public String getDefaultLanguageSettingsProvidersIds() { + ManagedBuilderCorePlugin.error("Default Language Settings Providers are not supported in multiconfiguration mode"); + return null; + } + /* (non-Javadoc) * @see org.eclipse.cdt.managedbuilder.core.IConfiguration#getFilteredTools() */ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ToolChain.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ToolChain.java index 97201a4e605..83fddb4c70c 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ToolChain.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ToolChain.java @@ -24,6 +24,7 @@ import java.util.SortedMap; import java.util.StringTokenizer; import org.eclipse.cdt.build.internal.core.scannerconfig.CfgDiscoveredPathManager.PathInfoCache; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.settings.model.ICStorageElement; import org.eclipse.cdt.core.settings.model.extension.CTargetPlatformData; import org.eclipse.cdt.core.settings.model.util.CDataUtil; @@ -50,6 +51,8 @@ import org.eclipse.cdt.managedbuilder.envvar.IConfigurationEnvironmentVariableSu import org.eclipse.cdt.managedbuilder.internal.dataprovider.ConfigurationDataProvider; import org.eclipse.cdt.managedbuilder.internal.enablement.OptionEnablementExpression; import org.eclipse.cdt.managedbuilder.macros.IConfigurationBuildMacroSupplier; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IConfigurationElement; import org.eclipse.core.runtime.IExtension; @@ -85,6 +88,7 @@ public class ToolChain extends HoldsOptions implements IToolChain, IMatchKeyProv private String targetToolIds; private String secondaryOutputIds; private Boolean isAbstract; + private String defaultLanguageSettingsProvidersIds; private String scannerConfigDiscoveryProfileId; private String versionsSupported; private String convertToId; @@ -554,6 +558,9 @@ public class ToolChain extends HoldsOptions implements IToolChain, IMatchKeyProv // Get the target tool id targetToolIds = SafeStringInterner.safeIntern(element.getAttribute(TARGET_TOOL)); + // Get the initial/default language setttings providers IDs + defaultLanguageSettingsProvidersIds = element.getAttribute(LANGUAGE_SETTINGS_PROVIDERS); + // Get the scanner config discovery profile id scannerConfigDiscoveryProfileId = SafeStringInterner.safeIntern(element.getAttribute(SCANNER_CONFIG_PROFILE_ID)); String tmp = element.getAttribute(RESOURCE_TYPE_BASED_DISCOVERY); @@ -1529,19 +1536,68 @@ public class ToolChain extends HoldsOptions implements IToolChain, IMatchKeyProv setDirty(true); } - /* (non-Javadoc) - * @see org.eclipse.cdt.managedbuilder.core.IToolChain#getScannerConfigDiscoveryProfileId() - */ - @Override - public String getScannerConfigDiscoveryProfileId() { - if (scannerConfigDiscoveryProfileId == null) { - if (getSuperClass() != null) { - return getSuperClass().getScannerConfigDiscoveryProfileId(); - } - } - return scannerConfigDiscoveryProfileId; - } + @Override + public String getDefaultLanguageSettingsProvidersIds() { + return defaultLanguageSettingsProvidersIds; + } + /** + * Temporary method to support compatibility during SD transition. + */ + private boolean isLanguageSettingsProvidersFunctionalityEnabled() { + boolean isLanguageSettingsProvidersEnabled = false; + IConfiguration cfg = getParent(); + if (cfg!=null) { + IResource rc = cfg.getOwner(); + if (rc!=null) { + IProject project = rc.getProject(); + isLanguageSettingsProvidersEnabled = ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(project); + } + } + return isLanguageSettingsProvidersEnabled; + } + + /** + * Temporary method to support compatibility during SD transition. + * @noreference This method is not intended to be referenced by clients. + */ + public String getLegacyScannerConfigDiscoveryProfileId() { + String profileId = scannerConfigDiscoveryProfileId; + if (profileId==null) { + profileId = ScannerDiscoveryLegacySupport.getDeprecatedLegacyProfiles(id); + if (profileId == null) { + IToolChain superClass = getSuperClass(); + if (superClass instanceof ToolChain) { + profileId = ((ToolChain) superClass).getLegacyScannerConfigDiscoveryProfileId(); + } + } + } + return profileId; + } + + /* + * (non-Javadoc) + * + * @see org.eclipse.cdt.managedbuilder.core.IToolChain#getScannerConfigDiscoveryProfileId() + */ + @Override + public String getScannerConfigDiscoveryProfileId() { + if (!isLanguageSettingsProvidersFunctionalityEnabled()) + return getLegacyScannerConfigDiscoveryProfileId(); + + return getScannerConfigDiscoveryProfileIdInternal(); + } + + /** + * Method extracted temporarily to support compatibility during SD transition. + */ + private String getScannerConfigDiscoveryProfileIdInternal() { + if (scannerConfigDiscoveryProfileId == null && superClass instanceof ToolChain) { + return ((ToolChain) getSuperClass()).getScannerConfigDiscoveryProfileIdInternal(); + } + return scannerConfigDiscoveryProfileId; + } + /* (non-Javadoc) * @see org.eclipse.cdt.managedbuilder.core.IToolChain#setScannerConfigDiscoveryProfileId(java.lang.String) */ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/GCCBuiltinSpecsDetector.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/GCCBuiltinSpecsDetector.java new file mode 100644 index 00000000000..0fe79bb509f --- /dev/null +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/GCCBuiltinSpecsDetector.java @@ -0,0 +1,127 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.managedbuilder.internal.scannerconfig; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.managedbuilder.scannerconfig.ToolchainBuiltinSpecsDetector; +import org.eclipse.core.runtime.CoreException; + +/** + * Class to detect built-in compiler settings. Note that currently this class is hardwired + * to GCC toolchain {@code cdt.managedbuild.toolchain.gnu.base}. + * + */ +public class GCCBuiltinSpecsDetector extends ToolchainBuiltinSpecsDetector implements ILanguageSettingsEditableProvider { + // ID must match the toolchain definition in org.eclipse.cdt.managedbuilder.core.buildDefinitions extension point + private static final String GCC_TOOLCHAIN_ID = "cdt.managedbuild.toolchain.gnu.base"; //$NON-NLS-1$ + + private enum State {NONE, EXPECTING_LOCAL_INCLUDE, EXPECTING_SYSTEM_INCLUDE, EXPECTING_FRAMEWORKS} + private State state = State.NONE; + + @SuppressWarnings("nls") + private static final AbstractOptionParser[] optionParsers = { + new IncludePathOptionParser("#include \"(\\S.*)\"", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY | ICSettingEntry.LOCAL), + new IncludePathOptionParser("#include <(\\S.*)>", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new IncludePathOptionParser("#framework <(\\S.*)>", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY | ICSettingEntry.FRAMEWORKS_MAC), + new MacroOptionParser("#define\\s+(\\S*\\(.*?\\))\\s*(.*)", "$1", "$2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("#define\\s+(\\S*)\\s*(\\S*)", "$1", "$2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + }; + + @Override + protected String getToolchainId() { + return GCC_TOOLCHAIN_ID; + } + + @Override + protected AbstractOptionParser[] getOptionParsers() { + return optionParsers; + } + + private List makeList(final String line) { + return new ArrayList() {{ add(line); }}; + } + + @Override + protected List parseForOptions(String line) { + line = line.trim(); + + // contribution of -dD option + if (line.startsWith("#define")) { + return makeList(line); + } + + // contribution of includes + if (line.equals("#include \"...\" search starts here:")) { + state = State.EXPECTING_LOCAL_INCLUDE; + } else if (line.equals("#include <...> search starts here:")) { + state = State.EXPECTING_SYSTEM_INCLUDE; + } else if (line.startsWith("End of search list.")) { + state = State.NONE; + } else if (line.equals("Framework search starts here:")) { + state = State.EXPECTING_FRAMEWORKS; + } else if (line.startsWith("End of framework search list.")) { + state = State.NONE; + } else if (state==State.EXPECTING_LOCAL_INCLUDE) { + // making that up for the parser to figure out + line = "#include \""+line+"\""; + return makeList(line); + } else { + String frameworkIndicator = "(framework directory)"; + if (state==State.EXPECTING_SYSTEM_INCLUDE) { + // making that up for the parser to figure out + if (line.contains(frameworkIndicator)) { + line = "#framework <"+line.replace(frameworkIndicator, "").trim()+">"; + } else { + line = "#include <"+line+">"; + } + return makeList(line); + } else if (state==State.EXPECTING_FRAMEWORKS) { + // making that up for the parser to figure out + line = "#framework <"+line.replace(frameworkIndicator, "").trim()+">"; + return makeList(line); + } + } + + return null; + } + + @Override + public void startup(ICConfigurationDescription cfgDescription) throws CoreException { + super.startup(cfgDescription); + + state = State.NONE; + } + + @Override + public void shutdown() { + state = State.NONE; + + super.shutdown(); + } + + @Override + public GCCBuiltinSpecsDetector cloneShallow() throws CloneNotSupportedException { + return (GCCBuiltinSpecsDetector) super.cloneShallow(); + } + + @Override + public GCCBuiltinSpecsDetector clone() throws CloneNotSupportedException { + return (GCCBuiltinSpecsDetector) super.clone(); + } + + +} diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/GCCBuiltinSpecsDetectorCygwin.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/GCCBuiltinSpecsDetectorCygwin.java new file mode 100644 index 00000000000..64389f7a5b3 --- /dev/null +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/GCCBuiltinSpecsDetectorCygwin.java @@ -0,0 +1,81 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.managedbuilder.internal.scannerconfig; + +import java.net.URI; +import java.net.URISyntaxException; + +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.core.resources.IResource; + +/** + * Class to detect built-in compiler settings. + * The paths are converted to cygwin "filesystem" representation. Then + * + */ +public class GCCBuiltinSpecsDetectorCygwin extends GCCBuiltinSpecsDetector { + private static final URI CYGWIN_ROOT; + static { + try { + CYGWIN_ROOT = new URI("cygwin:/"); //$NON-NLS-1$ + } catch (URISyntaxException e) { + // hey we know this works + throw new IllegalStateException(e); + } + } + + @SuppressWarnings("nls") + private static final AbstractOptionParser[] optionParsers = { + new IncludePathOptionParser("#include \"(\\S.*)\"", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY | ICSettingEntry.LOCAL), + new IncludePathOptionParser("#include <(\\S.*)>", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("#define (\\S*\\(.*?\\)) *(.*)", "$1", "$2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("#define (\\S*) *(.*)", "$1", "$2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + }; + + @Override + protected AbstractOptionParser[] getOptionParsers() { + return optionParsers; + } + + @Override + protected URI getMappedRootURI(IResource sourceFile, String parsedResourceName) { + if (mappedRootURI==null) { + mappedRootURI = super.getMappedRootURI(sourceFile, parsedResourceName); + if (mappedRootURI==null) { + mappedRootURI = CYGWIN_ROOT; + } + } + return mappedRootURI; + } + + @Override + protected URI getBuildDirURI(URI mappedRootURI) { + if (buildDirURI==null) { + buildDirURI = super.getBuildDirURI(mappedRootURI); + if (buildDirURI==null) { + buildDirURI = CYGWIN_ROOT; + } + } + return buildDirURI; + } + + @Override + public GCCBuiltinSpecsDetectorCygwin cloneShallow() throws CloneNotSupportedException { + return (GCCBuiltinSpecsDetectorCygwin) super.cloneShallow(); + } + + @Override + public GCCBuiltinSpecsDetectorCygwin clone() throws CloneNotSupportedException { + return (GCCBuiltinSpecsDetectorCygwin) super.clone(); + } + +} diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/MBSLanguageSettingsProvider.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/MBSLanguageSettingsProvider.java new file mode 100644 index 00000000000..19b626c8b2f --- /dev/null +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/scannerconfig/MBSLanguageSettingsProvider.java @@ -0,0 +1,127 @@ +/******************************************************************************* + * Copyright (c) 2009, 2009 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.managedbuilder.internal.scannerconfig; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.AbstractExecutableExtensionBase; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICFileDescription; +import org.eclipse.cdt.core.settings.model.ICFolderDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSetting; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICResourceDescription; +import org.eclipse.cdt.core.settings.model.ICSettingBase; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.IPath; + +//public class MBSLanguageSettingsProvider extends AbstractExecutableExtensionBase implements ILanguageSettingsEditableProvider { +public class MBSLanguageSettingsProvider extends AbstractExecutableExtensionBase implements ILanguageSettingsProvider { + + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + + IPath projectPath = rc.getProjectRelativePath(); + ICLanguageSetting[] languageSettings = null; + + if (rc instanceof IFile) { + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(projectPath, true); + if (ls != null) { + languageSettings = new ICLanguageSetting[] {ls}; + } + } else { + ICResourceDescription rcDescription = cfgDescription.getResourceDescription(projectPath, false); + languageSettings = getLanguageSettings(rcDescription); + } + + List list = new ArrayList(); + + if (languageSettings != null) { + for (ICLanguageSetting langSetting : languageSettings) { + if (langSetting!=null) { + String id = langSetting.getLanguageId(); + if (id!=null && id.equals(languageId)) { + int kindsBits = langSetting.getSupportedEntryKinds(); + for (int kind=1;kind<=kindsBits;kind<<=1) { + if ((kindsBits & kind) != 0) { + list.addAll(langSetting.getSettingEntriesList(kind)); + } + } + } else { + // System.err.println("languageSetting id=null: name=" + languageSetting.getName()); + } + } else { + System.err.println("languageSetting=null: rc=" + rc); + } + } + } + return list; + } + + private ICLanguageSetting[] getLanguageSettings(ICResourceDescription rcDescription) { + ICLanguageSetting[] array = null; + switch (rcDescription.getType()) { + case ICSettingBase.SETTING_PROJECT: + case ICSettingBase.SETTING_CONFIGURATION: + case ICSettingBase.SETTING_FOLDER: + ICFolderDescription foDes = (ICFolderDescription)rcDescription; + array = foDes.getLanguageSettings(); + break; + case ICSettingBase.SETTING_FILE: + ICFileDescription fiDes = (ICFileDescription)rcDescription; + ICLanguageSetting ls = fiDes.getLanguageSetting(); + if (ls!=null) { + array = new ICLanguageSetting[] { ls }; + } + } + if (array==null) { + array = new ICLanguageSetting[0]; + } + return array; + } + + public void setSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId, + List entries) { + +// lang.setSettingEntries(kind, entries); + IPath projectPath = rc.getProjectRelativePath(); + ICResourceDescription rcDescription = cfgDescription.getResourceDescription(projectPath, false); + + for (ICLanguageSetting languageSetting : getLanguageSettings(rcDescription)) { + if (languageSetting!=null) { + String id = languageSetting.getLanguageId(); + if (id!=null && id.equals(languageId)) { + int kindsBits = languageSetting.getSupportedEntryKinds(); + for (int kind=1;kind<=kindsBits;kind<<=1) { + if ((kindsBits & kind) != 0) { + List list = new ArrayList(entries.size()); + for (ICLanguageSettingEntry entry : entries) { + if (entry.getKind()==kind) { + list.add(entry); + } + } + languageSetting.setSettingEntries(kind, list); + } + } + } else { +// System.err.println("languageSetting id=null: name=" + languageSetting.getName()); + } + } else { + System.err.println("languageSetting=null: rcDescription=" + rcDescription.getName()); + } + } + } + +} diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyCalculator.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyCalculator.java old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyCommands.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyCommands.java old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyGeneratorType.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyGeneratorType.java old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyInfo.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyInfo.java old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyPreBuild.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/IManagedDependencyPreBuild.java old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/gnu/GnuDependencyGroupInfo.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/makegen/gnu/GnuDependencyGroupInfo.java old mode 100755 new mode 100644 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/scannerconfig/ToolchainBuiltinSpecsDetector.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/scannerconfig/ToolchainBuiltinSpecsDetector.java new file mode 100644 index 00000000000..c8fb17ca9be --- /dev/null +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/scannerconfig/ToolchainBuiltinSpecsDetector.java @@ -0,0 +1,81 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.managedbuilder.scannerconfig; + +import java.util.HashMap; +import java.util.Map; + +import org.eclipse.cdt.make.core.scannerconfig.AbstractBuiltinSpecsDetector; +import org.eclipse.cdt.managedbuilder.core.IInputType; +import org.eclipse.cdt.managedbuilder.core.ITool; +import org.eclipse.cdt.managedbuilder.core.IToolChain; +import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; +import org.eclipse.cdt.managedbuilder.core.ManagedBuilderCorePlugin; + +public abstract class ToolchainBuiltinSpecsDetector extends AbstractBuiltinSpecsDetector { + private Map toolMap = new HashMap(); + /** + * TODO + */ + protected abstract String getToolchainId(); + + private ITool getTool(String languageId) { + ITool langTool = toolMap.get(languageId); + if (langTool != null) { + return langTool; + } + + String toolchainId = getToolchainId(); + IToolChain toolchain = ManagedBuildManager.getExtensionToolChain(toolchainId); + if (toolchain != null) { + ITool[] tools = toolchain.getTools(); + for (ITool tool : tools) { + IInputType[] inputTypes = tool.getInputTypes(); + for (IInputType inType : inputTypes) { + String lang = inType.getLanguageId(tool); + if (languageId.equals(lang)) { + toolMap.put(languageId, tool); + return tool; + } + } + } + } + ManagedBuilderCorePlugin.error("Unable to find tool in toolchain="+toolchainId+" for language="+languageId); + return null; + } + + @Override + protected String getCompilerCommand(String languageId) { + ITool tool = getTool(languageId); + String compiler = tool.getToolCommand(); + if (compiler.length() == 0) { + String msg = "Unable to find compiler command in toolchain="+getToolchainId(); + ManagedBuilderCorePlugin.error(msg); + } + return compiler; + } + + @Override + protected String getSpecFileExtension(String languageId) { + String ext = null; + ITool tool = getTool(languageId); + String[] srcFileExtensions = tool.getAllInputExtensions(); + if (srcFileExtensions != null && srcFileExtensions.length > 0) { + ext = srcFileExtensions[0]; + } + if (ext == null || ext.length() == 0) { + ManagedBuilderCorePlugin.error("Unable to find file extension for language "+languageId); + } + return ext; + } + +} diff --git a/build/org.eclipse.cdt.managedbuilder.gnu.ui/plugin.xml b/build/org.eclipse.cdt.managedbuilder.gnu.ui/plugin.xml index ddc4c317689..fe404978003 100644 --- a/build/org.eclipse.cdt.managedbuilder.gnu.ui/plugin.xml +++ b/build/org.eclipse.cdt.managedbuilder.gnu.ui/plugin.xml @@ -1253,7 +1253,6 @@ dependencyExtensions="h" dependencyCalculator="org.eclipse.cdt.managedbuilder.makegen.gnu.DefaultGCCDependencyCalculator2" id="cdt.managedbuild.tool.gnu.c.compiler.input" - scannerConfigDiscoveryProfileId="org.eclipse.cdt.managedbuilder.core.GCCManagedMakePerProjectProfileC|org.eclipse.cdt.make.core.GCCStandardMakePerFileProfile" languageId="org.eclipse.cdt.core.gcc"> + /> + /> + osList="linux,hpux,aix,qnx" + targetTool="cdt.managedbuild.tool.gnu.c.linker;cdt.managedbuild.tool.gnu.cpp.linker;cdt.managedbuild.tool.gnu.archiver"> @@ -1810,6 +1810,7 @@ configurationEnvironmentSupplier="org.eclipse.cdt.managedbuilder.gnu.mingw.MingwEnvironmentVariableSupplier" id="cdt.managedbuild.toolchain.gnu.mingw.base" isToolChainSupported="org.eclipse.cdt.managedbuilder.gnu.mingw.MingwIsToolChainSupported" + languageSettingsProviders="org.eclipse.cdt.make.core.build.command.parser.gcc;*org.eclipse.cdt.managedbuilder.core.gcc.specs.detector" name="%ToolChainName.MinGW" osList="win32" targetTool="cdt.managedbuild.tool.gnu.cpp.linker.mingw.base;cdt.managedbuild.tool.gnu.c.linker.mingw.base;cdt.managedbuild.tool.gnu.archiver"> @@ -2051,9 +2052,9 @@ + id="cdt.managedbuild.config.gnu.base" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.make.core.build.command.parser.gcc"> + cleanCommand="rm -rf" + id="cdt.managedbuild.config.gnu.cygwin.base" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.make.core.build.command.parser.gcc"> + cleanCommand="rm -rf" + id="cdt.managedbuild.config.gnu.mingw.base" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.make.core.build.command.parser.gcc"> + + + + diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.java index 94f8c37d3f6..e848b5e4341 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.java @@ -211,6 +211,8 @@ public class Messages extends NLS { public static String PropertyPageDefsTab_8; public static String PropertyPageDefsTab_9; public static String PropertyPageDefsTab_showIncludeFileTab; + public static String PropertyPageDefsTab_showProvidersTab; + public static String RefreshPolicyExceptionDialog_addButtonLabel; public static String RefreshPolicyExceptionDialog_addDialogLabel; public static String RefreshPolicyExceptionDialog_AddExceptionInfoDialog_message; public static String RefreshPolicyExceptionDialog_AddExceptionInfoDialog_title; diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.properties b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.properties index 3fdd4bfe8fb..5644fa44bef 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.properties +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/internal/ui/Messages.properties @@ -273,6 +273,7 @@ PropertyPageDefsTab_7=Show disc. page names if they are unique. Else show profil PropertyPageDefsTab_8=Always show names + profile IDs PropertyPageDefsTab_9=Always show profile IDs only PropertyPageDefsTab_showIncludeFileTab=Display "Include Files" tab +PropertyPageDefsTab_showProvidersTab=Display new experimental Scanner Discovery Providers tabs ProjectConvert_convertersList=Converters List AbstractPrefPage_0=\ Preference settings will be applied to new projects \n only when there were no toolchains selected. diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/PropertyPageDefsTab.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/PropertyPageDefsTab.java index 458f7e517a1..245dde59395 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/PropertyPageDefsTab.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/PropertyPageDefsTab.java @@ -12,9 +12,9 @@ package org.eclipse.cdt.managedbuilder.ui.preferences; import org.eclipse.cdt.core.settings.model.ICResourceDescription; +import org.eclipse.cdt.managedbuilder.internal.ui.Messages; import org.eclipse.cdt.ui.newui.AbstractCPropertyTab; import org.eclipse.cdt.ui.newui.CDTPrefUtil; -import org.eclipse.cdt.managedbuilder.internal.ui.Messages; import org.eclipse.swt.SWT; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.layout.GridData; @@ -38,6 +38,7 @@ public class PropertyPageDefsTab extends AbstractCPropertyTab { private Button show_mng; private Button show_tool; private Button show_exp; + private Button show_providers_tab; // temporary checkbox for scanner discovery Providers tab private Button show_tipbox; private Button b_0; @@ -74,6 +75,11 @@ public class PropertyPageDefsTab extends AbstractCPropertyTab { show_exp.setText(Messages.PropertyPageDefsTab_10); show_exp.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); + show_providers_tab = new Button(usercomp, SWT.CHECK); + show_providers_tab.setText(Messages.PropertyPageDefsTab_showProvidersTab + ", " //$NON-NLS-1$ + + org.eclipse.cdt.internal.ui.newui.Messages.CDTMainWizardPage_TrySD90); + show_providers_tab.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); + show_tipbox = new Button(usercomp, SWT.CHECK); show_tipbox.setText(Messages.PropertyPageDefsTab_16); show_tipbox.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); @@ -117,6 +123,7 @@ public class PropertyPageDefsTab extends AbstractCPropertyTab { show_mng.setSelection(!CDTPrefUtil.getBool(CDTPrefUtil.KEY_NOMNG)); show_tool.setSelection(!CDTPrefUtil.getBool(CDTPrefUtil.KEY_NOTOOLM)); show_exp.setSelection(CDTPrefUtil.getBool(CDTPrefUtil.KEY_EXPORT)); + show_providers_tab.setSelection(!CDTPrefUtil.getBool(CDTPrefUtil.KEY_NO_SHOW_PROVIDERS)); show_tipbox.setSelection(CDTPrefUtil.getBool(CDTPrefUtil.KEY_TIPBOX)); switch (CDTPrefUtil.getInt(CDTPrefUtil.KEY_DISC_NAMES)) { @@ -140,6 +147,7 @@ public class PropertyPageDefsTab extends AbstractCPropertyTab { CDTPrefUtil.setBool(CDTPrefUtil.KEY_NOMNG, !show_mng.getSelection()); CDTPrefUtil.setBool(CDTPrefUtil.KEY_NOTOOLM, !show_tool.getSelection()); CDTPrefUtil.setBool(CDTPrefUtil.KEY_EXPORT, show_exp.getSelection()); + CDTPrefUtil.setBool(CDTPrefUtil.KEY_NO_SHOW_PROVIDERS, !show_providers_tab.getSelection()); CDTPrefUtil.setBool(CDTPrefUtil.KEY_TIPBOX, show_tipbox.getSelection()); int x = 0; if (b_1.getSelection()) x = 1; @@ -160,6 +168,7 @@ public class PropertyPageDefsTab extends AbstractCPropertyTab { show_mng.setSelection(true); show_tool.setSelection(true); show_exp.setSelection(false); + show_providers_tab.setSelection(false); show_tipbox.setSelection(false); b_0.setSelection(true); b_1.setSelection(false); diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/WizardDefaultsTab.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/WizardDefaultsTab.java index 636382cc660..03b4f0a8f1f 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/WizardDefaultsTab.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/preferences/WizardDefaultsTab.java @@ -30,6 +30,7 @@ public class WizardDefaultsTab extends AbstractCPropertyTab { private Button show_sup; private Button show_oth; + private Button checkBoxTryNewSD; @Override public void createControls(Composite parent) { @@ -44,20 +45,27 @@ public class WizardDefaultsTab extends AbstractCPropertyTab { show_oth.setText(Messages.WizardDefaultsTab_1); show_oth.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); + checkBoxTryNewSD = new Button(usercomp, SWT.CHECK); + checkBoxTryNewSD.setText(org.eclipse.cdt.internal.ui.newui.Messages.CDTMainWizardPage_TrySD90); + checkBoxTryNewSD.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); + show_sup.setSelection(!CDTPrefUtil.getBool(CDTPrefUtil.KEY_NOSUPP)); show_oth.setSelection(CDTPrefUtil.getBool(CDTPrefUtil.KEY_OTHERS)); + checkBoxTryNewSD.setSelection(CDTPrefUtil.getBool(CDTPrefUtil.KEY_NEWSD)); } @Override protected void performOK() { CDTPrefUtil.setBool(CDTPrefUtil.KEY_NOSUPP, !show_sup.getSelection()); CDTPrefUtil.setBool(CDTPrefUtil.KEY_OTHERS, show_oth.getSelection()); + CDTPrefUtil.setBool(CDTPrefUtil.KEY_NEWSD, checkBoxTryNewSD.getSelection()); } @Override protected void performDefaults() { show_sup.setSelection(true); show_oth.setSelection(false); + checkBoxTryNewSD.setSelection(true); } @Override diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/properties/DiscoveryTab.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/properties/DiscoveryTab.java index 1cb3196cbea..88d068ec2b1 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/properties/DiscoveryTab.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/properties/DiscoveryTab.java @@ -24,10 +24,12 @@ import org.eclipse.cdt.build.core.scannerconfig.ICfgScannerConfigBuilderInfo2Set import org.eclipse.cdt.build.internal.core.scannerconfig.CfgDiscoveredPathManager; import org.eclipse.cdt.build.internal.core.scannerconfig.CfgScannerConfigUtil; import org.eclipse.cdt.build.internal.core.scannerconfig2.CfgScannerConfigProfileManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.util.CDTListComparator; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICResourceDescription; import org.eclipse.cdt.core.settings.model.util.CDataUtil; +import org.eclipse.cdt.internal.ui.newui.StatusMessageLine; import org.eclipse.cdt.make.core.MakeCorePlugin; import org.eclipse.cdt.make.core.scannerconfig.IScannerConfigBuilderInfo2; import org.eclipse.cdt.make.core.scannerconfig.IScannerConfigBuilderInfo2Set; @@ -46,7 +48,9 @@ import org.eclipse.cdt.managedbuilder.core.IInputType; import org.eclipse.cdt.managedbuilder.core.IResourceInfo; import org.eclipse.cdt.managedbuilder.core.ITool; import org.eclipse.cdt.managedbuilder.core.IToolChain; +import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; import org.eclipse.cdt.managedbuilder.internal.ui.Messages; +import org.eclipse.cdt.ui.CUIPlugin; import org.eclipse.cdt.ui.newui.CDTPrefUtil; import org.eclipse.cdt.utils.ui.controls.ControlFactory; import org.eclipse.cdt.utils.ui.controls.TabFolderLayout; @@ -103,6 +107,7 @@ public class DiscoveryTab extends AbstractCBuildPropertyTab implements IBuildInf private Button reportProblemsCheckBox; private Combo profileComboBox; private Composite profileOptionsComposite; + private Button clearButton; private ICfgScannerConfigBuilderInfo2Set cbi; private Map baseInfoMap; @@ -116,6 +121,8 @@ public class DiscoveryTab extends AbstractCBuildPropertyTab implements IBuildInf private DiscoveryPageWrapper wrapper = null; + private StatusMessageLine fStatusLine; + /* * (non-Javadoc) * @@ -184,6 +191,9 @@ public class DiscoveryTab extends AbstractCBuildPropertyTab implements IBuildInf profileOptionsComposite.setLayoutData(gd); profileOptionsComposite.setLayout(new TabFolderLayout()); + fStatusLine = new StatusMessageLine(usercomp, SWT.LEFT, 2); + setEnablement(); + sashForm.setWeights(DEFAULT_SASH_WEIGHTS); } @@ -236,7 +246,7 @@ public class DiscoveryTab extends AbstractCBuildPropertyTab implements IBuildInf Label clearLabel = ControlFactory.createLabel(autoDiscoveryGroup, Messages.DiscoveryTab_ClearDisoveredEntries); // "Clear" button - Button clearButton = ControlFactory.createPushButton(autoDiscoveryGroup, Messages.DiscoveryTab_Clear); + clearButton = ControlFactory.createPushButton(autoDiscoveryGroup, Messages.DiscoveryTab_Clear); GridData gd = (GridData) clearButton.getLayoutData(); gd.grabExcessHorizontalSpace = true; //Bug 331783 - NLS: "Clear" button label in Makefile Project preferences truncated @@ -334,6 +344,27 @@ public class DiscoveryTab extends AbstractCBuildPropertyTab implements IBuildInf } else { setVisibility(Messages.DiscoveryTab_6); } + + setEnablement(); + } + + private void setEnablement() { + IStatus status = null; + ICConfigurationDescription cfgDescription = page.getResDesc().getConfiguration(); + boolean isEnabled = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + if (!isEnabled) { + status = new Status(IStatus.INFO, CUIPlugin.PLUGIN_ID, "Managed Build language settings provider is not enabled."); + } + + scopeComboBox.setEnabled(isEnabled); + resTable.setEnabled(isEnabled); + boolean isSCDEnabled = autoDiscoveryCheckBox.getSelection(); + reportProblemsCheckBox.setEnabled(isEnabled && isSCDEnabled); + autoDiscoveryCheckBox.setEnabled(isEnabled); + autoDiscoveryGroup.setEnabled(isEnabled); + clearButton.setEnabled(isEnabled); + + fStatusLine.setErrorStatus(status); } private void setVisibility(String errMsg) { @@ -372,7 +403,13 @@ public class DiscoveryTab extends AbstractCBuildPropertyTab implements IBuildInf buildInfo = (IScannerConfigBuilderInfo2) ti.getData("info"); //$NON-NLS-1$ String selectedProfileId = buildInfo.getSelectedProfileId(); iContext = (CfgInfoContext) ti.getData("cont"); //$NON-NLS-1$ - autoDiscoveryCheckBox.setSelection(buildInfo.isAutoDiscoveryEnabled() + boolean autodiscoveryEnabled2 = buildInfo.isAutoDiscoveryEnabled(); + if (autodiscoveryEnabled2) { + IConfiguration cfg = iContext.getConfiguration(); + ICConfigurationDescription cfgDescription = ManagedBuildManager.getDescriptionForConfiguration(cfg); + autodiscoveryEnabled2 = ScannerDiscoveryLegacySupport.isMbsLanguageSettingsProviderOn(cfgDescription); + } + autoDiscoveryCheckBox.setSelection(autodiscoveryEnabled2 && !selectedProfileId.equals(ScannerConfigProfileManager.NULL_PROFILE_ID)); reportProblemsCheckBox.setSelection(buildInfo.isProblemReportingEnabled()); diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/MBSWizardHandler.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/MBSWizardHandler.java index 73be50d9ad8..1e3214e6d37 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/MBSWizardHandler.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/MBSWizardHandler.java @@ -23,6 +23,10 @@ import java.util.SortedMap; import java.util.TreeMap; import java.util.TreeSet; +import org.eclipse.cdt.build.internal.core.scannerconfig2.CfgScannerConfigProfileManager; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescription; @@ -41,8 +45,8 @@ import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; import org.eclipse.cdt.managedbuilder.internal.core.Configuration; import org.eclipse.cdt.managedbuilder.internal.core.ManagedBuildInfo; import org.eclipse.cdt.managedbuilder.internal.core.ManagedProject; -import org.eclipse.cdt.managedbuilder.ui.properties.ManagedBuilderUIPlugin; import org.eclipse.cdt.managedbuilder.internal.ui.Messages; +import org.eclipse.cdt.managedbuilder.ui.properties.ManagedBuilderUIPlugin; import org.eclipse.cdt.ui.newui.CDTPrefUtil; import org.eclipse.cdt.ui.templateengine.IWizardDataPage; import org.eclipse.cdt.ui.templateengine.Template; @@ -546,6 +550,13 @@ public class MBSWizardHandler extends CWizardHandler { } private void setProjectDescription(IProject project, boolean defaults, boolean onFinish, IProgressMonitor monitor) throws CoreException { + boolean isTryingNewSD = false; + IWizardPage page = getStartingPage(); + if (page instanceof CDTMainWizardPage) { + CDTMainWizardPage mainWizardPage = (CDTMainWizardPage)page; + isTryingNewSD = mainWizardPage.isTryingNewSD(); + } + ICProjectDescriptionManager mngr = CoreModel.getDefault().getProjectDescriptionManager(); ICProjectDescription des = mngr.createProjectDescription(project, false, !onFinish); ManagedBuildInfo info = ManagedBuildManager.createBuildInfo(project); @@ -591,6 +602,18 @@ public class MBSWizardHandler extends CWizardHandler { cfgDebug = cfgDes; if (cfgFirst == null) // select at least first configuration cfgFirst = cfgDes; + + ScannerDiscoveryLegacySupport.setLanguageSettingsProvidersFunctionalityEnabled(project, isTryingNewSD); + if (isTryingNewSD) { + List providers = ManagedBuildManager.getLanguageSettingsProviders(config); + cfgDes.setLanguageSettingProviders(providers); + } else { + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(ManagedBuildManager.MBS_LANGUAGE_SETTINGS_PROVIDER); + List providers = new ArrayList(); + providers.add(provider); + cfgDes.setLanguageSettingProviders(providers); + } + monitor.worked(work); } mngr.setProjectDescription(project, des); diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExisting.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExisting.java index 6fb3743574e..aaee0129ce8 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExisting.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExisting.java @@ -11,10 +11,16 @@ package org.eclipse.cdt.managedbuilder.ui.wizards; import java.lang.reflect.InvocationTargetException; +import java.util.ArrayList; +import java.util.List; import org.eclipse.cdt.core.CCProjectNature; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager; import org.eclipse.cdt.core.settings.model.extension.CConfigurationData; @@ -69,6 +75,7 @@ public class NewMakeProjFromExisting extends Wizard implements IImportWizard, IN final String locationStr = page.getLocation(); final boolean isCPP = page.isCPP(); final IToolChain toolChain = page.getToolChain(); + final boolean isTryingNewSD = page.isTryingNewSD(); IRunnableWithProgress op = new WorkspaceModifyOperation() { @Override @@ -110,7 +117,19 @@ public class NewMakeProjFromExisting extends Wizard implements IImportWizard, IN IBuilder builder = config.getEditableBuilder(); builder.setManagedBuildOn(false); CConfigurationData data = config.getConfigurationData(); - projDesc.createConfiguration(ManagedBuildManager.CFG_DATA_PROVIDER_ID, data); + ICConfigurationDescription cfgDes = projDesc.createConfiguration(ManagedBuildManager.CFG_DATA_PROVIDER_ID, data); + + ScannerDiscoveryLegacySupport.setLanguageSettingsProvidersFunctionalityEnabled(project, isTryingNewSD); + if (isTryingNewSD) { + List providers = ManagedBuildManager.getLanguageSettingsProviders(config); + cfgDes.setLanguageSettingProviders(providers); + } else { + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(ManagedBuildManager.MBS_LANGUAGE_SETTINGS_PROVIDER); + List providers = new ArrayList(); + providers.add(provider); + cfgDes.setLanguageSettingProviders(providers); + } + monitor.worked(1); pdMgr.setProjectDescription(project, projDesc); diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExistingPage.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExistingPage.java index c9b59182216..22a07ea68ba 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExistingPage.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/NewMakeProjFromExistingPage.java @@ -19,6 +19,8 @@ import java.util.Map; import org.eclipse.cdt.managedbuilder.core.IToolChain; import org.eclipse.cdt.managedbuilder.core.ManagedBuildManager; import org.eclipse.cdt.managedbuilder.internal.ui.Messages; +import org.eclipse.cdt.ui.CUIPlugin; +import org.eclipse.cdt.ui.newui.CDTPrefUtil; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IWorkspaceRoot; import org.eclipse.core.resources.ResourcesPlugin; @@ -51,6 +53,9 @@ public class NewMakeProjFromExistingPage extends WizardPage { IWorkspaceRoot root; List tcList; Map tcMap = new HashMap(); + + private Button checkBoxTryNewSD; + protected NewMakeProjFromExistingPage() { super(Messages.NewMakeProjFromExistingPage_0); @@ -72,6 +77,21 @@ public class NewMakeProjFromExistingPage extends WizardPage { addLanguageSelector(comp); addToolchainSelector(comp); + checkBoxTryNewSD = new Button(comp, SWT.CHECK); + checkBoxTryNewSD.setText(org.eclipse.cdt.internal.ui.newui.Messages.CDTMainWizardPage_TrySD90); + GridData gd = new GridData(GridData.FILL_HORIZONTAL); + gd.horizontalSpan = 2; + checkBoxTryNewSD.setLayoutData(gd); + + + // restore settings from preferences + boolean isTryNewSD = true; + boolean contains = CUIPlugin.getDefault().getPreferenceStore().contains(CDTPrefUtil.KEY_NEWSD); + if (contains) { + isTryNewSD = CDTPrefUtil.getBool(CDTPrefUtil.KEY_NEWSD); + } + checkBoxTryNewSD.setSelection(isTryNewSD); + setControl(comp); } @@ -213,4 +233,7 @@ public class NewMakeProjFromExistingPage extends WizardPage { return selection.length != 0 ? tcMap.get(selection[0]) : null; } + public boolean isTryingNewSD() { + return checkBoxTryNewSD.getSelection(); + } } diff --git a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/STDWizardHandler.java b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/STDWizardHandler.java index b5128f0ef2e..cb515055f89 100644 --- a/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/STDWizardHandler.java +++ b/build/org.eclipse.cdt.managedbuilder.ui/src/org/eclipse/cdt/managedbuilder/ui/wizards/STDWizardHandler.java @@ -11,7 +11,14 @@ *******************************************************************************/ package org.eclipse.cdt.managedbuilder.ui.wizards; +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescription; import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager; import org.eclipse.cdt.core.settings.model.extension.CConfigurationData; @@ -24,10 +31,12 @@ import org.eclipse.cdt.managedbuilder.internal.core.ManagedBuildInfo; import org.eclipse.cdt.managedbuilder.internal.core.ManagedProject; import org.eclipse.cdt.managedbuilder.internal.core.ToolChain; import org.eclipse.cdt.managedbuilder.internal.ui.Messages; +import org.eclipse.cdt.ui.wizards.CDTMainWizardPage; import org.eclipse.core.resources.IProject; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.jface.wizard.IWizard; +import org.eclipse.jface.wizard.IWizardPage; import org.eclipse.swt.widgets.Composite; /** @@ -71,6 +80,14 @@ public class STDWizardHandler extends MBSWizardHandler { private void setProjectDescription(IProject project, boolean defaults, boolean onFinish, IProgressMonitor monitor) throws CoreException { + + boolean isTryingNewSD = false; + IWizardPage page = getStartingPage(); + if (page instanceof CDTMainWizardPage) { + CDTMainWizardPage mainWizardPage = (CDTMainWizardPage)page; + isTryingNewSD = mainWizardPage.isTryingNewSD(); + } + ICProjectDescriptionManager mngr = CoreModel.getDefault().getProjectDescriptionManager(); ICProjectDescription des = mngr.createProjectDescription(project, false, !onFinish); ManagedBuildInfo info = ManagedBuildManager.createBuildInfo(project); @@ -99,7 +116,19 @@ public class STDWizardHandler extends MBSWizardHandler { } cfg.setArtifactName(mProj.getDefaultArtifactName()); CConfigurationData data = cfg.getConfigurationData(); - des.createConfiguration(ManagedBuildManager.CFG_DATA_PROVIDER_ID, data); + ICConfigurationDescription cfgDes = des.createConfiguration(ManagedBuildManager.CFG_DATA_PROVIDER_ID, data); + + ScannerDiscoveryLegacySupport.setLanguageSettingsProvidersFunctionalityEnabled(project, isTryingNewSD); + if (isTryingNewSD) { + List providers = ManagedBuildManager.getLanguageSettingsProviders(cfg); + cfgDes.setLanguageSettingProviders(providers); + } else { + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(ManagedBuildManager.MBS_LANGUAGE_SETTINGS_PROVIDER); + List providers = new ArrayList(); + providers.add(provider); + cfgDes.setLanguageSettingProviders(providers); + } + monitor.worked(work); } mngr.setProjectDescription(project, des); diff --git a/core/org.eclipse.cdt.core.macosx/os/macosx/x86/libpty.jnilib b/core/org.eclipse.cdt.core.macosx/os/macosx/x86/libpty.jnilib old mode 100755 new mode 100644 diff --git a/core/org.eclipse.cdt.core.macosx/os/macosx/x86/libspawner.jnilib b/core/org.eclipse.cdt.core.macosx/os/macosx/x86/libspawner.jnilib old mode 100755 new mode 100644 diff --git a/core/org.eclipse.cdt.core.tests/META-INF/MANIFEST.MF b/core/org.eclipse.cdt.core.tests/META-INF/MANIFEST.MF index 24768732e86..66699fb547f 100644 --- a/core/org.eclipse.cdt.core.tests/META-INF/MANIFEST.MF +++ b/core/org.eclipse.cdt.core.tests/META-INF/MANIFEST.MF @@ -12,6 +12,7 @@ Export-Package: org.eclipse.cdt.core.cdescriptor.tests, org.eclipse.cdt.core.internal.tests;x-internal:=true, org.eclipse.cdt.core.internal.tests.filesystem.ram, org.eclipse.cdt.core.language, + org.eclipse.cdt.core.language.settings.providers;x-internal:=true, org.eclipse.cdt.core.model.tests, org.eclipse.cdt.core.parser.tests, org.eclipse.cdt.core.parser.tests.ast2, diff --git a/core/org.eclipse.cdt.core.tests/misc/org/eclipse/cdt/core/internal/tests/filesystem/ram/MemoryEFSExtensionProvider.java b/core/org.eclipse.cdt.core.tests/misc/org/eclipse/cdt/core/internal/tests/filesystem/ram/MemoryEFSExtensionProvider.java new file mode 100644 index 00000000000..279f507aae8 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/misc/org/eclipse/cdt/core/internal/tests/filesystem/ram/MemoryEFSExtensionProvider.java @@ -0,0 +1,33 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.core.internal.tests.filesystem.ram; + +import java.net.URI; + +import org.eclipse.cdt.core.EFSExtensionProvider; + +/** + * Test stub to test EFSExtensionProvider mappings. + * + */ +public class MemoryEFSExtensionProvider extends EFSExtensionProvider { + + public String getMappedPath(URI locationURI) { + + String path = locationURI.getPath(); + if (path.contains("/BeingMappedFrom/Folder")) { + return path.replaceFirst("/BeingMappedFrom/Folder", "/LocallyMappedTo/Folder"); + } + + return super.getMappedPath(locationURI); + } + +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java new file mode 100644 index 00000000000..15d6813587c --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java @@ -0,0 +1,33 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.core.language.settings.providers; + +import junit.framework.Test; +import junit.framework.TestSuite; + + +public class AllLanguageSettingsProvidersCoreTests { + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + public static Test suite() { + TestSuite suite = new TestSuite(AllLanguageSettingsProvidersCoreTests.class.getName()); + + suite.addTest(LanguageSettingsExtensionsTests.suite()); + suite.addTest(LanguageSettingsManagerTests.suite()); + suite.addTest(LanguageSettingsSerializableTests.suite()); + suite.addTest(LanguageSettingsPersistenceProjectTests.suite()); + suite.addTest(LanguageSettingsListenersTests.suite()); + suite.addTest(LanguageSettingsScannerInfoProviderTests.suite()); + return suite; + } +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsExtensionsTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsExtensionsTests.java new file mode 100644 index 00000000000..0783df36eee --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsExtensionsTests.java @@ -0,0 +1,325 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import junit.framework.TestSuite; + +import org.eclipse.cdt.core.settings.model.CIncludeFileEntry; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CLibraryFileEntry; +import org.eclipse.cdt.core.settings.model.CLibraryPathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.CMacroFileEntry; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsExtensionManager; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.Path; + +/** + * Test cases testing LanguageSettingsProvider functionality + */ +public class LanguageSettingsExtensionsTests extends BaseTestCase { + // These should match corresponding entries defined in plugin.xml + private static final String EXTENSION_BASE_PROVIDER_ID = "org.eclipse.cdt.core.tests.language.settings.base.provider"; + private static final String EXTENSION_BASE_PROVIDER_NAME = "Test Plugin Mock Language Settings Base Provider"; + private static final String EXTENSION_BASE_PROVIDER_LANG_ID = "org.eclipse.cdt.core.tests.language.id"; + private static final String EXTENSION_BASE_PROVIDER_PARAMETER = "custom parameter"; + private static final String EXTENSION_CUSTOM_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.language.settings.provider"; + private static final String EXTENSION_CUSTOM_PROVIDER_NAME = "Test Plugin Mock Language Settings Provider"; + private static final String EXTENSION_BASE_SUBCLASS_PROVIDER_ID = "org.eclipse.cdt.core.tests.language.settings.base.provider.subclass"; + private static final String EXTENSION_BASE_SUBCLASS_PROVIDER_PARAMETER = "custom parameter subclass"; + private static final String EXTENSION_SERIALIZABLE_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.serializable.language.settings.provider"; + private static final String EXTENSION_EDITABLE_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.editable.language.settings.provider"; + + // These are made up + private static final String PROVIDER_0 = "test.provider.0.id"; + private static final String PROVIDER_NAME_0 = "test.provider.0.name"; + private static final String LANG_ID = "test.lang.id"; + private static final IFile FILE_0 = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/project/path0")); + + /** + * Constructor. + * @param name - name of the test. + */ + public LanguageSettingsExtensionsTests(String name) { + super(name); + + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + super.tearDown(); + } + + /** + * @return - new TestSuite. + */ + public static TestSuite suite() { + return new TestSuite(LanguageSettingsExtensionsTests.class); + } + + /** + * main function of the class. + * + * @param args - arguments + */ + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + /** + * Check that regular ICLanguageSettingsProvider extension defined in plugin.xml is accessible. + */ + public void testExtension() throws Exception { + { + List providers = LanguageSettingsManager.getWorkspaceProviders(); + List ids = new ArrayList(); + for (ILanguageSettingsProvider provider : providers) { + ids.add(provider.getId()); + } + assertTrue("extension " + EXTENSION_BASE_PROVIDER_ID + " not found", ids.contains(EXTENSION_BASE_PROVIDER_ID)); + } + + { + // test provider not in the list + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getExtensionProviderCopy("missing.povider"); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(providerExt)); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(providerExt); + assertNull(rawProvider); + } + + // get test plugin extension provider + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getExtensionProviderCopy(EXTENSION_BASE_PROVIDER_ID); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(providerExt)); + + // get raw extension provider + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(providerExt); + assertTrue(rawProvider instanceof LanguageSettingsBaseProvider); + LanguageSettingsBaseProvider provider = (LanguageSettingsBaseProvider)rawProvider; + assertEquals(EXTENSION_BASE_PROVIDER_ID, provider.getId()); + assertEquals(EXTENSION_BASE_PROVIDER_NAME, provider.getName()); + assertEquals(EXTENSION_BASE_PROVIDER_PARAMETER, provider.getCustomParameter()); + + // attempt to get entries for wrong language + assertNull(provider.getSettingEntries(null, FILE_0, LANG_ID)); + + // benchmarks matching extension point definition + List entriesExt = new ArrayList(); + entriesExt.add(new CIncludePathEntry("/usr/include/", + ICSettingEntry.BUILTIN + | ICSettingEntry.LOCAL + | ICSettingEntry.RESOLVED + | ICSettingEntry.VALUE_WORKSPACE_PATH + | ICSettingEntry.UNDEFINED + )); + entriesExt.add(new CMacroEntry("TEST_DEFINE", "100", 0)); + entriesExt.add(new CIncludeFileEntry("/include/file.inc", 0)); + entriesExt.add(new CLibraryPathEntry("/usr/lib/", 0)); + entriesExt.add(new CLibraryFileEntry("libdomain.a", 0)); + entriesExt.add(new CMacroFileEntry("/macro/file.mac", 0)); + + // retrieve entries from extension point + List actual = provider.getSettingEntries(null, FILE_0, EXTENSION_BASE_PROVIDER_LANG_ID); + for (int i=0;i actual = provider.getSettingEntries(null, FILE_0, LANG_ID); + for (int i=0;i languages = new ArrayList(2); + languages.add("bogus.language.id"); + languages.add(LANG_ID); + + // add default provider + LanguageSettingsBaseProvider provider = new LanguageSettingsBaseProvider( + PROVIDER_0, PROVIDER_NAME_0, languages, entries); + + { + // attempt to get entries for wrong language + List actual = provider.getSettingEntries(null, FILE_0, "wrong.lang.id"); + assertNull(actual); + } + + { + // retrieve the entries + List actual = provider.getSettingEntries(null, FILE_0, LANG_ID); + assertEquals(entries.get(0), actual.get(0)); + assertNotSame(entries, actual); + // retrieve languages + List actualLanguageIds = provider.getLanguageScope(); + for (String languageId: languages) { + assertTrue(actualLanguageIds.contains(languageId)); + } + assertEquals(languages.size(), actualLanguageIds.size()); + } + } + + /** + * TODO + */ + public void testSerializableProvider() throws Exception { + // get test plugin extension for serializable provider + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getExtensionProviderCopy(EXTENSION_SERIALIZABLE_PROVIDER_ID); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(providerExt)); + + // get raw extension provider + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(providerExt); + assertTrue(rawProvider instanceof LanguageSettingsSerializable); + LanguageSettingsSerializable provider = (LanguageSettingsSerializable) rawProvider; + + assertEquals(null, provider.getLanguageScope()); + assertEquals("", provider.getCustomParameter()); + + List expected = new ArrayList(); + expected.add(new CMacroEntry("MACRO", "value", 0)); + assertEquals(expected, provider.getSettingEntries(null, null, null)); + } + + /** + * TODO + */ + public void testEditableProvider() throws Exception { + // Non-editable providers cannot be copied so they are singletons + { + // get test plugin extension for serializable provider + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getExtensionProviderCopy(EXTENSION_SERIALIZABLE_PROVIDER_ID); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(providerExt)); + + // get raw extension provider + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(providerExt); + assertTrue(rawProvider instanceof LanguageSettingsSerializable); + assertTrue(LanguageSettingsExtensionManager.equalsExtensionProvider(rawProvider)); + + // compare with workspace provider + ILanguageSettingsProvider providerWsp = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + ILanguageSettingsProvider providerWspRaw = LanguageSettingsManager.getRawProvider(providerWsp); + assertSame(rawProvider, providerWspRaw); + } + + // Editable providers are retrieved by copy + { + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getExtensionProviderCopy(EXTENSION_EDITABLE_PROVIDER_ID); + assertFalse(LanguageSettingsManager.isWorkspaceProvider(providerExt)); + assertTrue(providerExt instanceof ILanguageSettingsEditableProvider); + assertTrue(LanguageSettingsExtensionManager.equalsExtensionProvider(providerExt)); + + ILanguageSettingsProvider providerExt2 = LanguageSettingsManager.getExtensionProviderCopy(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotSame(providerExt, providerExt2); + assertEquals(providerExt, providerExt2); + + ILanguageSettingsProvider providerWsp = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + ILanguageSettingsProvider providerWspRaw = LanguageSettingsManager.getRawProvider(providerWsp); + assertNotSame(providerExt, providerWspRaw); + assertEquals(providerExt, providerWspRaw); + assertTrue(LanguageSettingsExtensionManager.equalsExtensionProvider(providerWspRaw)); + } + + // Test shallow copy + { + ILanguageSettingsProvider provider = LanguageSettingsManager.getExtensionProviderCopy(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(provider); + assertTrue(provider instanceof ILanguageSettingsEditableProvider); + + ILanguageSettingsProvider providerShallow = LanguageSettingsExtensionManager.getExtensionProviderShallow(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(providerShallow); + assertTrue(providerShallow instanceof ILanguageSettingsEditableProvider); + assertFalse(provider.equals(providerShallow)); + + assertFalse(LanguageSettingsExtensionManager.equalsExtensionProvider(providerShallow)); + assertTrue(LanguageSettingsExtensionManager.equalsExtensionProviderShallow((ILanguageSettingsEditableProvider) providerShallow)); + + } + } + +// /** +// * LanguageSettingsBaseProvider is not allowed to be configured twice. +// */ +// public void testBaseProviderConfigure() throws Exception { +// // create LanguageSettingsBaseProvider +// LanguageSettingsBaseProvider provider = new LanguageSettingsBaseProvider(); +// List entries = new ArrayList(); +// entries.add(new CIncludePathEntry("/usr/include/", 0)); +// // configure it +// provider.configureProvider("id", "name", null, entries, null); +// +// try { +// // attempt to configure it twice should fail +// provider.configureProvider("id", "name", null, entries, null); +// fail("LanguageSettingsBaseProvider is not allowed to be configured twice"); +// } catch (UnsupportedOperationException e) { +// } +// } + +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java new file mode 100644 index 00000000000..bb2915a5359 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsListenersTests.java @@ -0,0 +1,1047 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import junit.framework.TestSuite; + +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.language.settings.providers.ILanguageSettingsChangeEvent; +import org.eclipse.cdt.internal.core.language.settings.providers.ILanguageSettingsChangeListener; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.core.resources.IProject; + +/** + * Test cases testing LanguageSettingsProvider functionality + */ +public class LanguageSettingsListenersTests extends BaseTestCase { + // Must match provider id defined as extension point + private static final String EXTENSION_REGISTERER_PROVIDER_ID = "org.eclipse.cdt.core.tests.language.settings.listener.registerer.provider"; + private static final String EXTENSION_EDITABLE_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.editable.language.settings.provider"; + + private static final String PROVIDER_1 = "test.provider.1.id"; + private static final String PROVIDER_NAME_1 = "test.provider.1.name"; + private static final String PROVIDER_CUSTOM_GLOBAL = "test.provider.custom.global.id"; + private static final String PROVIDER_CUSTOM_GLOBAL_NAME = "test.provider.custom.global.name"; + + private static final CMacroEntry SAMPLE_LSE = new CMacroEntry("MACRO", "value",0); + private class MockLanguageSettingsChangeListener implements ILanguageSettingsChangeListener { + private int count = 0; + private ILanguageSettingsChangeEvent lastEvent = null; + + @Override + public void handleEvent(ILanguageSettingsChangeEvent event) { + count++; + lastEvent = event; + } + + public int getCount() { + return count; + } + + public void resetCount() { + count = 0; + lastEvent = null; + } + + public ILanguageSettingsChangeEvent getLastEvent() { + return lastEvent; + } + } + private MockLanguageSettingsChangeListener mockLseListener = new MockLanguageSettingsChangeListener(); + + /** + * Constructor. + * @param name - name of the test. + */ + public LanguageSettingsListenersTests(String name) { + super(name); + + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + LanguageSettingsProvidersSerializer.unregisterLanguageSettingsChangeListener(mockLseListener); + LanguageSettingsManager.setWorkspaceProviders(null); + super.tearDown(); + } + + /** + * @return - new TestSuite. + */ + public static TestSuite suite() { + return new TestSuite(LanguageSettingsListenersTests.class); + } + + /** + * main function of the class. + * + * @param args - arguments + */ + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + /** + */ + public void testListenerRegisterer_CheckExtensionProvider() throws Exception { + // check if extension provider exists + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(workspaceProvider); + assertNotNull(rawProvider); + // global listeners providers get registered only lazily + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + + /** + */ + public void testListenerRegisterer_OneOwnedByCfg() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider + ILanguageSettingsProvider mockProvider = new MockListenerRegisterer(PROVIDER_1, PROVIDER_NAME_1); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(PROVIDER_1)); + } + { + // close the project + project.close(null); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_1)); + } + { + // reopen the project + project.open(null); + CoreModel.getDefault().getProjectDescription(project); + assertEquals(1, MockListenerRegisterer.getCount(PROVIDER_1)); + // and delete + project.delete(true, null); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_1)); + } + + } + + /** + */ + public void testListenerRegisterer_TwoOwnedByCfgs() throws Exception { + IProject project = ResourceHelper.createCDTProject(this.getName(), null, new String[] { + "org.eclipse.cdt.core.tests.configuration.id.1", + "org.eclipse.cdt.core.tests.configuration.id.2", + }); + + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(2, cfgDescriptions.length); + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + + { + // create a provider 1 + ILanguageSettingsProvider mockProvider = new MockListenerRegisterer(PROVIDER_1, PROVIDER_NAME_1); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription1.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription1.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + } + { + // create a provider 2 + ILanguageSettingsProvider mockProvider = new MockListenerRegisterer(PROVIDER_1, PROVIDER_NAME_1); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription2.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription2.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + } + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + assertEquals(2, MockListenerRegisterer.getCount(PROVIDER_1)); + } + { + // close the project + project.close(null); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_1)); + } + { + // reopen the project + project.open(null); + CoreModel.getDefault().getProjectDescription(project); + assertEquals(2, MockListenerRegisterer.getCount(PROVIDER_1)); + // and delete + project.delete(true, null); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_1)); + } + + } + + /** + */ + public void testListenerRegisterer_OneGlobal() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // add global provider + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // close the project + project.close(null); + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // reopen the project + project.open(null); + CoreModel.getDefault().getProjectDescription(project); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + // and delete + project.delete(true, null); + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + + } + + /** + */ + public void testListenerRegisterer_TwoGlobal() throws Exception { + IProject project = ResourceHelper.createCDTProject(this.getName(), null, new String[] { + "org.eclipse.cdt.core.tests.configuration.id.1", + "org.eclipse.cdt.core.tests.configuration.id.2", + }); + + { + // retrieve global provider + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(2, cfgDescriptions.length); + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + + { + // add global provider to configuration 1 + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription1.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription1.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + } + { + // add global provider to configuration 2 + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription2.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription2.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + } + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // close the project + project.close(null); + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // reopen the project + project.open(null); + CoreModel.getDefault().getProjectDescription(project); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + // and delete + project.delete(true, null); + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + } + + /** + */ + public void testListenerRegisterer_TwoGlobalMinusOne() throws Exception { + IProject project = ResourceHelper.createCDTProject(this.getName(), null, new String[] { + "org.eclipse.cdt.core.tests.configuration.id.1", + "org.eclipse.cdt.core.tests.configuration.id.2", + }); + + { + // retrieve workspace provider + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(2, cfgDescriptions.length); + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + + { + // add global provider to configuration 1 + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription1.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription1.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + } + { + // add global provider to configuration 2 + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription2.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription2.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + } + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // retrieve workspace provider + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(2, cfgDescriptions.length); + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + + { + // remove global provider from configuration 1 + List providers = new ArrayList(); + cfgDescription1.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription1.getLanguageSettingProviders(); + assertEquals(0, storedProviders.size()); + } + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // close the project + project.close(null); + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + } + + /** + */ + public void testListenerRegisterer_GlobalProviderTwoProjects() throws Exception { + // create project 1 + IProject project_1 = ResourceHelper.createCDTProjectWithConfig(this.getName() + ".1"); + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project_1); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // add global provider + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project_1, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + + // create project 2 + IProject project_2 = ResourceHelper.createCDTProjectWithConfig(this.getName() + ".2"); + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project_2); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // add global provider + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_REGISTERER_PROVIDER_ID); + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project_2, writableProjDescription); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + + { + // close project 1 + project_1.close(null); + assertEquals(1, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + { + // close project 2 + project_2.close(null); + assertEquals(0, MockListenerRegisterer.getCount(EXTENSION_REGISTERER_PROVIDER_ID)); + } + + } + + /** + */ + public void testListenerRegisterer_GlobalProviderNotInUse() throws Exception { + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(PROVIDER_CUSTOM_GLOBAL); + + // the global custom provider has not been added yet + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(workspaceProvider); + assertNull(rawProvider); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + + List workspaceProvidersOriginal = LanguageSettingsManager.getWorkspaceProviders(); + { + // add global provider which is not engaged + ILanguageSettingsProvider provider = new MockListenerRegisterer(PROVIDER_CUSTOM_GLOBAL, PROVIDER_CUSTOM_GLOBAL_NAME); + List providers = new ArrayList(workspaceProvidersOriginal); + providers.add(provider); + LanguageSettingsManager.setWorkspaceProviders(providers); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + } + { + // remove global provider and restore original list + List providers = new ArrayList(workspaceProvidersOriginal); + LanguageSettingsManager.setWorkspaceProviders(providers); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + } + } + + /** + */ + public void testListenerRegisterer_GlobalProviderAddRemoveOutsideTheProject() throws Exception { + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(PROVIDER_CUSTOM_GLOBAL); + + // the global custom provider has not been added yet + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(workspaceProvider); + assertNull(rawProvider); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + + // prepare project + List workspaceProvidersOriginal = LanguageSettingsManager.getWorkspaceProviders(); + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // add global provider + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + // the global custom provider has not been added yet + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + } + + { + // add global provider + ILanguageSettingsProvider provider = new MockListenerRegisterer(PROVIDER_CUSTOM_GLOBAL, PROVIDER_CUSTOM_GLOBAL_NAME); + List providers = new ArrayList(); + providers.add(provider); + LanguageSettingsManager.setWorkspaceProviders(providers); + assertEquals(1, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + } + { + // remove global provider + List providers = new ArrayList(workspaceProvidersOriginal); + LanguageSettingsManager.setWorkspaceProviders(providers); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + } + + { + // close project + project.close(null); + assertEquals(0, MockListenerRegisterer.getCount(PROVIDER_CUSTOM_GLOBAL)); + } + } + + /** + */ + public void testNotification_cfgProvider_AddEmptyProvider() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + // First clear default providers + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // clear providers + List providers = new ArrayList(); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Add empty provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider and add to cfgDescription + ILanguageSettingsProvider mockProvider = new MockLanguageSettingsEditableProvider(PROVIDER_1, PROVIDER_NAME_1); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // No notifications expected + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + } + + /** + */ + public void testNotification_cfgProvider_AddNonEmptyProvider() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + // First clear default providers + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // clear providers + List providers = new ArrayList(); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Add non-empty provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescription.getId(); + + // create a provider and add entries + MockLanguageSettingsEditableProvider mockProvider = new MockLanguageSettingsEditableProvider(PROVIDER_1, PROVIDER_NAME_1); + List entries = new ArrayList(); + entries.add(SAMPLE_LSE); + mockProvider.setSettingEntries(cfgDescription, project, null, entries); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + + // inspect notifications + assertEquals(1, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNotNull(event); + + assertEquals(project.getName(), event.getProjectName()); + assertEquals(1, event.getConfigurationDescriptionIds().length); + assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); + } + } + + /** + */ + public void testNotification_cfgProvider_SerializeEntries() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + + // add the mock provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider and add to cfgDescription + List providers = new ArrayList(); + providers.add(new MockLanguageSettingsEditableProvider(PROVIDER_1, PROVIDER_NAME_1)); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Change the provider's entries + { + // get project descriptions + ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project, false); + assertNotNull(prjDescription); + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescription.getId(); + + // Add entries + List entries = new ArrayList(); + entries.add(SAMPLE_LSE); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + assertTrue(providers.get(0) instanceof MockLanguageSettingsEditableProvider); + MockLanguageSettingsEditableProvider mockProvider = (MockLanguageSettingsEditableProvider) providers.get(0); + mockProvider.setSettingEntries(cfgDescription, project, null, entries); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Serialize settings + LanguageSettingsProvidersSerializer.serializeLanguageSettings(prjDescription); + // inspect event + assertEquals(1, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNotNull(event); + + assertEquals(project.getName(), event.getProjectName()); + assertEquals(1, event.getConfigurationDescriptionIds().length); + assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); + } + } + + /** + */ + public void testNotification_cfgProvider_SerializeEntriesConcurrent() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + + // add the mock provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider and add to cfgDescription + List providers = new ArrayList(); + providers.add(new MockLanguageSettingsEditableProvider(PROVIDER_1, PROVIDER_NAME_1)); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Change the provider's entries concurrently + + // get project descriptions + ICProjectDescription prjDescription_1 = CoreModel.getDefault().getProjectDescription(project, false); + assertNotNull(prjDescription_1); + ICProjectDescription prjDescription_2 = CoreModel.getDefault().getProjectDescription(project, false); + assertNotNull(prjDescription_2); + { + ICConfigurationDescription[] cfgDescriptions = prjDescription_1.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescriptionWritable = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescriptionWritable.getId(); + + // Add entries + List entries = new ArrayList(); + entries.add(SAMPLE_LSE); + List providers = cfgDescriptionWritable.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + assertTrue(providers.get(0) instanceof MockLanguageSettingsEditableProvider); + MockLanguageSettingsEditableProvider mockProvider = (MockLanguageSettingsEditableProvider) providers.get(0); + mockProvider.setSettingEntries(cfgDescriptionWritable, project, null, entries); + + // reset count + mockLseListener.resetCount(); + assertEquals(0, mockLseListener.getCount()); + assertNull(mockLseListener.getLastEvent()); + + // Serialize settings + LanguageSettingsProvidersSerializer.serializeLanguageSettings(prjDescription_1); + // inspect event + assertEquals(1, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNotNull(event); + + assertEquals(project.getName(), event.getProjectName()); + assertEquals(1, event.getConfigurationDescriptionIds().length); + assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); + } + { + ICConfigurationDescription[] cfgDescriptions = prjDescription_2.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescriptionWritable = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescriptionWritable.getId(); + + // Add same entries + List entries = new ArrayList(); + entries.add(SAMPLE_LSE); + List providers = cfgDescriptionWritable.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + assertTrue(providers.get(0) instanceof MockLanguageSettingsEditableProvider); + MockLanguageSettingsEditableProvider mockProvider = (MockLanguageSettingsEditableProvider) providers.get(0); + mockProvider.setSettingEntries(cfgDescriptionWritable, project, null, entries); + + // reset count + mockLseListener.resetCount(); + assertEquals(0, mockLseListener.getCount()); + assertNull(mockLseListener.getLastEvent()); + + // Serialize settings + LanguageSettingsProvidersSerializer.serializeLanguageSettings(prjDescription_2); + // inspect event + assertEquals(0, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNull(event); + } + } + + /** + */ + public void testNotification_globalProvider_AddEmptyProvider() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + // First clear default providers + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // clear providers + List providers = new ArrayList(); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Add empty global provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // retrieve a global provider + ILanguageSettingsProvider wspProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(wspProvider); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(wspProvider); + assertTrue(rawProvider instanceof MockLanguageSettingsEditableProvider); + // clear it + ((MockLanguageSettingsEditableProvider) rawProvider).clear(); + assertEquals(null, wspProvider.getSettingEntries(cfgDescription, project, null)); + // add the provider to cfgDescription + List providers = new ArrayList(); + providers.add(wspProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // No notifications expected + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + } + + /** + */ + public void testNotification_globalProvider_AddNonEmptyProvider() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + // First clear default providers + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // clear providers + List providers = new ArrayList(); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Add non-empty provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescription.getId(); + + // retrieve a global provider + ILanguageSettingsProvider wspProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(wspProvider); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(wspProvider); + assertTrue(rawProvider instanceof MockLanguageSettingsEditableProvider); + ((MockLanguageSettingsEditableProvider) rawProvider).clear(); + // add entries + List entries = new ArrayList(); + entries.add(SAMPLE_LSE); + ((MockLanguageSettingsEditableProvider) rawProvider).setSettingEntries(cfgDescription, project, null, entries); + assertEquals(SAMPLE_LSE, wspProvider.getSettingEntries(cfgDescription, project, null).get(0)); + // add the provider to cfgDescription + List providers = new ArrayList(); + providers.add(wspProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + + // inspect notifications + assertEquals(1, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNotNull(event); + + assertEquals(project.getName(), event.getProjectName()); + assertEquals(1, event.getConfigurationDescriptionIds().length); + assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); + } + } + + /** + */ + public void testNotification_globalProvider_SerializeEntries() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + + // register mock listener to inspect the notifications + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(mockLseListener); + + // Add empty global provider + { + // get project descriptions + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // retrieve a global provider + ILanguageSettingsProvider wspProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(wspProvider); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(wspProvider); + assertTrue(rawProvider instanceof MockLanguageSettingsEditableProvider); + // clear it + ((MockLanguageSettingsEditableProvider) rawProvider).clear(); + assertEquals(null, wspProvider.getSettingEntries(cfgDescription, project, null)); + // add the provider to cfgDescription + List providers = new ArrayList(); + providers.add(wspProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + } + + // Change the provider's entries + { + // retrieve a global provider + ILanguageSettingsProvider wspProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(wspProvider); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(wspProvider); + assertTrue(rawProvider instanceof MockLanguageSettingsEditableProvider); + ((MockLanguageSettingsEditableProvider) rawProvider).clear(); + // add entries + List entries = new ArrayList(); + entries.add(SAMPLE_LSE); + ((MockLanguageSettingsEditableProvider) rawProvider).setSettingEntries(null, project, null, entries); + assertEquals(SAMPLE_LSE, wspProvider.getSettingEntries(null, project, null).get(0)); + + // reset count + mockLseListener.resetCount(); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Serialize settings + LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace(); + + // get cfgDescriptionId + ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project, false); + assertNotNull(prjDescription); + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescription.getId(); + + // inspect event + assertEquals(1, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNotNull(event); + + assertEquals(project.getName(), event.getProjectName()); + assertEquals(1, event.getConfigurationDescriptionIds().length); + assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); + } + // Change the provider's entries back (bug was found for this case) + { + // retrieve a global provider + ILanguageSettingsProvider wspProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertNotNull(wspProvider); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(wspProvider); + assertTrue(rawProvider instanceof MockLanguageSettingsEditableProvider); + // clear the provider again + ((MockLanguageSettingsEditableProvider) rawProvider).clear(); + + // reset count + mockLseListener.resetCount(); + assertEquals(0, mockLseListener.getCount()); + assertEquals(null, mockLseListener.getLastEvent()); + + // Serialize settings + LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace(); + + // get cfgDescriptionId + ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project, false); + assertNotNull(prjDescription); + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + String cfgDescriptionId = cfgDescription.getId(); + + // inspect event + assertEquals(1, mockLseListener.getCount()); + ILanguageSettingsChangeEvent event = mockLseListener.getLastEvent(); + assertNotNull(event); + + assertEquals(project.getName(), event.getProjectName()); + assertEquals(1, event.getConfigurationDescriptionIds().length); + assertEquals(cfgDescriptionId, event.getConfigurationDescriptionIds()[0]); + } + } +} + diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java new file mode 100644 index 00000000000..71f8fa663e9 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java @@ -0,0 +1,936 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import junit.framework.TestSuite; + +import org.eclipse.cdt.core.AbstractExecutableExtensionBase; +import org.eclipse.cdt.core.dom.ast.gnu.cpp.GPPLanguage; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.CModelMock; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.cdt.internal.core.settings.model.CConfigurationDescription; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.Path; + +/** + * Test cases testing LanguageSettingsProvider functionality + */ +public class LanguageSettingsManagerTests extends BaseTestCase { + // Those should match ids of plugin extensions defined in plugin.xml + private static final String EXTENSION_BASE_PROVIDER_ID = "org.eclipse.cdt.core.tests.language.settings.base.provider"; + private static final String EXTENSION_EDITABLE_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.editable.language.settings.provider"; + private static final String EXTENSION_EDITABLE_PROVIDER_NAME = "Test Plugin Mock Editable Language Settings Provider"; + + private static final IFile FILE_0 = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/project/path0")); + private static final String CFG_ID = "test.configuration.id"; + private static final String LANG_ID = "test.lang.id"; + private static final String LANG_CPP = GPPLanguage.ID; + private static final String PROVIDER_0 = "test.provider.0.id"; + private static final String PROVIDER_1 = "test.provider.1.id"; + private static final String PROVIDER_2 = "test.provider.2.id"; + private static final String PROVIDER_NAME_0 = "test.provider.0.name"; + private static final String PROVIDER_NAME_1 = "test.provider.1.name"; + private static final String PROVIDER_NAME_2 = "test.provider.2.name"; + + class MockConfigurationDescription extends CModelMock.DummyCConfigurationDescription { + List providers = new ArrayList(); + public MockConfigurationDescription(String id) { + super(id); + } + + @Override + public void setLanguageSettingProviders(List providers) { + this.providers = new ArrayList(providers); + } + + @Override + public List getLanguageSettingProviders() { + return providers; + } + } + + private class MockProvider extends AbstractExecutableExtensionBase implements ILanguageSettingsProvider { + private List entries; + + public MockProvider(String id, String name, List entries) { + super(id, name); + this.entries = entries; + } + + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + return entries; + } + } + + + /** + * Constructor. + * @param name - name of the test. + */ + public LanguageSettingsManagerTests(String name) { + super(name); + + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + LanguageSettingsManager.setWorkspaceProviders(null); + super.tearDown(); + } + + /** + * @return - new TestSuite. + */ + public static TestSuite suite() { + return new TestSuite(LanguageSettingsManagerTests.class); + } + + /** + * main function of the class. + * + * @param args - arguments + */ + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + /** + * Test ICConfigurationDescription API (getters and setters). + */ + public void testConfigurationDescription_Providers() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // set providers + ILanguageSettingsProvider provider1 = new MockProvider(PROVIDER_1, PROVIDER_NAME_1, null); + ILanguageSettingsProvider provider2 = new MockProvider(PROVIDER_2, PROVIDER_NAME_2, null); + List providers = new ArrayList(); + providers.add(provider1); + providers.add(provider2); + cfgDescription.setLanguageSettingProviders(providers); + + // get providers + List actual = cfgDescription.getLanguageSettingProviders(); + assertEquals(provider1, actual.get(0)); + assertEquals(provider2, actual.get(1)); + assertEquals(providers.size(), actual.size()); + assertNotSame(actual, providers); + } + + /** + * Test to ensure uniqueness of ids for providers kept in configuration description. + */ + public void testConfigurationDescription_ProvidersUniqueId() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project, true); + + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertTrue(cfgDescription instanceof CConfigurationDescription); + + // attempt to add duplicate providers + MockProvider dupe1 = new MockProvider(PROVIDER_0, PROVIDER_NAME_1, null); + MockProvider dupe2 = new MockProvider(PROVIDER_0, PROVIDER_NAME_2, null); + + List providers = new ArrayList(); + providers.add(dupe1); + providers.add(dupe2); + + try { + cfgDescription.setLanguageSettingProviders(providers); + fail("cfgDescription.setLanguageSettingProviders() should not accept duplicate providers"); + } catch (Exception e) { + // Exception is welcome here + } + } + + /** + * Test various cases of ill-defined providers. + */ + public void testRudeProviders() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + // set impolite provider returning null by getSettingEntries() + ILanguageSettingsProvider providerNull = new MockProvider(PROVIDER_1, PROVIDER_NAME_1, null); + { + List providers = new ArrayList(); + providers.add(providerNull); + cfgDescription.setLanguageSettingProviders(providers); + } + + // use provider returning null, no exception should be recorded + { + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(providerNull, cfgDescription, FILE_0, LANG_ID); + assertNotNull(actual); + assertEquals(0, actual.size()); + } + { + List actual = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, 0); + assertNotNull(actual); + assertEquals(0, actual.size()); + } + + // set impolite provider returning null in getSettingEntries() array + ILanguageSettingsProvider providerNull_2 = new MockProvider(PROVIDER_2, PROVIDER_NAME_2, + new ArrayList() { + { // init via static initializer + add(null); + } + }); + + { + List providers = new ArrayList(); + providers.add(providerNull); + cfgDescription.setLanguageSettingProviders(providers); + } + + // use provider returning null as item in array + { + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(providerNull_2, cfgDescription, FILE_0, LANG_ID); + assertNotNull(actual); + assertEquals(1, actual.size()); + } + { + List actual = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, 0); + assertNotNull(actual); + assertEquals(0, actual.size()); + } + + // use careless provider causing an exception + { + setExpectedNumberOfLoggedNonOKStatusObjects(1); + + ILanguageSettingsProvider providerNPE = new MockProvider(PROVIDER_1, PROVIDER_NAME_1, null) { + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + throw new NullPointerException("Can you handle me?"); + } + }; + try { + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(providerNPE, null, null, LANG_ID); + assertNotNull(actual); + assertEquals(0, actual.size()); + } catch (Throwable e) { + fail("Exceptions are expected to be swallowed (after logging) but got " + e); + } + } + } + + /** + * Test simple use case. + */ + public void testProvider_Basic() throws Exception { + final ICConfigurationDescription modelCfgDescription = new MockConfigurationDescription(CFG_ID); + + final List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + List providers = new ArrayList(); + // define provider returning entries when configuration id matches and null otherwise + ILanguageSettingsProvider providerYes = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, null) { + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (cfgDescription.getId().equals(modelCfgDescription.getId())) { + return entries; + } + return null; + } + + }; + providers.add(providerYes); + // define provider returning entries when configuration id does NOT match and null otherwise + ILanguageSettingsProvider providerNo = new MockProvider(PROVIDER_1, PROVIDER_NAME_1, null) { + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (cfgDescription!= null && !cfgDescription.getId().equals(modelCfgDescription.getId())) { + return entries; + } + return null; + } + + }; + providers.add(providerNo); + modelCfgDescription.setLanguageSettingProviders(providers); + + { + // retrieve the entries with provider returning the given list + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(providerYes, modelCfgDescription, FILE_0, LANG_ID); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + + { + // retrieve the entries with provider returning empty list + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(providerNo, modelCfgDescription, FILE_0, LANG_ID); + assertEquals(0, actual.size()); + } + } + + /** + * Test regular functionality with a few providers. + */ + public void testProvider_Regular() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // create couple of providers + List entries1 = new ArrayList(); + entries1.add(new CIncludePathEntry("value1", 1)); + entries1.add(new CIncludePathEntry("value2", 2)); + + List entries2 = new ArrayList(); + entries2.add(new CIncludePathEntry("value1", 1)); + entries2.add(new CIncludePathEntry("value2", 2)); + entries2.add(new CIncludePathEntry("value3", 2)); + + ILanguageSettingsProvider provider1 = new MockProvider(PROVIDER_1, PROVIDER_NAME_1, entries1); + ILanguageSettingsProvider provider2 = new MockProvider(PROVIDER_2, PROVIDER_NAME_2, entries2); + List providers = new ArrayList(); + providers.add(provider1); + providers.add(provider2); + cfgDescription.setLanguageSettingProviders(providers); + + { + // retrieve the entries for provider-1 + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(provider1, cfgDescription, FILE_0, LANG_ID); + assertNotSame(entries1, actual); + + ICLanguageSettingEntry[] entriesArray = entries1.toArray(new ICLanguageSettingEntry[0]); + ICLanguageSettingEntry[] actualArray = actual.toArray(new ICLanguageSettingEntry[0]); + for (int i=0;i entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List providers = new ArrayList(); + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, null) { + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (rc!=null && rc.equals(parentFolder)) { + return entries; + } + if (rc!=null && rc.equals(emptySettingsPath)) { + return new ArrayList(0); + } + return null; + } + + }; + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + { + // retrieve entries for a derived resource (in a subfolder) + IFile derived = ResourceHelper.createFile(project, "/ParentFolder/Subfolder/resource"); + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(provider, cfgDescription, derived, LANG_ID); + // taken from parent folder + assertEquals(entries.get(0),actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + + { + // retrieve entries for not related resource + IFile notRelated = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/AnotherFolder/Subfolder/resource")); + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(provider, cfgDescription, notRelated, LANG_ID); + assertEquals(0, actual.size()); + } + + { + // test distinction between no settings and empty settings + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(provider, cfgDescription, emptySettingsPath, LANG_ID); + // NOT taken from parent folder + assertEquals(0, actual.size()); + } + } + + /** + */ + public void testProvider_DefaultEntries() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project); + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertTrue(cfgDescription instanceof CConfigurationDescription); + + final IFolder parentFolder = ResourceHelper.createFolder(project, "/ParentFolder/"); + assertNotNull(parentFolder); + final IFile emptySettingsPath = ResourceHelper.createFile(project, "/ParentFolder/Subfolder/empty"); + assertNotNull(emptySettingsPath); + + // store the entries as default entries + final List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List providers = new ArrayList(); + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, null) { + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (cfgDescription==null && rc==null) { + return entries; + } + return null; + } + + }; + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + { + // retrieve entries for a resource + IFile derived = ResourceHelper.createFile(project, "/ParentFolder/Subfolder/resource"); + List actual = LanguageSettingsManager + .getSettingEntriesUpResourceTree(provider, cfgDescription, derived, LANG_ID); + // default entries given + assertEquals(entries.get(0),actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + * Test ability to get entries by kind. + */ + public void testEntriesByKind_Regular() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // contribute the entries + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + entries.add(new CMacroEntry("MACRO0", "value0",0)); + entries.add(new CIncludePathEntry("path1", 0)); + entries.add(new CMacroEntry("MACRO1", "value1",0)); + entries.add(new CIncludePathEntry("path2", 0)); + + ILanguageSettingsProvider provider0 = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, entries); + List providers = new ArrayList(); + providers.add(provider0); + cfgDescription.setLanguageSettingProviders(providers); + + // retrieve entries by kind + List includes = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + assertEquals(new CIncludePathEntry("path0", 0),includes.get(0)); + assertEquals(new CIncludePathEntry("path1", 0),includes.get(1)); + assertEquals(new CIncludePathEntry("path2", 0),includes.get(2)); + assertEquals(3, includes.size()); + + List macros = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.MACRO); + assertEquals(new CMacroEntry("MACRO0", "value0",0), macros.get(0)); + assertEquals(new CMacroEntry("MACRO1", "value1",0), macros.get(1)); + assertEquals(2, macros.size()); + } + + /** + * Test how conflicting entries are resolved. + */ + public void testEntriesByKind_ConflictingEntries() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // contribute the entries + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path", ICSettingEntry.BUILTIN)); + entries.add(new CIncludePathEntry("path", ICSettingEntry.UNDEFINED)); + entries.add(new CIncludePathEntry("path", 0)); + + ILanguageSettingsProvider provider0 = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, entries); + List providers = new ArrayList(); + providers.add(provider0); + cfgDescription.setLanguageSettingProviders(providers); + + // retrieve entries by kind, only first entry should be returned + List includes = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + assertEquals(1, includes.size()); + assertEquals(entries.get(0),includes.get(0)); + } + + /** + * Check handling of {@link ICSettingEntry#UNDEFINED} flag. + */ + public void testEntriesByKind_Undefined() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // contribute the entries + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path", ICSettingEntry.UNDEFINED)); + entries.add(new CIncludePathEntry("path", 0)); + + ILanguageSettingsProvider provider0 = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, entries); + List providers = new ArrayList(); + providers.add(provider0); + cfgDescription.setLanguageSettingProviders(providers); + + // retrieve entries by kind, no entries should be returned + List includes = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + assertEquals(0, includes.size()); + } + + /** + * Check handling of local vs. system entries, see {@link ICSettingEntry#LOCAL} flag. + */ + public void testEntriesByKind_LocalAndSystem() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // contribute the entries + List entries = new ArrayList(); + CIncludePathEntry localIncludeEntry = new CIncludePathEntry("path-local", ICSettingEntry.LOCAL); + CIncludePathEntry systemIncludeEntry = new CIncludePathEntry("path-system", 0); + entries.add(localIncludeEntry); + entries.add(systemIncludeEntry); + + ILanguageSettingsProvider provider0 = new MockProvider(PROVIDER_0, PROVIDER_NAME_0, entries); + List providers = new ArrayList(); + providers.add(provider0); + cfgDescription.setLanguageSettingProviders(providers); + + { + // retrieve local entries + List includes = LanguageSettingsProvidersSerializer + .getLocalSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + assertEquals(localIncludeEntry, includes.get(0)); + assertEquals(1, includes.size()); + } + + { + // retrieve system entries + List includes = LanguageSettingsProvidersSerializer + .getSystemSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + assertEquals(systemIncludeEntry, includes.get(0)); + assertEquals(1, includes.size()); + } + + { + // retrieve both local and system + List includes = LanguageSettingsProvidersSerializer + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + assertEquals(entries.get(0), includes.get(0)); + assertEquals(entries.get(1), includes.get(1)); + assertEquals(2, includes.size()); + } + } + + /** + * Test conflicting entries contributed by different providers. + */ + public void testEntriesByKind_ConflictingProviders() throws Exception { + ICConfigurationDescription cfgDescription = new MockConfigurationDescription(CFG_ID); + + // contribute the entries + List providers = new ArrayList(); + + // contribute the higher ranked entries + List entriesHigh = new ArrayList(); + entriesHigh.add(new CIncludePathEntry("path0", ICSettingEntry.RESOLVED)); + entriesHigh.add(new CIncludePathEntry("path1", 0)); + entriesHigh.add(new CIncludePathEntry("path2", ICSettingEntry.UNDEFINED)); + ILanguageSettingsProvider highRankProvider = new MockProvider(PROVIDER_2, PROVIDER_NAME_2, entriesHigh); + providers.add(highRankProvider); + + // contribute the lower ranked entries + List entriesLow = new ArrayList(); + entriesLow.add(new CIncludePathEntry("path0", ICSettingEntry.BUILTIN)); + entriesLow.add(new CIncludePathEntry("path1", ICSettingEntry.UNDEFINED)); + entriesLow.add(new CIncludePathEntry("path2", 0)); + entriesLow.add(new CIncludePathEntry("path3", 0)); + ILanguageSettingsProvider lowRankProvider = new MockProvider(PROVIDER_1, PROVIDER_NAME_1, entriesLow); + providers.add(lowRankProvider); + + cfgDescription.setLanguageSettingProviders(providers); + + // retrieve entries by kind + List includes = LanguageSettingsManager + .getSettingEntriesByKind(cfgDescription, FILE_0, LANG_ID, ICSettingEntry.INCLUDE_PATH); + // path0 is taken from higher priority provider + assertEquals(entriesHigh.get(0),includes.get(0)); + // path1 disablement by lower priority provider is ignored + assertEquals(entriesHigh.get(1),includes.get(1)); + // path2 is removed because of DISABLED flag of high priority provider + // path3 gets there from low priority provider + assertEquals(entriesLow.get(3),includes.get(2)); + assertEquals(3, includes.size()); + } + + /** + * Test ability to serialize providers for a configuration. + */ + public void testConfigurationDescription_SerializeProviders() throws Exception { + // Create model project and accompanied descriptions + String projectName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(projectName); + ICProjectDescription writableProjDescription = CoreModel.getDefault().getProjectDescription(project, true); + + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertTrue(cfgDescription instanceof CConfigurationDescription); + + ILanguageSettingsProvider workspaceProvider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_BASE_PROVIDER_ID); + assertNotNull(workspaceProvider); + { + // ensure no test provider is set yet + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + } + { + // set test provider + List providers = new ArrayList(); + providers.add(workspaceProvider); + cfgDescription.setLanguageSettingProviders(providers); + } + { + // check that test provider got there + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(workspaceProvider, providers.get(0)); + } + + { + // serialize + CoreModel.getDefault().setProjectDescription(project, writableProjDescription); + // close and reopen the project + project.close(null); + project.open(null); + } + + { + // check that test provider got loaded + ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project); + ICConfigurationDescription[] loadedCfgDescriptions = prjDescription.getConfigurations(); + ICConfigurationDescription loadedCfgDescription = loadedCfgDescriptions[0]; + assertTrue(cfgDescription instanceof CConfigurationDescription); + + List loadedProviders = loadedCfgDescription.getLanguageSettingProviders(); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(loadedProviders.get(0))); + } + + } + + /** + * Test a workspace provider basics. + */ + public void testWorkspaceProvider_Basic() throws Exception { + // get workspace provider + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertEquals(EXTENSION_EDITABLE_PROVIDER_ID, provider.getId()); + assertEquals(EXTENSION_EDITABLE_PROVIDER_NAME, provider.getName()); + + // get raw provider + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + assertEquals(EXTENSION_EDITABLE_PROVIDER_ID, rawProvider.getId()); + assertEquals(EXTENSION_EDITABLE_PROVIDER_NAME, rawProvider.getName()); + assertTrue(rawProvider instanceof LanguageSettingsSerializable); + // assert they are not the same object + assertNotSame(provider, rawProvider); + + { + // make sure entries are the same + List entries = provider.getSettingEntries(null, null, null); + assertEquals(1, entries.size()); // defined in the extension + List rawEntries = rawProvider.getSettingEntries(null, null, null); + assertEquals(entries, rawEntries); + } + + { + // set new entries to the raw provider + List newEntries = new ArrayList(); + newEntries.add(new CIncludePathEntry("path0", 0)); + newEntries.add(new CIncludePathEntry("path1", 0)); + ((LanguageSettingsSerializable)rawProvider).setSettingEntries(null, null, null, newEntries); + + // check that the workspace provider gets them too + List newRawEntries = rawProvider.getSettingEntries(null, null, null); + assertEquals(newEntries, newRawEntries); + assertEquals(2, newEntries.size()); + } + } + + /** + * Test workspace providers equality. + */ + public void testWorkspaceProvider_Equals() throws Exception { + ILanguageSettingsProvider providerA = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + ILanguageSettingsProvider providerB = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + assertEquals(providerA, providerB); + } + + /** + * Test ability to replace underlying raw provider. + */ + public void testWorkspaceProvider_ReplaceRawProvider() throws Exception { + // get sample workspace provider + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + { + // check on its entries + List entries = provider.getSettingEntries(null, null, null); + assertEquals(1, entries.size()); // defined in the extension + } + + // define new entries for the raw provider + List newEntries = new ArrayList(); + newEntries.add(new CIncludePathEntry("path0", 0)); + newEntries.add(new CIncludePathEntry("path1", 0)); + newEntries.add(new CIncludePathEntry("path2", 0)); + + { + // replace raw provider + List providers = new ArrayList(); + LanguageSettingsSerializable newRawProvider = new LanguageSettingsSerializable(EXTENSION_EDITABLE_PROVIDER_ID, PROVIDER_NAME_0); + newRawProvider.setSettingEntries(null, null, null, newEntries); + providers.add(newRawProvider); + LanguageSettingsManager.setWorkspaceProviders(providers); + } + + { + // check that provider provides the new entries + List entries = provider.getSettingEntries(null, null, null); + assertEquals(newEntries.size(), entries.size()); + assertEquals(newEntries, entries); + } + } + + /** + * Test ability to be called with workspace provider as well (NOOP). + */ + public void testWorkspaceProvider_ReplaceWithWorkspaceProvider() throws Exception { + // get sample workspace provider + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_EDITABLE_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + assertNotSame(provider, rawProvider); + + // attempt to "replace" with workspace provider (which is a wrapper around raw provider), should be NOOP + List providers = new ArrayList(); + providers.add(provider); + LanguageSettingsManager.setWorkspaceProviders(providers); + ILanguageSettingsProvider newRawProvider = LanguageSettingsManager.getRawProvider(provider); + assertSame(rawProvider, newRawProvider); + + // check for no side effect + assertSame(provider, providers.get(0)); + } + + /** + */ + public void testBuildResourceTree_FileInFolder() throws Exception { + // sample entries + CMacroEntry entry = new CMacroEntry("MACRO", null, 0); + List entries = new ArrayList(); + entries.add(entry); + + // create resources + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + IFile file = ResourceHelper.createFile(project, "file.cpp"); + assertNotNull(file); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, file, null, entries); + // build the hierarchy + LanguageSettingsProvidersSerializer.buildResourceTree(provider, null, null, project); + + // check that entries go to highest possible level + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file, null)); + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, project, null)); + } + + /** + */ + public void testBuildResourceTree_FileInSubFolder() throws Exception { + // sample entries + CMacroEntry entry = new CMacroEntry("MACRO", null, 0); + List entries = new ArrayList(); + entries.add(entry); + + // create resources + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + IFolder folder = ResourceHelper.createFolder(project, "Folder"); + IFile file = ResourceHelper.createFile(project, "Folder/file.cpp"); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, file, null, entries); + // build the hierarchy + LanguageSettingsManager.buildResourceTree(provider, null, null, project); + + // check that entries go to highest possible level + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file, null)); + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, folder, null)); + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, project, null)); + } + + /** + */ + public void testBuildResourceTree_TwoSubFolders() throws Exception { + // sample entries + List entries1 = new ArrayList(); + entries1.add(new CMacroEntry("MACRO_1", null, 0)); + List entries2 = new ArrayList(); + entries2.add(new CMacroEntry("MACRO_2", null, 0)); + + // create resources + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + IFolder folder1 = ResourceHelper.createFolder(project, "Folder1"); + IFolder folder2 = ResourceHelper.createFolder(project, "Folder2"); + IFile file1 = ResourceHelper.createFile(project, "Folder1/file1.cpp"); + IFile file2 = ResourceHelper.createFile(project, "Folder2/file2.cpp"); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, file1, null, entries1); + provider.setSettingEntries(null, file2, null, entries2); + // build the hierarchy + LanguageSettingsManager.buildResourceTree(provider, null, null, project); + + // check that entries go to highest possible level + assertEquals(entries1, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file1, null)); + assertEquals(entries1, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, folder1, null)); + + assertEquals(entries2, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file2, null)); + assertEquals(entries2, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, folder2, null)); + + assertEquals(0, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, project, null).size()); + } + + /** + */ + public void testBuildResourceTree_FlippingSettings() throws Exception { + // sample entries + List entries1 = new ArrayList(); + entries1.add(new CMacroEntry("MACRO_1", null, 0)); + List entries2 = new ArrayList(); + entries2.add(new CMacroEntry("MACRO_2", null, 0)); + + // create resources + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + IFile file1 = ResourceHelper.createFile(project, "file1.cpp"); + IFile file2 = ResourceHelper.createFile(project, "file2.cpp"); + IFile file3 = ResourceHelper.createFile(project, "file3.cpp"); + + // create a provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + + // set the entries for the first 2 files + provider.setSettingEntries(null, file1, null, entries1); + provider.setSettingEntries(null, file2, null, entries1); + // build the hierarchy + LanguageSettingsManager.buildResourceTree(provider, null, null, project); + // double-check where the entries go + assertEquals(entries1, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file1, null)); + assertEquals(entries1, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file2, null)); + assertEquals(entries1, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, project, null)); + + // set the entries for the second+third files (second file flips the settings) + provider.setSettingEntries(null, file2, null, entries2); + provider.setSettingEntries(null, file3, null, entries2); + // build the hierarchy + LanguageSettingsManager.buildResourceTree(provider, null, null, project); + // check where the entries go, it should not lose entries for the first file + assertEquals(entries1, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file1, null)); + assertEquals(entries2, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file2, null)); + assertEquals(entries2, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file3, null)); + assertEquals(entries2, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, project, null)); + } + + /** + */ + public void testBuildResourceTree_WithLanguage() throws Exception { + // sample entries + CMacroEntry entry = new CMacroEntry("MACRO", null, 0); + List entries = new ArrayList(); + entries.add(entry); + + // create resources + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + IFolder folder = ResourceHelper.createFolder(project, "Folder"); + IFile file = ResourceHelper.createFile(project, "Folder/file.cpp"); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, file, LANG_CPP, entries); + // build the hierarchy + LanguageSettingsManager.buildResourceTree(provider, null, LANG_CPP, project); + + // check that entries go to highest possible level + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, file, LANG_CPP)); + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, folder, LANG_CPP)); + assertEquals(entries, LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, null, project, LANG_CPP)); + } + +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsPersistenceProjectTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsPersistenceProjectTests.java new file mode 100644 index 00000000000..90406f5e144 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsPersistenceProjectTests.java @@ -0,0 +1,1207 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import junit.framework.TestSuite; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager; +import org.eclipse.cdt.core.settings.model.WriteAccessException; +import org.eclipse.cdt.core.testplugin.CModelMock; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.cdt.internal.core.settings.model.CProjectDescriptionManager; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.runtime.IPath; +import org.w3c.dom.Document; +import org.w3c.dom.Element; + +/** + * Test cases testing LanguageSettingsProvider functionality + */ +public class LanguageSettingsPersistenceProjectTests extends BaseTestCase { + private static final String LANGUAGE_SETTINGS_PROJECT_XML = ".settings/language.settings.xml"; + private static final String LANGUAGE_SETTINGS_WORKSPACE_XML = "language.settings.xml"; + // Should match extension points defined in plugin.xml + private static final String EXTENSION_PROVIDER_ID = "org.eclipse.cdt.core.tests.language.settings.base.provider.subclass"; + private static final String EXTENSION_PROVIDER_NAME = "Test Plugin Mock Base Provider Subclass"; + private static final String EXTENSION_SERIALIZABLE_PROVIDER_ID = "org.eclipse.cdt.core.tests.custom.serializable.language.settings.provider"; + + private static final String CFG_ID = "test.configuration.id.0"; + private static final String CFG_ID_2 = "test.configuration.id.2"; + private static final String PROVIDER_0 = "test.provider.0.id"; + private static final String PROVIDER_2 = "test.provider.2.id"; + private static final String PROVIDER_NAME_0 = "test.provider.0.name"; + private static final String PROVIDER_NAME_2 = "test.provider.2.name"; + private static final String PROVIDER_ID_WSP = "test.provider.workspace.id"; + private static final String PROVIDER_NAME_WSP = "test.provider.workspace.name"; + private static final String CUSTOM_PARAMETER = "custom parameter"; + private static final String ELEM_TEST = "test"; + + private static CoreModel coreModel = CoreModel.getDefault(); + + class MockConfigurationDescription extends CModelMock.DummyCConfigurationDescription { + List providers; + public MockConfigurationDescription(String id) { + super(id); + } + + @Override + public void setLanguageSettingProviders(List providers) { + this.providers = new ArrayList(providers); + } + + @Override + public List getLanguageSettingProviders() { + return providers; + } + } + class MockProjectDescription extends CModelMock.DummyCProjectDescription { + ICConfigurationDescription[] cfgDescriptions; + + public MockProjectDescription(ICConfigurationDescription[] cfgDescriptions) { + this.cfgDescriptions = cfgDescriptions; + } + + public MockProjectDescription(ICConfigurationDescription cfgDescription) { + this.cfgDescriptions = new ICConfigurationDescription[] { cfgDescription }; + } + + @Override + public ICConfigurationDescription[] getConfigurations() { + return cfgDescriptions; + + } + + @Override + public ICConfigurationDescription getConfigurationById(String id) { + for (ICConfigurationDescription cfgDescription : cfgDescriptions) { + if (cfgDescription.getId().equals(id)) + return cfgDescription; + } + return null; + } + } + + private class MockEditableProvider extends LanguageSettingsSerializable implements ILanguageSettingsEditableProvider { + public MockEditableProvider(String id, String name) { + super(id, name); + } + @Override + public MockEditableProvider cloneShallow() throws CloneNotSupportedException { + return (MockEditableProvider) super.cloneShallow(); + } + @Override + public MockEditableProvider clone() throws CloneNotSupportedException { + return (MockEditableProvider) super.clone(); + } + } + + /** + * Constructor. + * @param name - name of the test. + */ + public LanguageSettingsPersistenceProjectTests(String name) { + super(name); + + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + LanguageSettingsManager.setWorkspaceProviders(null); + super.tearDown(); + } + + /** + * @return - new TestSuite. + */ + public static TestSuite suite() { + return new TestSuite(LanguageSettingsPersistenceProjectTests.class); + } + + /** + * main function of the class. + * + * @param args - arguments + */ + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + private ICConfigurationDescription[] getConfigurationDescriptions(IProject project) { + ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager(); + // project description + ICProjectDescription projectDescription = mngr.getProjectDescription(project); + assertNotNull(projectDescription); + assertEquals(1, projectDescription.getConfigurations().length); + // configuration description + ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + return cfgDescriptions; + } + + private ICConfigurationDescription getFirstConfigurationDescription(IProject project) { + ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project); + + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + return cfgDescription; + } + + /** + */ + public void testNoProviders() throws Exception { + // serialize language settings of user defined providers (on workspace level) + LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace(); + LanguageSettingsProvidersSerializer.loadLanguageSettingsWorkspace(); + + // test passes if no exception was thrown + } + + /** + */ + public void testProjectDescription_PreventBackDoorAccess() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + + // get project descriptions + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + List originalProviders = cfgDescription.getLanguageSettingProviders(); + int originalSize = originalProviders.size(); + + // create new provider list + LanguageSettingsSerializable mockProvider = new MockEditableProvider(PROVIDER_0, PROVIDER_NAME_0); + List providers = new ArrayList(originalProviders); + providers.add(mockProvider); + assertTrue(originalSize != providers.size()); + + // changing providers shouldn't affect the original list + cfgDescription.setLanguageSettingProviders(providers); + assertEquals(originalSize, originalProviders.size()); + } + + /** + */ + public void testProjectDescription_ReadWriteProviders() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + + { + // get read-only description + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, false); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // try to write to it + try { + List providers = new ArrayList(); + cfgDescription.setLanguageSettingProviders(providers); + fail("WriteAccessException was expected but it was not throw."); + } catch (WriteAccessException e) { + // exception is expected + } + } + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // get project descriptions + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider + LanguageSettingsSerializable mockProvider = new MockEditableProvider(PROVIDER_0, PROVIDER_NAME_0); + mockProvider.setStoringEntriesInProjectArea(true); + mockProvider.setSettingEntries(cfgDescription, null, null, entries); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // apply new project description to the project model + coreModel.setProjectDescription(project, writableProjDescription); + } + { + // get read-only project descriptions + ICProjectDescription readOnlyProjDescription = coreModel.getProjectDescription(project, false); + assertNotNull(readOnlyProjDescription); + ICConfigurationDescription[] cfgDescriptions = readOnlyProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + ILanguageSettingsProvider loadedProvider = providers.get(0); + assertTrue(loadedProvider instanceof LanguageSettingsSerializable); + assertEquals(PROVIDER_0, loadedProvider.getId()); + assertEquals(PROVIDER_NAME_0, loadedProvider.getName()); + + List actual = loadedProvider.getSettingEntries(cfgDescription, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + { + // get writable project descriptions + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + ILanguageSettingsProvider loadedProvider = providers.get(0); + assertTrue(loadedProvider instanceof LanguageSettingsSerializable); + assertEquals(PROVIDER_0, loadedProvider.getId()); + assertEquals(PROVIDER_NAME_0, loadedProvider.getName()); + + List actual = loadedProvider.getSettingEntries(cfgDescription, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + */ + public void testWorkspacePersistence_ModifiedExtensionProvider() throws Exception { + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // get the raw extension provider + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + LanguageSettingsSerializable extProvider = (LanguageSettingsSerializable) LanguageSettingsManager.getRawProvider(provider); + assertNotNull(extProvider); + assertEquals(EXTENSION_SERIALIZABLE_PROVIDER_ID, extProvider.getId()); + + // add entries + extProvider.setSettingEntries(null, null, null, entries); + List actual = extProvider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + + // serialize language settings of workspace providers + LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace(); + + // clear the provider + extProvider.setSettingEntries(null, null, null, null); + } + + { + // doublecheck it's clean + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + List actual = provider.getSettingEntries(null, null, null); + assertNull(actual); + } + { + // re-load and check language settings of the provider + LanguageSettingsProvidersSerializer.loadLanguageSettingsWorkspace(); + + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + assertEquals(EXTENSION_SERIALIZABLE_PROVIDER_ID, provider.getId()); + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + */ + public void testWorkspacePersistence_GlobalProvider() throws Exception { + { + // get the raw extension provider + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + LanguageSettingsSerializable rawProvider = (LanguageSettingsSerializable) LanguageSettingsManager.getRawProvider(provider); + assertNotNull(rawProvider); + assertEquals(EXTENSION_SERIALIZABLE_PROVIDER_ID, rawProvider.getId()); + + // customize provider + rawProvider.setCustomParameter(CUSTOM_PARAMETER); + assertEquals(CUSTOM_PARAMETER, rawProvider.getCustomParameter()); + } + { + // save workspace provider (as opposed to raw provider) + List providers = new ArrayList(); + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + providers.add(provider); + LanguageSettingsManager.setWorkspaceProviders(providers); + } + { + // check that it has not cleared + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_SERIALIZABLE_PROVIDER_ID); + LanguageSettingsSerializable rawProvider = (LanguageSettingsSerializable) LanguageSettingsManager.getRawProvider(provider); + assertEquals(CUSTOM_PARAMETER, rawProvider.getCustomParameter()); + } + } + + /** + */ + public void testWorkspacePersistence_ShadowedExtensionProvider() throws Exception { + { + // get the raw extension provider + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + // confirm its type and name + assertTrue(rawProvider instanceof LanguageSettingsBaseProvider); + assertEquals(EXTENSION_PROVIDER_ID, rawProvider.getId()); + assertEquals(EXTENSION_PROVIDER_NAME, rawProvider.getName()); + } + { + // replace extension provider + ILanguageSettingsProvider provider = new MockLanguageSettingsSerializableProvider(EXTENSION_PROVIDER_ID, PROVIDER_NAME_0); + List providers = new ArrayList(); + providers.add(provider); + // note that this will also serialize workspace providers + LanguageSettingsManager.setWorkspaceProviders(providers); + } + { + // doublecheck it's in the list + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + assertTrue(rawProvider instanceof MockLanguageSettingsSerializableProvider); + assertEquals(EXTENSION_PROVIDER_ID, rawProvider.getId()); + assertEquals(PROVIDER_NAME_0, rawProvider.getName()); + } + + { + // re-load to check serialization + LanguageSettingsProvidersSerializer.loadLanguageSettingsWorkspace(); + + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + assertTrue(rawProvider instanceof MockLanguageSettingsSerializableProvider); + assertEquals(EXTENSION_PROVIDER_ID, rawProvider.getId()); + assertEquals(PROVIDER_NAME_0, rawProvider.getName()); + } + + { + // reset workspace providers, that will also serialize + LanguageSettingsManager.setWorkspaceProviders(null); + } + { + // doublecheck original one is in the list + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + assertTrue(rawProvider instanceof LanguageSettingsBaseProvider); + assertEquals(EXTENSION_PROVIDER_ID, rawProvider.getId()); + assertEquals(EXTENSION_PROVIDER_NAME, rawProvider.getName()); + } + { + // re-load to check serialization + LanguageSettingsProvidersSerializer.loadLanguageSettingsWorkspace(); + + ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + assertTrue(rawProvider instanceof LanguageSettingsBaseProvider); + assertEquals(EXTENSION_PROVIDER_ID, rawProvider.getId()); + assertEquals(EXTENSION_PROVIDER_NAME, rawProvider.getName()); + } + } + + /** + */ + public void testProjectPersistence_SerializableProviderDOM() throws Exception { + Element rootElement = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // create a provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + LanguageSettingsSerializable serializableProvider = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + serializableProvider.setSettingEntries(null, null, null, entries); + serializableProvider.setStoringEntriesInProjectArea(true); + + ArrayList providers = new ArrayList(); + providers.add(serializableProvider); + cfgDescription.setLanguageSettingProviders(providers); + + // prepare DOM storage + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(rootElement, null, mockPrjDescription); + } + { + // re-load and check language settings of the newly loaded provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(rootElement, null, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + List providers = cfgDescription.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertTrue(provider instanceof LanguageSettingsSerializable); + + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + */ + public void testProjectPersistence_TwoConfigurationsDOM() throws Exception { + Element rootElement = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List entries2 = new ArrayList(); + entries2.add(new CIncludePathEntry("path2", 0)); + + { + // create a project description with 2 configuration descriptions + MockProjectDescription mockPrjDescription = new MockProjectDescription( + new MockConfigurationDescription[] { + new MockConfigurationDescription(CFG_ID), + new MockConfigurationDescription(CFG_ID_2), + }); + { + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(2, cfgDescriptions.length); + { + // populate configuration 1 with provider + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + assertNotNull(cfgDescription1); + assertEquals(CFG_ID, cfgDescription1.getId()); + LanguageSettingsSerializable provider1 = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + provider1.setStoringEntriesInProjectArea(true); + provider1.setSettingEntries(null, null, null, entries); + ArrayList providers = new ArrayList(); + providers.add(provider1); + cfgDescription1.setLanguageSettingProviders(providers); + } + { + // populate configuration 2 with provider + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + assertNotNull(cfgDescription2); + assertEquals(CFG_ID_2, cfgDescription2.getId()); + LanguageSettingsSerializable provider2 = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + provider2.setStoringEntriesInProjectArea(true); + provider2.setSettingEntries(null, null, null, entries2); + ArrayList providers = new ArrayList(); + providers.add(provider2); + cfgDescription2.setLanguageSettingProviders(providers); + } + } + + { + // doublecheck both configuration descriptions + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(2, cfgDescriptions.length); + { + // doublecheck configuration 1 + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + assertNotNull(cfgDescription1); + List providers = cfgDescription1.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertNotNull(provider); + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + { + // doublecheck configuration 2 + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + assertNotNull(cfgDescription2); + List providers = cfgDescription2.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertNotNull(provider); + List actual2 = provider.getSettingEntries(null, null, null); + assertEquals(entries2.get(0), actual2.get(0)); + assertEquals(entries2.size(), actual2.size()); + } + } + + // prepare DOM storage + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(rootElement, null, mockPrjDescription); + } + { + // re-create a project description and re-load language settings for each configuration + MockProjectDescription mockPrjDescription = new MockProjectDescription( + new MockConfigurationDescription[] { + new MockConfigurationDescription(CFG_ID), + new MockConfigurationDescription(CFG_ID_2), + }); + // load + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(rootElement, null, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(2, cfgDescriptions.length); + { + // check configuration 1 + ICConfigurationDescription cfgDescription1 = cfgDescriptions[0]; + assertNotNull(cfgDescription1); + List providers = cfgDescription1.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertNotNull(provider); + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + { + // check configuration 2 + ICConfigurationDescription cfgDescription2 = cfgDescriptions[1]; + assertNotNull(cfgDescription2); + List providers = cfgDescription2.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertNotNull(provider); + List actual2 = provider.getSettingEntries(null, null, null); + assertEquals(entries2.get(0), actual2.get(0)); + assertEquals(entries2.size(), actual2.size()); + } + } + } + + /** + */ + public void testProjectPersistence_SubclassedSerializableProviderDOM() throws Exception { + Element rootElement = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // create a provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + LanguageSettingsSerializable serializableProvider = new MockLanguageSettingsSerializableProvider(PROVIDER_0, PROVIDER_NAME_0); + serializableProvider.setSettingEntries(null, null, null, entries); + serializableProvider.setStoringEntriesInProjectArea(true); + + ArrayList providers = new ArrayList(); + providers.add(serializableProvider); + cfgDescription.setLanguageSettingProviders(providers); + + // prepare DOM storage + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(rootElement, null, mockPrjDescription); + } + { + // re-load and check language settings of the newly loaded provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(rootElement, null, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + List providers = cfgDescription.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertTrue(provider instanceof MockLanguageSettingsSerializableProvider); + + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + */ + public void testProjectPersistence_ReferenceExtensionProviderDOM() throws Exception { + Element rootElement = null; + + // provider of other type (not LanguageSettingsSerializable) defined as an extension + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + + { + // create cfg description + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + // populate with provider defined as extension + List providers = new ArrayList(); + providers.add(providerExt); + cfgDescription.setLanguageSettingProviders(providers); + + // prepare DOM storage + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(rootElement, null, mockPrjDescription); + } + { + // re-load + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(rootElement, null, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + // and check the newly loaded provider which should be workspace provider + List providers = cfgDescription.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertNotNull(provider); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(provider)); + } + } + + /** + */ + public void testProjectPersistence_OverrideExtensionProviderDOM() throws Exception { + Element rootElement = null; + + // provider set on workspace level overriding an extension + String idExt = EXTENSION_PROVIDER_ID; + ILanguageSettingsProvider providerExt = LanguageSettingsManager.getWorkspaceProvider(idExt); + assertNotNull(providerExt); + { + // create cfg description + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + // populate with provider overriding the extension (must be SerializableLanguageSettingsProvider or a class from another extension) + MockLanguageSettingsSerializableProvider providerOverride = new MockLanguageSettingsSerializableProvider(idExt, PROVIDER_NAME_0); + providerOverride.setStoringEntriesInProjectArea(true); + List providers = new ArrayList(); + providers.add(providerOverride); + cfgDescription.setLanguageSettingProviders(providers); + + + // prepare DOM storage + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(rootElement, null, mockPrjDescription); + } + { + // re-load + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(rootElement, null, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + // check the newly loaded provider + List providers = cfgDescription.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertNotNull(provider); + assertTrue(provider instanceof MockLanguageSettingsSerializableProvider); + assertEquals(idExt, provider.getId()); + assertEquals(PROVIDER_NAME_0, provider.getName()); + } + } + + + /** + */ + public void testProjectPersistence_MixedProvidersDOM() throws Exception { + Element rootElement = null; + + List entries_31 = new ArrayList(); + entries_31.add(new CIncludePathEntry("path0", 0)); + + List entries_32 = new ArrayList(); + entries_32.add(new CIncludePathEntry("path2", 0)); + + ILanguageSettingsProvider providerExt; + ILanguageSettingsProvider providerWsp; + { + // Define providers a bunch + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + { + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + // 1. Provider reference to extension from plugin.xml + providerExt = LanguageSettingsManager.getWorkspaceProvider(EXTENSION_PROVIDER_ID); + + // 2. TODO Provider reference to provider defined in the project + + // 3. Providers defined in a configuration + // 3.1 + LanguageSettingsSerializable mockProvider1 = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + mockProvider1.setStoringEntriesInProjectArea(true); + mockProvider1.setSettingEntries(null, null, null, entries_31); + // 3.2 + LanguageSettingsSerializable mockProvider2 = new MockLanguageSettingsSerializableProvider(PROVIDER_2, PROVIDER_NAME_2); + mockProvider2.setStoringEntriesInProjectArea(true); + mockProvider2.setSettingEntries(null, null, null, entries_32); + + ArrayList providers = new ArrayList(); + providers.add(providerExt); + providers.add(mockProvider1); + providers.add(mockProvider2); + cfgDescription.setLanguageSettingProviders(providers); + } + + // prepare DOM storage + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(rootElement, null, mockPrjDescription); + XmlUtil.toString(doc); + } + { + // re-load and check language settings of the newly loaded provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(rootElement, null, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + List providers = cfgDescription.getLanguageSettingProviders(); + assertNotNull(providers); + // 1. Provider reference to extension from plugin.xml + ILanguageSettingsProvider provider0 = providers.get(0); + assertTrue(LanguageSettingsManager.isWorkspaceProvider(provider0)); + + // 2. TODO Provider reference to provider defined in the project + + // 3. Providers defined in a configuration + // 3.1 + { + ILanguageSettingsProvider provider1 = providers.get(1); + assertTrue(provider1 instanceof LanguageSettingsSerializable); + List actual = provider1.getSettingEntries(null, null, null); + assertEquals(entries_31.get(0), actual.get(0)); + assertEquals(entries_31.size(), actual.size()); + } + // 3.2 + { + ILanguageSettingsProvider provider2 = providers.get(2); + assertTrue(provider2 instanceof MockLanguageSettingsSerializableProvider); + List actual = provider2.getSettingEntries(null, null, null); + assertEquals(entries_32.get(0), actual.get(0)); + assertEquals(entries_32.size(), actual.size()); + } + assertEquals(3, providers.size()); + } + } + + /** + */ + public void testProjectPersistence_RealProject() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + String xmlStorageFileLocation; + String xmlOutOfTheWay; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // get project descriptions + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider + LanguageSettingsSerializable mockProvider = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + mockProvider.setStoringEntriesInProjectArea(true); + mockProvider.setSettingEntries(cfgDescription, null, null, entries); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + coreModel.setProjectDescription(project, writableProjDescription); + IFile xmlStorageFile = project.getFile(LANGUAGE_SETTINGS_PROJECT_XML); + assertTrue(xmlStorageFile.exists()); + xmlStorageFileLocation = xmlStorageFile.getLocation().toOSString(); + } + { + coreModel.getProjectDescription(project); + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertTrue(provider instanceof LanguageSettingsSerializable); + assertEquals(PROVIDER_0, provider.getId()); + assertEquals(PROVIDER_NAME_0, provider.getName()); + + List actual = provider.getSettingEntries(cfgDescription, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + { + // Move storage out of the way + java.io.File xmlFile = new java.io.File(xmlStorageFileLocation); + xmlOutOfTheWay = xmlStorageFileLocation+".out-of-the-way"; + java.io.File xmlFileOut = new java.io.File(xmlOutOfTheWay); + xmlFile.renameTo(xmlFileOut); + assertFalse(xmlFile.exists()); + assertTrue(xmlFileOut.exists()); + } + { + // Should not pollute workspace area with file with no meaningful data + String xmlWspStorageFileLocation = getStoreLocationInWorkspaceArea(project.getName()+'.'+LANGUAGE_SETTINGS_WORKSPACE_XML); + java.io.File xmlStorageFileWsp = new java.io.File(xmlWspStorageFileLocation); + assertFalse(xmlStorageFileWsp.exists()); + } + + { + // clear configuration + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + cfgDescription.setLanguageSettingProviders(new ArrayList()); + coreModel.setProjectDescription(project, writableProjDescription); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + } + { + // re-check if it really took it + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + } + { + // close the project + project.close(null); + } + { + // open to double-check the data is not kept in some other kind of cache + project.open(null); + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + // and close + project.close(null); + } + + { + // Move storage back + java.io.File xmlFile = new java.io.File(xmlStorageFileLocation); + xmlFile.delete(); + assertFalse("File "+xmlFile+ " still exist", xmlFile.exists()); + java.io.File xmlFileOut = new java.io.File(xmlOutOfTheWay); + xmlFileOut.renameTo(xmlFile); + assertTrue("File "+xmlFile+ " does not exist", xmlFile.exists()); + assertFalse("File "+xmlFileOut+ " still exist", xmlFileOut.exists()); + } + + { + // Remove project from internal cache + CProjectDescriptionManager.getInstance().projectClosedRemove(project); + // open project and check if providers are loaded + project.open(null); + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + ILanguageSettingsProvider loadedProvider = providers.get(0); + assertTrue(loadedProvider instanceof LanguageSettingsSerializable); + assertEquals(PROVIDER_0, loadedProvider.getId()); + assertEquals(PROVIDER_NAME_0, loadedProvider.getName()); + + List actual = loadedProvider.getSettingEntries(cfgDescription, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + */ + public void testProjectPersistence_SplitStorageDOM() throws Exception { + Element prjStorageElement = null; + Element wspStorageElement = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // create a provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + LanguageSettingsSerializable serializableProvider = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + serializableProvider.setSettingEntries(null, null, null, entries); + // do not store entries inside project + serializableProvider.setStoringEntriesInProjectArea(false); + + ArrayList providers = new ArrayList(); + providers.add(serializableProvider); + cfgDescription.setLanguageSettingProviders(providers); + + // prepare DOM storage + Document prjDoc = XmlUtil.newDocument(); + prjStorageElement = XmlUtil.appendElement(prjDoc, ELEM_TEST); + Document wspDoc = XmlUtil.newDocument(); + wspStorageElement = XmlUtil.appendElement(wspDoc, ELEM_TEST); + // serialize language settings to the DOM + LanguageSettingsProvidersSerializer.serializeLanguageSettingsInternal(prjStorageElement, wspStorageElement, mockPrjDescription); + } + { + // re-load and check language settings of the newly loaded provider + MockProjectDescription mockPrjDescription = new MockProjectDescription(new MockConfigurationDescription(CFG_ID)); + LanguageSettingsProvidersSerializer.loadLanguageSettingsInternal(prjStorageElement, wspStorageElement, mockPrjDescription); + + ICConfigurationDescription[] cfgDescriptions = mockPrjDescription.getConfigurations(); + assertNotNull(cfgDescriptions); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + List providers = cfgDescription.getLanguageSettingProviders(); + assertNotNull(providers); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertTrue(provider instanceof LanguageSettingsSerializable); + + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + * TODO: refactor with ErrorParserManager + * + * @param store - name of the store + * @return location of the store in the plug-in state area + */ + private static String getStoreLocationInWorkspaceArea(String store) { + IPath location = CCorePlugin.getDefault().getStateLocation().append(store); + return location.toString(); + } + + /** + */ + public void testProjectPersistence_RealProjectSplitStorage() throws Exception { + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + String xmlStorageFileLocation; + String xmlOutOfTheWay; + String xmlWspStorageFileLocation; + String xmlWspOutOfTheWay; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + { + // get project descriptions + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + assertNotNull(writableProjDescription); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + + // create a provider + LanguageSettingsSerializable mockProvider = new LanguageSettingsSerializable(PROVIDER_0, PROVIDER_NAME_0); + mockProvider.setStoringEntriesInProjectArea(false); + mockProvider.setSettingEntries(cfgDescription, null, null, entries); + List providers = new ArrayList(); + providers.add(mockProvider); + cfgDescription.setLanguageSettingProviders(providers); + List storedProviders = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, storedProviders.size()); + + // write to project description + coreModel.setProjectDescription(project, writableProjDescription); + IFile xmlStorageFile = project.getFile(LANGUAGE_SETTINGS_PROJECT_XML); + assertTrue(xmlStorageFile.exists()); + xmlStorageFileLocation = xmlStorageFile.getLocation().toOSString(); + // TODO - cleanup names + xmlWspStorageFileLocation = getStoreLocationInWorkspaceArea(project.getName()+'.'+LANGUAGE_SETTINGS_WORKSPACE_XML); + java.io.File xmlStorageFileWsp = new java.io.File(xmlWspStorageFileLocation); + assertTrue(xmlStorageFileWsp.exists()); + } + { + coreModel.getProjectDescription(project); + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + ILanguageSettingsProvider provider = providers.get(0); + assertTrue(provider instanceof LanguageSettingsSerializable); + assertEquals(PROVIDER_0, provider.getId()); + assertEquals(PROVIDER_NAME_0, provider.getName()); + + List actual = provider.getSettingEntries(cfgDescription, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + // Move storages out of the way + { + java.io.File xmlFile = new java.io.File(xmlStorageFileLocation); + xmlOutOfTheWay = xmlStorageFileLocation+".out-of-the-way"; + java.io.File xmlFileOut = new java.io.File(xmlOutOfTheWay); + xmlFile.renameTo(xmlFileOut); + assertFalse(xmlFile.exists()); + assertTrue(xmlFileOut.exists()); + } + { + // TODO - workspace file + java.io.File xmlStorageFileWsp = new java.io.File(xmlWspStorageFileLocation); + assertTrue(xmlStorageFileWsp.exists()); + xmlWspOutOfTheWay = xmlWspStorageFileLocation+".out-of-the-way"; + java.io.File xmlWspFileOut = new java.io.File(xmlWspOutOfTheWay); + boolean result = xmlStorageFileWsp.renameTo(xmlWspFileOut); + assertTrue(result); + assertFalse(xmlStorageFileWsp.exists()); + assertTrue(xmlWspFileOut.exists()); + } + + { + // clear configuration + ICProjectDescription writableProjDescription = coreModel.getProjectDescription(project); + ICConfigurationDescription[] cfgDescriptions = writableProjDescription.getConfigurations(); + assertEquals(1, cfgDescriptions.length); + ICConfigurationDescription cfgDescription = cfgDescriptions[0]; + assertNotNull(cfgDescription); + + cfgDescription.setLanguageSettingProviders(new ArrayList()); + coreModel.setProjectDescription(project, writableProjDescription); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + } + { + // re-check if it really took it + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + } + { + // close the project + project.close(null); + } + { + // open to double-check the data is not kept in some other kind of cache + project.open(null); + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(0, providers.size()); + // and close + project.close(null); + } + + { + // Move storage back + java.io.File xmlFile = new java.io.File(xmlStorageFileLocation); + xmlFile.delete(); + assertFalse("File "+xmlFile+ " still exist", xmlFile.exists()); + java.io.File xmlFileOut = new java.io.File(xmlOutOfTheWay); + xmlFileOut.renameTo(xmlFile); + assertTrue("File "+xmlFile+ " does not exist", xmlFile.exists()); + assertFalse("File "+xmlFileOut+ " still exist", xmlFileOut.exists()); + } + + { + // TODO + // Move storage back + java.io.File xmlWspFile = new java.io.File(xmlWspStorageFileLocation); + xmlWspFile.delete(); + assertFalse("File "+xmlWspFile+ " still exist", xmlWspFile.exists()); + java.io.File xmlWspFileOut = new java.io.File(xmlWspOutOfTheWay); + xmlWspFileOut.renameTo(xmlWspFile); + assertTrue("File "+xmlWspFile+ " does not exist", xmlWspFile.exists()); + assertFalse("File "+xmlWspFileOut+ " still exist", xmlWspFileOut.exists()); + } + + { + // Remove project from internal cache + CProjectDescriptionManager.getInstance().projectClosedRemove(project); + // open project and check if providers are loaded + project.open(null); + ICConfigurationDescription cfgDescription = getFirstConfigurationDescription(project); + List providers = cfgDescription.getLanguageSettingProviders(); + assertEquals(1, providers.size()); + ILanguageSettingsProvider loadedProvider = providers.get(0); + assertTrue(loadedProvider instanceof LanguageSettingsSerializable); + assertEquals(PROVIDER_0, loadedProvider.getId()); + assertEquals(PROVIDER_NAME_0, loadedProvider.getName()); + + List actual = loadedProvider.getSettingEntries(cfgDescription, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + } + } + + +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsScannerInfoProviderTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsScannerInfoProviderTests.java new file mode 100644 index 00000000000..bdc83f649a2 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsScannerInfoProviderTests.java @@ -0,0 +1,937 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import junit.framework.TestSuite; + +import org.eclipse.cdt.core.model.ILanguage; +import org.eclipse.cdt.core.model.LanguageManager; +import org.eclipse.cdt.core.parser.ExtendedScannerInfo; +import org.eclipse.cdt.core.settings.model.CIncludeFileEntry; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.CMacroFileEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICFolderDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSetting; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsScannerInfoProvider; +import org.eclipse.cdt.internal.core.settings.model.CProjectDescriptionManager; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.Path; + +/** + * Test cases testing LanguageSettingsProvider functionality + */ +public class LanguageSettingsScannerInfoProviderTests extends BaseTestCase { + private static final IFile FAKE_FILE = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/project/path0")); + private static final String PROVIDER_ID = "test.provider.id"; + private static final String PROVIDER_ID_2 = "test.provider.id.2"; + private static final String PROVIDER_NAME = "test.provider.name"; + + // constants for getProjectDescription() + private static final boolean READ_ONLY = false; + private static final boolean WRITEABLE = true; + + private class MockProvider extends LanguageSettingsBaseProvider implements ILanguageSettingsProvider { + private final List entries; + + public MockProvider(String id, String name, List entries) { + super(id, name); + this.entries = entries; + } + + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + return entries; + } + } + + /** + * Constructor. + * @param name - name of the test. + */ + public LanguageSettingsScannerInfoProviderTests(String name) { + super(name); + + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + super.tearDown(); + } + + /** + * @return - new TestSuite. + */ + public static TestSuite suite() { + return new TestSuite(LanguageSettingsScannerInfoProviderTests.class); + } + + /** + * main function of the class. + * + * @param args - arguments + */ + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + /** + * Sets build working directory for DefaultSettingConfiguration being tested. + */ + private void setBuilderCWD(IProject project, IPath buildCWD) throws CoreException { + CProjectDescriptionManager manager = CProjectDescriptionManager.getInstance(); + { + ICProjectDescription prjDescription = manager.getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + cfgDescription.getBuildSetting().setBuilderCWD(buildCWD); + manager.setProjectDescription(project, prjDescription); + // doublecheck builderCWD + IPath actualBuildCWD = cfgDescription.getBuildSetting().getBuilderCWD(); + assertEquals(buildCWD, actualBuildCWD); + } + { + // triplecheck builderCWD for different project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, READ_ONLY); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + } + } + + /** + * Test cases when some objects are null. + */ + public void testNulls() throws Exception { + { + // Handle project==null + IResource root = ResourcesPlugin.getWorkspace().getRoot(); + assertNull(root.getProject()); + + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(root); + assertEquals(0, info.getIncludePaths().length); + assertEquals(0, info.getDefinedSymbols().size()); + assertEquals(0, info.getIncludeFiles().length); + assertEquals(0, info.getMacroFiles().length); + assertEquals(0, info.getLocalIncludePath().length); + } + + { + // Handle prjDescription==null + IProject project = FAKE_FILE.getProject(); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, READ_ONLY); + assertNull(prjDescription); + + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(FAKE_FILE); + assertEquals(0, info.getIncludePaths().length); + assertEquals(0, info.getDefinedSymbols().size()); + assertEquals(0, info.getIncludeFiles().length); + assertEquals(0, info.getMacroFiles().length); + assertEquals(0, info.getLocalIncludePath().length); + } + + { + // Handle language==null + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + IFile file = ResourceHelper.createFile(project, "file"); + + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, READ_ONLY); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + ILanguage language = LanguageManager.getInstance().getLanguageForFile(file, cfgDescription); + assertNull(language); + + // AG FIXME - temporarily ignore the entry in the log + setExpectedNumberOfLoggedNonOKStatusObjects(1); + + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + assertEquals(0, info.getIncludePaths().length); + assertEquals(0, info.getDefinedSymbols().size()); + assertEquals(0, info.getIncludeFiles().length); + assertEquals(0, info.getMacroFiles().length); + assertEquals(0, info.getLocalIncludePath().length); + } + } + + /** + * Test empty scanner info. + */ + public void testEmpty() throws Exception { + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + IFile file = ResourceHelper.createFile(project, "file.c"); + + // confirm that language==null + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, READ_ONLY); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + ILanguage language = LanguageManager.getInstance().getLanguageForFile(file, cfgDescription); + assertNotNull(language); + + // test that the info is empty + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + assertEquals(0, info.getIncludePaths().length); + assertEquals(0, info.getDefinedSymbols().size()); + assertEquals(0, info.getIncludeFiles().length); + assertEquals(0, info.getMacroFiles().length); + assertEquals(0, info.getLocalIncludePath().length); + } + + /** + * Test regular cases. + */ + public void testRegular() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // sanity test of language + ILanguage language = LanguageManager.getInstance().getLanguageForFile(file, cfgDescription); + assertNotNull(language); + + // contribute the entries + IFolder includeFolder = ResourceHelper.createFolder(project, "/include-path"); + IFolder includeLocalFolder = ResourceHelper.createFolder(project, "/local-include-path"); + IFile macroFile = ResourceHelper.createFile(project, "macro-file"); + IFile includeFile = ResourceHelper.createFile(project, "include-file"); + + CIncludePathEntry includePathEntry = new CIncludePathEntry(includeFolder, 0); + CIncludePathEntry includeLocalPathEntry = new CIncludePathEntry(includeLocalFolder, ICSettingEntry.LOCAL); // #include "..." + CMacroEntry macroEntry = new CMacroEntry("MACRO", "value",0); + CIncludeFileEntry includeFileEntry = new CIncludeFileEntry(includeFile, 0); + CMacroFileEntry macroFileEntry = new CMacroFileEntry(macroFile, 0); + + List entries = new ArrayList(); + entries.add(includePathEntry); + entries.add(includeLocalPathEntry); + entries.add(macroEntry); + entries.add(includeFileEntry); + entries.add(macroFileEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test that the scannerInfoProvider gets the entries + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + Map actualDefinedSymbols = info.getDefinedSymbols(); + String[] actualIncludeFiles = info.getIncludeFiles(); + String[] actualMacroFiles = info.getMacroFiles(); + String[] actualLocalIncludePath = info.getLocalIncludePath(); + // include paths + assertEquals(includeFolder.getLocation(), new Path(actualIncludePaths[0])); + assertEquals(1, actualIncludePaths.length); + // macros + assertEquals(macroEntry.getValue(), actualDefinedSymbols.get(macroEntry.getName())); + assertEquals(1, actualDefinedSymbols.size()); + // include file + assertEquals(includeFile.getLocation(), new Path(actualIncludeFiles[0])); + assertEquals(1, actualIncludeFiles.length); + // macro file + assertEquals(macroFile.getLocation(), new Path(actualMacroFiles[0])); + assertEquals(1, actualMacroFiles.length); + // local include files + assertEquals(includeLocalFolder.getLocation(), new Path(actualLocalIncludePath[0])); + assertEquals(1, actualLocalIncludePath.length); + } + + /** + * Test "local" flag (#include "..."). + */ + public void testLocal() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + IFolder incFolder = ResourceHelper.createFolder(project, "include"); + IFolder incFolder2 = ResourceHelper.createFolder(project, "include2"); + CIncludePathEntry includePathEntry = new CIncludePathEntry(incFolder, 0); + CIncludePathEntry includeLocalPathEntry = new CIncludePathEntry(incFolder, ICSettingEntry.LOCAL); // #include "..." + CIncludePathEntry includeLocalPathEntry2 = new CIncludePathEntry(incFolder2, ICSettingEntry.LOCAL); // #include "..." + CIncludePathEntry includePathEntry2 = new CIncludePathEntry(incFolder2, 0); + + List entries = new ArrayList(); + entries.add(includePathEntry); + entries.add(includeLocalPathEntry); + // reverse order for incPath2 + entries.add(includeLocalPathEntry2); + entries.add(includePathEntry2); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test that the scannerInfoProvider gets the entries + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + String[] actualLocalIncludePath = info.getLocalIncludePath(); + // include paths + assertEquals(incFolder.getLocation(), new Path(actualIncludePaths[0])); + assertEquals(incFolder2.getLocation(), new Path(actualIncludePaths[1])); + assertEquals(2, actualIncludePaths.length); + // local include files + assertEquals(incFolder.getLocation(), new Path(actualLocalIncludePath[0])); + assertEquals(incFolder2.getLocation(), new Path(actualLocalIncludePath[1])); + assertEquals(2, actualLocalIncludePath.length); + } + + /** + * Test Mac frameworks. + */ + public void testFramework() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + IFolder frameworkFolder = ResourceHelper.createFolder(project, "Fmwk"); + CIncludePathEntry frameworkPathEntry = new CIncludePathEntry(frameworkFolder, ICSettingEntry.FRAMEWORKS_MAC); + + List entries = new ArrayList(); + entries.add(frameworkPathEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test that the scannerInfoProvider gets the entries + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + // include paths + assertEquals(frameworkFolder.getLocation().append("/__framework__.framework/Headers/__header__"), + new Path(actualIncludePaths[0])); + assertEquals(frameworkFolder.getLocation().append("/__framework__.framework/PrivateHeaders/__header__"), + new Path(actualIncludePaths[1])); + assertEquals(2, actualIncludePaths.length); + } + + /** + * Test duplicate entries. + */ + public void testDuplicate() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + IFolder incFolder = ResourceHelper.createFolder(project, "include"); + CIncludePathEntry includePathEntry = new CIncludePathEntry(incFolder, 0); + CIncludePathEntry includeLocalPathEntry = new CIncludePathEntry(incFolder, ICSettingEntry.LOCAL); // #include "..." + CIncludePathEntry includePathEntry2 = new CIncludePathEntry(incFolder, 0); + CIncludePathEntry includeLocalPathEntry2 = new CIncludePathEntry(incFolder, ICSettingEntry.LOCAL); // #include "..." + + List entries = new ArrayList(); + entries.add(includePathEntry); + entries.add(includeLocalPathEntry); + entries.add(includePathEntry2); + entries.add(includeLocalPathEntry2); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test that the scannerInfoProvider gets the entries + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + String[] actualLocalIncludePath = info.getLocalIncludePath(); + // include paths + assertEquals(incFolder.getLocation(), new Path(actualIncludePaths[0])); + assertEquals(1, actualIncludePaths.length); + // local include files + assertEquals(incFolder.getLocation(), new Path(actualLocalIncludePath[0])); + assertEquals(1, actualLocalIncludePath.length); + } + + /** + * Test include path managed by eclipse as a workspace path. + */ + public void testWorkspacePath() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // create sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + // eclipse-managed folder in workspace + IFolder incWorkspace_1 = ResourceHelper.createFolder(project, "include_1"); + IPath incWorkspaceLocation_1 = incWorkspace_1.getLocation(); + IFolder incWorkspace_2 = ResourceHelper.createFolder(project, "include_2"); + IPath incWorkspacePath_2 = incWorkspace_2.getFullPath(); + IPath incWorkspaceLocation_2 = incWorkspace_2.getLocation(); + IFolder incWorkspace_3 = ResourceHelper.createFolder(project, "include_3"); + // "relative" should make no difference for VALUE_WORKSPACE_PATH + IPath incWorkspaceRelativePath_3 = incWorkspace_3.getFullPath().makeRelative(); + IPath incWorkspaceLocation_3 = incWorkspace_3.getLocation(); + // folder defined by absolute path on the filesystem + IPath incFilesystem = ResourceHelper.createWorkspaceFolder("includeFilesystem"); + + // contribute the entries + CIncludePathEntry incWorkspaceEntry_1 = new CIncludePathEntry(incWorkspace_1, 0); + CIncludePathEntry incWorkspaceEntry_2 = new CIncludePathEntry(incWorkspacePath_2, ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED); + CIncludePathEntry incWorkspaceEntry_3 = new CIncludePathEntry(incWorkspaceRelativePath_3, ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED); + CIncludePathEntry incFilesystemEntry = new CIncludePathEntry(incFilesystem, 0); + + List entries = new ArrayList(); + entries.add(incWorkspaceEntry_1); + entries.add(incWorkspaceEntry_2); + entries.add(incWorkspaceEntry_3); + entries.add(incFilesystemEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + + assertEquals(incWorkspaceLocation_1, new Path(actualIncludePaths[0])); + assertEquals(incWorkspaceLocation_2, new Path(actualIncludePaths[1])); + assertEquals(incWorkspaceLocation_3, new Path(actualIncludePaths[2])); + assertEquals(incFilesystem, new Path(actualIncludePaths[3])); + assertEquals(4, actualIncludePaths.length); + + } + + /** + * Confirm that device letter is prepended on filesystems that support that. + */ + public void testFilesystemPathNoDriveLetter() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + // change drive on build working directory + String buildCwdDevice = project.getLocation().getDevice(); + +// // Test manually with a device which is different from project location device (path should exist) +// IPath buildCWD = new Path("D:/build/path"); +// String buildCwdDevice = buildCWD.getDevice(); + + // get project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // create sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + // no-drive-letter folder defined by absolute path on the filesystem + IPath incFilesystem = ResourceHelper.createWorkspaceFolder("includeFilesystem").setDevice(null); + CIncludePathEntry incFilesystemEntry = new CIncludePathEntry(incFilesystem, 0); + List entries = new ArrayList(); + entries.add(incFilesystemEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + + IPath expectedInclude = incFilesystem.setDevice(buildCwdDevice); + assertEquals(expectedInclude, new Path(actualIncludePaths[0])); + assertEquals(1, actualIncludePaths.length); + } + + /** + * Test relative paths. + */ + public void testRelativePath() throws Exception { + // create a project + String prjName = getName(); + IProject project = ResourceHelper.createCDTProjectWithConfig(prjName); + String relativePath = "include"; + IFolder buildFolder = ResourceHelper.createFolder(project, "buildDir"); + IFolder relativeFolder = ResourceHelper.createFolder(project, "buildDir/"+relativePath); + IFolder relativeFolderProjName = ResourceHelper.createFolder(project, "buildDir/"+prjName); + String markedResolved = "-MarkedResolved"; + IFolder relativeFolderProjNameResolved = ResourceHelper.createFolder(project, "buildDir/" + prjName+markedResolved); + IPath buildCWD=buildFolder.getLocation(); + setBuilderCWD(project, buildCWD); + + // get project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // create sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + CIncludePathEntry incRelativeEntry = new CIncludePathEntry(new Path(relativePath), 0); + CIncludePathEntry incProjNameEntry = new CIncludePathEntry(new Path("${ProjName}"), 0); + CIncludePathEntry incProjNameMarkedResolvedEntry = new CIncludePathEntry(new Path("${ProjName}"+markedResolved), ICSettingEntry.RESOLVED); + List entries = new ArrayList(); + entries.add(incRelativeEntry); + entries.add(incProjNameEntry); + entries.add(incProjNameMarkedResolvedEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + + // pair of entries, one from build dir another relative path + assertEquals(relativeFolder.getLocation(), new Path(actualIncludePaths[0])); + assertEquals(new Path(relativePath), new Path(actualIncludePaths[1])); + + // pair of entries, one resolved from build dir another expanded relative path + assertEquals(relativeFolderProjName.getLocation(), new Path(actualIncludePaths[2])); + assertEquals(new Path(prjName), new Path(actualIncludePaths[3])); + + // if marked RESOLVED only that path stays + assertEquals(new Path("${ProjName}"+markedResolved), new Path(actualIncludePaths[4])); + + assertEquals(5, actualIncludePaths.length); + } + + /** + * Test relative paths - some combinations of dot paths. + */ + public void testRelativePathWithDots() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + // set build CWD + IFolder buildFolder = ResourceHelper.createFolder(project, "buildDir"); + IPath buildCWD=buildFolder.getLocation(); + setBuilderCWD(project, buildCWD); + + // define a few variations of paths + String relativePath_dot = "."; + String relativePath_dot_slash = "./"; + String relativePath_dot_slash_path = "./include"; + IFolder relativeFolder_dot_slash_path = ResourceHelper.createFolder(project, "buildDir/include"); + String relativePath_dotdot = ".."; + String relativePath_dotdot_slash = "../"; + String relativePath_dotdot_slash_path = "../include"; + IFolder relativeFolder_dotdot_slash_path = ResourceHelper.createFolder(project, "include"); + String locationPath_dotdot_path = buildCWD.toString()+"/../include2"; + IFolder incFolder_dotdot_slash_path = ResourceHelper.createFolder(project, "include2"); // "/ProjPath/buildDir/../include2" + + // get project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // create sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + CIncludePathEntry incRelativeEntry_dot = new CIncludePathEntry(new Path(relativePath_dot), 0); + CIncludePathEntry incRelativeEntry_dot_slash_path = new CIncludePathEntry(new Path(relativePath_dot_slash_path), 0); + CIncludePathEntry incRelativeEntry_dotdot = new CIncludePathEntry(new Path(relativePath_dotdot), 0); + CIncludePathEntry incRelativeEntry_dotdot_slash_path = new CIncludePathEntry(new Path(relativePath_dotdot_slash_path), 0); + CIncludePathEntry incEntry_dotdot_path = new CIncludePathEntry(locationPath_dotdot_path, 0); + // use LOCAL flag not to clash with plain dot entries + CIncludePathEntry incRelativeEntry_dotdot_slash = new CIncludePathEntry(new Path(relativePath_dotdot_slash), ICSettingEntry.LOCAL); + CIncludePathEntry incRelativeEntry_dot_slash = new CIncludePathEntry(new Path(relativePath_dot_slash), ICSettingEntry.LOCAL); + + List entries = new ArrayList(); + entries.add(incRelativeEntry_dot); + entries.add(incRelativeEntry_dot_slash); + entries.add(incRelativeEntry_dot_slash_path); + entries.add(incRelativeEntry_dotdot); + entries.add(incRelativeEntry_dotdot_slash); + entries.add(incRelativeEntry_dotdot_slash_path); + entries.add(incEntry_dotdot_path); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + String[] actualLocalIncludePaths = info.getLocalIncludePath(); + + IPath expectedLocation_dot = buildFolder.getLocation(); + IPath expectedLocation_dot_slash = buildFolder.getLocation(); + IPath expectedLocation_dot_slash_path = relativeFolder_dot_slash_path.getLocation(); + IPath expectedLocation_dotdot = project.getLocation(); + IPath expectedLocation_dotdot_slash = project.getLocation(); + IPath expectedLocation_dotdot_slash_path = relativeFolder_dotdot_slash_path.getLocation(); + + assertEquals(expectedLocation_dot, new Path(actualIncludePaths[0])); + assertEquals(".", actualIncludePaths[1]); + assertEquals(expectedLocation_dot_slash_path, new Path(actualIncludePaths[2])); + assertEquals(new Path(relativePath_dot_slash_path), new Path(actualIncludePaths[3])); + + assertEquals(expectedLocation_dotdot, new Path(actualIncludePaths[4])); + assertEquals("..", actualIncludePaths[5]); + assertEquals(expectedLocation_dotdot_slash_path, new Path(actualIncludePaths[6])); + assertEquals(new Path(relativePath_dotdot_slash_path), new Path(actualIncludePaths[7])); + assertTrue(actualIncludePaths[7].startsWith("..")); + assertEquals(new Path(locationPath_dotdot_path), new Path(actualIncludePaths[8])); + assertTrue(actualIncludePaths[8].contains("..")); + assertEquals(9, actualIncludePaths.length); + + assertEquals(expectedLocation_dot_slash, new Path(actualLocalIncludePaths[0])); + assertEquals(new Path(relativePath_dot_slash), new Path(actualLocalIncludePaths[1])); + assertTrue(actualLocalIncludePaths[1].startsWith(".")); + assertEquals(expectedLocation_dotdot_slash, new Path(actualLocalIncludePaths[2])); + assertEquals(new Path(relativePath_dotdot_slash), new Path(actualLocalIncludePaths[3])); + assertTrue(actualLocalIncludePaths[3].startsWith("..")); + assertEquals(4, actualLocalIncludePaths.length); + } + + /** + * Test if build/environment variables are expanded + */ + public void testEnvironmentVars() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + IFolder folder = ResourceHelper.createFolder(project, "Folder"); + String envPathStr = "${ProjDirPath}/Folder"; + + // get project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // create sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + CIncludePathEntry incRelativeEntry = new CIncludePathEntry(envPathStr, 0); + List entries = new ArrayList(); + entries.add(incRelativeEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + + IPath expectedLocation = folder.getLocation(); + assertEquals(expectedLocation, new Path(actualIncludePaths[0])); + assertEquals(1, actualIncludePaths.length); + } + + /** + * Test from parent folder's entries. + */ + public void testParentFolder() throws Exception { + class MockProviderForResource extends LanguageSettingsBaseProvider implements ILanguageSettingsProvider { + private IResource rc; + private final List entries; + + public MockProviderForResource(IResource rc, List entries) { + this.rc = rc; + this.entries = entries; + } + + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (this.rc.equals(rc)) + return entries; + return null; + } + } + + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // sample file + IFolder parentFolder = ResourceHelper.createFolder(project, "ParentFolder"); + IFile file = ResourceHelper.createFile(project, "ParentFolder/file.c"); + + // contribute the entries + IFolder incFolder = ResourceHelper.createFolder(project, "include"); + CIncludePathEntry includePathEntry = new CIncludePathEntry(incFolder, 0); + + List entries = new ArrayList(); + entries.add(includePathEntry); + + // add provider for parent folder + ILanguageSettingsProvider provider = new MockProviderForResource(parentFolder, entries); + assertNull(provider.getSettingEntries(cfgDescription, file, null)); + assertEquals(includePathEntry, provider.getSettingEntries(cfgDescription, parentFolder, null).get(0)); + + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test that the scannerInfoProvider gets the entries for + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + // include paths + assertEquals(incFolder.getLocation(), new Path(actualIncludePaths[0])); + assertEquals(1, actualIncludePaths.length); + } + + /** + * Test resolved paths. + */ + public void testResolvedPath() throws Exception { + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + IFolder folder = ResourceHelper.createFolder(project, "Folder"); + String envPathStr = "${ProjDirPath}/Folder"; + + // get project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // create sample file + IFile file = ResourceHelper.createFile(project, "file.c"); + + // contribute the entries + CIncludePathEntry incRelativeEntry = new CIncludePathEntry(envPathStr, ICSettingEntry.RESOLVED); + List entries = new ArrayList(); + entries.add(incRelativeEntry); + + // add provider to the configuration + ILanguageSettingsProvider provider = new MockProvider(PROVIDER_ID, PROVIDER_NAME, entries); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(file); + String[] actualIncludePaths = info.getIncludePaths(); + + // test that RESOLVED entries are not modified + IPath expectedLocation = new Path(envPathStr); + assertEquals(expectedLocation, new Path(actualIncludePaths[0])); + assertEquals(1, actualIncludePaths.length); + } + + private List getLanguages(IFolder folder, ICConfigurationDescription cfgDescription) { + // Get first 2 languages + IPath rcPath = folder.getProjectRelativePath(); + ICFolderDescription rcDes = (ICFolderDescription) cfgDescription.getResourceDescription(rcPath, false); + ICLanguageSetting[] langSettings = rcDes.getLanguageSettings(); + assertNotNull(langSettings); + + List languageIds = new ArrayList(); + for (ICLanguageSetting ls : langSettings) { + String langId = ls.getLanguageId(); + if (langId!=null && !languageIds.contains(langId)) { + languageIds.add(langId); + } + } + return languageIds; + } + + /** + * Test composition of 2 languages. + */ + public void testResourceLanguages() throws Exception { + class MockProviderLang extends LanguageSettingsBaseProvider implements ILanguageSettingsProvider { + private final String langId; + private final List entries; + + public MockProviderLang(String id, String name, String langId, List entries) { + super(id, name); + this.langId = langId; + this.entries = entries; + } + + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (langId==null || langId.equals(languageId)) + return entries; + return new ArrayList(); + } + } + + // create a project + IProject project = ResourceHelper.createCDTProjectWithConfig(getName()); + IFolder folder = ResourceHelper.createFolder(project, "Folder"); + + IFolder incFolderA = ResourceHelper.createFolder(project, "includeA"); + IFolder incFolderB = ResourceHelper.createFolder(project, "includeB"); + IFolder incFolderC = ResourceHelper.createFolder(project, "includeC"); + + // get project/configuration descriptions + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, WRITEABLE); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + assertNotNull(cfgDescription); + + // find 2 languages applicable to the folder + List languageIds = getLanguages(folder, cfgDescription); + assertTrue(languageIds.size() >= 2); + String langId1 = languageIds.get(0); + String langId2 = languageIds.get(1); + + // define overlapping entries + CIncludePathEntry incEntryA = new CIncludePathEntry(incFolderA, 0); + CIncludePathEntry incEntryB = new CIncludePathEntry(incFolderB, 0); + CIncludePathEntry incEntryC = new CIncludePathEntry(incFolderC, 0); + List entries1 = new ArrayList(); + entries1.add(incEntryA); + entries1.add(incEntryB); + List entries2 = new ArrayList(); + entries2.add(incEntryC); + entries2.add(incEntryB); + + // add providers to the configuration + ILanguageSettingsProvider provider1 = new MockProviderLang(PROVIDER_ID, PROVIDER_NAME, langId1, entries1); + ILanguageSettingsProvider provider2 = new MockProviderLang(PROVIDER_ID_2, PROVIDER_NAME, langId2, entries2); + List providers = new ArrayList(); + providers.add(provider1); + providers.add(provider2); + cfgDescription.setLanguageSettingProviders(providers); + + // set project description + CProjectDescriptionManager.getInstance().setProjectDescription(project, prjDescription); + + // test the entries received from the scannerInfoProvider + LanguageSettingsScannerInfoProvider scannerInfoProvider = new LanguageSettingsScannerInfoProvider(); + ExtendedScannerInfo info = scannerInfoProvider.getScannerInformation(folder); + String[] actualIncludePaths = info.getIncludePaths(); + + // Test that the result is the union of entries + assertEquals(incFolderA.getLocation(), new Path(actualIncludePaths[0])); + assertEquals(incFolderB.getLocation(), new Path(actualIncludePaths[1])); + assertEquals(incFolderC.getLocation(), new Path(actualIncludePaths[2])); + assertEquals(3, actualIncludePaths.length); + } + +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableTests.java new file mode 100644 index 00000000000..e3e9f98b546 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableTests.java @@ -0,0 +1,1471 @@ +/******************************************************************************* + * Copyright (c) 2009 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import junit.framework.TestSuite; + +import org.eclipse.cdt.core.settings.model.CIncludeFileEntry; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CLibraryFileEntry; +import org.eclipse.cdt.core.settings.model.CLibraryPathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.CMacroFileEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.testplugin.CModelMock; +import org.eclipse.cdt.core.testplugin.ResourceHelper; +import org.eclipse.cdt.core.testplugin.util.BaseTestCase; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.Path; +import org.w3c.dom.Document; +import org.w3c.dom.Element; + +/** + * Test cases testing LanguageSettingsProvider functionality + */ +public class LanguageSettingsSerializableTests extends BaseTestCase { + private static final String CFG_ID = "test.configuration.id"; + private static final ICConfigurationDescription MOCK_CFG = new CModelMock.DummyCConfigurationDescription(CFG_ID); + private static final IResource MOCK_RC = ResourcesPlugin.getWorkspace().getRoot(); + private static final String LANG_ID = "test.lang.id"; + private static final String LANG_ID_1 = "test.lang.id.1"; + private static final String LANG_ID_2 = "test.lang.id.2"; + private static final String PROVIDER_NULL = "test.provider.null.id"; + private static final String PROVIDER_1 = "test.provider.1.id"; + private static final String PROVIDER_2 = "test.provider.2.id"; + private static final String PROVIDER_NAME_NULL = "test.provider.null.name"; + private static final String PROVIDER_NAME_1 = "test.provider.1.name"; + private static final String PROVIDER_NAME_2 = "test.provider.2.name"; + private static final String CUSTOM_PARAMETER = "custom.parameter"; + private static final String ATTR_STORE_ENTRIES = "store-entries"; + private static final String VALUE_PROJECT = "project"; + private static final String ELEM_TEST = "test"; + + /** + * Constructor. + * @param name - name of the test. + */ + public LanguageSettingsSerializableTests(String name) { + super(name); + + } + + @Override + protected void setUp() throws Exception { + super.setUp(); + } + + @Override + protected void tearDown() throws Exception { + super.tearDown(); + } + + /** + * @return - new TestSuite. + */ + public static TestSuite suite() { + return new TestSuite(LanguageSettingsSerializableTests.class); + } + + /** + * main function of the class. + * + * @param args - arguments + */ + public static void main(String[] args) { + junit.textui.TestRunner.run(suite()); + } + + /** + */ + public void testProvider_SettersGetters() throws Exception { + // benchmark data + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List languages = new ArrayList(); + languages.add(LANG_ID); + + // create a provider + LanguageSettingsSerializable mockProvider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + // test isEmpty() + assertTrue(mockProvider.isEmpty()); + + // test setters and getters + mockProvider.setId(PROVIDER_2); + assertEquals(PROVIDER_2, mockProvider.getId()); + mockProvider.setName(PROVIDER_NAME_2); + assertEquals(PROVIDER_NAME_2, mockProvider.getName()); + mockProvider.setCustomParameter(CUSTOM_PARAMETER); + assertEquals(CUSTOM_PARAMETER, mockProvider.getCustomParameter()); + + assertEquals(false, mockProvider.isStoringEntriesInProjectArea()); + mockProvider.setStoringEntriesInProjectArea(true); + assertEquals(true, mockProvider.isStoringEntriesInProjectArea()); + + mockProvider.setLanguageScope(languages); + assertEquals(languages, mockProvider.getLanguageScope()); + mockProvider.setLanguageScope(null); + assertEquals(null, mockProvider.getLanguageScope()); + + mockProvider.setSettingEntries(null, MOCK_RC, LANG_ID, entries); + List actual = mockProvider.getSettingEntries(null, MOCK_RC, LANG_ID); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + assertFalse(mockProvider.isEmpty()); + + // test clear() + mockProvider.clear(); + assertTrue(mockProvider.isEmpty()); + } + + /** + */ + public void testProvider_RegularDOM() throws Exception { + Element elementProvider; + { + // create customized provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setStoringEntriesInProjectArea(true); + provider.setCustomParameter(CUSTOM_PARAMETER); + + List languageScope = new ArrayList(); + languageScope.add(LANG_ID); + provider.setLanguageScope(languageScope); + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 1)); + provider.setSettingEntries(null, null, null, entries); + + // serialize + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + // check XML + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(PROVIDER_1)); + assertTrue(xmlString.contains(PROVIDER_NAME_1)); + assertTrue(xmlString.contains(CUSTOM_PARAMETER)); + assertTrue(xmlString.contains(LANG_ID)); + assertTrue(xmlString.contains("path0")); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + assertEquals(true, provider.isStoringEntriesInProjectArea()); + assertEquals(CUSTOM_PARAMETER, provider.getCustomParameter()); + assertNotNull(provider.getLanguageScope()); + assertTrue(provider.getLanguageScope().size()>0); + assertEquals(LANG_ID, provider.getLanguageScope().get(0)); + + List entries = provider.getSettingEntries(null, null, null); + assertNotNull(entries); + assertTrue(entries.size()>0); + assertEquals(new CIncludePathEntry("path0", 1), entries.get(0)); + } + } + + /** + */ + public void testProvider_serializeAttributesDOM() throws Exception { + Element elementProvider; + { + // create customized provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setStoringEntriesInProjectArea(true); + provider.setCustomParameter(CUSTOM_PARAMETER); + + List languageScope = new ArrayList(); + languageScope.add(LANG_ID); + provider.setLanguageScope(languageScope); + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 1)); + provider.setSettingEntries(null, null, null, entries); + + // serialize + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serializeAttributes(rootElement); + // check XML + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(PROVIDER_1)); + assertTrue(xmlString.contains(PROVIDER_NAME_1)); + assertTrue(xmlString.contains(CUSTOM_PARAMETER)); + assertTrue(xmlString.contains(LANG_ID)); + // no entries + assertFalse(xmlString.contains("path0")); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(); + provider.loadAttributes(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + assertEquals(true, provider.isStoringEntriesInProjectArea()); + assertEquals(CUSTOM_PARAMETER, provider.getCustomParameter()); + assertNotNull(provider.getLanguageScope()); + assertTrue(provider.getLanguageScope().size()>0); + assertEquals(LANG_ID, provider.getLanguageScope().get(0)); + // no entries should be loaded + List entries = provider.getSettingEntries(null, null, null); + assertNull(entries); + } + } + + /** + */ + public void testProvider_serializeEntriesDOM() throws Exception { + Element rootElement; + { + // create customized provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setStoringEntriesInProjectArea(true); + provider.setCustomParameter(CUSTOM_PARAMETER); + + List languageScope = new ArrayList(); + languageScope.add(LANG_ID); + provider.setLanguageScope(languageScope); + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 1)); + provider.setSettingEntries(null, null, null, entries); + + // serialize + Document doc = XmlUtil.newDocument(); + rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + provider.serializeEntries(rootElement); + // check XML + String xmlString = XmlUtil.toString(doc); + // no attributes + assertFalse(xmlString.contains(PROVIDER_1)); + assertFalse(xmlString.contains(PROVIDER_NAME_1)); + assertFalse(xmlString.contains(CUSTOM_PARAMETER)); + assertFalse(xmlString.contains(LANG_ID)); + // entries should be present + assertTrue(xmlString.contains("path0")); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_2, PROVIDER_NAME_2); + provider.loadEntries(rootElement); + assertEquals(PROVIDER_2, provider.getId()); + assertEquals(PROVIDER_NAME_2, provider.getName()); + // no attributes should be loaded + assertFalse(PROVIDER_1.equals(provider.getId())); + assertFalse(PROVIDER_NAME_1.equals(provider.getName())); + assertFalse(true==provider.isStoringEntriesInProjectArea()); + assertFalse(CUSTOM_PARAMETER.equals(provider.getCustomParameter())); + assertNull(provider.getLanguageScope()); + // entries should be loaded + List entries = provider.getSettingEntries(null, null, null); + assertNotNull(entries); + assertTrue(entries.size()>0); + assertEquals(new CIncludePathEntry("path0", 1), entries.get(0)); + } + } + + /** + */ + public void testProvider_EmptyDOM() throws Exception { + Element elementProvider; + { + // create null provider + LanguageSettingsSerializable providerNull = new LanguageSettingsSerializable(PROVIDER_NULL, PROVIDER_NAME_NULL); + assertNull(providerNull.getSettingEntries(null, null, null)); + // set and get null entries + providerNull.setSettingEntries(null, null, null, null); + assertNull(providerNull.getSettingEntries(null, null, null)); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = providerNull.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(PROVIDER_NULL)); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_NULL, provider.getId()); + List actual = provider.getSettingEntries(null, null, null); + assertNull(actual); + } + } + + /** + */ + public void testCustomParameterDOM() throws Exception { + Element elementProvider; + { + // create provider with custom parameter + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setCustomParameter(CUSTOM_PARAMETER); + assertEquals(CUSTOM_PARAMETER, provider.getCustomParameter()); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(CUSTOM_PARAMETER)); + } + { + // re-load and check custom parameter of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(CUSTOM_PARAMETER, provider.getCustomParameter()); + } + } + + /** + */ + public void testStoreEntriesWithProjectDOM() throws Exception { + Element elementProvider; + { + // create provider with custom parameter + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + assertEquals(false, provider.isStoringEntriesInProjectArea()); + provider.setStoringEntriesInProjectArea(true); + assertEquals(true, provider.isStoringEntriesInProjectArea()); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(ATTR_STORE_ENTRIES)); + assertTrue(xmlString.contains(VALUE_PROJECT)); + } + { + // re-load and check custom parameter of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(true, provider.isStoringEntriesInProjectArea()); + } + } + + /** + */ + public void testLanguagesDOM() throws Exception { + List expectedLanguageIds = new ArrayList(); + expectedLanguageIds.add(LANG_ID); + expectedLanguageIds.add(LANG_ID_1); + + Element elementProvider; + { + // create provider with custom language scope + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setLanguageScope(expectedLanguageIds); + List actualIds = provider.getLanguageScope(); + assertEquals(LANG_ID, actualIds.get(0)); + assertEquals(LANG_ID_1, actualIds.get(1)); + assertEquals(2, actualIds.size()); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(LANG_ID)); + assertTrue(xmlString.contains(LANG_ID_1)); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + List actualIds = provider.getLanguageScope(); + assertEquals(expectedLanguageIds.get(0), actualIds.get(0)); + assertEquals(expectedLanguageIds.get(1), actualIds.get(1)); + assertEquals(expectedLanguageIds.size(), actualIds.size()); + } + } + + /** + */ + public void testLanguageScopeDOM() throws Exception { + // benchmark entries + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + + // define the scope + List expectedLanguageIds = new ArrayList(); + expectedLanguageIds.add(LANG_ID); + expectedLanguageIds.add(LANG_ID_1); + + Element elementProvider; + { + // create provider with no scope by default + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + // set entries for the whole language scope (now langId=null) + provider.setSettingEntries(null, null, null, entries); + { + // doublecheck for language scope itself + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries, actual); + } + { + // doublecheck for any language + List actual = provider.getSettingEntries(null, null, LANG_ID_2); + assertEquals(entries, actual); + } + + // set the scope + provider.setLanguageScope(expectedLanguageIds); + List actualIds = provider.getLanguageScope(); + assertEquals(LANG_ID, actualIds.get(0)); + assertEquals(LANG_ID_1, actualIds.get(1)); + assertEquals(2, actualIds.size()); + + { + // check for language scope itself + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries, actual); + } + { + // check for language in the language scope + List actual = provider.getSettingEntries(null, null, LANG_ID); + assertEquals(entries, actual); + } + { + // check for language not in scope + List actual = provider.getSettingEntries(null, null, LANG_ID_2); + assertNull(actual); + } + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(LANG_ID)); + assertTrue(xmlString.contains(LANG_ID_1)); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + List actualIds = provider.getLanguageScope(); + assertEquals(expectedLanguageIds.get(0), actualIds.get(0)); + assertEquals(expectedLanguageIds.get(1), actualIds.get(1)); + assertEquals(expectedLanguageIds.size(), actualIds.size()); + + { + // check for language scope itself + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries, actual); + } + { + // check for language in the language scope + List actual = provider.getSettingEntries(null, null, LANG_ID); + assertEquals(entries, actual); + } + { + // check for language not in scope + List actual = provider.getSettingEntries(null, null, LANG_ID_2); + assertNull(actual); + } + } + } + + /** + */ + public void testNullConfigurationDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, MOCK_RC, LANG_ID, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that "configuration" element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(null, MOCK_RC, LANG_ID); + assertEquals(entries.get(0), actual.get(0)); + } + } + + /** + */ + public void testNullLanguageDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(MOCK_CFG, MOCK_RC, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that "language" element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(MOCK_CFG, MOCK_RC, null); + assertEquals(entries.get(0), actual.get(0)); + } + } + + + /** + */ + public void testNullLanguageScopeDOM() throws Exception { + // define benchmark entries + List entriesNullLanguage = new ArrayList(); + entriesNullLanguage.add(new CIncludePathEntry("path_null", 0)); + List entriesLanguage = new ArrayList(); + entriesLanguage.add(new CIncludePathEntry("path", 0)); + + Element elementProvider; + + { + // create a provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + assertEquals(null, provider.getLanguageScope()); + + // add null language + provider.setSettingEntries(null, MOCK_RC, null, entriesNullLanguage); + assertEquals(null, provider.getLanguageScope()); + { + // getter by null language + List actual = provider.getSettingEntries(null, MOCK_RC, null); + assertEquals(entriesNullLanguage.get(0), actual.get(0)); + assertEquals(entriesNullLanguage.size(), actual.size()); + } + { + // getter by any language - should return same entries as null + List actual = provider.getSettingEntries(null, MOCK_RC, LANG_ID); + assertEquals(entriesNullLanguage.get(0), actual.get(0)); + assertEquals(entriesNullLanguage.size(), actual.size()); + } + + // add non-null language + provider.setSettingEntries(MOCK_CFG, MOCK_RC, LANG_ID, entriesLanguage); + assertNull(provider.getLanguageScope()); + { + // getter by null language + List actual = provider.getSettingEntries(null, MOCK_RC, null); + assertEquals(entriesNullLanguage.get(0), actual.get(0)); + assertEquals(entriesNullLanguage.size(), actual.size()); + } + { + // getter by the language + List actual = provider.getSettingEntries(null, MOCK_RC, LANG_ID); + assertEquals(entriesLanguage.get(0), actual.get(0)); + assertEquals(entriesLanguage.size(), actual.size()); + } + + // provider/configuration/language/resource/settingEntry + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that "language" element is saved in XML + String xmlString = XmlUtil.toString(doc); + assertTrue(xmlString.contains(" actual = provider.getSettingEntries(null, MOCK_RC, null); + assertEquals(entriesNullLanguage.get(0), actual.get(0)); + assertEquals(entriesNullLanguage.size(), actual.size()); + } + { + // getter by the language + List actual = provider.getSettingEntries(null, MOCK_RC, LANG_ID); + assertEquals(entriesLanguage.get(0), actual.get(0)); + assertEquals(entriesLanguage.size(), actual.size()); + } + } + } + + /** + */ + public void testNullResourceDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(MOCK_CFG, null, LANG_ID, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that "resource" element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(MOCK_CFG, null, LANG_ID); + assertEquals(entries.get(0), actual.get(0)); + } + } + + /** + */ + public void testNullConfigurationLanguageDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, MOCK_RC, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(null, MOCK_RC, null); + assertEquals(entries.get(0), actual.get(0)); + } + } + + /** + */ + public void testNullConfigurationResourceDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, LANG_ID, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(null, null, LANG_ID); + assertEquals(entries.get(0), actual.get(0)); + } + } + + /** + */ + public void testNullLanguageResourceDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(MOCK_CFG, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(MOCK_CFG, null, null); + assertEquals(entries.get(0), actual.get(0)); + } + } + + /** + */ + public void testNullConfigurationLanguageResourceFlagDOM() throws Exception { + // provider/configuration/language/resource/settingEntry + Element elementProvider; + List entries = new ArrayList(); + int flag = 0; + entries.add(new CIncludePathEntry("path0", flag)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + + // verify that element is collapsed and not saved in XML + String xmlString = XmlUtil.toString(doc); + assertFalse(xmlString.contains(" actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + } + } + + /** + */ + public void testCIncludePathEntryDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + ICLanguageSettingEntry entry = actual.get(0); + assertTrue(entry instanceof CIncludePathEntry); + + CIncludePathEntry includePathEntry = (CIncludePathEntry)entry; + assertEquals(entries.get(0).getName(), includePathEntry.getName()); + assertEquals(entries.get(0).getValue(), includePathEntry.getValue()); + assertEquals(entries.get(0).getKind(), includePathEntry.getKind()); + assertEquals(entries.get(0).getFlags(), includePathEntry.getFlags()); + assertEquals(entries.get(0), includePathEntry); + } + } + + /** + */ + public void testCIncludeFileEntryDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludeFileEntry("name", 1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + ICLanguageSettingEntry entry = actual.get(0); + assertTrue(entry instanceof CIncludeFileEntry); + CIncludeFileEntry includeFileEntry = (CIncludeFileEntry)entry; + assertEquals(entries.get(0).getName(), includeFileEntry.getName()); + assertEquals(entries.get(0).getValue(), includeFileEntry.getValue()); + assertEquals(entries.get(0).getKind(), includeFileEntry.getKind()); + assertEquals(entries.get(0).getFlags(), includeFileEntry.getFlags()); + assertEquals(entries.get(0), includeFileEntry); + } + } + + /** + */ + public void testCMacroEntryDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CMacroEntry("MACRO0", "value0",1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + ICLanguageSettingEntry entry = actual.get(0); + assertTrue(entry instanceof CMacroEntry); + CMacroEntry macroEntry = (CMacroEntry)entry; + assertEquals(entries.get(0).getName(), macroEntry.getName()); + assertEquals(entries.get(0).getValue(), macroEntry.getValue()); + assertEquals(entries.get(0).getKind(), macroEntry.getKind()); + assertEquals(entries.get(0).getFlags(), macroEntry.getFlags()); + assertEquals(entries.get(0), macroEntry); + } + } + + /** + */ + public void testCMacroFileEntryDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CMacroFileEntry("name", 1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + ICLanguageSettingEntry entry = actual.get(0); + assertTrue(entry instanceof CMacroFileEntry); + CMacroFileEntry macroFileEntry = (CMacroFileEntry)entry; + assertEquals(entries.get(0).getName(), macroFileEntry.getName()); + assertEquals(entries.get(0).getValue(), macroFileEntry.getValue()); + assertEquals(entries.get(0).getKind(), macroFileEntry.getKind()); + assertEquals(entries.get(0).getFlags(), macroFileEntry.getFlags()); + assertEquals(entries.get(0), macroFileEntry); + } + } + + /** + */ + public void testCLibraryPathEntryDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CLibraryPathEntry("name", 1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + ICLanguageSettingEntry entry = actual.get(0); + assertTrue(entry instanceof CLibraryPathEntry); + CLibraryPathEntry libraryPathEntry = (CLibraryPathEntry)entry; + assertEquals(entries.get(0).getName(), libraryPathEntry.getName()); + assertEquals(entries.get(0).getValue(), libraryPathEntry.getValue()); + assertEquals(entries.get(0).getKind(), libraryPathEntry.getKind()); + assertEquals(entries.get(0).getFlags(), libraryPathEntry.getFlags()); + assertEquals(entries.get(0), libraryPathEntry); + } + } + + /** + */ + public void testCLibraryFileEntryDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CLibraryFileEntry("name", 1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + ICLanguageSettingEntry entry = actual.get(0); + assertTrue(entry instanceof CLibraryFileEntry); + CLibraryFileEntry libraryFileEntry = (CLibraryFileEntry)entry; + assertEquals(entries.get(0).getName(), libraryFileEntry.getName()); + assertEquals(entries.get(0).getValue(), libraryFileEntry.getValue()); + assertEquals(entries.get(0).getKind(), libraryFileEntry.getKind()); + assertEquals(entries.get(0).getFlags(), libraryFileEntry.getFlags()); + assertEquals(entries.get(0), libraryFileEntry); + } + } + + /** + */ + public void testMixedSettingEntriesDOM() throws Exception { + Element elementProvider; + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 1)); + entries.add(new CIncludePathEntry("path1", 1)); + entries.add(new CMacroEntry("MACRO0", "value0",1)); + { + // create a provider and serialize its settings + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, entries); + + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = provider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(elementProvider); + assertEquals(PROVIDER_1, provider.getId()); + + List actual = provider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.get(1), actual.get(1)); + assertEquals(entries.get(2), actual.get(2)); + assertEquals(entries.size(), actual.size()); + } + } + + /** + */ + public void testLanguageAndNullDOM() throws Exception { + Element elementProvider = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List entries2 = new ArrayList(); + entries2.add(new CIncludePathEntry("path2", 0)); + + { + // create a provider + LanguageSettingsSerializable mockProvider = null; + mockProvider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + mockProvider.setSettingEntries(null, null, null, entries); + mockProvider.setSettingEntries(null, null, LANG_ID, entries2); + + // serialize language settings to DOM + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = mockProvider.serialize(rootElement); + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable loadedProvider = new LanguageSettingsSerializable(elementProvider); + + List actual = loadedProvider.getSettingEntries(null, null, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + + List actual2 = loadedProvider.getSettingEntries(null, null, LANG_ID); + assertEquals(entries2.get(0), actual2.get(0)); + assertEquals(entries2.size(), actual2.size()); + } + } + + /** + */ + public void testTwoLanguagesDOM() throws Exception { + Element elementProvider = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List entries2 = new ArrayList(); + entries2.add(new CIncludePathEntry("path2", 0)); + + { + // create a provider + LanguageSettingsSerializable mockProvider = null; + mockProvider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + mockProvider.setSettingEntries(null, null, LANG_ID_1, entries); + mockProvider.setSettingEntries(null, null, LANG_ID_2, entries2); + + // serialize language settings to DOM + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = mockProvider.serialize(rootElement); + String xml = XmlUtil.toString(elementProvider.getOwnerDocument()); +// fail(xml); // for debugging + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable loadedProvider = new LanguageSettingsSerializable(elementProvider); + + List actual = loadedProvider.getSettingEntries(null, null, LANG_ID_1); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + + List actual2 = loadedProvider.getSettingEntries(null, null, LANG_ID_2); + assertEquals(entries2.get(0), actual2.get(0)); + assertEquals(entries2.size(), actual2.size()); + } + } + + /** + */ + public void testTwoResourcesDOM() throws Exception { + // Create resources + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + IFile rc1 = ResourceHelper.createFile(project, "rc1"); + assertNotNull(rc1); + IFile rc2 = ResourceHelper.createFile(project, "rc2"); + assertNotNull(rc2); + assertFalse(rc1.getFullPath().equals(rc2.getFullPath())); + + Element elementProvider = null; + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + List entries2 = new ArrayList(); + entries2.add(new CIncludePathEntry("path2", 0)); + + { + // create a provider + LanguageSettingsSerializable mockProvider = null; + mockProvider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + mockProvider.setSettingEntries(null, rc1, null, entries); + mockProvider.setSettingEntries(null, rc2, null, entries2); + + // serialize language settings to DOM + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_TEST); + elementProvider = mockProvider.serialize(rootElement); + String xml = XmlUtil.toString(elementProvider.getOwnerDocument()); +// fail(xml); // for debugging + } + { + // re-load and check language settings of the newly loaded provider + LanguageSettingsSerializable loadedProvider = new LanguageSettingsSerializable(elementProvider); + + List actual = loadedProvider.getSettingEntries(null, rc1, null); + assertEquals(entries.get(0), actual.get(0)); + assertEquals(entries.size(), actual.size()); + + List actual2 = loadedProvider.getSettingEntries(null, rc2, null); + assertEquals(entries2.get(0), actual2.get(0)); + assertEquals(entries2.size(), actual2.size()); + } + } + + /** + */ + public void testParentFolder() throws Exception { + // Create model project and accompanied descriptions + IProject project = ResourceHelper.createCDTProjectWithConfig(this.getName()); + + // Create resources + IFolder parentFolder = ResourceHelper.createFolder(project, "/ParentFolder/"); + assertNotNull(parentFolder); + IFile emptySettingsPath = ResourceHelper.createFile(project, "/ParentFolder/Subfolder/empty"); + assertNotNull(emptySettingsPath); + + // Create provider + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + + // store the entries in parent folder + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path0", 0)); + provider.setSettingEntries(null, parentFolder, LANG_ID, entries); + provider.setSettingEntries(null, emptySettingsPath, LANG_ID, new ArrayList()); + + { + // retrieve entries for a parent folder itself + List actual = provider.getSettingEntries(null, parentFolder, LANG_ID); + assertEquals(entries,actual); + assertEquals(entries.size(), actual.size()); + } + + { + // retrieve entries for a derived resource (in a subfolder) + IFile derived = ResourceHelper.createFile(project, "/ParentFolder/Subfolder/resource"); + List actual = provider.getSettingEntries(null, derived, LANG_ID); + // NOT taken from parent folder + assertEquals(null,actual); + } + + { + // retrieve entries for not related resource + IFile notRelated = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path("/AnotherFolder/Subfolder/resource")); + List actual = provider.getSettingEntries(null, notRelated, LANG_ID); + assertEquals(null,actual); + } + + { + // test distinction between no settings and empty settings + List actual = provider.getSettingEntries(null, emptySettingsPath, LANG_ID); + // NOT taken from parent folder and not null + assertEquals(0, actual.size()); + } + } + + /** + */ + public void testEquals() throws Exception { + List sampleEntries_1 = new ArrayList(); + sampleEntries_1.add(new CMacroEntry("MACRO0", "value0",1)); + sampleEntries_1.add(new CIncludePathEntry("path0", 1)); + sampleEntries_1.add(new CIncludePathEntry("path1", 1)); + + List sampleEntries_2 = new ArrayList(); + sampleEntries_2.add(new CIncludePathEntry("path0", 1)); + + List sampleLanguages = new ArrayList(); + sampleLanguages.add(LANG_ID); + + // create a model provider + LanguageSettingsSerializable provider1 = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider1.setLanguageScope(sampleLanguages); + provider1.setCustomParameter(CUSTOM_PARAMETER); + assertEquals(false, provider1.isStoringEntriesInProjectArea()); + provider1.setStoringEntriesInProjectArea(true); + provider1.setSettingEntries(MOCK_CFG, MOCK_RC, LANG_ID, sampleEntries_1); + provider1.setSettingEntries(null, null, LANG_ID, sampleEntries_2); + + { + // create another provider with the same data + LanguageSettingsSerializable provider2 = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + assertFalse(provider1.equals(provider2)); + assertFalse(provider1.hashCode()==provider2.hashCode()); + + provider2.setSettingEntries(MOCK_CFG, MOCK_RC, LANG_ID, sampleEntries_1); + assertFalse(provider1.equals(provider2)); + assertFalse(provider1.hashCode()==provider2.hashCode()); + + provider2.setSettingEntries(null, null, LANG_ID, sampleEntries_2); + assertFalse(provider1.equals(provider2)); + assertFalse(provider1.hashCode()==provider2.hashCode()); + + provider2.setLanguageScope(sampleLanguages); + assertFalse(provider1.equals(provider2)); + assertFalse(provider1.hashCode()==provider2.hashCode()); + + provider2.setCustomParameter(CUSTOM_PARAMETER); + assertFalse(provider1.equals(provider2)); + assertFalse(provider1.hashCode()==provider2.hashCode()); + + provider2.setStoringEntriesInProjectArea(true); + + // All set now, so they should be equal + assertTrue(provider1.equals(provider2)); + assertTrue(provider1.hashCode()==provider2.hashCode()); + + // check different ID + provider2.setId(PROVIDER_2); + assertFalse(provider1.equals(provider2)); + assertFalse(provider1.hashCode()==provider2.hashCode()); + } + + { + // check that subclasses are not equal + LanguageSettingsSerializable providerSub1 = new LanguageSettingsSerializable() {}; + LanguageSettingsSerializable providerSub2 = new LanguageSettingsSerializable() {}; + assertFalse(providerSub1.equals(providerSub2)); + assertFalse(providerSub1.hashCode()==providerSub2.hashCode()); + } + } + + /** + */ + public void testClone() throws Exception { + // define sample data + List sampleEntries_1 = new ArrayList(); + sampleEntries_1.add(new CIncludePathEntry("path0", 1)); + sampleEntries_1.add(new CIncludePathEntry("path1", 1)); + sampleEntries_1.add(new CMacroEntry("MACRO0", "value0",1)); + + List sampleEntries_2 = new ArrayList(); + sampleEntries_2.add(new CIncludePathEntry("path0", 1)); + + List sampleLanguages = new ArrayList(); + sampleLanguages.add(LANG_ID); + + // create a model provider + class LanguageSettingsSerializableMock extends LanguageSettingsSerializable implements Cloneable { + public LanguageSettingsSerializableMock(String id, String name) { + super(id, name); + } + @Override + public LanguageSettingsSerializableMock clone() throws CloneNotSupportedException { + return (LanguageSettingsSerializableMock) super.clone(); + } + + } + LanguageSettingsSerializableMock provider1 = new LanguageSettingsSerializableMock(PROVIDER_1, PROVIDER_NAME_1); + provider1.setLanguageScope(sampleLanguages); + provider1.setCustomParameter(CUSTOM_PARAMETER); + assertEquals(false, provider1.isStoringEntriesInProjectArea()); + provider1.setStoringEntriesInProjectArea(true); + provider1.setSettingEntries(MOCK_CFG, MOCK_RC, LANG_ID, sampleEntries_1); + provider1.setSettingEntries(null, null, LANG_ID, sampleEntries_2); + + // clone provider + LanguageSettingsSerializableMock providerClone = provider1.clone(); + assertNotSame(provider1, providerClone); + assertTrue(provider1.equals(providerClone)); + assertTrue(provider1.getClass()==providerClone.getClass()); + assertEquals(provider1.getCustomParameter(), providerClone.getCustomParameter()); + assertEquals(provider1.isStoringEntriesInProjectArea(), providerClone.isStoringEntriesInProjectArea()); + assertEquals(provider1.getLanguageScope().get(0), providerClone.getLanguageScope().get(0)); + + List actual1 = providerClone.getSettingEntries(MOCK_CFG, MOCK_RC, LANG_ID); + assertNotSame(sampleEntries_1, actual1); + assertEquals(sampleEntries_1.get(0), actual1.get(0)); + assertEquals(sampleEntries_1.get(1), actual1.get(1)); + assertEquals(sampleEntries_1.get(2), actual1.get(2)); + assertEquals(sampleEntries_1.size(), actual1.size()); + + List actual2 = providerClone.getSettingEntries(null, null, LANG_ID); + assertNotSame(sampleEntries_2, actual2); + assertEquals(sampleEntries_2.get(0), actual2.get(0)); + assertEquals(sampleEntries_2.size(), actual2.size()); + } + + /** + */ + public void testCloneShallow() throws Exception { + // define sample data + List sampleLanguages = new ArrayList(); + sampleLanguages.add(LANG_ID); + + // create a model provider + class LanguageSettingsSerializableMock extends LanguageSettingsSerializable implements Cloneable { + public LanguageSettingsSerializableMock(String id, String name) { + super(id, name); + } + @Override + public LanguageSettingsSerializableMock cloneShallow() throws CloneNotSupportedException { + return (LanguageSettingsSerializableMock) super.cloneShallow(); + } + + } + LanguageSettingsSerializableMock provider1 = new LanguageSettingsSerializableMock(PROVIDER_1, PROVIDER_NAME_1); + provider1.setLanguageScope(sampleLanguages); + provider1.setCustomParameter(CUSTOM_PARAMETER); + assertEquals(false, provider1.isStoringEntriesInProjectArea()); + provider1.setStoringEntriesInProjectArea(true); + + List entries = new ArrayList(); + entries.add(new CIncludePathEntry("path", 1)); + provider1.setSettingEntries(null, null, null, entries); + + // clone provider + LanguageSettingsSerializableMock providerClone = provider1.cloneShallow(); + assertNotSame(provider1, providerClone); + assertFalse(provider1.equals(providerClone)); + assertTrue(provider1.getClass()==providerClone.getClass()); + assertEquals(provider1.getCustomParameter(), providerClone.getCustomParameter()); + assertEquals(provider1.isStoringEntriesInProjectArea(), providerClone.isStoringEntriesInProjectArea()); + assertEquals(provider1.getLanguageScope().get(0), providerClone.getLanguageScope().get(0)); + + List actual = providerClone.getSettingEntries(null, null, null); + assertNull(actual); + } + + /** + */ + public void testSort_Kinds() throws Exception { + // create sample entries + CIncludePathEntry includePathEntry1 = new CIncludePathEntry("path1", 0); + CIncludePathEntry includePathEntry2 = new CIncludePathEntry("path2", 0); + CMacroEntry macroEntry1 = new CMacroEntry("MACRO1", null, 0); + CMacroEntry macroEntry2 = new CMacroEntry("MACRO2", null, 0); + CIncludeFileEntry includeFileEntry1 = new CIncludeFileEntry("file1", 0); + CIncludeFileEntry includeFileEntry2 = new CIncludeFileEntry("file2", 0); + CMacroFileEntry macroFileEntry1 = new CMacroFileEntry("file1", 0); + CMacroFileEntry macroFileEntry2 = new CMacroFileEntry("file2", 0); + CLibraryPathEntry libraryPathEntry1 = new CLibraryPathEntry("lib1", 0); + CLibraryPathEntry libraryPathEntry2 = new CLibraryPathEntry("lib2", 0); + CLibraryFileEntry libraryFileEntry1 = new CLibraryFileEntry("file1", 0); + CLibraryFileEntry libraryFileEntry2 = new CLibraryFileEntry("file2", 0); + + // place entries in unsorted list + List unsortedEntries = new ArrayList(); + unsortedEntries.add(macroEntry1); + unsortedEntries.add(macroFileEntry1); + unsortedEntries.add(macroEntry2); + unsortedEntries.add(includePathEntry1); + unsortedEntries.add(includeFileEntry1); + unsortedEntries.add(macroFileEntry2); + unsortedEntries.add(libraryFileEntry1); + unsortedEntries.add(includeFileEntry2); + unsortedEntries.add(libraryFileEntry2); + unsortedEntries.add(libraryPathEntry1); + unsortedEntries.add(includePathEntry2); + unsortedEntries.add(libraryPathEntry2); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, unsortedEntries); + + // retrieve and check that language settings got sorted properly + int i=0; + List actual = provider.getSettingEntries(null, null, null); + assertEquals(includePathEntry1, actual.get(i++)); + assertEquals(includePathEntry2, actual.get(i++)); + assertEquals(includeFileEntry1, actual.get(i++)); + assertEquals(includeFileEntry2, actual.get(i++)); + assertEquals(macroEntry1, actual.get(i++)); + assertEquals(macroEntry2, actual.get(i++)); + assertEquals(macroFileEntry1, actual.get(i++)); + assertEquals(macroFileEntry2, actual.get(i++)); + assertEquals(libraryPathEntry1, actual.get(i++)); + assertEquals(libraryPathEntry2, actual.get(i++)); + assertEquals(libraryFileEntry1, actual.get(i++)); + assertEquals(libraryFileEntry2, actual.get(i++)); + + assertEquals(unsortedEntries.size(), actual.size()); + } + + /** + */ + public void testSort_Entries() throws Exception { + // create sample entries + CIncludePathEntry includePathEntry1 = new CIncludePathEntry("path_B", 0); + CIncludePathEntry includePathEntry2 = new CIncludePathEntry("path_A", 0); + CMacroEntry macroEntry1 = new CMacroEntry("MACRO_A", null, 0); + CMacroEntry macroEntry2 = new CMacroEntry("MACRO_B", null, 0); + CIncludeFileEntry includeFileEntry1 = new CIncludeFileEntry("file_B", 0); + CIncludeFileEntry includeFileEntry2 = new CIncludeFileEntry("file_A", 0); + CMacroFileEntry macroFileEntry1 = new CMacroFileEntry("file_B", 0); + CMacroFileEntry macroFileEntry2 = new CMacroFileEntry("file_A", 0); + CLibraryPathEntry libraryPathEntry1 = new CLibraryPathEntry("lib_B", 0); + CLibraryPathEntry libraryPathEntry2 = new CLibraryPathEntry("lib_A", 0); + CLibraryFileEntry libraryFileEntry1 = new CLibraryFileEntry("file_B", 0); + CLibraryFileEntry libraryFileEntry2 = new CLibraryFileEntry("file_A", 0); + + // place entries in unsorted list + List unsortedEntries = new ArrayList(); + // macros will be sorted by name + unsortedEntries.add(macroEntry2); + unsortedEntries.add(macroEntry1); + // paths are not sorted only grouped by kind + unsortedEntries.add(macroFileEntry1); + unsortedEntries.add(macroFileEntry2); + unsortedEntries.add(includePathEntry1); + unsortedEntries.add(includePathEntry2); + unsortedEntries.add(includeFileEntry1); + unsortedEntries.add(includeFileEntry2); + unsortedEntries.add(libraryFileEntry1); + unsortedEntries.add(libraryFileEntry2); + unsortedEntries.add(libraryPathEntry1); + unsortedEntries.add(libraryPathEntry2); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, unsortedEntries); + + // retrieve and check that language settings got sorted properly + int i=0; + List actual = provider.getSettingEntries(null, null, null); + assertEquals(includePathEntry1, actual.get(i++)); + assertEquals(includePathEntry2, actual.get(i++)); + assertEquals(includeFileEntry1, actual.get(i++)); + assertEquals(includeFileEntry2, actual.get(i++)); + assertEquals(macroEntry1, actual.get(i++)); + assertEquals(macroEntry2, actual.get(i++)); + assertEquals(macroFileEntry1, actual.get(i++)); + assertEquals(macroFileEntry2, actual.get(i++)); + assertEquals(libraryPathEntry1, actual.get(i++)); + assertEquals(libraryPathEntry2, actual.get(i++)); + assertEquals(libraryFileEntry1, actual.get(i++)); + assertEquals(libraryFileEntry2, actual.get(i++)); + + assertEquals(unsortedEntries.size(), actual.size()); + } + + /** + */ + public void testSort_Undef() throws Exception { + // create sample entries + CMacroEntry macroEntry1 = new CMacroEntry("MACRO_1", null, 0); + CMacroEntry macroEntry2A = new CMacroEntry("MACRO_2", null, ICSettingEntry.UNDEFINED); + CMacroEntry macroEntry2B = new CMacroEntry("MACRO_2", null, 0); + CMacroEntry macroEntry2C = new CMacroEntry("MACRO_2", null, ICSettingEntry.BUILTIN); + CMacroEntry macroEntry3 = new CMacroEntry("MACRO_3", null, 0); + + // place entries in unsorted list + List unsortedEntries = new ArrayList(); + // macros will be sorted by name and keep order for the same name + unsortedEntries.add(macroEntry2A); + unsortedEntries.add(macroEntry3); + unsortedEntries.add(macroEntry2B); + unsortedEntries.add(macroEntry1); + unsortedEntries.add(macroEntry2C); + + // create a provider and set the entries + LanguageSettingsSerializable provider = new LanguageSettingsSerializable(PROVIDER_1, PROVIDER_NAME_1); + provider.setSettingEntries(null, null, null, unsortedEntries); + + // retrieve and check that language settings got sorted properly + int i=0; + List actual = provider.getSettingEntries(null, null, null); + assertEquals(macroEntry1, actual.get(i++)); + assertEquals(macroEntry2A, actual.get(i++)); + assertEquals(macroEntry2B, actual.get(i++)); + assertEquals(macroEntry2C, actual.get(i++)); + assertEquals(macroEntry3, actual.get(i++)); + + assertEquals(unsortedEntries.size(), actual.size()); + } + +} + + diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsBaseProvider.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsBaseProvider.java new file mode 100644 index 00000000000..afae2a4cb50 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsBaseProvider.java @@ -0,0 +1,19 @@ +/******************************************************************************* + * Copyright (c) 2009, 2009 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider; + + +public class MockLanguageSettingsBaseProvider extends LanguageSettingsBaseProvider { + +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsEditableProvider.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsEditableProvider.java new file mode 100644 index 00000000000..32b907c017b --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsEditableProvider.java @@ -0,0 +1,33 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; + + +public class MockLanguageSettingsEditableProvider extends LanguageSettingsSerializable implements ILanguageSettingsEditableProvider { + public MockLanguageSettingsEditableProvider() { + super(); + } + + public MockLanguageSettingsEditableProvider(String id, String name) { + super(id, name); + } + + public MockLanguageSettingsEditableProvider cloneShallow() throws CloneNotSupportedException { + return (MockLanguageSettingsEditableProvider) super.cloneShallow(); + } + + public MockLanguageSettingsEditableProvider clone() throws CloneNotSupportedException { + return (MockLanguageSettingsEditableProvider) super.clone(); + } +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsProvider.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsProvider.java new file mode 100644 index 00000000000..96024c7db45 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsProvider.java @@ -0,0 +1,28 @@ +/******************************************************************************* + * Copyright (c) 2009, 2009 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.List; + +import org.eclipse.cdt.core.AbstractExecutableExtensionBase; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.core.resources.IResource; + +public class MockLanguageSettingsProvider extends AbstractExecutableExtensionBase + implements ILanguageSettingsProvider { + + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + return null; + } +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsSerializableProvider.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsSerializableProvider.java new file mode 100644 index 00000000000..276a3400b93 --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockLanguageSettingsSerializableProvider.java @@ -0,0 +1,25 @@ +/******************************************************************************* + * Copyright (c) 2009, 2009 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; + + +public class MockLanguageSettingsSerializableProvider extends LanguageSettingsSerializable { + public MockLanguageSettingsSerializableProvider() { + super(); + } + + public MockLanguageSettingsSerializableProvider(String id, String name) { + super(id, name); + } +} diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockListenerRegisterer.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockListenerRegisterer.java new file mode 100644 index 00000000000..4afb94905ef --- /dev/null +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/MockListenerRegisterer.java @@ -0,0 +1,102 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.core.runtime.Assert; + +/** + * Language Settings Provider that keeps count how many times it has been registered. + */ +public class MockListenerRegisterer extends LanguageSettingsSerializable implements ILanguageSettingsEditableProvider, ICListenerRegisterer { + private static MockListenerManager mockListenerManager = new MockListenerManager(); + + private static class MockListenerManager { + private class ListenerCount { + private MockListenerRegisterer listener; + private int count; + public ListenerCount(MockListenerRegisterer l, int cnt) { + listener = l; + count = cnt; + } + } + private List register = new ArrayList(); + + public void registerListener(MockListenerRegisterer listener) { + for (ListenerCount lc : register) { + if (lc.listener == listener) { + lc.count++; + return; + } + } + + register.add(new ListenerCount(listener, 1)); + } + + public void unregisterListener(MockListenerRegisterer listener) { + for (ListenerCount lc : register) { + if (lc.listener == listener) { + lc.count--; + Assert.isTrue(lc.count>=0); + return; + } + } + + // attempt to unregister non-registered listener + Assert.isTrue(false); + } + + /** + * Note that that count includes all listeners with that id. + */ + public int getCount(String id) { + int count = 0; + + for (ListenerCount lc : register) { + if (lc.listener.getId().equals(id)) { + count = count + lc.count; + } + } + + return count; + } + } + + public MockListenerRegisterer() { + super(); + } + public MockListenerRegisterer(String id, String name) { + super(id, name); + } + public void registerListener(ICConfigurationDescription cfgDescription) { + mockListenerManager.registerListener(this); + } + + public void unregisterListener() { + mockListenerManager.unregisterListener(this); + } + @Override + public MockListenerRegisterer cloneShallow() throws CloneNotSupportedException { + return (MockListenerRegisterer) super.cloneShallow(); + } + @Override + public MockListenerRegisterer clone() throws CloneNotSupportedException { + return (MockListenerRegisterer) super.clone(); + } + + public static int getCount(String id) { + return mockListenerManager.getCount(id); + } +} \ No newline at end of file diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/model/tests/AllCoreTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/model/tests/AllCoreTests.java index b6738d6a07d..f9f98edac7a 100644 --- a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/model/tests/AllCoreTests.java +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/model/tests/AllCoreTests.java @@ -14,6 +14,7 @@ package org.eclipse.cdt.core.model.tests; import junit.framework.Test; import junit.framework.TestSuite; +import org.eclipse.cdt.core.language.settings.providers.AllLanguageSettingsProvidersCoreTests; import org.eclipse.cdt.core.settings.model.AllCProjectDescriptionTests; import org.eclipse.cdt.core.settings.model.PathSettingsContainerTests; @@ -60,6 +61,8 @@ public class AllCoreTests { suite.addTest(AsmModelBuilderTest.suite()); suite.addTest(CModelBuilderBugsTest.suite()); suite.addTest(Bug311189.suite()); + + suite.addTest(AllLanguageSettingsProvidersCoreTests.suite()); return suite; } diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/settings/model/CProjectDescriptionDeltaTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/settings/model/CProjectDescriptionDeltaTests.java index ff562be920b..4d80b3adff7 100644 --- a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/settings/model/CProjectDescriptionDeltaTests.java +++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/settings/model/CProjectDescriptionDeltaTests.java @@ -19,6 +19,8 @@ import java.util.Map; import junit.framework.TestSuite; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.settings.model.util.CDataUtil; import org.eclipse.cdt.core.testplugin.ResourceHelper; @@ -994,5 +996,52 @@ public class CProjectDescriptionDeltaTests extends BaseTestCase{ ICProjectDescription newSetting = (ICProjectDescription)delta.getNewSetting(); assertEquals(cfgDescription1.getName(), newSetting.getDefaultSettingConfiguration().getName()); } + + public void testDelta_LANGUAGE_SETTINGS_PROVIDERS() throws Exception { + String projName = getName(); + ICProjectDescriptionManager mngr = CoreModel.getDefault().getProjectDescriptionManager(); + + initListener(projName); + IProject project = ResourceHelper.createCDTProjectWithConfig(projName); + + // Get writable project description and its configuration + ICProjectDescription prjDescription = mngr.getProjectDescription(project, true); + assertNotNull(prjDescription); + ICConfigurationDescription cfgDescription = prjDescription.getConfigurations()[0]; + assertNotNull(cfgDescription); + List originalProviders = cfgDescription.getLanguageSettingProviders(); + + // Modification LANGUAGE_SETTINGS_PROVIDERS + ILanguageSettingsProvider provider = new LanguageSettingsSerializable("id", "name"); + List providers = new ArrayList(); + providers.add(provider); + cfgDescription.setLanguageSettingProviders(providers); + + // Write project description + listener.clearNotified(); + mngr.setProjectDescription(project, prjDescription); + assertEquals(true, listener.isNotified()); + + // Analyze delta + ICDescriptionDelta rootDelta = listener.getDelta(); + assertNotNull(rootDelta); + List deltas = findDeltas(rootDelta, ICDescriptionDelta.LANGUAGE_SETTINGS_PROVIDERS); + assertEquals(1, deltas.size()); + ICDescriptionDelta delta = deltas.get(0); + assertNotNull(delta); + assertEquals(ICDescriptionDelta.LANGUAGE_SETTINGS_PROVIDERS, delta.getChangeFlags()); + + // Check old setting + assertTrue(delta.getOldSetting() instanceof ICConfigurationDescription); + ICConfigurationDescription oldSetting = (ICConfigurationDescription)delta.getOldSetting(); + List oldProviders = oldSetting.getLanguageSettingProviders(); + assertEquals(originalProviders, oldProviders); + + // Check new setting + assertTrue(delta.getNewSetting() instanceof ICConfigurationDescription); + ICConfigurationDescription newSetting = (ICConfigurationDescription)delta.getNewSetting(); + List newProviders = newSetting.getLanguageSettingProviders(); + assertEquals(providers, newProviders); + } } diff --git a/core/org.eclipse.cdt.core.tests/parser/org/eclipse/cdt/internal/index/tests/IndexProviderManagerTest.java b/core/org.eclipse.cdt.core.tests/parser/org/eclipse/cdt/internal/index/tests/IndexProviderManagerTest.java index 34a600877e2..e1a55874e49 100644 --- a/core/org.eclipse.cdt.core.tests/parser/org/eclipse/cdt/internal/index/tests/IndexProviderManagerTest.java +++ b/core/org.eclipse.cdt.core.tests/parser/org/eclipse/cdt/internal/index/tests/IndexProviderManagerTest.java @@ -25,6 +25,7 @@ import org.eclipse.cdt.core.index.IIndex; import org.eclipse.cdt.core.index.provider.IIndexProvider; import org.eclipse.cdt.core.internal.index.provider.test.DummyProviderTraces; import org.eclipse.cdt.core.internal.index.provider.test.Providers; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.model.ICProject; import org.eclipse.cdt.core.parser.util.ArrayUtil; @@ -704,6 +705,12 @@ class MockConfig implements ICConfigurationDescription { } public void setReadOnly(boolean readOnly, boolean keepModify) {} + + public void setLanguageSettingProviders(List providers) {} + + public List getLanguageSettingProviders() { + return null; + } } /* @@ -760,4 +767,4 @@ class MockPDOM extends EmptyIndexFragment { public String toString() { return "[Mock index fragment "+id+"."+System.identityHashCode(this)+"]"; } -} \ No newline at end of file +} diff --git a/core/org.eclipse.cdt.core.tests/plugin.xml b/core/org.eclipse.cdt.core.tests/plugin.xml index 4e9b99437e5..c8588c34993 100644 --- a/core/org.eclipse.cdt.core.tests/plugin.xml +++ b/core/org.eclipse.cdt.core.tests/plugin.xml @@ -159,6 +159,13 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + getReferenceInfo() { + return null; + } + + public void setReferenceInfo(Map refs) throws WriteAccessException { + } + + public ICExternalSetting[] getExternalSettings() { + return null; + } + + public ICExternalSetting createExternalSetting(String[] languageIDs, + String[] contentTypeIds, String[] extensions, + ICSettingEntry[] entries) throws WriteAccessException { + return null; + } + + public void removeExternalSetting(ICExternalSetting setting) throws WriteAccessException { + } + + public void removeExternalSettings() throws WriteAccessException { + } + + public ICBuildSetting getBuildSetting() { + return null; + } + + public ICdtVariablesContributor getBuildVariablesContributor() { + return null; + } + + public Object getSessionProperty(QualifiedName name) { + return null; + } + + public void setSessionProperty(QualifiedName name, Object value) { + } + + public void setName(String name) throws WriteAccessException { + } + + public ICConfigExtensionReference[] get(String extensionPointID) { + return null; + } + + public ICConfigExtensionReference create(String extensionPoint, String extension) throws CoreException { + return null; + } + + public void remove(ICConfigExtensionReference ext) throws CoreException { + } + + public void remove(String extensionPoint) throws CoreException { + } + + public boolean isPreferenceConfiguration() { + return false; + } + + public ICLanguageSetting getLanguageSettingForFile(IPath path, boolean ignoreExludeStatus) { + return null; + } + + public void setExternalSettingsProviderIds(String[] ids) { + } + + public String[] getExternalSettingsProviderIds() { + return null; + } + + public void updateExternalSettingsProviders(String[] ids) throws WriteAccessException { + } + + public CConfigurationStatus getConfigurationStatus() { + return null; + } + + public void setLanguageSettingProviders(List providers) { + } + + public List getLanguageSettingProviders() { + return null; + } + + } +} diff --git a/core/org.eclipse.cdt.core/META-INF/MANIFEST.MF b/core/org.eclipse.cdt.core/META-INF/MANIFEST.MF index 69e4f77e5dc..c81a487398c 100644 --- a/core/org.eclipse.cdt.core/META-INF/MANIFEST.MF +++ b/core/org.eclipse.cdt.core/META-INF/MANIFEST.MF @@ -27,6 +27,7 @@ Export-Package: org.eclipse.cdt.core, org.eclipse.cdt.core.index.export, org.eclipse.cdt.core.index.provider, org.eclipse.cdt.core.language, + org.eclipse.cdt.core.language.settings.providers, org.eclipse.cdt.core.model, org.eclipse.cdt.core.model.util, org.eclipse.cdt.core.parser, @@ -66,6 +67,7 @@ Export-Package: org.eclipse.cdt.core, org.eclipse.cdt.internal.core.index.provider;x-internal:=true, org.eclipse.cdt.internal.core.indexer;x-internal:=true, org.eclipse.cdt.internal.core.language;x-friends:="org.eclipse.cdt.ui", + org.eclipse.cdt.internal.core.language.settings.providers;x-internal:=true, org.eclipse.cdt.internal.core.model;x-friends:="org.eclipse.cdt.ui,org.eclipse.cdt.debug.core,org.eclipse.cdt.debug.ui", org.eclipse.cdt.internal.core.model.ext;x-friends:="org.eclipse.cdt.ui", org.eclipse.cdt.internal.core.parser;x-internal:=true, diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ICListenerRegisterer.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ICListenerRegisterer.java new file mode 100644 index 00000000000..df953e20808 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ICListenerRegisterer.java @@ -0,0 +1,24 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; + + +/** + * Helper class to allow listeners self-register/dispose. Called by cdt core. + * TODO - expand in more detail. + */ +public interface ICListenerRegisterer { + public void registerListener(ICConfigurationDescription cfgDescription); + public void unregisterListener(); +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ILanguageSettingsEditableProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ILanguageSettingsEditableProvider.java new file mode 100644 index 00000000000..83052f276d9 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ILanguageSettingsEditableProvider.java @@ -0,0 +1,34 @@ +/******************************************************************************* + * Copyright (c) 2009, 2009 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.List; + +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.core.resources.IResource; + +/** + * This interface is used in UI to identify classes allowing user to modify settings externally + * contrary to some subclasses of {@link LanguageSettingsSerializable} managing + * their settings themselves and not providing such option to the user. + * + */ +public interface ILanguageSettingsEditableProvider extends ILanguageSettingsProvider, Cloneable { + + public void setSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId, List entries); + public boolean isEmpty(); + public void clear(); + + public ILanguageSettingsEditableProvider cloneShallow() throws CloneNotSupportedException; + public ILanguageSettingsEditableProvider clone() throws CloneNotSupportedException; +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ILanguageSettingsProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ILanguageSettingsProvider.java new file mode 100644 index 00000000000..e8a30f39a24 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ILanguageSettingsProvider.java @@ -0,0 +1,65 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.List; + +import org.eclipse.cdt.core.model.LanguageManager; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.core.resources.IResource; + +/** + * Base interface to provide list of {@link ICLanguageSettingEntry}. + * This interface is used to deliver additions to compiler options such as + * include paths (-I) or preprocessor defines (-D) and others (see + * {@link ICSettingEntry#INCLUDE_PATH} and other kinds). + * + * To define a provider like that use extension point + * {@code org.eclipse.cdt.core.LanguageSettingsProvider} and implement this + * interface. CDT provides a few general use implementations such as + * {@link LanguageSettingsBaseProvider} which could be used out of the box or + * extended. See extension point schema description LanguageSettingsProvider.exsd + * for more details. + * + * @since 6.0 + */ +public interface ILanguageSettingsProvider { + /** + * Id is used to keep track of the providers internally. Use unique id + * to represent the provider. + * + * @return Id of the provider. + */ + public String getId(); + + /** + * Name is used to present the provider to the end user in UI. + * + * @return name of the provider. + */ + public String getName(); + + /** + * Returns the list of setting entries for the given configuration description, + * resource and language. + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id + * (see {@link LanguageManager#getLanguageForFile(org.eclipse.core.resources.IFile, ICConfigurationDescription)}). + * + * @return the list of setting entries or {@code null} if no settings defined. + */ + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId); +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsBaseProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsBaseProvider.java new file mode 100644 index 00000000000..03e049eeb95 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsBaseProvider.java @@ -0,0 +1,175 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.eclipse.cdt.core.AbstractExecutableExtensionBase; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.core.resources.IResource; + +/** + * {@code LanguageSettingsBaseProvider} is a basic implementation of {@link ILanguageSettingsProvider} + * defined in {@code org.eclipse.cdt.core.LanguageSettingsProvider} extension point. + * + * This implementation supports "static" list of entries for languages specified in + * the extension point. + * + * @since 6.0 + */ +public class LanguageSettingsBaseProvider extends AbstractExecutableExtensionBase implements ILanguageSettingsProvider { + /** Language scope, i.e. list of languages the entries will be provided for. */ + protected List languageScope = null; + + /** Custom parameter. Intended for providers extending this class. */ + protected String customParameter = null; + + /** List of entries defined by this provider. */ + private List entries = null; + + /** + * Default constructor. + */ + public LanguageSettingsBaseProvider() { + } + + /** + * Constructor. Creates an "empty" provider. + * + * @param id - id of the provider. + * @param name - name of the provider to be presented to a user. + */ + public LanguageSettingsBaseProvider(String id, String name) { + super(id, name); + } + + /** + * Constructor. + * + * @param id - id of the provider. + * @param name - name of the provider to be presented to a user. + * @param languages - list of languages the {@code entries} provided for. + * {@code languages} can be {@code null}, in this case the {@code entries} + * are provided for any language. + * @param entries - the list of language settings entries this provider provides. + * If {@code null} is passed, the provider creates an empty list. + */ + public LanguageSettingsBaseProvider(String id, String name, List languages, List entries) { + super(id, name); + this.languageScope = languages!=null ? new ArrayList(languages) : null; + this.entries = cloneList(entries); + } + + /** + * Constructor. + * + * @param id - id of the provider. + * @param name - name of the provider to be presented to a user. + * @param languages - list of languages the {@code entries} provided for. + * {@code languages} can be {@code null}, in this case the {@code entries} + * are provided for any language. + * @param entries - the list of language settings entries this provider provides. + * If {@code null} is passed, the provider creates an empty list. + * @param customParameter - a custom parameter as the means to customize + * providers extending this class. + */ + public LanguageSettingsBaseProvider(String id, String name, List languages, List entries, String customParameter) { + super(id, name); + this.languageScope = languages!=null ? new ArrayList(languages) : null; + this.entries = cloneList(entries); + this.customParameter = customParameter; + } + + /** + * A method to configure the provider. The initialization of provider from + * the extension point is done in 2 steps. First, the class is created as + * an executable extension using the default provider. Then this method is + * used to configure the provider. + * + * FIXME It is not allowed to reconfigure the provider. + * + * @param id - id of the provider. + * @param name - name of the provider to be presented to a user. + * @param languages - list of languages the {@code entries} provided for. + * {@code languages} can be {@code null}, in this case the {@code entries} + * are provided for any language. + * @param entries - the list of language settings entries this provider provides. + * If {@code null} is passed, the provider creates an empty list. + * @param customParameter - a custom parameter as the means to customize + * providers extending this class from extension definition in {@code plugin.xml}. + * + * FIXME @throws UnsupportedOperationException if an attempt to reconfigure provider is made. + */ + public void configureProvider(String id, String name, List languages, List entries, String customParameter) { +// if (this.entries!=null) +// throw new UnsupportedOperationException(SettingsModelMessages.getString("LanguageSettingsBaseProvider.CanBeConfiguredOnlyOnce")); //$NON-NLS-1$ + + setId(id); + setName(name); + this.languageScope = languages!=null ? new ArrayList(languages) : null; + this.entries = cloneList(entries); + this.customParameter = customParameter; + } + + /** + * {@inheritDoc} + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. If {@code null}, then entries defined for + * the language scope are returned. See {@link #getLanguageScope()} + */ + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + if (languageScope==null) { + if (entries==null) + return null; + return Collections.unmodifiableList(entries); + } + for (String lang : languageScope) { + if (lang.equals(languageId)) { + if (entries==null) + return null; + return Collections.unmodifiableList(entries); + } + } + return null; + } + + /** + * @return the list of languages this provider provides for. + * If {@code null}, the provider provides for any language. + */ + public List getLanguageScope() { + if (languageScope==null) + return null; + return Collections.unmodifiableList(languageScope); + } + + /** + * @return the custom parameter defined in the extension in {@code plugin.xml}. + */ + public String getCustomParameter() { + return customParameter; + } + + /** + * @param entries + * @return copy of the list of the entries. + */ + private List cloneList(List entries) { + return entries!=null ? new ArrayList(entries) : null; + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java new file mode 100644 index 00000000000..09d6bb1c910 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java @@ -0,0 +1,259 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.model.ILanguage; +import org.eclipse.cdt.core.model.LanguageManager; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICFileDescription; +import org.eclipse.cdt.core.settings.model.ICFolderDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSetting; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICResourceDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsExtensionManager; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; + +/** + * A collection of utility methods to manage language settings providers. + * See {@link ILanguageSettingsProvider}. + * + * @since 6.0 + */ +public class LanguageSettingsManager { + /** + * Returns the list of setting entries of the given provider + * for the given configuration description, resource and language. + * This method reaches to the parent folder of the resource recursively + * in case the resource does not define the entries for the given provider. + * + * @param provider - language settings provider. + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * + * @return the list of setting entries. Never returns {@code null} + * although individual providers return {@code null} if no settings defined. + */ + public static List getSettingEntriesUpResourceTree(ILanguageSettingsProvider provider, ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + return LanguageSettingsProvidersSerializer.getSettingEntriesUpResourceTree(provider, cfgDescription, rc, languageId); + } + + /** + * Builds for the provider a nice looking resource tree to present hierarchical view to the user. + * + * TODO - Note that after using this method for a while for BOP parsers it appears that disadvantages + * outweight benefits. In particular, it doesn't result in saving memory as the language settings + * (and the lists itself) are not duplicated in memory anyway but optimized with using WeakHashSet + * and SafeStringInterner. + * + * @param provider - language settings provider to build the tree for. + * @param cfgDescription - configuration description. + * @param languageId - language ID. + * @param project - the project which is considered the root of the resource tree. + */ + public static void buildResourceTree(LanguageSettingsSerializable provider, ICConfigurationDescription cfgDescription, String languageId, IProject project) { + LanguageSettingsProvidersSerializer.buildResourceTree(provider, cfgDescription, languageId, project); + } + + + /** + * Returns the list of setting entries of a certain kind (such as include paths) + * for the given configuration description, resource and language. This is a + * combined list for all providers taking into account settings of parent folder + * if settings for the given resource are not defined. + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * @param kind - kind of language settings entries, such as + * {@link ICSettingEntry#INCLUDE_PATH} etc. This is a binary flag + * and it is possible to specify composite kind. + * Use {@link ICSettingEntry#ALL} to get all kinds. + * + * @return the list of setting entries. + */ + // FIXME: get rid of callers PathEntryTranslator and DescriptionScannerInfoProvider + public static List getSettingEntriesByKind(ICConfigurationDescription cfgDescription, IResource rc, String languageId, int kind) { + return LanguageSettingsProvidersSerializer.getSettingEntriesByKind(cfgDescription, rc, languageId, kind); + } + + /** + * Get Language Settings Provider defined in the workspace. That includes user-defined + * providers and after that providers defined as extensions via + * {@code org.eclipse.cdt.core.LanguageSettingsProvider} extension point. + * That returns actual object, any modifications will affect any configuration + * referring to the provider. + * + * @param id - id of provider to find. + * @return the provider or {@code null} if provider is not defined. + */ + public static ILanguageSettingsProvider getWorkspaceProvider(String id) { + return LanguageSettingsProvidersSerializer.getWorkspaceProvider(id); + } + + /** + * @return a list of language settings providers defined on workspace level. + * That includes user-defined providers and after that providers defined as + * extensions via {@code org.eclipse.cdt.core.LanguageSettingsProvider} + * extension point. + */ + public static List getWorkspaceProviders() { + return LanguageSettingsProvidersSerializer.getWorkspaceProviders(); + } + + /** + * Checks if the provider is defined on the workspace level. + * + * @param provider - provider to check. + * @return {@code true} if the given provider is workspace provider, {@code false} otherwise. + */ + public static boolean isWorkspaceProvider(ILanguageSettingsProvider provider) { + return LanguageSettingsProvidersSerializer.isWorkspaceProvider(provider); + } + + /** + * TODO - helper method for often used chunk of code + * @param provider + * @return ILanguageSettingsProvider + */ + public static ILanguageSettingsProvider getRawProvider(ILanguageSettingsProvider provider) { + if (LanguageSettingsManager.isWorkspaceProvider(provider)){ + provider = LanguageSettingsProvidersSerializer.getRawWorkspaceProvider(provider.getId()); + } + return provider; + } + + + /** + * Set and store in workspace area user defined providers. + * + * @param providers - array of user defined workspace providers. + * Note that those providers will shadow extension providers with the same ID. + * All not shadowed extension providers will be added to the list to be present + * as workspace providers. {@code null} is equivalent to passing an empty array + * and so will reset workspace providers to match extension providers. + * @throws CoreException in case of problems (such as problems with persistence). + */ + public static void setWorkspaceProviders(List providers) throws CoreException { + LanguageSettingsProvidersSerializer.setWorkspaceProviders(providers); + } + + /** + * Get Language Settings Provider defined via + * {@code org.eclipse.cdt.core.LanguageSettingsProvider} extension point. + * + * @param id - ID of provider to find. + * @return the copy of the provider if possible (i.e. for {@link ILanguageSettingsEditableProvider}) + * or workspace provider if provider is not copyable. + */ + public static ILanguageSettingsProvider getExtensionProviderCopy(String id) { + ILanguageSettingsProvider provider = null; + try { + provider = LanguageSettingsExtensionManager.getExtensionProviderClone(id); + } catch (CloneNotSupportedException e) { + // from here falls to get workspace provider + } + if (provider==null) + provider = LanguageSettingsManager.getWorkspaceProvider(id); + + return provider; + } + + /** + * Find language IDs for the resource represented by resource description. + * Under the hood build component is inquired and the language IDs would + * commonly come from the input type(s). + * + * @param rcDescription - resource description + * @return list of language IDs for the resource. + * Never returns {@code null} but empty list if no languages can be found. + * + */ + public static List getLanguages(ICResourceDescription rcDescription) { + ICLanguageSetting[] languageSettings = null; + if (rcDescription instanceof ICFileDescription) { + ICLanguageSetting languageSetting = ((ICFileDescription)rcDescription).getLanguageSetting(); + if (languageSetting != null) { + languageSettings = new ICLanguageSetting[] {languageSetting}; + } + } else if (rcDescription instanceof ICFolderDescription) { + languageSettings = ((ICFolderDescription)rcDescription).getLanguageSettings(); + } + + List languageIds = new ArrayList(); + if (languageSettings != null) { + for (ICLanguageSetting languageSetting : languageSettings) { + if (languageSetting!=null) { + String languageId = languageSetting.getLanguageId(); + if (languageId != null && !languageId.isEmpty()) { + languageIds.add(languageId); + } + } + } + } + + return languageIds; + } + + /** + * Find language IDs for the resource in given build configuration. + * Under the hood build component is inquired and the language IDs would + * commonly come from the input type(s). + * + * @param resource - the resource to find languages for. + * @param cfgDescription + * @return list of language IDs for the resource. + * Never returns {@code null} but empty list if no languages can be found. + */ + public static List getLanguages(IResource resource, ICConfigurationDescription cfgDescription) { + List languageIds = new ArrayList(); + IPath prjRelPath = resource.getProjectRelativePath(); + if (resource instanceof IFile) { + String langId = null; + if (cfgDescription != null) { + ICLanguageSetting ls = cfgDescription.getLanguageSettingForFile(prjRelPath, true); + if (ls != null) { + langId = ls.getLanguageId(); + } + } else { + try { + ILanguage lang = LanguageManager.getInstance().getLanguageForFile((IFile) resource, null); + langId = lang.getId(); + } catch (CoreException e) { + CCorePlugin.log(e); + } + } + if (langId != null) { + languageIds.add(langId); + } + } else { + ICResourceDescription rcDes = cfgDescription.getResourceDescription(prjRelPath, false); + if (rcDes == null) { + rcDes = cfgDescription.getRootFolderDescription(); + } + languageIds = getLanguages(rcDes); + } + + return languageIds; + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager_TBD.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager_TBD.java new file mode 100644 index 00000000000..39edb52603b --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager_TBD.java @@ -0,0 +1,69 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.List; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsExtensionManager; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; + +/** + * This temporary class keeps the utility methods being looking for better home + */ +public class LanguageSettingsManager_TBD { + public static final String PROVIDER_UNKNOWN = "org.eclipse.cdt.projectmodel.4.0.0"; + public static final String PROVIDER_UI_USER = "org.eclipse.cdt.ui.user.LanguageSettingsProvider"; + public static final char PROVIDER_DELIMITER = LanguageSettingsProvidersSerializer.PROVIDER_DELIMITER; + + public static boolean isCustomizedResource(ICConfigurationDescription cfgDescription, IResource rc) { + if (rc instanceof IProject) + return false; + + for (ILanguageSettingsProvider provider: cfgDescription.getLanguageSettingProviders()) { + // FIXME +// if (!LanguageSettingsManager.isWorkspaceProvider(provider)) { + if (provider instanceof ILanguageSettingsEditableProvider || provider instanceof LanguageSettingsSerializable) { + for (String languageId : LanguageSettingsManager.getLanguages(rc, cfgDescription)) { + List list = provider.getSettingEntries(cfgDescription, rc, languageId); + if (list!=null) { + List listDefault = provider.getSettingEntries(null, null, languageId); + // != is OK here due as the equal lists will have the same reference in WeakHashSet + if (list != listDefault) + return true; + } + } + } + } + + return false; + } + + public static boolean isReconfigured(ILanguageSettingsProvider provider) { + if (provider instanceof ILanguageSettingsEditableProvider) { + try { + return ! LanguageSettingsExtensionManager.equalsExtensionProviderShallow((ILanguageSettingsEditableProvider) provider); + } catch (Exception e) { + CCorePlugin.log("Internal Error: cannot clone provider "+provider.getId(), e); + } + } + return false; + } + + public static boolean isEqualExtensionProvider(ILanguageSettingsProvider provider) { + return LanguageSettingsExtensionManager.equalsExtensionProvider(provider); + } +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java new file mode 100644 index 00000000000..3437ccd30c7 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializable.java @@ -0,0 +1,418 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.List; + +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsStorage; +import org.eclipse.core.resources.IResource; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + + +/** + * This class is the base class for language settings providers able to serialize + * into XML storage. + * + * TODO - more JavaDoc, info and hints about class hierarchy + * + */ +public class LanguageSettingsSerializable extends LanguageSettingsBaseProvider { + public static final String ELEM_PROVIDER = "provider"; //$NON-NLS-1$ + private static final String ATTR_ID = "id"; //$NON-NLS-1$ + + private static final String ELEM_LANGUAGE_SCOPE = "language-scope"; //$NON-NLS-1$ + private static final String ATTR_NAME = "name"; //$NON-NLS-1$ + private static final String ATTR_CLASS = "class"; //$NON-NLS-1$ + private static final String ATTR_PARAMETER = "parameter"; //$NON-NLS-1$ + private static final String ATTR_STORE_ENTRIES = "store-entries"; //$NON-NLS-1$ + private static final String VALUE_WORKSPACE = "workspace"; //$NON-NLS-1$ + private static final String VALUE_PROJECT = "project"; //$NON-NLS-1$ + + /** Tells if language settings entries are persisted with the project or in workspace area while serializing. */ + private boolean storeEntriesInProjectArea = false; + + private LanguageSettingsStorage fStorage = new LanguageSettingsStorage(); + + /** + * Default constructor. This constructor has to be always followed with setting id and name of the provider. + */ + public LanguageSettingsSerializable() { + super(); + } + + /** + * Constructor. + * + * @param id - id of the provider. + * @param name - name of the provider. Note that this name may show up in UI. + */ + public LanguageSettingsSerializable(String id, String name) { + super(id, name); + } + + /** + * Constructor which allows to instantiate provider defined via XML markup. + * + * @param elementProvider + */ + public LanguageSettingsSerializable(Element elementProvider) { + super(); + load(elementProvider); + } + + @Override + public void configureProvider(String id, String name, List languages, List entries, String customParameter) { + // do not pass entries to super, keep them in local storage + super.configureProvider(id, name, languages, null, customParameter); + + fStorage.clear(); + + if (entries!=null) { + // note that these entries are intended to be retrieved by LanguageSettingsManager.getSettingEntriesUpResourceTree() + // when the whole resource hierarchy has been traversed up + setSettingEntries(null, null, null, entries); + } + } + + /** + * @return {@code true} if the provider does not keep any settings yet or {@code false} if there are some. + */ + public boolean isEmpty() { + return fStorage.isEmpty(); + } + + /** + * Set the language scope of the provider. + * + * @param languages - the list of languages this provider provides for. + * If {@code null}, the provider provides for any language. + * + * @see #getLanguageScope() + */ + public void setLanguageScope(List languages) { + if (languages==null) + this.languageScope = null; + else + this.languageScope = new ArrayList(languages); + } + + /** + * Set custom parameter for the provider. + * Subclasses are free to define how their behavior depends on custom parameter. + * + * @param customParameter + */ + public void setCustomParameter(String customParameter) { + this.customParameter = customParameter; + } + + /** + * Tells if language settings entries are persisted with the project (under .settings folder) + * or in workspace area. Persistence in the project area lets the entries migrate with the + * project. + * + * @return {@code true} if LSE persisted with the project or {@code false} if in the workspace. + */ + public boolean isStoringEntriesInProjectArea() { + return storeEntriesInProjectArea; + } + + /** + * Setter to define where language settings are persisted. + * @param storeEntriesWithProject - {@code true} if with the project, + * {@code false} if in workspace area. + */ + public void setStoringEntriesInProjectArea(boolean storeEntriesWithProject) { + this.storeEntriesInProjectArea = storeEntriesWithProject; + } + + /** + * Clear all the entries for all configurations, all resources and all languages. + */ + public void clear() { + fStorage.clear(); + } + + /** + * Sets language settings entries for the provider. + * Note that the entries are not persisted at that point. To persist use TODO + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. If {@code null}, then entries are considered to be defined for + * the language scope. See {@link #getLanguageScope()} + * @param entries - language settings entries to set. + */ + public void setSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId, List entries) { + String rcProjectPath = rc!=null ? rc.getProjectRelativePath().toString() : null; + fStorage.setSettingEntries(rcProjectPath, languageId, entries); + } + + /** + * {@inheritDoc} + *
+ * Note that this list is unmodifiable. To modify the list copy it, change and use + * {@link #setSettingEntries(ICConfigurationDescription, IResource, String, List)}. + *
+ * Note also that you can compare these lists with simple equality operator ==, + * as lists themselves are backed by WeakHashSet> where + * identical copies (deep comparison is used) are replaced with the same one instance. + */ + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + List entries = fStorage.getSettingEntries(cfgDescription, rc, languageId); + if (entries == null) { + if (languageId!=null && (languageScope==null || languageScope.contains(languageId))) { + entries = getSettingEntries(cfgDescription, rc, null); + } + } + + return entries; + } + + /** + * Serialize the provider under parent XML element. + * This is convenience method not intended to be overridden on purpose. + * Override {@link #serializeAttributes(Element)} or + * {@link #serializeEntries(Element)} instead. + * + * @param parentElement - element where to serialize. + * @return - newly created element. That element will already be + * attached to the parent element. + */ + final public Element serialize(Element parentElement) { + /* + + + + + + + + + */ + Element elementProvider = serializeAttributes(parentElement); + serializeEntries(elementProvider); + return elementProvider; + } + + /** + * Serialize the provider attributes under parent XML element. That is + * equivalent to serializing everything (including language scope) except entries. + * + * @param parentElement - element where to serialize. + * @return - newly created element. That element will already be + * attached to the parent element. + */ + public Element serializeAttributes(Element parentElement) { + Element elementProvider = XmlUtil.appendElement(parentElement, ELEM_PROVIDER, new String[] { + ATTR_ID, getId(), + ATTR_NAME, getName(), + ATTR_CLASS, getClass().getCanonicalName(), + ATTR_PARAMETER, getCustomParameter(), + ATTR_STORE_ENTRIES, isStoringEntriesInProjectArea() ? VALUE_PROJECT : VALUE_WORKSPACE, + }); + + if (languageScope!=null) { + for (String langId : languageScope) { + XmlUtil.appendElement(elementProvider, ELEM_LANGUAGE_SCOPE, new String[] {ATTR_ID, langId}); + } + } + return elementProvider; + } + + /** + * Serialize the provider entries under parent XML element. + * @param elementProvider - element where to serialize the entries. + */ + public void serializeEntries(Element elementProvider) { + fStorage.serializeEntries(elementProvider); + } + + /** + * Load provider from XML provider element. + * This is convenience method not intended to be overridden on purpose. + * Override {@link #loadAttributes(Element)} or + * {@link #loadEntries(Element)} instead. + * + * @param providerNode - XML element to load provider from. + */ + final public void load(Element providerNode) { + fStorage.clear(); + languageScope = null; + + // provider/configuration/language/resource/entry + if (providerNode!=null) { + loadAttributes(providerNode); + loadEntries(providerNode); + } + } + + /** + * Determine and set language scope from given XML node. + */ + private void loadLanguageScopeElement(Node parentNode) { + if (languageScope==null) { + languageScope = new ArrayList(); + } + String id = XmlUtil.determineAttributeValue(parentNode, ATTR_ID); + languageScope.add(id); + + } + + /** + * Load attributes from XML provider element. + * @param providerNode - XML element to load attributes from. + */ + public void loadAttributes(Element providerNode) { + String providerId = XmlUtil.determineAttributeValue(providerNode, ATTR_ID); + String providerName = XmlUtil.determineAttributeValue(providerNode, ATTR_NAME); + String providerParameter = XmlUtil.determineAttributeValue(providerNode, ATTR_PARAMETER); + String providerStoreEntries = XmlUtil.determineAttributeValue(providerNode, ATTR_STORE_ENTRIES); + + this.setId(providerId); + this.setName(providerName); + this.setCustomParameter(providerParameter); + this.setStoringEntriesInProjectArea(VALUE_PROJECT.equals(providerStoreEntries)); + + NodeList nodes = providerNode.getChildNodes(); + for (int i=0;i where entries are defined. + */ + public void loadEntries(Element providerNode) { + fStorage.loadEntries(providerNode); + } + + /** + * See {@link #cloneShallow()}. This method is extracted + * to avoid expressing {@link #clone()} via {@link #cloneShallow()}. + */ + private LanguageSettingsSerializable cloneShallowInternal() throws CloneNotSupportedException { + LanguageSettingsSerializable clone = (LanguageSettingsSerializable)super.clone(); + if (languageScope!=null) + clone.languageScope = new ArrayList(languageScope); + + clone.fStorage = new LanguageSettingsStorage(); + return clone; + } + + /** + * Shallow clone of the provider. "Shallow" is defined here as the exact copy except that + * the copy will have zero language settings entries. + * + * @return shallow copy of the provider. + * @throws CloneNotSupportedException in case {@link #clone()} throws the exception. + */ + protected LanguageSettingsSerializable cloneShallow() throws CloneNotSupportedException { + return cloneShallowInternal(); + } + + @Override + protected LanguageSettingsSerializable clone() throws CloneNotSupportedException { + LanguageSettingsSerializable clone = cloneShallowInternal(); + clone.fStorage = fStorage.cloneStorage(); + return clone; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((getId() == null) ? 0 : getId().hashCode()); + result = prime * result + ((getName() == null) ? 0 : getName().hashCode()); + result = prime * result + ((languageScope == null) ? 0 : languageScope.hashCode()); + result = prime * result + ((customParameter == null) ? 0 : customParameter.hashCode()); + result = prime * result + (storeEntriesInProjectArea ? 0 : 1); + result = prime * result + ((fStorage == null) ? 0 : fStorage.hashCode()); + result = prime * result + getClass().hashCode(); + return result; + } + + /** + * @return {@code true} if the objects are equal, {@code false } otherwise. + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + LanguageSettingsSerializable other = (LanguageSettingsSerializable) obj; + + String id = getId(); + String otherId = other.getId(); + if (id == null) { + if (otherId != null) + return false; + } else if (!id.equals(otherId)) + return false; + + String name = getName(); + String otherName = other.getName(); + if (name == null) { + if (otherName != null) + return false; + } else if (!name.equals(otherName)) + return false; + + if (languageScope == null) { + if (other.languageScope != null) + return false; + } else if (!languageScope.equals(other.languageScope)) + return false; + + if (customParameter == null) { + if (other.customParameter != null) + return false; + } else if (!customParameter.equals(other.customParameter)) + return false; + + if (storeEntriesInProjectArea!=other.storeEntriesInProjectArea) + return false; + + if (fStorage == null) { + if (other.fStorage != null) + return false; + } else if (!fStorage.equals(other.fStorage)) + return false; + return true; + } + + /** + * @noreference This method is not intended to be referenced by clients. + */ + public LanguageSettingsStorage getStorageInternal() { + return fStorage; + } +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableEditable.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableEditable.java new file mode 100644 index 00000000000..22465b7b6e4 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableEditable.java @@ -0,0 +1,28 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +// TODO: move ILanguageSettingsEditableProvider here + +// TODO this one is unused - remove +final public class LanguageSettingsSerializableEditable extends LanguageSettingsSerializable implements ILanguageSettingsEditableProvider { + @Override + public LanguageSettingsSerializableEditable clone() throws CloneNotSupportedException { + return (LanguageSettingsSerializableEditable) super.clone(); + } + + @Override + public LanguageSettingsSerializableEditable cloneShallow() throws CloneNotSupportedException { + return (LanguageSettingsSerializableEditable) super.cloneShallow(); + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ScannerDiscoveryLegacySupport.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ScannerDiscoveryLegacySupport.java new file mode 100644 index 00000000000..df9429f4770 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/ScannerDiscoveryLegacySupport.java @@ -0,0 +1,129 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core.language.settings.providers; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.internal.core.LocalProjectScope; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.runtime.preferences.InstanceScope; +import org.osgi.service.prefs.BackingStoreException; +import org.osgi.service.prefs.Preferences; + +/** + * Collection of utilities for legacy support of older Scanner Discovery functionality. + * This class is temporary and not intended to be used by clients. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ +public class ScannerDiscoveryLegacySupport { + /** Name of MBS language settings provider (from org.eclipse.cdt.managedbuilder.core) */ + public static final String MBS_LANGUAGE_SETTINGS_PROVIDER = "org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider"; //$NON-NLS-1$ + + private static String USE_LANGUAGE_SETTINGS_PROVIDERS_PREFERENCE = "enabled"; //$NON-NLS-1$ +// the default needs to be "false" for legacy projects to be open with old SD enabled for MBS provider + private static boolean USE_LANGUAGE_SETTINGS_PROVIDERS_DEFAULT = false; + private static final String PREFERENCES_QUALIFIER = CCorePlugin.PLUGIN_ID; + private static final String LANGUAGE_SETTINGS_PROVIDERS_NODE = "languageSettingsProviders"; //$NON-NLS-1$ + + private static Map legacyProfiles = null; + + + private static Preferences getPreferences(IProject project) { + if (project == null) + return InstanceScope.INSTANCE.getNode(PREFERENCES_QUALIFIER).node(LANGUAGE_SETTINGS_PROVIDERS_NODE); + else + return new LocalProjectScope(project).getNode(PREFERENCES_QUALIFIER).node(LANGUAGE_SETTINGS_PROVIDERS_NODE); + } + + /** + * Checks if Language Settings functionality is enabled for given project. + * + * @param project - project to check the preference + * @return {@code true} if functionality is enabled + * + * @noreference This method is temporary and not intended to be referenced by clients. + */ + public static boolean isLanguageSettingsProvidersFunctionalityEnabled(IProject project) { + Preferences pref = getPreferences(project); + return pref.getBoolean(USE_LANGUAGE_SETTINGS_PROVIDERS_PREFERENCE, USE_LANGUAGE_SETTINGS_PROVIDERS_DEFAULT); + } + + /** + * Enable/disable Language Settings functionality for the given project. + * + * @param project + * @param value {@code true} to enable or {@code false} to disable the functionality. + * + * @noreference This method is temporary and not intended to be referenced by clients. + */ + public static void setLanguageSettingsProvidersFunctionalityEnabled(IProject project, boolean value) { + Preferences pref = getPreferences(project); + pref.putBoolean(USE_LANGUAGE_SETTINGS_PROVIDERS_PREFERENCE, value); + try { + pref.flush(); + } catch (BackingStoreException e) { + CCorePlugin.log(e); + } + } + + /** + * @noreference This is internal helper method to support compatibility with previous versions + * which is not intended to be referenced by clients. + */ + public static boolean isMbsLanguageSettingsProviderOn(ICConfigurationDescription cfgDescription) { + List lsProviders = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider lsp : lsProviders) { + if (MBS_LANGUAGE_SETTINGS_PROVIDER.equals(lsp.getId())) { + return true; + } + } + return false; + } + + /** + * Returns the values of scanner discovery profiles (scannerConfigDiscoveryProfileId) which were deprecated + * and replaced with language settings providers in plugin.xml. + * This (temporary) function serves as fail-safe switch during the transition. + * + * @param id - can be id of either org.eclipse.cdt.managedbuilder.internal.core.InputType + * or org.eclipse.cdt.managedbuilder.internal.core.ToolChain. + * @return legacy scannerConfigDiscoveryProfileId. + */ + @SuppressWarnings("nls") + public static String getDeprecatedLegacyProfiles(String id) { + if (legacyProfiles == null) { + legacyProfiles = new HashMap(); + + // InputTypes +// legacyProfiles.put(inputTypeId, scannerConfigDiscoveryProfileId); + legacyProfiles.put("cdt.managedbuild.tool.gnu.c.compiler.input", "org.eclipse.cdt.managedbuilder.core.GCCManagedMakePerProjectProfileC|org.eclipse.cdt.make.core.GCCStandardMakePerFileProfile"); + legacyProfiles.put("cdt.managedbuild.tool.gnu.cpp.compiler.input", "org.eclipse.cdt.managedbuilder.core.GCCManagedMakePerProjectProfileCPP|org.eclipse.cdt.make.core.GCCStandardMakePerFileProfile"); + legacyProfiles.put("cdt.managedbuild.tool.gnu.c.compiler.input.cygwin", "org.eclipse.cdt.managedbuilder.core.GCCWinManagedMakePerProjectProfileC"); + legacyProfiles.put("cdt.managedbuild.tool.gnu.cpp.compiler.input.cygwin", "org.eclipse.cdt.managedbuilder.core.GCCWinManagedMakePerProjectProfileCPP"); + legacyProfiles.put("cdt.managedbuild.tool.xlc.c.compiler.input", "org.eclipse.cdt.managedbuilder.xlc.core.XLCManagedMakePerProjectProfile"); + legacyProfiles.put("cdt.managedbuild.tool.xlc.cpp.c.compiler.input", "org.eclipse.cdt.managedbuilder.xlc.core.XLCManagedMakePerProjectProfile"); + legacyProfiles.put("cdt.managedbuild.tool.xlc.cpp.compiler.input", "org.eclipse.cdt.managedbuilder.xlc.core.XLCManagedMakePerProjectProfileCPP"); + + // Toolchains +// legacyProfiles.put(toolchainId, scannerConfigDiscoveryProfileId); + } + + return legacyProfiles.get(id); + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACExclusionFilterEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACExclusionFilterEntry.java index 098b5c62313..e6db0464024 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACExclusionFilterEntry.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACExclusionFilterEntry.java @@ -36,8 +36,9 @@ public abstract class ACExclusionFilterEntry extends ACPathEntry implements ICEx this.exclusionPatterns = exclusionPatterns != null ? (IPath[])exclusionPatterns.clone() : new IPath[0]; } + /** @since 5.3 */ @Override - protected final boolean isFile() { + public final boolean isFile() { return false; } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACPathEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACPathEntry.java index 3835d6e878b..4fbb27a953c 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACPathEntry.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACPathEntry.java @@ -15,8 +15,7 @@ import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.Path; -public abstract class ACPathEntry extends ACSettingEntry - implements ICPathEntry { +public abstract class ACPathEntry extends ACSettingEntry implements ICPathEntry { // IPath fFullPath; // IPath fLocation; // private IPath fPath; @@ -67,8 +66,11 @@ public abstract class ACPathEntry extends ACSettingEntry return rcs[0].getFullPath(); return null; } - - protected abstract boolean isFile(); + + /** + * @since 5.3 + */ + public abstract boolean isFile(); @Override public IPath getLocation() { diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACSettingEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACSettingEntry.java index 840047ff044..0c2dc98335d 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACSettingEntry.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ACSettingEntry.java @@ -56,30 +56,31 @@ public abstract class ACSettingEntry implements ICSettingEntry { } @Override - public boolean equals(Object other){ - if(other == this) + public boolean equals(Object obj) { + if (this == obj) return true; - - if(!(other instanceof ACSettingEntry)) + if (obj == null) return false; - - ACSettingEntry e = (ACSettingEntry)other; - - if(getKind() != e.getKind()) + if (getClass() != obj.getClass()) return false; - - if(fFlags != e.fFlags) + ACSettingEntry other = (ACSettingEntry) obj; + if (fFlags != other.fFlags) return false; - - if(!fName.equals(e.fName)) + if (fName == null) { + if (other.fName != null) + return false; + } else if (!fName.equals(other.fName)) return false; - return true; } @Override - public int hashCode(){ - return getKind() + fFlags + fName.hashCode(); + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + fFlags; + result = prime * result + ((fName == null) ? 0 : fName.hashCode()); + return result; } @Override diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/CMacroEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/CMacroEntry.java index df0c903803d..078b70c1597 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/CMacroEntry.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/CMacroEntry.java @@ -35,15 +35,28 @@ public final class CMacroEntry extends ACSettingEntry implements ICMacroEntry{ } @Override - public boolean equals(Object other) { - if(!super.equals(other)) + public boolean equals(Object obj) { + if (this == obj) + return true; + if (!super.equals(obj)) return false; - return fValue.equals(((CMacroEntry)other).fValue); + if (getClass() != obj.getClass()) + return false; + CMacroEntry other = (CMacroEntry) obj; + if (fValue == null) { + if (other.fValue != null) + return false; + } else if (!fValue.equals(other.fValue)) + return false; + return true; } @Override public int hashCode() { - return super.hashCode() + fValue.hashCode(); + final int prime = 31; + int result = super.hashCode(); + result = prime * result + ((fValue == null) ? 0 : fValue.hashCode()); + return result; } @Override diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java index eac75d44021..8ca2a43140e 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java @@ -10,9 +10,11 @@ *******************************************************************************/ package org.eclipse.cdt.core.settings.model; +import java.util.List; import java.util.Map; import org.eclipse.cdt.core.cdtvariables.ICdtVariablesContributor; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.settings.model.extension.CConfigurationData; import org.eclipse.cdt.core.settings.model.extension.CConfigurationDataProvider; @@ -387,4 +389,31 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin void updateExternalSettingsProviders(String[] ids) throws WriteAccessException; CConfigurationStatus getConfigurationStatus(); + + /** + * Sets the list of language settings providers. Language settings providers are + * used to supply language settings {@link ICLanguageSettingEntry} such as include paths + * or preprocessor macros. + * + * @param providers the list of providers to assign to the configuration description. + * Warning: the providers will be cloned before actual addition to the project model + * due to TODO - very important reason but I forgot why by now. + * + * @since 6.0 + */ + public void setLanguageSettingProviders(List providers); + + /** + * Returns the list of language settings providers. Language settings providers are + * used to supply language settings {@link ICLanguageSettingEntry} such as include paths + * or preprocessor macros. + * + * @return the list of providers to assign to the configuration description. This + * returns immutable list. Use {@link #setLanguageSettingProviders(List)} to change. + * This method does not return {@code null}. + * + * @since 6.0 + */ + public List getLanguageSettingProviders(); + } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICDescriptionDelta.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICDescriptionDelta.java index 8467c6966c9..11172d5d99d 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICDescriptionDelta.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICDescriptionDelta.java @@ -49,7 +49,10 @@ public interface ICDescriptionDelta { // int PATH = 1 << 3; int LANGUAGE_ID = 1 << 4; int SOURCE_CONTENT_TYPE = 1 << 5; - int SOURCE_ENTENSIONS = 1 << 6; + int SOURCE_EXTENSIONS = 1 << 6; + /** @deprecated Use ICDescriptionDelta.SOURCE_EXTENSIONS */ + @Deprecated + int SOURCE_ENTENSIONS = SOURCE_EXTENSIONS; // int HEADER_CONTENT_TYPE = 1 << 7; // int HEADER_ENTENSIONS = 1 << 8; int SETTING_ENTRIES = 1 << 9; @@ -66,6 +69,7 @@ public interface ICDescriptionDelta { int OWNER = 1 << 20; int INDEX_CFG = 1 << 21; int SETTING_CFG = INDEX_CFG; + int LANGUAGE_SETTINGS_PROVIDERS = 1 << 22; /** * specifies that the project "isCdtProjectCreating" state was set to false diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java index 3adc824a568..4cef66d3750 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java @@ -46,6 +46,21 @@ public interface ICSettingEntry { */ int RESOLVED = 1 << 4; + /** + * Flag {@code UNDEFINED} indicates that the entry should not be defined. + * It's main purpose to provide the means to negate entries defined elsewhere. + * + * @since 6.0 + */ + int UNDEFINED = 1 << 5; + + /** + * Flag {@code FRAMEWORKS_MAC} applies for path entries. Such a path entry will be treated + * in a special way to imitate resolving paths by Apple's version of gcc, see bug 69529. + * . + */ + int FRAMEWORKS_MAC = 1 << 6; + int INCLUDE_PATH = 1; int INCLUDE_FILE = 1 << 1; int MACRO = 1 << 2; diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/CDataUtil.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/CDataUtil.java index 4081606adac..761fa3f0cfb 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/CDataUtil.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/CDataUtil.java @@ -56,6 +56,7 @@ import org.eclipse.cdt.core.settings.model.extension.CResourceData; import org.eclipse.cdt.core.settings.model.extension.CTargetPlatformData; import org.eclipse.cdt.core.settings.model.extension.impl.CDataFactory; import org.eclipse.cdt.core.settings.model.extension.impl.CDefaultLanguageData; +import org.eclipse.cdt.internal.core.parser.util.WeakHashSet; import org.eclipse.cdt.internal.core.settings.model.ExceptionFactory; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.ProjectScope; @@ -74,6 +75,14 @@ public class CDataUtil { private static Random randomNumber; public static final String[] EMPTY_STRING_ARRAY = new String[0]; + + private static WeakHashSet languageSettingsPool = new WeakHashSet() { + @Override + public synchronized ICSettingEntry add(ICSettingEntry entry) { + return super.add(entry); + } + + }; public static int genRandomNumber(){ if (randomNumber == null) { @@ -301,25 +310,36 @@ public class CDataUtil { public static ICSettingEntry createEntry(int kind, String name, String value, IPath[] exclusionPatterns, int flags, IPath srcPath, IPath srcRootPath, IPath srcPrefixMapping){ + ICSettingEntry entry = null; switch (kind){ case ICLanguageSettingEntry.INCLUDE_PATH: - return new CIncludePathEntry(name, flags); + entry = new CIncludePathEntry(name, flags); + break; case ICLanguageSettingEntry.MACRO: - return new CMacroEntry(name, value, flags); + entry = new CMacroEntry(name, value, flags); + break; case ICLanguageSettingEntry.INCLUDE_FILE: - return new CIncludeFileEntry(name, flags); + entry = new CIncludeFileEntry(name, flags); + break; case ICLanguageSettingEntry.MACRO_FILE: - return new CMacroFileEntry(name, flags); + entry = new CMacroFileEntry(name, flags); + break; case ICLanguageSettingEntry.LIBRARY_PATH: - return new CLibraryPathEntry(name, flags); + entry = new CLibraryPathEntry(name, flags); + break; case ICLanguageSettingEntry.LIBRARY_FILE: - return new CLibraryFileEntry(name, flags, srcPath, srcRootPath, srcPrefixMapping); + entry = new CLibraryFileEntry(name, flags, srcPath, srcRootPath, srcPrefixMapping); + break; case ICLanguageSettingEntry.OUTPUT_PATH: - return new COutputEntry(name, exclusionPatterns, flags); + entry = new COutputEntry(name, exclusionPatterns, flags); + break; case ICLanguageSettingEntry.SOURCE_PATH: - return new CSourceEntry(name, exclusionPatterns, flags); + entry = new CSourceEntry(name, exclusionPatterns, flags); + break; + default: + throw new IllegalArgumentException(); } - throw new IllegalArgumentException(); + return languageSettingsPool.add(entry); } public static String[] getSourceExtensions(IProject project, CLanguageData data) { diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/LanguageSettingEntriesSerializer.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/LanguageSettingEntriesSerializer.java index a889fa9f68f..7047e40fd55 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/LanguageSettingEntriesSerializer.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/LanguageSettingEntriesSerializer.java @@ -59,6 +59,8 @@ public class LanguageSettingEntriesSerializer { public static final String LOCAL = "LOCAL"; //$NON-NLS-1$ public static final String VALUE_WORKSPACE_PATH = "VALUE_WORKSPACE_PATH"; //$NON-NLS-1$ public static final String RESOLVED = "RESOLVED"; //$NON-NLS-1$ + private static final String UNDEFINED = "UNDEFINED"; //$NON-NLS-1$ + private static final String FRAMEWORK = "FRAMEWORK"; //$NON-NLS-1$ public static final String FLAGS_SEPARATOR = "|"; //$NON-NLS-1$ @@ -280,10 +282,22 @@ public class LanguageSettingEntriesSerializer { buf.append(RESOLVED); } + if((flags & ICLanguageSettingEntry.UNDEFINED) != 0){ + if(buf.length() != 0) + buf.append(FLAGS_SEPARATOR); + + buf.append(UNDEFINED); + } + if((flags & ICLanguageSettingEntry.FRAMEWORKS_MAC) != 0){ + if(buf.length() != 0) + buf.append(FLAGS_SEPARATOR); + + buf.append(FRAMEWORK); + } return buf.toString(); } - private static int composeFlags(String flagsString){ + public static int composeFlags(String flagsString){ if(flagsString == null || flagsString.length() == 0) return 0; @@ -302,6 +316,10 @@ public class LanguageSettingEntriesSerializer { flags |= ICLanguageSettingEntry.VALUE_WORKSPACE_PATH; if(RESOLVED.equals(f)) flags |= ICLanguageSettingEntry.RESOLVED; + if(UNDEFINED.equals(f)) + flags |= ICLanguageSettingEntry.UNDEFINED; + if(FRAMEWORK.equals(f)) + flags |= ICLanguageSettingEntry.FRAMEWORKS_MAC; } return flags; diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/PathEntryTranslator.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/PathEntryTranslator.java index 4a9db6d9ebb..1f197a9da03 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/PathEntryTranslator.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/util/PathEntryTranslator.java @@ -26,6 +26,8 @@ import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.cdtvariables.CdtVariableException; import org.eclipse.cdt.core.cdtvariables.ICdtVariable; import org.eclipse.cdt.core.cdtvariables.ICdtVariableManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.model.CModelException; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.model.CoreModelUtil; @@ -68,6 +70,7 @@ import org.eclipse.cdt.internal.core.CharOperation; import org.eclipse.cdt.internal.core.cdtvariables.CoreVariableSubstitutor; import org.eclipse.cdt.internal.core.cdtvariables.DefaultVariableContextInfo; import org.eclipse.cdt.internal.core.cdtvariables.ICoreVariableContextInfo; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsLogger; import org.eclipse.cdt.internal.core.model.APathEntry; import org.eclipse.cdt.internal.core.model.CModelStatus; import org.eclipse.cdt.internal.core.model.PathEntry; @@ -2003,7 +2006,7 @@ public class PathEntryTranslator { } } - public static PathEntryCollector collectEntries(IProject project, ICConfigurationDescription des) { + public static PathEntryCollector collectEntries(IProject project, final ICConfigurationDescription des) { CConfigurationData data = getCfgData(des); ReferenceSettingsInfo refInfo = new ReferenceSettingsInfo(des); @@ -2038,10 +2041,12 @@ public class PathEntryTranslator { public boolean visit(PathSettingsContainer container) { CResourceData data = (CResourceData)container.getValue(); if (data != null) { + AG_log(des, kinds, data); // AG FIXME REMOVEME + PathEntryCollector child = cr.createChild(container.getPath()); for (int kind : kinds) { List list = new ArrayList(); - if (collectResourceDataEntries(kind, data, list)) { + if (collectResourceDataEntries(des, kind, data, list)) { ICLanguageSettingEntry[] entries = list.toArray(new ICLanguageSettingEntry[list.size()]); child.setEntries(kind, entries, exportedSettings); } @@ -2049,11 +2054,28 @@ public class PathEntryTranslator { } return true; } + + // AG FIXME REMOVEME + private void AG_log(final ICConfigurationDescription des, final int[] kinds, CResourceData data) { + String kindsStr=""; + for (int kind : kinds) { + String kstr = LanguageSettingEntriesSerializer.kindToString(kind); + if (kindsStr.length()==0) { + kindsStr = kstr; + } else { + kindsStr += "|" + kstr; + } + } + final IProject prj = des.getProjectDescription().getProject(); + String log_msg = "path="+prj+"/"+data.getPath()+", kind=["+kindsStr+"]"+" (PathEntryTranslator.collectEntries())"; + LanguageSettingsLogger.logInfo(log_msg); + } + }); return cr; } - private static boolean collectResourceDataEntries(int kind, CResourceData data, List list) { + private static boolean collectResourceDataEntries(ICConfigurationDescription des, int kind, CResourceData data, List list) { CLanguageData[] lDatas = null; if (data instanceof CFolderData) { lDatas = ((CFolderData)data).getLanguageDatas(); @@ -2070,6 +2092,17 @@ public class PathEntryTranslator { return false; } + + IProject project = des.getProjectDescription().getProject(); + if (ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(project)) { + IResource rc = getResource(project, data.getPath()); + for (CLanguageData lData : lDatas) { + list.addAll(LanguageSettingsManager.getSettingEntriesByKind(des, rc, lData.getLanguageId(), kind)); + } + return list.size()>0; + + } + // Legacy logic boolean supported = false; for (CLanguageData lData : lDatas) { if (collectLanguageDataEntries(kind, lData, list)) @@ -2094,4 +2127,14 @@ public class PathEntryTranslator { PathEntryCollector cr = collectEntries(project, cfg); return cr.getEntries(flags, cfg); } + + private static IResource getResource(IProject project, IPath workspacePath) { + IResource rc; + if (project!=null) { + rc = project.findMember(workspacePath); + } else { + rc = ResourcesPlugin.getWorkspace().getRoot().findMember(workspacePath); + } + return rc; + } } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeEvent.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeEvent.java new file mode 100644 index 00000000000..63b07601810 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeEvent.java @@ -0,0 +1,38 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.internal.core.language.settings.providers; + +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; + +/** + * Contains the details of changes that occurred as a result of modifying + * language settings entries {@link ICLanguageSettingEntry}. The event is + * associated with a project. + * + * API notes: this interface probably is not stable yet as it is not currently + * clear how it may need to be used in future. Only bare minimum is provided + * here at this point. + * + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. + */ +public interface ILanguageSettingsChangeEvent { + /** + * @return project name where the event occurred. + */ + public String getProjectName(); + + /** + * @return configuration IDs which are affected by the language settings changes. + */ + public String[] getConfigurationDescriptionIds(); + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java new file mode 100644 index 00000000000..3e0ae4d1a3b --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/ILanguageSettingsChangeListener.java @@ -0,0 +1,26 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.internal.core.language.settings.providers; + +/** + * An interface for listeners to changes in language settings. + * + * @see LanguageSettingsProvidersSerializer#registerLanguageSettingsChangeListener(ILanguageSettingsChangeListener) + * @see LanguageSettingsProvidersSerializer#unregisterLanguageSettingsChangeListener(ILanguageSettingsChangeListener) + */ +public interface ILanguageSettingsChangeListener { + /** + * Indicates that language settings have been changed. + * + * @param event - details of the event. + */ + public void handleEvent(ILanguageSettingsChangeEvent event); +} \ No newline at end of file diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsDelta.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsDelta.java new file mode 100644 index 00000000000..4b88f99e6cf --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsDelta.java @@ -0,0 +1,34 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.internal.core.language.settings.providers; + +import java.util.LinkedHashMap; + + +/** + * This class currently is a placeholder holding old and new states. + * If more details need to be pulled out of delta, it could be elaborated further. + */ +public class LanguageSettingsDelta { + // maps need to be ordered by providers + @SuppressWarnings("unused") + private LinkedHashMap oldLanguageSettingsState; + @SuppressWarnings("unused") + private LinkedHashMap newLanguageSettingsState; + + public LanguageSettingsDelta(LinkedHashMap oldState, LinkedHashMap newState) { + oldLanguageSettingsState = oldState; + newLanguageSettingsState = newState; + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsExtensionManager.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsExtensionManager.java new file mode 100644 index 00000000000..9d7eff5361c --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsExtensionManager.java @@ -0,0 +1,343 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.Comparator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Set; +import java.util.TreeSet; + +import org.eclipse.cdt.core.AbstractExecutableExtensionBase; +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.util.CDataUtil; +import org.eclipse.cdt.core.settings.model.util.LanguageSettingEntriesSerializer; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IConfigurationElement; +import org.eclipse.core.runtime.IExtension; +import org.eclipse.core.runtime.IExtensionPoint; +import org.eclipse.core.runtime.IExtensionRegistry; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Platform; +import org.eclipse.core.runtime.Status; + +/** + * Class {@code LanguageSettingsExtensionManager} manages {@link ILanguageSettingsProvider} extensions + */ +public class LanguageSettingsExtensionManager { + /** Name of the extension point for contributing language settings */ + static final String PROVIDER_EXTENSION_FULL_ID = "org.eclipse.cdt.core.LanguageSettingsProvider"; //$NON-NLS-1$ + static final String PROVIDER_EXTENSION_SIMPLE_ID = "LanguageSettingsProvider"; //$NON-NLS-1$ + + static final String ELEM_PROVIDER = "provider"; //$NON-NLS-1$ + static final String ATTR_CLASS = "class"; //$NON-NLS-1$ + static final String ATTR_ID = "id"; //$NON-NLS-1$ + static final String ATTR_NAME = "name"; //$NON-NLS-1$ + static final String ATTR_PARAMETER = "parameter"; //$NON-NLS-1$ + + static final String ELEM_LANGUAGE_SCOPE = "language-scope"; //$NON-NLS-1$ + + static final String ELEM_ENTRY = "entry"; //$NON-NLS-1$ + static final String ELEM_FLAG = "flag"; //$NON-NLS-1$ + static final String ATTR_KIND = "kind"; //$NON-NLS-1$ + static final String ATTR_VALUE = "value"; //$NON-NLS-1$ + + /** + * Extension providers loaded once. If the provider is editable (read cloneable) + * external callers get copy rather than real instance. + */ + private static final LinkedHashMap fExtensionProviders = new LinkedHashMap(); + + /** + * Providers loaded initially via static initializer. + */ + static { + try { + loadProviderExtensions(); + } catch (Throwable e) { + CCorePlugin.log("Error loading language settings providers extensions", e); //$NON-NLS-1$ + } finally { + } + } + + /** + * Load language settings providers contributed via the extension point. + */ + synchronized private static void loadProviderExtensions() { + // sort by name - for the providers taken from platform extensions + Set sortedProviders = new TreeSet( + new Comparator() { + public int compare(ILanguageSettingsProvider pr1, ILanguageSettingsProvider pr2) { + return pr1.getName().compareTo(pr2.getName()); + } + } + ); + + loadProviderExtensions(Platform.getExtensionRegistry(), sortedProviders); + + fExtensionProviders.clear(); + for (ILanguageSettingsProvider provider : sortedProviders) { + fExtensionProviders.put(provider.getId(), provider); + } + } + + /** + * Load contributed extensions from extension registry. + * + * @param registry - extension registry + * @param providers - resulting set of providers + */ + private static void loadProviderExtensions(IExtensionRegistry registry, Set providers) { + providers.clear(); + IExtensionPoint extension = registry.getExtensionPoint(CCorePlugin.PLUGIN_ID, PROVIDER_EXTENSION_SIMPLE_ID); + if (extension != null) { + IExtension[] extensions = extension.getExtensions(); + for (IExtension ext : extensions) { + for (IConfigurationElement cfgEl : ext.getConfigurationElements()) { + ILanguageSettingsProvider provider = null; + String id=null; + try { + if (cfgEl.getName().equals(ELEM_PROVIDER)) { + id = determineAttributeValue(cfgEl, ATTR_ID); + provider = createExecutableExtension(cfgEl); + configureExecutableProvider(provider, cfgEl); + providers.add(provider); + } + } catch (Throwable e) { + CCorePlugin.log("Cannot load LanguageSettingsProvider extension id=" + id, e); //$NON-NLS-1$ + } + } + } + } + } + + + private static String determineAttributeValue(IConfigurationElement ce, String attr) { + String value = ce.getAttribute(attr); + return value!=null ? value : ""; //$NON-NLS-1$ + } + + /** + * Creates empty non-configured provider as executable extension from extension point definition. + * If "class" attribute is empty {@link LanguageSettingsBaseProvider} is created. + * + * @param ce - configuration element with provider definition + * @return new non-configured provider + * @throws CoreException in case of failure + */ + private static ILanguageSettingsProvider createExecutableExtension(IConfigurationElement ce) throws CoreException { + String ceClass = ce.getAttribute(ATTR_CLASS); + ILanguageSettingsProvider provider = null; + if (ceClass==null || ceClass.trim().length()==0 || ceClass.equals(LanguageSettingsBaseProvider.class.getCanonicalName())) { + provider = new LanguageSettingsBaseProvider(); + } else { + provider = (ILanguageSettingsProvider)ce.createExecutableExtension(ATTR_CLASS); + } + + return provider; + } + + + /** + * Configure language settings provider with parameters defined in XML metadata. + * + * @param provider - empty non-configured provider. + * @param ce - configuration element from registry representing XML. + */ + private static void configureExecutableProvider(ILanguageSettingsProvider provider, IConfigurationElement ce) { + String ceId = determineAttributeValue(ce, ATTR_ID); + String ceName = determineAttributeValue(ce, ATTR_NAME); + String ceParameter = determineAttributeValue(ce, ATTR_PARAMETER); + List languages = null; + List entries = null; + + for (IConfigurationElement ceLang : ce.getChildren(ELEM_LANGUAGE_SCOPE)) { + String langId = determineAttributeValue(ceLang, ATTR_ID); + if (langId.trim().length()>0) { + if (languages==null) { + languages = new ArrayList(); + } + languages.add(langId); + } + } + + for (IConfigurationElement ceEntry : ce.getChildren(ELEM_ENTRY)) { + try { + int entryKind = LanguageSettingEntriesSerializer.stringToKind(determineAttributeValue(ceEntry, ATTR_KIND)); + String entryName = determineAttributeValue(ceEntry, ATTR_NAME); + String entryValue = determineAttributeValue(ceEntry, ATTR_VALUE); + + int flags = 0; + for (IConfigurationElement ceFlags : ceEntry.getChildren(ELEM_FLAG)) { + int bitFlag = LanguageSettingEntriesSerializer.composeFlags(determineAttributeValue(ceFlags, ATTR_VALUE)); + flags |= bitFlag; + } + + ICLanguageSettingEntry entry = (ICLanguageSettingEntry) CDataUtil.createEntry( + entryKind, entryName, entryValue, null, flags); + + if (entries == null) + entries = new ArrayList(); + entries.add(entry); + + } catch (Exception e) { + CCorePlugin.log("Error creating language settings entry ", e); //$NON-NLS-1$ + } + } + + if (provider instanceof LanguageSettingsBaseProvider) { + ((LanguageSettingsBaseProvider) provider).configureProvider(ceId, ceName, languages, entries, ceParameter); + } else if (provider instanceof AbstractExecutableExtensionBase) { + ((AbstractExecutableExtensionBase) provider).setId(ceId); + ((AbstractExecutableExtensionBase) provider).setName(ceName); + } + } + + /** + * Creates empty non-configured provider from extension point definition. The method will + * inspect extension registry for extension point "org.eclipse.cdt.core.LanguageSettingsProvider" + * to determine bundle and instantiate the class. + * ID and name of provider are assigned from first extension point encountered. + * + * @param className - full qualified class name of provider. + * @param registry - extension registry + * @return new non-configured provider + */ + private static ILanguageSettingsProvider createProviderCarcass(String className, IExtensionRegistry registry) { + if (className==null || className.length()==0) { + return new LanguageSettingsBaseProvider(); + } + + try { + IExtensionPoint extension = registry.getExtensionPoint(CCorePlugin.PLUGIN_ID, PROVIDER_EXTENSION_SIMPLE_ID); + if (extension != null) { + IExtension[] extensions = extension.getExtensions(); + for (IExtension ext : extensions) { + for (IConfigurationElement cfgEl : ext.getConfigurationElements()) { + if (cfgEl.getName().equals(ELEM_PROVIDER) && className.equals(cfgEl.getAttribute(ATTR_CLASS))) { + ILanguageSettingsProvider provider = createExecutableExtension(cfgEl); + if (provider instanceof AbstractExecutableExtensionBase) { + String ceId = determineAttributeValue(cfgEl, ATTR_ID); + String ceName = determineAttributeValue(cfgEl, ATTR_NAME); + ((AbstractExecutableExtensionBase) provider).setId(ceId); + ((AbstractExecutableExtensionBase) provider).setName(ceName); + } + return provider; + } + } + } + } + } catch (Exception e) { + CCorePlugin.log("Error creating language settings provider.", e); //$NON-NLS-1$ + } + return null; + } + + /** + * Create an instance of language settings provider of given class name. + * + * @param className - class name to instantiate. + * @return new instance of language settings provider. + */ + /*package*/ static ILanguageSettingsProvider getProviderInstance(String className) { + if (className==null || className.equals(LanguageSettingsSerializable.class.getName())) { + return new LanguageSettingsSerializable(); + } + + ILanguageSettingsProvider provider = createProviderCarcass(className, Platform.getExtensionRegistry()); + if (provider==null) { + IStatus status = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, "Not able to load provider class=" + className); + CCorePlugin.log(new CoreException(status)); + } + return provider; + } + + /** + * Get Language Settings Provider defined via + * {@code org.eclipse.cdt.core.LanguageSettingsProvider} extension point. + * + * @param id - ID of provider to find. + * @return the clone of the provider or {@code null} if provider is not defined. + * @throws CloneNotSupportedException if the provider is not cloneable + */ + public static ILanguageSettingsProvider getExtensionProviderClone(String id) throws CloneNotSupportedException { + ILanguageSettingsProvider provider = fExtensionProviders.get(id); + if (provider!=null) { + if (!(provider instanceof ILanguageSettingsEditableProvider)) + throw new CloneNotSupportedException("Not able to clone provider " + provider.getClass()); + + provider = ((ILanguageSettingsEditableProvider) provider).clone(); + } + return provider; + } + + /** + * TODO + * + * @param id + * @return + */ + public static ILanguageSettingsProvider getExtensionProviderShallow(String id) { + ILanguageSettingsProvider provider = fExtensionProviders.get(id); + if (provider instanceof ILanguageSettingsEditableProvider) { + try { + return ((ILanguageSettingsEditableProvider) provider).cloneShallow(); + } catch (CloneNotSupportedException e) { + IStatus status = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, "Not able to clone provider " + provider.getClass()); + CCorePlugin.log(new CoreException(status)); + return null; + } + } + return provider; + } + + /** + * @return list of providers contributed by all extensions. Preferable copy but if not possible + * will return raw provider. + */ + /*package*/ static List getExtensionProvidersInternal() { + ArrayList list = new ArrayList(fExtensionProviders.size()); + for (String id : fExtensionProviders.keySet()) { + ILanguageSettingsProvider extensionProvider = null; + try { + extensionProvider = getExtensionProviderClone(id); + } catch (CloneNotSupportedException e) { + // from here falls to get raw extension provider + } + if (extensionProvider==null) + extensionProvider = fExtensionProviders.get(id); + + if (extensionProvider!=null) + list.add(extensionProvider); + } + return list; + } + + public static boolean equalsExtensionProviderShallow(ILanguageSettingsEditableProvider provider) throws CloneNotSupportedException { + String id = provider.getId(); + ILanguageSettingsProvider extensionProviderShallow = getExtensionProviderShallow(id); + return provider.cloneShallow().equals(extensionProviderShallow); + } + + public static boolean equalsExtensionProvider(ILanguageSettingsProvider provider) { + String id = provider.getId(); + ILanguageSettingsProvider extensionProvider = fExtensionProviders.get(id); + return provider.equals(extensionProvider); + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsLogger.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsLogger.java new file mode 100644 index 00000000000..40d7c54fcfa --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsLogger.java @@ -0,0 +1,79 @@ +package org.eclipse.cdt.internal.core.language.settings.providers; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Status; + +@Deprecated +public class LanguageSettingsLogger { + + public static boolean isEnabled() { + return false; +// return true; + } + + // AG FIXME + /** + * @param msg + * @noreference This method is not intended to be referenced by clients. + */ + @Deprecated + public static void logInfo(String msg) { + if (isEnabled()) { + Exception e = new Exception(msg); + IStatus status = new Status(IStatus.INFO, CCorePlugin.PLUGIN_ID, msg, e); + CCorePlugin.log(status); + } + } + + // AG FIXME + /** + * @param msg + * @noreference This method is not intended to be referenced by clients. + */ + @Deprecated + public static void logWarning(String msg) { + if (isEnabled()) { + Exception e = new Exception(msg); + IStatus status = new Status(IStatus.WARNING, CCorePlugin.PLUGIN_ID, msg, e); + CCorePlugin.log(status); + } + } + + // AG FIXME + /** + * @param msg + * @noreference This method is not intended to be referenced by clients. + */ + @Deprecated + public static void logError(String msg) { + if (isEnabled()) { + Exception e = new Exception(msg); + IStatus status = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, msg, e); + CCorePlugin.log(status); + } + } + + // AG FIXME + /** + * @param rc + * @param who - pass "this" (calling class instance) here + * @noreference This method is not intended to be referenced by clients. + */ + @Deprecated + public static void logScannerInfoProvider(IResource rc, Object who) { + if (isEnabled()) { + String msg = "rc="+rc+" <-- "+who.getClass().getSimpleName(); + if (rc instanceof IFile) { + LanguageSettingsLogger.logInfo(msg); + } else if (rc instanceof IProject) { + LanguageSettingsLogger.logWarning(msg); + } else { + LanguageSettingsLogger.logError(msg); + } + } + } +} \ No newline at end of file diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java new file mode 100644 index 00000000000..165a28722d9 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsProvidersSerializer.java @@ -0,0 +1,1289 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.core.language.settings.providers; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ICListenerRegisterer; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; +import org.eclipse.cdt.core.model.ILanguage; +import org.eclipse.cdt.core.model.LanguageManager; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.settings.model.CConfigurationSpecSettings; +import org.eclipse.cdt.internal.core.settings.model.IInternalCCfgInfo; +import org.eclipse.core.filesystem.URIUtil; +import org.eclipse.core.resources.IContainer; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.IWorkspaceRoot; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.Assert; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.ListenerList; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.ILock; +import org.eclipse.core.runtime.jobs.Job; +import org.eclipse.core.runtime.preferences.IEclipsePreferences; +import org.eclipse.core.runtime.preferences.InstanceScope; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + +public class LanguageSettingsProvidersSerializer { + private static final String PREFERENCE_WORSPACE_PROVIDERS_SET = "language.settings.providers.set.for.workspace"; + private static final String STORAGE_WORKSPACE_LANGUAGE_SETTINGS = "language.settings.xml"; //$NON-NLS-1$ + private static final String SETTINGS_FOLDER_NAME = ".settings/"; //$NON-NLS-1$ + private static final String STORAGE_PROJECT_LANGUAGE_SETTINGS = "language.settings.xml"; //$NON-NLS-1$ + public static final char PROVIDER_DELIMITER = ';'; + private static final String ELEM_PLUGIN = "plugin"; //$NON-NLS-1$ + private static final String ELEM_EXTENSION = "extension"; //$NON-NLS-1$ + private static final String ATTR_POINT = "point"; //$NON-NLS-1$ + private static final String ELEM_PROJECT = "project"; //$NON-NLS-1$ + private static final String ELEM_CONFIGURATION = "configuration"; //$NON-NLS-1$ + private static final String ELEM_PROVIDER = "provider"; //$NON-NLS-1$ + private static final String ELEM_PROVIDER_REFERENCE = "provider-reference"; //$NON-NLS-1$ + + private static ILock serializingLock = Job.getJobManager().newLock(); + + /** Cache of globally available providers to be consumed by calling clients */ + private static Map rawGlobalWorkspaceProviders = new HashMap(); + private static Map globalWorkspaceProviders = new HashMap(); + + private static ListenerList fLanguageSettingsChangeListeners = new ListenerList(ListenerList.IDENTITY); + + private static class ListenerAssociation { + private ICListenerRegisterer listener; + private ICConfigurationDescription cfgDescription; + + public ListenerAssociation(ICListenerRegisterer li, ICConfigurationDescription cfgd) { + listener = li; + cfgDescription = cfgd; + } + } + + private static class LanguageSettingsWorkspaceProvider implements ILanguageSettingsProvider, ICListenerRegisterer { + private String providerId; + private int projectCount = 0; + + private LanguageSettingsWorkspaceProvider(String id) { + Assert.isNotNull(id); + providerId = id; + } + + @Override + public String getId() { + return providerId; + } + + @Override + public String getName() { + ILanguageSettingsProvider rawProvider = getRawProvider(); + String name = rawProvider!=null ? rawProvider.getName() : null; + return name; + } + + @Override + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + ILanguageSettingsProvider rawProvider = getRawProvider(); + List entries = rawProvider!=null ? rawProvider.getSettingEntries(cfgDescription, rc, languageId) : null; + return entries; + } + + /** + * Do not cache the "raw" provider as workspace provider can be changed at any time. + */ + private ILanguageSettingsProvider getRawProvider() { + return LanguageSettingsProvidersSerializer.getRawWorkspaceProvider(providerId); + } + + @Override + public boolean equals(Object obj) { + if (obj instanceof LanguageSettingsWorkspaceProvider) { + LanguageSettingsWorkspaceProvider that = (LanguageSettingsWorkspaceProvider) obj; + return providerId.equals(that.providerId); + } + return false; + } + /** + * Method toString() for debugging purposes. + */ + @SuppressWarnings("nls") + @Override + public String toString() { + return "id="+getId()+", name="+getName(); + } + + /** + * We count number of times workspace provider (not the raw one!) associated + * with a project. If a project includes it multiple times via different configurations + * it still counts as 1. + */ + private int getProjectCount() { + return projectCount; + } + + private synchronized int incrementProjectCount() { + projectCount++; + return projectCount; + } + + private synchronized int decrementProjectCount() { + projectCount--; + return projectCount; + } + + @Override + public void registerListener(ICConfigurationDescription cfgDescription) { + // keep in mind that rawProvider can change + ILanguageSettingsProvider rawProvider = getRawProvider(); + if (rawProvider instanceof ICListenerRegisterer) { + ((ICListenerRegisterer) rawProvider).registerListener(null); + } + } + + @Override + public void unregisterListener() { + // keep in mind that rawProvider can change + ILanguageSettingsProvider rawProvider = getRawProvider(); + if (rawProvider instanceof ICListenerRegisterer) { + ((ICListenerRegisterer) rawProvider).unregisterListener(); + } + } + } + + /** + * Language Settings Change Event implementation. + * + */ + private static class LanguageSettingsChangeEvent implements ILanguageSettingsChangeEvent { + private String projectName = null; + private Map deltaMap = new HashMap(); + + /** + * The act of creating event resets internal delta count in configuration state. + * That implies that when the event is retrieved it must be fired or delta will go missing. + * That side effect is here to ensure atomic processing of firing & resetting the delta. + */ + public LanguageSettingsChangeEvent(ICProjectDescription prjDescription) { + if (!prjDescription.isReadOnly()) { + String msg = "Project description " + prjDescription.getName() + " is expected to be read-only"; + CCorePlugin.log(new Status(IStatus.WARNING, CCorePlugin.PLUGIN_ID, msg, new Exception(msg))); + } + + projectName = prjDescription.getName(); + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + for (ICConfigurationDescription cfgDescription : cfgDescriptions) { + if (cfgDescription instanceof IInternalCCfgInfo) { + CConfigurationSpecSettings specSettings = null; + try { + specSettings = ((IInternalCCfgInfo) cfgDescription).getSpecSettings(); + } catch (CoreException e) { + CCorePlugin.log(e); + } + if (specSettings != null) { + LanguageSettingsDelta delta = specSettings.dropDelta(); + if (delta != null) + deltaMap.put(cfgDescription.getId(), delta); + } else { + IStatus ss = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, "Internal error: Missing specSettings for " + cfgDescription.getClass().getSimpleName()); + CCorePlugin.log(new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, ss.getMessage(), new CoreException(ss))); + } + } + } + } + + @Override + public String getProjectName() { + return projectName; + } + + @Override + public String[] getConfigurationDescriptionIds() { + return deltaMap.keySet().toArray(new String[deltaMap.size()]); + } + + @Override + public String toString() { + return "LanguageSettingsChangeEvent for project=[" + getProjectName() + "]" + + ", configurations=" + deltaMap.keySet() + ; + } + } + + /** static initializer */ + static { + try { + loadLanguageSettingsWorkspace(); + } catch (Throwable e) { + // log and swallow any exception + CCorePlugin.log("Error loading workspace language settings providers", e); //$NON-NLS-1$ + } + } + + private static IFile getStoreInProjectArea(IProject project) throws CoreException { + IFolder folder = project.getFolder(SETTINGS_FOLDER_NAME); + if (!folder.exists()) { + folder.create(true, true, null); + } + IFile storage = folder.getFile(STORAGE_PROJECT_LANGUAGE_SETTINGS); + return storage; + } + + /** + * TODO: refactor with ErrorParserManager ? + * + * @param store - name of the store + * @return location of the store in the plug-in state area + */ + private static URI getStoreInWorkspaceArea(String store) { + IPath location = CCorePlugin.getDefault().getStateLocation().append(store); + URI uri = URIUtil.toURI(location); + return uri; + } + + /** + * Set and store in workspace area user defined providers. + * + * @param providers - array of user defined providers + * @throws CoreException in case of problems + */ + public static void setWorkspaceProviders(List providers) throws CoreException { + setWorkspaceProvidersInternal(providers); + serializeLanguageSettingsWorkspace(); + // generate preference change event + IEclipsePreferences prefs = InstanceScope.INSTANCE.getNode(CCorePlugin.PLUGIN_ID); + prefs.putBoolean(PREFERENCE_WORSPACE_PROVIDERS_SET, ! prefs.getBoolean(PREFERENCE_WORSPACE_PROVIDERS_SET, false)); + } + + /** + * Internal method to set user defined providers in memory. + * + * @param providers - list of user defined providers. If {@code null} + * is passed user defined providers are cleared. + */ + private static void setWorkspaceProvidersInternal(List providers) { + Map rawWorkspaceProviders = new HashMap(); + List extensionProviders = new ArrayList(LanguageSettingsExtensionManager.getExtensionProvidersInternal()); + for (ILanguageSettingsProvider rawExtensionProvider : extensionProviders) { + if (rawExtensionProvider!=null) { + rawWorkspaceProviders.put(rawExtensionProvider.getId(), rawExtensionProvider); + } + } + + List rawProviders = new ArrayList(); + if (providers!=null) { + for (ILanguageSettingsProvider provider : providers) { + if (isWorkspaceProvider(provider)) { + provider = rawGlobalWorkspaceProviders.get(provider.getId()); + } + if (provider!=null) { + rawProviders.add(provider); + } + } + for (ILanguageSettingsProvider provider : rawProviders) { + rawWorkspaceProviders.put(provider.getId(), provider); + } + } + + List oldListeners = selectListeners(rawGlobalWorkspaceProviders.values()); + List newListeners = selectListeners(rawProviders); + + for (ICListenerRegisterer oldListener : oldListeners) { + if (!isObjectInTheList(newListeners, oldListener)) { + LanguageSettingsWorkspaceProvider wspProvider = (LanguageSettingsWorkspaceProvider) globalWorkspaceProviders.get(((ILanguageSettingsProvider)oldListener).getId()); + if (wspProvider != null && wspProvider.getProjectCount() > 0) { + oldListener.unregisterListener(); + } + } + } + + for (ICListenerRegisterer newListener : newListeners) { + if (!isObjectInTheList(oldListeners, newListener)) { + LanguageSettingsWorkspaceProvider wspProvider = (LanguageSettingsWorkspaceProvider) globalWorkspaceProviders.get(((ILanguageSettingsProvider)newListener).getId()); + if (wspProvider != null && wspProvider.getProjectCount() > 0) { + newListener.registerListener(null); + } + } + } + + rawGlobalWorkspaceProviders = rawWorkspaceProviders; + } + + private static List createLanguageLettingsChangeEvents(List serializableProviders) { + List events = new ArrayList(); + + List serializableIds = new ArrayList(); + for (LanguageSettingsSerializable provider : serializableProviders) { + serializableIds.add(provider.getId()); + } + + IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot(); + IProject[] projects = root.getProjects(); +projects: + for (IProject project : projects) { + if (project.isAccessible()) { + ICProjectDescription prjDescription = CCorePlugin.getDefault().getProjectDescription(project, false); + if (prjDescription != null) { + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + for (ICConfigurationDescription cfgDescription : cfgDescriptions) { + for (ILanguageSettingsProvider provider : cfgDescription.getLanguageSettingProviders()) { + if (isWorkspaceProvider(provider) && serializableIds.contains(provider.getId())) { + LanguageSettingsChangeEvent event = new LanguageSettingsChangeEvent(prjDescription); + if (event.getConfigurationDescriptionIds().length > 0) { + events.add(event); + } + continue projects; + } + } + } + } + } + + } + + return events; + } + + public static void serializeLanguageSettingsWorkspace() throws CoreException { + LanguageSettingsLogger.logWarning("LanguageSettingsProvidersSerializer.serializeLanguageSettingsWorkspace()"); + + URI uriStoreWsp = getStoreInWorkspaceArea(STORAGE_WORKSPACE_LANGUAGE_SETTINGS); + List serializableWorkspaceProviders = new ArrayList(); + for (ILanguageSettingsProvider provider : rawGlobalWorkspaceProviders.values()) { + if (provider instanceof LanguageSettingsSerializable) { + // serialize all editable providers which are different from corresponding extension + // and serialize all serializable ones that are not editable (those are singletons and we don't know whether they changed) + if (!(provider instanceof ILanguageSettingsEditableProvider) || !LanguageSettingsExtensionManager.equalsExtensionProvider(provider)) { + serializableWorkspaceProviders.add((LanguageSettingsSerializable)provider); + } + } + } + try { + List events = null; + if (serializableWorkspaceProviders.isEmpty()) { + java.io.File fileStoreWsp = new java.io.File(uriStoreWsp); + try { + serializingLock.acquire(); + fileStoreWsp.delete(); + // manufacture events while inside the lock + events = createLanguageLettingsChangeEvents(serializableWorkspaceProviders); + } finally { + serializingLock.release(); + } + } else { + Document doc = XmlUtil.newDocument(); + Element rootElement = XmlUtil.appendElement(doc, ELEM_PLUGIN); + Element elementExtension = XmlUtil.appendElement(rootElement, ELEM_EXTENSION, new String[] {ATTR_POINT, LanguageSettingsExtensionManager.PROVIDER_EXTENSION_FULL_ID}); + + for (LanguageSettingsSerializable provider : serializableWorkspaceProviders) { + provider.serialize(elementExtension); + } + + try { + serializingLock.acquire(); + XmlUtil.serializeXml(doc, uriStoreWsp); + // manufacture events while inside the lock + events = createLanguageLettingsChangeEvents(serializableWorkspaceProviders); + } finally { + serializingLock.release(); + } + } + // notify the listeners outside the lock + for (LanguageSettingsChangeEvent event : events) { + notifyLanguageSettingsChangeListeners(event); + } + + } catch (Exception e) { + CCorePlugin.log("Internal error while trying to serialize language settings", e); //$NON-NLS-1$ + IStatus s = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, "Internal error while trying to serialize language settings", e); + throw new CoreException(s); + } + } + + public static void loadLanguageSettingsWorkspace() throws CoreException { + List providers = null; + + URI uriStoreWsp = getStoreInWorkspaceArea(STORAGE_WORKSPACE_LANGUAGE_SETTINGS); + + Document doc = null; + serializingLock.acquire(); + try { + doc = XmlUtil.loadXml(uriStoreWsp); + } catch (Exception e) { + CCorePlugin.log("Can't load preferences from file "+uriStoreWsp, e); //$NON-NLS-1$ + } finally { + serializingLock.release(); + } + + if (doc!=null) { + Element rootElement = doc.getDocumentElement(); + NodeList providerNodes = rootElement.getElementsByTagName(LanguageSettingsSerializable.ELEM_PROVIDER); + + List userDefinedProvidersIds = new ArrayList(); + for (int i=0;i(); + + if (!LanguageSettingsExtensionManager.equalsExtensionProvider(provider)) { + providers.add(provider); + } + } + } + } + setWorkspaceProvidersInternal(providers); + } + + /** + * @noreference This method is not intended to be referenced by clients. + * It is public solely for benefit of JUnit testing. + */ + public static void serializeLanguageSettingsInternal(Element projectElementPrjStore, Element projectElementWspStore, ICProjectDescription prjDescription) throws CoreException { + + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + for (ICConfigurationDescription cfgDescription : cfgDescriptions) { + Element elementConfiguration = XmlUtil.appendElement(projectElementPrjStore, ELEM_CONFIGURATION, new String[] { + LanguageSettingsExtensionManager.ATTR_ID, cfgDescription.getId(), + LanguageSettingsExtensionManager.ATTR_NAME, cfgDescription.getName(), + }); + Element elementConfigurationWsp = null; + List providers = cfgDescription.getLanguageSettingProviders(); + if (providers.size()>0) { + Element elementExtension = XmlUtil.appendElement(elementConfiguration, ELEM_EXTENSION, new String[] { + ATTR_POINT, LanguageSettingsExtensionManager.PROVIDER_EXTENSION_FULL_ID}); + Element elementExtensionWsp = null; + for (ILanguageSettingsProvider provider : providers) { + if (isWorkspaceProvider(provider)) { + // Element elementProviderReference = + XmlUtil.appendElement(elementExtension, ELEM_PROVIDER_REFERENCE, new String[] { + LanguageSettingsExtensionManager.ATTR_ID, provider.getId()}); + continue; + } + if (provider instanceof LanguageSettingsSerializable) { + LanguageSettingsSerializable lss = (LanguageSettingsSerializable) provider; + + boolean useWsp = projectElementWspStore!=null && projectElementPrjStore!=projectElementWspStore; + if (lss.isStoringEntriesInProjectArea() || !useWsp) { + lss.serialize(elementExtension); + } else { + lss.serializeAttributes(elementExtension); + + // lazy initialization of elements - to avoid serialization of no-data file + if (elementExtensionWsp==null) { + if (elementConfigurationWsp==null) { + elementConfigurationWsp = XmlUtil.appendElement(projectElementWspStore, ELEM_CONFIGURATION, new String[] { + LanguageSettingsExtensionManager.ATTR_ID, cfgDescription.getId(), + LanguageSettingsExtensionManager.ATTR_NAME, cfgDescription.getName(), + }); + } + elementExtensionWsp = XmlUtil.appendElement(elementConfigurationWsp, ELEM_EXTENSION, new String[] { + ATTR_POINT, LanguageSettingsExtensionManager.PROVIDER_EXTENSION_FULL_ID}); + } + Element elementProviderWsp = XmlUtil.appendElement(elementExtensionWsp, ELEM_PROVIDER, new String[] { + LanguageSettingsExtensionManager.ATTR_ID, provider.getId()}); + lss.serializeEntries(elementProviderWsp); + } + } else { + // Element elementProvider = + XmlUtil.appendElement(elementExtension, LanguageSettingsExtensionManager.ELEM_PROVIDER, new String[] { + LanguageSettingsExtensionManager.ATTR_ID, provider.getId(), + LanguageSettingsExtensionManager.ATTR_NAME, provider.getName(), + LanguageSettingsExtensionManager.ATTR_CLASS, provider.getClass().getCanonicalName(), + }); + } + } + } + } + } + + public static void serializeLanguageSettings(ICProjectDescription prjDescription) throws CoreException { + IProject project = prjDescription.getProject(); + LanguageSettingsLogger.logWarning("LanguageSettingsProvidersSerializer.serializeLanguageSettings() for " + project); + + try { + // Document to store in project area + Document docStorePrj = XmlUtil.newDocument(); + Element projectElementStorePrj = XmlUtil.appendElement(docStorePrj, ELEM_PROJECT); + // Document to store in workspace area + Document docStoreWsp = XmlUtil.newDocument(); + Element projectElementStoreWsp = XmlUtil.appendElement(docStoreWsp, ELEM_PROJECT); + + // The project store should not be absent. Absent store means legacy project, not 0 providers. + IFile fileStorePrj = getStoreInProjectArea(project); + + URI uriStoreWsp = getStoreInWorkspaceArea(project.getName()+'.'+STORAGE_WORKSPACE_LANGUAGE_SETTINGS); + LanguageSettingsChangeEvent event = null; + + try { + serializingLock.acquire(); + + // Note that need for serialization may exist even if LSE event delta is empty, + // as number or properties of providers may differ + serializeLanguageSettingsInternal(projectElementStorePrj, projectElementStoreWsp, prjDescription); + XmlUtil.serializeXml(docStorePrj, fileStorePrj); + + // project-specific location in workspace area + boolean isWorkspaceStoreEmpty = projectElementStoreWsp.getChildNodes().getLength() == 0; + if (!isWorkspaceStoreEmpty) { + XmlUtil.serializeXml(docStoreWsp, uriStoreWsp); + } else { + new java.io.File(uriStoreWsp).delete(); + } + + // manufacture the event only if serialization was successful + event = new LanguageSettingsChangeEvent(prjDescription); + } finally { + serializingLock.release(); + } + // notify the listeners outside the lock + if (event.getConfigurationDescriptionIds().length > 0) { + notifyLanguageSettingsChangeListeners(event); + } + + } catch (Exception e) { + IStatus s = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, "Internal error while trying to serialize language settings", e); + CCorePlugin.log(s); + throw new CoreException(s); + } + } + + /** + * @noreference This method is not intended to be referenced by clients. + * It is public solely for benefit of JUnit testing. + */ + public static void loadLanguageSettingsInternal(Element projectElementPrj, Element projectElementWsp, ICProjectDescription prjDescription) { + /* + + + + + + + + + */ + NodeList configurationNodes = projectElementPrj.getChildNodes(); + for (int ic=0;ic providers = new ArrayList(); + String cfgId = XmlUtil.determineAttributeValue(cfgNode, LanguageSettingsExtensionManager.ATTR_ID); + @SuppressWarnings("unused") + String cfgName = XmlUtil.determineAttributeValue(cfgNode, LanguageSettingsExtensionManager.ATTR_NAME); + + NodeList extensionAndReferenceNodes = cfgNode.getChildNodes(); + for (int ie=0;ie + + + + + + + + */ + NodeList configurationNodes = projectElementWsp.getChildNodes(); + for (int ic=0;ic + + URI uriStoreWsp = getStoreInWorkspaceArea(project.getName()+'.'+STORAGE_WORKSPACE_LANGUAGE_SETTINGS); + Document docWsp = null; + serializingLock.acquire(); + try { + docWsp = XmlUtil.loadXml(uriStoreWsp); + } finally { + serializingLock.release(); + } + + Element rootElementWsp = null; // + if (docWsp!=null) { + rootElementWsp = docWsp.getDocumentElement(); + } + + + loadLanguageSettingsInternal(rootElementPrj, rootElementWsp, prjDescription); + } catch (Exception e) { + CCorePlugin.log("Can't load preferences from file "+storePrj.getLocation(), e); //$NON-NLS-1$ + } + + if (doc!=null) { + } + + } else { + // Already existing legacy projects + ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations(); + for (ICConfigurationDescription cfgDescription : cfgDescriptions) { + if (cfgDescription!=null) { + List providers = new ArrayList(2); + ILanguageSettingsProvider userProvider = getWorkspaceProvider(ScannerDiscoveryLegacySupport.MBS_LANGUAGE_SETTINGS_PROVIDER); + providers.add(userProvider); + cfgDescription.setLanguageSettingProviders(providers); + } + } + + } + } + + /** + * FIXME Get Language Settings Provider defined in the workspace. That includes user-defined + * providers and after that providers defined as extensions via + * {@code org.eclipse.cdt.core.LanguageSettingsProvider} extension point. + * That returns actual object, any modifications will affect any configuration + * referring to the provider. + * + * @param id - ID of provider to find. + * @return the provider or {@code null} if provider is not defined. + */ + public static ILanguageSettingsProvider getWorkspaceProvider(String id) { + ILanguageSettingsProvider provider = globalWorkspaceProviders.get(id); + if (provider == null) { + provider = new LanguageSettingsWorkspaceProvider(id); + globalWorkspaceProviders.put(id, provider); + } + return provider; + } + + public static ILanguageSettingsProvider getRawWorkspaceProvider(String id) { + return rawGlobalWorkspaceProviders.get(id); + } + + /** + * TODO + * @return ordered set of providers defined in the workspace which include contributed through extension + user defined ones + * + */ + public static List getWorkspaceProviders() { + ArrayList workspaceProviders = new ArrayList(); + for (ILanguageSettingsProvider rawProvider : rawGlobalWorkspaceProviders.values()) { + workspaceProviders.add(getWorkspaceProvider(rawProvider.getId())); + } + return workspaceProviders; + } + + /** + * Checks if the provider is defined on the workspace level. + * + * @param provider - provider to check. + * @return {@code true} if the given provider is workspace provider, {@code false} otherwise. + * + */ + public static boolean isWorkspaceProvider(ILanguageSettingsProvider provider) { + return provider instanceof LanguageSettingsWorkspaceProvider; + } + + /** + * TODO - remove me + * Temporary method to report inconsistency in log. + */ + @Deprecated + public static void assertConsistency(ICProjectDescription prjDescription) { + if (prjDescription != null) { + List prjProviders = new ArrayList(); + for (ICConfigurationDescription cfgDescription : prjDescription.getConfigurations()) { + List providers = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider provider : providers) { + if (!LanguageSettingsManager.isWorkspaceProvider(provider)) { + if (isObjectInTheList(prjProviders, provider)) { + IStatus status = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, "Inconsistent state, duplicate LSP in project description " + + "[" + System.identityHashCode(provider) + "] " + + provider); + CoreException e = new CoreException(status); + CCorePlugin.log(e); + } + prjProviders.add(provider); + } + } + } + } + } + + private static boolean isObjectInTheList(Collection list, T element) { + // list.contains(element) won't do it as we are interested in exact object, not in equal object + for (T elem : list) { + if (elem == element) + return true; + } + return false; + } + + private static boolean isListenerInTheListOfAssociations(Collection list, ICListenerRegisterer element) { + // list.contains(element) won't do it as we are interested in exact object, not in equal object + for (ListenerAssociation la : list) { + if (la.listener == element) + return true; + } + return false; + } + + /** + * Get a providers list including only providers of type ICListenerRegisterer + * for a given project description - collecting from all configurations. + */ + private static List getListeners(ICProjectDescription prjDescription) { + List listeners = new ArrayList(); + if (prjDescription != null) { + for (ICConfigurationDescription cfgDescription : prjDescription.getConfigurations()) { + List providers = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider provider : providers) { + if (provider instanceof ICListenerRegisterer) { + ICListenerRegisterer listener = (ICListenerRegisterer) provider; + if (!isObjectInTheList(listeners, listener)) { + listeners.add(listener); + } + } + } + } + } + return listeners; + } + + private static List selectListeners(Collection values) { + List listeners = new ArrayList(); + for (ILanguageSettingsProvider provider : values) { + if (provider instanceof ICListenerRegisterer) + listeners.add((ICListenerRegisterer) provider); + } + return listeners; + } + + /** + * Get a providers list including only providers of type IResourceChangeListener + * for a given project description - collecting from all configurations. + */ + private static List getListenersAssociations(ICProjectDescription prjDescription) { + List associations = new ArrayList(); + if (prjDescription != null) { + for (ICConfigurationDescription cfgDescription : prjDescription.getConfigurations()) { + List providers = cfgDescription.getLanguageSettingProviders(); + List listeners = selectListeners(providers); + for (ICListenerRegisterer listener : listeners) { + if (!isListenerInTheListOfAssociations(associations, listener)) { + associations.add(new ListenerAssociation(listener, cfgDescription)); + } + } + } + } + return associations; + } + + /** + * Unregister listeners which are not used anymore and register new listeners. + * The method is used when project description is applied to workspace. + * @param oldPrjDescription - old project descriptions being replaced in the workspace. + * @param newPrjDescription - new project description being applied to the workspace. + */ + public static void reRegisterListeners(ICProjectDescription oldPrjDescription, ICProjectDescription newPrjDescription) { + if (oldPrjDescription == newPrjDescription) { + assertConsistency(oldPrjDescription); // TODO - remove me + return; + } + + assertConsistency(oldPrjDescription); // TODO - remove me + assertConsistency(newPrjDescription); // TODO - remove me + + List oldListeners = getListeners(oldPrjDescription); + List newAssociations = getListenersAssociations(newPrjDescription); + + for (ICListenerRegisterer oldListener : oldListeners) { + if (!isListenerInTheListOfAssociations(newAssociations, oldListener)) { + int count = 0; + if (oldListener instanceof LanguageSettingsWorkspaceProvider) { + count = ((LanguageSettingsWorkspaceProvider) oldListener).decrementProjectCount(); + } + if (count == 0) { + try { + oldListener.unregisterListener(); + } catch (Throwable e) { + // protect from any exceptions from implementers + CCorePlugin.log(e); + } + } + } + } + + for (ListenerAssociation newListenerAssociation : newAssociations) { + ICListenerRegisterer newListener = newListenerAssociation.listener; + if (!isObjectInTheList(oldListeners, newListener)) { + int count = 1; + if (newListener instanceof LanguageSettingsWorkspaceProvider) { + count = ((LanguageSettingsWorkspaceProvider) newListener).incrementProjectCount(); + } + if (count == 1) { + try { + newListener.registerListener(newListenerAssociation.cfgDescription); + } catch (Throwable e) { + // protect from any exceptions from implementers + CCorePlugin.log(e); + } + } + } + } + + } + + /** + * Deep clone of a list of language settings providers. + * + * @param baseProviders - list of providers to clone. + * @return newly cloned list. + */ + public static List cloneProviders(List baseProviders) { + List newProviders = new ArrayList(); + for (ILanguageSettingsProvider provider : baseProviders) { + if (provider instanceof ILanguageSettingsEditableProvider) { + try { + provider = ((ILanguageSettingsEditableProvider) provider).clone(); + } catch (CloneNotSupportedException e) { + IStatus status = new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, Status.OK, + "Not able to clone provider " + provider.getClass(), e); + CCorePlugin.log(status); + } + } + newProviders.add(provider); + } + return new ArrayList(newProviders); + } + + /** + * Adds a listener that will be notified of changes in language settings. + * + * @param listener the ILanguageMappingChangeListener to add + */ + public static void registerLanguageSettingsChangeListener(ILanguageSettingsChangeListener listener) { + fLanguageSettingsChangeListeners.add(listener); + } + + /** + * Removes a language settings change listener. + * + * @param listener the ILanguageMappingChangeListener to remove. + */ + public static void unregisterLanguageSettingsChangeListener(ILanguageSettingsChangeListener listener) { + fLanguageSettingsChangeListeners.remove(listener); + } + + /** + * Notifies all language settings change listeners of a change. + * + * @param event the ILanguageSettingsChangeEvent event to be broadcast. + */ + public static void notifyLanguageSettingsChangeListeners(ILanguageSettingsChangeEvent event) { + LanguageSettingsLogger.logWarning("Firing " + event); + + Object[] listeners = fLanguageSettingsChangeListeners.getListeners(); + for (Object obj : listeners) { + ILanguageSettingsChangeListener listener = (ILanguageSettingsChangeListener) obj; + listener.handleEvent(event); + } + } + + private static List getSettingEntriesPooled(ILanguageSettingsProvider provider, + ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + + try { + return LanguageSettingsStorage.getPooledList(provider.getSettingEntries(cfgDescription, rc, languageId)); + } catch (Throwable e) { + String cfgId = cfgDescription!=null ? cfgDescription.getId() : null; + String msg = "Exception in provider "+provider.getId()+": getSettingEntries("+cfgId+", "+rc+", "+languageId+")"; + CCorePlugin.log(msg, e); + // return empty list to prevent getting potentially non-empty list from up the resource tree + return LanguageSettingsStorage.getPooledEmptyList(); + } + } + + /** + * Returns the list of setting entries of the given provider + * for the given configuration description, resource and language. + * This method reaches to the parent folder of the resource recursively + * in case the resource does not define the entries for the given provider. + * + * @param provider - language settings provider. + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * + * @return the list of setting entries which is unmodifiable. Never returns {@code null} + * although individual providers mandated to return {@code null} if no settings defined. + */ + public static List getSettingEntriesUpResourceTree(ILanguageSettingsProvider provider, ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + Assert.isTrue( !(rc instanceof IWorkspaceRoot) ); + if (provider!=null) { + List entries = getSettingEntriesPooled(provider, cfgDescription, rc, languageId); + if (entries!=null) { + return entries; + } + if (rc!=null) { + IResource parentFolder = (rc instanceof IProject) ? null : rc.getParent(); + if (parentFolder!=null) { + return getSettingEntriesUpResourceTree(provider, cfgDescription, parentFolder, languageId); + } + // if out of parent resources - get default entries for the applicable language scope + entries = getSettingEntriesPooled(provider, null, null, languageId); + if (entries!=null) { + return entries; + } + } + } + + return LanguageSettingsStorage.getPooledEmptyList(); + } + + /** + * Builds for the provider a nice looking resource tree to present hierarchical view to the user. + * Note that it is not advisable to "compact" the tree because of potential loss of information + * which is especially important during partial or incremental builds. + * + * @param provider - language settings provider to build the tree for. + * @param cfgDescription - configuration description. + * @param languageId - language ID. + * @param folder - container where the tree roots. + */ + public static void buildResourceTree(LanguageSettingsSerializable provider, ICConfigurationDescription cfgDescription, String languageId, IContainer folder) { + IResource[] members = null; + try { + members = folder.members(); + } catch (Exception e) { + CCorePlugin.log(e); + } + if (members==null) + return; + + for (IResource rc : members) { + if (rc instanceof IContainer) { + buildResourceTree(provider, cfgDescription, languageId, (IContainer) rc); + } + } + + int rcNumber = members.length; + + Map, Integer> listMap = new HashMap, Integer>(); + + // on the first pass find majority entries + List majorityEntries = null; + List candidate = null; + int candidateCount = 0; + for (IResource rc : members) { + if (!isLanguageInScope(rc, cfgDescription, languageId)) { + rcNumber--; + } else { + List entries = provider.getSettingEntries(null, rc, languageId); + if (entries==null && rc instanceof IContainer) { + rcNumber--; + } else { + Integer count = listMap.get(entries); + if (count==null) { + count = 0; + } + count++; + + if (count>candidateCount) { + candidateCount = count; + candidate = entries; + } + + listMap.put(entries, count); + } + } + + if (candidateCount > rcNumber/2) { + majorityEntries = candidate; + break; + } + } + + if (majorityEntries!=null) { + provider.setSettingEntries(cfgDescription, folder, languageId, majorityEntries); + } + + // second pass - assign the entries to the folders + for (IResource rc : members) { + List entries = provider.getSettingEntries(null, rc, languageId); + if (entries!=null && entries==majorityEntries) { + if (!(rc instanceof IFile)) { // preserve information which files were collected + provider.setSettingEntries(cfgDescription, rc, languageId, null); + } + } + } + } + + private static boolean isLanguageInScope(IResource rc, ICConfigurationDescription cfgDescription, String languageId) { + if (rc instanceof IFile) { + ILanguage lang = null; + try { + lang = LanguageManager.getInstance().getLanguageForFile((IFile) rc, cfgDescription); + } catch (CoreException e) { + CCorePlugin.log("Error loading language settings providers extensions", e); //$NON-NLS-1$ + } + if (lang==null || (languageId!=null && !languageId.equals(lang.getId()))) { + return false; + } + } + return true; + } + + private static boolean checkBit(int flags, int bit) { + return (flags & bit) == bit; + } + + /** + * Returns the list of setting entries of a certain kind (such as include paths) + * for the given configuration description, resource and language. This is a + * combined list for all providers taking into account settings of parent folder + * if settings for the given resource are not defined. + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * @param kind - kind of language settings entries, such as + * {@link ICSettingEntry#INCLUDE_PATH} etc. This is a binary flag + * and it is possible to specify composite kind. + * Use {@link ICSettingEntry#ALL} to get all kinds. + * @param checkLocality - specifies if parameter {@code isLocal} should be considered. + * @param isLocal - {@code true} if "local" entries should be provided and + * {@code false} for "system" entries. This makes sense for include paths where + * [#include "..."] is "local" and [#include <...>] is system. + * + * @return the list of setting entries found. + */ + private static List getSettingEntriesByKind(ICConfigurationDescription cfgDescription, + IResource rc, String languageId, int kind, boolean checkLocality, boolean isLocal) { + + List entries = new ArrayList(); + List alreadyAdded = new ArrayList(); + + List providers = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider provider: providers) { + List providerEntries = getSettingEntriesUpResourceTree(provider, cfgDescription, rc, languageId); + for (ICLanguageSettingEntry entry : providerEntries) { + if (entry!=null) { + String entryName = entry.getName(); + boolean isRightKind = (entry.getKind() & kind) != 0; + // Only first entry is considered + // Entry flagged as "UNDEFINED" prevents adding entry with the same name down the line + if (isRightKind && !alreadyAdded.contains(entryName)) { + int flags = entry.getFlags(); + boolean isRightLocal = !checkLocality || (checkBit(flags, ICSettingEntry.LOCAL) == isLocal); + if (isRightLocal) { + if (!checkBit(flags, ICSettingEntry.UNDEFINED)) { + entries.add(entry); + } + alreadyAdded.add(entryName); + } + } + } + } + } + + return entries; + } + + /** + * Returns the list of setting entries of a certain kind (such as include paths) + * for the given configuration description, resource and language. This is a + * combined list for all providers taking into account settings of parent folder + * if settings for the given resource are not defined. For include paths both + * local (#include "...") and system (#include <...>) entries are returned. + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * @param kind - kind of language settings entries, such as + * {@link ICSettingEntry#INCLUDE_PATH} etc. This is a binary flag + * and it is possible to specify composite kind. + * Use {@link ICSettingEntry#ALL} to get all kinds. + * + * @return the list of setting entries. + */ + public static List getSettingEntriesByKind(ICConfigurationDescription cfgDescription, IResource rc, String languageId, int kind) { + return getSettingEntriesByKind(cfgDescription, rc, languageId, kind, /* checkLocality */ false, /* isLocal */ false); + } + + /** + * Returns the list of "system" (such as [#include <...>]) setting entries of a certain kind + * for the given configuration description, resource and language. This is a + * combined list for all providers taking into account settings of parent folder + * if settings for the given resource are not defined. + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * @param kind - kind of language settings entries, such as + * {@link ICSettingEntry#INCLUDE_PATH} etc. This is a binary flag + * and it is possible to specify composite kind. + * Use {@link ICSettingEntry#ALL} to get all kinds. + * + * @return the list of setting entries. + */ + public static List getSystemSettingEntriesByKind(ICConfigurationDescription cfgDescription, IResource rc, String languageId, int kind) { + return getSettingEntriesByKind(cfgDescription, rc, languageId, kind, /* checkLocality */ true, /* isLocal */ false); + } + + /** + * Returns the list of "local" (such as [#include "..."]) setting entries of a certain kind + * for the given configuration description, resource and language. This is a + * combined list for all providers taking into account settings of parent folder + * if settings for the given resource are not defined. + * + * @param cfgDescription - configuration description. + * @param rc - resource such as file or folder. + * @param languageId - language id. + * @param kind - kind of language settings entries, such as + * {@link ICSettingEntry#INCLUDE_PATH} etc. This is a binary flag + * and it is possible to specify composite kind. + * Use {@link ICSettingEntry#ALL} to get all kinds. + * + * @return the list of setting entries. + */ + public static List getLocalSettingEntriesByKind(ICConfigurationDescription cfgDescription, IResource rc, String languageId, int kind) { + return getSettingEntriesByKind(cfgDescription, rc, languageId, kind, /* checkLocality */ true, /* isLocal */ true); + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsScannerInfoProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsScannerInfoProvider.java new file mode 100644 index 00000000000..d34a52176b3 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsScannerInfoProvider.java @@ -0,0 +1,263 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.cdtvariables.CdtVariableException; +import org.eclipse.cdt.core.cdtvariables.ICdtVariableManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.parser.ExtendedScannerInfo; +import org.eclipse.cdt.core.parser.IScannerInfoChangeListener; +import org.eclipse.cdt.core.parser.IScannerInfoProvider; +import org.eclipse.cdt.core.settings.model.ACPathEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICMacroEntry; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.internal.core.settings.model.CProjectDescriptionManager; +import org.eclipse.cdt.internal.core.settings.model.SettingsModelMessages; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Status; +import org.eclipse.osgi.util.NLS; + +/** + * Implementation of {@link IScannerInfoProvider} backed by the list of + * language settings providers of "default settings configuration" + * (see {@link ICProjectDescription#getDefaultSettingConfiguration()}). + * + */ +public class LanguageSettingsScannerInfoProvider implements IScannerInfoProvider { + private static final ExtendedScannerInfo DUMMY_SCANNER_INFO = new ExtendedScannerInfo(); + + @Override + public ExtendedScannerInfo getScannerInformation(IResource rc) { + LanguageSettingsLogger.logScannerInfoProvider(rc, this); + + IProject project = rc.getProject(); + if (project==null) + return DUMMY_SCANNER_INFO; + + ICProjectDescription prjDescription = CProjectDescriptionManager.getInstance().getProjectDescription(project, false); + if (prjDescription==null) + return DUMMY_SCANNER_INFO; + + ICConfigurationDescription cfgDescription = prjDescription.getDefaultSettingConfiguration(); + if (cfgDescription==null) + return DUMMY_SCANNER_INFO; + + List languageIds = LanguageSettingsManager.getLanguages(rc, cfgDescription); + if (languageIds.isEmpty()) { + String msg = NLS.bind(SettingsModelMessages.getString("LanguageSettingsScannerInfoProvider.UnableToDetermineLanguage"), rc.toString()); //$NON-NLS-1$ + CCorePlugin.log(new CoreException(new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, msg))); + return DUMMY_SCANNER_INFO; + } + + LinkedHashSet includePathEntries = new LinkedHashSet(); + LinkedHashSet includePathLocalEntries = new LinkedHashSet(); + LinkedHashSet includeFileEntries = new LinkedHashSet(); + LinkedHashSet macroFileEntries = new LinkedHashSet(); + LinkedHashSet macroEntries = new LinkedHashSet(); + + for (String langId : languageIds) { + List incSys = LanguageSettingsProvidersSerializer.getSystemSettingEntriesByKind(cfgDescription, rc, langId, + ICSettingEntry.INCLUDE_PATH); + includePathEntries.addAll(incSys); + + List incLocal = LanguageSettingsProvidersSerializer.getLocalSettingEntriesByKind(cfgDescription, rc, langId, + ICSettingEntry.INCLUDE_PATH); + includePathLocalEntries.addAll(incLocal); + + List incFiles = LanguageSettingsProvidersSerializer.getSettingEntriesByKind(cfgDescription, rc, langId, + ICSettingEntry.INCLUDE_FILE); + includeFileEntries.addAll(incFiles); + + List macroFiles = LanguageSettingsProvidersSerializer.getSettingEntriesByKind(cfgDescription, rc, langId, + ICSettingEntry.MACRO_FILE); + macroFileEntries.addAll(macroFiles); + + List macros = LanguageSettingsProvidersSerializer.getSettingEntriesByKind(cfgDescription, rc, langId, + ICSettingEntry.MACRO); + macroEntries.addAll(macros); + } + + String[] includePaths = convertToLocations(includePathEntries, cfgDescription); + String[] includePathsLocal = convertToLocations(includePathLocalEntries, cfgDescription); + String[] includeFiles = convertToLocations(includeFileEntries, cfgDescription); + String[] macroFiles = convertToLocations(macroFileEntries, cfgDescription); + + Map definedMacros = new HashMap(); + for (ICLanguageSettingEntry entry : macroEntries) { + ICMacroEntry macroEntry = (ICMacroEntry)entry; + String name = macroEntry.getName(); + String value = macroEntry.getValue(); + definedMacros.put(name, value); + } + + return new ExtendedScannerInfo(definedMacros, includePaths, macroFiles, includeFiles, includePathsLocal); + } + + private IPath expandVariables(IPath path, ICConfigurationDescription cfgDescription) { + ICdtVariableManager varManager = CCorePlugin.getDefault().getCdtVariableManager(); + String pathStr = path.toString(); + try { + pathStr = varManager.resolveValue(pathStr, "", null, cfgDescription); //$NON-NLS-1$ + } catch (CdtVariableException e) { + // Swallow exceptions but also log them + CCorePlugin.log(e); + } + IPath resolvedLoc = new Path(pathStr); + return resolvedLoc; + } + + /** + * Get build working directory for the provided configuration. Returns + * project location if none defined. + */ + private static IPath getBuildCWD(ICConfigurationDescription cfgDescription) { + IPath buildCWD = cfgDescription.getBuildSetting().getBuilderCWD(); + if (buildCWD==null) { + IProject project = cfgDescription.getProjectDescription().getProject(); + buildCWD = project.getLocation(); + } else { + ICdtVariableManager mngr = CCorePlugin.getDefault().getCdtVariableManager(); + try { + // FIXME IPath buildCWD can hold variables i.e. ${workspace_loc:/path} + String buildPathString = buildCWD.toString(); + buildPathString = mngr.resolveValue(buildPathString, "", null, cfgDescription); + buildCWD = new Path(buildPathString); + } catch (CdtVariableException e) { + CCorePlugin.log(e); + } + + } + buildCWD = buildCWD.addTrailingSeparator(); + return buildCWD; + } + + /** + * Resolve location to file system location in a configuration context. + * Resolving includes replacing build/environment variables with values, making relative path absolute etc. + * + * @param location - location to resolve. If relative, it is taken to be rooted in build working directory. + * @param cfgDescription - the configuration context. + * @return resolved file system location. + */ + private static String resolveEntry(String location, ICConfigurationDescription cfgDescription) { + // Substitute build/environment variables + ICdtVariableManager varManager = CCorePlugin.getDefault().getCdtVariableManager(); + try { + location = varManager.resolveValue(location, "", null, cfgDescription); //$NON-NLS-1$ + } catch (CdtVariableException e) { + // Swallow exceptions but also log them + CCorePlugin.log(e); + } + // use OS file separators (i.e. '\' on Windows) + if (java.io.File.separatorChar != '/') { + location = location.replace('/', java.io.File.separatorChar); + } + + // note that we avoid using org.eclipse.core.runtime.Path for manipulations being careful + // to preserve "../" segments and not let collapsing them which is not correct for symbolic links. + Path locPath = new Path(location); + if (locPath.isAbsolute() && locPath.getDevice()==null) { + // prepend device (C:) for Windows + IPath buildCWD = getBuildCWD(cfgDescription); + String device = buildCWD.getDevice(); + if (device!=null) + location = device + location; + } + if (!locPath.isAbsolute()) { + // consider relative path to be from build working directory + IPath buildCWD = getBuildCWD(cfgDescription); + location = buildCWD.toOSString() + locPath; + } + return location; + } + + /** + * Convert the path entries to absolute file system locations represented as String array. + * Resolve the entries which are not resolved. + * + * @param entriesPath - language settings path entries. + * @param cfgDescription - configuration description for resolving entries. + * @return array of the locations. + */ + private String[] convertToLocations(LinkedHashSet entriesPath, ICConfigurationDescription cfgDescription){ + List locations = new ArrayList(entriesPath.size()); + for (ICLanguageSettingEntry entry : entriesPath) { + ACPathEntry entryPath = (ACPathEntry)entry; + if (entryPath.isValueWorkspacePath()) { + IPath loc = entryPath.getLocation(); + if (loc!=null) { + if (checkBit(entryPath.getFlags(), ICSettingEntry.FRAMEWORKS_MAC)) { + locations.add(loc.append("/__framework__.framework/Headers/__header__").toOSString()); + locations.add(loc.append("/__framework__.framework/PrivateHeaders/__header__").toOSString()); + } else { + locations.add(loc.toOSString()); + } + } + } else { + String locStr = entryPath.getName(); + if (entryPath.isResolved()) { + locations.add(locStr); + } else { + locStr = resolveEntry(locStr, cfgDescription); + if (locStr!=null) { + if (checkBit(entryPath.getFlags(), ICSettingEntry.FRAMEWORKS_MAC)) { + locations.add(locStr+"/__framework__.framework/Headers/__header__"); + locations.add(locStr+"/__framework__.framework/PrivateHeaders/__header__"); + } else { + locations.add(locStr); + // add relative paths again for indexer to resolve from source file location + IPath unresolvedPath = entryPath.getLocation(); + if (!unresolvedPath.isAbsolute()) { + IPath expandedPath = expandVariables(unresolvedPath, cfgDescription); + if (!expandedPath.isAbsolute()) { + locations.add(expandedPath.toOSString()); + } + } + } + } + } + } + } + + return locations.toArray(new String[locations.size()]); + } + + private static boolean checkBit(int flags, int bit) { + return (flags & bit) == bit; + } + + @Override + public void subscribe(IResource resource, IScannerInfoChangeListener listener) { + // Handled by ScannerInfoProviderProxy for the moment + } + + @Override + public void unsubscribe(IResource resource, IScannerInfoChangeListener listener) { + // Handled by ScannerInfoProviderProxy for the moment + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsStorage.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsStorage.java new file mode 100644 index 00000000000..ec37aa13ec6 --- /dev/null +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/language/settings/providers/LanguageSettingsStorage.java @@ -0,0 +1,419 @@ +package org.eclipse.cdt.internal.core.language.settings.providers; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.Comparator; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.core.settings.model.util.CDataUtil; +import org.eclipse.cdt.core.settings.model.util.LanguageSettingEntriesSerializer; +import org.eclipse.cdt.internal.core.XmlUtil; +import org.eclipse.cdt.internal.core.parser.util.WeakHashSet; +import org.eclipse.core.resources.IResource; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + +public class LanguageSettingsStorage { + private static final String ELEM_LANGUAGE = "language"; //$NON-NLS-1$ + private static final String ATTR_LANGUAGE_ID = "id"; //$NON-NLS-1$ + private static final String ELEM_RESOURCE = "resource"; //$NON-NLS-1$ + private static final String ATTR_PROJECT_PATH = "project-relative-path"; //$NON-NLS-1$ + + private static final String ELEM_ENTRY = "entry"; //$NON-NLS-1$ + private static final String ATTR_KIND = "kind"; //$NON-NLS-1$ + private static final String ATTR_NAME = "name"; //$NON-NLS-1$ + private static final String ATTR_VALUE = "value"; //$NON-NLS-1$ + private static final String ELEM_FLAG = "flag"; //$NON-NLS-1$ + + /** + * Storage to keep settings entries. Note that it is not necessary to keep configuration in the maps + * as the configuration is always the one provider belongs to. + */ + private Map>> fStorage = new HashMap>>(); + + /** + * Pool of LSE lists implemented as WeakHashSet. That allows to gain memory savings + * at the expense of CPU time. WeakHashSet handles garbage collection when a list is not + * referenced anywhere else. See JavaDoc {@link java.lang.ref.WeakReference} about weak reference objects. + */ + private static WeakHashSet> listPool = new WeakHashSet>() { + @Override + public synchronized List add(List list) { + return super.add(list); + } + + }; + + /** + * TODO + *
Note that this list is unmodifiable. + * + */ + public List getSettingEntries(ICConfigurationDescription cfgDescription, IResource rc, String languageId) { + List entries = null; + Map> langMap = fStorage.get(languageId); + if (langMap!=null) { + String rcProjectPath = rc!=null ? rc.getProjectRelativePath().toString() : null; + entries = langMap.get(rcProjectPath); + } + return entries; + } + + /** + * Some providers may collect entries in pretty much random order. For the purposes of + * predictability, UI usability and efficient storage the entries are sorted by kinds + * and secondary by name for kinds where the secondary order is not significant. + * + * @param entries - list of entries to sort. + * @return - sorted entries. + */ + private List sortEntries(List entries) { + List sortedEntries = new ArrayList(entries); + Collections.sort(sortedEntries, new Comparator(){ + /** + * This comparator sorts by kinds first and the macros are sorted additionally by name. + */ + @Override + public int compare(ICLanguageSettingEntry entry0, ICLanguageSettingEntry entry1) { + int kind0 = entry0.getKind(); + int kind1 = entry1.getKind(); + if (kind0==ICSettingEntry.MACRO && kind1==ICSettingEntry.MACRO) { + return entry0.getName().compareTo(entry1.getName()); + } + + return kind0 - kind1; + }}); + + return sortedEntries; + } + + /** + * + */ + public void setSettingEntries(String rcProjectPath, String languageId, List entries) { + synchronized (fStorage) { + if (entries!=null) { + Map> langMap = fStorage.get(languageId); + if (langMap==null) { + langMap = new HashMap>(); + fStorage.put(languageId, langMap); + } + List sortedEntries = getPooledList(sortEntries(entries), false); + langMap.put(rcProjectPath, sortedEntries); + } else { + // do not keep nulls in the tables + Map> langMap = fStorage.get(languageId); + if (langMap!=null) { + langMap.remove(rcProjectPath); + if (langMap.size()==0) { + fStorage.remove(languageId); + } + } + } + } + } + + /** + * @return {@code true} if the provider does not keep any settings yet or {@code false} if there are some. + */ + public boolean isEmpty() { + return fStorage.isEmpty(); + } + + /** + * Clear all the entries for all configurations, all resources and all languages. + */ + public void clear() { + synchronized (fStorage) { + fStorage.clear(); + } + } + + /** + * Serialize the provider entries under parent XML element. + * @param elementProvider - element where to serialize the entries. + */ + public void serializeEntries(Element elementProvider) { + synchronized (fStorage) { + for (Entry>> entryLang : fStorage.entrySet()) { + serializeLanguage(elementProvider, entryLang); + } + } + } + + /** + * Serialize the provider entries for a given language list. + */ + private void serializeLanguage(Element parentElement, Entry>> entryLang) { + String langId = entryLang.getKey(); + if (langId!=null) { + Element elementLanguage = XmlUtil.appendElement(parentElement, ELEM_LANGUAGE, new String[] {ATTR_LANGUAGE_ID, langId}); + parentElement = elementLanguage; + } + for (Entry> entryRc : entryLang.getValue().entrySet()) { + serializeResource(parentElement, entryRc); + } + } + + /** + * Serialize the provider entries for a given resource list. + */ + private void serializeResource(Element parentElement, Entry> entryRc) { + String rcProjectPath = entryRc.getKey(); + if (rcProjectPath!=null) { + Element elementRc = XmlUtil.appendElement(parentElement, ELEM_RESOURCE, new String[] {ATTR_PROJECT_PATH, rcProjectPath}); + parentElement = elementRc; + } + serializeSettingEntries(parentElement, entryRc.getValue()); + } + + /** + * Serialize given settings entries. + */ + private void serializeSettingEntries(Element parentElement, List settingEntries) { + for (ICLanguageSettingEntry entry : settingEntries) { + Element elementSettingEntry = XmlUtil.appendElement(parentElement, ELEM_ENTRY, new String[] { + ATTR_KIND, LanguageSettingEntriesSerializer.kindToString(entry.getKind()), + ATTR_NAME, entry.getName(), + }); + switch(entry.getKind()) { + case ICSettingEntry.MACRO: + elementSettingEntry.setAttribute(ATTR_VALUE, entry.getValue()); + break; +// case ICLanguageSettingEntry.LIBRARY_FILE: +// // TODO: sourceAttachment fields may need to be covered +// break; + } + int flags = entry.getFlags(); + if (flags!=0) { + // Element elementFlag = + XmlUtil.appendElement(elementSettingEntry, ELEM_FLAG, new String[] { + ATTR_VALUE, LanguageSettingEntriesSerializer.composeFlagsString(entry.getFlags()) + }); + } + } + } + + /** + * Load provider entries from XML provider element. + * @param providerNode - parent XML element where entries are defined. + */ + public void loadEntries(Element providerNode) { + List settings = new ArrayList(); + NodeList nodes = providerNode.getChildNodes(); + for (int i=0;i0) { + setSettingEntries(null, null, settings); + } + } + + /** + * Load a setting entry from XML element. + */ + private ICLanguageSettingEntry loadSettingEntry(Node parentElement) { + String settingKind = XmlUtil.determineAttributeValue(parentElement, ATTR_KIND); + String settingName = XmlUtil.determineAttributeValue(parentElement, ATTR_NAME); + + NodeList flagNodes = parentElement.getChildNodes(); + int flags = 0; + for (int i=0;i settings = new ArrayList(); + NodeList nodes = parentNode.getChildNodes(); + for (int i=0;i0) { + setSettingEntries(null, langId, settings); + } + } + + /** + * Load entries defined in resource element. + */ + private void loadResourceElement(Node parentNode, String cfgId, String langId) { + String rcProjectPath = XmlUtil.determineAttributeValue(parentNode, ATTR_PROJECT_PATH); + + List settings = new ArrayList(); + NodeList nodes = parentNode.getChildNodes(); + for (int i=0;i0) { + setSettingEntries(rcProjectPath, langId, settings); + } + } + + /** + * Returns the equal list of entries from the pool to conserve the memory. + * + * @param entries - list of entries to pool. + * @param copy - specify {@code true} to copy the list in order to prevent + * back-door modification on the original list changes. + * @return returns the list of entries from the pool. + */ + private static List getPooledList(List entries, boolean copy) { + if (entries == null) + return null; + + List pooledList = listPool.get(entries); + if (pooledList != null) { + return pooledList; + } + + if (entries.size() == 0) { + return getPooledEmptyList(); + } + + if (copy) { + entries = new ArrayList(entries); + } + pooledList = Collections.unmodifiableList(entries); + return listPool.add(pooledList); + } + + /** + * Returns the equal list of entries from the pool to conserve the memory. + * + * @param entries - list of entries to pool. + * @return returns the list of entries from the pool. + */ + public static List getPooledList(List entries) { + return getPooledList(entries, true); + } + + /** + * @return the empty immutable list which is pooled. Use this call rather than creating + * new empty array to ensure that operator '==' can be used instead of deep equals(). + */ + public static List getPooledEmptyList() { + List pooledEmptyList = Collections.emptyList(); + return listPool.add(pooledEmptyList); + } + + /** + * Clone storage for the entries. Copies references for lists of entries as a whole. + * Note that is OK as the lists kept in storage are unmodifiable. + */ + public LanguageSettingsStorage cloneStorage() { + LanguageSettingsStorage storageClone = new LanguageSettingsStorage(); + synchronized (fStorage) { + Set>>> entrySetLang = fStorage.entrySet(); + for (Entry>> entryLang : entrySetLang) { + String langId = entryLang.getKey(); + Map> mapRc = entryLang.getValue(); + Map> mapRcClone = new HashMap>(); + Set>> entrySetRc = mapRc.entrySet(); + for (Entry> entryRc : entrySetRc) { + String rcProjectPath = entryRc.getKey(); + List lsEntries = entryRc.getValue(); + // don't need to clone entries, they are from the LSE pool + mapRcClone.put(rcProjectPath, lsEntries); + } + storageClone.fStorage.put(langId, mapRcClone); + } + } + return storageClone; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((fStorage == null) ? 0 : fStorage.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + LanguageSettingsStorage other = (LanguageSettingsStorage) obj; + if (fStorage == null) { + if (other.fStorage != null) + return false; + } else if (!fStorage.equals(other.fStorage)) + return false; + return true; + } + +} diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescription.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescription.java index 0f2af5f4b18..edd8031cf5d 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescription.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescription.java @@ -18,6 +18,7 @@ import java.util.Map; import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.cdtvariables.ICdtVariablesContributor; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.settings.model.CConfigurationStatus; import org.eclipse.cdt.core.settings.model.ICBuildSetting; import org.eclipse.cdt.core.settings.model.ICConfigExtensionReference; @@ -817,4 +818,22 @@ public class CConfigurationDescription extends CDataProxyContainer implements IC CConfigurationStatus status = data.getStatus(); return status != null ? status : CConfigurationStatus.CFG_STATUS_OK; } + + public void setLanguageSettingProviders(List providers) { + try { + CConfigurationSpecSettings specSettings = getSpecSettings(); + specSettings.setLanguageSettingProviders(providers); + } catch (CoreException e) { + CCorePlugin.log(e); + } +} + + public List getLanguageSettingProviders() { + try { + return getSpecSettings().getLanguageSettingProviders(); + } catch (CoreException e) { + CCorePlugin.log(e); + } + return null; + } } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescriptionCache.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescriptionCache.java index 0f537ed8b63..6b455cdd058 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescriptionCache.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationDescriptionCache.java @@ -16,6 +16,7 @@ import java.util.Map; import org.eclipse.cdt.core.cdtvariables.ICdtVariable; import org.eclipse.cdt.core.cdtvariables.ICdtVariablesContributor; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.settings.model.CConfigurationStatus; import org.eclipse.cdt.core.settings.model.ICBuildSetting; import org.eclipse.cdt.core.settings.model.ICConfigExtensionReference; @@ -53,6 +54,28 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.QualifiedName; +/** + * CConfigurationDescriptionCache is a proxy class for serialization of configuration description data. + * + * An inspection of the scenario where user changes project properties and saves it yields + * following sequence of events: + * - Initialization: + * - After eclipse started a project is being opened. A new CConfigurationDescriptionCache is created + * with CConfigurationDescriptionCache(ICStorageElement storage, CProjectDescription parent) constructor. + * - Any clients needed ICConfigurationDescription get CConfigurationDescription using constructor + * CConfigurationDescription(CConfigurationData data, String buildSystemId, ICDataProxyContainer cr) + * where the CConfigurationDescriptionCache is passed as data. The reference to cache is kept in field fCfgCache. + * - fCfgCache is used to getSpecSettings() CConfigurationSpecSettings, after that fCfgCache is set to null. + * - User enters project properties/settings: + * - another CConfigurationDescription (settings configuration) created using the same constructor setting fCfgCache + * to the CConfigurationDescriptionCache. + * - User changes settings (in the settings configuration CConfigurationDescription) and saves it: + * - new CConfigurationDescriptionCache is created from the CConfigurationDescription via constructor + * CConfigurationDescriptionCache(ICConfigurationDescription baseDescription, ...) where + * baseDescription is saved as fBaseDescription. + * - CConfigurationDescriptionCache.applyData(...) is used to persist the data. at that point + * reference fBaseDescription gets set to null. + */ public class CConfigurationDescriptionCache extends CDefaultConfigurationData implements ICConfigurationDescription, IInternalCCfgInfo, ICachedData { private CProjectDescription fParent; @@ -580,4 +603,13 @@ public class CConfigurationDescriptionCache extends CDefaultConfigurationData return status != null ? status : CConfigurationStatus.CFG_STATUS_OK; } + public void setLanguageSettingProviders(List providers) { + if(!fInitializing) + throw ExceptionFactory.createIsReadOnlyException(); + fSpecSettings.setLanguageSettingProviders(providers); + } + + public List getLanguageSettingProviders() { + return fSpecSettings.getLanguageSettingProviders(); + } } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java index 416bce252a1..8a4a4cf835d 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CConfigurationSpecSettings.java @@ -11,15 +11,21 @@ *******************************************************************************/ package org.eclipse.cdt.internal.core.settings.model; +import java.util.ArrayList; import java.util.Arrays; +import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.LinkedHashMap; +import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Set; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; import org.eclipse.cdt.core.settings.model.CExternalSetting; import org.eclipse.cdt.core.settings.model.ICBuildSetting; import org.eclipse.cdt.core.settings.model.ICConfigExtensionReference; @@ -37,9 +43,13 @@ import org.eclipse.cdt.internal.core.COwner; import org.eclipse.cdt.internal.core.COwnerConfiguration; import org.eclipse.cdt.internal.core.cdtvariables.StorableCdtVariables; import org.eclipse.cdt.internal.core.envvar.EnvironmentVariableManager; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsDelta; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsStorage; import org.eclipse.cdt.utils.envvar.StorableEnvironment; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.QualifiedName; +import org.eclipse.osgi.util.NLS; /** * CConfigurationSpecSettings impelements ICSettingsStorage @@ -87,6 +97,10 @@ public class CConfigurationSpecSettings implements ICSettingsStorage{ // private CConfigBasedDescriptor fDescriptor; // private Map fExternalSettingsProviderMap; + private List fLanguageSettingsProviders = new ArrayList(0); + private LinkedHashMap lspPersistedState = new LinkedHashMap(); + + private class DeltaSet { public Set extSet; public Set idSet; @@ -179,6 +193,12 @@ public class CConfigurationSpecSettings implements ICSettingsStorage{ fOwner = base.fOwner; copyExtensionInfo(base); + + fLanguageSettingsProviders = LanguageSettingsProvidersSerializer.cloneProviders(base.getLanguageSettingProviders()); + for (String providerId : base.lspPersistedState.keySet()) { + LanguageSettingsStorage clone = base.lspPersistedState.get(providerId).cloneStorage(); + lspPersistedState.put(providerId, clone); + } } // private void copyRefInfos(Map infosMap){ @@ -977,4 +997,70 @@ public class CConfigurationSpecSettings implements ICSettingsStorage{ public void updateExternalSettingsProviders(String[] ids){ ExtensionContainerFactory.updateReferencedProviderIds(fCfg, ids); } + + /** + * Adds list of {@link ILanguageSettingsProvider} to the specs. + * Note that only unique IDs are accepted. + * + * @param providers - list of providers to keep in the specs. + */ + public void setLanguageSettingProviders(List providers) { + fLanguageSettingsProviders = new ArrayList(0); + Set ids = new HashSet(); + for (ILanguageSettingsProvider provider : providers) { + String id = provider.getId(); + if (provider==LanguageSettingsProvidersSerializer.getRawWorkspaceProvider(id)) { + String msg = "Error: Attempt to add to the configuration raw global provider " + id; + throw new IllegalArgumentException(msg); + } + if (!ids.contains(id)) { + fLanguageSettingsProviders.add(provider); + ids.add(id); + } else { + String msg = NLS.bind(SettingsModelMessages.getString("CConfigurationSpecSettings.MustHaveUniqueID"), id); //$NON-NLS-1$ + throw new IllegalArgumentException(msg); + } + } + fIsModified = true; + } + + public List getLanguageSettingProviders() { + return Collections.unmodifiableList(fLanguageSettingsProviders); + } + + /** + * Returns delta and updates last persisted state to the new state. + * That implies that the delta needs to be used to fire an event of it will + * be lost. + */ + public LanguageSettingsDelta dropDelta() { + LanguageSettingsDelta languageSettingsDelta = null; + // newState gets shallow map first + LinkedHashMap newStateShallow = new LinkedHashMap(); + for (ILanguageSettingsProvider provider : fLanguageSettingsProviders) { + if (LanguageSettingsManager.isWorkspaceProvider(provider)) { + provider = LanguageSettingsManager.getRawProvider(provider); + } + if (provider instanceof LanguageSettingsSerializable) { + LanguageSettingsStorage store = ((LanguageSettingsSerializable) provider).getStorageInternal(); + if (!store.isEmpty()) { + newStateShallow.put(provider.getId(), store); + } + } + } + if (!newStateShallow.equals(lspPersistedState)) { + // do deep copy if the state needs to be saved + LinkedHashMap newStateDeep = new LinkedHashMap(); + for (Entry entry : newStateShallow.entrySet()) { + String providerId = entry.getKey(); + LanguageSettingsStorage store = entry.getValue(); + newStateDeep.put(providerId, store.cloneStorage()); + } + languageSettingsDelta = new LanguageSettingsDelta(lspPersistedState, newStateDeep); + lspPersistedState = newStateDeep; + } + + return languageSettingsDelta; + } + } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionDelta.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionDelta.java index 45bd1fb3b02..3508e6a902b 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionDelta.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionDelta.java @@ -182,6 +182,7 @@ public class CProjectDescriptionDelta implements ICDescriptionDelta { if ((flags&EXT_REF)!=0) str.append("EXT_REF|"); if ((flags&OWNER)!=0) str.append("OWNER|"); if ((flags&INDEX_CFG)!=0) str.append("INDEX_CFG|"); + if ((flags&LANGUAGE_SETTINGS_PROVIDERS)!=0) str.append("LANGUAGE_SETTINGS_PROVIDERS|"); if (str.charAt(str.length()-1)=='|') str.deleteCharAt(str.length()-1); return str.toString(); diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionManager.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionManager.java index 2143b5e9488..231694eb3f9 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionManager.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/CProjectDescriptionManager.java @@ -50,6 +50,7 @@ import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.model.CModelException; import org.eclipse.cdt.core.model.ICElement; import org.eclipse.cdt.core.model.ICElementDelta; @@ -1570,6 +1571,10 @@ public class CProjectDescriptionManager implements ICProjectDescriptionManager { CCorePlugin.log(e); } + List newLSProviders = newCfg.getLanguageSettingProviders(); + List oldLSProviders = oldCfg.getLanguageSettingProviders(); + if(!newLSProviders.equals(oldLSProviders)) + delta.addChangeFlags(ICDescriptionDelta.LANGUAGE_SETTINGS_PROVIDERS); calculateCfgExtSettingsDelta(delta); diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/DescriptionScannerInfoProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/DescriptionScannerInfoProvider.java index f6317eb69e9..25def77a37c 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/DescriptionScannerInfoProvider.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/DescriptionScannerInfoProvider.java @@ -35,6 +35,7 @@ import org.eclipse.cdt.core.settings.model.ICProjectDescriptionListener; import org.eclipse.cdt.core.settings.model.ICResourceDescription; import org.eclipse.cdt.core.settings.model.ICSettingBase; import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsLogger; import org.eclipse.cdt.utils.EFSExtensionManager; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; @@ -77,6 +78,9 @@ public class DescriptionScannerInfoProvider implements IScannerInfoProvider, ICP @Override public IScannerInfo getScannerInformation(IResource resource) { + // AG FIXME + LanguageSettingsLogger.logScannerInfoProvider(resource, this); + if(!fInited) updateProjCfgInfo(CProjectDescriptionManager.getInstance().getProjectDescription(fProject, false)); diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/MultiConfigDescription.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/MultiConfigDescription.java index 653b0c662bd..c0688bbf98b 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/MultiConfigDescription.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/MultiConfigDescription.java @@ -14,9 +14,11 @@ package org.eclipse.cdt.internal.core.settings.model; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; +import java.util.List; import java.util.Map; import org.eclipse.cdt.core.cdtvariables.ICdtVariablesContributor; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; import org.eclipse.cdt.core.settings.model.CConfigurationStatus; import org.eclipse.cdt.core.settings.model.ICBuildSetting; import org.eclipse.cdt.core.settings.model.ICConfigExtensionReference; @@ -637,4 +639,15 @@ public class MultiConfigDescription extends MultiItemsHolder implements fCfgs[i].removeStorage(id); } + public void setLanguageSettingProviders(List providers) { + if (DEBUG) + System.out.println("Bad multi access: MultiConfigDescription.setLanguageSettingProviders()"); //$NON-NLS-1$ + } + + public List getLanguageSettingProviders() { + if (DEBUG) + System.out.println("Bad multi access: MultiConfigDescription.getLanguageSettingProviders()"); //$NON-NLS-1$ + return null; + } + } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/ScannerInfoProviderProxy.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/ScannerInfoProviderProxy.java index e314ffce39b..ec753f5d9bb 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/ScannerInfoProviderProxy.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/ScannerInfoProviderProxy.java @@ -16,13 +16,19 @@ import java.util.List; import java.util.Map; import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; import org.eclipse.cdt.core.parser.IScannerInfo; import org.eclipse.cdt.core.parser.IScannerInfoChangeListener; import org.eclipse.cdt.core.parser.IScannerInfoProvider; import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsScannerInfoProvider; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; +/** + * TODO fProvider is going to be deprecated in favor of {@link LanguageSettingsScannerInfoProvider}. + * + */ public class ScannerInfoProviderProxy extends AbstractCExtensionProxy implements IScannerInfoProvider, IScannerInfoChangeListener{ private Map> listeners; private IScannerInfoProvider fProvider; @@ -34,6 +40,11 @@ public class ScannerInfoProviderProxy extends AbstractCExtensionProxy implements @Override public IScannerInfo getScannerInformation(IResource resource) { + if (ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(getProject())) { + LanguageSettingsScannerInfoProvider lsProvider = new LanguageSettingsScannerInfoProvider(); + return lsProvider.getScannerInformation(resource); + } + // Legacy logic providerRequested(); return fProvider.getScannerInformation(resource); } diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/SettingsModelMessages.properties b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/SettingsModelMessages.properties index a37c844b3f2..09dd9fd56cb 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/SettingsModelMessages.properties +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/SettingsModelMessages.properties @@ -15,8 +15,9 @@ CConfigurationDescription.0=data was not created CConfigurationDescription.1=expected proxy of type ICFileDescription, but was CConfigurationDescription.2=data was not created CConfigurationDescription.3=expected proxy of type ICFolderDescription, but was -CConfigurationStatus.1=configurations settings invalid CConfigurationDescriptionCache.0=description is read only +CConfigurationSpecSettings.MustHaveUniqueID=Language Settings Providers must have unique ID. Duplicate ID={0} +CConfigurationStatus.1=configurations settings invalid CProjectConverterDesciptor.0=illegal provider implementation CProjectConverterDesciptor.1=no provider defined CProjectDescriptionManager.1=required build system is not installed @@ -49,5 +50,8 @@ CExternalSettingsManager.3=writable ref info is requested for the read only conf CfgExportSettingContainerFactory.2=invalid id: project name not specified ExtensionContainerFactory.4=invalid setting provider class specified ExtensionContainerFactory.5=provider element not specified +LanguageSettingsBaseProvider.CanBeConfiguredOnlyOnce=LanguageSettingsBaseProvider can be configured only once +LanguageSettingsScannerInfoProvider.UnableToDetermineLanguage=Error getting ScannerInfo: Unable to determine language for resource {0} SettingsContext.0=no project associated with the context SettingsContext.1=can not accept the not-context project description + diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/xml/XmlProjectDescriptionStorage.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/xml/XmlProjectDescriptionStorage.java index 8ad92ba26c8..e5dca0d567a 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/xml/XmlProjectDescriptionStorage.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/internal/core/settings/model/xml/XmlProjectDescriptionStorage.java @@ -42,6 +42,7 @@ import org.eclipse.cdt.core.settings.model.extension.ICProjectConverter; import org.eclipse.cdt.core.settings.model.util.CDataUtil; import org.eclipse.cdt.internal.core.XmlUtil; import org.eclipse.cdt.internal.core.envvar.ContributedEnvironment; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; import org.eclipse.cdt.internal.core.settings.model.AbstractCProjectDescriptionStorage; import org.eclipse.cdt.internal.core.settings.model.CProjectDescription; import org.eclipse.cdt.internal.core.settings.model.CProjectDescriptionManager; @@ -172,6 +173,7 @@ public class XmlProjectDescriptionStorage extends AbstractCProjectDescriptionSto serializingLock.acquire(); projectModificaitonStamp = serialize(fDes.getProject(), ICProjectDescriptionStorageType.STORAGE_FILE_NAME, fElement); ((ContributedEnvironment) CCorePlugin.getDefault().getBuildEnvironmentManager().getContributedEnvironment()).serialize(fDes); + LanguageSettingsProvidersSerializer.serializeLanguageSettings(fDes); } finally { serializingLock.release(); Job.getJobManager().removeJobChangeListener(notifyJobCanceller); @@ -364,6 +366,7 @@ public class XmlProjectDescriptionStorage extends AbstractCProjectDescriptionSto if (!overwriteIfExists && fProjectDescription.get() != null) return false; + ICProjectDescription oldDes = fProjectDescription.get(); if (des != null) { if (project.exists() && project.isOpen()) { fProjectDescription = new SoftReference(des); @@ -374,6 +377,8 @@ public class XmlProjectDescriptionStorage extends AbstractCProjectDescriptionSto } else { fProjectDescription = new SoftReference(null); } + + LanguageSettingsProvidersSerializer.reRegisterListeners(oldDes, fProjectDescription.get()); return true; } @@ -486,6 +491,8 @@ public class XmlProjectDescriptionStorage extends AbstractCProjectDescriptionSto try { setThreadLocalProjectDesc(des); des.loadDatas(); + + LanguageSettingsProvidersSerializer.loadLanguageSettings(des); des.doneLoading(); } finally { setThreadLocalProjectDesc(null); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java new file mode 100644 index 00000000000..67ccc3f082f --- /dev/null +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/LanguageSettingsChangeListener.java @@ -0,0 +1,53 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.internal.core.pdom; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICProjectDescription; +import org.eclipse.cdt.internal.core.language.settings.providers.ILanguageSettingsChangeEvent; +import org.eclipse.cdt.internal.core.language.settings.providers.ILanguageSettingsChangeListener; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IWorkspaceRoot; +import org.eclipse.core.resources.ResourcesPlugin; + +/** + * This class handles changes in language settings for the PDOM. + */ +public class LanguageSettingsChangeListener implements ILanguageSettingsChangeListener { + private PDOMManager fManager; + + public LanguageSettingsChangeListener(PDOMManager manager) { + fManager = manager; + } + + public void handleEvent(ILanguageSettingsChangeEvent event) { + IWorkspaceRoot wspRoot = ResourcesPlugin.getWorkspace().getRoot(); + IProject project = wspRoot.getProject(event.getProjectName()); + + if (project != null) { + ICProjectDescription prjDescription = CCorePlugin.getDefault().getProjectDescription(project); + if (prjDescription != null) { + ICConfigurationDescription indexedCfgDescription = prjDescription.getDefaultSettingConfiguration(); + String indexedCfgId = indexedCfgDescription.getId(); + + for (String cfgId : event.getConfigurationDescriptionIds()) { + if (cfgId.equals(indexedCfgId)) { + fManager.handlePostBuildEvent(); + return; + } + } + } + } + + } + +} diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java index 797f76b56dc..425c2b95641 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/PDOMManager.java @@ -68,6 +68,7 @@ import org.eclipse.cdt.internal.core.index.IndexChangeEvent; import org.eclipse.cdt.internal.core.index.IndexFactory; import org.eclipse.cdt.internal.core.index.IndexerStateEvent; import org.eclipse.cdt.internal.core.index.provider.IndexProviderManager; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer; import org.eclipse.cdt.internal.core.pdom.PDOM.IListener; import org.eclipse.cdt.internal.core.pdom.db.ChunkCache; import org.eclipse.cdt.internal.core.pdom.dom.IPDOMLinkageFactory; @@ -165,6 +166,7 @@ public class PDOMManager implements IWritableIndexManager, IListener { private CModelListener fCModelListener= new CModelListener(this); private ILanguageMappingChangeListener fLanguageChangeListener = new LanguageMappingChangeListener(this); + private LanguageSettingsChangeListener fLanguageSettingsChangeListener = new LanguageSettingsChangeListener(this); private final ICProjectDescriptionListener fProjectDescriptionListener; private final JobChangeListener fJobChangeListener; private final IPreferenceChangeListener fPreferenceChangeListener; @@ -238,6 +240,7 @@ public class PDOMManager implements IWritableIndexManager, IListener { ResourcesPlugin.getWorkspace().addResourceChangeListener(fCModelListener, IResourceChangeEvent.POST_BUILD); model.addElementChangedListener(fCModelListener); LanguageManager.getInstance().registerLanguageChangeListener(fLanguageChangeListener); + LanguageSettingsProvidersSerializer.registerLanguageSettingsChangeListener(fLanguageSettingsChangeListener); final int types= CProjectDescriptionEvent.DATA_APPLIED; CCorePlugin.getDefault().getProjectDescriptionManager().addCProjectDescriptionListener(fProjectDescriptionListener, types); @@ -258,6 +261,7 @@ public class PDOMManager implements IWritableIndexManager, IListener { final CoreModel model = CoreModel.getDefault(); model.removeElementChangedListener(fCModelListener); ResourcesPlugin.getWorkspace().removeResourceChangeListener(fCModelListener); + LanguageSettingsProvidersSerializer.unregisterLanguageSettingsChangeListener(fLanguageSettingsChangeListener); LanguageManager.getInstance().unregisterLanguageChangeListener(fLanguageChangeListener); PDOMIndexerJob jobToCancel= null; synchronized (fTaskQueue) { diff --git a/core/org.eclipse.cdt.core/plugin.properties b/core/org.eclipse.cdt.core/plugin.properties index af08cf10ff5..58aae223c1e 100644 --- a/core/org.eclipse.cdt.core/plugin.properties +++ b/core/org.eclipse.cdt.core/plugin.properties @@ -26,6 +26,7 @@ ErrorParser.name=Error Parser BinaryParser.name=Binary Parser PathEntryStore.name=Path Entry Store ScannerInfoProvider.name=Scanner Information Provider +LanguageSettingsProvider.name=Language Settings Provider CIndexer.name= C/C++ Indexer language.name= CDT Language diff --git a/core/org.eclipse.cdt.core/plugin.xml b/core/org.eclipse.cdt.core/plugin.xml index 3cb166b1acb..95349032069 100644 --- a/core/org.eclipse.cdt.core/plugin.xml +++ b/core/org.eclipse.cdt.core/plugin.xml @@ -638,8 +638,9 @@ - - + + + + + + + diff --git a/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd b/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd new file mode 100644 index 00000000000..3fd10baf9c5 --- /dev/null +++ b/core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd @@ -0,0 +1,264 @@ + + + + + + + + + This extension point is used to contribute a new Language Settings Provider. A Language Settings Provider is used to get additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model. + + + + + + + + + + + + + + + + + + + + + + + + ID of the extension point, not used + + + + + + + Name of the extension point, not used + + + + + + + + + + + + + The definition of a language settings provider. + + + + + + + + + + + A fully qualified name of the Java class that implements <samp>org.eclipse.cdt.core.settings.model.ILanguageSettingsProvider</samp> interface. If empty, <samp>org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider</samp> is used by default which provides basic functionality defined by this extension point. +If there is a need to configure a provider, attribute parameter could be used in a class extending <samp>LanguageSettingsBaseProvider</samp>. + + + + + + + + + + Unique ID of the provider + + + + + + + Name of the provider. This name will be presented to a user in UI. + + + + + + + A custom parameter to initialize provider. Used to deliver command for GCCBuiltinSpecsDetector as an example. + + + + + + + + + + The definition of language scope. Includes the list of language ID this provider is applicable to. If a language scope is not present, the provider will provide for any language. + + + + + + + ID of the language for which this provider provides the entries. As an example, those are languages contributed by CDT (see extension org.eclipse.cdt.core.language): +<p>- "<samp>org.eclipse.cdt.core.gcc</samp>" for C,</p> +<p>- "<samp>org.eclipse.cdt.core.g++</samp>" for C++.</p> + + + + + + + + + + The Language Settings Entries used to provide additions to compiler options such as include paths (-I) or preprocessor defines (-D) and others into the project model. + + + + + + + + + + Kind of language settings entry which maps to compiler options. For example, following mapping is used for gcc options: + +<br><samp>"-I"</samp> : includePath +<br>"<samp>-D</samp>" : macro +<br>"<samp>-include</samp>" : includeFile +<br>"<samp>-L</samp>" : libraryPath +<br>"<samp>-l</samp>" : libraryFile +<br>"<samp>-imacros</samp>" : macroFile + + + + + + + + + + + + + + + + + + + + + + + "name" attribute maps to path for the entries representing a path to a folder or file and to name for <samp>macro</samp> kind representing name-value pair. For example: +<br>"<samp>/usr/include/</samp>" +<br>"<samp>MACRO</samp>" (for <samp>#define MACRO value</samp>) +<br>Note that relative paths are treated as rooted in build working directory (when applicable). + + + + + + + "value" attribute is used for <samp>macro</samp> kind representing name-value pair only. It is not used for the entries representing a path. For example: +<br>"<samp>value</samp>" (for <samp>#define MACRO value</samp>) + + + + + + + + + + Combination of flags for the entry. + + + + + + + A value of the flag. Corresponds to <samp>ICSettingEntry</samp> flags, see JavaDoc there for more details. Here is an excerpt from the Javadoc for the flags intended to be used with this extension point (the others might be not supported): + <br>- <samp>BUILTIN</samp> : Indicates settings built in a tool (compiler) itself. That kind of settings are not passed as options to a compiler but indexer or other clients might need them. + <br>- <samp>LOCAL</samp> : Applicable for <samp>includePath</samp> only which could be local (#include "...") or system (#include <...>). If an <samp>includePath</samp> is not marked as <samp>LOCAL</samp> it is treated as system. + <br>- <samp>RESOLVED</samp> : Indicates that the entries do not need to be resolved such as expansion of environment variables, normalizing the path against build working directory etc. + <br>- <samp>VALUE_WORKSPACE_PATH</samp> : is used to indicate that the entry is a resource managed by eclipse in the workspace. The path is rooted in the workspace root. + <br>- <samp>UNDEFINED</samp> : indicates that the entry should not be defined, corresponds to <samp>-U</samp> option of gcc compiler. If this flag is defined it will negate entries with the same name (and kind) for all providers down the list. + + + + + + + + + + + + + + + + + + + + + + + + + + CDT 9.0 + + + + + + + + + [Enter extension point usage example here.] + + + + + + + + + Plug-ins that want to extend this extension point must implement <samp>org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider</samp> interface. +<br/> +For those cases where contributed settings entries (representing the compiler options) are not changed dynamically it is sufficient to configure existing class LanguageSettingsBaseProvider which is provided by default. +<br/> + + + + + + + + + [Enter information about supplied implementation of this extension point.] + + + + + + + + + Copyright (c) 2009, 2010 Andrew Gvozdev (Quoin Inc.) 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 + + + + diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/AbstractExecutableExtensionBase.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/AbstractExecutableExtensionBase.java new file mode 100644 index 00000000000..d56988056f6 --- /dev/null +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/AbstractExecutableExtensionBase.java @@ -0,0 +1,83 @@ +/******************************************************************************* + * Copyright (c) 2009, 2010 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core; + +/** + * Helper abstract class serving as a base for creating a frame of executable class + * defined as an extension in plugin.xml. + * + */ +public abstract class AbstractExecutableExtensionBase { + private String fId; + private String fName; + + /** + * Default constructor will initialize with the name of the class + * using reflection mechanism. + */ + public AbstractExecutableExtensionBase() { + fName = this.getClass().getSimpleName(); + fId = this.getClass().getCanonicalName(); + } + + /** + * Constructor to initialize with ID and name of the extension. + * + * @param id - ID of the extension. + * @param name - name of the extension. + */ + public AbstractExecutableExtensionBase(String id, String name) { + fName = name; + fId = id; + } + + /** + * Set extension ID. + * + * @param id of extension + */ + public void setId(String id) { + fId = id; + } + + /** + * Set extension name. + * + * @param name of extension + */ + public void setName(String name) { + fName = name; + } + + /** + * @return id of extension + */ + public String getId() { + return fId; + } + + /** + * @return name of extension + */ + public String getName() { + return fName; + } + + /** + * Method toString() for debugging purposes. + */ + @SuppressWarnings("nls") + @Override + public String toString() { + return "id="+fId+", name="+fName; + } +} diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java index cb10cbfe991..83100d58ca2 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java @@ -530,7 +530,7 @@ public class CCorePlugin extends Plugin { * * @return CDT console adapter. */ - private IConsole getConsole(String extConsoleId, String contextId, String name, URL iconUrl) { + public IConsole getConsole(String extConsoleId, String contextId, String name, URL iconUrl) { try { IExtensionPoint extensionPoint = Platform.getExtensionRegistry().getExtensionPoint(CCorePlugin.PLUGIN_ID, "CBuildConsole"); //$NON-NLS-1$ if (extensionPoint != null) { @@ -1385,4 +1385,4 @@ public class CCorePlugin extends Plugin { return InstanceScope.INSTANCE.getNode(PLUGIN_ID) .getBoolean(CCorePreferenceConstants.SHOW_SOURCE_ROOTS_AT_TOP_LEVEL_OF_PROJECT, true); } -} \ No newline at end of file +} diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java index 65ea2af5837..7d5c988656a 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java @@ -713,7 +713,7 @@ outer: * @return URI * @since 5.1 */ - private URI toURI(IPath path) { + public URI toURI(IPath path) { // try { URI baseURI = getWorkingDirectoryURI(); String uriString = path.toString(); diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICConsoleParser.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICConsoleParser.java new file mode 100644 index 00000000000..44b216124bc --- /dev/null +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICConsoleParser.java @@ -0,0 +1,25 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.core; + +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.core.runtime.CoreException; + +/** + * TODO - this interface assumes configuration description. CDT project + * can be without configurations, in that case IProject should be passed + * to startup somehow. Perhaps another interface "IPConsoleParser" could + * be created when needed? + */ +public interface ICConsoleParser extends IConsoleParser { + public void startup(ICConfigurationDescription cfgDescription) throws CoreException; +} diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/ScannerProvider.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/ScannerProvider.java index 9295514553e..091ba1e09b8 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/ScannerProvider.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/ScannerProvider.java @@ -29,8 +29,10 @@ import org.eclipse.cdt.core.model.IMacroFileEntry; import org.eclipse.cdt.core.parser.IScannerInfo; import org.eclipse.cdt.core.parser.IScannerInfoChangeListener; import org.eclipse.cdt.core.parser.IScannerInfoProvider; +import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsLogger; import org.eclipse.cdt.internal.core.model.PathEntryManager; import org.eclipse.cdt.internal.core.settings.model.ScannerInfoProviderProxy; +import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.IPath; @@ -96,6 +98,13 @@ public class ScannerProvider extends AbstractCExtension implements IScannerInfoP */ @Override public IScannerInfo getScannerInformation(IResource resource) { + // AG FIXME + if (resource instanceof IFile) { + LanguageSettingsLogger.logInfo("rc="+resource+" (ScannerProvider.getScannerInformation())"); + } else { + LanguageSettingsLogger.logWarning("rc="+resource+" (ScannerProvider.getScannerInformation())"); + } + IPath resPath = resource.getFullPath(); try { diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/ConsoleOutputSniffer.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/ConsoleOutputSniffer.java index aa357dd991a..636fe70164e 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/ConsoleOutputSniffer.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/ConsoleOutputSniffer.java @@ -13,7 +13,10 @@ package org.eclipse.cdt.internal.core; import java.io.IOException; import java.io.OutputStream; +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.ErrorParserManager; import org.eclipse.cdt.core.IConsoleParser; +import org.eclipse.cdt.core.IErrorParser; /** @@ -127,6 +130,8 @@ public class ConsoleOutputSniffer { private OutputStream consoleErrorStream; private IConsoleParser[] parsers; + private ErrorParserManager errorParserManager = null; + public ConsoleOutputSniffer(IConsoleParser[] parsers) { this.parsers = parsers; } @@ -137,6 +142,11 @@ public class ConsoleOutputSniffer { this.consoleErrorStream = errorStream; } + public ConsoleOutputSniffer(OutputStream outputStream, OutputStream errorStream, IConsoleParser[] parsers, ErrorParserManager epm) { + this(outputStream, errorStream, parsers); + this.errorParserManager = epm; + } + /** * Returns an output stream that will be sniffed. * This stream should be hooked up so the command @@ -166,7 +176,13 @@ public class ConsoleOutputSniffer { public synchronized void closeConsoleOutputStream() throws IOException { if (nOpens > 0 && --nOpens == 0) { for (int i = 0; i < parsers.length; ++i) { - parsers[i].shutdown(); + try { + parsers[i].shutdown(); + } catch (Throwable e) { + // Report exception if any but let all the parsers chance to shutdown. + CCorePlugin.log(e); + } finally { + } } } } @@ -177,8 +193,18 @@ public class ConsoleOutputSniffer { * @param line */ private synchronized void processLine(String line) { - for (int i = 0; i < parsers.length; ++i) { - parsers[i].processLine(line); + for (IConsoleParser parser : parsers) { + try { + if (parser instanceof IErrorParser) { + // IErrorParser interface is used here only with purpose to pass ErrorParserManager + // which keeps track of CWD and provides useful methods for locating files + ((IErrorParser)parser).processLine(line, errorParserManager); + } else { + parser.processLine(line); + } + } catch (Throwable e) { + CCorePlugin.log(e); + } } } diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/resources/CygwinEFSExtensionProvider.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/resources/CygwinEFSExtensionProvider.java new file mode 100644 index 00000000000..5e78daf609b --- /dev/null +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/resources/CygwinEFSExtensionProvider.java @@ -0,0 +1,101 @@ +/******************************************************************************* + * Copyright (c) 2011, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.core.resources; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URI; + +import org.eclipse.cdt.core.CCorePlugin; +import org.eclipse.cdt.core.EFSExtensionProvider; +import org.eclipse.core.runtime.Platform; + +public class CygwinEFSExtensionProvider extends EFSExtensionProvider { + @Override + public String getMappedPath(URI locationURI) { + String cygwinPath = getPathFromURI(locationURI); + String windowsPath = null; + try { + windowsPath = cygwinToWindowsPath(cygwinPath); + } catch (Exception e) { + CCorePlugin.log(e); + } + return windowsPath; + } + + /** + * Conversion from Windows path to Cygwin path. + * + * @param windowsPath - Windows path. + * @return Cygwin style converted path. + * @throws UnsupportedOperationException if Cygwin is unavailable. + * @throws IOException on IO problem. + * + * See ResourceHelper.windowsToCygwinPath(...) + */ + public static String windowsToCygwinPath(String windowsPath) throws IOException, UnsupportedOperationException { + if (!Platform.getOS().equals(Platform.OS_WIN32)) { + // Don't run this on non-windows platforms + throw new UnsupportedOperationException("Not a Windows system, Cygwin is unavailable."); + } + @SuppressWarnings("nls") + String[] args = {"cygpath", "-u", windowsPath}; + Process cygpath; + try { + cygpath = Runtime.getRuntime().exec(args); + } catch (IOException ioe) { + throw new UnsupportedOperationException("Cygwin utility cygpath is not in the system search path."); + } + BufferedReader stdout = new BufferedReader(new InputStreamReader(cygpath.getInputStream())); + + String cygwinPath = stdout.readLine(); + if (cygwinPath == null) { + throw new UnsupportedOperationException("Cygwin utility cygpath is not available."); + } + return cygwinPath.trim(); + } + + /** + * Conversion from Cygwin path to Windows path. + * + * @param cygwinPath - Cygwin path. + * @return Windows style converted path. + * @throws UnsupportedOperationException if Cygwin is unavailable. + * @throws IOException on IO problem. + * + * * See ResourceHelper.cygwinToWindowsPath(...) + */ + public static String cygwinToWindowsPath(String cygwinPath) throws IOException, UnsupportedOperationException { + if (!Platform.getOS().equals(Platform.OS_WIN32)) { + // Don't run this on non-windows platforms + throw new UnsupportedOperationException("Not a Windows system, Cygwin is unavailable."); + } + @SuppressWarnings("nls") + String[] args = {"cygpath", "-w", cygwinPath}; + Process cygpath; + try { + cygpath = Runtime.getRuntime().exec(args); + } catch (IOException ioe) { + throw new UnsupportedOperationException("Cygwin utility cygpath is not in the system search path."); + } + BufferedReader stdout = new BufferedReader(new InputStreamReader(cygpath.getInputStream())); + + String windowsPath = stdout.readLine(); + if (windowsPath == null) { + throw new UnsupportedOperationException("Cygwin utility cygpath is not available."); + } + return windowsPath.trim(); + } + + +} diff --git a/core/org.eclipse.cdt.ui/META-INF/MANIFEST.MF b/core/org.eclipse.cdt.ui/META-INF/MANIFEST.MF index 993b6f1a79d..cd374ed28a2 100644 --- a/core/org.eclipse.cdt.ui/META-INF/MANIFEST.MF +++ b/core/org.eclipse.cdt.ui/META-INF/MANIFEST.MF @@ -29,6 +29,7 @@ Export-Package: org.eclipse.cdt.internal.corext;x-internal:=true, org.eclipse.cdt.internal.ui.includebrowser;x-internal:=true, org.eclipse.cdt.internal.ui.indexview;x-internal:=true, org.eclipse.cdt.internal.ui.language;x-internal:=true, + org.eclipse.cdt.internal.ui.language.settings.providers;x-internal:=true, org.eclipse.cdt.internal.ui.navigator;x-internal:=true, org.eclipse.cdt.internal.ui.newui;x-internal:=true, org.eclipse.cdt.internal.ui.preferences;x-internal:=true, diff --git a/core/org.eclipse.cdt.ui/icons/obj16/filesyst.gif b/core/org.eclipse.cdt.ui/icons/obj16/filesyst.gif index 13ce11b1490..4b98a62c6ee 100644 Binary files a/core/org.eclipse.cdt.ui/icons/obj16/filesyst.gif and b/core/org.eclipse.cdt.ui/icons/obj16/filesyst.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/obj16/frameworks.gif b/core/org.eclipse.cdt.ui/icons/obj16/frameworks.gif new file mode 100644 index 00000000000..82261154cd7 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/obj16/frameworks.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/obj16/ls_entries.gif b/core/org.eclipse.cdt.ui/icons/obj16/ls_entries.gif new file mode 100644 index 00000000000..93368302e91 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/obj16/ls_entries.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/obj16/ls_entries_provider.gif b/core/org.eclipse.cdt.ui/icons/obj16/ls_entries_provider.gif new file mode 100644 index 00000000000..4832572f211 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/obj16/ls_entries_provider.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/obj16/provider_ls_obj.gif b/core/org.eclipse.cdt.ui/icons/obj16/provider_ls_obj.gif new file mode 100644 index 00000000000..7f3f595bc5e Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/obj16/provider_ls_obj.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/obj16/search.gif b/core/org.eclipse.cdt.ui/icons/obj16/search.gif new file mode 100644 index 00000000000..d540a01f4d9 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/obj16/search.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/cfg_ovr.gif b/core/org.eclipse.cdt.ui/icons/ovr16/cfg_ovr.gif new file mode 100644 index 00000000000..f82aa5fbb49 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/cfg_ovr.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/edited_ov.gif b/core/org.eclipse.cdt.ui/icons/ovr16/edited_ov.gif new file mode 100644 index 00000000000..48526ac8b38 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/edited_ov.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/empty_ovr.png b/core/org.eclipse.cdt.ui/icons/ovr16/empty_ovr.png new file mode 100644 index 00000000000..337395a0812 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/empty_ovr.png differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/global_ovr.gif b/core/org.eclipse.cdt.ui/icons/ovr16/global_ovr.gif new file mode 100644 index 00000000000..2888b2eefa9 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/global_ovr.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/import_co.gif b/core/org.eclipse.cdt.ui/icons/ovr16/import_co.gif new file mode 100644 index 00000000000..b0a24b27844 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/import_co.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/link_ovr.gif b/core/org.eclipse.cdt.ui/icons/ovr16/link_ovr.gif new file mode 100644 index 00000000000..4f1440ebe0e Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/link_ovr.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/lock_ovr.gif b/core/org.eclipse.cdt.ui/icons/ovr16/lock_ovr.gif new file mode 100644 index 00000000000..4499ad076d3 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/lock_ovr.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/overlay-has-context.gif b/core/org.eclipse.cdt.ui/icons/ovr16/overlay-has-context.gif new file mode 100644 index 00000000000..c53adcf7f30 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/overlay-has-context.gif differ diff --git a/core/org.eclipse.cdt.ui/icons/ovr16/project_co.gif b/core/org.eclipse.cdt.ui/icons/ovr16/project_co.gif new file mode 100644 index 00000000000..388f31514c4 Binary files /dev/null and b/core/org.eclipse.cdt.ui/icons/ovr16/project_co.gif differ diff --git a/core/org.eclipse.cdt.ui/plugin.properties b/core/org.eclipse.cdt.ui/plugin.properties index 356cea095b7..9a3bc8c32ac 100644 --- a/core/org.eclipse.cdt.ui/plugin.properties +++ b/core/org.eclipse.cdt.ui/plugin.properties @@ -595,9 +595,11 @@ excluded-file.name = C/C++ Files Excluded from Build templatesViewName= Templates +AllLanguageSettingEntries.name=Providers +AllLanguageSettingEntries.tooltip=Language Setting Entries Providers + deleteConfigsCommand.name = Reset to Default -excludeCommand.name = Exclude from Build -ActionDefinition.selectEnclosing.description = Expand the selection to enclosing C/C++ element +excludeCommand.name = Exclude from BuildActionDefinition.selectEnclosing.description = Expand the selection to enclosing C/C++ element ActionDefinition.selectEnclosing.name = Select Enclosing C/C++ Element ActionDefinition.selectNext.description = Expand the selection to next C/C++ element ActionDefinition.selectNext.name = Select Next C/C++ Element @@ -605,6 +607,8 @@ ActionDefinition.selectPrevious.description = Expand the selection to enclosing ActionDefinition.selectPrevious.name = Select Previous C/C++ Element ActionDefinition.selectLast.description = Restore last selection in C/C++ editor ActionDefinition.selectLast.name = Restore Last C/C++ Selection +LanguageSettingsProviderUIExtensionPoint=Language Settings Provider UI +LanguageSettingsProviderAssociationExtensionPoint=Language Settings Provider UI overrideAnnotation.label = C/C++ Override indicators transfer.EditorAppearance.name = C/C++ Editor Appearance @@ -615,4 +619,4 @@ transfer.EditorBehavior.description = Preference related to how the editor proce # Refresh Exclusion Contributors RefreshExclusionContributor.name = Resources -extension-point.name = Refresh Exclusion Contributor \ No newline at end of file +extension-point.name = Refresh Exclusion Contributor diff --git a/core/org.eclipse.cdt.ui/plugin.xml b/core/org.eclipse.cdt.ui/plugin.xml index 9a712d3953f..44ec840d861 100644 --- a/core/org.eclipse.cdt.ui/plugin.xml +++ b/core/org.eclipse.cdt.ui/plugin.xml @@ -26,6 +26,7 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + [Enter description of this extension point.] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [Enter the first release in which this extension point appears.] + + + + + + + + + [Enter extension point usage example here.] + + + + + + + + + [Enter API information here.] + + + + + + + + + [Enter information about supplied implementation of this extension point.] + + + + + diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/ImageCombo.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/ImageCombo.java new file mode 100644 index 00000000000..8b71742590a --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/ImageCombo.java @@ -0,0 +1,1471 @@ +/******************************************************************************* + * Copyright (c) 2000, 2005 IBM Corporation 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: + * IBM Corporation - initial API and implementation + * Tom Seidel - enhancements for image-handling + *******************************************************************************/ +package org.eclipse.cdt.internal.ui; + +import java.util.Arrays; + +import org.eclipse.swt.SWT; +import org.eclipse.swt.SWTException; +import org.eclipse.swt.accessibility.ACC; +import org.eclipse.swt.accessibility.AccessibleAdapter; +import org.eclipse.swt.accessibility.AccessibleControlAdapter; +import org.eclipse.swt.accessibility.AccessibleControlEvent; +import org.eclipse.swt.accessibility.AccessibleEvent; +import org.eclipse.swt.accessibility.AccessibleTextAdapter; +import org.eclipse.swt.accessibility.AccessibleTextEvent; +import org.eclipse.swt.events.ModifyListener; +import org.eclipse.swt.events.SelectionEvent; +import org.eclipse.swt.events.SelectionListener; +import org.eclipse.swt.graphics.Color; +import org.eclipse.swt.graphics.Font; +import org.eclipse.swt.graphics.GC; +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.graphics.Point; +import org.eclipse.swt.graphics.Rectangle; +import org.eclipse.swt.widgets.Button; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Display; +import org.eclipse.swt.widgets.Event; +import org.eclipse.swt.widgets.Label; +import org.eclipse.swt.widgets.Layout; +import org.eclipse.swt.widgets.Listener; +import org.eclipse.swt.widgets.Shell; +import org.eclipse.swt.widgets.Table; +import org.eclipse.swt.widgets.TableItem; +import org.eclipse.swt.widgets.Text; +import org.eclipse.swt.widgets.TypedListener; +import org.eclipse.swt.widgets.Widget; + +/** + * The ImageCombo class represents a selectable user interface object + * that combines a text field and a table and issues notification + * when an item is selected from the table. + *

+ * Note that although this class is a subclass of Composite, + * it does not make sense to add children to it, or set a layout on it. + *

+ *
+ *
Styles: + *
BORDER, READ_ONLY, FLAT
+ *
Events: + *
Selection
+ *
+ */ +public final class ImageCombo extends Composite { + + Text text; + Table table; + int visibleItemCount = 5; + Shell popup; + Button arrow; + boolean hasFocus; + Listener listener, filter; + Color foreground, background; + Font font; + +/** + * Constructs a new instance of this class given its parent + * and a style value describing its behavior and appearance. + *

+ * The style value is either one of the style constants defined in + * class SWT which is applicable to instances of this + * class, or must be built by bitwise OR'ing together + * (that is, using the int "|" operator) two or more + * of those SWT style constants. The class description + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. + *

+ * + * @param parent a widget which will be the parent of the new instance (cannot be null) + * @param style the style of widget to construct + * + * @exception IllegalArgumentException
    + *
  • ERROR_NULL_ARGUMENT - if the parent is null
    • + *
+ * @exception SWTException
    + *
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
    • + *
+ * + * @see SWT#BORDER + * @see SWT#READ_ONLY + * @see SWT#FLAT + * @see Widget#getStyle() + */ +public ImageCombo (Composite parent, int style) { + super (parent, style = checkStyle (style)); + + int textStyle = SWT.SINGLE; + if ((style & SWT.READ_ONLY) != 0) textStyle |= SWT.READ_ONLY; + if ((style & SWT.FLAT) != 0) textStyle |= SWT.FLAT; + text = new Text (this, SWT.NONE); + int arrowStyle = SWT.ARROW | SWT.DOWN; + if ((style & SWT.FLAT) != 0) arrowStyle |= SWT.FLAT; + arrow = new Button (this, arrowStyle); + + listener = new Listener () { + public void handleEvent (Event event) { + if (popup == event.widget) { + popupEvent (event); + return; + } + if (text == event.widget) { + textEvent (event); + return; + } + if (table == event.widget) { + listEvent (event); + return; + } + if (arrow == event.widget) { + arrowEvent (event); + return; + } + if (ImageCombo.this == event.widget) { + comboEvent (event); + return; + } + if (getShell () == event.widget) { + handleFocus (SWT.FocusOut); + } + } + }; + filter = new Listener() { + public void handleEvent(Event event) { + Shell shell = ((Control)event.widget).getShell (); + if (shell == ImageCombo.this.getShell ()) { + handleFocus (SWT.FocusOut); + } + } + }; + + int [] comboEvents = {SWT.Dispose, SWT.Move, SWT.Resize}; + for (int i=0; i + *
  • ERROR_NULL_ARGUMENT - if the string is null
    • + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see #add(String,int) + */ +public void add (String string, Image image) { + checkWidget(); + if (string == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + TableItem newItem = new TableItem(this.table,SWT.NONE); + newItem.setText(string); + if (image != null) newItem.setImage(image); +} +/** + * Adds the argument to the receiver's list at the given + * zero-relative index. + *

    + * Note: To add an item at the end of the list, use the + * result of calling getItemCount() as the + * index or use add(String). + *

    + * + * @param string the new item + * @param index the index for the item + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the string is null
      • + *
    • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list (inclusive)
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see #add(String) + */ +public void add (String string,Image image, int index) { + checkWidget(); + if (string == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + TableItem newItem = new TableItem(this.table,SWT.NONE,index); + if (image != null) newItem.setImage(image); +} +/** + * Adds the listener to the collection of listeners who will + * be notified when the receiver's text is modified, by sending + * it one of the messages defined in the ModifyListener + * interface. + * + * @param listener the listener which should be notified + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the listener is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see ModifyListener + * @see #removeModifyListener + */ +public void addModifyListener (ModifyListener listener) { + checkWidget(); + if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + TypedListener typedListener = new TypedListener (listener); + addListener (SWT.Modify, typedListener); +} +/** + * Adds the listener to the collection of listeners who will + * be notified when the receiver's selection changes, by sending + * it one of the messages defined in the SelectionListener + * interface. + *

    + * widgetSelected is called when the combo's list selection changes. + * widgetDefaultSelected is typically called when ENTER is pressed the combo's text area. + *

    + * + * @param listener the listener which should be notified + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the listener is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see SelectionListener + * @see #removeSelectionListener + * @see SelectionEvent + */ +public void addSelectionListener(SelectionListener listener) { + checkWidget(); + if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + TypedListener typedListener = new TypedListener (listener); + addListener (SWT.Selection,typedListener); + addListener (SWT.DefaultSelection,typedListener); +} +void arrowEvent (Event event) { + switch (event.type) { + case SWT.FocusIn: { + handleFocus (SWT.FocusIn); + break; + } + case SWT.Selection: { + dropDown (!isDropped ()); + break; + } + } +} +/** + * Sets the selection in the receiver's text field to an empty + * selection starting just before the first character. If the + * text field is editable, this has the effect of placing the + * i-beam at the start of the text. + *

    + * Note: To clear the selected items in the receiver's list, + * use deselectAll(). + *

    + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see #deselectAll + */ +public void clearSelection () { + checkWidget (); + text.clearSelection (); + table.deselectAll (); +} +void comboEvent (Event event) { + switch (event.type) { + case SWT.Dispose: + if (popup != null && !popup.isDisposed ()) { + table.removeListener (SWT.Dispose, listener); + popup.dispose (); + } + Shell shell = getShell (); + shell.removeListener (SWT.Deactivate, listener); + Display display = getDisplay (); + display.removeFilter (SWT.FocusIn, filter); + popup = null; + text = null; + table = null; + arrow = null; + break; + case SWT.Move: + dropDown (false); + break; + case SWT.Resize: + internalLayout (false); + break; + } +} + +public Point computeSize (int wHint, int hHint, boolean changed) { + checkWidget (); + int width = 0, height = 0; + String[] items = getStringsFromTable(); + int textWidth = 0; + GC gc = new GC (text); + int spacer = gc.stringExtent (" ").x; //$NON-NLS-1$ + for (int i = 0; i < items.length; i++) { + textWidth = Math.max (gc.stringExtent (items[i]).x, textWidth); + } + gc.dispose(); + Point textSize = text.computeSize (SWT.DEFAULT, SWT.DEFAULT, changed); + Point arrowSize = arrow.computeSize (SWT.DEFAULT, SWT.DEFAULT, changed); + Point listSize = table.computeSize (wHint, SWT.DEFAULT, changed); + int borderWidth = getBorderWidth (); + + height = Math.max (hHint, Math.max (textSize.y, arrowSize.y) + 2*borderWidth); + width = Math.max (wHint, Math.max (textWidth + 2*spacer + arrowSize.x + 2*borderWidth, listSize.x)); + return new Point (width, height); +} +void createPopup(int selectionIndex) { + // create shell and list + popup = new Shell (getShell (), SWT.NO_TRIM | SWT.ON_TOP); + int style = getStyle (); + int listStyle = SWT.SINGLE | SWT.V_SCROLL; + if ((style & SWT.FLAT) != 0) listStyle |= SWT.FLAT; + if ((style & SWT.RIGHT_TO_LEFT) != 0) listStyle |= SWT.RIGHT_TO_LEFT; + if ((style & SWT.LEFT_TO_RIGHT) != 0) listStyle |= SWT.LEFT_TO_RIGHT; + // create a table instead of a list. + table = new Table (popup, listStyle); + if (font != null) table.setFont (font); + if (foreground != null) table.setForeground (foreground); + if (background != null) table.setBackground (background); + + int [] popupEvents = {SWT.Close, SWT.Paint, SWT.Deactivate}; + for (int i=0; i + *
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • + *
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • + * + */ +public void deselect (int index) { + checkWidget (); + table.deselect (index); +} +/** + * Deselects all selected items in the receiver's list. + *

    + * Note: To clear the selection in the receiver's text field, + * use clearSelection(). + *

    + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see #clearSelection + */ +public void deselectAll () { + checkWidget (); + table.deselectAll (); +} +void dropDown (boolean drop) { + if (drop == isDropped ()) return; + if (!drop) { + popup.setVisible (false); + if (!isDisposed ()&& arrow.isFocusControl()) { + text.setFocus(); + } + return; + } + + if (getShell() != popup.getParent ()) { + TableItem[] items = table.getItems (); + int selectionIndex = table.getSelectionIndex (); + table.removeListener (SWT.Dispose, listener); + popup.dispose(); + popup = null; + table = null; + createPopup (selectionIndex); + } + + Point size = getSize (); + int itemCount = table.getItemCount (); + itemCount = (itemCount == 0) ? visibleItemCount : Math.min(visibleItemCount, itemCount); + int itemHeight = table.getItemHeight () * itemCount; + Point listSize = table.computeSize (SWT.DEFAULT, itemHeight, false); + table.setBounds (1, 1, Math.max (size.x - 2, listSize.x), listSize.y); + + int index = table.getSelectionIndex (); + if (index != -1) table.setTopIndex (index); + Display display = getDisplay (); + Rectangle listRect = table.getBounds (); + Rectangle parentRect = display.map (getParent (), null, getBounds ()); + Point comboSize = getSize (); + Rectangle displayRect = getMonitor ().getClientArea (); + int width = Math.max (comboSize.x, listRect.width + 2); + int height = listRect.height + 2; + int x = parentRect.x; + int y = parentRect.y + comboSize.y; + if (y + height > displayRect.y + displayRect.height) y = parentRect.y - height; + popup.setBounds (x, y, width, height); + popup.setVisible (true); + table.setFocus (); +} +/* + * Return the Label immediately preceding the receiver in the z-order, + * or null if none. + */ +Label getAssociatedLabel () { + Control[] siblings = getParent ().getChildren (); + for (int i = 0; i < siblings.length; i++) { + if (siblings [i] == ImageCombo.this) { + if (i > 0 && siblings [i-1] instanceof Label) { + return (Label) siblings [i-1]; + } + } + } + return null; +} +public Control [] getChildren () { + checkWidget(); + return new Control [0]; +} +/** + * Gets the editable state. + * + * @return whether or not the reciever is editable + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @since 3.0 + */ +public boolean getEditable () { + checkWidget (); + return text.getEditable(); +} +/** + * Returns the item at the given, zero-relative index in the + * receiver's list. Throws an exception if the index is out + * of range. + * + * @param index the index of the item to return + * @return the item at the given index + * + * @exception IllegalArgumentException
      + *
    • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public TableItem getItem (int index) { + checkWidget(); + return this.table.getItem (index); +} +/** + * Returns the number of items contained in the receiver's list. + * + * @return the number of items + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public int getItemCount () { + checkWidget (); + return table.getItemCount (); +} +/** + * Returns the height of the area which would be used to + * display one of the items in the receiver's list. + * + * @return the height of one item + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public int getItemHeight () { + checkWidget (); + return table.getItemHeight (); +} +/** + * Returns an array of Strings which are the items + * in the receiver's list. + *

    + * Note: This is not the actual structure used by the receiver + * to maintain its list of items, so modifying the array will + * not affect the receiver. + *

    + * + * @return the items in the receiver's list + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public TableItem [] getItems () { + checkWidget (); + return table.getItems (); +} +char getMnemonic (String string) { + int index = 0; + int length = string.length (); + do { + while ((index < length) && (string.charAt (index) != '&')) index++; + if (++index >= length) return '\0'; + if (string.charAt (index) != '&') return string.charAt (index); + index++; + } while (index < length); + return '\0'; +} + +String [] getStringsFromTable() +{ + String[] items = new String[this.table.getItems().length]; + for (int i = 0, n = items.length; i < n; i++) { + items[i]=this.table.getItem(i).getText(); + } + return items; +} +/** + * Returns a Point whose x coordinate is the start + * of the selection in the receiver's text field, and whose y + * coordinate is the end of the selection. The returned values + * are zero-relative. An "empty" selection as indicated by + * the the x and y coordinates having the same value. + * + * @return a point representing the selection start and end + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public Point getSelection () { + checkWidget (); + return text.getSelection (); +} +/** + * Returns the zero-relative index of the item which is currently + * selected in the receiver's list, or -1 if no item is selected. + * + * @return the index of the selected item + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public int getSelectionIndex () { + checkWidget (); + return table.getSelectionIndex (); +} +public int getStyle () { + int style = super.getStyle (); + style &= ~SWT.READ_ONLY; + if (!text.getEditable()) style |= SWT.READ_ONLY; + return style; +} +/** + * Returns a string containing a copy of the contents of the + * receiver's text field. + * + * @return the receiver's text + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public String getText () { + checkWidget (); + return text.getText (); +} +/** + * Returns the height of the receivers's text field. + * + * @return the text height + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public int getTextHeight () { + checkWidget (); + return text.getLineHeight (); +} +/** + * Returns the maximum number of characters that the receiver's + * text field is capable of holding. If this has not been changed + * by setTextLimit(), it will be the constant + * Combo.LIMIT. + * + * @return the text limit + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public int getTextLimit () { + checkWidget (); + return text.getTextLimit (); +} +/** + * Gets the number of items that are visible in the drop + * down portion of the receiver's list. + * + * @return the number of items that are visible + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @since 3.0 + */ +public int getVisibleItemCount () { + checkWidget (); + return visibleItemCount; +} +void handleFocus (int type) { + if (isDisposed ()) return; + switch (type) { + case SWT.FocusIn: { + if (hasFocus) return; + if (getEditable ()) text.selectAll (); + hasFocus = true; + Shell shell = getShell (); + shell.removeListener (SWT.Deactivate, listener); + shell.addListener (SWT.Deactivate, listener); + Display display = getDisplay (); + display.removeFilter (SWT.FocusIn, filter); + display.addFilter (SWT.FocusIn, filter); + Event e = new Event (); + notifyListeners (SWT.FocusIn, e); + break; + } + case SWT.FocusOut: { + if (!hasFocus) return; + Control focusControl = getDisplay ().getFocusControl (); + if (focusControl == arrow || focusControl == table || focusControl == text) return; + hasFocus = false; + Shell shell = getShell (); + shell.removeListener(SWT.Deactivate, listener); + Display display = getDisplay (); + display.removeFilter (SWT.FocusIn, filter); + Event e = new Event (); + notifyListeners (SWT.FocusOut, e); + break; + } + } +} +/** + * Searches the receiver's list starting at the first item + * (index 0) until an item is found that is equal to the + * argument, and returns the index of that item. If no item + * is found, returns -1. + * + * @param string the search item + * @return the index of the item + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the string is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public int indexOf (String string) { + checkWidget (); + if (string == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + return Arrays.asList(getStringsFromTable()).indexOf (string); +} + + +void initAccessible() { + AccessibleAdapter accessibleAdapter = new AccessibleAdapter () { + public void getName (AccessibleEvent e) { + String name = null; + Label label = getAssociatedLabel (); + if (label != null) { + name = stripMnemonic (label.getText()); + } + e.result = name; + } + public void getKeyboardShortcut(AccessibleEvent e) { + String shortcut = null; + Label label = getAssociatedLabel (); + if (label != null) { + String text = label.getText (); + if (text != null) { + char mnemonic = getMnemonic (text); + if (mnemonic != '\0') { + shortcut = "Alt+"+mnemonic; //$NON-NLS-1$ + } + } + } + e.result = shortcut; + } + public void getHelp (AccessibleEvent e) { + e.result = getToolTipText (); + } + }; + getAccessible ().addAccessibleListener (accessibleAdapter); + text.getAccessible ().addAccessibleListener (accessibleAdapter); + table.getAccessible ().addAccessibleListener (accessibleAdapter); + + arrow.getAccessible ().addAccessibleListener (new AccessibleAdapter() { + public void getName (AccessibleEvent e) { + e.result = isDropped () ? SWT.getMessage ("SWT_Close") : SWT.getMessage ("SWT_Open"); //$NON-NLS-1$ //$NON-NLS-2$ + } + public void getKeyboardShortcut (AccessibleEvent e) { + e.result = "Alt+Down Arrow"; //$NON-NLS-1$ + } + public void getHelp (AccessibleEvent e) { + e.result = getToolTipText (); + } + }); + + getAccessible().addAccessibleTextListener (new AccessibleTextAdapter() { + public void getCaretOffset (AccessibleTextEvent e) { + e.offset = text.getCaretPosition (); + } + }); + + getAccessible().addAccessibleControlListener (new AccessibleControlAdapter() { + public void getChildAtPoint (AccessibleControlEvent e) { + Point testPoint = toControl (e.x, e.y); + if (getBounds ().contains (testPoint)) { + e.childID = ACC.CHILDID_SELF; + } + } + + public void getLocation (AccessibleControlEvent e) { + Rectangle location = getBounds (); + Point pt = toDisplay (location.x, location.y); + e.x = pt.x; + e.y = pt.y; + e.width = location.width; + e.height = location.height; + } + + public void getChildCount (AccessibleControlEvent e) { + e.detail = 0; + } + + public void getRole (AccessibleControlEvent e) { + e.detail = ACC.ROLE_COMBOBOX; + } + + public void getState (AccessibleControlEvent e) { + e.detail = ACC.STATE_NORMAL; + } + + public void getValue (AccessibleControlEvent e) { + e.result = getText (); + } + }); + + text.getAccessible ().addAccessibleControlListener (new AccessibleControlAdapter () { + public void getRole (AccessibleControlEvent e) { + e.detail = text.getEditable () ? ACC.ROLE_TEXT : ACC.ROLE_LABEL; + } + }); + + arrow.getAccessible ().addAccessibleControlListener (new AccessibleControlAdapter() { + public void getDefaultAction (AccessibleControlEvent e) { + e.result = isDropped () ? SWT.getMessage ("SWT_Close") : SWT.getMessage ("SWT_Open"); //$NON-NLS-1$ //$NON-NLS-2$ + } + }); +} +boolean isDropped () { + return popup.getVisible (); +} +public boolean isFocusControl () { + checkWidget(); + if (text.isFocusControl () || arrow.isFocusControl () || table.isFocusControl () || popup.isFocusControl ()) { + return true; + } + return super.isFocusControl (); +} +void internalLayout (boolean changed) { + if (isDropped ()) dropDown (false); + Rectangle rect = getClientArea (); + int width = rect.width; + int height = rect.height; + Point arrowSize = arrow.computeSize (SWT.DEFAULT, height, changed); + text.setBounds (0, 0, width - arrowSize.x, height); + arrow.setBounds (width - arrowSize.x, 0, arrowSize.x, arrowSize.y); +} +void listEvent (Event event) { + switch (event.type) { + case SWT.Dispose: + if (getShell () != popup.getParent ()) { + TableItem[] items = table.getItems (); + int selectionIndex = table.getSelectionIndex (); + popup = null; + table = null; + createPopup (selectionIndex); + } + break; + case SWT.FocusIn: { + handleFocus (SWT.FocusIn); + break; + } + case SWT.MouseUp: { + if (event.button != 1) return; + dropDown (false); + break; + } + case SWT.Selection: { + int index = table.getSelectionIndex (); + if (index == -1) return; + text.setText (table.getItem (index).getText()); + text.selectAll (); + table.setSelection (index); + Event e = new Event (); + e.time = event.time; + e.stateMask = event.stateMask; + e.doit = event.doit; + notifyListeners (SWT.Selection, e); + event.doit = e.doit; + break; + } + case SWT.Traverse: { + switch (event.detail) { + case SWT.TRAVERSE_RETURN: + case SWT.TRAVERSE_ESCAPE: + case SWT.TRAVERSE_ARROW_PREVIOUS: + case SWT.TRAVERSE_ARROW_NEXT: + event.doit = false; + break; + } + Event e = new Event (); + e.time = event.time; + e.detail = event.detail; + e.doit = event.doit; + e.character = event.character; + e.keyCode = event.keyCode; + notifyListeners (SWT.Traverse, e); + event.doit = e.doit; + event.detail = e.detail; + break; + } + case SWT.KeyUp: { + Event e = new Event (); + e.time = event.time; + e.character = event.character; + e.keyCode = event.keyCode; + e.stateMask = event.stateMask; + notifyListeners (SWT.KeyUp, e); + break; + } + case SWT.KeyDown: { + if (event.character == SWT.ESC) { + // Escape key cancels popup list + dropDown (false); + } + if ((event.stateMask & SWT.ALT) != 0 && (event.keyCode == SWT.ARROW_UP || event.keyCode == SWT.ARROW_DOWN)) { + dropDown (false); + } + if (event.character == SWT.CR) { + // Enter causes default selection + dropDown (false); + Event e = new Event (); + e.time = event.time; + e.stateMask = event.stateMask; + notifyListeners (SWT.DefaultSelection, e); + } + // At this point the widget may have been disposed. + // If so, do not continue. + if (isDisposed ()) break; + Event e = new Event(); + e.time = event.time; + e.character = event.character; + e.keyCode = event.keyCode; + e.stateMask = event.stateMask; + notifyListeners(SWT.KeyDown, e); + break; + + } + } +} + +void popupEvent(Event event) { + switch (event.type) { + case SWT.Paint: + // draw black rectangle around list + Rectangle listRect = table.getBounds(); + Color black = getDisplay().getSystemColor(SWT.COLOR_BLACK); + event.gc.setForeground(black); + event.gc.drawRectangle(0, 0, listRect.width + 1, listRect.height + 1); + break; + case SWT.Close: + event.doit = false; + dropDown (false); + break; + case SWT.Deactivate: + dropDown (false); + break; + } +} +public void redraw () { + super.redraw(); + text.redraw(); + arrow.redraw(); + if (popup.isVisible()) table.redraw(); +} +public void redraw (int x, int y, int width, int height, boolean all) { + super.redraw(x, y, width, height, true); +} + +/** + * Removes the item from the receiver's list at the given + * zero-relative index. + * + * @param index the index for the item + * + * @exception IllegalArgumentException
      + *
    • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void remove (int index) { + checkWidget(); + table.remove (index); +} +/** + * Removes the items from the receiver's list which are + * between the given zero-relative start and end + * indices (inclusive). + * + * @param start the start of the range + * @param end the end of the range + * + * @exception IllegalArgumentException
      + *
    • ERROR_INVALID_RANGE - if either the start or end are not between 0 and the number of elements in the list minus 1 (inclusive)
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void remove (int start, int end) { + checkWidget(); + table.remove (start, end); +} +/** + * Searches the receiver's list starting at the first item + * until an item is found that is equal to the argument, + * and removes that item from the list. + * + * @param string the item to remove + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the string is null
      • + *
    • ERROR_INVALID_ARGUMENT - if the string is not found in the list
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void remove (String string) { + checkWidget(); + if (string == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + int index = -1; + for (int i = 0, n = table.getItemCount(); i < n; i++) { + if (table.getItem(i).getText().equals(string)) { + index = i; + break; + } + } + remove(index); +} +/** + * Removes all of the items from the receiver's list and clear the + * contents of receiver's text field. + *

    + * @exception SWTException

      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void removeAll () { + checkWidget(); + text.setText (""); //$NON-NLS-1$ + table.removeAll (); +} +/** + * Removes the listener from the collection of listeners who will + * be notified when the receiver's text is modified. + * + * @param listener the listener which should no longer be notified + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the listener is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see ModifyListener + * @see #addModifyListener + */ +public void removeModifyListener (ModifyListener listener) { + checkWidget(); + if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + removeListener(SWT.Modify, listener); +} +/** + * Removes the listener from the collection of listeners who will + * be notified when the receiver's selection changes. + * + * @param listener the listener which should no longer be notified + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the listener is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @see SelectionListener + * @see #addSelectionListener + */ +public void removeSelectionListener (SelectionListener listener) { + checkWidget(); + if (listener == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + removeListener(SWT.Selection, listener); + removeListener(SWT.DefaultSelection,listener); +} +/** + * Selects the item at the given zero-relative index in the receiver's + * list. If the item at the index was already selected, it remains + * selected. Indices that are out of range are ignored. + * + * @param index the index of the item to select + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void select (int index) { + checkWidget(); + if (index == -1) { + table.deselectAll (); + text.setText (""); //$NON-NLS-1$ + return; + } + if (0 <= index && index < table.getItemCount()) { + if (index != getSelectionIndex()) { + text.setText (table.getItem (index).getText()); + text.selectAll (); + table.select (index); + table.showSelection (); + } + } +} +public void setBackground (Color color) { + super.setBackground(color); + background = color; + if (text != null) text.setBackground(color); + if (table != null) table.setBackground(color); + if (arrow != null) arrow.setBackground(color); +} +/** + * Sets the editable state. + * + * @param editable the new editable state + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @since 3.0 + */ +public void setEditable (boolean editable) { + checkWidget (); + text.setEditable(editable); +} +public void setEnabled (boolean enabled) { + super.setEnabled(enabled); + if (popup != null) popup.setVisible (false); + if (text != null) text.setEnabled(enabled); + if (arrow != null) arrow.setEnabled(enabled); +} +public boolean setFocus () { + checkWidget(); + return text.setFocus (); +} +public void setFont (Font font) { + super.setFont (font); + this.font = font; + text.setFont (font); + table.setFont (font); + internalLayout (true); +} +public void setForeground (Color color) { + super.setForeground(color); + foreground = color; + if (text != null) text.setForeground(color); + if (table != null) table.setForeground(color); + if (arrow != null) arrow.setForeground(color); +} +/** + * Sets the text of the item in the receiver's list at the given + * zero-relative index to the string argument. This is equivalent + * to remove'ing the old item at the index, and then + * add'ing the new item at that index. + * + * @param index the index for the item + * @param string the new text for the item + * + * @exception IllegalArgumentException
      + *
    • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
      • + *
    • ERROR_NULL_ARGUMENT - if the string is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void setItem (int index, String string, Image image) { + checkWidget(); + remove(index); + add(string,image,index); +} +/** + * Sets the receiver's list to be the given array of items. + * + * @param items the array of items + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the items array is null
      • + *
    • ERROR_INVALID_ARGUMENT - if an item in the items array is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void setItems (String [] items) { + checkWidget (); + this.table.removeAll(); + for (int i = 0, n = items.length; i < n; i++) { + add(items[i],null); + } + if (!text.getEditable ()) text.setText (""); //$NON-NLS-1$ +} + +/** + * Sets the layout which is associated with the receiver to be + * the argument which may be null. + *

    + * Note : No Layout can be set on this Control because it already + * manages the size and position of its children. + *

    + * + * @param layout the receiver's new layout or null + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void setLayout (Layout layout) { + checkWidget (); + return; +} +/** + * Sets the selection in the receiver's text field to the + * range specified by the argument whose x coordinate is the + * start of the selection and whose y coordinate is the end + * of the selection. + * + * @param selection a point representing the new selection start and end + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the point is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void setSelection (Point selection) { + checkWidget(); + if (selection == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + text.setSelection (selection.x, selection.y); +} + +/** + * Sets the contents of the receiver's text field to the + * given string. + *

    + * Note: The text field in a Combo is typically + * only capable of displaying a single line of text. Thus, + * setting the text to a string containing line breaks or + * other special characters will probably cause it to + * display incorrectly. + *

    + * + * @param string the new text + * + * @exception IllegalArgumentException
      + *
    • ERROR_NULL_ARGUMENT - if the string is null
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void setText (String string) { + checkWidget(); + if (string == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); + int index = -1; + for (int i = 0, n = table.getItemCount(); i < n; i++) { + if (table.getItem(i).getText().equals(string)) { + index = i; + break; + } + } + if (index == -1) { + table.deselectAll (); + text.setText (string); + return; + } + text.setText (string); + text.selectAll (); + table.setSelection (index); + table.showSelection (); +} +/** + * Sets the maximum number of characters that the receiver's + * text field is capable of holding to be the argument. + * + * @param limit new text limit + * + * @exception IllegalArgumentException
      + *
    • ERROR_CANNOT_BE_ZERO - if the limit is zero
      • + *
    + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + */ +public void setTextLimit (int limit) { + checkWidget(); + text.setTextLimit (limit); +} + +public void setToolTipText (String string) { + checkWidget(); + super.setToolTipText(string); + arrow.setToolTipText (string); + text.setToolTipText (string); +} + +public void setVisible (boolean visible) { + super.setVisible(visible); + if (!visible) popup.setVisible(false); +} +/** + * Sets the number of items that are visible in the drop + * down portion of the receiver's list. + * + * @param count the new number of items to be visible + * + * @exception SWTException
      + *
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
      • + *
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • + *
    + * + * @since 3.0 + */ +public void setVisibleItemCount (int count) { + checkWidget (); + if (count < 0) return; + visibleItemCount = count; +} +String stripMnemonic (String string) { + int index = 0; + int length = string.length (); + do { + while ((index < length) && (string.charAt (index) != '&')) index++; + if (++index >= length) return string; + if (string.charAt (index) != '&') { + return string.substring(0, index-1) + string.substring(index, length); + } + index++; + } while (index < length); + return string; +} +void textEvent (Event event) { + switch (event.type) { + case SWT.FocusIn: { + handleFocus (SWT.FocusIn); + break; + } + case SWT.KeyDown: { + if (event.character == SWT.CR) { + dropDown (false); + Event e = new Event (); + e.time = event.time; + e.stateMask = event.stateMask; + notifyListeners (SWT.DefaultSelection, e); + } + //At this point the widget may have been disposed. + // If so, do not continue. + if (isDisposed ()) break; + + if (event.keyCode == SWT.ARROW_UP || event.keyCode == SWT.ARROW_DOWN) { + event.doit = false; + if ((event.stateMask & SWT.ALT) != 0) { + boolean dropped = isDropped (); + text.selectAll (); + if (!dropped) setFocus (); + dropDown (!dropped); + break; + } + + int oldIndex = getSelectionIndex (); + if (event.keyCode == SWT.ARROW_UP) { + select (Math.max (oldIndex - 1, 0)); + } else { + select (Math.min (oldIndex + 1, getItemCount () - 1)); + } + if (oldIndex != getSelectionIndex ()) { + Event e = new Event(); + e.time = event.time; + e.stateMask = event.stateMask; + notifyListeners (SWT.Selection, e); + } + //At this point the widget may have been disposed. + // If so, do not continue. + if (isDisposed ()) break; + } + + // Further work : Need to add support for incremental search in + // pop up list as characters typed in text widget + + Event e = new Event (); + e.time = event.time; + e.character = event.character; + e.keyCode = event.keyCode; + e.stateMask = event.stateMask; + notifyListeners (SWT.KeyDown, e); + break; + } + case SWT.KeyUp: { + Event e = new Event (); + e.time = event.time; + e.character = event.character; + e.keyCode = event.keyCode; + e.stateMask = event.stateMask; + notifyListeners (SWT.KeyUp, e); + break; + } + case SWT.Modify: { + table.deselectAll (); + Event e = new Event (); + e.time = event.time; + notifyListeners (SWT.Modify, e); + break; + } + case SWT.MouseDown: { + if (event.button != 1) return; + if (text.getEditable ()) return; + boolean dropped = isDropped (); + text.selectAll (); + if (!dropped) setFocus (); + dropDown (!dropped); + break; + } + case SWT.MouseUp: { + if (event.button != 1) return; + if (text.getEditable ()) return; + text.selectAll (); + break; + } + case SWT.Traverse: { + switch (event.detail) { + case SWT.TRAVERSE_RETURN: + case SWT.TRAVERSE_ARROW_PREVIOUS: + case SWT.TRAVERSE_ARROW_NEXT: + // The enter causes default selection and + // the arrow keys are used to manipulate the list contents so + // do not use them for traversal. + event.doit = false; + break; + } + + Event e = new Event (); + e.time = event.time; + e.detail = event.detail; + e.doit = event.doit; + e.character = event.character; + e.keyCode = event.keyCode; + notifyListeners (SWT.Traverse, e); + event.doit = e.doit; + event.detail = e.detail; + break; + } + } +} +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/AbstractLanguageSettingProviderOptionPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/AbstractLanguageSettingProviderOptionPage.java new file mode 100644 index 00000000000..7ac9d439827 --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/AbstractLanguageSettingProviderOptionPage.java @@ -0,0 +1,13 @@ +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import org.eclipse.cdt.ui.dialogs.AbstractCOptionPage; + +public abstract class AbstractLanguageSettingProviderOptionPage extends AbstractCOptionPage { + protected LanguageSettingsProviderTab providerTab; + protected String providerId; + + protected void init(LanguageSettingsProviderTab providerTab, String providerId) { + this.providerTab = providerTab; + this.providerId = providerId; + } +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingEntryDialog.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingEntryDialog.java new file mode 100644 index 00000000000..999328e7cfe --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingEntryDialog.java @@ -0,0 +1,653 @@ +/******************************************************************************* + * Copyright (c) 2010, 2010 Andrew Gvozdev 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import org.eclipse.core.resources.IProject; +import org.eclipse.jface.dialogs.IDialogConstants; +import org.eclipse.swt.SWT; +import org.eclipse.swt.events.ModifyEvent; +import org.eclipse.swt.events.ModifyListener; +import org.eclipse.swt.events.SelectionAdapter; +import org.eclipse.swt.events.SelectionEvent; +import org.eclipse.swt.events.SelectionListener; +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Button; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Label; +import org.eclipse.swt.widgets.Shell; +import org.eclipse.swt.widgets.Text; + +import org.eclipse.cdt.core.settings.model.CIncludeFileEntry; +import org.eclipse.cdt.core.settings.model.CIncludePathEntry; +import org.eclipse.cdt.core.settings.model.CLibraryFileEntry; +import org.eclipse.cdt.core.settings.model.CLibraryPathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.CMacroFileEntry; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.cdt.ui.newui.AbstractCPropertyTab; +import org.eclipse.cdt.ui.newui.AbstractPropertyDialog; + +import org.eclipse.cdt.internal.ui.ImageCombo; +import org.eclipse.cdt.internal.ui.newui.LanguageSettingsImages; +import org.eclipse.cdt.internal.ui.newui.Messages; + +/** + * @noextend This class is not intended to be subclassed by clients. + */ +public class LanguageSettingEntryDialog extends AbstractPropertyDialog { + private static final String SLASH = "/"; //$NON-NLS-1$ + + private ICConfigurationDescription cfgDescription; + private IProject project; + private ICLanguageSettingEntry entry; + private boolean clearValue; + private int kind; + + private Label iconComboKind; + private ImageCombo comboKind; + private ImageCombo comboPathCategory; + private Label labelInput; + public Text inputName; + private Label checkBoxValue; + public Text inputValue; + private Button buttonBrowse; + private Button buttonVars; + private Button checkBoxBuiltIn; + private Button checkBoxFramework; + + private Button checkBoxAllCfgs; + private Button checkBoxAllLangs; + + private Button buttonOk; + private Button buttonCancel; + + + private static final int COMBO_INDEX_INCLUDE_PATH = 0; + private static final int COMBO_INDEX_MACRO = 1; + private static final int COMBO_INDEX_INCLUDE_FILE = 2; + private static final int COMBO_INDEX_MACRO_FILE = 3; + private static final int COMBO_INDEX_LIBRARY_PATH = 4; + private static final int COMBO_INDEX_LIBRARY_FILE = 5; + + final private String [] comboKindItems = { + "Include Directory", + "Preprocessor Macro", + "Include File", + "Preprocessor Macros File", + "Library Path", + "Library", + }; + final private Image[] comboKindImages = { + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_MACRO), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_TUNIT_HEADER), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_MACROS_FILE), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_LIBRARY_FOLDER), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_LIBRARY), + }; + + private static final int COMBO_PATH_INDEX_PROJECT = 0; + private static final int COMBO_PATH_INDEX_WORKSPACE = 1; + private static final int COMBO_PATH_INDEX_FILESYSTEM = 2; + + final private String [] pathCategories = { + "Project-Relative", + "Workspace Path", + "Filesystem", + }; + final private Image[] pathCategoryImages = { + CDTSharedImages.getImage(CDTSharedImages.IMG_ETOOL_PROJECT), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_WORKSPACE), + CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_FILESYSTEM), + }; + + + + private ICLanguageSettingEntry[] entries; + private Composite comp1; + + public LanguageSettingEntryDialog(Shell parent, ICConfigurationDescription cfgDescription, int kind) { + super(parent, ""); + this.cfgDescription = cfgDescription; + this.project = cfgDescription.getProjectDescription().getProject(); + this.entry = null; + this.clearValue = true; + this.kind = kind; + } + + /** + * This constructor is intended to be used with {@code clearValue=true} for "Add" dialogs + * where provided entry is used as a template. + */ + public LanguageSettingEntryDialog(Shell parent, ICConfigurationDescription cfgDescription, ICLanguageSettingEntry entry, boolean clearValue) { + super(parent, ""); + this.cfgDescription = cfgDescription; + this.project = cfgDescription.getProjectDescription().getProject(); + this.entry = entry; + this.kind = entry!=null ? entry.getKind() : ICSettingEntry.INCLUDE_PATH; + this.clearValue = clearValue; + } + + /** + * This constructor is used for "Edit" dialogs to edit provided entry + */ + public LanguageSettingEntryDialog(Shell parent, ICConfigurationDescription cfgDescription, ICLanguageSettingEntry entry) { + this(parent, cfgDescription, entry, false); + } + + private int comboIndexToKind(int index) { + int kind=0; + switch (index) { + case COMBO_INDEX_INCLUDE_PATH: + kind = ICSettingEntry.INCLUDE_PATH; + break; + case COMBO_INDEX_MACRO: + kind = ICSettingEntry.MACRO; + break; + case COMBO_INDEX_INCLUDE_FILE: + kind = ICSettingEntry.INCLUDE_FILE; + break; + case COMBO_INDEX_MACRO_FILE: + kind = ICSettingEntry.MACRO_FILE; + break; + case COMBO_INDEX_LIBRARY_PATH: + kind = ICSettingEntry.LIBRARY_PATH; + break; + case COMBO_INDEX_LIBRARY_FILE: + kind = ICSettingEntry.LIBRARY_FILE; + break; + } + return kind; + } + + private int kindToComboIndex(int kind) { + int index=0; + switch (kind) { + case ICSettingEntry.INCLUDE_PATH: + index = COMBO_INDEX_INCLUDE_PATH; + break; + case ICSettingEntry.MACRO: + index = COMBO_INDEX_MACRO; + break; + case ICSettingEntry.INCLUDE_FILE: + index = COMBO_INDEX_INCLUDE_FILE; + break; + case ICSettingEntry.MACRO_FILE: + index = COMBO_INDEX_MACRO_FILE; + break; + case ICSettingEntry.LIBRARY_PATH: + index = COMBO_INDEX_LIBRARY_PATH; + break; + case ICSettingEntry.LIBRARY_FILE: + index = COMBO_INDEX_LIBRARY_FILE; + break; + } + return index; + } + + @Override + protected Control createDialogArea(Composite parent) { + parent.setLayout(new GridLayout(4, false)); + GridData gd; + + // Composite comp1 + comp1 = new Composite (parent, SWT.NONE); + gd = new GridData(GridData.FILL_HORIZONTAL); + gd.verticalAlignment = SWT.TOP; + gd.horizontalSpan = 7; + comp1.setLayoutData(gd); + comp1.setLayout(new GridLayout(7, false)); + + // Icon for kind + iconComboKind = new Label (comp1, SWT.NONE); + gd = new GridData(); + gd.verticalAlignment = SWT.TOP; + gd.horizontalAlignment = SWT.RIGHT; + iconComboKind.setLayoutData(gd); + iconComboKind.setText("Select Kind:"); + int kindToComboIndex = kindToComboIndex(kind); + iconComboKind.setImage(comboKindImages[kindToComboIndex]); + + // Combo for the setting entry kind + comboKind = new ImageCombo(comp1, SWT.DROP_DOWN | SWT.READ_ONLY | SWT.BORDER); + for (int i = 0; i < comboKindItems.length; i++) { + comboKind.add(comboKindItems[i], comboKindImages[i]); + } + comboKind.setText(comboKindItems[kindToComboIndex]); + + comboKind.addSelectionListener(new SelectionListener() { + @Override + public void widgetSelected(SelectionEvent e) { + updateImages(); + setButtons(); + } + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + + } + }); + comboKind.setEnabled(clearValue); + + + // + // Icon for path category + final Label comboPathCategoryIcon = new Label (comp1, SWT.NONE); + gd = new GridData(GridData.GRAB_HORIZONTAL | GridData.HORIZONTAL_ALIGN_END); + gd.verticalAlignment = SWT.TOP; + gd.widthHint = 15; + comboPathCategoryIcon.setLayoutData(gd); + comboPathCategoryIcon.setText(""); + + // Combo for path category + comboPathCategory = new ImageCombo(comp1, SWT.DROP_DOWN | SWT.READ_ONLY | SWT.BORDER); + for (int i = 0; i < pathCategories.length; i++) { + comboPathCategory.add(pathCategories[i], pathCategoryImages[i]); + } + int pcindex = COMBO_PATH_INDEX_PROJECT; + if (entry!=null) { + if ( (entry.getFlags() & ICSettingEntry.VALUE_WORKSPACE_PATH) == 0) { + pcindex = COMBO_PATH_INDEX_FILESYSTEM; + } else { + if (entry.getName().startsWith(SLASH)) { + pcindex = COMBO_PATH_INDEX_WORKSPACE; + } else { + pcindex = COMBO_PATH_INDEX_PROJECT; + } + } + + } + comboPathCategory.setText(pathCategories[pcindex]); + gd = new GridData(SWT.FILL, SWT.NONE, false, false); + gd.verticalAlignment = SWT.TOP; + gd.horizontalSpan = 4; + comboPathCategory.setLayoutData(gd); + + comboPathCategory.addSelectionListener(new SelectionListener() { + @Override + public void widgetSelected(SelectionEvent e) { + updateImages(); + setButtons(); + } + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + + } + }); + + // Dir/File/Name label + labelInput = new Label(comp1, SWT.NONE); + labelInput.setText("Dir:"); + gd = new GridData(); + labelInput.setLayoutData(gd); + + // Dir/File/Name input + inputName = new Text(comp1, SWT.SINGLE | SWT.BORDER); + if (entry!=null && !clearValue) { + inputName.setText(entry.getName()); + } + gd = new GridData(GridData.FILL_HORIZONTAL | GridData.GRAB_HORIZONTAL); + gd.horizontalSpan = 2; + gd.widthHint = 200; + inputName.setLayoutData(gd); + inputName.addModifyListener(new ModifyListener() { + @Override + public void modifyText(ModifyEvent e) { + setButtons(); + }}); + + inputName.setFocus(); + inputName.setSelection(0, inputName.getText().length()); + + // Value label + checkBoxValue = new Label(comp1, SWT.NONE); + checkBoxValue.setText("Value:"); + gd = new GridData(); + checkBoxValue.setLayoutData(gd); + + // Path button + buttonBrowse = new Button(comp1, SWT.PUSH); + buttonBrowse.setText("..."); + buttonBrowse.setImage(pathCategoryImages[0]); + buttonBrowse.setLayoutData(new GridData()); + buttonBrowse.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent event) { + buttonPressed(event); + } + }); + + // Variables button + buttonVars = new Button(comp1, SWT.PUSH); + buttonVars.setText(AbstractCPropertyTab.VARIABLESBUTTON_NAME); + buttonVars.setLayoutData(new GridData()); + buttonVars.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent event) { + buttonPressed(event); + } + }); + + // Value input. Located after the other controls to get sufficient width + int comboPathWidth = comboPathCategory.computeSize(SWT.DEFAULT, SWT.NONE).x; + inputValue = new Text(comp1, SWT.SINGLE | SWT.BORDER); + if (entry!=null && !clearValue) { + inputValue.setText(entry.getValue()); + } + gd = new GridData(SWT.FILL, SWT.NONE, false, false); + gd.widthHint = comboPathWidth; + inputValue.setLayoutData(gd); + + if (entry!=null && kind==ICSettingEntry.MACRO && !clearValue) { + inputValue.setFocus(); + inputValue.setSelection(0, inputValue.getText().length()); + } + + // Checkboxes + Composite compCheckboxes = new Composite (parent, SWT.NONE); + gd = new GridData(GridData.FILL_HORIZONTAL); + gd.verticalAlignment = SWT.TOP; + gd.horizontalSpan = 4; + compCheckboxes.setLayoutData(gd); + compCheckboxes.setLayout(new GridLayout(1, false)); + + // Checkbox "Built-In" + checkBoxBuiltIn = new Button(compCheckboxes, SWT.CHECK); + checkBoxBuiltIn.setText("Treat as Built-In (Ignore during build)"); + checkBoxBuiltIn.setSelection(entry!=null && (entry.getFlags()&ICSettingEntry.BUILTIN)!=0); + gd = new GridData(GridData.FILL_HORIZONTAL); + checkBoxBuiltIn.setLayoutData(gd); + checkBoxBuiltIn.addSelectionListener(new SelectionListener() { + + @Override + public void widgetSelected(SelectionEvent e) { + updateImages(); + setButtons(); + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + }); + + // Checkbox "Framework" + checkBoxFramework = new Button(compCheckboxes, SWT.CHECK); + checkBoxFramework.setText("Framework folder (Mac only)"); + checkBoxFramework.setSelection(entry!=null && (entry.getFlags()&ICSettingEntry.FRAMEWORKS_MAC)!=0); + gd = new GridData(GridData.FILL_HORIZONTAL); + checkBoxFramework.setLayoutData(gd); + checkBoxFramework.addSelectionListener(new SelectionListener() { + + @Override + public void widgetSelected(SelectionEvent e) { + updateImages(); + setButtons(); + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + }); + + // Separator + @SuppressWarnings("unused") + Label separator = new Label(compCheckboxes, SWT.SEPARATOR | SWT.HORIZONTAL | SWT.SHADOW_NONE); + + // Checkbox "All configurations" + checkBoxAllCfgs = new Button(compCheckboxes, SWT.CHECK); + checkBoxAllCfgs.setText(Messages.IncludeDialog_2); + gd = new GridData(GridData.FILL_HORIZONTAL); + checkBoxAllCfgs.setLayoutData(gd); + checkBoxAllCfgs.setEnabled(false); + checkBoxAllCfgs.setToolTipText("Not implemented yet"); + + // Checkbox "All languages" + checkBoxAllLangs = new Button(compCheckboxes, SWT.CHECK); + checkBoxAllLangs.setText(Messages.IncludeDialog_3); + gd = new GridData(GridData.FILL_HORIZONTAL); + checkBoxAllLangs.setLayoutData(gd); + checkBoxAllLangs.setEnabled(false); + checkBoxAllLangs.setToolTipText("Not implemented yet"); + + // Buttons + Composite compButtons = new Composite (parent, SWT.FILL); + gd = new GridData(SWT.RIGHT, SWT.BOTTOM, false, false); + gd.horizontalSpan = 4; + gd.grabExcessVerticalSpace = true; + compButtons.setLayoutData(gd); + compButtons.setLayout(new GridLayout(4, false)); + + // placeholder + Label placeholder = new Label(compButtons, 0); + placeholder.setLayoutData(new GridData(GridData.GRAB_HORIZONTAL)); + + // Button OK + buttonOk = new Button(compButtons, SWT.PUSH); + buttonOk.setText(IDialogConstants.OK_LABEL); + gd = new GridData(); + gd.widthHint = buttonVars.computeSize(SWT.DEFAULT,SWT.NONE).x; + buttonOk.setLayoutData(gd); + buttonOk.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent event) { + buttonPressed(event); + } + }); + + // Button Cancel + buttonCancel = new Button(compButtons, SWT.PUSH); + buttonCancel.setText(IDialogConstants.CANCEL_LABEL); + gd = new GridData(); + gd.widthHint = buttonVars.computeSize(SWT.DEFAULT, SWT.NONE).x; + buttonCancel.setLayoutData(gd); + buttonCancel.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent event) { + buttonPressed(event); + } + }); + + parent.getShell().setDefaultButton(buttonOk); + parent.pack(); + + updateImages(); + setButtons(); + return parent; + } + + private void setButtons() { + int kindSelectionIndex = comboKind.getSelectionIndex(); + boolean isMacroSelected = kindSelectionIndex==COMBO_INDEX_MACRO; + comboPathCategory.setVisible(!isMacroSelected); + buttonBrowse.setVisible(!isMacroSelected); + buttonVars.setVisible(!isMacroSelected); + checkBoxValue.setVisible(isMacroSelected); + inputValue.setVisible(isMacroSelected); + + ((GridData)checkBoxValue.getLayoutData()).exclude = !isMacroSelected; + ((GridData)inputValue.getLayoutData()).exclude = !isMacroSelected; + + ((GridData)buttonBrowse.getLayoutData()).exclude = isMacroSelected; + ((GridData)buttonVars.getLayoutData()).exclude = isMacroSelected; + + switch (kindSelectionIndex) { + case COMBO_INDEX_INCLUDE_PATH: + case COMBO_INDEX_LIBRARY_PATH: + labelInput.setText("Path:"); + break; + case COMBO_INDEX_INCLUDE_FILE: + case COMBO_INDEX_MACRO_FILE: + case COMBO_INDEX_LIBRARY_FILE: + labelInput.setText("File:"); + break; + case COMBO_INDEX_MACRO: + default: + labelInput.setText("Name:"); + } + + inputValue.setEnabled(isMacroSelected); + + int indexPathKind = comboPathCategory.getSelectionIndex(); + boolean isProjectSelected = indexPathKind==COMBO_PATH_INDEX_PROJECT; + boolean isWorkspaceSelected = indexPathKind==COMBO_PATH_INDEX_WORKSPACE; + boolean isFilesystemSelected = indexPathKind==COMBO_PATH_INDEX_FILESYSTEM; + + String path = inputName.getText(); + if (path.trim().length()==0) { + buttonOk.setEnabled(false); + } else { + buttonOk.setEnabled((isProjectSelected && !path.startsWith(SLASH)) || + (isWorkspaceSelected && path.startsWith(SLASH)) || isFilesystemSelected); + } + + buttonVars.setEnabled(isFilesystemSelected); + + comp1.layout(true); + } + + @Override + public void buttonPressed(SelectionEvent e) { + String s=null; + if (e.widget.equals(buttonOk)) { + String name = inputName.getText(); + text1 = name; + String value = inputValue.getText(); + check1 = checkBoxAllCfgs.getSelection(); + check3 = checkBoxAllLangs.getSelection(); + result = true; + + int flagBuiltIn = checkBoxBuiltIn.getSelection() ? ICSettingEntry.BUILTIN : 0; + int flagFramework = checkBoxFramework.getSelection() ? ICSettingEntry.FRAMEWORKS_MAC : 0; + int indexPathKind = comboPathCategory.getSelectionIndex(); + int kind = comboKind.getSelectionIndex(); + boolean isProjectPath = indexPathKind==COMBO_PATH_INDEX_PROJECT; + boolean isWorkspacePath = (kind!=COMBO_INDEX_MACRO) && (isProjectPath || indexPathKind==COMBO_PATH_INDEX_WORKSPACE); + int flagWorkspace = isWorkspacePath ? ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED : 0; + int flags = flagBuiltIn | flagWorkspace | flagFramework; + + ICLanguageSettingEntry entry=null; + switch (comboKind.getSelectionIndex()) { + case COMBO_INDEX_INCLUDE_PATH: + entry = new CIncludePathEntry(name, flags); + break; + case COMBO_INDEX_MACRO: + // note that value=null is not supported by CMacroEntry + entry = new CMacroEntry(name, value, flags); + break; + case COMBO_INDEX_INCLUDE_FILE: + entry = new CIncludeFileEntry(name, flags); + break; + case COMBO_INDEX_MACRO_FILE: + entry = new CMacroFileEntry(name, flags); + break; + case COMBO_INDEX_LIBRARY_PATH: + entry = new CLibraryPathEntry(name, flags); + break; + case COMBO_INDEX_LIBRARY_FILE: + entry = new CLibraryFileEntry(name, flags); + break; + default: + result = false; + } + + entries = new ICLanguageSettingEntry[] {entry}; + shell.dispose(); + } else if (e.widget.equals(buttonCancel)) { + shell.dispose(); + } else if (e.widget.equals(buttonBrowse)) { + boolean isDirectory = false; + boolean isFile = false; + switch (comboKind.getSelectionIndex()) { + case COMBO_INDEX_INCLUDE_PATH: + case COMBO_INDEX_LIBRARY_PATH: + isDirectory = true; + break; + case COMBO_INDEX_INCLUDE_FILE: + case COMBO_INDEX_MACRO_FILE: + case COMBO_INDEX_LIBRARY_FILE: + isFile = true; + break; + case COMBO_INDEX_MACRO: + break; + } + + if (isDirectory) { + switch (comboPathCategory.getSelectionIndex()) { + case COMBO_PATH_INDEX_WORKSPACE: + s = AbstractCPropertyTab.getWorkspaceDirDialog(shell, inputName.getText()); + break; + case COMBO_PATH_INDEX_PROJECT: + s = AbstractCPropertyTab.getProjectDirDialog(shell, inputName.getText(), project); + break; + case COMBO_PATH_INDEX_FILESYSTEM: + s = AbstractCPropertyTab.getFileSystemDirDialog(shell, inputName.getText()); + break; + } + } else if (isFile) { + switch (comboPathCategory.getSelectionIndex()) { + case COMBO_PATH_INDEX_WORKSPACE: + s = AbstractCPropertyTab.getWorkspaceFileDialog(shell, inputName.getText()); + break; + case COMBO_PATH_INDEX_PROJECT: + s = AbstractCPropertyTab.getProjectFileDialog(shell, inputName.getText(), project); + break; + case COMBO_PATH_INDEX_FILESYSTEM: + s = AbstractCPropertyTab.getFileSystemFileDialog(shell, inputName.getText()); + break; + } + } + + if (s != null) { + s = strip_wsp(s); + if (comboPathCategory.getSelectionIndex()==COMBO_PATH_INDEX_PROJECT && s.startsWith(SLASH+project.getName()+SLASH)) { + s=s.substring(project.getName().length()+2); + } + inputName.setText(s); + } + } else if (e.widget.equals(buttonVars)) { + s = AbstractCPropertyTab.getVariableDialog(shell, cfgDescription); + if (s != null) inputName.insert(s); + } + } + + public ICLanguageSettingEntry[] getEntries() { + return entries; + } + + private void updateImages() { + int indexEntryKind = comboKind.getSelectionIndex(); + int indexPathKind = comboPathCategory.getSelectionIndex(); + shell.setText("Add " + comboKindItems[indexEntryKind]); + + int kind = comboIndexToKind(indexEntryKind); + int flagBuiltin = checkBoxBuiltIn.getSelection() ? ICSettingEntry.BUILTIN : 0; + int flagFramework = checkBoxFramework.getSelection() ? ICSettingEntry.FRAMEWORKS_MAC : 0; + boolean isWorkspacePath = indexPathKind==COMBO_PATH_INDEX_PROJECT || indexPathKind==COMBO_PATH_INDEX_WORKSPACE; + int flagWorkspace = isWorkspacePath ? ICSettingEntry.VALUE_WORKSPACE_PATH | ICSettingEntry.RESOLVED : 0; + int flags = flagBuiltin | flagWorkspace | flagFramework; + Image image = LanguageSettingsImages.getImage(kind, flags, indexPathKind==COMBO_PATH_INDEX_PROJECT); + + iconComboKind.setImage(image); + shell.setImage(image); + + buttonBrowse.setImage(pathCategoryImages[indexPathKind]); + } + +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsEntriesTab.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsEntriesTab.java new file mode 100644 index 00000000000..564cde960ac --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsEntriesTab.java @@ -0,0 +1,1069 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; + +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Status; +import org.eclipse.jface.viewers.IDecoration; +import org.eclipse.jface.viewers.ITreeContentProvider; +import org.eclipse.jface.viewers.TreeViewer; +import org.eclipse.jface.viewers.Viewer; +import org.eclipse.swt.SWT; +import org.eclipse.swt.custom.SashForm; +import org.eclipse.swt.events.PaintEvent; +import org.eclipse.swt.events.PaintListener; +import org.eclipse.swt.events.SelectionAdapter; +import org.eclipse.swt.events.SelectionEvent; +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Button; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Tree; +import org.eclipse.swt.widgets.TreeColumn; +import org.eclipse.swt.widgets.TreeItem; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; +import org.eclipse.cdt.core.model.ILanguage; +import org.eclipse.cdt.core.model.LanguageManager; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICResourceDescription; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.cdt.ui.CUIPlugin; +import org.eclipse.cdt.ui.newui.AbstractCPropertyTab; +import org.eclipse.cdt.ui.newui.CDTPrefUtil; + +import org.eclipse.cdt.internal.ui.newui.LanguageSettingsImages; +import org.eclipse.cdt.internal.ui.newui.Messages; +import org.eclipse.cdt.internal.ui.newui.StatusMessageLine; + + +/** + * This tab presents language settings entries categorized by language + * settings providers. + * + *@noinstantiate This class is not intended to be instantiated by clients. + *@noextend This class is not intended to be subclassed by clients. + */ +public class LanguageSettingsEntriesTab extends AbstractCPropertyTab { + private static final int[] DEFAULT_ENTRIES_SASH_WEIGHTS = new int[] { 10, 30 }; + + private SashForm sashFormEntries; + private Tree treeLanguages; + private Tree treeEntries; + private TreeViewer treeEntriesViewer; + private static String currentLanguageId = null; + + private Button builtInCheckBox; + private Button enableProvidersCheckBox; + private StatusMessageLine fStatusLine; + + private Page_LanguageSettingsProviders masterPropertyPage = null; + + private static final int BUTTON_ADD = 0; + private static final int BUTTON_EDIT = 1; + private static final int BUTTON_DELETE = 2; + // there is a separator instead of button #3 + private static final int BUTTON_MOVE_UP = 4; + private static final int BUTTON_MOVE_DOWN = 5; + + private final static String[] BUTTON_LABELS = { + ADD_STR, + EDIT_STR, + DEL_STR, + null, + MOVEUP_STR, + MOVEDOWN_STR, + }; + private static final String CLEAR_STR = Messages.LanguageSettingsProviderTab_Clear; + + private Map> initialProvidersMap = new HashMap>(); + private boolean initialEnablement =false; + + private class EntriesTreeLabelProvider extends LanguageSettingsProvidersLabelProvider { + @Override + protected String[] getOverlayKeys(ILanguageSettingsProvider provider) { + String[] overlayKeys = super.getOverlayKeys(provider); + +// if (LanguageSettingsManager.isWorkspaceProvider(provider)) +// provider = LanguageSettingsManager.getRawWorkspaceProvider(provider.getId()); +// + if (currentLanguageId != null) { + IResource rc = getResource(); + List entries = getSettingEntries(provider); + if (entries == null && !(rc instanceof IProject)) { + List entriesParent = getSettingEntriesUpResourceTree(provider); + if (entriesParent != null /*&& entriesParent.size() > 0*/) { + overlayKeys[IDecoration.TOP_RIGHT] = CDTSharedImages.IMG_OVR_PARENT; + } + } else if (provider instanceof ILanguageSettingsEditableProvider && (page.isForFile() || page.isForFolder())) { + // Assuming that the default entries for a resource are always null. + // Using that for performance reasons. See note in PerformDefaults(). + List entriesParent = provider.getSettingEntries(null, null, currentLanguageId); + if (entries!=null && !entries.equals(entriesParent)) { + overlayKeys[IDecoration.TOP_RIGHT] = CDTSharedImages.IMG_OVR_SETTING; + } + } + } + + // TODO + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + List initialProviders = initialProvidersMap.get(cfgDescription.getId()); + if (initialProviders!=null && !initialProviders.contains(provider)) { + overlayKeys[IDecoration.TOP_RIGHT] = CDTSharedImages.IMG_OVR_EDITED; + } + return overlayKeys; + } + + @Override + public Image getImage(Object element) { + if (element instanceof ICLanguageSettingEntry) { + ICLanguageSettingEntry entry = (ICLanguageSettingEntry) element; + return LanguageSettingsImages.getImage(entry); + } + + return super.getImage(element); + } + + @Override + public String getText(Object element) { + if (element instanceof ICLanguageSettingEntry) { + ICLanguageSettingEntry entry = (ICLanguageSettingEntry) element; + String s = entry.getName(); + if ((entry.getKind() == ICSettingEntry.MACRO) && (entry.getFlags()&ICSettingEntry.UNDEFINED) == 0) { + s = s + '=' + entry.getValue(); + } + return s; + } + + return super.getText(element); + } + } + + /** + * Content provider for setting entries tree. + */ + private class EntriesTreeContentProvider implements ITreeContentProvider { + @Override + public Object[] getElements(Object inputElement) { + return getChildren(inputElement); + } + + @Override + public Object[] getChildren(Object parentElement) { + if (parentElement instanceof Object[]) + return (Object[]) parentElement; + + if (parentElement instanceof ILanguageSettingsProvider) { + ILanguageSettingsProvider lsProvider = (ILanguageSettingsProvider)parentElement; + List entriesList = getSettingEntriesUpResourceTree(lsProvider); + if (entriesList == null) { + return null; + } + + // convert to modifiable list + entriesList = new ArrayList(entriesList); + + if (builtInCheckBox.getSelection()==false) { + for (Iterator iter = entriesList.iterator(); iter.hasNext();) { + ICLanguageSettingEntry entry = iter.next(); + if (entry.isBuiltIn()) { + iter.remove(); + } + } + } + return entriesList.toArray(); + } + + return null; + } + + @Override + public Object getParent(Object element) { + return null; + } + + @Override + public boolean hasChildren(Object element) { + Object[] children = getChildren(element); + return children!=null && children.length>0; + } + + @Override + public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { + } + + @Override + public void dispose() { + } + + } + + /** + * Shortcut for getting the current resource for the property page. + */ + private IResource getResource() { + return (IResource)page.getElement(); + } + + /** + * Shortcut for getting the current configuration description. + */ + private ICConfigurationDescription getConfigurationDescription() { + return getResDesc().getConfiguration(); + } + + /** + * Shortcut for getting the currently selected provider. + */ + private ILanguageSettingsProvider getSelectedProvider() { + ILanguageSettingsProvider provider = null; + + TreeItem[] items = treeEntries.getSelection(); + if (items.length>0) { + TreeItem item = items[0]; + Object itemData = item.getData(); + if (itemData instanceof ICLanguageSettingEntry) { + item = item.getParentItem(); + if (item!=null) { + itemData = item.getData(); + } + } + if (itemData instanceof ILanguageSettingsProvider) { + provider = (ILanguageSettingsProvider)itemData; + } + } + return provider; + } + + /** + * Shortcut for getting the currently selected setting entry. + */ + private ICLanguageSettingEntry getSelectedEntry() { + ICLanguageSettingEntry entry = null; + + TreeItem[] selItems = treeEntries.getSelection(); + if (selItems.length==0) { + return null; + } + + TreeItem item = selItems[0]; + Object itemData = item.getData(); + if (itemData instanceof ICLanguageSettingEntry) { + entry = (ICLanguageSettingEntry)itemData; + } + return entry; + } + + /** + * Shortcut for getting setting entries for current context. {@link LanguageSettingsManager} + * will be checking parent resources if no settings defined for current resource. + * + * @return list of setting entries for the current context. + */ + private List getSettingEntriesUpResourceTree(ILanguageSettingsProvider provider) { + if (currentLanguageId==null) + return null; + + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + IResource rc = getResource(); + List entries = LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, cfgDescription, rc, currentLanguageId); + return entries; + } + + /** + * Shortcut for getting setting entries for current context without checking the parent resource. + * @return list of setting entries for the current context. + */ + private List getSettingEntries(ILanguageSettingsProvider provider) { + if (currentLanguageId==null) + return null; + + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + IResource rc = getResource(); + return provider.getSettingEntries(cfgDescription, rc, currentLanguageId); + } + + private void addTreeForLanguages(Composite comp) { + treeLanguages = new Tree(comp, SWT.BORDER | SWT.SINGLE | SWT.H_SCROLL); + treeLanguages.setLayoutData(new GridData(GridData.FILL_VERTICAL)); + treeLanguages.setHeaderVisible(true); + + treeLanguages.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + TreeItem[] items = treeLanguages.getSelection(); + if (items.length > 0) { + currentLanguageId = (String) items[0].getData(); + updateTreeEntries(); + updateButtons(); + } + } + }); + + final TreeColumn columnLanguages = new TreeColumn(treeLanguages, SWT.NONE); + columnLanguages.setText(Messages.AbstractLangsListTab_Languages); + columnLanguages.setWidth(200); + columnLanguages.setResizable(false); + columnLanguages.setToolTipText(Messages.AbstractLangsListTab_Languages); + + treeLanguages.addPaintListener(new PaintListener() { + @Override + public void paintControl(PaintEvent e) { + int x = treeLanguages.getBounds().width - 5; + if (columnLanguages.getWidth() != x) + columnLanguages.setWidth(x); + } + }); + + } + + private void addTreeForEntries(Composite comp) { + treeEntries = new Tree(comp, SWT.BORDER | SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL); + treeEntries.setLayoutData(new GridData(GridData.FILL_VERTICAL)); + treeEntries.setHeaderVisible(true); + treeEntries.setLinesVisible(true); + + final TreeColumn treeCol = new TreeColumn(treeEntries, SWT.NONE); + treeEntries.addPaintListener(new PaintListener() { + @Override + public void paintControl(PaintEvent e) { + int x = treeEntries.getClientArea().width; + if (treeCol.getWidth() != x) + treeCol.setWidth(x); + } + }); + + treeCol.setText(Messages.LanguageSettingsProviderTab_SettingEntries); + treeCol.setWidth(200); + treeCol.setResizable(false); + treeCol.setToolTipText(Messages.LanguageSettingsProviderTab_SettingEntriesTooltip); + + treeEntriesViewer = new TreeViewer(treeEntries); + treeEntriesViewer.setContentProvider(new EntriesTreeContentProvider()); + treeEntriesViewer.setLabelProvider(new EntriesTreeLabelProvider()); + + treeEntriesViewer.setUseHashlookup(true); + + treeEntries.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + updateStatusLine(); + updateButtons(); + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + if (buttonIsEnabled(BUTTON_EDIT) && treeEntries.getSelection().length>0) + buttonPressed(BUTTON_EDIT); + } + }); + + } + + private void trackInitialSettings() { + if (!page.isForPrefs()) { + ICConfigurationDescription[] cfgDescriptions = page.getCfgsEditable(); + for (ICConfigurationDescription cfgDescription : cfgDescriptions) { + if (cfgDescription!=null) { + String cfgId = cfgDescription.getId(); + List initialProviders = cfgDescription.getLanguageSettingProviders(); + initialProvidersMap.put(cfgId, initialProviders); + } + } + initialEnablement = ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(page.getProject()); + } + } + + @Override + public void createControls(Composite parent) { + super.createControls(parent); + usercomp.setLayout(new GridLayout()); + GridData gd = (GridData) usercomp.getLayoutData(); + // Discourage settings entry table from trying to show all its items at once, see bug 264330 + gd.heightHint =1; + + if (page instanceof Page_LanguageSettingsProviders) { + masterPropertyPage = (Page_LanguageSettingsProviders) page; + } + + trackInitialSettings(); + + // SashForms for each mode + createShowEntriesSashForm(); + + // Status line + fStatusLine = new StatusMessageLine(usercomp, SWT.LEFT, 2); + + // "Show built-ins" checkbox + builtInCheckBox = setupCheck(usercomp, Messages.AbstractLangsListTab_ShowBuiltin, 1, GridData.FILL_HORIZONTAL); + builtInCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + updateTreeEntries(); + } + }); + builtInCheckBox.setSelection(true); + builtInCheckBox.setEnabled(true); + + // "I want to try new scanner discovery" temporary checkbox + enableProvidersCheckBox = setupCheck(usercomp, Messages.CDTMainWizardPage_TrySD90, 2, GridData.FILL_HORIZONTAL); + enableProvidersCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean enabled = enableProvidersCheckBox.getSelection(); + if (masterPropertyPage!=null) + masterPropertyPage.setLanguageSettingsProvidersEnabled(enabled); + enableControls(enabled); + updateStatusLine(); + } + }); + + if (masterPropertyPage!=null) + enableProvidersCheckBox.setSelection(masterPropertyPage.isLanguageSettingsProvidersEnabled()); + else + enableProvidersCheckBox.setSelection(ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(page.getProject())); + // display but disable the checkbox for file/folder resource + enableProvidersCheckBox.setEnabled(page.isForProject()/* && !isConfigureMode*/); + enableControls(enableProvidersCheckBox.getSelection()); + + initButtons(BUTTON_LABELS); + updateData(getResDesc()); + } + + private void createShowEntriesSashForm() { + sashFormEntries = new SashForm(usercomp,SWT.HORIZONTAL); + + GridData gd = new GridData(GridData.FILL_BOTH); + gd.horizontalSpan = 2; + gd.grabExcessVerticalSpace = true; + sashFormEntries.setLayoutData(gd); + + GridLayout layout = new GridLayout(); + sashFormEntries.setLayout(layout); + + addTreeForLanguages(sashFormEntries); + addTreeForEntries(sashFormEntries); + + sashFormEntries.setWeights(DEFAULT_ENTRIES_SASH_WEIGHTS); + } + + private void enableControls(boolean enable) { + sashFormEntries.setEnabled(enable); + treeLanguages.setEnabled(enable); + treeEntries.setEnabled(enable); + builtInCheckBox.setEnabled(enable); + + buttoncomp.setEnabled(enable); + + if (enable) { + updateTreeEntries(); + } else { + disableButtons(); + } + } + + private void disableButtons() { + buttonSetEnabled(BUTTON_ADD, false); + buttonSetEnabled(BUTTON_EDIT, false); + buttonSetEnabled(BUTTON_DELETE, false); + buttonSetEnabled(BUTTON_MOVE_UP, false); + buttonSetEnabled(BUTTON_MOVE_DOWN, false); +// buttonSetEnabled(BUTTON_CONFIGURE, false); + } + + /** + * Updates state for all buttons. Called when table selection changes. + */ + @Override + protected void updateButtons() { + ILanguageSettingsProvider provider = getSelectedProvider(); + ICLanguageSettingEntry entry = getSelectedEntry(); + List entries = getSettingEntriesUpResourceTree(provider); + + boolean isEntrySelected = entry!=null; + boolean isProviderSelected = !isEntrySelected && (provider!=null); + + boolean isProviderEditable = provider instanceof ILanguageSettingsEditableProvider; +// boolean isUserProvider = provider instanceof UserLanguageSettingsProvider; + + boolean canAdd = isProviderEditable; + boolean canEdit = isProviderEditable && isEntrySelected; + boolean canDelete = isProviderEditable && isEntrySelected; + boolean canClear = isProviderEditable && isProviderSelected && entries!=null && entries.size()>0; + + boolean canMoveUp = false; + boolean canMoveDown = false; + if (isProviderEditable && isEntrySelected && entries!=null) { + int last = entries.size()-1; + int pos = getExactIndex(entries, entry); + + if (pos>=0 && pos<=last) { + canMoveUp = pos!=0; + canMoveDown = pos!=last; + } + } + + buttonSetText(BUTTON_DELETE, isProviderSelected ? CLEAR_STR : DEL_STR); + + buttonSetEnabled(BUTTON_ADD, canAdd); + buttonSetEnabled(BUTTON_EDIT, canEdit); + buttonSetEnabled(BUTTON_DELETE, canDelete || canClear); + + buttonSetEnabled(BUTTON_MOVE_UP, canMoveUp); + buttonSetEnabled(BUTTON_MOVE_DOWN, canMoveDown); + + } + + /** + * Displays warning message - if any - for selected language settings entry. + */ + private void updateStatusLine() { + IStatus status=null; + if (enableProvidersCheckBox.getSelection()==true) { + status = LanguageSettingsImages.getStatus(getSelectedEntry()); + } + if (status==null || status==Status.OK_STATUS) { + ILanguageSettingsProvider provider = getSelectedProvider(); + if (provider!=null && !(provider instanceof UserLanguageSettingsProvider)) { + String msg = "Setting entries for this provider are supplied by system and are not editable."; + status = new Status(IStatus.INFO, CUIPlugin.PLUGIN_ID, msg); + } + } + if (status==null || status==Status.OK_STATUS) { + if (treeLanguages.getItemCount()<=0) { + String msg = "Cannot determine toolchain languages."; + status = new Status(IStatus.ERROR, CUIPlugin.PLUGIN_ID, msg); + } + } + fStatusLine.setErrorStatus(status); + } + + /** + * Handle buttons + */ + @Override + public void buttonPressed(int buttonIndex) { + ILanguageSettingsProvider selectedProvider = getSelectedProvider(); + ICLanguageSettingEntry selectedEntry = getSelectedEntry(); + + switch (buttonIndex) { + case BUTTON_ADD: + performAdd(selectedProvider); + break; + case BUTTON_EDIT: + performEdit(selectedProvider, selectedEntry); + break; + case BUTTON_DELETE: + performDelete(selectedProvider, selectedEntry); + break; +// case BUTTON_CONFIGURE: +// performConfigure(selectedProvider); +// break; + case BUTTON_MOVE_UP: + performMoveUp(selectedProvider, selectedEntry); + break; + case BUTTON_MOVE_DOWN: + performMoveDown(selectedProvider, selectedEntry); + break; + default: + } + treeEntries.setFocus(); + } + + /** + * That method returns exact position of an element in the list. + * Note that {@link List#indexOf(Object)} returns position of the first element + * equals to the given one, not exact element. + * + * @param entries + * @param entry + * @return exact position of the element or -1 of not found. + */ + private int getExactIndex(List entries, ICLanguageSettingEntry entry) { + if (entries!=null) { + for (int i=0;i0) { + treeEntries.showItem(providerItem.getItems()[0]); + } + TreeItem entryItem = findEntryItem(providerId, entry); + if (entryItem!=null) { + treeEntries.showItem(entryItem); + treeEntries.select(entryItem); + } + } + } + + private void addEntry(ILanguageSettingsProvider provider, ICLanguageSettingEntry entry) { + if (provider!=null && entry != null) { + String providerId = provider.getId(); + + List entries = getWritableEntries(provider); + ICLanguageSettingEntry selectedEntry = getSelectedEntry(); + int pos = getExactIndex(entries, selectedEntry); + entries.add(pos+1, entry); + saveEntries(provider, entries); + + updateTreeEntries(); + selectItem(providerId, entry); + updateButtons(); + } + } + + private void saveEntries(ILanguageSettingsProvider provider, List entries) { + if (provider instanceof LanguageSettingsSerializable) { + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + IResource rc = getResource(); + if (entries!=null && rc!=null) { + List parentEntries = null; + if (rc instanceof IProject) { + parentEntries = new ArrayList(); + } else { + parentEntries = LanguageSettingsManager.getSettingEntriesUpResourceTree(provider, cfgDescription, rc.getParent(), currentLanguageId); + } + if (entries.equals(parentEntries)) { + // to use parent entries instead + entries = null; + } + } + ((LanguageSettingsSerializable)provider).setSettingEntries(cfgDescription, rc, currentLanguageId, entries); + } + } + + private List getWritableEntries(ILanguageSettingsProvider provider) { + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + IResource rc = getResource(); + List entries = provider.getSettingEntries(cfgDescription, rc, currentLanguageId); + if (entries == null) { + entries = getSettingEntriesUpResourceTree(provider); + } + entries = new ArrayList(entries); + return entries; + } + + private ICLanguageSettingEntry doAdd() { + ICLanguageSettingEntry selectedEntry = getSelectedEntry(); + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + LanguageSettingEntryDialog dlg = new LanguageSettingEntryDialog(usercomp.getShell(), cfgDescription, selectedEntry, true); + if (dlg.open()) { + return dlg.getEntries()[0]; + } + return null; + } + + private void performAdd(ILanguageSettingsProvider selectedProvider) { + if (selectedProvider instanceof ILanguageSettingsEditableProvider) { + ICLanguageSettingEntry settingEntry = doAdd(); + if (settingEntry!=null) { + selectedProvider = arrangeEditedCopy((ILanguageSettingsEditableProvider)selectedProvider); + addEntry(selectedProvider, settingEntry); + } + } + } + + /** + * @param selectedProvider + * @return + */ + private ILanguageSettingsEditableProvider arrangeEditedCopy(ILanguageSettingsEditableProvider selectedProvider) { + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + List initialProviders = initialProvidersMap.get(cfgDescription.getId()); + if (initialProviders.contains(selectedProvider)) { + List providers = new ArrayList(cfgDescription.getLanguageSettingProviders()); + int pos = providers.indexOf(selectedProvider); + if (pos>=0) { + try { + selectedProvider = selectedProvider.clone(); + providers.set(pos, selectedProvider); + cfgDescription.setLanguageSettingProviders(providers); + } catch (CloneNotSupportedException e) { + CUIPlugin.log("Internal Error: cannot clone provider "+selectedProvider.getId(), e); + } + } else { + CUIPlugin.getDefault().logErrorMessage("Internal Error: cannot find provider "+selectedProvider.getId()); + } + } + return selectedProvider; + } + + private ICLanguageSettingEntry doEdit(ICLanguageSettingEntry ent) { + ICLanguageSettingEntry selectedEntry = getSelectedEntry(); + ICConfigurationDescription cfgDecsription = getConfigurationDescription(); + LanguageSettingEntryDialog dlg = new LanguageSettingEntryDialog(usercomp.getShell(), cfgDecsription, selectedEntry); + if (dlg.open()) { + return dlg.getEntries()[0]; + } + return null; + } + + private void performEdit(ILanguageSettingsProvider selectedProvider, ICLanguageSettingEntry selectedEntry) { + if (selectedProvider instanceof ILanguageSettingsEditableProvider) { + ICLanguageSettingEntry settingEntry = doEdit(selectedEntry); + if (settingEntry!=null) { + selectedProvider = arrangeEditedCopy((ILanguageSettingsEditableProvider)selectedProvider); + deleteEntry(selectedProvider, selectedEntry); + addEntry(selectedProvider, settingEntry); + } + } + } + + private void deleteEntry(ILanguageSettingsProvider provider, ICLanguageSettingEntry entry) { + if (provider!=null && entry != null) { + String providerId = provider.getId(); + + List entries = getWritableEntries(provider); + int pos = getExactIndex(entries, entry); + entries.remove(entry); + saveEntries(provider, entries); + + if (pos>=entries.size()) + pos = entries.size()-1; + ICLanguageSettingEntry nextEntry = pos>=0 ? entries.get(pos) : null; + + updateTreeEntries(); + selectItem(providerId, nextEntry); + updateButtons(); + } + } + + private void clearProvider(ILanguageSettingsProvider provider) { + if (provider!=null) { + String providerId = provider.getId(); + List empty = new ArrayList(); + saveEntries(provider, empty); + + updateTreeEntries(); + selectItem(providerId, null); + updateButtons(); + } + } + + private void performDelete(ILanguageSettingsProvider selectedProvider, ICLanguageSettingEntry selectedEntry) { + if (selectedProvider instanceof ILanguageSettingsEditableProvider) { + selectedProvider = arrangeEditedCopy((ILanguageSettingsEditableProvider)selectedProvider); + if (selectedEntry!=null) { + deleteEntry(selectedProvider, selectedEntry); + } else { + clearProvider(selectedProvider); + } + } + } + + private void moveEntry(ILanguageSettingsProvider provider, ICLanguageSettingEntry entry, boolean up) { + if (provider!=null && entry != null) { + String providerId = provider.getId(); + + List entries = getWritableEntries(provider); + int pos = getExactIndex(entries, entry); + int newPos = up ? pos-1 : pos+1; + Collections.swap(entries, pos, newPos); + saveEntries(provider, entries); + + updateTreeEntries(); + selectItem(providerId, entry); + updateButtons(); + } + } + + private void performMoveUp(ILanguageSettingsProvider selectedProvider, ICLanguageSettingEntry selectedEntry) { + if (selectedEntry!=null && (selectedProvider instanceof ILanguageSettingsEditableProvider)) { + selectedProvider = arrangeEditedCopy((ILanguageSettingsEditableProvider)selectedProvider); + moveEntry(selectedProvider, selectedEntry, true); + } + } + + private void performMoveDown(ILanguageSettingsProvider selectedProvider, ICLanguageSettingEntry selectedEntry) { + if (selectedEntry!=null && (selectedProvider instanceof ILanguageSettingsEditableProvider)) { + selectedProvider = arrangeEditedCopy((ILanguageSettingsEditableProvider)selectedProvider); + moveEntry(selectedProvider, selectedEntry, false); + } + } + + /** + * Get list of providers to display in the settings entry tree. + */ + private List getProviders(String languageSettingId) { + List itemsList = new LinkedList(); + if (currentLanguageId!=null) { + IResource rc = getResource(); + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + if (rc!=null && cfgDescription!=null) { + List cfgProviders = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider cfgProvider : cfgProviders) { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(cfgProvider); + if (rawProvider instanceof LanguageSettingsBaseProvider) { + // filter out providers incapable of providing entries for this language + List languageIds = ((LanguageSettingsBaseProvider)rawProvider).getLanguageScope(); + if (languageIds!=null && !languageIds.contains(currentLanguageId)) { + continue; + } + } + itemsList.add(cfgProvider); + } + } + } + return itemsList; + } + + /** + * Refreshes the entries tree in "Show Entries" mode. + */ + public void updateTreeEntries() { + List tableItems = getProviders(currentLanguageId); + treeEntriesViewer.setInput(tableItems.toArray(new Object[tableItems.size()])); + updateStatusLine(); + updateButtons(); + } + + private void updateTreeLanguages(ICResourceDescription rcDes) { + treeLanguages.removeAll(); + TreeItem selectedLanguageItem = null; + + List languageIds = LanguageSettingsManager.getLanguages(rcDes); + Collections.sort(languageIds); + for (String langId : languageIds) { + ILanguage language = LanguageManager.getInstance().getLanguage(langId); + if (language == null) + continue; + + String langName = language.getName(); + if (langName == null || langName.length()==0) + continue; + + TreeItem t = new TreeItem(treeLanguages, SWT.NONE); + t.setText(0, langName); + t.setData(langId); + if (selectedLanguageItem == null) { + if (currentLanguageId!=null) { + if (currentLanguageId.equals(langId)) { + selectedLanguageItem = t; + } + } else { + selectedLanguageItem = t; + currentLanguageId = langId; + } + } + } + + if (selectedLanguageItem != null) { + treeLanguages.setSelection(selectedLanguageItem); + } + } + + /** + * Called when configuration changed Refreshes languages list entries tree. + */ + @Override + public void updateData(ICResourceDescription rcDes) { + if (!canBeVisible()) + return; + + if (rcDes!=null) { + if (page.isMultiCfg()) { + setAllVisible(false, null); + return; + } else { + setAllVisible(true, null); + } + + updateTreeLanguages(rcDes); + updateTreeEntries(); + if (masterPropertyPage!=null) { + boolean enabled = masterPropertyPage.isLanguageSettingsProvidersEnabled(); + enableProvidersCheckBox.setSelection(enabled); + enableControls(enabled); + } + } + updateButtons(); + } + + @Override + protected void performDefaults() { + // This page restores defaults for file/folder only. + // Project and Preferences page are restored by LanguageSettingsProviderTab. + if (page.isForFile() || page.isForFolder()) { + // The logic below is not exactly correct as the default for a resource could be different than null. + // It is supposed to match the one taken from extension for the same resource which in theory can be non-null. + // However for the performance reasons for resource decorators where the same logic is used + // we use null for resetting file/folder resource which should be correct in most cases. + // Count that as a feature. + boolean changed = false; + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + IResource rc = getResource(); + List providers = cfgDescription.getLanguageSettingProviders(); + List writableProviders = new ArrayList(providers.size()); + +providers: for (ILanguageSettingsProvider provider : providers) { + ILanguageSettingsEditableProvider writableProvider = null; + if (provider instanceof ILanguageSettingsEditableProvider) { + for (TreeItem langItems : treeLanguages.getItems()) { + String langId = (String)langItems.getData(); + if (langId!=null) { + if (provider.getSettingEntries(cfgDescription, rc, langId)!=null) { + try { + // clone providers to be able to "Cancel" in UI + if (writableProvider==null) { + writableProvider = ((ILanguageSettingsEditableProvider) provider).clone(); + } + writableProvider.setSettingEntries(cfgDescription, rc, langId, null); + changed = true; + } catch (CloneNotSupportedException e) { + CUIPlugin.log("Internal Error: cannot clone provider "+provider.getId(), e); + continue providers; + } + } + } + } + } + if (writableProvider!=null) + writableProviders.add(writableProvider); + else + writableProviders.add(provider); + } + if (changed) { + cfgDescription.setLanguageSettingProviders(writableProviders); +// updateTreeEntries(); +// updateData(getResDesc()); + List tableItems = getProviders(currentLanguageId); + treeEntriesViewer.setInput(tableItems.toArray(new Object[tableItems.size()])); + } + } + } + + @Override + protected void performApply(ICResourceDescription srcRcDescription, ICResourceDescription destRcDescription) { + if (!page.isForPrefs()) { + ICConfigurationDescription srcCfgDescription = srcRcDescription.getConfiguration(); + ICConfigurationDescription destCfgDescription = destRcDescription.getConfiguration(); + + List providers = srcCfgDescription.getLanguageSettingProviders(); + destCfgDescription.setLanguageSettingProviders(providers); + } + + if (!page.isForPrefs()) { + ICConfigurationDescription sd = srcRcDescription.getConfiguration(); + ICConfigurationDescription dd = destRcDescription.getConfiguration(); + List newProviders = sd.getLanguageSettingProviders(); + dd.setLanguageSettingProviders(newProviders); + } + + performOK(); + } + + @Override + protected void performOK() { + if (page.isForProject() && enableProvidersCheckBox!=null) { + boolean enabled = enableProvidersCheckBox.getSelection(); + if (masterPropertyPage!=null) + enabled = masterPropertyPage.isLanguageSettingsProvidersEnabled(); + ScannerDiscoveryLegacySupport.setLanguageSettingsProvidersFunctionalityEnabled(page.getProject(), enabled); + enableProvidersCheckBox.setSelection(enabled); + } + + trackInitialSettings(); + updateData(getResDesc()); + } + + @Override + public boolean canBeVisible() { + if (CDTPrefUtil.getBool(CDTPrefUtil.KEY_NO_SHOW_PROVIDERS)) + return false; + + //filter out files not associated with any languages such as *.o + if (page.isForFile()) { + List languageIds = LanguageSettingsManager.getLanguages(getResDesc()); + for (String langId : languageIds) { + LanguageManager langManager = LanguageManager.getInstance(); + ILanguage language = langManager.getLanguage(langId); + if (language != null) + return true; + } + return false; + } + + return true; + } + + /** + * Shortcut for setting setting entries for current context. + * + */ + private void setSettingEntries(ILanguageSettingsEditableProvider provider, List entries) { + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + IResource rc = getResource(); + if (currentLanguageId!=null) + provider.setSettingEntries(cfgDescription, rc, currentLanguageId, entries); + } + +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProviderAssociation.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProviderAssociation.java new file mode 100644 index 00000000000..76537635cd5 --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProviderAssociation.java @@ -0,0 +1,246 @@ +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import java.net.MalformedURLException; +import java.net.URL; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import org.eclipse.core.runtime.IConfigurationElement; +import org.eclipse.core.runtime.IExtension; +import org.eclipse.core.runtime.IExtensionPoint; +import org.eclipse.core.runtime.IExtensionRegistry; +import org.eclipse.core.runtime.Platform; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.cdt.ui.CUIPlugin; +import org.eclipse.cdt.ui.dialogs.ICOptionPage; + +public class LanguageSettingsProviderAssociation { + public static final String LANGUAGE_SETTINGS_PROVIDER_UI = "LanguageSettingsProviderAssociation"; //$NON-NLS-1$ + + private static final String ELEM_ID_ASSOCIATION = "id-association"; //$NON-NLS-1$ + private static final String ELEM_CLASS_ASSOCIATION = "class-association"; //$NON-NLS-1$ + private static final String ATTR_ID = "id"; //$NON-NLS-1$ + private static final String ATTR_CLASS = "class"; //$NON-NLS-1$ + private static final String ATTR_ICON = "icon"; //$NON-NLS-1$ + private static final String ATTR_PAGE = "page"; //$NON-NLS-1$ + + static private List loadedIcons = null; + static private Map fImagesUrlById = null; + static private Map fImagesUrlByClass = null; + static private List fRegirestedIds = null; + static private List fRegisteredClasses = null; + + private static void loadExtensions() { + if (loadedIcons!=null) { + return; + } + if (loadedIcons==null) loadedIcons = new ArrayList(); + if (fImagesUrlById==null) fImagesUrlById = new HashMap(); + if (fImagesUrlByClass==null) fImagesUrlByClass = new HashMap(); + if (fRegirestedIds==null) fRegirestedIds = new ArrayList(); + if (fRegisteredClasses==null) fRegisteredClasses = new ArrayList(); + + IExtensionRegistry registry = Platform.getExtensionRegistry(); + IExtensionPoint extension = registry.getExtensionPoint(CUIPlugin.PLUGIN_ID, LanguageSettingsProviderAssociation.LANGUAGE_SETTINGS_PROVIDER_UI); + if (extension != null) { + IExtension[] extensions = extension.getExtensions(); + for (IExtension ext : extensions) { + @SuppressWarnings("unused") + String extensionID = ext.getUniqueIdentifier(); + for (IConfigurationElement cfgEl : ext.getConfigurationElements()) { + if (cfgEl.getName().equals(ELEM_ID_ASSOCIATION)) { + String id = cfgEl.getAttribute(ATTR_ID); + URL url = getIconUrl(cfgEl); + fImagesUrlById.put(id, url); + fRegirestedIds.add(id); + } else if (cfgEl.getName().equals(ELEM_CLASS_ASSOCIATION)) { + String className = cfgEl.getAttribute(ATTR_CLASS); + URL url = getIconUrl(cfgEl); + fImagesUrlByClass.put(className, url); + String pageClass = cfgEl.getAttribute(ATTR_PAGE); + if (pageClass!=null && pageClass.trim().length()>0) { + fRegisteredClasses.add(className); + } + } + } + } + } + + } + + private static URL getIconUrl(IConfigurationElement config) { + URL url = null; + try { + String iconName = config.getAttribute(ATTR_ICON); + if (iconName != null) { + URL pluginInstallUrl = Platform.getBundle(config.getDeclaringExtension().getContributor().getName()).getEntry("/"); //$NON-NLS-1$ + url = new URL(pluginInstallUrl, iconName); + if (loadedIcons.contains(url)) + return url; + } + } catch (MalformedURLException exception) {} + + loadedIcons.add(url); + if (url!=null) { + CDTSharedImages.register(url); + } + + return url; + } + + public static URL getImageUrl(String id) { + if (fImagesUrlById==null) { + loadExtensions(); + } + return fImagesUrlById.get(id); + } + + private static ICOptionPage createOptionsPageById(String providerId) { + if (fRegirestedIds==null) { + loadExtensions(); + } + if (fRegirestedIds.contains(providerId)) { + IExtensionRegistry registry = Platform.getExtensionRegistry(); + IExtensionPoint extension = registry.getExtensionPoint(CUIPlugin.PLUGIN_ID, LanguageSettingsProviderAssociation.LANGUAGE_SETTINGS_PROVIDER_UI); + if (extension != null) { + IExtension[] extensions = extension.getExtensions(); + for (IExtension ext : extensions) { + try { + @SuppressWarnings("unused") + String extensionID = ext.getUniqueIdentifier(); + for (IConfigurationElement cfgEl : ext.getConfigurationElements()) { + if (cfgEl.getName().equals(ELEM_ID_ASSOCIATION)) { + String id = cfgEl.getAttribute(ATTR_ID); + if (providerId.equals(id)) { + String pageClass = cfgEl.getAttribute(ATTR_PAGE); + if (pageClass!=null && pageClass.trim().length()>0) { + ICOptionPage page = (ICOptionPage) cfgEl.createExecutableExtension(ATTR_PAGE); + return page; + } + } + } + } + } catch (Exception e) { + CUIPlugin.log("Cannot load LanguageSettingsProviderAssociation extension " + ext.getUniqueIdentifier(), e); //$NON-NLS-1$ + } + } + } + } + return null; + } + + private static ICOptionPage createOptionsPageByClass(String providerClassName) { + if (fRegisteredClasses==null) { + loadExtensions(); + } + if (fRegisteredClasses.contains(providerClassName)) { + IExtensionRegistry registry = Platform.getExtensionRegistry(); + IExtensionPoint extension = registry.getExtensionPoint(CUIPlugin.PLUGIN_ID, LanguageSettingsProviderAssociation.LANGUAGE_SETTINGS_PROVIDER_UI); + if (extension != null) { + IExtension[] extensions = extension.getExtensions(); + for (IExtension ext : extensions) { + try { + @SuppressWarnings("unused") + String extensionID = ext.getUniqueIdentifier(); + for (IConfigurationElement cfgEl : ext.getConfigurationElements()) { + if (cfgEl.getName().equals(ELEM_CLASS_ASSOCIATION)) { + String className = cfgEl.getAttribute(ATTR_CLASS); + if (providerClassName.equals(className)) { + String pageClass = cfgEl.getAttribute(ATTR_PAGE); + if (pageClass!=null && pageClass.trim().length()>0) { + ICOptionPage page = (ICOptionPage) cfgEl.createExecutableExtension(ATTR_PAGE); + return page; + } + } + } + } + } catch (Exception e) { + CUIPlugin.log("Cannot load LanguageSettingsProviderAssociation extension " + ext.getUniqueIdentifier(), e); //$NON-NLS-1$ + } + } + } + } + return null; + } + + /** + * Returns Language Settings Provider image registered for closest superclass + * or interface. + * + * @param clazz - class to find Language Settings Provider image. + * @return image or {@code null} + */ + public static URL getImage(Class clazz) { + URL url = null; + + outer: for (Class cl=clazz;cl!=null;cl=cl.getSuperclass()) { + url = getImageURL(cl); + if (url!=null) + break; + + // this does not check for superinterfaces, feel free to implement as needed + for (Class in : cl.getInterfaces()) { + url = getImageURL(in); + if (url!=null) + break outer; + } + } + return url; + } + + private static URL getImageURL(Class clazz) { + String className = clazz.getCanonicalName(); + Set> entrySet = fImagesUrlByClass.entrySet(); + for (Entry entry : entrySet) { + if (entry.getKey().equals(className)) { + return entry.getValue(); + } + } + return null; + } + + /** + * Returns Language Settings Provider image registered for closest superclass. + * @param provider TODO + * @return image or {@code null} + */ + public static ICOptionPage createOptionsPage(ILanguageSettingsProvider provider) { + String id = provider.getId(); + ICOptionPage optionsPage = createOptionsPageById(id); + if (optionsPage!=null) { + return optionsPage; + } + + Class clazz = provider.getClass(); + outer: for (Class cl=clazz;cl!=null;cl=cl.getSuperclass()) { + optionsPage = createOptionsPageByClass(cl); + if (optionsPage!=null) + break; + + // this does not check for superinterfaces, feel free to implement as needed + for (Class in : cl.getInterfaces()) { + optionsPage = createOptionsPageByClass(in); + if (optionsPage!=null) + break outer; + } + } + return optionsPage; + } + + private static ICOptionPage createOptionsPageByClass(Class c) { + ICOptionPage optionsPage = null; + String className = c.getCanonicalName(); + if (fRegisteredClasses.contains(className)) { + optionsPage = createOptionsPageByClass(className); + } + return optionsPage; + } + + +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProviderTab.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProviderTab.java new file mode 100644 index 00000000000..750fd028d24 --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProviderTab.java @@ -0,0 +1,1044 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.Comparator; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.TreeSet; + +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.Assert; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.jface.dialogs.MessageDialog; +import org.eclipse.jface.viewers.ArrayContentProvider; +import org.eclipse.jface.viewers.CheckStateChangedEvent; +import org.eclipse.jface.viewers.CheckboxTableViewer; +import org.eclipse.jface.viewers.ICheckStateListener; +import org.eclipse.jface.viewers.IDecoration; +import org.eclipse.swt.SWT; +import org.eclipse.swt.custom.SashForm; +import org.eclipse.swt.events.SelectionAdapter; +import org.eclipse.swt.events.SelectionEvent; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Button; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Event; +import org.eclipse.swt.widgets.Group; +import org.eclipse.swt.widgets.Link; +import org.eclipse.swt.widgets.Listener; +import org.eclipse.swt.widgets.Table; +import org.eclipse.ui.dialogs.PreferencesUtil; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager_TBD; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; +import org.eclipse.cdt.core.settings.model.ICConfigurationDescription; +import org.eclipse.cdt.core.settings.model.ICResourceDescription; +import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.cdt.ui.CUIPlugin; +import org.eclipse.cdt.ui.dialogs.ICOptionPage; +import org.eclipse.cdt.ui.newui.AbstractCPropertyTab; +import org.eclipse.cdt.ui.newui.CDTPrefUtil; +import org.eclipse.cdt.utils.ui.controls.TabFolderLayout; + +import org.eclipse.cdt.internal.ui.newui.Messages; +import org.eclipse.cdt.internal.ui.newui.StatusMessageLine; + +/** + * This tab presents language settings entries categorized by language + * settings providers. + * + *@noinstantiate This class is not intended to be instantiated by clients. + *@noextend This class is not intended to be subclassed by clients. + */ +public class LanguageSettingsProviderTab extends AbstractCPropertyTab { + private static final String WORKSPACE_PREFERENCE_PAGE = "org.eclipse.cdt.ui.preferences.BuildSettingProperties"; //$NON-NLS-1$ + // TODO: generalize + private static final String TEST_PLUGIN_ID_PATTERN = "org.eclipse.cdt.*.tests.*"; //$NON-NLS-1$ + +// private static final String RENAME_STR = "Rename..."; +// private static final String RUN_STR = Messages.LanguageSettingsProviderTab_Run; + private static final String CLEAR_STR = Messages.LanguageSettingsProviderTab_Clear; + private static final String RESET_STR = "Reset"; + +// private static final int BUTTON_RENAME = 0; +// private static final int BUTTON_RUN = 0; + private static final int BUTTON_CLEAR = 0; + private static final int BUTTON_RESET = 1; + // there is a separator instead of button #2 + private static final int BUTTON_MOVE_UP = 3; + private static final int BUTTON_MOVE_DOWN = 4; + + private final static String[] BUTTON_LABELS_PROJECT = { +// RENAME_STR, +// RUN_STR, + CLEAR_STR, + RESET_STR, + null, + MOVEUP_STR, + MOVEDOWN_STR, + }; + + private final static String[] BUTTON_LABELS_PREF = { +// RENAME_STR, +// RUN_STR, + CLEAR_STR, + RESET_STR, + }; + + private static final int[] DEFAULT_CONFIGURE_SASH_WEIGHTS = new int[] { 50, 50 }; + private SashForm sashFormConfigure; + + private Table tableProviders; + private CheckboxTableViewer tableProvidersViewer; + private Group groupOptionsPage; + private ICOptionPage currentOptionsPage = null; + private Composite compositeOptionsPage; + + private Button enableProvidersCheckBox; + private StatusMessageLine fStatusLine; + + private Button globalProviderCheckBox = null; + private Link linkWorkspacePreferences = null; + private Button projectStorageCheckBox = null; + + private Page_LanguageSettingsProviders masterPropertyPage = null; + + /** + * List of providers presented to the user. + * For global providers included in a configuration this contains references + * not raw providers. + */ + private List presentedProviders = null; + private final Map optionsPageMap = new HashMap(); + private Map> initialProvidersByCfg = new HashMap>(); + + private boolean initialEnablement = false; + + /** + * Returns current working copy of the provider. Creates one if it has not been created yet. + * Used by option pages when there is a need to modify the provider. + * Warning: Do not cache the result as the provider can be replaced at any time. + * @param providerId + * + * @return the provider + */ + public ILanguageSettingsProvider getWorkingCopy(String providerId) { + ILanguageSettingsProvider provider = findProvider(providerId, presentedProviders); + if (isWorkingCopy(provider)) + return provider; + + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + Assert.isTrue(rawProvider instanceof ILanguageSettingsEditableProvider); + + ILanguageSettingsEditableProvider editableProvider = (ILanguageSettingsEditableProvider)rawProvider; + try { + ILanguageSettingsEditableProvider newProvider = editableProvider.clone(); + replaceSelectedProvider(newProvider); + return newProvider; + + } catch (CloneNotSupportedException e) { + CUIPlugin.log("Error cloning provider " + editableProvider.getId(), e); + // TODO warning dialog for user? + } + + return null; + } + + private class ProvidersTableLabelProvider extends LanguageSettingsProvidersLabelProvider { + @Override + protected String[] getOverlayKeys(ILanguageSettingsProvider provider) { + String[] overlayKeys = super.getOverlayKeys(provider); + + ILanguageSettingsProvider rawProvider = page.isForPrefs() ? LanguageSettingsManager.getRawProvider(provider) : provider; + if (LanguageSettingsManager_TBD.isReconfigured(rawProvider)) { + overlayKeys[IDecoration.TOP_RIGHT] = CDTSharedImages.IMG_OVR_SETTING; + } + + if (isWorkingCopy(provider)) { + overlayKeys[IDecoration.TOP_RIGHT] = CDTSharedImages.IMG_OVR_EDITED; + } + return overlayKeys; + } + } + + /** + * Shortcut for getting the current resource for the property page. + */ + private IResource getResource() { + return (IResource)page.getElement(); + } + + /** + * Shortcut for getting the current configuration description. + */ + private ICConfigurationDescription getConfigurationDescription() { + if (page.isForPrefs()) + return null; + + ICConfigurationDescription cfgDescription = getResDesc().getConfiguration(); + return cfgDescription; + } + + /** + * Shortcut for getting the currently selected provider. + * Do not use if you need to change provider's settings, use {@link #getWorkingCopy(String)}. + */ + private ILanguageSettingsProvider getSelectedProvider() { + ILanguageSettingsProvider provider = null; + + int pos = tableProviders.getSelectionIndex(); + if (pos >= 0 && pos initialProviders = cfgDescription.getLanguageSettingProviders(); + initialProvidersByCfg.put(cfgId, initialProviders); + } + } + initialEnablement = ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(page.getProject()); + } + } + + @Override + public void createControls(Composite parent) { + super.createControls(parent); + usercomp.setLayout(new GridLayout()); + GridData gd = (GridData) usercomp.getLayoutData(); + // Discourage settings entry table from trying to show all its items at once, see bug 264330 + gd.heightHint =1; + + if (page instanceof Page_LanguageSettingsProviders) { + masterPropertyPage = (Page_LanguageSettingsProviders) page; + } + + trackInitialSettings(); + + // SashForms for each mode + createConfigureSashForm(); + + // Status line + fStatusLine = new StatusMessageLine(usercomp, SWT.LEFT, 2); + + if (page.isForPrefs()) { + initButtons(BUTTON_LABELS_PREF); + + } else { + // "I want to try new scanner discovery" temporary checkbox + enableProvidersCheckBox = setupCheck(usercomp, Messages.CDTMainWizardPage_TrySD90, 2, GridData.FILL_HORIZONTAL); + enableProvidersCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean enabled = enableProvidersCheckBox.getSelection(); + if (masterPropertyPage!=null) + masterPropertyPage.setLanguageSettingsProvidersEnabled(enabled); + enableControls(enabled); + updateStatusLine(); + } + }); + + if (masterPropertyPage!=null) + enableProvidersCheckBox.setSelection(masterPropertyPage.isLanguageSettingsProvidersEnabled()); + else + enableProvidersCheckBox.setSelection(ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(page.getProject())); + // display but disable the checkbox for file/folder resource + enableProvidersCheckBox.setEnabled(page.isForProject()); + enableControls(enableProvidersCheckBox.getSelection()); + + initButtons(BUTTON_LABELS_PROJECT); + } + updateData(getResDesc()); + } + + private void createConfigureSashForm() { + // SashForm for Configure + sashFormConfigure = new SashForm(usercomp, SWT.VERTICAL); + GridLayout layout = new GridLayout(); + sashFormConfigure.setLayout(layout); + + // Providers table + Composite compositeSashForm = new Composite(sashFormConfigure, SWT.BORDER | SWT.SINGLE); + compositeSashForm.setLayout(new GridLayout()); + + // items checkboxes only for project properties page + tableProviders = new Table(compositeSashForm, page.isForPrefs() ? SWT.NONE : SWT.CHECK); + tableProviders.setLayoutData(new GridData(GridData.FILL_BOTH)); + tableProviders.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + displaySelectedOptionPage(); + updateButtons(); + } + }); + tableProvidersViewer = new CheckboxTableViewer(tableProviders); + tableProvidersViewer.setContentProvider(new ArrayContentProvider()); + tableProvidersViewer.setLabelProvider(new ProvidersTableLabelProvider()); + + tableProvidersViewer.addCheckStateListener(new ICheckStateListener() { + @Override + public void checkStateChanged(CheckStateChangedEvent e) { + saveCheckedProviders(e.getElement()); + tableProvidersViewer.update(e.getElement(), null); + }}); + + createOptionsControl(); + + sashFormConfigure.setWeights(DEFAULT_CONFIGURE_SASH_WEIGHTS); + enableSashForm(sashFormConfigure, true); + } + + private Link createLinkToPreferences(final Composite parent, int span) { + Link link = new Link(parent, SWT.NONE); + GridData gd = new GridData(); + gd.horizontalSpan = span; + link.setLayoutData(gd); + + link.addListener(SWT.Selection, new Listener() { + @Override + public void handleEvent(Event event) { + // Use event.text to tell which link was used + PreferencesUtil.createPreferenceDialogOn(parent.getShell(), WORKSPACE_PREFERENCE_PAGE, null, null).open(); + } + }); + + return link; + } + + // Called from globalProviderCheckBox listener + private ILanguageSettingsProvider toggleGlobalProvider(ILanguageSettingsProvider oldProvider, boolean toGlobal) { + ILanguageSettingsProvider newProvider = null; + + String id = oldProvider.getId(); + if (toGlobal) { + newProvider = LanguageSettingsManager.getWorkspaceProvider(id); + } else { + // Local provider instance chosen + try { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(oldProvider); + if (rawProvider instanceof ILanguageSettingsEditableProvider) { + newProvider = ((ILanguageSettingsEditableProvider) rawProvider).cloneShallow(); + } + } catch (CloneNotSupportedException e) { + CUIPlugin.log("Error cloning provider " + oldProvider.getId(), e); + } + } + if (newProvider!=null) { + replaceSelectedProvider(newProvider); + + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + initializeOptionsPage(newProvider, cfgDescription); + displaySelectedOptionPage(); + } else { + newProvider = oldProvider; + } + + return newProvider; + } + + private void replaceSelectedProvider(ILanguageSettingsProvider newProvider) { + int pos = tableProviders.getSelectionIndex(); + presentedProviders.set(pos, newProvider); + tableProvidersViewer.setInput(presentedProviders); + tableProviders.setSelection(pos); + + ICConfigurationDescription cfgDescription = null; + if (!page.isForPrefs()) { + cfgDescription = getConfigurationDescription(); + + List cfgProviders = new ArrayList(cfgDescription.getLanguageSettingProviders()); + pos = getProviderIndex(newProvider.getId(), cfgProviders); + cfgProviders.set(pos, newProvider); + cfgDescription.setLanguageSettingProviders(cfgProviders); + tableProvidersViewer.setCheckedElements(cfgProviders.toArray(new ILanguageSettingsProvider[0])); + } + refreshItem(newProvider); + } + + public void refreshItem(ILanguageSettingsProvider provider) { + tableProvidersViewer.refresh(provider); + updateButtons(); + } + + private void createOptionsControl() { + groupOptionsPage = new Group(sashFormConfigure, SWT.SHADOW_ETCHED_IN); + groupOptionsPage.setText("Language Settings Provider Options"); + groupOptionsPage.setLayout(new GridLayout(2, false)); + + if (!page.isForPrefs()) { + if (globalProviderCheckBox==null) { + globalProviderCheckBox = new Button(groupOptionsPage, SWT.CHECK); + globalProviderCheckBox.setText("Share setting entries between projects (global provider)"); + globalProviderCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean isGlobal = globalProviderCheckBox.getSelection(); + ILanguageSettingsProvider provider = getSelectedProvider(); + if (isGlobal != LanguageSettingsManager.isWorkspaceProvider(provider)) { + provider = toggleGlobalProvider(provider, isGlobal); + } + projectStorageCheckBox.setSelection(provider instanceof LanguageSettingsSerializable + && ((LanguageSettingsSerializable) provider).isStoringEntriesInProjectArea()); + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + + }); + + projectStorageCheckBox = new Button(groupOptionsPage, SWT.CHECK); + projectStorageCheckBox.setText("Store entries in project settings folder (supporting project miration)"); + projectStorageCheckBox.addSelectionListener(new SelectionAdapter() { + @Override + public void widgetSelected(SelectionEvent e) { + boolean isWithProject = projectStorageCheckBox.getSelection(); + ILanguageSettingsProvider provider = getWorkingCopy(getSelectedProvider().getId()); + Assert.isTrue(provider instanceof LanguageSettingsSerializable); + ((LanguageSettingsSerializable)provider).setStoringEntriesInProjectArea(isWithProject); + refreshItem(provider); + } + + @Override + public void widgetDefaultSelected(SelectionEvent e) { + widgetSelected(e); + } + + }); + + linkWorkspacePreferences = createLinkToPreferences(groupOptionsPage, 2); + } + } + + compositeOptionsPage = new Composite(groupOptionsPage, SWT.NONE); + compositeOptionsPage.setLayout(new TabFolderLayout()); + } + + private void enableSashForm(SashForm sashForm, boolean enable) { + sashForm.setVisible(enable); + // Some of woodoo to fill properties page vertically and still keep right border visible in preferences + GridData gd = new GridData(enable || page.isForPrefs() ? GridData.FILL_BOTH : SWT.NONE); + gd.horizontalSpan = 2; + gd.heightHint = enable ? SWT.DEFAULT : 0; + sashForm.setLayoutData(gd); + } + + private void enableControls(boolean enable) { + sashFormConfigure.setEnabled(enable); + tableProviders.setEnabled(enable); + compositeOptionsPage.setEnabled(enable); + + buttoncomp.setEnabled(enable); + + if (enable) { + displaySelectedOptionPage(); + } else { + if (currentOptionsPage != null) { + currentOptionsPage.setVisible(false); + } + disableButtons(); + } + } + + /** + * Populate provider tables and their option pages which are used in Configure mode + */ + private void updateProvidersTable() { + ILanguageSettingsProvider selectedProvider = getSelectedProvider(); + String selectedId = selectedProvider!=null ? selectedProvider.getId() : null; + + // update viewer if the list of providers changed + int pos = tableProviders.getSelectionIndex(); + tableProvidersViewer.setInput(presentedProviders); + tableProviders.setSelection(pos); + + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + if (cfgDescription!=null) { + List cfgProviders = cfgDescription.getLanguageSettingProviders(); + tableProvidersViewer.setCheckedElements(cfgProviders.toArray(new ILanguageSettingsProvider[0])); + } + + if (selectedId!=null) { + for (int i=0; i idsList = new ArrayList(); + + List providers; + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + if (cfgDescription!=null) { + providers = new ArrayList(cfgDescription.getLanguageSettingProviders()); + for (ILanguageSettingsProvider provider : providers) { + idsList.add(provider.getId()); + } + } else { + providers = new ArrayList(); + } + + List workspaceProviders = LanguageSettingsManager.getWorkspaceProviders(); + + // ensure sorting by name all unchecked providers + Set allAvailableProvidersSet = new TreeSet(new Comparator() { + @Override + public int compare(ILanguageSettingsProvider prov1, ILanguageSettingsProvider prov2) { + Boolean isTest1 = prov1.getId().matches(TEST_PLUGIN_ID_PATTERN); + Boolean isTest2 = prov2.getId().matches(TEST_PLUGIN_ID_PATTERN); + int result = isTest1.compareTo(isTest2); + if (result==0) + result = prov1.getName().compareTo(prov2.getName()); + return result; + } + }); + allAvailableProvidersSet.addAll(workspaceProviders); + + for (ILanguageSettingsProvider provider : allAvailableProvidersSet) { + String id = provider.getId(); + if (!idsList.contains(id)) { + providers.add(provider); + idsList.add(id); + } + } + + // renders better when using temporary + presentedProviders = providers; + + int pos = tableProviders.getSelectionIndex(); + tableProvidersViewer.setInput(presentedProviders); + tableProviders.setSelection(pos); + } + + private ICOptionPage createOptionsPage(ILanguageSettingsProvider provider, ICConfigurationDescription cfgDescription) { + ICOptionPage optionsPage = null; + if (provider!=null) { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + if (rawProvider!=null) { + optionsPage = LanguageSettingsProviderAssociation.createOptionsPage(rawProvider); + } + + if (optionsPage instanceof AbstractLanguageSettingProviderOptionPage) { + ((AbstractLanguageSettingProviderOptionPage)optionsPage).init(this, provider.getId()); + } + } + + return optionsPage; + } + + private void initializeOptionsPage(ILanguageSettingsProvider provider, ICConfigurationDescription cfgDescription) { + ICOptionPage optionsPage = createOptionsPage(provider, cfgDescription); + + if (optionsPage!=null) { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + boolean isEditableForProject = page.isForProject() && provider instanceof ILanguageSettingsEditableProvider; + boolean isEditableForPrefs = page.isForPrefs() && rawProvider instanceof ILanguageSettingsEditableProvider; + boolean isEditable = isEditableForProject || isEditableForPrefs; + compositeOptionsPage.setEnabled(isEditable); + + String id = (provider!=null) ? provider.getId() : null; + optionsPageMap.put(id, optionsPage); + optionsPage.setContainer(page); + optionsPage.createControl(compositeOptionsPage); + optionsPage.setVisible(false); + compositeOptionsPage.layout(true); + } + } + + private void displaySelectedOptionPage() { + if (currentOptionsPage != null) { + currentOptionsPage.setVisible(false); + } + + ILanguageSettingsProvider provider = getSelectedProvider(); + String id = (provider!=null) ? provider.getId() : null; + + boolean isGlobal = LanguageSettingsManager.isWorkspaceProvider(provider); + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + + currentOptionsPage = optionsPageMap.get(id); + + boolean isChecked = tableProvidersViewer.getChecked(provider); + if (!page.isForPrefs()) { + boolean isRawProviderEditable = rawProvider instanceof ILanguageSettingsEditableProvider; + globalProviderCheckBox.setSelection(isGlobal); + globalProviderCheckBox.setEnabled(isChecked && isRawProviderEditable); + globalProviderCheckBox.setVisible(provider!=null); + + projectStorageCheckBox.setEnabled(!isGlobal); + projectStorageCheckBox.setVisible(rawProvider instanceof LanguageSettingsSerializable); + projectStorageCheckBox.setSelection(provider instanceof LanguageSettingsSerializable + && ((LanguageSettingsSerializable)provider).isStoringEntriesInProjectArea()); + + boolean needPreferencesLink=isGlobal && currentOptionsPage!=null; + // TODO: message + final String linkMsg = needPreferencesLink ? "Options of global providers can be changed in Workspace Settings, Discovery Tab." : ""; + linkWorkspacePreferences.setText(linkMsg); + linkWorkspacePreferences.pack(); + linkWorkspacePreferences.setEnabled(isChecked); + } + + if (currentOptionsPage != null) { + boolean isEditableForProject = page.isForProject() && provider instanceof ILanguageSettingsEditableProvider; + boolean isEditableForPrefs = page.isForPrefs() && rawProvider instanceof ILanguageSettingsEditableProvider; + boolean isEditable = isEditableForProject || isEditableForPrefs; + currentOptionsPage.getControl().setEnabled(isEditable); + currentOptionsPage.setVisible(true); + + compositeOptionsPage.setEnabled(isEditable); +// compositeOptionsPage.layout(true); + } + } + + + private void saveCheckedProviders(Object selectedElement) { + if (page.isForProject()) { + Object[] checked = tableProvidersViewer.getCheckedElements(); + List providers = new ArrayList(checked.length); + for (Object element : checked) { + ILanguageSettingsProvider provider = (ILanguageSettingsProvider)element; + providers.add(provider); + } + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + cfgDescription.setLanguageSettingProviders(providers); + + if (selectedElement!=null) { + tableProvidersViewer.update(selectedElement, null); + if (selectedElement instanceof ILanguageSettingsProvider) { + ILanguageSettingsProvider selectedProvider = (ILanguageSettingsProvider) selectedElement; + initializeOptionsPage(selectedProvider, cfgDescription); + displaySelectedOptionPage(); + } + } + } + } + + private void disableButtons() { +// buttonSetEnabled(BUTTON_RENAME, false); +// buttonSetEnabled(BUTTON_RUN, false); + buttonSetEnabled(BUTTON_CLEAR, false); + buttonSetEnabled(BUTTON_RESET, false); + buttonSetEnabled(BUTTON_MOVE_UP, false); + buttonSetEnabled(BUTTON_MOVE_DOWN, false); +// buttonSetEnabled(BUTTON_CONFIGURE, false); + } + + /** + * Updates state for all buttons. Called when table selection changes. + */ + @Override + protected void updateButtons() { + ILanguageSettingsProvider provider = getSelectedProvider(); + boolean isProviderSelected =provider!=null; + boolean canForWorkspace = isProviderSelected && page.isForPrefs(); + boolean canForProject = isProviderSelected && page.isForProject() && !LanguageSettingsManager.isWorkspaceProvider(provider); + + int pos = tableProviders.getSelectionIndex(); + int count = tableProviders.getItemCount(); + int last = count - 1; + boolean isRangeOk = pos >= 0 && pos <= last; + + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + boolean canClear = false; + if (rawProvider instanceof ILanguageSettingsEditableProvider) { + // TODO - commented out because we need the means to restart failed Spec Detectors +// if (!((ILanguageSettingsEditableProvider) rawProvider).isEmpty()) { + canClear = canForWorkspace || canForProject; +// } + } + + boolean canReset = false; + if (rawProvider!=null && (canForWorkspace || canForProject)) { + canReset = ! LanguageSettingsManager_TBD.isEqualExtensionProvider(rawProvider); + } + + boolean canMoveUp = page.isForProject() && isProviderSelected && isRangeOk && pos!=0; + boolean canMoveDown = page.isForProject() && isProviderSelected && isRangeOk && pos!=last; + +// buttonSetEnabled(BUTTON_RENAME, false); +// buttonSetEnabled(BUTTON_RUN, false); + buttonSetEnabled(BUTTON_CLEAR, canClear); + buttonSetEnabled(BUTTON_RESET, canReset); + buttonSetEnabled(BUTTON_MOVE_UP, canMoveUp); + buttonSetEnabled(BUTTON_MOVE_DOWN, canMoveDown); + } + + /** + * Displays warning message - if any - for selected language settings entry. + */ + private void updateStatusLine() { +// IStatus status=null; +// fStatusLine.setErrorStatus(status); + } + + /** + * Handle buttons + */ + @Override + public void buttonPressed(int buttonIndex) { + ILanguageSettingsProvider selectedProvider = getSelectedProvider(); + + switch (buttonIndex) { +// case BUTTON_RENAME: +// performRename(selectedProvider); +// break; +// case BUTTON_RUN: +// performRun(selectedProvider); +// break; + case BUTTON_CLEAR: + performClear(selectedProvider); + break; + case BUTTON_RESET: + performReset(selectedProvider); + break; + case BUTTON_MOVE_UP: + performMoveUp(selectedProvider); + break; + case BUTTON_MOVE_DOWN: + performMoveDown(selectedProvider); + break; + default: + } + } + + private void performClear(ILanguageSettingsProvider selectedProvider) { + if (isWorkingCopy(selectedProvider)) { + if (selectedProvider instanceof ILanguageSettingsEditableProvider) { + ILanguageSettingsEditableProvider editableProvider = (ILanguageSettingsEditableProvider) selectedProvider; + editableProvider.clear(); + tableProvidersViewer.update(selectedProvider, null); + } + } else { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(selectedProvider); + if (rawProvider instanceof ILanguageSettingsEditableProvider) { + ILanguageSettingsEditableProvider editableProvider = (ILanguageSettingsEditableProvider) rawProvider; + + try { + ILanguageSettingsEditableProvider newProvider = editableProvider.cloneShallow(); + replaceSelectedProvider(newProvider); + + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + initializeOptionsPage(newProvider, cfgDescription); + displaySelectedOptionPage(); + + } catch (CloneNotSupportedException e) { + CUIPlugin.log("Error cloning provider " + editableProvider.getId(), e); + return; + } + } + + } + updateButtons(); + } + + private void performReset(ILanguageSettingsProvider selectedProvider) { + ILanguageSettingsProvider newProvider = LanguageSettingsManager.getExtensionProviderCopy(selectedProvider.getId()); + replaceSelectedProvider(newProvider); + + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + initializeOptionsPage(newProvider, cfgDescription); + displaySelectedOptionPage(); + updateButtons(); + } + + private boolean isWorkingCopy(ILanguageSettingsProvider provider) { + boolean isWorkingCopy = false; + if (page.isForPrefs()) { + isWorkingCopy = ! LanguageSettingsManager.isWorkspaceProvider(provider); + } else { + if (!LanguageSettingsManager.isWorkspaceProvider(provider)) { + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + List initialProviders = initialProvidersByCfg.get(cfgDescription.getId()); + isWorkingCopy = ! initialProviders.contains(provider); + } + + } + return isWorkingCopy; + } + + private void performMoveUp(ILanguageSettingsProvider selectedProvider) { + int pos = presentedProviders.indexOf(selectedProvider); + if (pos > 0) { + moveProvider(pos, pos-1); + } + } + + private void performMoveDown(ILanguageSettingsProvider selectedProvider) { + int pos = presentedProviders.indexOf(selectedProvider); + int last = presentedProviders.size() - 1; + if (pos >= 0 && pos < last) { + moveProvider(pos, pos+1); + } + } + + private void moveProvider(int oldPos, int newPos) { + Collections.swap(presentedProviders, oldPos, newPos); + + updateProvidersTable(); + tableProviders.setSelection(newPos); + + saveCheckedProviders(null); + updateButtons(); + } + + /** + * Called when configuration changed + */ + @Override + public void updateData(ICResourceDescription rcDes) { + if (!canBeVisible()) + return; + + if (rcDes!=null) { + if (page.isMultiCfg()) { + setAllVisible(false, null); + return; + } else { + setAllVisible(true, null); + } + + if (enableProvidersCheckBox!=null && masterPropertyPage!=null) { + boolean enabled = masterPropertyPage.isLanguageSettingsProvidersEnabled(); + enableProvidersCheckBox.setSelection(enabled); + enableControls(enabled); + } + } + + // for Preference page initialize providers list just once as no configuration here to change + // and re-initializing could ruins modified providers in case of switching tabs or pages + if (!page.isForPrefs() || presentedProviders==null) { + initializeProviders(); + } + updateProvidersTable(); + updateButtons(); + } + + @Override + protected void performDefaults() { + if (enableProvidersCheckBox==null || enableProvidersCheckBox.getSelection()==false) + return; + + if (page.isForPrefs() || page.isForProject()) { + if (MessageDialog.openQuestion(usercomp.getShell(), + Messages.LanguageSettingsProviderTab_TitleResetProviders, + Messages.LanguageSettingsProviderTab_AreYouSureToResetProviders)) { + + if (page.isForProject()) { + ICConfigurationDescription cfgDescription = getConfigurationDescription(); + List cfgProviders = new ArrayList(cfgDescription.getLanguageSettingProviders()); + boolean atLeastOneChanged = false; + for (int i=0;i providers = new ArrayList(presentedProviders); + for (int i=0;i destProviders = new ArrayList(); + + List srcProviders = srcCfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider pro : srcProviders) { + // TODO: clone + destProviders.add(pro); + } + + destCfgDescription.setLanguageSettingProviders(destProviders); + } + + if (!page.isForPrefs()) { + ICConfigurationDescription sd = srcRcDescription.getConfiguration(); + ICConfigurationDescription dd = destRcDescription.getConfiguration(); + List newProviders = sd.getLanguageSettingProviders(); + dd.setLanguageSettingProviders(newProviders); + } + + performOK(); + } + + @Override + protected void performOK() { + if (!page.isForPrefs()) { + // FIXME: for now only handles current configuration + ICResourceDescription rcDesc = getResDesc(); + IResource rc = getResource(); + ICConfigurationDescription cfgDescription = rcDesc.getConfiguration(); + + List destProviders = new ArrayList(); + List providers = cfgDescription.getLanguageSettingProviders(); + for (ILanguageSettingsProvider pro : providers) { + // TODO: clone + destProviders.add(pro); + } + cfgDescription.setLanguageSettingProviders(destProviders); + } + + // Build Settings page + if (page.isForPrefs()) { + try { + LanguageSettingsManager.setWorkspaceProviders(presentedProviders); + } catch (CoreException e) { + CUIPlugin.log("Error setting user defined providers", e); + } + initializeProviders(); + } + + if (page.isForProject() && enableProvidersCheckBox!=null) { + boolean enabled = enableProvidersCheckBox.getSelection(); + if (masterPropertyPage!=null) + enabled = masterPropertyPage.isLanguageSettingsProvidersEnabled(); + ScannerDiscoveryLegacySupport.setLanguageSettingsProvidersFunctionalityEnabled(page.getProject(), enabled); + enableProvidersCheckBox.setSelection(enabled); + } + + Collection optionPages = optionsPageMap.values(); + for (ICOptionPage op : optionPages) { + try { + op.performApply(null); + } catch (CoreException e) { + CUIPlugin.log("Error applying options page", e); + } + } + + trackInitialSettings(); + updateData(getResDesc()); + } + + @Override + public boolean canBeVisible() { + if (CDTPrefUtil.getBool(CDTPrefUtil.KEY_NO_SHOW_PROVIDERS)) + return false; + + return page.isForPrefs() || page.isForProject(); + } + + private ILanguageSettingsProvider findRawProvider(String id, List providers) { + for (ILanguageSettingsProvider provider : providers) { + if (provider.getId().equals(id)) { + provider = LanguageSettingsManager.getRawProvider(provider); + return provider; + } + } + return null; + } + + private ILanguageSettingsProvider findProvider(String id, List providers) { + for (ILanguageSettingsProvider provider : providers) { + if (provider.getId().equals(id)) { + return provider; + } + } + return null; + } + + public ILanguageSettingsProvider getProvider(String id) { + return findProvider(id, presentedProviders); + } + + private int getProviderIndex(String id, List providers) { + int pos = 0; + for (ILanguageSettingsProvider p : providers) { + if (p.getId().equals(id)) + return pos; + pos++; + } + return -1; + } + +// private void informOptionPages(boolean apply) { +// Collection pages = optionsPageMap.values(); +// for (ICOptionPage dynamicPage : pages) { +// if (dynamicPage!=null && dynamicPage.isValid() && dynamicPage.getControl() != null) { +// try { +// if (apply) +// dynamicPage.performApply(new NullProgressMonitor()); +// else +// dynamicPage.performDefaults(); +// } catch (CoreException e) { +// CUIPlugin.log("ErrorParsTab.error.OnApplyingSettings", e); +// } +// } +// } +//} + +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProvidersLabelProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProvidersLabelProvider.java new file mode 100644 index 00000000000..7eb9160364e --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/LanguageSettingsProvidersLabelProvider.java @@ -0,0 +1,122 @@ +/******************************************************************************* + * Copyright (c) 2010, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import java.net.URL; + +import org.eclipse.jface.viewers.IDecoration; +import org.eclipse.jface.viewers.LabelProvider; +import org.eclipse.swt.graphics.Image; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; +import org.eclipse.cdt.ui.CDTSharedImages; + + +/** + * Label provider for language settings providers. + * + */ +class LanguageSettingsProvidersLabelProvider extends LabelProvider { + private static final String TEST_PLUGIN_ID_PATTERN = "org.eclipse.cdt.*.tests.*"; //$NON-NLS-1$ + private static final String OOPS = "OOPS"; //$NON-NLS-1$ + + /** + * Returns base image key (for image without overlay). + */ + protected String getBaseKey(ILanguageSettingsProvider provider) { + String imageKey = null; + // try id-association + String id = provider.getId(); + URL url = LanguageSettingsProviderAssociation.getImageUrl(id); + // try class-association + if (url==null) { + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + if (rawProvider!=null) { + url = LanguageSettingsProviderAssociation.getImage(rawProvider.getClass()); + } + } + if (url!=null) { + imageKey = url.toString(); + } + + if (imageKey==null) { + if (id.matches(TEST_PLUGIN_ID_PATTERN)) { + imageKey = CDTSharedImages.IMG_OBJS_CDT_TESTING; + } else { + imageKey = CDTSharedImages.IMG_OBJS_EXTENSION; + } + } + return imageKey; + } + + /** + * Returns keys for image overlays. Returning {@code null} is not allowed. + */ + protected String[] getOverlayKeys(ILanguageSettingsProvider provider) { + String[] overlayKeys = new String[5]; + { // TODO temporary for debugging +// boolean isSpecial = provider.getId().equals(LegacySupport.MBS_LANGUAGE_SETTINGS_PROVIDER); + + ILanguageSettingsProvider rawProvider = LanguageSettingsManager.getRawProvider(provider); + if (rawProvider instanceof LanguageSettingsSerializable) { + if (((LanguageSettingsSerializable)rawProvider).isEmpty()) { + overlayKeys[IDecoration.BOTTOM_RIGHT] = CDTSharedImages.IMG_OVR_EMPTY; + } + } + + if (LanguageSettingsManager.isWorkspaceProvider(provider) /*&& !isSpecial*/) { + overlayKeys[IDecoration.TOP_LEFT] = CDTSharedImages.IMG_OVR_GLOBAL; +// overlayKeys[IDecoration.TOP_LEFT] = CDTSharedImages.IMG_OVR_REFERENCE; +// overlayKeys[IDecoration.TOP_RIGHT] = CDTSharedImages.IMG_OVR_PARENT; +// overlayKeys[IDecoration.BOTTOM_RIGHT] = CDTSharedImages.IMG_OVR_LINK; + } else { +// overlayKeys[IDecoration.TOP_LEFT] = CDTSharedImages.IMG_OVR_CONFIGURATION; +// overlayKeys[IDecoration.TOP_LEFT] = CDTSharedImages.IMG_OVR_INDEXED; +// overlayKeys[IDecoration.TOP_LEFT] = CDTSharedImages.IMG_OVR_CONTEXT; + +// overlayKeys[IDecoration.TOP_LEFT] = CDTSharedImages.IMG_OVR_PROJECT; + } + + } + return overlayKeys; + } + + @Override + public Image getImage(Object element) { + if (element instanceof ILanguageSettingsProvider) { + ILanguageSettingsProvider provider = (ILanguageSettingsProvider)element; + String imageKey = getBaseKey(provider); + String[] overlayKeys = getOverlayKeys(provider); + return CDTSharedImages.getImageOverlaid(imageKey, overlayKeys); + } + return null; + } + + @Override + public String getText(Object element) { + if (element instanceof ILanguageSettingsProvider) { + ILanguageSettingsProvider provider = (ILanguageSettingsProvider) element; + String name = provider.getName(); + if (name!=null) { + if (LanguageSettingsManager.isWorkspaceProvider(provider)) { + name = name + " [ Shared ]"; + } + return name; + } + String id = provider.getId(); + return "[ Not accessible id="+id+" ]"; + } + return OOPS; + } +} \ No newline at end of file diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/Page_LanguageSettingsProviders.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/Page_LanguageSettingsProviders.java new file mode 100644 index 00000000000..a27cc162494 --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/Page_LanguageSettingsProviders.java @@ -0,0 +1,42 @@ +/******************************************************************************* + * Copyright (c) 2007, 2010 Intel Corporation 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: + * Intel Corporation - initial API and implementation + *******************************************************************************/ +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport; +import org.eclipse.cdt.ui.newui.AbstractPage; +import org.eclipse.cdt.ui.newui.ICPropertyTab; + + + +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ +public class Page_LanguageSettingsProviders extends AbstractPage { + private Boolean isLanguageSettingsProvidersEnabled = null; + + @Override + protected boolean isSingle() { + return false; + } + + public boolean isLanguageSettingsProvidersEnabled() { + if (isLanguageSettingsProvidersEnabled==null) { + isLanguageSettingsProvidersEnabled = ScannerDiscoveryLegacySupport.isLanguageSettingsProvidersFunctionalityEnabled(getProject()); + } + return isLanguageSettingsProvidersEnabled; + } + + public void setLanguageSettingsProvidersEnabled(boolean enable) { + isLanguageSettingsProvidersEnabled = enable; + forEach(ICPropertyTab.UPDATE,getResDesc()); + } +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/UserLanguageSettingsProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/UserLanguageSettingsProvider.java new file mode 100644 index 00000000000..68fc50e431e --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/language/settings/providers/UserLanguageSettingsProvider.java @@ -0,0 +1,47 @@ +/******************************************************************************* + * Copyright (c) 2009, 2009 Andrew Gvozdev (Quoin Inc.) 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: + * Andrew Gvozdev (Quoin Inc.) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.ui.language.settings.providers; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsSerializable; + +/** + * Provider to support user interface for language settings. The important difference with + * {@link LanguageSettingsSerializable} is that it implements {@link ILanguageSettingsEditableProvider}. + * + */ +public class UserLanguageSettingsProvider extends LanguageSettingsSerializable implements ILanguageSettingsEditableProvider { + + @Override + public int hashCode() { + return super.hashCode()*13 + 1; + } + + @Override + public boolean equals(Object o) { + if (o instanceof UserLanguageSettingsProvider) { + return super.equals(o); + } + return false; + } + + @Override + public UserLanguageSettingsProvider cloneShallow() throws CloneNotSupportedException { + return (UserLanguageSettingsProvider)super.cloneShallow(); + } + + @Override + public UserLanguageSettingsProvider clone() throws CloneNotSupportedException { + return (UserLanguageSettingsProvider)super.clone(); + } + +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/LanguageSettingsImages.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/LanguageSettingsImages.java new file mode 100644 index 00000000000..32f06aad27a --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/LanguageSettingsImages.java @@ -0,0 +1,195 @@ +/******************************************************************************* + * Copyright (c) 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.ui.newui; + +import org.eclipse.core.resources.IResource; +import org.eclipse.core.resources.ResourcesPlugin; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Status; +import org.eclipse.jface.viewers.IDecoration; +import org.eclipse.swt.graphics.Image; + +import org.eclipse.cdt.core.settings.model.ACPathEntry; +import org.eclipse.cdt.core.settings.model.CMacroEntry; +import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.cdt.ui.CUIPlugin; + +/** + * Helper class to provide unified images for {@link ICLanguageSettingEntry}. + */ +public class LanguageSettingsImages { + public static Image getImage(int kind, int flags, boolean isProjectRelative) { + String imageKey = getImageKey(kind, flags, isProjectRelative); + if (imageKey!=null) { +// String overlayKey = getErrorOverlayKey(kind, flags, isProjectRelative); +// if (overlayKey!=null) { +// return getOverlaidImage(imageKey, overlayKey, IDecoration.BOTTOM_LEFT); +// } + return CDTSharedImages.getImage(imageKey); + } + return null; + } + + /** + * Returns image for the given entry from internally managed repository including + * necessary overlays. This method is shortcut for {@link #getImage(ICLanguageSettingEntry, String)} + * when no project is available. + * + * @param entry - language settings entry to get an image for. + * @return the image for the entry with appropriate overlays. + */ + public static Image getImage(ICLanguageSettingEntry entry) { + return getImage(entry, null); + } + + /** + * Returns image for the given entry from internally managed repository including + * necessary overlays. + * + * @param entry - language settings entry to get an image for. + * @param projectName - pass project name if available. That lets to put "project" metaphor + * on the image. Pass {@code null} if no project name is available. + * @return the image for the entry with appropriate overlays. + */ + public static Image getImage(ICLanguageSettingEntry entry, String projectName) { + int kind = entry.getKind(); + boolean isWorkspacePath = (entry.getFlags() & ICSettingEntry.VALUE_WORKSPACE_PATH) != 0; + String path = entry.getName(); + boolean isProjectRelative = projectName!=null && isWorkspacePath && path.startsWith(IPath.SEPARATOR+projectName+IPath.SEPARATOR); + // FIXME + isProjectRelative = isProjectRelative || (isWorkspacePath && path.charAt(0)!=IPath.SEPARATOR); + int flags = entry.getFlags(); + String imageKey = getImageKey(kind, flags, isProjectRelative); + if (imageKey!=null) { + if ((entry.getFlags()&ICSettingEntry.UNDEFINED) == ICSettingEntry.UNDEFINED) + return CDTSharedImages.getImageOverlaid(imageKey, CDTSharedImages.IMG_OVR_INACTIVE, IDecoration.BOTTOM_LEFT); + + if (entry instanceof ACPathEntry) { + String overlayKey=null; + IStatus status = getStatus(entry); + switch (status.getSeverity()) { + case IStatus.ERROR: + overlayKey = CDTSharedImages.IMG_OVR_ERROR; + break; + case IStatus.WARNING: + overlayKey = CDTSharedImages.IMG_OVR_WARNING; + break; + case IStatus.INFO: + overlayKey = CDTSharedImages.IMG_OVR_WARNING; + break; + } + return CDTSharedImages.getImageOverlaid(imageKey, overlayKey, IDecoration.BOTTOM_LEFT); + } + return CDTSharedImages.getImage(imageKey); + } + return null; + } + + /** + * Checking if the entry points to existing or accessible location. + */ + private static boolean isLocationOk(ACPathEntry entry) { + // have to trust paths which contain variables + if (entry.getName().contains("${")) //$NON-NLS-1$ + return true; + + boolean exists = true; + boolean isWorkspacePath = (entry.getFlags() & ICSettingEntry.VALUE_WORKSPACE_PATH) != 0; + if (isWorkspacePath) { + IPath path = new Path(entry.getValue()); + IResource rc = ResourcesPlugin.getWorkspace().getRoot().findMember(path); + exists = rc!=null && rc.isAccessible(); + } else { + String pathname = entry.getName(); + java.io.File file = new java.io.File(pathname); + exists = file.exists(); + } + return exists; + } + + /** + * Defines status object for the status message line. + * + * @param entry - the entry to check status on. + * @return a status object defining severity and message. + */ + public static IStatus getStatus(ICLanguageSettingEntry entry) { + if (entry instanceof ACPathEntry) { + ACPathEntry acEntry = (ACPathEntry)entry; + IPath path = new Path(acEntry.getName()); + if (!path.isAbsolute()) { + String msg = "Using relative paths is ambiguous and not recommended. It can cause unexpected side-effects."; + return new Status(IStatus.INFO, CUIPlugin.PLUGIN_ID, msg); + } + if (!isLocationOk(acEntry)) { + String msg; + if (acEntry.isFile()) + msg = "The selected file does not exist or not accessible."; + else + msg = "The selected folder does not exist or not accessible."; + return new Status(IStatus.WARNING, CUIPlugin.PLUGIN_ID, msg); + } + + } + return Status.OK_STATUS; + } + + /** + * @return the base key for the image. + */ + private static String getImageKey(int kind, int flag, boolean isProjectRelative) { + String imageKey = null; + + boolean isWorkspacePath = (flag & ICSettingEntry.VALUE_WORKSPACE_PATH) != 0; + boolean isBuiltin = (flag & ICSettingEntry.BUILTIN) != 0; + boolean isFramework = (flag & ICSettingEntry.FRAMEWORKS_MAC) != 0; + + switch (kind) { + case ICSettingEntry.INCLUDE_PATH: + if (isWorkspacePath) + if (isProjectRelative) + imageKey = CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER_PROJECT; + else + imageKey = CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER_WORKSPACE; + else if (isFramework) + imageKey = CDTSharedImages.IMG_OBJS_FRAMEWORKS_FOLDER; + else if (isBuiltin) + imageKey = CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER_SYSTEM; + else + imageKey = CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER; + break; + case ICSettingEntry.INCLUDE_FILE: + imageKey = CDTSharedImages.IMG_OBJS_TUNIT_HEADER; + break; + case ICSettingEntry.MACRO: + imageKey = CDTSharedImages.IMG_OBJS_MACRO; + break; + case ICSettingEntry.MACRO_FILE: + imageKey = CDTSharedImages.IMG_OBJS_MACROS_FILE; + break; + case ICSettingEntry.LIBRARY_PATH: + imageKey = CDTSharedImages.IMG_OBJS_LIBRARY_FOLDER; + break; + case ICSettingEntry.LIBRARY_FILE: + imageKey = CDTSharedImages.IMG_OBJS_LIBRARY; + break; + } + if (imageKey==null) + imageKey = CDTSharedImages.IMG_OBJS_UNKNOWN_TYPE; + return imageKey; + } + +} diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.java index fe48a3b97b8..ba35da75ca9 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.java @@ -84,6 +84,7 @@ public class Messages extends NLS { public static String CDTCommonProjectWizard_creatingProject; public static String CDTMainWizardPage_0; public static String CDTMainWizardPage_1; + public static String CDTMainWizardPage_TrySD90; public static String CLocationOutputTab_0; public static String CLocationSourceTab_0; public static String CLocationTab_0; @@ -186,6 +187,16 @@ public class Messages extends NLS { public static String IncludeTab_2; public static String IncludeTab_export; public static String IncludeTab_import; + public static String LanguageSettingsProviderTab_AreYouSureToResetProviders; + public static String LanguageSettingsProviderTab_Clear; + public static String LanguageSettingsProviderTab_Configure; + public static String LanguageSettingsProviderTab_ErrorPerformingDefaults; + public static String LanguageSettingsProviderTab_ProviderOptions; +// public static String LanguageSettingsProviderTab_Run; + public static String LanguageSettingsProviderTab_SettingEntries; + public static String LanguageSettingsProviderTab_SettingEntriesTooltip; + public static String LanguageSettingsProviderTab_ShowEntries; + public static String LanguageSettingsProviderTab_TitleResetProviders; public static String LanguagesTab_0; public static String LanguagesTab_1; public static String LibraryPathTab_1; diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.properties b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.properties index 80f166a65c7..e26bd03bb53 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.properties +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/Messages.properties @@ -166,6 +166,16 @@ IncludeDialog_0=Directory: IncludeDialog_1=File: IncludeDialog_2=Add to all configurations IncludeDialog_3=Add to all languages +LanguageSettingsProviderTab_AreYouSureToResetProviders=Are you sure you want to reset all customized language settings providers? +LanguageSettingsProviderTab_Clear=Clear Entries +LanguageSettingsProviderTab_Configure=Configure +LanguageSettingsProviderTab_ErrorPerformingDefaults=Error restoring defaults for language settings providers +LanguageSettingsProviderTab_ProviderOptions=Language Settings Provider Options +#LanguageSettingsProviderTab_Run=Run +LanguageSettingsProviderTab_SettingEntries=Setting Entries +LanguageSettingsProviderTab_SettingEntriesTooltip=Setting Entries +LanguageSettingsProviderTab_ShowEntries=Show Entries +LanguageSettingsProviderTab_TitleResetProviders=Reset Language Settings Providers LanguagesTab_0=Content type LanguagesTab_1=Language LibraryPathTab_1=Add... @@ -269,6 +279,7 @@ StringVariableSelectionDialog_message=&Choose a variable (? = any character, * = StringVariableSelectionDialog_columnDescription=&Variable Description: CDTMainWizardPage_0=Project name cannot contain '\#' symbol CDTMainWizardPage_1=Project category is selected. Expand the category and select a concrete project type. +CDTMainWizardPage_TrySD90=I want to try new upcoming version of Scanner Discovery in CDT 9.0 (v.0.1.0) CProjectWizard_0=Add C Project Nature CCProjectWizard_0=Add CC Project Nature WorkingSetConfigAction_21=Building project diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/StatusMessageLine.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/StatusMessageLine.java new file mode 100644 index 00000000000..aacedf2cbcb --- /dev/null +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/newui/StatusMessageLine.java @@ -0,0 +1,81 @@ +/******************************************************************************* + * Copyright (c) 2010 Andrew Gvozdev 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: + * Andrew Gvozdev - Initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.internal.ui.newui; + +import org.eclipse.core.runtime.IStatus; +import org.eclipse.jface.dialogs.Dialog; +import org.eclipse.jface.resource.JFaceResources; +import org.eclipse.swt.SWT; +import org.eclipse.swt.custom.CLabel; +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.widgets.Composite; + +/** + * A message line displaying a status. + * See also org.eclipse.jface.dialogs.StatusDialog.MessageLine. + */ +public class StatusMessageLine { + private CLabel fLabel; + + /** + * Constructor. + * + * @param parent - parent element. + * @param style - the style of the control. Refer to {@link CLabel#CLabel(Composite, int)}. + * @param span - how many columns it should span. + */ + public StatusMessageLine(Composite parent, int style, int span) { + fLabel = new CLabel(parent, style); + if (span!=1) { + GridData gd = new GridData(SWT.FILL, SWT.NONE, true, false); + gd.horizontalSpan = span; + fLabel.setLayoutData(gd); + } + } + + /** + * Find an image associated with the status. + */ + private Image findImage(IStatus status) { + if (status.isOK()) { + return null; + } else if (status.matches(IStatus.ERROR)) { + return JFaceResources.getImage(Dialog.DLG_IMG_MESSAGE_ERROR); + } else if (status.matches(IStatus.WARNING)) { + return JFaceResources.getImage(Dialog.DLG_IMG_MESSAGE_WARNING); + } else if (status.matches(IStatus.INFO)) { + return JFaceResources.getImage(Dialog.DLG_IMG_MESSAGE_INFO); + } + return null; + } + + /** + * Assign {@link IStatus} object to the message line. The status should provide + * severity for the icon and message to display. + * + * @param status - status object for the message line. + */ + public void setErrorStatus(IStatus status) { + if (status != null && !status.isOK()) { + String message = status.getMessage(); + if (message != null && message.length() > 0) { + fLabel.setText(message); + fLabel.setImage(findImage(status)); + fLabel.layout(); + return; + } + } + fLabel.setText(""); //$NON-NLS-1$ + fLabel.setImage(null); + } +} \ No newline at end of file diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java index 17232c410cc..e576c176e62 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java @@ -29,6 +29,7 @@ import org.eclipse.swt.graphics.Point; import org.eclipse.swt.graphics.Rectangle; import org.eclipse.ui.texteditor.MarkerUtilities; +import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager_TBD; import org.eclipse.cdt.core.model.CModelException; import org.eclipse.cdt.core.model.CoreModel; import org.eclipse.cdt.core.model.ICElement; @@ -387,7 +388,8 @@ public class ProblemsLabelDecorator implements ILabelDecorator, ILightweightLabe if (cfgDescription != null) { IPath path = rc.getProjectRelativePath(); ICResourceDescription rcDescription = cfgDescription.getResourceDescription(path, true); - if (rcDescription != null) + boolean isLSCustomized = LanguageSettingsManager_TBD.isCustomizedResource(cfgDescription, rc); + if (rcDescription != null || isLSCustomized) result |= TICK_CONFIGURATION; } } diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTSharedImages.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTSharedImages.java index 73cbf49068b..95c5d4618d5 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTSharedImages.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTSharedImages.java @@ -116,6 +116,7 @@ public class CDTSharedImages { public static final String IMG_OBJS_INCLUDES_FOLDER_WORKSPACE = "icons/obj16/wsp_includefolder.gif"; //$NON-NLS-1$ public static final String IMG_OBJS_QUOTE_INCLUDES_FOLDER = "icons/obj16/hfolder_quote_obj.gif"; //$NON-NLS-1$ public static final String IMG_OBJS_INCLUDES_FOLDER_SYSTEM = "icons/obj16/fldr_sys_obj.gif"; //$NON-NLS-1$ + public static final String IMG_OBJS_FRAMEWORKS_FOLDER = "icons/obj16/frameworks.gif"; //$NON-NLS-1$ public static final String IMG_OBJS_MACROS_FILE= "icons/obj16/macros_file.gif"; //$NON-NLS-1$ public static final String IMG_OBJS_LIBRARY_FOLDER= "icons/obj16/fldr_lib_obj.gif"; // $NON-NLS-1$ //$NON-NLS-1$ public static final String IMG_OBJS_ORDER = "icons/obj16/cp_order_obj.gif"; //$NON-NLS-1$ @@ -208,6 +209,23 @@ public class CDTSharedImages { public static final String IMG_VIEW_PIN_ACTION_B = "icons/obj16/toolbar_pinned_b.gif"; //$NON-NLS-1$ public static final String IMG_VIEW_PIN_ACTION_MULTI = "icons/obj16/toolbar_pinned_multi.gif"; //$NON-NLS-1$ + // Language Settings Images + public static final String IMG_OBJS_LANG_SETTINGS_PROVIDER = "icons/obj16/ls_entries_provider.gif"; //$NON-NLS-1$ + public static final String IMG_ETOOL_PROJECT = "icons/etool16/prj_obj.gif"; //$NON-NLS-1$ + + public static final String IMG_OVR_GLOBAL = "icons/ovr16/global_ovr.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_IMPORT = "icons/ovr16/import_co.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_LINK = "icons/ovr16/link_ovr.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_CONFIGURATION = "icons/ovr16/cfg_ovr.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_PARENT = "icons/ovr16/path_inherit_co.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_INDEXED = "icons/ovr16/indexedFile.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_REFERENCE = "icons/ovr16/referencedby_co.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_PROJECT = "icons/ovr16/project_co.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_CONTEXT = "icons/ovr16/overlay-has-context.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_LOCK = "icons/ovr16/lock_ovr.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_EDITED = "icons/ovr16/edited_ov.gif"; //$NON-NLS-1$ + public static final String IMG_OVR_EMPTY = "icons/ovr16/empty_ovr.png"; //$NON-NLS-1$ + /** * The method finds URL of the image corresponding to the key which could be project-relative path * of the image in org.eclipse.cdt.ui plugin or a (previously registered) string representation of URL diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractCPropertyTab.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractCPropertyTab.java index aaa8b02edf1..412011c2196 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractCPropertyTab.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractCPropertyTab.java @@ -94,6 +94,7 @@ public abstract class AbstractCPropertyTab implements ICPropertyTab { public static final String EDIT_STR = Messages.FileListControl_edit; public static final String MOVEUP_STR = Messages.FileListControl_moveup; public static final String MOVEDOWN_STR = Messages.FileListControl_movedown; + public static final String PROJECTBUTTON_NAME = "Project..."; public static final String WORKSPACEBUTTON_NAME = Messages.FileListControl_button_workspace; public static final String FILESYSTEMBUTTON_NAME = Messages.FileListControl_button_fs; public static final String VARIABLESBUTTON_NAME = Messages.AbstractCPropertyTab_1; @@ -453,6 +454,12 @@ public abstract class AbstractCPropertyTab implements ICPropertyTab { public static String getWorkspaceFileDialog(Shell shell, String text) { return getWorkspaceDialog(shell, text, false, null); } + public static String getProjectDirDialog(Shell shell, String text, IProject prj) { + return getWorkspaceDialog(shell, text, true, prj); + } + public static String getProjectFileDialog(Shell shell, String text, IProject prj) { + return getWorkspaceDialog(shell, text, false, prj); + } private static String getWorkspaceDialog(Shell shell, String text, boolean dir, IProject prj) { String currentPathText; diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractLangsListTab.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractLangsListTab.java index 3dde6555933..d0dabdc47bc 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractLangsListTab.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractLangsListTab.java @@ -9,6 +9,7 @@ * Intel Corporation - initial API and implementation * IBM Corporation * Markus Schorn (Wind River Systems) + * Andrew Gvozdev (Quoin Inc.) *******************************************************************************/ package org.eclipse.cdt.ui.newui; @@ -18,6 +19,7 @@ import java.util.Comparator; import java.util.LinkedList; import java.util.List; +import org.eclipse.core.resources.IProject; import org.eclipse.jface.resource.JFaceResources; import org.eclipse.jface.viewers.IFontProvider; import org.eclipse.jface.viewers.IStructuredContentProvider; @@ -65,9 +67,10 @@ import org.eclipse.cdt.core.settings.model.ICSettingBase; import org.eclipse.cdt.core.settings.model.ICSettingEntry; import org.eclipse.cdt.core.settings.model.MultiLanguageSetting; import org.eclipse.cdt.core.settings.model.util.CDataUtil; -import org.eclipse.cdt.ui.CDTSharedImages; +import org.eclipse.cdt.internal.ui.newui.LanguageSettingsImages; import org.eclipse.cdt.internal.ui.newui.Messages; +import org.eclipse.cdt.internal.ui.newui.StatusMessageLine; public abstract class AbstractLangsListTab extends AbstractCPropertyTab { protected Table table; @@ -77,6 +80,8 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { protected Button showBIButton; protected boolean toAllCfgs = false; protected boolean toAllLang = false; + private StatusMessageLine fStatusLine; + /** @deprecated as of CDT 8.0. {@code linkStringListMode} is used instead. */ @Deprecated protected Label lb1, lb2; @@ -120,12 +125,6 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { private static final Comparator comp = CDTListComparator.getInstance(); private static String selectedLanguage; - private final static Image IMG_FOLDER = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_FOLDER); - private final static Image IMG_INCLUDES_FOLDER = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER); - private final static Image IMG_BUILTIN_FOLDER = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER_SYSTEM); - private final static Image IMG_WORKSPACE = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_WORKSPACE); - private final static Image IMG_INCLUDES_FOLDER_WORKSPACE = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_INCLUDES_FOLDER_WORKSPACE); - private final static Image IMG_MACRO = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_MACRO); private static final int[] DEFAULT_SASH_WEIGHTS = new int[] { 10, 30 }; @Override @@ -186,11 +185,12 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {} }); - tv.setLabelProvider(new RichLabelProvider()); + tv.setLabelProvider(new LanguageSettingsEntriesLabelProvider()); table.addSelectionListener(new SelectionAdapter() { @Override public void widgetSelected(SelectionEvent e) { + updateStatusLine(); updateButtons(); } @@ -211,6 +211,8 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { setColumnToFit(); }}); + fStatusLine = new StatusMessageLine(usercomp, SWT.LEFT, 2); + showBIButton = setupCheck(usercomp, Messages.AbstractLangsListTab_ShowBuiltin, 1, GridData.GRAB_HORIZONTAL); gd = (GridData) showBIButton.getLayoutData(); showBIButton.addSelectionListener(new SelectionAdapter() { @@ -233,6 +235,17 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { updateData(getResDesc()); } + /** + * @return selected entry when only one is selected or {@code null}. + */ + private ICLanguageSettingEntry getSelectedEntry() { + int index = table.getSelectionIndex(); + if (index<0 || table.getSelectionIndices().length!=1) + return null; + + return (ICLanguageSettingEntry)(table.getItem(index).getData()); + } + /** * Used to display UI control for multiple configurations string list mode * (see Multiple Configurations Edit Preference page). @@ -243,6 +256,14 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { stringListModeControl.updateStringListModeControl(); } + /** + * Displays warning message - if any - for selected language settings entry. + * Multiline selection is not supported. + */ + private void updateStatusLine() { + fStatusLine.setErrorStatus(LanguageSettingsImages.getStatus(getSelectedEntry())); + } + /** * Updates state for all buttons * Called when table selection changes. @@ -351,6 +372,7 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { } updateStringListModeControl(); + updateStatusLine(); updateButtons(); } @@ -698,70 +720,63 @@ public abstract class AbstractLangsListTab extends AbstractCPropertyTab { } // Extended label provider - private class RichLabelProvider extends LabelProvider implements IFontProvider, ITableLabelProvider /*, IColorProvider*/{ - public RichLabelProvider(){} + private class LanguageSettingsEntriesLabelProvider extends LabelProvider implements IFontProvider, ITableLabelProvider /*, IColorProvider*/{ @Override public Image getImage(Object element) { return getColumnImage(element, 0); } + @Override public Image getColumnImage(Object element, int columnIndex) { - if (columnIndex > 0) return null; - if (! (element instanceof ICLanguageSettingEntry)) return null; - - ICLanguageSettingEntry le = (ICLanguageSettingEntry) element; - if (le.getKind() == ICSettingEntry.MACRO) - return IMG_MACRO; - if ((le.getFlags() & ICSettingEntry.BUILTIN) != 0) - return IMG_BUILTIN_FOLDER; - - boolean isWorkspacePath = (le.getFlags() & ICSettingEntry.VALUE_WORKSPACE_PATH) != 0; - if (le.getKind() == ICSettingEntry.INCLUDE_PATH || le.getKind() == ICSettingEntry.INCLUDE_FILE) { - if (isWorkspacePath) - return IMG_INCLUDES_FOLDER_WORKSPACE; - else - return IMG_INCLUDES_FOLDER; - } else { - if (isWorkspacePath) - return IMG_WORKSPACE; - else - return IMG_FOLDER; + if (columnIndex==0 && (element instanceof ICLanguageSettingEntry)) { + ICConfigurationDescription cfg = getResDesc().getConfiguration(); + IProject project = cfg.getProjectDescription().getProject(); + return LanguageSettingsImages.getImage((ICLanguageSettingEntry) element, project.getName()); } + return null; } + @Override public String getText(Object element) { return getColumnText(element, 0); } + @Override public String getColumnText(Object element, int columnIndex) { - if (! (element instanceof ICLanguageSettingEntry)) { - return (columnIndex == 0) ? element.toString() : EMPTY_STR; - } - ICLanguageSettingEntry le = (ICLanguageSettingEntry) element; - if (columnIndex == 0) { - String s = le.getName(); - if (exported.contains(resolve(le))) - s = s + Messages.AbstractLangsListTab_ExportIndicator; - return s; - } - if (le.getKind() == ICSettingEntry.MACRO) { + if (element instanceof ICLanguageSettingEntry) { + ICLanguageSettingEntry entry = (ICLanguageSettingEntry) element; switch (columnIndex) { - case 1: return le.getValue(); + case 0: + String name = entry.getName(); + if (exported.contains(resolve(entry))) + name = name + Messages.AbstractLangsListTab_ExportIndicator; + return name; + case 1: + if (entry.getKind() == ICSettingEntry.MACRO) { + return entry.getValue(); } + return null; + } + } else if (columnIndex == 0) { + return element.toString(); } - return EMPTY_STR; + + return null; } @Override public Font getFont(Object element) { - if (! (element instanceof ICLanguageSettingEntry)) return null; - ICLanguageSettingEntry le = (ICLanguageSettingEntry) element; - if (le.isBuiltIn()) return null; // built in - if (le.isReadOnly()) // read only + if (element instanceof ICLanguageSettingEntry) { + ICLanguageSettingEntry entry = (ICLanguageSettingEntry) element; + if (entry.isBuiltIn()) + return null; + if (entry.isReadOnly()) return JFaceResources.getFontRegistry().getItalic(JFaceResources.DIALOG_FONT); // normal return JFaceResources.getFontRegistry().getBold(JFaceResources.DIALOG_FONT); } + return null; + } } public ICLanguageSetting[] getLangSetting(ICResourceDescription rcDes) { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/CDTPrefUtil.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/CDTPrefUtil.java index 4422ba202a0..58594cf3146 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/CDTPrefUtil.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/CDTPrefUtil.java @@ -33,11 +33,13 @@ import org.eclipse.cdt.internal.ui.workingsets.WorkingSetConfigurationManager; public class CDTPrefUtil { // boolean keys (KEY_NO-s are to be inverted !) public static final String KEY_NOSUPP = "wizard.show.unsupported.disable"; //$NON-NLS-1$ + public static final String KEY_NEWSD = "wizard.try.new.sd.enable"; //$NON-NLS-1$ public static final String KEY_OTHERS = "wizard.group.others.enable"; //$NON-NLS-1$ public static final String KEY_NOMNG = "properties.manage.config.disable"; //$NON-NLS-1$ public static final String KEY_DTREE = "properties.data.hierarchy.enable"; //$NON-NLS-1$ public static final String KEY_NOTOOLM = "properties.toolchain.modification.disable"; //$NON-NLS-1$ public static final String KEY_EXPORT = "properties.export.page.enable"; //$NON-NLS-1$ + public static final String KEY_NO_SHOW_PROVIDERS = "properties.providers.tab.disable"; //$NON-NLS-1$ /** @since 5.2 Show the "Include Files" settings entry tab */ public static final String KEY_SHOW_INC_FILES = "properties.includefiles.page.enable"; //$NON-NLS-1$ /** @since 5.2 */ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/CDTMainWizardPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/CDTMainWizardPage.java index bcdd3864dbf..bfbd7649fc6 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/CDTMainWizardPage.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/CDTMainWizardPage.java @@ -67,6 +67,7 @@ import org.eclipse.cdt.internal.ui.newui.Messages; private Tree tree; private Composite right; private Button show_sup; + private Button checkBoxTryNewSD; private Label right_label; public CWizardHandler h_selected = null; @@ -154,6 +155,20 @@ import org.eclipse.cdt.internal.ui.newui.Messages; // restore settings from preferences show_sup.setSelection(!CDTPrefUtil.getBool(CDTPrefUtil.KEY_NOSUPP)); + + checkBoxTryNewSD = new Button(c, SWT.CHECK); + checkBoxTryNewSD.setText(Messages.CDTMainWizardPage_TrySD90); + /* GridData */gd = new GridData(GridData.FILL_HORIZONTAL); + gd.horizontalSpan = 2; + checkBoxTryNewSD.setLayoutData(gd); + + // restore settings from preferences + boolean isTryNewSD = true; + boolean contains = CUIPlugin.getDefault().getPreferenceStore().contains(CDTPrefUtil.KEY_NEWSD); + if (contains) { + isTryNewSD = CDTPrefUtil.getBool(CDTPrefUtil.KEY_NEWSD); + } + checkBoxTryNewSD.setSelection(isTryNewSD); } @Override @@ -481,5 +496,9 @@ import org.eclipse.cdt.internal.ui.newui.Messages; public List filterItems(List items) { return items; } + + public boolean isTryingNewSD() { + return checkBoxTryNewSD.getSelection(); + } } diff --git a/cross/org.eclipse.cdt.build.crossgcc/.project b/cross/org.eclipse.cdt.build.crossgcc/.project old mode 100755 new mode 100644 diff --git a/cross/org.eclipse.cdt.build.crossgcc/build.properties b/cross/org.eclipse.cdt.build.crossgcc/build.properties old mode 100755 new mode 100644 diff --git a/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/build/crossgcc/SetCrossCommandProcess.java b/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/build/crossgcc/SetCrossCommandProcess.java old mode 100755 new mode 100644 diff --git a/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/internal/build/crossgcc/Activator.java b/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/internal/build/crossgcc/Activator.java old mode 100755 new mode 100644 diff --git a/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/internal/build/crossgcc/CrossCommandLineGenerator.java b/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/internal/build/crossgcc/CrossCommandLineGenerator.java old mode 100755 new mode 100644 diff --git a/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/internal/build/crossgcc/CrossEnvironmentVariableSupplier.java b/cross/org.eclipse.cdt.build.crossgcc/src/org/eclipse/cdt/internal/build/crossgcc/CrossEnvironmentVariableSupplier.java old mode 100755 new mode 100644 diff --git a/cross/org.eclipse.cdt.build.crossgcc/templates/setCrossCommand/template.xml b/cross/org.eclipse.cdt.build.crossgcc/templates/setCrossCommand/template.xml old mode 100755 new mode 100644 diff --git a/debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/command/CCommandAdapterFactory.java b/debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/command/CCommandAdapterFactory.java old mode 100755 new mode 100644 diff --git a/debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/command/CForEachCommand.java b/debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/command/CForEachCommand.java old mode 100755 new mode 100644 diff --git a/debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/command/RestartCommand.java b/debug/org.eclipse.cdt.debug.core/src/org/eclipse/cdt/debug/core/command/RestartCommand.java old mode 100755 new mode 100644 diff --git a/debug/org.eclipse.cdt.debug.ui/icons/obj16/reverse_stepinto.gif b/debug/org.eclipse.cdt.debug.ui/icons/obj16/reverse_stepinto.gif old mode 100755 new mode 100644 diff --git a/debug/org.eclipse.cdt.debug.ui/icons/obj16/reverse_stepover.gif b/debug/org.eclipse.cdt.debug.ui/icons/obj16/reverse_stepover.gif old mode 100755 new mode 100644 diff --git a/debug/org.eclipse.cdt.debug.ui/icons/obj16/uncall.gif b/debug/org.eclipse.cdt.debug.ui/icons/obj16/uncall.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/btn_columns.png b/doc/org.eclipse.cdt.doc.user/images/btn_columns.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/btn_import_executables.png b/doc/org.eclipse.cdt.doc.user/images/btn_import_executables.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/btn_restart.png b/doc/org.eclipse.cdt.doc.user/images/btn_restart.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/c_exe_obj.png b/doc/org.eclipse.cdt.doc.user/images/c_exe_obj.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/c_object_file.png b/doc/org.eclipse.cdt.doc.user/images/c_object_file.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_define_build_var.png b/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_define_build_var.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_edit_build_var.png b/doc/org.eclipse.cdt.doc.user/images/cdt_dlg_edit_build_var.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_menu_toggle_comments.png b/doc/org.eclipse.cdt.doc.user/images/cdt_menu_toggle_comments.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref_build_vars.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref_build_vars.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref_new_task_tag_dlg.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref_new_task_tag_dlg.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_pref_task_tags.png b/doc/org.eclipse.cdt.doc.user/images/cdt_pref_task_tags.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_w_basic06a.png b/doc/org.eclipse.cdt.doc.user/images/cdt_w_basic06a.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_w_debug_configurations_01.png b/doc/org.eclipse.cdt.doc.user/images/cdt_w_debug_configurations_01.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_w_debug_configurations_02.png b/doc/org.eclipse.cdt.doc.user/images/cdt_w_debug_configurations_02.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/command_link.png b/doc/org.eclipse.cdt.doc.user/images/command_link.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/editor_mark_preferences.png b/doc/org.eclipse.cdt.doc.user/images/editor_mark_preferences.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/editor_save_actions_preferences.png b/doc/org.eclipse.cdt.doc.user/images/editor_save_actions_preferences.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/hierarchy_co.gif b/doc/org.eclipse.cdt.doc.user/images/hierarchy_co.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/history_list.gif b/doc/org.eclipse.cdt.doc.user/images/history_list.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_build_make_target.png b/doc/org.eclipse.cdt.doc.user/images/icon_build_make_target.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_clear_console.png b/doc/org.eclipse.cdt.doc.user/images/icon_clear_console.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_edit_make_target.png b/doc/org.eclipse.cdt.doc.user/images/icon_edit_make_target.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_expand_all.png b/doc/org.eclipse.cdt.doc.user/images/icon_expand_all.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_hide_inactive_includes.png b/doc/org.eclipse.cdt.doc.user/images/icon_hide_inactive_includes.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_hide_make_targets.png b/doc/org.eclipse.cdt.doc.user/images/icon_hide_make_targets.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_hide_sys_includes.png b/doc/org.eclipse.cdt.doc.user/images/icon_hide_sys_includes.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_new_make_target.png b/doc/org.eclipse.cdt.doc.user/images/icon_new_make_target.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_next_error.png b/doc/org.eclipse.cdt.doc.user/images/icon_next_error.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_open_console.png b/doc/org.eclipse.cdt.doc.user/images/icon_open_console.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_pin.png b/doc/org.eclipse.cdt.doc.user/images/icon_pin.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_prev_error.png b/doc/org.eclipse.cdt.doc.user/images/icon_prev_error.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_repeat_search.png b/doc/org.eclipse.cdt.doc.user/images/icon_repeat_search.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_save_output_file.png b/doc/org.eclipse.cdt.doc.user/images/icon_save_output_file.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/icon_show_error.png b/doc/org.eclipse.cdt.doc.user/images/icon_show_error.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/namespace_declared_obj.png b/doc/org.eclipse.cdt.doc.user/images/namespace_declared_obj.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/new_proj_convert_candidate.png b/doc/org.eclipse.cdt.doc.user/images/new_proj_convert_candidate.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/pref_panel_build.png b/doc/org.eclipse.cdt.doc.user/images/pref_panel_build.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/pref_panel_code_templates.png b/doc/org.eclipse.cdt.doc.user/images/pref_panel_code_templates.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/pref_panel_edit_template_dlg.png b/doc/org.eclipse.cdt.doc.user/images/pref_panel_edit_template_dlg.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/pref_traditional_memory_prefs.png b/doc/org.eclipse.cdt.doc.user/images/pref_traditional_memory_prefs.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/progress_stop.gif b/doc/org.eclipse.cdt.doc.user/images/progress_stop.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/refresh_nav.gif b/doc/org.eclipse.cdt.doc.user/images/refresh_nav.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/sub_co.gif b/doc/org.eclipse.cdt.doc.user/images/sub_co.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/super_co.gif b/doc/org.eclipse.cdt.doc.user/images/super_co.gif old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/view_executables.png b/doc/org.eclipse.cdt.doc.user/images/view_executables.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/view_include_browser.png b/doc/org.eclipse.cdt.doc.user/images/view_include_browser.png old mode 100755 new mode 100644 diff --git a/doc/org.eclipse.cdt.doc.user/images/view_table_rendering.png b/doc/org.eclipse.cdt.doc.user/images/view_table_rendering.png old mode 100755 new mode 100644 diff --git a/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/connect.gif b/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/connect.gif old mode 100755 new mode 100644 diff --git a/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/reversestepinto.gif b/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/reversestepinto.gif old mode 100755 new mode 100644 diff --git a/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/reversestepover.gif b/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/reversestepover.gif old mode 100755 new mode 100644 diff --git a/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/stop_visual_trace.gif b/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/stop_visual_trace.gif old mode 100755 new mode 100644 diff --git a/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/uncall.gif b/dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/icons/full/obj16/uncall.gif old mode 100755 new mode 100644 diff --git a/dsf/org.eclipse.cdt.examples.dsf.pda/.options b/dsf/org.eclipse.cdt.examples.dsf.pda/.options old mode 100755 new mode 100644 diff --git a/memory/org.eclipse.cdt.debug.ui.memory.memorybrowser/icons/memorybrowser_view.gif b/memory/org.eclipse.cdt.debug.ui.memory.memorybrowser/icons/memorybrowser_view.gif old mode 100755 new mode 100644 diff --git a/memory/org.eclipse.cdt.debug.ui.memory.memorybrowser/src/org/eclipse/cdt/debug/ui/memory/memorybrowser/api/IMemoryBrowser.java b/memory/org.eclipse.cdt.debug.ui.memory.memorybrowser/src/org/eclipse/cdt/debug/ui/memory/memorybrowser/api/IMemoryBrowser.java old mode 100755 new mode 100644 diff --git a/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.properties b/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.properties index 9d000f26688..1f8857cdb4d 100644 --- a/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.properties +++ b/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.properties @@ -16,4 +16,7 @@ providerName=Eclipse CDT objectFileName=Object File profileName=XL C managed make per project scanner discovery profile -profileNameCPP=XL C++ managed make per project scanner discovery profile \ No newline at end of file +profileNameCPP=XL C++ managed make per project scanner discovery profile + +XlcBuiltinSpecsDetectorName=CDT XLC Builtin Compiler Settings +XlcBuildCommandParserName=CDT XLC Build Output Parser diff --git a/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.xml b/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.xml index 9e581224621..e0136162399 100644 --- a/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.xml +++ b/xlc/org.eclipse.cdt.managedbuilder.xlc.core/plugin.xml @@ -74,6 +74,24 @@ class="org.eclipse.cdt.make.xlc.core.scannerconfig.XlCSpecsConsoleParser"> - + + + + + + + + + + diff --git a/xlc/org.eclipse.cdt.managedbuilder.xlc.core/src/org/eclipse/cdt/managedbuilder/xlc/core/XlcBuiltinSpecsDetector.java b/xlc/org.eclipse.cdt.managedbuilder.xlc.core/src/org/eclipse/cdt/managedbuilder/xlc/core/XlcBuiltinSpecsDetector.java new file mode 100644 index 00000000000..b2fc7ca939d --- /dev/null +++ b/xlc/org.eclipse.cdt.managedbuilder.xlc.core/src/org/eclipse/cdt/managedbuilder/xlc/core/XlcBuiltinSpecsDetector.java @@ -0,0 +1,97 @@ +/******************************************************************************* + * Copyright (c) 2009, 2011 Andrew Gvozdev 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: + * Andrew Gvozdev - initial API and implementation + *******************************************************************************/ + +package org.eclipse.cdt.managedbuilder.xlc.core; + +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider; +import org.eclipse.cdt.core.settings.model.ICSettingEntry; +import org.eclipse.cdt.managedbuilder.scannerconfig.ToolchainBuiltinSpecsDetector; + + +/** + * + +> xlC -E -V -P -w ~/tmp/spec.C +export XL_CONFIG=/etc/vac.cfg:xlC +/usr/vac/exe/xlCcpp /home/me/tmp/spec.C - -qc++=/usr/vacpp/include -D_AIX -D_AIX32 -D_AIX41 -D_AIX43 -D_AIX50 -D_AIX51 -D_AIX52 -D_IBMR2 -D_POWER -E -P -w -qlanglvl=ansi -qansialias +rm /tmp/xlcW0lt4Jia +rm /tmp/xlcW1lt4Jib +rm /tmp/xlcW2lt4Jic + + */ + +/** + * Class to detect built-in compiler settings. Note that currently this class is hardwired + * to GCC toolchain {@code cdt.managedbuild.toolchain.gnu.base}. + * + */ +public class XlcBuiltinSpecsDetector extends ToolchainBuiltinSpecsDetector implements ILanguageSettingsEditableProvider { + // must match the toolchain definition in org.eclipse.cdt.managedbuilder.core.buildDefinitions extension point + // FIXME - ill defined XLC toolchain +// private static final String XLC_TOOLCHAIN_ID = "cdt.managedbuild.toolchain.xlc.exe.debug"; //$NON-NLS-1$ + private static final String GCC_TOOLCHAIN_ID = "cdt.managedbuild.toolchain.gnu.base"; //$NON-NLS-1$ + + private static final Pattern OPTIONS_PATTERN = Pattern.compile("-[^\\s\"']*(\\s*((\".*?\")|('.*?')|([^-\\s][^\\s]+)))?"); //$NON-NLS-1$ + private static final int OPTION_GROUP = 0; + + @SuppressWarnings("nls") + private static final AbstractOptionParser[] optionParsers = { + new IncludePathOptionParser("-I\\s*([\"'])(.*)\\1", "$2", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY | ICSettingEntry.LOCAL), + new IncludePathOptionParser("-I\\s*([^\\s\"']*)", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new IncludePathOptionParser("-qc\\+\\+=\\s*([^\\s\"']*)", "$1", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("-D\\s*([\"'])([^=]*)(=(.*))?\\1", "$2", "$4", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("-D\\s*([^\\s=\"']*)=(\\\\([\"']))(.*?)\\2", "$1", "$3$4$3", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("-D\\s*([^\\s=\"']*)=([\"'])(.*?)\\2", "$1", "$3", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + new MacroOptionParser("-D\\s*([^\\s=\"']*)(=([^\\s\"']*))?", "$1", "$3", ICSettingEntry.BUILTIN | ICSettingEntry.READONLY), + }; + + @Override + protected String getToolchainId() { +// return XLC_TOOLCHAIN_ID; + return GCC_TOOLCHAIN_ID; + } + + @Override + protected AbstractOptionParser[] getOptionParsers() { + return optionParsers; + } + + @Override + protected List parseForOptions(String line) { + List options = new ArrayList(); + Matcher optionMatcher = OPTIONS_PATTERN.matcher(line); + while (optionMatcher.find()) { + String option = optionMatcher.group(OPTION_GROUP); + if (option!=null) { + options.add(option); + } + } + return options; + } + + + @Override + public XlcBuiltinSpecsDetector cloneShallow() throws CloneNotSupportedException { + return (XlcBuiltinSpecsDetector) super.cloneShallow(); + } + + @Override + public XlcBuiltinSpecsDetector clone() throws CloneNotSupportedException { + return (XlcBuiltinSpecsDetector) super.clone(); + } + + +} diff --git a/xlc/org.eclipse.cdt.managedbuilder.xlc.ui/plugin.xml b/xlc/org.eclipse.cdt.managedbuilder.xlc.ui/plugin.xml index f6c2ea28a99..1a3575471fd 100644 --- a/xlc/org.eclipse.cdt.managedbuilder.xlc.ui/plugin.xml +++ b/xlc/org.eclipse.cdt.managedbuilder.xlc.ui/plugin.xml @@ -522,18 +522,19 @@ name="%TargetName.xlc.exe" projectMacroSupplier="org.eclipse.cdt.managedbuilder.xlc.ui.XLCProjectMacroSupplier"> + artifactExtension="exe" + cleanCommand="rm -rf" + errorParsers="org.eclipse.cdt.errorparsers.xlc.XlcErrorParser" + id="cdt.managedbuild.config.xlc.exe.debug" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser" + name="%ConfigName.Dbg"> + name="%ConfigName.Rel" + artifactExtension="exe" + cleanCommand="rm -rf" + errorParsers="org.eclipse.cdt.errorparsers.xlc.XlcErrorParser" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser" + id="cdt.managedbuild.config.xlc.exe.release"> + name="%ConfigName.Dbg" + cleanCommand="rm -rf" + artifactExtension="so" + errorParsers="org.eclipse.cdt.errorparsers.xlc.XlcErrorParser" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser" + id="cdt.managedbuild.config.xlc.so.debug"> + id="cdt.managedbuild.toolchain.xlc.so.debug" + languageSettingsProviders="org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser;*org.eclipse.cdt.managedbuilder.xlc.core.xlc.specs.detector" + name="%ToolChainName.Dbg" + targetTool="cdt.managedbuild.tool.xlc.c.linker.so.debug;cdt.managedbuild.tool.xlc.cpp.linker.so.debug"> + name="%ConfigName.Rel" + cleanCommand="rm -rf" + artifactExtension="so" + errorParsers="org.eclipse.cdt.errorparsers.xlc.XlcErrorParser" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser" + id="cdt.managedbuild.config.xlc.so.release"> + id="cdt.managedbuild.toolchain.xlc.so.release" + languageSettingsProviders="org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser;*org.eclipse.cdt.managedbuilder.xlc.core.xlc.specs.detector" + name="%ToolChainName.Rel" + targetTool="cdt.managedbuild.tool.xlc.c.linker.so.release;cdt.managedbuild.tool.xlc.cpp.linker.so.release"> + name="%ConfigName.Dbg" + cleanCommand="rm -rf" + artifactExtension="lib" + errorParsers="org.eclipse.cdt.errorparsers.xlc.XlcErrorParser" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser" + id="cdt.managedbuild.config.xlc.lib.debug"> + id="cdt.managedbuild.toolchain.xlc.lib.debug" + languageSettingsProviders="org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser;*org.eclipse.cdt.managedbuilder.xlc.core.xlc.specs.detector" + name="%ToolChainName.Dbg" + targetTool="cdt.managedbuild.tool.xlc.archiver.lib.debug"> + name="%ConfigName.Rel" + cleanCommand="rm -rf" + artifactExtension="lib" + errorParsers="org.eclipse.cdt.errorparsers.xlc.XlcErrorParser" + languageSettingsProviders="org.eclipse.cdt.ui.user.LanguageSettingsProvider;org.eclipse.cdt.managedbuilder.core.LanguageSettingsProvider;${Toolchain};-org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser" + id="cdt.managedbuild.config.xlc.lib.release"> + id="cdt.managedbuild.toolchain.xlc.lib.release" + languageSettingsProviders="org.eclipse.cdt.managedbuilder.xlc.core.xlc.build.command.parser;*org.eclipse.cdt.managedbuilder.xlc.core.xlc.specs.detector" + name="%ToolChainName.Rel" + targetTool="cdt.managedbuild.tool.xlc.archiver.lib.release"> @@ -3753,7 +3762,6 @@ id="cdt.managedbuild.tool.xlc.cpp.c.compiler.input" name="%inputType.c.name.2" primaryInput="true" - scannerConfigDiscoveryProfileId="org.eclipse.cdt.managedbuilder.xlc.core.XLCManagedMakePerProjectProfile" sourceContentType="org.eclipse.cdt.core.cSource" sources="c"> @@ -3763,7 +3771,6 @@ id="cdt.managedbuild.tool.xlc.cpp.compiler.input" name="%inputType.cpp.name" primaryInput="true" - scannerConfigDiscoveryProfileId="org.eclipse.cdt.managedbuilder.xlc.core.XLCManagedMakePerProjectProfileCPP" sourceContentType="org.eclipse.cdt.core.cxxSource" sources="c,C,cc,cxx,cpp">