carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/cdt/builder/PKGViewPathHelper.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>
PKGViewPathHelper (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.cdt.builder.PKGViewPathHelper class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="PKGViewPathHelper (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/PKGViewPathHelper.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/MMPViewPathHelper.html" title="class in com.nokia.carbide.cdt.builder"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/cdt/builder/PKGViewPathHelper.html" target="_top"><B>FRAMES</B></A>
<A HREF="PKGViewPathHelper.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <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 PKGViewPathHelper</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.nokia.carbide.cdt.builder.PKGViewPathHelper</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>PKGViewPathHelper</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Helper to resolve paths used in pkg files.
<p>
When building a pkg file, you can pass a search directory to makesis (-d) and it will
look for any files without paths in that search directory. Carbide also lets you specify
macros in the PKG file that need to be expanded, e.g. $(EPOCROOT)
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.3</DD>
</DL>
<HR>
<P>
<!-- ======== 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/PKGViewPathHelper.html#PKGViewPathHelper(IPath, IPath, java.lang.String, java.lang.String)">PKGViewPathHelper</A></B>(IPath pkgFilePath,
IPath epocRoot,
java.lang.String platform,
java.lang.String target)</CODE>
<BR>
Constructor for test purposes or for out-of-project experiences.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/PKGViewPathHelper.html#PKGViewPathHelper(com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGView, com.nokia.carbide.cdt.builder.project.ICarbideBuildConfiguration)">PKGViewPathHelper</A></B>(com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGView view,
<A HREF="../../../../../com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.html" title="interface in com.nokia.carbide.cdt.builder.project">ICarbideBuildConfiguration</A> buildConfig)</CODE>
<BR>
Construct an instance using the given PKG view, to provide the
content search location.</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/PKGViewPathHelper.html#getAbsolutePathFromViewPath(IPath)">getAbsolutePathFromViewPath</A></B>(IPath path)</CODE>
<BR>
Given a source install-file path from an IPKGInstallFile, convert it to an absolute
file system 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/PKGViewPathHelper.html#getMainDirectory()">getMainDirectory</A></B>()</CODE>
<BR>
Returns the main directory used as the basis for relative path lookups</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/PKGViewPathHelper.html#getViewPathFromAbsolutePath(IPath)">getViewPathFromAbsolutePath</A></B>(IPath path)</CODE>
<BR>
Converts an absolute path to a pkg view path.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/PKGViewPathHelper.html#setMainDirectory(IPath)">setMainDirectory</A></B>(IPath mainDirectory)</CODE>
<BR>
Sets the main directory to use as the basis for relative path lookups</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/cdt/builder/PKGViewPathHelper.html#setSISBuilderInfo(com.nokia.carbide.cdt.builder.project.ISISBuilderInfo)">setSISBuilderInfo</A></B>(<A HREF="../../../../../com/nokia/carbide/cdt/builder/project/ISISBuilderInfo.html" title="interface in com.nokia.carbide.cdt.builder.project">ISISBuilderInfo</A> sisInfo)</CODE>
<BR>
</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>
<!-- ========= 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="PKGViewPathHelper(com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGView, com.nokia.carbide.cdt.builder.project.ICarbideBuildConfiguration)"><!-- --></A><H3>
PKGViewPathHelper</H3>
<PRE>
public <B>PKGViewPathHelper</B>(com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGView view,
<A HREF="../../../../../com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.html" title="interface in com.nokia.carbide.cdt.builder.project">ICarbideBuildConfiguration</A> buildConfig)</PRE>
<DL>
<DD>Construct an instance using the given PKG view, to provide the
content search location.
<p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>view</CODE> - the non-null PKG view (does not take ownership)<DD><CODE>buildConfig</CODE> - the build configuration context. this will be used for expanding PKG macros
and obtaining the content search location, unless set from</DL>
</DL>
<HR>
<A NAME="PKGViewPathHelper(IPath, IPath, java.lang.String, java.lang.String)"><!-- --></A><H3>
PKGViewPathHelper</H3>
<PRE>
public <B>PKGViewPathHelper</B>(IPath pkgFilePath,
IPath epocRoot,
java.lang.String platform,
java.lang.String target)</PRE>
<DL>
<DD>Constructor for test purposes or for out-of-project experiences.
<P>
</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="setSISBuilderInfo(com.nokia.carbide.cdt.builder.project.ISISBuilderInfo)"><!-- --></A><H3>
setSISBuilderInfo</H3>
<PRE>
public void <B>setSISBuilderInfo</B>(<A HREF="../../../../../com/nokia/carbide/cdt/builder/project/ISISBuilderInfo.html" title="interface in com.nokia.carbide.cdt.builder.project">ISISBuilderInfo</A> sisInfo)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMainDirectory()"><!-- --></A><H3>
getMainDirectory</H3>
<PRE>
public IPath <B>getMainDirectory</B>()</PRE>
<DL>
<DD>Returns the main directory used as the basis for relative path lookups
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setMainDirectory(IPath)"><!-- --></A><H3>
setMainDirectory</H3>
<PRE>
public void <B>setMainDirectory</B>(IPath mainDirectory)</PRE>
<DL>
<DD>Sets the main directory to use as the basis for relative path lookups
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAbsolutePathFromViewPath(IPath)"><!-- --></A><H3>
getAbsolutePathFromViewPath</H3>
<PRE>
public IPath <B>getAbsolutePathFromViewPath</B>(IPath path)</PRE>
<DL>
<DD>Given a source install-file path from an IPKGInstallFile, convert it to an absolute
file system path. Any Carbide macros in the path will be expanded
(see , ,
.
<p>
Non-absolute paths will first try to be resolved relative to the pkg file directory. If the file
does not exist, we will try to resolve it relative to the search location (when available). If
still not found, the path will be returned relative to the pkg file location.
The content search location will be obtained from the ISISBuilderInfo. The ISISBuilderInfo set from
<A HREF="../../../../../com/nokia/carbide/cdt/builder/PKGViewPathHelper.html#setSISBuilderInfo(com.nokia.carbide.cdt.builder.project.ISISBuilderInfo)"><CODE>setSISBuilderInfo(ISISBuilderInfo)</CODE></A> will be used when set, otherwise the first ISISBuilderInfo
in the build configuration that matches the pkg file will be used.
<p>
Note that the makesis source code was examined to determine the search order, and it it looks relative
to the pkg file directory before checking the search directory. It will of course bail though if either
does not exist. Since this helper is not designed to check for the existence of the file, but rather to
return the path where the file should be, there may be cases where we return the wrong file path.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - relative or absolute path from a IPKGInstallFile
<DT><B>Returns:</B><DD>absolute path for an existing or candidate file</DL>
</DD>
</DL>
<HR>
<A NAME="getViewPathFromAbsolutePath(IPath)"><!-- --></A><H3>
getViewPathFromAbsolutePath</H3>
<PRE>
public IPath <B>getViewPathFromAbsolutePath</B>(IPath path)</PRE>
<DL>
<DD>Converts an absolute path to a pkg view path. If the content search location is a prefix
of the absolute path, a path relative to the search location will be returned. Otherwise
the absolute path will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - absolute path
<DT><B>Returns:</B><DD>view path</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/PKGViewPathHelper.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/MMPViewPathHelper.html" title="class in com.nokia.carbide.cdt.builder"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/cdt/builder/PKGViewPathHelper.html" target="_top"><B>FRAMES</B></A>
<A HREF="PKGViewPathHelper.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <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>