Ticket #4724: temp_dir_path.patch

boost/filesystem/v3/operations.hpp

@@ -188 +188 @@
     BOOST_FILESYSTEM_DECL
     path system_complete(const path& p, system::error_code* ec=0);
     BOOST_FILESYSTEM_DECL
+    path temp_dir_path(system::error_code* ec=0);
+    BOOST_FILESYSTEM_DECL
     path unique_path(const path& p, system::error_code* ec=0);
   }  // namespace detail
 
@@ -443 +445 @@
   path system_complete(const path& p, system::error_code& ec)
                                        {return detail::system_complete(p, &ec);}
   inline
+  path temp_dir_path()                {return detail::temp_dir_path();}
+
+  inline
+  path temp_dir_path(system::error_code& ec) 
+                                       {return detail::temp_dir_path(&ec);}
+  inline
   path unique_path(const path& p="%%%%-%%%%-%%%%-%%%%")
                                        { return detail::unique_path(p); }
   inline
@@ -982 +990 @@
     using filesystem3::symlink_file;
     using filesystem3::symlink_status;
     using filesystem3::system_complete;
+    using filesystem3::temp_dir_path;
     using filesystem3::type_unknown;
     using filesystem3::unique_path;
 # ifndef BOOST_FILESYSTEM_NO_DEPRECATED

libs/filesystem/v3/test/operations_test.cpp

@@ -1269 +1269 @@
     BOOST_TEST(!fs::equivalent(ng, file_ph));
   }
 
+  //  temp_dir_path_tests  ---------------------------------------------------------//
+
+  void temp_dir_path_tests()
+  {
+      std::cout << "temp_dir_path_tests..." << std::endl;
+
+      BOOST_TEST(!fs::temp_dir_path().empty());
+      BOOST_TEST(exists(fs::temp_dir_path()));
+  }
+
   //  _tests  --------------------------------------------------------------------------//
 
   void _tests()
@@ -1393 +1403 @@
   if (create_symlink_ok)  // only if symlinks supported
     remove_symlink_tests();
   write_time_tests(dir);
-
+  
+  temp_dir_path_tests();
+  
   std::cout << "testing complete" << std::endl;
 
   // post-test cleanup

libs/filesystem/v3/doc/reference.html

@@ -114 +114 @@
 &nbsp;&nbsp;&nbsp;&nbsp <a href="#status_known">status_known</a><br>
 &nbsp;&nbsp;&nbsp;&nbsp <a href="#symlink_status">symlink_status</a><br>
 &nbsp;&nbsp;&nbsp;&nbsp <a href="#system_complete">system_complete</a><br>
+&nbsp;&nbsp;&nbsp;&nbsp <a href="#temp_dir_path">temp_dir_path</a><br>
 &nbsp;&nbsp;&nbsp;&nbsp; <a href="#unique_path">unique_path</a></td>
     <td width="34%" valign="top">
     <a href="#File-streams">File streams</a><br>
@@ -437 +438 @@
       path         <a href="#system_complete">system_complete</a>(const path&amp; p);
       path         <a href="#system_complete">system_complete</a>(const path&amp; p, system::error_code&amp; ec);
 
+      path         <a href="#temp_dir_path">temp_dir_path</a>();
+      path         <a href="#temp_dir_path">temp_dir_path</a>(system::error_code&amp; ec);
+
       path         <a href="#unique_path">unique_path</a>(const path&amp; model=&quot;%%%%-%%%%-%%%%-%%%%&quot;);
       path         <a href="#unique_path">unique_path</a>(const path&amp; model, system::error_code&amp; ec);
 
@@ -2442 +2446 @@
   <p>See <a href="#complete_note">
   <i>complete()</i> note</a> for usage suggestions. <i>-- end note</i>]</p>
 </blockquote>
+<pre>path <a name="temp_dir_path">temp_dir_path</a>();
+path temp_dir_path(system::error_code&amp; ec);</pre>
+<blockquote>
+  <p><i>Returns:</i> The temporary directory path as returned by the <i>POSIX</i> <code>getenv("TMPDIR")</code> environment variable, 
+  or the <i>Windows</i> <code>GetTempPath</code> API function. <code>is_directory()</code> is true for the returned path.</p>
+  <p><i>Throws:</i> As specified in
+  <a href="#Error-reporting">
+  Error reporting</a>.</p>
+  <p>[<i>Note: </i>The <code>temp_dir_path()</code> name was chosen to emphasize that the return is a 
+  path, not just a single directory name.&nbsp; <i>-- end note</i>]</p>
+</blockquote>
 <pre>path <a name="unique_path">unique_path</a>(const path&amp; model=&quot;%%%%-%%%%-%%%%-%%%%&quot;);
 path unique_path(const path&amp; model, system::error_code&amp; ec);</pre>
 <blockquote>

libs/filesystem/v3/src/operations.cpp

@@ -49 +49 @@
 #include <boost/scoped_array.hpp>
 #include <boost/detail/workaround.hpp>
 #include <cstdlib>  // for malloc, free
+#include <vector>
 
 #ifdef BOOST_FILEYSTEM_INCLUDE_IOSTREAM
 # include <iostream>
@@ -1445 +1446 @@
   }
 
   BOOST_FILESYSTEM_DECL
+  path temp_dir_path(system::error_code* ec)
+  {
+#   ifdef BOOST_POSIX_API
+      const char* val = std::getenv("TMPDIR");
+      
+      if (error(val==0, 
+        ec, "boost::filesystem::temp_dir_path"))
+          return path();
+        
+      path p(val);
+
+      if (error((ec && !is_directory(p, *ec)) || 
+        (!ec && !is_directory(p)), 
+        ec, "boost::filesystem::temp_dir_path"))
+          return path();
+        
+      return p;
+      
+#   else  // Windows
+
+      std::vector<path::value_type> buf(GetTempPathW(0, NULL));
+
+      if (error(buf.empty() || GetTempPathW(buf.size(), &buf[0])==0, 
+        ec, "boost::filesystem::temp_dir_path"))
+          return path();
+          
+      buf.pop_back();
+      
+      path p(buf.begin(), buf.end());
+          
+      if (error((ec && !is_directory(p, *ec)) || 
+          (!ec && !is_directory(p)), 
+        ec, "boost::filesystem::temp_dir_path"))
+          return path();
+
+      return p;
+#   endif
+  }
+  
+  BOOST_FILESYSTEM_DECL
   path system_complete(const path& p, system::error_code* ec)
   {
 #   ifdef BOOST_POSIX_API