doc/third_party/Pluma/html/Dir_8cpp_source.htm

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3     <head>
   4         <title>Pluma - Plug-in Management Framework</title>
   5         <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
   6         <link href="doxygen.css" rel="stylesheet" type="text/css" />
   7         <link href="tabs.css" rel="stylesheet" type="text/css" />
   8     </head>
   9     <body>
  10         <div id="logo">
  11             <img src="./logo.png" title="Pluma home" alt="Pluma logo" />
  12         </div>
  13 <!-- Generated by Doxygen 1.8.6 -->
  14   <div id="navrow1" class="tabs">
  15     <ul class="tablist">
  16       <li><a href="index.htm"><span>Main&#160;Page</span></a></li>
  17       <li><a href="annotated.htm"><span>Classes</span></a></li>
  18       <li class="current"><a href="files.htm"><span>Files</span></a></li>
  19     </ul>
  20   </div>
  21   <div id="navrow2" class="tabs2">
  22     <ul class="tablist">
  23       <li><a href="files.htm"><span>File&#160;List</span></a></li>
  24     </ul>
  25   </div>
  26 </div><!-- top -->
  27 <div class="header">
  28   <div class="headertitle">
  29 <div class="title">Dir.cpp</div>  </div>
  30 </div><!--header-->
  31 <div class="contents">
  32 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div>
  33 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// Pluma - Plug-in Management Framework</span></div>
  34 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Copyright (C) 2010-2012 Gil Costa (gsaurus@gmail.com)</span></div>
  35 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//</span></div>
  36 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// This software is provided &#39;as-is&#39;, without any express or implied warranty.</span></div>
  37 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
  38 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//</span></div>
  39 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
  40 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
  41 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// subject to the following restrictions:</span></div>
  42 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//</span></div>
  43 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
  44 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//    you must not claim that you wrote the original software.</span></div>
  45 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//    If you use this software in a product, an acknowledgment</span></div>
  46 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">//    in the product documentation would be appreciated but is not required.</span></div>
  47 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">//</span></div>
  48 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
  49 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">//    and must not be misrepresented as being the original software.</span></div>
  50 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">//</span></div>
  51 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
  52 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">//</span></div>
  53 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"></span></div>
  54 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
  55 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">// Headers</span></div>
  56 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span><span class="preprocessor">#include &lt;Pluma/Dir.hpp&gt;</span></div>
  57 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &lt;Pluma/uce-dirent.h&gt;</span></div>
  58 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &lt;cstdio&gt;</span></div>
  59 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &lt;queue&gt;</span></div>
  60 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
  61 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
  62 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">namespace </span>pluma{</div>
  63 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
  64 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">namespace </span>dir{</div>
  65 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div>
  66 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
  67 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keywordtype">void</span> listFiles(std::list&lt;std::string&gt;&amp; list, <span class="keyword">const</span> std::string&amp; folder, <span class="keyword">const</span> std::string&amp; extension, <span class="keywordtype">bool</span> recursive){</div>
  68 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    DIR* dir;</div>
  69 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    DIR* subDir;</div>
  70 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keyword">struct </span>dirent *ent;</div>
  71 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="comment">// try to open top folder</span></div>
  72 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    dir = opendir(folder.c_str());</div>
  73 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keywordflow">if</span> (dir == NULL){</div>
  74 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;        <span class="comment">// could not open directory</span></div>
  75 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;      fprintf(stderr, <span class="stringliteral">&quot;Could not open \&quot;%s\&quot; directory.\n&quot;</span>, folder.c_str());</div>
  76 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;      <span class="keywordflow">return</span>;</div>
  77 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    }<span class="keywordflow">else</span>{</div>
  78 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <span class="comment">// close, we&#39;ll process it next</span></div>
  79 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        closedir(dir);</div>
  80 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    }</div>
  81 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="comment">// enqueue top folder</span></div>
  82 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    std::queue&lt;std::string&gt; folders;</div>
  83 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    folders.push(folder);</div>
  84 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
  85 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="comment">// run while has queued folders</span></div>
  86 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <span class="keywordflow">while</span> (!folders.empty()){</div>
  87 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        std::string currFolder = folders.front();</div>
  88 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        folders.pop();</div>
  89 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        dir = opendir(currFolder.c_str());</div>
  90 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <span class="keywordflow">if</span> (dir == NULL) <span class="keywordflow">continue</span>;</div>
  91 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        <span class="comment">// iterate through all the files and directories</span></div>
  92 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        <span class="keywordflow">while</span> ((ent = readdir (dir)) != NULL) {</div>
  93 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;            std::string name(ent-&gt;d_name);</div>
  94 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;            <span class="comment">// ignore &quot;.&quot; and &quot;..&quot; directories</span></div>
  95 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;            <span class="keywordflow">if</span> ( name.compare(<span class="stringliteral">&quot;.&quot;</span>) == 0 || name.compare(<span class="stringliteral">&quot;..&quot;</span>) == 0) <span class="keywordflow">continue</span>;</div>
  96 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;            <span class="comment">// add path to the file name</span></div>
  97 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;            std::string path = currFolder;</div>
  98 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;            path.append(<span class="stringliteral">&quot;/&quot;</span>);</div>
  99 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;            path.append(name);</div>
 100 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;            <span class="comment">// check if it&#39;s a folder by trying to open it</span></div>
 101 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;            subDir = opendir(path.c_str());</div>
 102 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;            <span class="keywordflow">if</span> (subDir != NULL){</div>
 103 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;                <span class="comment">// it&#39;s a folder: close, we can process it later</span></div>
 104 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;                closedir(subDir);</div>
 105 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;                <span class="keywordflow">if</span> (recursive) folders.push(path);</div>
 106 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;            }<span class="keywordflow">else</span>{</div>
 107 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;                <span class="comment">// it&#39;s a file</span></div>
 108 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                <span class="keywordflow">if</span> (extension.empty()){</div>
 109 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;                    list.push_back(path);</div>
 110 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;                }<span class="keywordflow">else</span>{</div>
 111 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                    <span class="comment">// check file extension</span></div>
 112 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;                    <span class="keywordtype">size_t</span> lastDot = name.find_last_of(<span class="charliteral">&#39;.&#39;</span>);</div>
 113 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;                    std::string ext = name.substr(lastDot+1);</div>
 114 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;                    <span class="keywordflow">if</span> (ext.compare(extension) == 0){</div>
 115 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;                        <span class="comment">// match</span></div>
 116 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                        list.push_back(path);</div>
 117 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;                    }</div>
 118 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;                } <span class="comment">// endif (extension test)</span></div>
 119 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;            } <span class="comment">// endif (folder test)</span></div>
 120 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        } <span class="comment">// endwhile (nextFile)</span></div>
 121 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        closedir(dir);</div>
 122 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    } <span class="comment">// endwhile (queued folders)</span></div>
 123 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
 124 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;} <span class="comment">// end listFiles</span></div>
 125 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div>
 126 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div>
 127 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;}   <span class="comment">// namespace dir</span></div>
 128 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div>
 129 <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;}   <span class="comment">// namespace pluma</span></div>
 130 </div><!-- fragment --></div><!-- contents -->
 131
 132         <p id="footer">
 133             &nbsp;::&nbsp; Copyright &copy; 2011 Gil Costa, all rights reserved &nbsp;::&nbsp;
 134             Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> &nbsp;::&nbsp;
 135         </p>
 136     </body>
 137 </html>