carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/tasks/sdk_getinfmmpinfo.htm
author cawthron
Wed, 29 Apr 2009 16:06:32 -0500
branchRCL_2_0
changeset 136 34dd9d46f3ea
parent 2 d760517a8095
child 1704 24ac5a5cf80c
permissions -rw-r--r--
add second line to about box for SymSEE build number
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
cawthron
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
cawthron
parents:
diff changeset
     2
<html xmlns="http://www.w3.org/1999/xhtml">
cawthron
parents:
diff changeset
     3
<head>
cawthron
parents:
diff changeset
     4
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
cawthron
parents:
diff changeset
     5
<title>Retrieving INF/MMP Project Information</title>
cawthron
parents:
diff changeset
     6
<link rel="StyleSheet" href="../../book.css" type="text/css"/>
cawthron
parents:
diff changeset
     7
</head>
cawthron
parents:
diff changeset
     8
<body bgcolor="#FFFFFF">
cawthron
parents:
diff changeset
     9
cawthron
parents:
diff changeset
    10
<h2>Retrieving INF/MMP Project Information</h2>
cawthron
parents:
diff changeset
    11
<p>All Carbide build stages, with the exception of the post-link SIS Builder   stage get their data from INF and MMP files. So naturally Carbide needs a way to   retrieve and store this data for doing things like setting up the source indexer   and displaying the visual INF and MMP editors. The com.nokia.carbide.cdt.builder.<STRONG>EpocEngineHelper</STRONG> class is a good first stop to retrieve this information. For example, if you want   to get all the source files in the first MMP file:</p>
cawthron
parents:
diff changeset
    12
<p class="listing">// ...assumes ICarbideProjectInformation (cpi) is known.<br>
cawthron
parents:
diff changeset
    13
  List&lt;IPath&gt; mmpPaths = EpocEngineHelper.getMMPFilesForProject(cpi);<br>
cawthron
parents:
diff changeset
    14
// array length check omitted for brevity....<br>
cawthron
parents:
diff changeset
    15
List&lt;IPath&gt; srcFilesTest = EpocEngineHelper.getSourceFilesForConfiguration(defultConfig, mmpPaths.get(0));</p>
cawthron
parents:
diff changeset
    16
<h3>SDK Management</h3>
cawthron
parents:
diff changeset
    17
<p>Each SDK entry in devices.xml is analogous to a   com.nokia.carbide.cpp.sdk.core.<STRONG>ISymbianSDK</STRONG> object. If you want to get the entire list of ISymbianSDK   objects (same list and properties from the SDK Preferences page) you   simply invoke:</p>
cawthron
parents:
diff changeset
    18
<p class="listing">ISDKManager sdkMgr = SDKCorePlugin.getSDKManager();<br>
cawthron
parents:
diff changeset
    19
List&lt;ISymbianSDK&gt; sdkList = sdkMgr.getSDKList();</p>
cawthron
parents:
diff changeset
    20
<p>Now you can iterate the list and get whatever information you want out of the   installed SDKs. For example, using Java 5 iterators we can get the EPOCROOT   values of all the SDKs:</p>
cawthron
parents:
diff changeset
    21
<p class="listing">for (ISymbianSDK currSDK : sdkList){
cawthron
parents:
diff changeset
    22
   <br>
cawthron
parents:
diff changeset
    23
  &nbsp;&nbsp;&nbsp;&nbsp;String epocRootStr = currSDK.getEPOCROOT();<br>
cawthron
parents:
diff changeset
    24
}</p>
cawthron
parents:
diff changeset
    25
<h3>Reading MMP Statements with the EpocEngine and IMMPData</h3>
cawthron
parents:
diff changeset
    26
<p>This topic demonstrates how you can read the MMP data for any build   configuration (ICarbideBuildConfiguration). The main interface for retrieving   MMP data is <strong>com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPData</strong>. Once you get   access to this interface you can learn anything you want about a particular MMP file.</p>
cawthron
parents:
diff changeset
    27
<p><strong>Prerequisite:</strong> All MMP and bld.inf parsing requires a dependency to the plugin   <strong>com.nokia.carbide.cpp.epoc.engine</strong>.</p>
cawthron
parents:
diff changeset
    28
<p>Typically most keywords of interest are either single string settings   (TARGETTYPE, TARGET, EPOCSTACKSIZE) or list of settings (MACRO, CAPABILITY,   LANG). Other types can be directly retrieved from IMMPData routines. Check the   API documentation for specifics.</p>
cawthron
parents:
diff changeset
    29
<p>The example provided simply iterates through all the MMP files of a   particular build configuration and grabs a list value and single item setting.   You'll need to get the particular MMP file you are interested in. Play around   with the IMMPData object in the run method and you can quickly get the idea.</p>
cawthron
parents:
diff changeset
    30
<PRE class="listing">// Assumes buildConfig (ICarbideBuildConfiguration) is known
cawthron
parents:
diff changeset
    31
for (IPath mmpPath : EpocEngineHelper.getMMPFilesForBuildConfiguration(buildConfig)) {
cawthron
parents:
diff changeset
    32
     Object data = EpocEnginePlugin.runWithMMPData(mmpPath,  new
cawthron
parents:
diff changeset
    33
                              DefaultMMPViewConfiguration(buildConfig.getCarbideProject().getProject(),
cawthron
parents:
diff changeset
    34
                              buildConfig, new AcceptedNodesViewFilter()),  new MMPDataRunnableAdapter() {
cawthron
parents:
diff changeset
    35
                        public Object run(IMMPData mmpData) {
cawthron
parents:
diff changeset
    36
                          // Example, getting a keyword as a list of strings
cawthron
parents:
diff changeset
    37
                          List macros = mmpData.getListArgumentSettings().get(EMMPStatement.MACRO);
cawthron
parents:
diff changeset
    38
                          // The real return value, getting a single argument setting
cawthron
parents:
diff changeset
    39
                         return mmpData.getSingleArgumentSettings().get(EMMPStatement.TARGETTYPE);
cawthron
parents:
diff changeset
    40
		  	                }   
cawthron
parents:
diff changeset
    41
      });
cawthron
parents:
diff changeset
    42
// Make sure to test for and cast to proper Object type!
cawthron
parents:
diff changeset
    43
String mmpStatement = (String)data;  // Now we should have the TARGETTYPE
cawthron
parents:
diff changeset
    44
}</PRE>
cawthron
parents:
diff changeset
    45
<div id="footer">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div></div>
cawthron
parents:
diff changeset
    46
</body>
cawthron
parents:
diff changeset
    47
</html>