File: index.htm

package info (click to toggle)
boost 1.32.0-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 93,952 kB
  • ctags: 128,458
  • sloc: cpp: 492,477; xml: 52,125; python: 13,519; ansic: 13,013; sh: 1,773; yacc: 853; makefile: 526; perl: 418; lex: 110; csh: 6
file content (554 lines) | stat: -rw-r--r-- 28,781 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>Boost Filesystem Library</title>
</head>

<body bgcolor="#FFFFFF">

<h1>
<img border="0" src="../../../boost.png" align="center" width="277" height="86">Boost 
Filesystem Library</h1>
<table border="0" cellpadding="0" width="100%">
  <tr>
    <td width="50%" valign="top"><font size="4">This Document</font><br>
&nbsp;&nbsp;&nbsp; <a href="#Introduction">Introduction</a><br>
&nbsp;&nbsp;&nbsp; <a href="#tutorial">Two-minute tutorial</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Examples">Examples</a><br>
&nbsp;&nbsp;&nbsp;
<a href="#Definitions">Definitions</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Common_Specifications">Common Specifications</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Race-condition">Race-condition danger</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Implementation">Implementation</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Building">Building the object-library</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="#Cgywin">Notes for Cygwin users</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Acknowledgements">Acknowledgements</a><br>
&nbsp;&nbsp;&nbsp; <a href="#Change-history">Change history</a></td>
    <td width="50%"><font size="4">Other Documents</font><br>
&nbsp;&nbsp;&nbsp; <a href="design.htm">Library Design</a><br>
&nbsp;&nbsp;&nbsp; <a href="faq.htm">FAQ</a><br>
&nbsp;&nbsp;&nbsp; <a href="portability_guide.htm">Portability Guide</a><br>
&nbsp;&nbsp;&nbsp; <a href="path.htm"><b><i>path.hpp</i></b> documentation</a><br>
&nbsp;&nbsp;&nbsp; <a href="operations.htm"><b><i>operations.hpp</i></b> documentation</a><br>
&nbsp;&nbsp;&nbsp; <a href="fstream.htm"><b><i>fstream.hpp</i></b> documentation</a><br>
&nbsp;&nbsp;&nbsp; <a href="exception.htm"><b><i>exception.hpp</i></b> documentation</a><br>
&nbsp;&nbsp;&nbsp; <a href="convenience.htm"><b><i>convenience.hpp</i></b> 
    documentation</a><br>
&nbsp;&nbsp;&nbsp; <a href="do-list.htm">Do-list</a></td>
  </tr>
</table>
<h2><a name="Introduction">Introduction</a></h2>
<p>The Boost Filesystem Library provides portable facilities to query and 
manipulate paths, files, and directories.</p>

<p>The motivation for the library is the need to be able to perform portable script-like operations from within C++ programs. The intent is not to 
compete with Python, Perl, or shell languages, but rather to provide portable filesystem 
operations when C++ is already the language of choice. The <a href="design.htm">
design</a> encourages, but does not require, safe and portable filesystem usage.</p>

<p>The Filesystem Library supplies several&nbsp; headers, all in 
directory boost/filesystem:</p>

<ul>
  <li>Header <i><a href="../../../boost/filesystem/path.hpp">path.hpp</a></i> provides class <i>path, </i>a portable mechanism for representing
      <a href="#path">paths</a> in C++ programs. Validity checking 
      functions are also provided. See <a href="path.htm">path.hpp documentation</a>.<br>
&nbsp;</li>
  <li>Header <i><a href="../../../boost/filesystem/operations.hpp">operations.hpp</a></i> provides functions operating on files and directories, 
  and includes class <i>directory_iterator</i>. See <a href="operations.htm">
  operations.hpp documentation</a>.<br>
&nbsp;</li>
  <li>Header <i><a href="../../../boost/filesystem/fstream.hpp">fstream.hpp</a></i> provides the same components as the C++ Standard 
  Library's <i>fstream</i> header, except 
      that files are identified by <i>path</i> objects rather that <i>char *</i>'s. 
  See <a href="fstream.htm">fstream.hpp documentation</a>.<br>
