core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/ISBSv2BuildInfo.java
author timkelly
Mon, 14 Jun 2010 13:24:47 -0500
branchC3_BUILDER_WORK
changeset 1471 62024a5fa81d
parent 1462 b38491fd06da
child 1568 508bfdb3a934
permissions -rw-r--r--
Refactor out BSF/SBV support from SBSv2 Builder data. Create new package for SBSv2Query APIs (moved from builder tests).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     1
/*
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). 
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     3
* All rights reserved.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     4
* This component and the accompanying materials are made available
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     6
* which accompanies this distribution, and is available
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     8
*
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
     9
* Initial Contributors:
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    11
*
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    12
*/
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    13
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    14
package com.nokia.carbide.cpp.internal.api.sdk;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    15
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    16
import java.util.List;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    17
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    18
import org.eclipse.core.runtime.IPath;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    19
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    20
import com.nokia.carbide.cpp.sdk.core.ISDKBuildInfo;
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    21
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    22
/**
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    23
 * Interface for SBSv2 specific build information.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    24
 *
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    25
 */
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    26
public interface ISBSv2BuildInfo extends ISDKBuildInfo {
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    27
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    28
	void clearPlatformMacros();
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    29
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    30
	/**
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    31
	 * Returns the list of all platform macros for a SDK.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    32
	 * <p>
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    33
	 * This is somewhat equivalent to calling "bldmake plat" on the command line
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    34
	 * These are the macros that can be used in MMP and INF files. They are only given by name (no value)
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    35
	 * </p>
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    36
	 * @param platform the platform name
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    37
	 * @return a list of macros, which may be empty.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    38
	 */
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    39
	List<String> getPlatformMacros(String platform);
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    40
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    41
	/**
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    42
	 * Get the full path to the prefix file defined under \epoc32\tools\variant\variant.cfg
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    43
	 * @return A path object, or null if the variant.cfg does not exist. This routine does not check to see if the returned path exists.
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    44
	 */
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    45
	public IPath getPrefixFromVariantCfg();
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    46
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    47
	/**
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    48
	 * Get a list of macros specific to the given target type, e.g. "__EXE__" or "__DLL__"
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    49
	 * @param targettype
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    50
	 * @return list of macro strings, may be empty
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    51
	 */
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    52
	List<String> getTargetTypeMacros(String targettype);
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    53
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    54
	/**
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    55
	 * Tells whether or not the plug-in installer has sniffed this SDK for eclipse plug-ins to install.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    56
	 * @return true if the SDK was scanned.
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    57
	 * @since 2.0
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    58
	 */
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    59
	boolean isPreviouslyScanned();
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    60
1462
b38491fd06da More ISymbianSDK refactoring.
stechong
parents: 1434
diff changeset
    61
	void setPreviouslyScanned(boolean wasScanned);
1434
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    62
79471fd1fd69 First pass refactoring ISymbianSDK.
stechong
parents:
diff changeset
    63
}