%PDF- %PDF-
Direktori : /proc/self/root/proc/self/root/usr/share/nagios/html/docs/ |
Current File : //proc/self/root/proc/self/root/usr/share/nagios/html/docs/nspath_8h_source.html |
<!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>Nagios: nspath.h 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">Nagios  <span id="projectnumber">4.4.3</span> </div> <div id="projectbrief">Dev docs for Nagios core and neb-module hackers</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="annotated.html"><span>Data Structures</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>Globals</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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">nspath.h</div> </div> </div><!--header--> <div class="contents"> <a href="nspath_8h.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="preprocessor">#ifndef LIBNAGIOS_NSPATH_H_INCLUDED</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define LIBNAGIOS_NSPATH_H_INCLUDED</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef _GNU_SOURCE</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor"></span><span class="preprocessor"># ifndef NODOXY</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor"></span><span class="preprocessor"># define _GNU_SOURCE 1</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span><span class="preprocessor"># endif</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span><span class="preprocessor">#include <errno.h></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <sys/stat.h></span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "snprintf.h"</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/**</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * @file nspath.h</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * @brief path handling functions</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * This library handles path normalization and resolution. It's nifty</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * if you want to turn relative paths into absolute ones, or if you</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * want to make insane ones sane, but without chdir()'ing your way</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * around the filesystem.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> *</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @{</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> */</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/**</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * Normalize a path</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * By "normalize", we mean that we convert dot-slash and dot-dot-slash</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * embedded components into a legible continuous string of characters.</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Leading and trailing slashes are kept exactly as they are in input,</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * but with sequences of slashes reduced to a single one.</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> *</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * "foo/bar/.././lala.txt" becomes "foo/lala.txt"</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * "../../../../bar/../foo/" becomes "/foo/"</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * "////foo////././bar" becomes "/foo/bar"</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @param orig_path The path to normalize</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @return A newly allocated string containing the normalized path</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> */</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">extern</span> <span class="keywordtype">char</span> *<a class="code" href="nspath_8h.html#a7874661cba4d6ffb5457eed16d0288a4">nspath_normalize</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *orig_path);</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/**</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * Make the "base"-relative path "rel_path" absolute.</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * Turns the relative path "rel_path" into an absolute path and</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * resolves it as if we were currently in "base". If "base" is</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * NULL, the current working directory is used. If "base" is not</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * null, it should be an absolute path for the result to make</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * sense.</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @param rel_path The relative path to convert</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param base The base directory (if NULL, we use current working dir)</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @return A newly allocated string containing the absolute path</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">extern</span> <span class="keywordtype">char</span> *<a class="code" href="nspath_8h.html#ade9ccb53fdbcc123b9468603b1ff2919">nspath_absolute</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *rel_path, <span class="keyword">const</span> <span class="keywordtype">char</span> *base);</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/**</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * Canonicalize the "base"-relative path "rel_path".</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * errno gets properly set in case of errors.</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @param rel_path The path to transform</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @param base The base we should operate relative to</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @return Newly allocated canonical path on success, NULL on errors</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> */</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">extern</span> <span class="keywordtype">char</span> *<a class="code" href="nspath_8h.html#aba277ee8aa56daaf0512aa278b68400c">nspath_real</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *rel_path, <span class="keyword">const</span> <span class="keywordtype">char</span> *base);</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/**</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * Get absolute dirname of "path", relative to "base"</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @param path Full path to target object (file or subdir)</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param base The base directory (if NULL, we use current working dir)</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @return NULL on errors, allocated absolute directory name on success</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">extern</span> <span class="keywordtype">char</span> *<a class="code" href="nspath_8h.html#a33faaeee14f2933798ec177d9d9ccc7b">nspath_absolute_dirname</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *base);</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> <span class="comment"></span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/**</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * Recursively create a directory, just like mkdir_p would.</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @note This function *will* taint errno with ENOENT if any path</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * component has to be created.</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @note If "path" has a trailing slash, NSPATH_MKDIR_SKIP_LAST</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * won't have any effect. That's considered a feature, since the</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * option is designed so one can send a file-path to the function</span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * and have it create the directory structure for it.</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param path Path to create, in normalized form</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param mode Filemode (same as mkdir() takes)</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @param options Options flag. See NSPATH_MKDIR_* for or-able options</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @return 0 on success, -1 on errors and errno will hold error code</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * from either stat() or mkdir().</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> */</span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="nspath_8h.html#a1afa9d79f14a4b33413f5dbdaa12e262">nspath_mkdir_p</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, mode_t mode, <span class="keywordtype">int</span> options);</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/** Don't mkdir() last element of path when calling nspath_mkdir_p() */</span></div> <div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="nspath_8h.html#a5345faf70185d3be4d5c1cd46dbc314a"> 88</a></span> <span class="preprocessor">#define NSPATH_MKDIR_SKIP_LAST (1 << 0)</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/** @} */</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif</span></div> <div class="ttc" id="nspath_8h_html_a7874661cba4d6ffb5457eed16d0288a4"><div class="ttname"><a href="nspath_8h.html#a7874661cba4d6ffb5457eed16d0288a4">nspath_normalize</a></div><div class="ttdeci">char * nspath_normalize(const char *orig_path)</div><div class="ttdoc">Normalize a path By &quot;normalize&quot;, we mean that we convert dot-slash and dot-dot-slash embedded compone...</div></div> <div class="ttc" id="nspath_8h_html_aba277ee8aa56daaf0512aa278b68400c"><div class="ttname"><a href="nspath_8h.html#aba277ee8aa56daaf0512aa278b68400c">nspath_real</a></div><div class="ttdeci">char * nspath_real(const char *rel_path, const char *base)</div><div class="ttdoc">Canonicalize the &quot;base&quot;-relative path &quot;rel_path&quot;. </div></div> <div class="ttc" id="nspath_8h_html_ade9ccb53fdbcc123b9468603b1ff2919"><div class="ttname"><a href="nspath_8h.html#ade9ccb53fdbcc123b9468603b1ff2919">nspath_absolute</a></div><div class="ttdeci">char * nspath_absolute(const char *rel_path, const char *base)</div><div class="ttdoc">Make the &quot;base&quot;-relative path &quot;rel_path&quot; absolute. </div></div> <div class="ttc" id="nspath_8h_html_a33faaeee14f2933798ec177d9d9ccc7b"><div class="ttname"><a href="nspath_8h.html#a33faaeee14f2933798ec177d9d9ccc7b">nspath_absolute_dirname</a></div><div class="ttdeci">char * nspath_absolute_dirname(const char *path, const char *base)</div><div class="ttdoc">Get absolute dirname of &quot;path&quot;, relative to &quot;base&quot;. </div></div> <div class="ttc" id="nspath_8h_html_a1afa9d79f14a4b33413f5dbdaa12e262"><div class="ttname"><a href="nspath_8h.html#a1afa9d79f14a4b33413f5dbdaa12e262">nspath_mkdir_p</a></div><div class="ttdeci">int nspath_mkdir_p(const char *path, mode_t mode, int options)</div><div class="ttdoc">Recursively create a directory, just like mkdir_p would. </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>