&nbsp;</li>
  <li>Header <i><a href="../../../boost/filesystem/exception.hpp">exception.hpp</a></i> provides class <i>filesystem_error</i>. See
  <a href="exception.htm">exception.hpp documentation</a>.<br>
&nbsp;</li>
  <li>Header <a href="../../../boost/filesystem/convenience.hpp">convenience.hpp</a> 
  provides convenience functions that combine lower-level functions in useful 
  ways. See <a href="convenience.htm">convenience.hpp documentation</a>.</li>
</ul>
<p>The organizing principle is that purely lexical operations on<i> </i>
      <a href="#path">paths</a> are supplied as <i>class path</i> member 
functions in <i>path.hpp</i>, while operations performed by the operating system 
on the actual external filesystem directories and files are provided in <i>
operations.hpp,</i> primarily as free functions.</p>
<h2>Two-minute <a name="tutorial">tutorial</a></h2>
<p>First some preliminaries:</p>
<blockquote>
  <pre>#include &quot;boost/filesystem/operations.hpp&quot; // includes boost/filesystem/path.hpp
#include &quot;boost/filesystem/fstream.hpp&quot;    // ditto
#include &lt;iostream&gt;                        // for std::cout
using boost::filesystem;                   // for ease of tutorial presentation;
                                           // a namespace alias is preferred in real code</pre>
</blockquote>
<p>A <a href="path.htm#synopsis">class <i>path</i></a> object can be created:</p>
<blockquote>
  <pre>path my_path( &quot;some_dir/file.txt&quot; );</pre>
</blockquote>
<p>The string passed to the <i>path</i> constructor is in a
<a href="path.htm#Grammar">portable generic path format</a>. Access functions 
make <i>my_path</i> contents available in an operating system dependent format, 
such as <code>&quot;some_dir:file.txt&quot;</code>, <code>&quot;[some_dir]file.txt&quot;</code>,
<code>&quot;some_dir/file.txt&quot;</code>, or whatever is appropriate for the  
operating system.</p>
<p>Class <i>path</i> has conversion constructors from <i>const char*</i> and <i>
const std:: string&amp;</i>, so that even though the Filesystem Library functions in 
the following code snippet take <i>const path&amp;</i> arguments, the user can just 
code C-style strings:</p>
<blockquote>
  <pre>remove_all( &quot;foobar&quot; );
create_directory( &quot;foobar&quot; );
ofstream file( &quot;foobar/cheeze&quot; );
file &lt;&lt; &quot;tastes good!\n&quot;;
file.close();
if ( !exists( &quot;foobar/cheeze&quot; ) )
  std::cout &lt;&lt; &quot;Something is rotten in foobar\n&quot;;</pre>
