Repository URL to install this package:
|
Version:
6.3.5.2-2 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>LibreOffice: salhelper/linkhelper.hxx Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">LibreOffice
</div>
<div id="projectbrief">LibreOffice 6.3 SDK C/C++ API Reference</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_53aa4ad1b831e9847d1f4a68148b5df1.html">salhelper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">linkhelper.hxx</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00413.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This file is part of the LibreOffice project.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef INCLUDED_SALHELPER_LINKHELPER_HXX</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_SALHELPER_LINKHELPER_HXX</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="a00399.html">rtl/ustring.hxx</a>"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="a00343.html">osl/file.hxx</a>"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>salhelper</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="a00126.html"> 18</a></span>  <span class="keyword">class </span><a class="code" href="a00409.html#af3f9a0ae90b2fa68c7ccb7488d0f4304">SAL_WARN_UNUSED</a> <a class="code" href="a00126.html">LinkResolver</a></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="a00126.html#a98f496864272671bbac694bc81d76da1"> 21</a></span>  <a class="code" href="a00092.html">osl::FileStatus</a> <a class="code" href="a00126.html#a98f496864272671bbac694bc81d76da1">m_aStatus</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="a00126.html#a1887764a729420a285c3b2d20d3e583e"> 23</a></span>  <a class="code" href="a00126.html#a1887764a729420a285c3b2d20d3e583e">LinkResolver</a>(sal_uInt32 nMask)</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  : m_aStatus(nMask |</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="a00462.html#ga941355da90c7c2f40f0148adbe98a3eb">osl_FileStatus_Mask_FileURL</a> |</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="a00462.html#ga7b59b8cdd6503dec80f0f1a8185afa98">osl_FileStatus_Mask_Type</a> |</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="a00462.html#ga96a32768216edca6085a2e360165a217">osl_FileStatus_Mask_LinkTargetURL</a>)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  }</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="a00126.html#a6e0c84f5fdf2f5402e331d869d81d771"> 38</a></span>  <a class="code" href="a00091.html#ae2e12b95c2df5b6cab62104982151c7e">osl::FileBase::RC</a> <a class="code" href="a00126.html#a6e0c84f5fdf2f5402e331d869d81d771">fetchFileStatus</a>(<span class="keyword">const</span> <a class="code" href="a00152.html">rtl::OUString</a> &rURL,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">int</span> nDepth = 128)</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">//In an ideal world this wouldn't be inline, but I want to use this</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">//in jvmfwk hence salhelper, but salhelper is .map controlled and</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">//getting all the mangled names right is a misery, moving it over</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">//to visibility markup would drop per-symbol versioning</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="a00091.html#ae2e12b95c2df5b6cab62104982151c7e">osl::FileBase::RC</a> eReturn;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="a00076.html">osl::DirectoryItem</a> item;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="a00152.html">rtl::OUString</a> sURL(rURL);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">while</span> ((eReturn = <a class="code" href="a00076.html#a85df12ae96f16a48149017e3c9b5ddb1">osl::DirectoryItem::get</a>(sURL, item))</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  == <a class="code" href="a00091.html#ae2e12b95c2df5b6cab62104982151c7eaf8fa12839b0aaa709fb51e0b41d58a2e">osl::File::E_None</a>)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (--nDepth == 0)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  eReturn = <a class="code" href="a00091.html#ae2e12b95c2df5b6cab62104982151c7ea67d1d3964adb9be07eabb71147825c74">osl::FileBase::E_MULTIHOP</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  eReturn = item.<a class="code" href="a00076.html#ae16d2a1763d79c19d5f2e2da21a0d545">getFileStatus</a>(m_aStatus);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">if</span> (eReturn != <a class="code" href="a00091.html#ae2e12b95c2df5b6cab62104982151c7eaf8fa12839b0aaa709fb51e0b41d58a2e">osl::File::E_None</a>)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">if</span> (m_aStatus.getFileType() != <a class="code" href="a00092.html#a17884cd168469537e71c44a0813c8d2bac8fb6558e56738537a922173f46f47c0">osl::FileStatus::Link</a>)</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  eReturn = <a class="code" href="a00091.html#ae2e12b95c2df5b6cab62104982151c7eaf8fa12839b0aaa709fb51e0b41d58a2e">osl::FileBase::E_None</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  sURL = m_aStatus.getLinkTargetURL();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> eReturn;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  };</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div>
<div class="ttc" id="a00076_html"><div class="ttname"><a href="a00076.html">osl::DirectoryItem</a></div><div class="ttdoc">The directory item class object provides access to file status information. </div><div class="ttdef"><b>Definition:</b> file.hxx:1429</div></div>
<div class="ttc" id="a00126_html_a6e0c84f5fdf2f5402e331d869d81d771"><div class="ttname"><a href="a00126.html#a6e0c84f5fdf2f5402e331d869d81d771">salhelper::LinkResolver::fetchFileStatus</a></div><div class="ttdeci">osl::FileBase::RC fetchFileStatus(const rtl::OUString &rURL, int nDepth=128)</div><div class="ttdoc">Resolve a file url if it&#39;s a symbolic link, to a maximum depth of nDepth and fill in m_aStatus with t...</div><div class="ttdef"><b>Definition:</b> linkhelper.hxx:38</div></div>
<div class="ttc" id="a00126_html_a1887764a729420a285c3b2d20d3e583e"><div class="ttname"><a href="a00126.html#a1887764a729420a285c3b2d20d3e583e">salhelper::LinkResolver::LinkResolver</a></div><div class="ttdeci">LinkResolver(sal_uInt32 nMask)</div><div class="ttdef"><b>Definition:</b> linkhelper.hxx:23</div></div>
<div class="ttc" id="a00076_html_ae16d2a1763d79c19d5f2e2da21a0d545"><div class="ttname"><a href="a00076.html#ae16d2a1763d79c19d5f2e2da21a0d545">osl::DirectoryItem::getFileStatus</a></div><div class="ttdeci">RC getFileStatus(FileStatus &rStatus)</div><div class="ttdoc">Retrieve information about a single file or directory. </div><div class="ttdef"><b>Definition:</b> file.hxx:1564</div></div>
<div class="ttc" id="a00091_html_ae2e12b95c2df5b6cab62104982151c7eaf8fa12839b0aaa709fb51e0b41d58a2e"><div class="ttname"><a href="a00091.html#ae2e12b95c2df5b6cab62104982151c7eaf8fa12839b0aaa709fb51e0b41d58a2e">osl::FileBase::E_None</a></div><div class="ttdoc">on success </div><div class="ttdef"><b>Definition:</b> file.hxx:54</div></div>
<div class="ttc" id="a00343_html"><div class="ttname"><a href="a00343.html">file.hxx</a></div></div>
<div class="ttc" id="a00399_html"><div class="ttname"><a href="a00399.html">ustring.hxx</a></div></div>
<div class="ttc" id="a00462_html_ga941355da90c7c2f40f0148adbe98a3eb"><div class="ttname"><a href="a00462.html#ga941355da90c7c2f40f0148adbe98a3eb">osl_FileStatus_Mask_FileURL</a></div><div class="ttdeci">#define osl_FileStatus_Mask_FileURL</div><div class="ttdef"><b>Definition:</b> file.h:367</div></div>
<div class="ttc" id="a00126_html"><div class="ttname"><a href="a00126.html">salhelper::LinkResolver</a></div><div class="ttdef"><b>Definition:</b> linkhelper.hxx:18</div></div>
<div class="ttc" id="a00462_html_ga96a32768216edca6085a2e360165a217"><div class="ttname"><a href="a00462.html#ga96a32768216edca6085a2e360165a217">osl_FileStatus_Mask_LinkTargetURL</a></div><div class="ttdeci">#define osl_FileStatus_Mask_LinkTargetURL</div><div class="ttdef"><b>Definition:</b> file.h:368</div></div>
<div class="ttc" id="a00091_html_ae2e12b95c2df5b6cab62104982151c7e"><div class="ttname"><a href="a00091.html#ae2e12b95c2df5b6cab62104982151c7e">osl::FileBase::RC</a></div><div class="ttdeci">RC</div><div class="ttdef"><b>Definition:</b> file.hxx:53</div></div>
<div class="ttc" id="a00126_html_a98f496864272671bbac694bc81d76da1"><div class="ttname"><a href="a00126.html#a98f496864272671bbac694bc81d76da1">salhelper::LinkResolver::m_aStatus</a></div><div class="ttdeci">osl::FileStatus m_aStatus</div><div class="ttdef"><b>Definition:</b> linkhelper.hxx:21</div></div>
<div class="ttc" id="a00152_html"><div class="ttname"><a href="a00152.html">rtl::OUString</a></div><div class="ttdoc">This String class provides base functionality for C++ like Unicode character array handling...</div><div class="ttdef"><b>Definition:</b> ustring.hxx:126</div></div>
<div class="ttc" id="a00091_html_ae2e12b95c2df5b6cab62104982151c7ea67d1d3964adb9be07eabb71147825c74"><div class="ttname"><a href="a00091.html#ae2e12b95c2df5b6cab62104982151c7ea67d1d3964adb9be07eabb71147825c74">osl::FileBase::E_MULTIHOP</a></div><div class="ttdoc">remote resource is not directly available </div><div class="ttdef"><b>Definition:</b> file.hxx:95</div></div>
<div class="ttc" id="a00092_html"><div class="ttname"><a href="a00092.html">osl::FileStatus</a></div><div class="ttdoc">The FileStatus class. </div><div class="ttdef"><b>Definition:</b> file.hxx:634</div></div>
<div class="ttc" id="a00076_html_a85df12ae96f16a48149017e3c9b5ddb1"><div class="ttname"><a href="a00076.html#a85df12ae96f16a48149017e3c9b5ddb1">osl::DirectoryItem::get</a></div><div class="ttdeci">static RC get(const ::rtl::OUString &ustrFileURL, DirectoryItem &rItem)</div><div class="ttdoc">Retrieve a single directory item. </div><div class="ttdef"><b>Definition:</b> file.hxx:1522</div></div>
<div class="ttc" id="a00462_html_ga7b59b8cdd6503dec80f0f1a8185afa98"><div class="ttname"><a href="a00462.html#ga7b59b8cdd6503dec80f0f1a8185afa98">osl_FileStatus_Mask_Type</a></div><div class="ttdeci">#define osl_FileStatus_Mask_Type</div><div class="ttdef"><b>Definition:</b> file.h:360</div></div>
<div class="ttc" id="a00092_html_a17884cd168469537e71c44a0813c8d2bac8fb6558e56738537a922173f46f47c0"><div class="ttname"><a href="a00092.html#a17884cd168469537e71c44a0813c8d2bac8fb6558e56738537a922173f46f47c0">osl::FileStatus::Link</a></div><div class="ttdef"><b>Definition:</b> file.hxx:657</div></div>
<div class="ttc" id="a00409_html_af3f9a0ae90b2fa68c7ccb7488d0f4304"><div class="ttname"><a href="a00409.html#af3f9a0ae90b2fa68c7ccb7488d0f4304">SAL_WARN_UNUSED</a></div><div class="ttdeci">#define SAL_WARN_UNUSED</div><div class="ttdoc">Annotate classes where a compiler should warn if an instance is unused. </div><div class="ttdef"><b>Definition:</b> types.h:578</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>