core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv1BuildInfo.java
branchC3_BUILDER_WORK
changeset 1799 ee7381872847
parent 1736 ba74c19c6de3
child 1802 7e50573a0115
equal deleted inserted replaced
1789:f9d171c71f7e 1799:ee7381872847
    20 import com.nokia.carbide.cpp.sdk.core.ISDKBuildInfo;
    20 import com.nokia.carbide.cpp.sdk.core.ISDKBuildInfo;
    21 import com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext;
    21 import com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext;
    22 
    22 
    23 /**
    23 /**
    24  * Interface for SBSv1 specific build information.
    24  * Interface for SBSv1 specific build information.
       
    25  * @since 3.0
       
    26  * @deprecated - Temporary support exists for abld on Symbian^2 but will be removed, vFuture
    25  *
    27  *
    26  */
    28  */
    27 public interface ISBSv1BuildInfo extends ISDKBuildInfo {
    29 public interface ISBSv1BuildInfo extends ISDKBuildInfo {
    28 
    30 	
       
    31 	/**
       
    32 	 * Clears the list of macros specific to all abld build platforms
       
    33 	 * @deprecated
       
    34 	 */
    29 	void clearPlatformMacros();
    35 	void clearPlatformMacros();
    30 
    36 
    31 	/**
    37 	/**
    32 	 * Returns the list of all available platforms for a SDK.
    38 	 * Returns the list of all available platforms for a SDK.
    33 	 * @return a list of platform names which may be empty.
    39 	 * @return a list of platform names which may be empty.
       
    40 	 * @deprecated
    34 	 */
    41 	 */
    35 	List<String> getAvailablePlatforms();
    42 	List<String> getAvailablePlatforms();
    36 
    43 
    37 	/**
    44 	/**
    38 	 * Get the BSF catalog for a SDK.
    45 	 * Get the BSF catalog for a SDK.
       
    46 	 * @deprecated
    39 	 */
    47 	 */
    40 	IBSFCatalog getBSFCatalog();
    48 	IBSFCatalog getBSFCatalog();
    41 
    49 
    42 	/**
    50 	/**
    43 	 * Returns the list of all platform macros for a SDK.
    51 	 * Returns the list of all platform macros for a SDK.
    45 	 * This is somewhat equivalent to calling "bldmake plat" on the command line
    53 	 * This is somewhat equivalent to calling "bldmake plat" on the command line
    46 	 * These are the macros that can be used in MMP and INF files. They are only given by name (no value)
    54 	 * These are the macros that can be used in MMP and INF files. They are only given by name (no value)
    47 	 * </p>
    55 	 * </p>
    48 	 * @param platform the platform name
    56 	 * @param platform the platform name
    49 	 * @return a list of macros, which may be empty.
    57 	 * @return a list of macros, which may be empty.
       
    58 	 * @deprecated
    50 	 */
    59 	 */
    51 	List<String> getPlatformMacros(String platform);
    60 	List<String> getPlatformMacros(String platform);
    52 
    61 
    53 	/**
    62 	/**
    54 	 * Get the Symbian Binary Variation (SBV) catalog for a SDK.
    63 	 * Get the Symbian Binary Variation (SBV) catalog for a SDK.
       
    64 	 * @deprecated
    55 	 */
    65 	 */
    56 	ISBVCatalog getSBVCatalog();
    66 	ISBVCatalog getSBVCatalog();
    57 
    67 
    58 	/**
    68 	/**
    59 	 * Get a list of macros specific to the given target type, e.g. "__EXE__" or "__DLL__"
    69 	 * Get a list of macros specific to the given target type, e.g. "__EXE__" or "__DLL__"
    60 	 * @param targettype
    70 	 * @param targettype
    61 	 * @return list of macro strings, may be empty
    71 	 * @return list of macro strings, may be empty
       
    72 	 * @deprecated
    62 	 */
    73 	 */
    63 	List<String> getTargetTypeMacros(String targettype);
    74 	List<String> getTargetTypeMacros(String targettype);
    64 
    75 
    65 	/**
    76 	/**
    66 	 * Get a list of macros that are used to distinguish a SDK. Typically only
    77 	 * Get a list of macros that are used to distinguish a SDK. Typically only
    67 	 * S603rd edition SDKs contain this information and it's used to differentiate between
    78 	 * S603rd edition SDKs contain this information and it's used to differentiate between
    68 	 * varios S60 SDK releases. Other vendors, such as UIQ may put their macros in the variant HRH file.
    79 	 * varios S60 SDK releases. Other vendors, such as UIQ may put their macros in the variant HRH file.
    69 	 * @return A list of macros just returned by name.
    80 	 * @return A list of macros just returned by name.
       
    81 	 * @deprecated
    70 	 */
    82 	 */
    71 	public List<String> getVendorSDKMacros();
    83 	public List<String> getVendorSDKMacros();
    72 
    84 
    73 	/**
    85 	/**
    74 	 * Tells whether or not the plug-in installer has sniffed this SDK for eclipse plug-ins to install.
    86 	 * Tells whether or not the plug-in installer has sniffed this SDK for eclipse plug-ins to install.
    75 	 * @return true if the SDK was scanned
    87 	 * @return true if the SDK was scanned
       
    88 	 * @deprecated
    76 	 */
    89 	 */
    77 	boolean isPreviouslyScanned();
    90 	boolean isPreviouslyScanned();
    78 
    91 	
       
    92 	/**
       
    93 	 * @deprecated
       
    94 	 */
    79 	void setPreviouslyScanned(boolean wasScanned);
    95 	void setPreviouslyScanned(boolean wasScanned);
    80 
    96 
    81 	/**
    97 	/**
    82 	 * Returns the list of all built in macros for this configuration. This is ABLD specific. SBSv2 gets these macros from the --query=config.
    98 	 * Returns the list of all built in macros for this configuration. This is ABLD specific. SBSv2 gets these macros from the --query=config.
    83 	 * <p>
    99 	 * <p>
    84 	 * Macros will be just a name, e.g. "_DEBUG", "__SYMBIAN32__", etc..
   100 	 * Macros will be just a name, e.g. "_DEBUG", "__SYMBIAN32__", etc..
    85 	 * </p>
   101 	 * </p>
    86 	 *
   102 	 *
    87 	 * @return a list of macros which may be empty.
   103 	 * @return a list of macros which may be empty.
       
   104 	 * @deprecated
    88 	 */
   105 	 */
    89 	List<String> getBuiltinMacros(ISymbianBuildContext context);
   106 	List<String> getBuiltinMacros(ISymbianBuildContext context);
    90 
   107 
    91 	/**
   108 	/**
    92 	 * Get a list of supported targettypes listed by this SDK. This routine parses the 
   109 	 * Get a list of supported targettypes listed by this SDK. This routine parses the 
    93 	 * \epoc32\tools\trgttype.pm file to build it's list.
   110 	 * \epoc32\tools\trgttype.pm file to build it's list.
    94 	 * @return A list of targettype names that can be used in an MMP file
   111 	 * @return A list of targettype names that can be used in an MMP file
       
   112 	 * @deprecated
    95 	 */
   113 	 */
    96 	List<String> getSupportedTargetTypes();
   114 	List<String> getSupportedTargetTypes();
    97 
   115 
    98 	
   116 	
    99 	/**
   117 	/**
   100 	 * Returns a list of the macros defined in the variant.cfg file. This is NOT the macros
   118 	 * Returns a list of the macros defined in the variant.cfg file. This is NOT the macros
   101 	 * in the HRH file, but the actual maros written to the variant.cfg file.
   119 	 * in the HRH file, but the actual maros written to the variant.cfg file.
   102 	 * @return A String list of macros found as is, or an empty list if none.
   120 	 * @return A String list of macros found as is, or an empty list if none.
       
   121 	 * @deprecated
   103 	 */
   122 	 */
   104 	List<String> getVariantCFGMacros();
   123 	List<String> getVariantCFGMacros();
   105 	
   124 	
   106 }
   125 }