deprecated.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Language" content="en-us">
  4. <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
  5. <meta name="ProgId" content="FrontPage.Editor.Document">
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  7. <title>Filesystem Deprecated Features</title>
  8. <link href="styles.css" rel="stylesheet">
  9. </head>
  10. <body>
  11. <table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111">
  12. <tr>
  13. <td width="277">
  14. <a href="../../../index.htm">
  15. <img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="300" height="86" border="0"></a></td>
  16. <td align="middle">
  17. <font size="7">Filesystem Deprecated Features</font>
  18. </td>
  19. </tr>
  20. </table>
  21. <table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse"
  22. bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
  23. <tr>
  24. <td><a href="index.htm">Home</a> &nbsp;&nbsp;
  25. <a href="tutorial.html">Tutorial</a> &nbsp;&nbsp;
  26. <a href="reference.html">Reference</a> &nbsp;&nbsp;
  27. <a href="faq.htm">FAQ</a> &nbsp;&nbsp;
  28. <a href="release_history.html">Releases</a> &nbsp;&nbsp;
  29. <a href="portability_guide.htm">Portability</a> &nbsp;&nbsp;
  30. <a href="v3.html">V3 Intro</a> &nbsp;&nbsp;
  31. <a href="v3_design.html">V3 Design</a> &nbsp;&nbsp;
  32. <a href="deprecated.html">Deprecated</a> &nbsp;&nbsp;
  33. <a href="issue_reporting.html">Bug Reports </a>&nbsp;&nbsp;
  34. </td>
  35. </table>
  36. <h2><a name="Deprecated-names">Deprecated names</a> and features</h2>
  37. <p style="font-size: 10pt">As the library evolves over time, names sometimes
  38. change or old features are removed to make way for new features. To ease transition, Boost.Filesystem deprecates
  39. the old names and features, but by default continues to provide many of them.
  40. The deprecated names and other workarounds can be suppressed by defining macro <code>
  41. BOOST_FILESYSTEM_NO_DEPRECATED</code>, and this is recommended for all new code.</p>
  42. <p style="font-size: 10pt">In the table, &#10004; indicates a synonym or other
  43. workaround is provided unless <code>
  44. BOOST_FILESYSTEM_NO_DEPRECATED</code> is defined.</p>
  45. <table border="1" cellpadding="5" cellspacing="1" style="border-collapse: collapse" bordercolor="#111111">
  46. <tr>
  47. <td style="font-size: 10pt" valign="top">
  48. <b><i>Component or location</i></b></td>
  49. <td style="font-size: 10pt" valign="top">
  50. <p style="font-size: 10pt"><b><i>Old name, now deprecated</i></b></td>
  51. <td style="font-size: 10pt" valign="top">
  52. &#10004;</td>
  53. <td style="font-size: 10pt" valign="top">
  54. <p style="font-size: 10pt"><b><i>New name</i></b></td>
  55. </tr>
  56. <tr>
  57. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  58. <td style="font-size: 10pt" valign="top"><code>branch_path()</code></td>
  59. <td style="font-size: 10pt" valign="top">&#10004;</td>
  60. <td style="font-size: 10pt" valign="top"><code>parent_path()</code></td>
  61. </tr>
  62. <tr>
  63. <td style="font-size: 10pt" valign="top">
  64. <code>class path</code></td>
  65. <td style="font-size: 10pt" valign="top">
  66. <code>canonize()</code></td>
  67. <td style="font-size: 10pt" valign="top">
  68. &nbsp;</td>
  69. <td style="font-size: 10pt" valign="top">
  70. <i>Function removed</i></td>
  71. </tr>
  72. <tr>
  73. <td style="font-size: 10pt" valign="top">
  74. <code>class path</code></td>
  75. <td style="font-size: 10pt" valign="top">
  76. <code>default_name_check()</code></td>
  77. <td style="font-size: 10pt" valign="top">
  78. &#10004;</td>
  79. <td style="font-size: 10pt" valign="top">
  80. <i>Function removed</i></td>
  81. </tr>
  82. <tr>
  83. <td style="font-size: 10pt" valign="top">
  84. <code>class path</code></td>
  85. <td style="font-size: 10pt" valign="top">
  86. <code>default_name_check(name_check)</code></td>
  87. <td style="font-size: 10pt" valign="top">
  88. &#10004;</td>
  89. <td style="font-size: 10pt" valign="top">
  90. <i>Function removed</i></td>
  91. </tr>
  92. <tr>
  93. <td style="font-size: 10pt" valign="top">
  94. <code>class path</code></td>
  95. <td style="font-size: 10pt" valign="top">
  96. <code>default_name_check_writable()</code></td>
  97. <td style="font-size: 10pt" valign="top">
  98. &#10004;</td>
  99. <td style="font-size: 10pt" valign="top">
  100. <i>Function removed</i></td>
  101. </tr>
  102. <tr>
  103. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  104. <td style="font-size: 10pt" valign="top"><code>directory_string()</code></td>
  105. <td style="font-size: 10pt" valign="top">&#10004;</td>
  106. <td style="font-size: 10pt" valign="top"><code>string</code></td>
  107. </tr>
  108. <tr>
  109. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  110. <td style="font-size: 10pt" valign="top"><code>external_directory_string()</code></td>
  111. <td style="font-size: 10pt" valign="top">&#10004;</td>
  112. <td style="font-size: 10pt" valign="top"><code>native()</code></td>
  113. </tr>
  114. <tr>
  115. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  116. <td style="font-size: 10pt" valign="top"><code>external_file_string()</code></td>
  117. <td style="font-size: 10pt" valign="top">&#10004;</td>
  118. <td style="font-size: 10pt" valign="top"><code>native()</code></td>
  119. </tr>
  120. <tr>
  121. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  122. <td style="font-size: 10pt" valign="top"><code>file_string()</code></td>
  123. <td style="font-size: 10pt" valign="top">&#10004;</td>
  124. <td style="font-size: 10pt" valign="top"><code>string()</code></td>
  125. </tr>
  126. <tr>
  127. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  128. <td style="font-size: 10pt" valign="top"><code>has_branch_path()</code></td>
  129. <td style="font-size: 10pt" valign="top">&#10004;</td>
  130. <td style="font-size: 10pt" valign="top"><code>has_parent_path()</code></td>
  131. </tr>
  132. <tr>
  133. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  134. <td style="font-size: 10pt" valign="top"><code>has_leaf()</code></td>
  135. <td style="font-size: 10pt" valign="top">&#10004;</td>
  136. <td style="font-size: 10pt" valign="top"><code>has_filename()</code></td>
  137. </tr>
  138. <tr>
  139. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  140. <td style="font-size: 10pt" valign="top"><code>is_complete()</code></td>
  141. <td style="font-size: 10pt" valign="top">&#10004;</td>
  142. <td style="font-size: 10pt" valign="top"><code>is_absolute()</code></td>
  143. </tr>
  144. <tr>
  145. <td style="font-size: 10pt" valign="top"><code>class path</code></td>
  146. <td style="font-size: 10pt" valign="top"><code>leaf()</code></td>
  147. <td style="font-size: 10pt" valign="top">&#10004;</td>
  148. <td style="font-size: 10pt" valign="top"><code>filename()</code></td>
  149. </tr>
  150. <tr>
  151. <td style="font-size: 10pt" valign="top">
  152. <code>class path</code></td>
  153. <td style="font-size: 10pt" valign="top">
  154. <code>native_directory_string()</code></td>
  155. <td style="font-size: 10pt" valign="top">
  156. &#10004;</td>
  157. <td style="font-size: 10pt" valign="top">
  158. <code>string()</code></td>
  159. </tr>
  160. <tr>
  161. <td style="font-size: 10pt" valign="top">
  162. <code>class path</code></td>
  163. <td style="font-size: 10pt" valign="top">
  164. <code>native_file_string()</code></td>
  165. <td style="font-size: 10pt" valign="top">
  166. &#10004;</td>
  167. <td style="font-size: 10pt" valign="top">
  168. <code>string()</code></td>
  169. </tr>
  170. <tr>
  171. <td style="font-size: 10pt" valign="top">
  172. <code>class path</code></td>
  173. <td style="font-size: 10pt" valign="top">
  174. <code>normalize()</code></td>
  175. <td style="font-size: 10pt" valign="top">
  176. &#10004;</td>
  177. <td style="font-size: 10pt" valign="top">
  178. <i>Function removed</i></td>
  179. </tr>
  180. <tr>
  181. <td style="font-size: 10pt" valign="top">
  182. <code>class path</code></td>
  183. <td style="font-size: 10pt" valign="top">
  184. <code>path(const string_type&amp; str, name_check)</code></td>
  185. <td style="font-size: 10pt" valign="top">
  186. &#10004;</td>
  187. <td style="font-size: 10pt" valign="top">
  188. <i>Function removed. Workaround ignores </i><code>name_check</code><i>
  189. argument.</i></td>
  190. </tr>
  191. <tr>
  192. <td style="font-size: 10pt" valign="top">
  193. <code>class path</code></td>
  194. <td style="font-size: 10pt" valign="top">
  195. <code>path(const string_type::value_type* s,&nbsp; name_check)</code></td>
  196. <td style="font-size: 10pt" valign="top">
  197. &#10004;</td>
  198. <td style="font-size: 10pt" valign="top">
  199. <i>Function removed. Workaround ignores </i><code>name_check</code><i>
  200. argument.</i></td>
  201. </tr>
  202. <tr>
  203. <td style="font-size: 10pt" valign="top">
  204. <code>class path</code></td>
  205. <td style="font-size: 10pt" valign="top">
  206. <p style="font-size: 10pt"><code>remove_leaf()</code></td>
  207. <td style="font-size: 10pt" valign="top">
  208. &#10004;</td>
  209. <td style="font-size: 10pt" valign="top">
  210. <p style="font-size: 10pt"><code>remove_filename()</code></td>
  211. </tr>
  212. <tr>
  213. <td style="font-size: 10pt" valign="top">
  214. <code>path.hpp</code></td>
  215. <td style="font-size: 10pt" valign="top">
  216. <code>template&lt;class String, class Traits&gt;<br>
  217. &nbsp; class basic_path;</code></td>
  218. <td style="font-size: 10pt" valign="top">
  219. &nbsp;</td>
  220. <td style="font-size: 10pt" valign="top">
  221. Class template <code>basic_path</code> is replaced by <code>class path</code>.
  222. No workaround for an explicitly coded <code>basic_path</code> is provided,
  223. but see the next row - <code>path</code>.</td>
  224. </tr>
  225. <tr>
  226. <td style="font-size: 10pt" valign="top">
  227. <code>path.hpp</code></td>
  228. <td style="font-size: 10pt" valign="top">
  229. <code>typedef basic_path&lt;std::string, path_traits&gt; path</code></td>
  230. <td style="font-size: 10pt" valign="top">
  231. &#10004;</td>
  232. <td style="font-size: 10pt" valign="top">
  233. <code>class path</code></td>
  234. </tr>
  235. <tr>
  236. <td style="font-size: 10pt" valign="top">
  237. <code>path.hpp</code></td>
  238. <td style="font-size: 10pt" valign="top">
  239. <code>typedef basic_path&lt;std::wstring, wpath_traits&gt; wpath</code></td>
  240. <td style="font-size: 10pt" valign="top">
  241. &#10004;</td>
  242. <td style="font-size: 10pt" valign="top">
  243. <i>Removed; use </i><code>class path</code><i> instead. Workaround provides
  244. </i><code>typedef path wpath</code></td>
  245. </tr>
  246. <tr>
  247. <td style="font-size: 10pt" valign="top">
  248. <code>operations.hpp</code></td>
  249. <td style="font-size: 10pt" valign="top">
  250. <code>initial_path()</code></td>
  251. <td style="font-size: 10pt" valign="top">
  252. &#10004;</td>
  253. <td style="font-size: 10pt" valign="top">
  254. <i>Function removed</i></td>
  255. </tr>
  256. <tr>
  257. <td style="font-size: 10pt" valign="top">
  258. <code>operations.hpp</code></td>
  259. <td style="font-size: 10pt" valign="top">
  260. <p dir="ltr"><code>template &lt;class Path&gt;<br>
  261. Path complete(const Path&amp; p,<br>
  262. &nbsp;const Path&amp; base=<br>
  263. &nbsp;&nbsp; initial_path&lt;Path&gt;())</code></td>
  264. <td style="font-size: 10pt" valign="top">
  265. &#10004;</td>
  266. <td style="font-size: 10pt" valign="top">
  267. <p dir="ltr"><code>path absolute(const path&amp; p, const path&amp; base=<br>
  268. &nbsp; current_path())</code></td>
  269. </tr>
  270. <tr>
  271. <td style="font-size: 10pt" valign="top">
  272. <code>operations.hpp</code></td>
  273. <td style="font-size: 10pt" valign="top">
  274. <code>is_regular(file_status f)</code></td>
  275. <td style="font-size: 10pt" valign="top">
  276. &#10004;</td>
  277. <td style="font-size: 10pt" valign="top">
  278. <p dir="ltr">
  279. <code>is_regular_file(file_status f)</code></td>
  280. </tr>
  281. <tr>
  282. <td style="font-size: 10pt" valign="top">
  283. <code>operations.hpp</code></td>
  284. <td style="font-size: 10pt" valign="top">
  285. <code>symbolic_link_exists(const path&amp; ph)</code></td>
  286. <td style="font-size: 10pt" valign="top">
  287. &nbsp;</td>
  288. <td style="font-size: 10pt" valign="top">
  289. <i>Function removed</i></td>
  290. </tr>
  291. <tr>
  292. <td style="font-size: 10pt" valign="top">
  293. <code>class directory_entry</code></td>
  294. <td style="font-size: 10pt" valign="top">
  295. <code>filename()</code></td>
  296. <td style="font-size: 10pt" valign="top">
  297. &#10004;</td>
  298. <td style="font-size: 10pt" valign="top">
  299. <i>Function removed, use </i><code>path().filename()</code><i> instead.</i></td>
  300. </tr>
  301. <tr>
  302. <td style="font-size: 10pt" valign="top">
  303. <code>class directory_entry</code></td>
  304. <td style="font-size: 10pt" valign="top">
  305. <code>leaf()</code></td>
  306. <td style="font-size: 10pt" valign="top">
  307. &#10004;</td>
  308. <td style="font-size: 10pt" valign="top">
  309. <i>Function removed, use </i><code>path().filename()</code><i> instead.</i></td>
  310. </tr>
  311. <tr>
  312. <td style="font-size: 10pt" valign="top">
  313. <code>class directory_entry</code></td>
  314. <td style="font-size: 10pt" valign="top">
  315. <code>string()</code></td>
  316. <td style="font-size: 10pt" valign="top">
  317. &#10004;</td>
  318. <td style="font-size: 10pt" valign="top">
  319. <i>Function removed, use </i><code>path().string()</code><i> instead.</i></td>
  320. </tr>
  321. <tr>
  322. <td style="font-size: 10pt" valign="top"><code>class recursive_directory_iterator</code></td>
  323. <td style="font-size: 10pt" valign="top"><code>level()</code></td>
  324. <td style="font-size: 10pt" valign="top">&#10004;</td>
  325. <td style="font-size: 10pt" valign="top"><code>depth()</code></td>
  326. </tr>
  327. <tr>
  328. <td style="font-size: 10pt" valign="top"><code>class recursive_directory_iterator</code></td>
  329. <td style="font-size: 10pt" valign="top"><code>no_push_pending()</code></td>
  330. <td style="font-size: 10pt" valign="top">&#10004;</td>
  331. <td style="font-size: 10pt" valign="top"><code>!recursion_pending()</code></td>
  332. </tr>
  333. <tr>
  334. <td style="font-size: 10pt" valign="top"><code>class recursive_directory_iterator</code></td>
  335. <td style="font-size: 10pt" valign="top"><code>no_push()</code></td>
  336. <td style="font-size: 10pt" valign="top">&#10004;</td>
  337. <td style="font-size: 10pt" valign="top"><code>disable_recursion_pending()</code></td>
  338. </tr>
  339. <tr>
  340. <td style="font-size: 10pt" valign="top"><code>directory.hpp</code></td>
  341. <td style="font-size: 10pt" valign="top"><code>enum class symlink_option</code></td>
  342. <td style="font-size: 10pt" valign="top">&#10004;</td>
  343. <td style="font-size: 10pt" valign="top"><i>Removed; use corresponding values of </i><code>enum class directory_options</code><i> instead.</i></td>
  344. </tr>
  345. <tr>
  346. <td style="font-size: 10pt" valign="top">
  347. <code>directory.hpp</code></td>
  348. <td style="font-size: 10pt" valign="top">
  349. <code>wrecursive_directory_iterator</code> typedef</td>
  350. <td style="font-size: 10pt" valign="top">
  351. &#10004;</td>
  352. <td style="font-size: 10pt" valign="top">
  353. <i>Removed; use </i><code>class recursive_directory_iterator</code><i> instead. Workaround provides
  354. </i><code>typedef recursive_directory_iterator wrecursive_directory_iterator</code></td>
  355. </tr>
  356. <tr>
  357. <td style="font-size: 10pt" valign="top">
  358. <code>operations.hpp</code></td>
  359. <td style="font-size: 10pt" valign="top">
  360. The header provides <code>filesystem_error</code>, <code>file_status</code>, <code>directory_entry</code>, <code>directory_iterator</code>, <code>recursive_directory_iterator</code> and associated enums and functions.</td>
  361. <td style="font-size: 10pt" valign="top">
  362. &#10004;</td>
  363. <td style="font-size: 10pt" valign="top">
  364. <i>These components were moved to separate headers </i><code>exception.hpp</code><i>, </i><code>file_status.hpp</code><i> and </i><code>directory.hpp</code><i>.
  365. The workaround is to include the new headers or </i><code>filesystem.hpp</code><i>. The new headers are still included by </i><code>operations.hpp</code><i> if
  366. </i><code>BOOST_FILESYSTEM_NO_DEPRECATED</code><i> is not defined.</i></td>
  367. </tr>
  368. <tr>
  369. <td style="font-size: 10pt" valign="top">
  370. Macro definitions</td>
  371. <td style="font-size: 10pt" valign="top">
  372. <code>BOOST_WINDOW_API</code></td>
  373. <td style="font-size: 10pt" valign="top">
  374. &nbsp;</td>
  375. <td style="font-size: 10pt" valign="top">
  376. <i>No longer supported; API selection is always automatic.</i></td>
  377. </tr>
  378. <tr>
  379. <td style="font-size: 10pt" valign="top">
  380. Macro definitions</td>
  381. <td style="font-size: 10pt" valign="top">
  382. <code>BOOST_POSIX_API</code></td>
  383. <td style="font-size: 10pt" valign="top">
  384. &nbsp;</td>
  385. <td style="font-size: 10pt" valign="top">
  386. <i>No longer supported; API selection is always automatic.</i></td>
  387. </tr>
  388. <tr>
  389. <td style="font-size: 10pt" valign="top">
  390. Macro definitions</td>
  391. <td style="font-size: 10pt" valign="top">
  392. <code>BOOST_WINDOW_PATH</code></td>
  393. <td style="font-size: 10pt" valign="top">
  394. &nbsp;</td>
  395. <td style="font-size: 10pt" valign="top">
  396. <i>No longer supported; native path format selection is always automatic.</i></td>
  397. </tr>
  398. <tr>
  399. <td style="font-size: 10pt" valign="top">
  400. Macro definitions</td>
  401. <td style="font-size: 10pt" valign="top">
  402. <code>BOOST_POSIX_PATH</code></td>
  403. <td style="font-size: 10pt" valign="top">
  404. &nbsp;</td>
  405. <td style="font-size: 10pt" valign="top">
  406. <i>No longer supported; native path format selection is always automatic.</i></td>
  407. </tr>
  408. </table>
  409. <h2>Deprecation rationale</h2>
  410. <h3><code>initial_path</code> function</h3>
  411. <p dir="ltr">Full implementation of <code>initial_path()</code> would require
  412. support from the C++ runtime startup code, and that doesn't seem likely to
  413. happen. Depending on the user to call <code>initial_path()</code> at the
  414. beginning of <code>main()</code> is too error prone.&nbsp; An equivalent
  415. function can trivially be provided by a user.</p>
  416. <hr>
  417. <p>Revised
  418. <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 December, 2014<!--webbot bot="Timestamp" endspan i-checksum="38652" --></p>
  419. <p>&copy; Copyright Beman Dawes, 2002-2005, 2010</p>
  420. <p> Use, modification, and distribution are subject to the Boost Software
  421. License, Version 1.0. See <a href="http://www.boost.org/LICENSE_1_0.txt">
  422. www.boost.org/LICENSE_1_0.txt</a></p>
  423. </body>
  424. </html>