clean up some TODOs C3_BUILDER_WORK
authortimkelly
Wed, 28 Jul 2010 11:33:05 -0500
branchC3_BUILDER_WORK
changeset 1709 6bd6640867aa
parent 1707 ddfcc3a97d22
child 1710 94cdcd7c5550
clean up some TODOs
builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/errorParsers/CarbideErrorParserTestHarness.java
builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/errorParsers/TestMakeErrorParser.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/DefaultIncludeFileLocator.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/api/builder/CarbideConfigurationDataProvider.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideLanguageData.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideProjectInfo.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideSBSv1Builder.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/BuildContextSBSv2.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/DynamicFeatureInstaller.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SBSv1BuildInfo.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SBSv2BuildInfo.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SDKManager.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/processes/CheckS60CustKitSupport.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/SDKCorePlugin.java
core/com.nokia.carbide.cpp.sdk.ui/src/com/nokia/carbide/cpp/internal/api/sdk/ui/SBSv2PlatformFilterComposite.java
project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/internal/cpp/epoc/engine/model/bldinf/BldInfView.java
project/com.nokia.carbide.cpp.project.core.tests/src/com/nokia/carbide/cpp/project/core/tests/MissingSdkTest.java
--- a/builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/errorParsers/CarbideErrorParserTestHarness.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/errorParsers/CarbideErrorParserTestHarness.java	Wed Jul 28 11:33:05 2010 -0500
@@ -170,7 +170,6 @@
 					file = FileUtils.pluginRelativeFile(TestPlugin.getDefault(), "data/currentOutput.xml");
 					writeRegressionXMLFile(new java.io.PrintStream(file));
 				} catch (IOException e) {
-					// TODO Auto-generated catch block
 					e.printStackTrace();
 				}
 			}
@@ -377,7 +376,6 @@
 	        printStream.close();
         
 		} catch (IOException e) {
-			// TODO Auto-generated catch block
 			e.printStackTrace();
 		}
 
--- a/builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/errorParsers/TestMakeErrorParser.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder.test/src/com/nokia/carbide/cdt/builder/test/errorParsers/TestMakeErrorParser.java	Wed Jul 28 11:33:05 2010 -0500
@@ -42,7 +42,6 @@
 
 	public TestMakeErrorParser(String name) {
 		super(name);
-		// TODO Auto-generated constructor stub
 	}
 
 	CarbideErrorParserTestHarness harness;
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/DefaultIncludeFileLocator.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/DefaultIncludeFileLocator.java	Wed Jul 28 11:33:05 2010 -0500
@@ -54,7 +54,6 @@
 			}
 
 			// get info from context
-			// TODO: HACK HACK. Hard coded build context to get working....
 			Check.checkState(buildContext instanceof BuildContextSBSv1 || buildContext instanceof BuildContextSBSv2);
 			
 			if (buildContext instanceof BuildContextSBSv1){
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java	Wed Jul 28 11:33:05 2010 -0500
@@ -2383,13 +2383,13 @@
 	}
 	
 	/**
-	 * Get the MD5 hash value for an existing configuration by parsing its makefile.
+	 * Get the MD5 hash value for an existing configuration by parsing its makefile. Should only be used for ABLD build system.
 	 * @param makefile - The build makefile to parse to check for the MD5
 	 * @param config - The build configuration to check under
 	 * @return The string for the MD5 hash. An empty string if it cannot be determined.
 	 */
 	private static String getMD5VariantFromMakefile(File makefile, ICarbideBuildConfiguration config){
-		// TODO: We can also use the .vmap in the release folder as well.
+		// We could also use the .vmap in the release folder as well.
 		// we can parse the makefile and get the variant name for each in the comments:
 		//
 		//# FeatureVariantURELLabel d41d8cd98f00b204e9800998ecf8427e
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.java	Wed Jul 28 11:33:05 2010 -0500
@@ -148,19 +148,14 @@
 	/** ISymbianBuildContext wrapper */
 	String getTargetString();
 	
-	/** TODO: Detect on instanceof ? */
 	public IPath getCompilerPrefixFile();
 	
-	/** TODO: Detect on instanceof ? */
 	public List<IDefine> getCompilerMacros();
 	
-	/** TODO: Detect on instanceof ? */
 	public List<IDefine> getVariantHRHDefines();
 	
-	/** TODO: Detect on instanceof ? */
 	public List<File> getPrefixFileIncludes();
 	
-	/** TODO: Detect on instanceof ? */
 	public String getBuildVariationName();
 
 	String getConfigurationID();
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/api/builder/CarbideConfigurationDataProvider.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/api/builder/CarbideConfigurationDataProvider.java	Wed Jul 28 11:33:05 2010 -0500
@@ -117,6 +117,7 @@
 		return baseData;
 	}
 
