carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_15) on Tue Jan 06 17:31:52 CST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>
BldInfViewPathHelper (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.cdt.builder.BldInfViewPathHelper class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="BldInfViewPathHelper (Carbide.c++ SDK API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BldInfViewPathHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/nokia/carbide/cdt/builder/AcceptedBuildContextNodesViewFilter.html" title="class in com.nokia.carbide.cdt.builder"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/nokia/carbide/cdt/builder/BuilderPreferenceConstants.html" title="class in com.nokia.carbide.cdt.builder"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html" target="_top"><B>FRAMES</B></A>
<A HREF="BldInfViewPathHelper.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.nokia.carbide.cdt.builder</FONT>
<BR>
Class BldInfViewPathHelper</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.nokia.carbide.cdt.builder.BldInfViewPathHelper</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>BldInfViewPathHelper</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class manages conversion of IPaths provided by an IBldInfView
back and forth to real-world paths in the filesystem or workspace.
<p>
In most cases, EpocEnginePathHelper is sufficient for this purpose.
The routines here are for use with the IExtension API provided by
<A HREF="../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IBldInfView.html#getExtensions()"><CODE>IBldInfView.getExtensions()</CODE></A>.
<p>
Instances of this class should be short-lived (e.g. if a project is
deleted or renamed, it may cease to work).
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html#epocRoot">epocRoot</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html#epocTemplatesRoot">epocTemplatesRoot</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html#BldInfViewPathHelper(com.nokia.carbide.cpp.epoc.engine.model.bldinf.IBldInfData, IPath)">BldInfViewPathHelper</A></B>(<A HREF="../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IBldInfData.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf">IBldInfData</A> data,
IPath epocRoot)</CODE>
<BR>
Construct an instance with the given epocRoot.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html#convertExtensionTemplateFromFilesystem(IPath)">convertExtensionTemplateFromFilesystem</A></B>(IPath path)</CODE>
<BR>
Convert the given full-path template makefile base path to the template
makefile-relative path.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html#convertExtensionTemplateToFilesystem(IPath)">convertExtensionTemplateToFilesystem</A></B>(IPath path)</CODE>
<BR>
Convert the given path (from an IExtension) into the full filesystem
path where its *.mk and *.meta files live.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html#isExtensionMakefileBuiltForPlatform(IPath, com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext)">isExtensionMakefileBuiltForPlatform</A></B>(IPath extensionMakefilePath,
<A HREF="../../../../../com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.html" title="interface in com.nokia.carbide.cpp.sdk.core">ISymbianBuildContext</A> buildContext)</CODE>
<BR>
Determine whether an extension makefile is suitable for the given build configuration.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="epocRoot"><!-- --></A><H3>
epocRoot</H3>
<PRE>
protected IPath <B>epocRoot</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="epocTemplatesRoot"><!-- --></A><H3>
epocTemplatesRoot</H3>
<PRE>
protected IPath <B>epocTemplatesRoot</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="BldInfViewPathHelper(com.nokia.carbide.cpp.epoc.engine.model.bldinf.IBldInfData, IPath)"><!-- --></A><H3>
BldInfViewPathHelper</H3>
<PRE>
public <B>BldInfViewPathHelper</B>(<A HREF="../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IBldInfData.html" title="interface in com.nokia.carbide.cpp.epoc.engine.model.bldinf">IBldInfData</A> data,
IPath epocRoot)</PRE>
<DL>
<DD>Construct an instance with the given epocRoot.
This constructor is used when a project doesn't exist yet.
<p>
In this configuration, if epocRoot==null,
<CODE>#convertbld.infToFilesystem(Ebld.infPathContext, IPath)</CODE> will return
null for EPOCROOT-relative paths.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>buildConfiguration</CODE> - </DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="convertExtensionTemplateToFilesystem(IPath)"><!-- --></A><H3>
convertExtensionTemplateToFilesystem</H3>
<PRE>
public IPath <B>convertExtensionTemplateToFilesystem</B>(IPath path)</PRE>
<DL>
<DD>Convert the given path (from an IExtension) into the full filesystem
path where its *.mk and *.meta files live.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - path from <A HREF="../../../../../com/nokia/carbide/cpp/epoc/engine/model/bldinf/IExtension.html#getTemplatePath()"><CODE>IExtension.getTemplatePath()</CODE></A>
<DT><B>Returns:</B><DD>absolute path, without file extension , or null if no EPOCROOT was passed.</DL>
</DD>
</DL>
<HR>
<A NAME="convertExtensionTemplateFromFilesystem(IPath)"><!-- --></A><H3>
convertExtensionTemplateFromFilesystem</H3>
<PRE>
public IPath <B>convertExtensionTemplateFromFilesystem</B>(IPath path)</PRE>
<DL>
<DD>Convert the given full-path template makefile base path to the template
makefile-relative path.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - full path
<DT><B>Returns:</B><DD>relative path, without file extension, or null if not representable</DL>
</DD>
</DL>
<HR>
<A NAME="isExtensionMakefileBuiltForPlatform(IPath, com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext)"><!-- --></A><H3>
isExtensionMakefileBuiltForPlatform</H3>
<PRE>
public boolean <B>isExtensionMakefileBuiltForPlatform</B>(IPath extensionMakefilePath,
<A HREF="../../../../../com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.html" title="interface in com.nokia.carbide.cpp.sdk.core">ISymbianBuildContext</A> buildContext)</PRE>
<DL>
<DD>Determine whether an extension makefile is suitable for the given build configuration.
This information is recorded in the *.meta file next to the *.mk file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>extensionMakefilePath</CODE> - resolved full path to extension makefile base (no extension)<DD><CODE>buildContext</CODE> - the build context being tested, may not be null
<DT><B>Returns:</B><DD>true if the makefile is appropriate to the build configuration</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BldInfViewPathHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/nokia/carbide/cdt/builder/AcceptedBuildContextNodesViewFilter.html" title="class in com.nokia.carbide.cdt.builder"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/nokia/carbide/cdt/builder/BuilderPreferenceConstants.html" title="class in com.nokia.carbide.cdt.builder"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/cdt/builder/BldInfViewPathHelper.html" target="_top"><B>FRAMES</B></A>
<A HREF="BldInfViewPathHelper.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div id="footer">Copyright © 2010 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>
</BODY>
</HTML>