mark abld-specific methods as deprecated C3_BUILDER_WORK
authortimkelly
Tue, 10 Aug 2010 14:39:10 -0500
branchC3_BUILDER_WORK
changeset 1799 ee7381872847
parent 1789 f9d171c71f7e
child 1802 7e50573a0115
mark abld-specific methods as deprecated
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/builder/CarbideCPPBuilder.java
builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/BuildContextSBSv1.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildContext.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildInfo.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuilderID.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDK.java
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java	Tue Aug 10 14:39:10 2010 -0500
@@ -2332,6 +2332,7 @@
 	 * @param config - The Carbide build configuration to check against
 	 * @param mmpFullPath - The path to the MMP file that builds the binary
 	 * @return A string of the MD5 hash. Returns an empty string if the configuration is not a binary variant or cannot be determined.
+	 * @deprecated - ABLD support to be removed vFuture
 	 */
 	static public String getMD5HashForBinaryVariant(final ICarbideBuildConfiguration config, final IPath mmpFullPath){
 		
@@ -2358,6 +2359,7 @@
 	 * @param mmpData
 	 * @param config
 	 * @return
+	 * @deprecated - Abld support to be be removed vFuture
 	 */
 	private static File getMakeFileForSymbianBinaryVariant(IMMPData mmpData, ICarbideBuildConfiguration config){
 		
@@ -2391,6 +2393,7 @@
 	 * @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.
+	 * @deprecated - abld support to be removed
 	 */
 	private static String getMD5VariantFromMakefile(File makefile, ICarbideBuildConfiguration config){
 		// We could also use the .vmap in the release folder as well.
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/builder/CarbideCPPBuilder.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/builder/CarbideCPPBuilder.java	Tue Aug 10 14:39:10 2010 -0500
@@ -818,6 +818,7 @@
 	 * @param bldmakeArgs array of String arguments to be passed to bldmake
 	 * @param removeMarkers project markers will be removed when true
 	 * @return true if operation was successful, false otherwise
+	 * @deprecated - Abld support to be be removed vFuture
 	 */
 	public static boolean invokeBldmakeCommand(ICarbideBuildConfiguration buildConfig, CarbideCommandLauncher launcher, String[] bldmakeArgs, boolean removeMarkers) {
 		ICarbideProjectInfo cpi = buildConfig.getCarbideProject();
@@ -896,6 +897,7 @@
 	 * @param config the build configuration context
 	 * @param launcher the Carbide launcher
 	 * @return false if makefile generation was necessary but failed, true otherwise
+	 * @deprecated - Abld support to be be removed vFuture
 	 */
 	public static boolean generateBldmakeMakefilesIfNecessary(ICarbideBuildConfiguration config, CarbideCommandLauncher launcher) {
 
@@ -933,6 +935,7 @@
 	 * is newer than any of the makefiles, then returns true.
 	 * @param config - The build configuration to check the makefiles for
 	 * @return true if makefiles need to be regenerated (bldmake bldfiles platform)
+	 * @deprecated - Abld support to be be removed vFuture
 	 */
 	protected static boolean needsBldmakeMakefileGeneration(ICarbideBuildConfiguration config) {
 		return getBuilder(config.getCarbideProject().getProject()).needsBldmakeMakefileGeneration(config);
@@ -990,6 +993,7 @@
 	 * @param progress monitor to allow user to cancel
 	 * @return false if any makefile generation was necessary but failed, true otherwise
 	 * @since 2.0
+	 * @deprecated - Abld support to be be removed vFuture
 	 */
 	public static boolean generateAbldMakefilesIfNecessary(ICarbideBuildConfiguration config, CarbideCommandLauncher launcher, boolean calculateComponentLists, IProgressMonitor progress) {
 
@@ -1026,6 +1030,7 @@
 	 * @param componentPath the absolute file system path of the component
 	 * @param isTest true for test components, false otherwise
 	 * @return false if any makefile generation was necessary but failed, true otherwise
+	 * @deprecated - Abld support to be be removed vFuture
 	 */
 	protected static boolean generateAbldMakefileIfNecessary(ICarbideBuildConfiguration config, CarbideCommandLauncher launcher, IPath componentPath, boolean isTest, IProgressMonitor progress) {
 		return getBuilder(config.getCarbideProject().getProject()).generateAbldMakefileIfNecessary(config, launcher, componentPath, isTest, progress);
@@ -2026,6 +2031,11 @@
 		return false;
     }
     
+    /**
+     * @deprecated - Abld support to be be removed vFuture
+     * @param config
+     * @return
+     */
     public static IPath getBuilderMakefileDir(ICarbideBuildConfiguration config){
     	return getBuilder(config.getCarbideProject().getProject()).getMakefileDirectory(config);
     }
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideProjectInfo.java	Tue Aug 10 14:39:10 2010 -0500
@@ -82,7 +82,7 @@
 	
 	/**
 	 * Check whether or not all components of the inf are built or subcomponents.
-	 * Building from inf means that only 'abld build' is invoked rather than invoking 'abld build' on specific MMP and makefiles
+	 * Building from inf means that the build system is invoked on a single bld.inf, rather than build steps for individual MMPs
 	 * @return true when building from bld.inf
 	 */
 	public boolean isBuildingFromInf();
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/BuildContextSBSv1.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/BuildContextSBSv1.java	Tue Aug 10 14:39:10 2010 -0500
@@ -34,6 +34,10 @@
 import com.nokia.carbide.cpp.sdk.core.ISymbianSDK;
 import com.nokia.carbide.cpp.sdk.core.SDKCorePlugin;
 
+/**
+ * @deprecated - Temporary support exists for abld on Symbian^2 but will be removed, vFuture
+ *
+ */
 public class BuildContextSBSv1 implements ISBSv1BuildContext {
 
 	private String sdkId;
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildContext.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildContext.java	Tue Aug 10 14:39:10 2010 -0500
@@ -6,6 +6,7 @@
  * Build Context specific information for the SBS/Raptor Symbian Builder.
  * @see ICarbideBuildConfigation
  * @since 3.0
+ * @deprecated - Temporary support exists for abld on Symbian^2 but will be removed, vFuture
  *
  */
 public interface ISBSv1BuildContext extends ISymbianBuildContext {
@@ -27,6 +28,7 @@
 	 * @return The base platform string.
 	 * @see isSymbianBinaryVariation()
 	 * @since 2.0
+	 * @deprecated
 	 */
 	public String getBasePlatformForVariation();
 	
@@ -34,7 +36,7 @@
 	 * Get the (abld)build arguments info.  Contains pref settings from the Arguments tab.
 	 * This only applies when building with SBSv1 (bldmake, abld)
 	 * @return IBuildArgumentsInfo instance, never null
-	 *  
+	 * @deprecated 
 	 */
 	IBuildArgumentsInfo getBuildArgumentsInfo();
 	
@@ -42,6 +44,7 @@
 	 * Get the (abld)build arguments info.  Contains pref settings from the Arguments tab.
 	 * This only applies when building with SBSv1 (bldmake, abld)
 	 * @return A copy of BuildArgumentsInfo instance, never null
+	 * @deprecated
 	 */
 	BuildArgumentsInfo getBuildArgumentsInfoCopy();
 	
@@ -49,6 +52,7 @@
 	 * Set the build arguments info for SBSv2 build arguments. This only sets values in memory, does
 	 * not write settings to disk. See 
 	 * @return IBuildArgumentsInfo instance, never null
+	 * @deprecated
 	 */
 	void setBuildArgumentsInfo(BuildArgumentsInfo bldArgInfo);
 	
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildInfo.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildInfo.java	Tue Aug 10 14:39:10 2010 -0500
@@ -22,20 +22,28 @@
 
 /**
  * Interface for SBSv1 specific build information.
+ * @since 3.0
+ * @deprecated - Temporary support exists for abld on Symbian^2 but will be removed, vFuture
  *
  */
 public interface ISBSv1BuildInfo extends ISDKBuildInfo {
-
+	
+	/**
+	 * Clears the list of macros specific to all abld build platforms
+	 * @deprecated
+	 */
 	void clearPlatformMacros();
 
 	/**
 	 * Returns the list of all available platforms for a SDK.
 	 * @return a list of platform names which may be empty.
+	 * @deprecated
 	 */
 	List<String> getAvailablePlatforms();
 
 	/**
 	 * Get the BSF catalog for a SDK.
+	 * @deprecated
 	 */
 	IBSFCatalog getBSFCatalog();
 
@@ -47,11 +55,13 @@
 	 * </p>
 	 * @param platform the platform name
 	 * @return a list of macros, which may be empty.
+	 * @deprecated
 	 */
 	List<String> getPlatformMacros(String platform);
 
 	/**
 	 * Get the Symbian Binary Variation (SBV) catalog for a SDK.
+	 * @deprecated
 	 */
 	ISBVCatalog getSBVCatalog();
 
@@ -59,6 +69,7 @@
 	 * Get a list of macros specific to the given target type, e.g. "__EXE__" or "__DLL__"
 	 * @param targettype
 	 * @return list of macro strings, may be empty
+	 * @deprecated
 	 */
 	List<String> getTargetTypeMacros(String targettype);
 
@@ -67,15 +78,20 @@
 	 * S603rd edition SDKs contain this information and it's used to differentiate between
 	 * varios S60 SDK releases. Other vendors, such as UIQ may put their macros in the variant HRH file.
 	 * @return A list of macros just returned by name.
+	 * @deprecated
 	 */
 	public List<String> getVendorSDKMacros();
 
 	/**
 	 * Tells whether or not the plug-in installer has sniffed this SDK for eclipse plug-ins to install.
 	 * @return true if the SDK was scanned
+	 * @deprecated
 	 */
 	boolean isPreviouslyScanned();
-
+	
+	/**
+	 * @deprecated
+	 */
 	void setPreviouslyScanned(boolean wasScanned);
 
 	/**
@@ -85,6 +101,7 @@
 	 * </p>
 	 *
 	 * @return a list of macros which may be empty.
+	 * @deprecated
 	 */
 	List<String> getBuiltinMacros(ISymbianBuildContext context);
 
@@ -92,6 +109,7 @@
 	 * Get a list of supported targettypes listed by this SDK. This routine parses the 
 	 * \epoc32\tools\trgttype.pm file to build it's list.
 	 * @return A list of targettype names that can be used in an MMP file
+	 * @deprecated
 	 */
 	List<String> getSupportedTargetTypes();
 
@@ -100,6 +118,7 @@
 	 * Returns a list of the macros defined in the variant.cfg file. This is NOT the macros
 	 * in the HRH file, but the actual maros written to the variant.cfg file.
 	 * @return A String list of macros found as is, or an empty list if none.
+	 * @deprecated
 	 */
 	List<String> getVariantCFGMacros();
 	
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuilderID.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuilderID.java	Tue Aug 10 14:39:10 2010 -0500
@@ -18,7 +18,10 @@
  * @since 3.0
  */
 public interface ISymbianBuilderID {
-
+	
+	/**
+	 * @deprecated - SBSv1 / ABLD builder will be removed in vFuture.
+	 */
 	public static final String SBSV1_BUILDER = "SBSv1Builder";
 	public static final String SBSV2_BUILDER = "SBSv2Builder";
 
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDK.java	Fri Aug 06 12:17:31 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDK.java	Tue Aug 10 14:39:10 2010 -0500
@@ -35,7 +35,7 @@
 	/**
 	 * Returns build info for a particular builder.
 	 * @param builderId id string of a builder (ISymbianBuilderID constant)
-	 * @return build info
+	 * @return ISDKBuildInfo - may be null if the builderId is deprecated.
 	 * @since 3.0
 	 * @see {@link ISymbianBuilderID}
 	 */