+	@SuppressWarnings("restriction")
 	@Override
 	public CConfigurationData loadConfiguration(ICConfigurationDescription des,
 			IProgressMonitor monitor) throws CoreException {
@@ -139,7 +140,7 @@
 									+ project.getProject().getName(), null));
 				}
 			} else {
-				// TODO: Presume it's SBSv1?
+				// Presume it's SBSv1
 				// find the configuration that matches the id (sdk, platform, target)
 				String configId = des.getConfiguration().getId();
 				context = BuildContextSBSv1.getBuildContextFromDisplayName(configId);
@@ -163,6 +164,7 @@
 		return null;
 	}
 
+	@SuppressWarnings("restriction")
 	private ISymbianBuildContext loadSBSv2Configuration(ICConfigurationDescription des, 
 														IProgressMonitor monitor) {
 		
@@ -215,7 +217,7 @@
 		
 		ISymbianSDK sdk = null;
 		if (!configID.startsWith(ISBSv2BuildContext.BUILDER_ID)){
-			// pre-C3 project, get SDK id from config name
+			// pre-C3 (Carbide 2.x) project, get SDK id from config name
 			if (displayString == null){
 				displayString = configID;
 			} 
@@ -234,7 +236,6 @@
 		}
 		if (sdkID != null){
 			sdk = SDKCorePlugin.getSDKManager().getSDK(sdkID, true);
-			// TODO: NEED TO HANDLE MISSING SDK ID
 			if (sdk != null){
 				return new BuildContextSBSv2(sdk, platform, target, buidAlias, displayString, configID);
 			} else {
@@ -245,7 +246,6 @@
 			}
 		}
 		
-		
 		return null;
 		
 	}