</blockquote>
<p>Additional class path constructors provide for an operating system dependent 
format, useful for user provided input:</p>
<blockquote>
  <pre>int main( int argc, char * argv[] ) {
path arg_path( argv[1], native ); // native means use O/S path format</pre>
</blockquote>
<p>To make class <i>path</i> objects easy to use in expressions, <i>operator/</i> 
appends paths:</p>
<blockquote>
  <pre>ifstream file1( arg_path / &quot;foo/bar&quot; );
ifstream file2( arg_path / &quot;foo&quot; / &quot;bar&quot; );</pre>
</blockquote>
<p>The expressions <i>arg_path / &quot;foo/bar&quot;</i> and <i>arg_path / &quot;foo&quot; 
/ &quot;bar&quot;</i> yield identical results.</p>
<p>Paths can include references to the parent directory, using the &quot;<code>..</code>&quot; 
notation. Paths are always automatically converted to
<a href="path.htm#Canonical">canonical form</a>, so <i>&quot;foo/../bar&quot;</i> gets 
converted to <i>&quot;bar&quot;</i>, and <i>&quot;../foo/../bar&quot;</i> gets converted to <i>
&quot;../bar&quot;</i>.</p>
<p><a href="operations.htm#directory_iterator">Class <i>directory_iterator</i></a> 
is an important component of the library. It provides input iterators over the 
contents of a directory, with the value type being class <i>path</i>.</p>
<p>The following function, given a directory path and a file name, recursively 
searches the directory and its sub-directories for the file name, returning a 
bool, and if successful, the path to the file that was found.&nbsp; The code 
below is extracted from a real program, slightly modified for clarity:</p>
<blockquote>
  <pre>bool find_file( const path &amp; dir_path,     // in this directory,
                const std::string &amp; file_name, // search for this name,
                path &amp; path_found )        // placing path here if found
{
  if ( !exists( dir_path ) ) return false;
  directory_iterator end_itr; // default construction yields past-the-end
  for ( directory_iterator itr( dir_path );
        itr != end_itr;
        ++itr )
  {
    if ( is_directory( *itr ) )
    {
      if ( find_file( *itr, file_name, path_found ) ) return true;
    }
    else if ( itr-&gt;leaf() == file_name ) // see below
    {
      path_found = *itr;
      return true;
    }
  }
  return false;
}</pre>
</blockquote>
<p>The expression <i>itr-&gt;leaf() == file_name</i>, in the line commented <i>// 
see below</i>, calls the <i>leaf()</i> function on the <i>path</i> object 
returned by the iterator. <i>leaf()</i> returns a string which is a copy of the 
last (closest to the leaf, farthest from the root) file or directory name in the
<i>path</i> object.</p>
<p>In addition to <i>leaf()</i>, several other function names use the 
tree/root/branch/leaf metaphor.</p>
<p>Notice that <i>find_file()</i> does not do explicit error checking, such as 
verifying that the <i>dir_path</i> argument really represents a directory. All 
Filesystem Library functions throw <a href="exception.htm">filesystem_error</a> 
exceptions if they do not complete successfully, so there is enough implicit 
error checking that this application doesn't need to supply additional error 
checking code.</p>
<p>The tutorial is now over; hopefully you now are ready to write simple, 
script-like, programs using the Filesystem Library!</p>
<h2><a name="Examples">Examples</a></h2>
<h3>simple_ls.cpp</h3>
<p>The example program <a href="../example/simple_ls.cpp">simple_ls.cpp</a> is 
given a path as a command line argument. Since the command line argument may be 
a relative path, the complete path is determined so that messages displayed 
can be more precise.</p>
<p>The program checks to see if the path exists; if not a message is printed.</p>
<p>If the path identifies a directory, the directory is iterated through, 
printing the name of the entries found, and an indication if they are 
directories. A count of directories and files is updated, and then printed after 
the iteration is complete.</p>
<p>If the path is for a file, a message indicating that is printed.</p>
<p>Try compiling and executing <a href="../example/simple_ls.cpp">simple_ls.cpp</a> 
to see how it works on your system. Try various path arguments to see what 
happens.</p>
<h3>Other examples</h3>
<p>The programs used to generate the Boost regression test status tables use the 
Filesystem Library extensively.&nbsp; See:</p>
<ul>
  <li><a href="../../../tools/regression/process_jam_log.cpp">
  process_jam_log.cpp</a></li>
  <li><a href="../../../tools/regression/compiler_status.cpp">
  compiler_status.cpp</a></li>
</ul>
<p>Test programs are sometimes useful in understanding a library, as they 
illustrate what the developer expected to work and not work. See:</p>
<ul>
  <li><a href="../test/path_test.cpp">path_test.cpp</a></li>
  <li><a href="../test/operations_test.cpp">operations_test.cpp</a></li>
  <li><a href="../test/fstream_test.cpp">fstream_test.cpp</a></li>
</ul>
<h2><a name="Definitions">Definitions</a></h2>
<p><b><a name="directory">directory</a> </b>- A container provided by the operating system, 
containing the names of files, other directories, or both. Directories are identified 
by <a href="#directory path">directory path</a>.</p>
<p><b><a name="directory_tree">directory tree</a></b> - A directory and file 
hierarchy viewed as an acyclic graph. The tree metaphor is reflected in the 
root/branch/leaf naming convention for many <a href="#path">path</a> related 
functions.</p>
<p><b><a name="path">path</a> </b>- A possibly empty sequence of <a href="#name">names</a>. Each 
element in the sequence, except the last, names a <a href="#directory">directory</a> 
which contains the 
next element. The last element may name either a directory or file. The first 
element is closest to the <a href="#root">root</a> of the directory tree, the last element is 
farthest from the root.</p>
<p>It is traditional to represent a path as a string, where each element in the 
path is represented by a <a href="#name">name</a>, and some operating system 
defined syntax distinguishes between the name elements. Other representations of 
a path are possible, such as each name being an element in a <code>std::vector&lt;std::string&gt;</code>.</p>
<p><b><a name="file path">file path</a></b> - A <a href="#path">path</a> whose 
last element is a file.</p>
<p><b><a name="directory_path">directory path</a></b> - A <a href="#path">path</a> 
whose last element is a directory.</p>
<p><b><a name="complete_path">complete path</a></b> - A <a href="#path">path</a> 
which contains all the elements required by the operating system to uniquely 
identify a file or directory. (There is an odd
<a href="path.htm#is_complete_note">corner case</a> where a complete path can 
still be ambiguous on a few operating systems.)</p>
<p><b><a name="relative_path">relative path</a></b> - A <a href="#root">path</a> 
which is not <a href="#complete_path">complete</a>. Before actual use, relative 
paths are turned into <a href="#complete_path">complete paths</a> either 
implicitly by the filesystem adding default elements, or explicitly by the 
program adding the missing elements via function call. Use of relative paths 
often makes a program much more flexible.</p>
<p><b><a name="name">name</a></b> - A file or directory name, without any
<a href="#directory path">directory path</a> information to indicate the file or 
directory's actual location within a directory tree. For some 
operating systems, files and directories may have more than one valid name, such 
as a short-form name and a long-form name.</p>
<p><b><a name="root">root</a></b> - The initial node in the acyclic graph which 
represents the <a href="#directory_path">directory tree</a> for a filesystem.</p>
<p><b><a name="multi-root_filesystem">multi-root operating system</a></b> - An 
operating system which has multiple <a href="#root">roots</a>. Some operating systems 
have different <a href="#directory_tree">directory trees</a> for each different 
disk, drive, device, volume, share, or other entity managed the system, with each having its 
own root-name.</p>
<p><b><a name="link">link</a></b> - A&nbsp;name in a <a href="#directory">
directory</a> can be viewed as a pointer to some underlying directory or file 
content. Modern operating systems permit multiple directory elements to point to 
the same underlying directory or file content. Such a pointer is often called a 
link. Not all operating systems support the 
concept of links. Links may be reference-counted (<a href="#hard-link">hard link</a>) 
or non-reference-counted (<a href="#symbolic-link">symbolic link</a>).</p>
<p><b><a name="hard-link">hard link</a></b> - A reference-counted
<a href="#link">link</a>. Because the operating system manages the underlying 
file or directory, hard links are transparent to programs. They &quot;just work&quot; 
without the programmer needing to be aware of their existence.</p>
<p><b><a name="symbolic-link">symbolic link</a></b> - A non-reference-counted
<a href="#hard-link">link</a>. The operating system manages some aspects of 
symbolic links. Most uses, such as opening or querying files, automatically 
resolve to the file or directory being pointed to rather than to the symbolic 
link itself. A few uses, such as remove() and rename(), modify the symbolic link 
rather than it's target. See an important
<a href="operations.htm#symbolic-link-warning">symbolic links warning</a>.</p>
<h2><a name="Common_Specifications">Common Specifications</a></h2>
<p>Unless otherwise specified, all Filesystem Library member and non-member 
functions have the following common specifications:</p>
<p><b>Postconditions not guaranteed in the presence of race-conditions</b> - 
Filesystem function specifications follow the form of C++ Standard Library 
specifications, and so sometimes specify behavior in terms of postconditions. If 
a <a href="#Race-condition">race-condition</a> exists, a function's 
postconditions may no longer be true by the time the function returns to the 
caller.</p>
<p><b>May throw exceptions</b> - Filesystem Library functions may throw <i><a href="exception.htm">filesystem_error</a></i> 
exceptions if they cannot successfully complete their operational 
specifications. Function implementations may use C++ Standard Library functions, 
which may throw <i>std::bad_alloc</i>. These exceptions may be thrown even 
though the error condition leading to the exception is not explicitly specified 
in the function's &quot;Throws&quot; paragraph.</p>
<p><b>Exceptions thrown via <a href="../../utility/throw_exception.html">
boost::throw_exception()</a></b> - All exceptions thrown by the Filesystem 
Library are implemented by calling <a href="../../utility/throw_exception.html">
boost::throw_exception()</a>. Thus exact behavior may differ depending on 
BOOST_NO_EXCEPTIONS at the time the filesystem source files are compiled.</p>
<p><b><a name="link_rules">Links follow operating system rules</a></b>- <a href="#link">Links</a> are 
transparent in that Filesystem Library functions simply follow operating system 
rules. That implies that some functions may throw <i><a href="exception.htm">filesystem_error</a></i> 
exceptions if a link is cyclic or has other problems. Also, see an important
<a href="operations.htm#symbolic-link-warning">symbolic links warning</a>.</p>
<p>Typical operating systems rules call for deep operations on all links except 
that destructive operations on non-reference counted links are either shallow, 
or fail altogether in the case of trying to remove a non-reference counted link 
to a directory.</p>
<p>Rationale: Follows existing practice (POSIX, Windows, etc.).</p>
<p><b>No atomic-operation or rollback guarantee</b> - Filesystem Library 
functions which throw exceptions may leave the external file system in an 
altered state. It is suggested that implementations provide stronger guarantees 
when possible.</p>
<p>Rationale: Implementers shouldn't be required to provide guarantees which are 
impossible to meet on some operating systems. Implementers should be given 
normative encouragement to provide those guarantees when possible.</p>
<p><b>Graceful degradation</b> -&nbsp; Filesystem Library functions which cannot 
be fully supported on a particular operating system will be partially supported 
if possible. Implementations must document such partial support. Functions which 
are requested to provide some operation which they cannot support should report 
an error at compile time (preferred) or throw an exception at runtime.</p>
<p>Rationale: Implementations on less-powerful operating systems should provide 
useful functionality if possible, but are not be required to simulate 
features not present in the underlying operating system.</p>
<h2><a name="Race-condition">Race-condition</a> d<a name="Dangers">anger</a></h2>
<p>The state of files and directories is often
globally shared, and thus may be changed unexpectedly by other threads, 
processes, or even other computers having network access to the filesystem. As an 
example of the difficulties this can cause, note that the following asserts 
may fail:</p>
<blockquote>
<p><code>assert( exists( &quot;foo&quot; ) == exists( &quot;foo&quot; ) );&nbsp; // 
(1)<br>
<br>
remove_all( &quot;foo&quot; );<br>
assert( !exists( &quot;foo&quot; ) );&nbsp; // (2)<br>
<br>
assert( is_directory( &quot;foo&quot; ) == is_directory( &quot;foo&quot; ) ); // 
(3)</code></p>
</blockquote>
<p>(1) will fail if a non-existent &quot;foo&quot; comes into existence, or an 
existent &quot;foo&quot; is removed, between the first and second call to <i>exists()</i>. 
This could happen if, during the execution of the example code, another thread, 
process, or computer is also performing operations in the same directory.</p>
<p>(2) will fail if between the call to <i>remove_all()</i> and the call to
<i>exists()</i> a new file or directory named &quot;foo&quot; is created by another 
thread, process, or computer.</p>
<p>(3) will fail if another thread, process, or computer removes an 
existing file &quot;foo&quot; and then creates a directory named &quot;foo&quot;, between the 
example code's two calls to <i>is_directory()</i>.</p>
<p>A program which needs to be robust when operating on potentially-shared file 
or directory resources should be prepared for <i>filesystem_error</i> exceptions 
to be thrown from any filesystem function except those explicitly specified as 
not throwing exceptions.</p>
<h2><a name="Implementation">Implementation</a></h2>
<p>The current implementation supports operating systems that have 
either the POSIX or Windows API's available.</p>
<p>The following tests are provided:</p>
<ul>
  <li><a href="../test/path_test.cpp">path_test.cpp</a></li>
  <li><a href="../test/operations_test.cpp">operations_test.cpp</a></li>
  <li><a href="../test/fstream_test.cpp">fstream_test.cpp</a></li>
  <li><a href="../test/convenience_test.cpp">convenience_test.cpp</a></li>
</ul>
<p>The library is in regular use on Apple Mac OS, HP-UX, IBM AIX, Linux, 
Microsoft Windows, SGI IRIX, and Sun Solaris operating systems using a variety 
of compilers.</p>
<h2><a name="Building">Building</a> the object-library</h2>
<p>The object-library will normally be built automatically. See
<a href="../../../more/getting_started.html">Getting Started</a>. It can also be 
built manually using a <a href="../build/Jamfile">Jamfile</a> 
supplied in directory libs/filesystem/build, or the user can construct an IDE 
project or make file which includes the object-library source files.</p>
<p>The object-library source files (<a href="../src/convenience.cpp">convenience.cpp</a>,
<a href="../src/exception.cpp">exception.cpp</a>,
<a href="../src/operations_posix_windows.cpp">operations_posix_windows.cpp</a>, 
and <a href="../src/path_posix_windows.cpp">path_posix_windows.cpp</a>) are 
supplied in directory libs/filesystem/src. These source files implement the 
library for POSIX or Windows compatible operating systems; no implementation is 
supplied for other operating systems. Note that many operating systems not 
normally thought of as POSIX  systems, such as mainframe legacy 
operating systems or embedded operating systems, support POSIX compatible file 
systems which will work with the Filesystem Library.</p>
<p>The object-library can be built for static or dynamic (shared/dll) linking. 
This is controlled by the BOOST_ALL_DYN_LINK or BOOST_FILESYSTEM_DYN_LINK 
macros. See the <a href="../../../more/separate_compilation.html">Separate 
Compilation</a> page for a description of the techniques used.</p>
<h3>Note for <a name="Cgywin">Cygwin</a> users</h3>
<p>The library's implementation code automatically detects the current platform, 
and compiles the POSIX or Windows implementation code accordingly. Automatic 
platform detection during object library compilation can be overridden by 
defining BOOST_POSIX or BOOST_WINDOWS macros. With the exception of the Cygwin 
environment, there is usually no reason to define one of the macros, as the 
software development kits supplied with most compilers only support a single 
platform.</p>
<p>The <a href="http://www.cygwin.com/">Cygwin</a> package of tools supports 
traditional Windows usage, but also provides an emulation layer and other tools 
which can be used to make Windows act as Linux (and thus POSIX), and provide the 
Linux look-and-feel. GCC is usually the compiler of choice in this environment, 
as it can be installed via the Cygwin install process. Other compilers can also 
use the Cygwin emulation of POSIX, at least in theory.</p>
<p>Those wishing to use the Cygwin POSIX emulation layer should define the 
BOOST_POSIX macro when compiling the Boost Filesystem Library's object-library. 
The macro does not need to be defined (and will have no effect if defined) for 
Boost Filesystem Library user programs.</p>
<h2><a name="Acknowledgements">Acknowledgements</a></h2>
<p>The Filesystem Library was designed and implemented by Beman Dawes. The <i>directory_iterator</i> and <i>filesystem_error</i> classes were 
based on prior work from Dietmar Khl, as modified by Jan Langer. Thomas Witt 
was a particular help in later stages of development.</p>

<p>Key <a href="design.htm#Requirements">design requirements</a> and
<a href="design.htm#Realities">design realities</a> were developed during 
extensive discussions on the Boost mailing list, followed by comments on the 
initial implementation. Numerous helpful comments were then received during the 
Formal Review.<p>Participants included 
Aaron Brashears,
Alan Bellingham,
Aleksey Gurtovoy,
Alex Rosenberg,
Alisdair Meredith,
Andy Glew,
Anthony Williams,
Baptiste Lepilleur, 
Beman Dawes,
Bill Kempf,
Bill Seymour, 
Carl Daniel,
Chris Little,
Chuck Allison,
Craig Henderson, 
Dan Nuffer,
Dan'l Miller,
Daniel Frey, 
Darin Adler, 
David Abrahams,
David Held, 
Davlet Panech,
Dietmar Kuehl,
Douglas Gregor, 
Dylan Nicholson,
Ed Brey, 
Eric Jensen,
Eric Woodruff,
Fedder Skovgaard,
Gary Powell,
Gennaro Prota,
Geoff Leyland, 
George Heintzelman, 
Giovanni Bajo,
Glen Knowles,
Hillel Sims,
Howard Hinnant,
Jaap Suter,
James Dennett, 
Jan Langer, 
Jani Kajala, 
Jason Stewart, 
Jeff Garland,
Jens Maurer,
Jesse Jones,
Jim Hyslop,
Joel de Guzman,
Joel Young,
John Levon, 
John Maddock,
John Williston,
Jonathan Caves,
Jonathan Biggar,
Jurko,
Justus Schwartz,
Keith Burton, 
Ken Hagen,
Kostya Altukhov, 
Mark Rodgers,
Martin Schuerch, 
Matt Austern,
Matthias Troyer, 
Mattias Flodin, 
Michiel Salters,
Mickael Pointier,
Misha Bergal,
Neal Becker,
Noel Yap,
Parksie,
Patrick Hartling, Pavel Vozenilek,
Pete Becker, 
Peter Dimov,
Rainer Deyke,
Rene Rivera,
Rob Lievaart,
Rob Stewart,
Ron Garcia,
Ross Smith,
Sashan,
Steve Robbins, 
Thomas Witt, 
Tom Harris, 
Toon Knapen,
Victor Wagner,
Vincent Finn,
Vladimir Prus, and
Yitzhak Sapir
 
<p>A lengthy discussion on the C++ committee's library reflector illuminated the &quot;illusion 
of portability&quot; problem, particularly in postings by PJ Plauger and Pete Becker.</p>

<p>Walter Landry provided much help illuminating symbolic link use cases for 
version 1.31.0.</p>

<h2><a name="Change-history">Change history</a></h2>

<h3>Version 1.32.0</h3>

<ul>
  <li><a href="operations.htm#file_size">file_size()</a> function added.</li>
  <li>Class path <a href="path.htm#operator_eq">relational operators</a> added.</li>
  <li><a href="operations.htm#equivalent">equivalent()</a> function added.</li>
  <li><a href="operations.htm#create_directory">create_directory()</a> no longer 
  throws if the directory already exists. A bool is returned, indicating that 
  the directory did not preexist. Similar changes made to
  <a href="convenience.htm">create_directories()</a>.</li>
  <li><a href="#Cgywin">Docs added</a> for users wishing Cygwin/POSIX behavior 
  on Windows.</li>
  <li>For POSIX, Large File Support (LSF) is enabled if available, such as on 
  Linux.</li>
  <li><a href="operations.htm#current_path">current_path()</a> and
  <a href="operations.htm#initial_path">initial_path()</a> on POSIX now handle 
  very long paths correctly.</li>
</ul>

<h3>Version 1.31.0</h3>

<ul>
  <li>The object library can now be <a href="#Building">built</a> for either 
  static or dynamic (shared/dll) linking. </li>
  <li>Several added functions, including improved checking for directory and 
  file name portability. See <a href="path.htm#default_name_check">Default name 
  check functions</a>, <a href="path.htm#name_check_mechanism">Default name 
  check mechanism</a>, and <a href="portability_guide.htm#name_check_functions">
  Name check functions</a>.</li>
  <li>Separation of <a href="path.htm#Canonical">Canonical form</a> and
  <a href="path.htm#Normalized">Normalized form</a> and a new path member 
  function <a href="path.htm#normalize">normalize()</a>. This changes behavior, 
  in that canonical form is now different, but eliminates a subtle
  <a href="design.htm#symbolic-link-use-case">bug</a> when symbolic links to 
  directories are present. </li>
</ul>

<hr>
<p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2004<!--webbot bot="Timestamp" endspan i-checksum="28862" --></p>

<p> Copyright Beman Dawes, 2002</p>
<p> Use, modification, and distribution are subject to the Boost Software 
License, Version 1.0. (See accompanying file <a href="../../../LICENSE_1_0.txt">
LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
www.boost.org/LICENSE_1_0.txt</a>)</p>

</body>

</html>