@@ -285,12 +285,13 @@
 	protected static void convertSettingsData(IProject project, CarbideBuilderConfigInfoType buildConfigType) {
 		
 		if (buildConfigType.getVersion() == CarbideBuildConfigurationLoader.SETTINGS_VERSION_0) {
-			// Iteraate through all the configurations and convert from version 0 to 1.
+			// Iterate through all the configurations and convert from version 0 to 1.
 			// Reset all PATH, EPOCROOT, and MW* variables set back to their defaults
 			// as they are computed dynamically now.
 			for (Iterator i = buildConfigType.getConfiguration().iterator(); i.hasNext();) {
 				ConfigurationType currConfig = (ConfigurationType)i.next();
-				// TODO: YUKCY!
+				
+				@SuppressWarnings("restriction")
 				ISymbianBuildContext context = BuildContextSBSv1.getBuildContextFromDisplayName(currConfig.getName());
 				IEnvironmentVarsInfo envSettings = new EnvironmentVarsInfo(project, context, currConfig.getEnvVars());
 				List<IEnvironmentVariable> varsFromSettings = envSettings.getModifiedEnvVarsListFromSettings();
@@ -415,8 +416,9 @@
 					List<ISymbianBuildContext> configs = new ArrayList<ISymbianBuildContext>();
 					for (Iterator i = oldConfigInfo.getConfiguration().iterator(); i.hasNext();) {
 						ConfigurationType currConfig = (ConfigurationType)i.next();
-						// TODO: YUCKY!
-		    			ISymbianBuildContext context = BuildContextSBSv1.getBuildContextFromDisplayName(currConfig.getName());
+						
+		    			@SuppressWarnings("restriction")
+						ISymbianBuildContext context = BuildContextSBSv1.getBuildContextFromDisplayName(currConfig.getName());
 						if (context != null) {
 							configs.add(context);
 						}
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideLanguageData.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideLanguageData.java	Wed Jul 28 11:33:05 2010 -0500
@@ -248,7 +248,6 @@
 		if (context instanceof ISBSv2BuildContext) {
 			// SBSv2 only system includes
 			if (((ISBSv2BuildContext)context).getSystemIncludes() != null){
-				// TODO: THIS SHOULD NOT HAPPEN
 			
 				for (IPath incPath : ((ISBSv2BuildContext)context).getSystemIncludes()) {
 					IPath projRelIncPath = FileUtils.removePrefixFromPath(projectPath, incPath);
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideProjectInfo.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideProjectInfo.java	Wed Jul 28 11:33:05 2010 -0500
@@ -304,9 +304,6 @@
 		if (config != null) {
 			CConfigurationData data = config.getConfigurationData();
 			if (data == null){
-				// TODO: HACK. FOR REASONS I DON'T GET RIGHT NOW, IF I CREATE A VARIANT AND SAVE IT'S
-				// OK. BUT IF I CLOSE AND RE-OPEN THE PROJECT THE DEFAULT CONFIG DATA IS NOT LOADED.
-				// SO JUST LOAD THE FIRST IN THE LIST. THIS NEEDS TO BE ADDRESSED.
 				ICConfigurationDescription[] config2 = projectDescription.getConfigurations();
 				data = config2[0].getConfigurationData();
 			}
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideSBSv1Builder.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/internal/builder/CarbideSBSv1Builder.java	Wed Jul 28 11:33:05 2010 -0500
@@ -2400,7 +2400,6 @@
 				} catch (CoreException e) {
 					CarbideBuilderPlugin.log(e);
 					e.printStackTrace();
-					//TODO is this enough?
 				}
 			}
 		}
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/BuildContextSBSv2.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/BuildContextSBSv2.java	Wed Jul 28 11:33:05 2010 -0500
@@ -170,14 +170,14 @@
 
 	@Override
 	public String getBuildVariationName() {
-		// TODO: This should not be needed for Raptor
+		// Not needed for Raptor
 		return "";
 	}
 
 	@Override
 	public boolean isSymbianBinaryVariation() {
-		// This should not be needed for Raptor. We do need a check
-		// in the MPP for the featurevariant keyword perhaps
+		// Not be needed for Raptor. We do check
+		// in the MPP for the featurevariant keyword
 		return false;
 	}
 	
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/DynamicFeatureInstaller.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/DynamicFeatureInstaller.java	Wed Jul 28 11:33:05 2010 -0500
@@ -137,7 +137,6 @@
 			for (IConfiguredSite site : configuredSites) {
 				installedFeatureRefs.addAll(Arrays.asList(site.getConfiguredFeatures()));
 				if (localSite == null && site.isUpdatable()) {
-					// TODO: If there are multiple sites should the user be presented a list to choose from?
 					localSite = site;
 				}
 			}
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SBSv1BuildInfo.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SBSv1BuildInfo.java	Wed Jul 28 11:33:05 2010 -0500
@@ -83,11 +83,10 @@
 		if (buildPlats.size() == 0){
 			return Collections.emptyList();
 		}
-		// TODO: Hard code build context hack
+
 		buildTargets.add(new BuildContextSBSv1(sdk, ISBSv1BuildContext.EMULATOR_PLATFORM, ISymbianBuildContext.DEBUG_TARGET));
 		
 		if (sdkFeatures.contains(ISymbianSDKFeatures.IS_WINSCW_UREL_SUPPORTED)){
-			// TODO: Hard code build context hack
 			buildTargets.add(new BuildContextSBSv1(sdk, ISBSv1BuildContext.EMULATOR_PLATFORM, ISymbianBuildContext.RELEASE_TARGET));
 		}
 		
@@ -96,11 +95,9 @@
 				// emulation targets already determined (some SDKs don't get WISNCW UREL
 				continue;
 			}
-			// TODO: Hard code build context hack
 			buildTargets.add(new BuildContextSBSv1(sdk, currPlat, ISymbianBuildContext.DEBUG_TARGET));
 			
 			// everything gets release except for WINSCW
-			// TODO: Hard code build context hack
 			buildTargets.add(new BuildContextSBSv1(sdk, currPlat, ISymbianBuildContext.RELEASE_TARGET));
 		}
 		
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SBSv2BuildInfo.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SBSv2BuildInfo.java	Wed Jul 28 11:33:05 2010 -0500
@@ -61,7 +61,7 @@
 
 	@Override
 	public List<ISymbianBuildContext> getAllBuildConfigurations() {
-		// TODO: Will get rid of this method. Only filtered configs will apply
+		// This really only applies to SBSv1. We never return the full list of configs for SBSv2, only the filtered ones
 		return sbsv2FilteredConetxts;
 	}
 
@@ -176,7 +176,7 @@
 	private String getMeaningForVariant(String alias) {
 		String meaning = null;
 		
-		// TODO: Assuming now that the alias now is the first part and the last bits are the variant bits.
+		// The alias is the first token when splitting on a dot.
 		String tokens[] = alias.split("\\.");
 		if (tokens.length > 0){
 			meaning = aliasToMeaningMap.get(tokens[0]);
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SDKManager.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/model/SDKManager.java	Wed Jul 28 11:33:05 2010 -0500
@@ -215,7 +215,7 @@
 		} catch (Exception e) {			
 			//TODO: Localise
 			String errMsg = "Could not read registry for local machine key: '" +  CSL_ARM_TOOLCHAIN_REG_PATH 
-								+ " (" + e.getMessage() +").";
+								+ " (" + e.getMessage() +")."; //$NON-NLS-N$
 			throw new SDKEnvInfoFailureException(errMsg);
 		}
 		
@@ -223,7 +223,7 @@
 			//TODO: Localise
 			String errMsg = "CSL Arm Toolchain installation path pointed by registry key '" 
 							+  CSL_ARM_TOOLCHAIN_REG_PATH 
-							+ "' does not exist.";
+							+ "' does not exist."; //$NON-NLS-N$
 			throw new SDKEnvInfoFailureException(errMsg);
 		}
 
@@ -240,9 +240,8 @@
 			toolPathName = gcceToolDir + "\\" + toolName;
 			
 			if (!new File(toolPathName).exists()){
-				//TODO: Localise
 				String errMsg = "Required tool from CSL Arm Toolchain is missing: " 
-								+ toolPathName;
+								+ toolPathName; //$NON-NLS-N$
 				throw new SDKEnvInfoFailureException(errMsg);
 			}			
 		}
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/processes/CheckS60CustKitSupport.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/sdk/core/processes/CheckS60CustKitSupport.java	Wed Jul 28 11:33:05 2010 -0500
@@ -138,9 +138,6 @@
 			helpCompilerNames = new String[] { HELP_COMPILER_WIN32, HELP_COMPILER_PERL };
 		} else {
 			
-			// TODO: the infrastructure for the techview/bldhelp.mk is a total mess 
-			// currently, and it also appears that help is obsolete in recent devkits,
-			// so just drop this
 			if (!SBSv2Utils.enableSBSv1Support() && isSBSv2Project(template))
 				return null;
 			
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/SDKCorePlugin.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/SDKCorePlugin.java	Wed Jul 28 11:33:05 2010 -0500
@@ -94,6 +94,7 @@
 		if (sdkManager == null) {
 			// TODO: SDKManagerRaptorOnly, currently only works on Linux
 			// ... and SDKManager depends on Windows
+			// Win32 can use this instead once ABLD support is dropped from Carbide
 			if (HostOS.IS_WIN32)
 				sdkManager = new SDKManager();
 			else
--- a/core/com.nokia.carbide.cpp.sdk.ui/src/com/nokia/carbide/cpp/internal/api/sdk/ui/SBSv2PlatformFilterComposite.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.ui/src/com/nokia/carbide/cpp/internal/api/sdk/ui/SBSv2PlatformFilterComposite.java	Wed Jul 28 11:33:05 2010 -0500
@@ -54,9 +54,6 @@
 @SuppressWarnings("restriction")
 public class SBSv2PlatformFilterComposite extends Composite {
 
-	// TODO: Temporary map. We need a way to ensure we only get the alias map
-	// when needed and that the data we are getting is properly cached to avoid
-	// having to run Raptor queries too often
 	private static HashMap<String, String> aliasMap = new HashMap<String, String>();
 	private static List<String> productVariantList = new ArrayList<String>();
 	
--- a/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/internal/cpp/epoc/engine/model/bldinf/BldInfView.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/internal/cpp/epoc/engine/model/bldinf/BldInfView.java	Wed Jul 28 11:33:05 2010 -0500
@@ -437,7 +437,6 @@
 	 */
 	@Override
 	protected boolean internalMerge(IASTTranslationUnit oldTu) {
-		// TODO Auto-generated method stub
 		return false;
 	}
 
--- a/project/com.nokia.carbide.cpp.project.core.tests/src/com/nokia/carbide/cpp/project/core/tests/MissingSdkTest.java	Tue Jul 27 16:30:33 2010 -0500
+++ b/project/com.nokia.carbide.cpp.project.core.tests/src/com/nokia/carbide/cpp/project/core/tests/MissingSdkTest.java	Wed Jul 28 11:33:05 2010 -0500
@@ -115,9 +115,9 @@
 			// check we only have those configs in the removed SDK in the missing list
 			List<ICarbideBuildConfiguration> configList = cpi.getBuildConfigurations();
 			int badCount = 0;
-			for (ICarbideBuildConfiguration config: configList) {		
-				// TODO: Hack to use static method for prototyping BuildContextSBSv1.getSDKIDFromConfigName
-				// Should be no static calls on those classes.
+			for (ICarbideBuildConfiguration config: configList) {
+				// TODO: Using SBSv1 static method. Currently display name keeps the SDKID the same for both
+				// SBSv1 and SBSv2 configs. Will need to update in the event that SBSv1 support is removed. TCK.
 				if (SDKManagerInternalAPI.getMissingSdk(BuildContextSBSv1.getSDKIDFromConfigName(config.getDisplayString())) != null) {
 					badCount++;
 				}