[转]boost 文件系统库相关资料

[转]boost 文件系统库相关资料
2011年05月04日
　　原文链接：http://www.usidcbbs.com/simple/?t1883.html
　　今天开始写作boost库指南系列文章了，我个人比较熟的就是这个filesystem库，当然要从这里先开始。这系列指南只是对初学的一个快速指南，没有深入学习，当然我个人水平也不敢说“深入”二字。
　　C++ 程序一直有一个方面不能做可移植性，尽管标准库有几个函数用于操作与文件系统相关的任务，但是这几个函数作用相对我们日常对文件系统操作的需求来说真是杯水车薪，所以对目录、路径、文件元信息的操作一直难以做可移植性。然而对于现在的程序来说，可移植性极端重要，谁也不保证他写程序不要某一天要移植更一个系统中去，可能这个系统现在大家还很少听说。
　　boost.filesystem 为大家提供了一个选择。boost.filesystem以实现可移植的文件系统的操作为目标，通过精心设计一个中间概念来完成大多数可移植的文件系统的操作，这个中间层试图独立于所有的具体文件系统，然后把操作任务映射到这个中间层。当然这个中间层可能与现有的文件系统有最大的相似之处。本文不试图去讲述这个中间层，因为针对绝大部分情况，我们使用boost.filesystem不需要知道这个中间层。
　　下面我正式开始这个指南，这次好像扯得太远了。
　　基础知识 
　　这里我们讲述一些使用库的基础的准备的知识。
　　filesystem 库提供了两个头文件，一个是，这个头文件包含主要的库内容。它提供了对文件系统的重要操作。同时它定义了一个类path，正如大家所想的，这个是一个可移植的路径表示方法，它是filesystem库的基础。 
　　一个是，是对std::fstream的一个补充，使用可以使用类boost::path作为参数，从而使得filesystem库与标准库的关系更亲密。 
　　由于文件系统对于大多数系统来说都是共享的，所以不同的进程可以同时操作同一个对象，因此filesysetm不提供这方面的特性保证。当然这种保证也是不可能的，或者至少昂贵的。 
　　filesystem在任何时候，只要不能完成相应的任务，它都可能抛出 basic_filesystem_error异常，当然并不是总会抛出异常，因为在库编译的时候可以关闭这个功能。同时有两个函数提供了无异常版本，这是因为在任务不能完成时并非是异常。 
　　filesystem 库的所有内容定义在boost名字空间的一个下级名字空间里，它叫boost::filesytem。在使用boost.filesytem之后，链接时需要加“-lboost_filesystem-mt”选项，因为这个需要额外的链接，并非一个纯头文件的库。 获得单独文件属性有了上面的准备知识，大家可以写一些简单的程序了。这篇文档主要作为一个入门的指南性的文档，所以会提供许多实例，或者说主要以实体来说明的boost.filesystem库的使用. /*  * ================================================== ===================================  *  * Filename: filesystem.cpp  *  * Description: 简单C++，boost filesystem 指南  *  * Version: 1.0  * Created: 2009年08月17日 17时16分32秒  * Revision: none  * Compiler: gcc -Wall -Wextra filesystem.cpp -lboost_filesystem-mt  *  * Author: lgb (LiuGuangBao), [email protected]  * Company: easy99.org  *  * ================================================== ===================================  */#include#include#includeint main() { namespace bf=boost::filesystem;//简单别名 //filesystem中最基本的类型  bf::path path("/tmp/test"); //对当前的目录的操作  bf::path old_cpath=bf::current_path(); //取得当前目录  bf::path file_path = path / "file"; //path重载了 / 运算符 //判断文件存在性 if(bf::exists(path)) { std::ofstream out(path.file_string().c_str()); if(!out) return 1; out "一个测试文件\n"; } else { std::cout path "不存在\n"; //目录不存在，创建  bf::create_directory(path); std::ofstream out(file_path.file_string().c_str()); if(!out) return 1; out "一个测试文件\n"; } bf::current_path(path); //设置当前为/home if(bf::is_regular_file(path)) { std::cout path "是普通文件\n"; std::cout path ": 大小为"bf::file_size(path) '\n'; bf::create_symlink(file_path, "/tmp/test/file-symlink"); } bf::current_path(old_cpath); bf::remove(file_path);//删除文件file_path  bf::remove_all(path);//递归地删除 return 0; } 
　　上面的示例我们在Linux在测试通过，因为使用的是Linux系统。它首先创建一些东西，最后又把这些东西删除了，恢复原样了。 
　　filesystem库使用经验 
　　文件系统不具有许多特性与我们日常编写的程序不一样，标准库没有提供一个filesystem的原因就在于此，这个特殊性表现在：
　　文件系统是操作系统级别上的全局性，即文件系统中的操作可以在多个进程中异步进行，这可能引起许多问题，也就是说文件系统不是串行系统。 
　　文件系统具有很大的系统相关性，不同的操作系统提供了不同的文件系统，相同的操作系统也可以存在众多区别。这使得编写具有可移植的文件系统相关程序很困难，这需要足够多的小心与细致。 
　　不要使用绝对路径，因为绝对路径系统相关性太强了，所以不可能在中间层透明地完成；应该使用相对路径。 
　　boost::filesystem系统地定义了一个中间层，并且做到尽可能自由，但是有些问题是无法避免的。如UNIX系统存在符号链接的概念，而Windows中不存在，所以当你使用符号链接的时候就说明你不可能做到可移植性。  缺乏定义良好的、用于处理文件系统操作的库，这一直是 C++ 语言存在的一个问题。过去，程序员必须使用本机 API 来解决此问题。通过本文您将了解一个提供安全、可移植且易用的 C++ 接口来促进文件系统操作的库：Boost Filesystem Library。  C++ 语言（实际上是 C++ 标准）的最常见问题之一是，缺乏定义良好的库来帮助处理文件系统查询和操作。 由于这个原因，程序员不得不使用本机操作系统提供的应用程序编程接口（Application Program Interfaces，API），而这使得代码不能在平台之间移植。以下面的简单情况为例：您需要确定某个文件是否是 Directory 类型。在 Microsoft Windows 平台中，可以通过调用 GetAttributes 库函数（在 windows.h 头文件中定义）进行此操作：  对于目录，所得到的结果应该为 FILE_ATTRIBUTE_DIRECTORY，而您的代码必须检查是否为此结果。在 UNIX 和 Linux 平台上，可以通过使用 stat 或 fstat 函数及 sys/stat.h 中定义的 S_ISDIR 宏来实现相同的功能。您还必须理解 stat 结构。下面是对应的代码：   对于 I/O 操作较多的程序，这样的不一致就意味着需要进行大量的工程工作才能在平台间移植代码。正是因为这个原因，我们才引入了 Boost Filesystem Library。这个广泛使用的库提供了安全、可移植且易用的 C++ 接口，用于执行文件系统操作。可以从 Boost 站点免费下载此库。 
　　使用 boost::filesystem 的第一个程序 
　　在深入研究 Boost Filesystem Library 的更多细节之前，请看一下清单 1 中所示的代码；此代码使用 Boost API 确定某个文件的类型是否为 Directory。 
　　清单 1. 用于确定某个文件的类型是否为 Directory 的代码  此代码非常明了易懂，您并不需要了解任何系统特定的例程。此代码经过验证，能在不用修改的情况下在 gcc-3.4.4 和 cl-13.10.3077 上成功编译。
　　了解 Boost path 对象 
　　了解 Boost Filesystem Library 的关键是 path 对象，因为 Filesystem Library 中定义的多个例程都要对相应的 path 对象操作。文件系统路径通常依赖于操作系统。例如，众所周知，UNIX 和 Linux 系统使用正斜杠 ( /) 字符作为目录分隔符，而 Windows 将反斜杠 (\) 字符用于类似的用途。boost::filesystem::path 旨在准确地抽象此特性。path 对象可以通过多种方式进行初始化，最常见的方式是使用 char* 或 std::string 进行初始化，如清单 2 中所示。 
　　清单 2. 创建 Boost path 对象的方法  在初始化 path 对象时，可以采用本机格式或可移植操作系统接口（Portable Operating System Interface，POSIX）委员会定义的可移植格式提供 PATHNAME 变量。这两种方法在实际中各有优缺点。考虑以下情况：您希望操作软件所创建的目录，此目录在 UNIX 和 Linux 系统上位于 /tmp/mywork，而在 Windows 上位于 C:\tmp\mywork。可以采用多种方法处理问题。清单 3 显示了面向本机格式的方法。
　　清单 3. 使用本机格式初始化 path  需要单个 #ifdef 来按操作系统初始化 path 对象。不过，如果您喜欢使用可移植格式，请参见清单 4。
　　清单 4. 使用可移植格式初始化 path  请注意，path::name_check 指的是一个名称检查函数原型。如果其参数输入 PATHNAME 对于特定的操作系统或文件系统有效，名称检查函数将返回“True”。Boost Filesystem Library 提供了多个名称检查函数，而且也欢迎您提供自己的变体。常用的名称检查函数是 Boost 提供的 portable_posix_name 和 windows_name。 
　　path 成员函数概述 
　　path 对象提供了多个成员方法。这些成员例程并不会修改文件系统，但会根据 path 名称提供有用的信息。此部分提供了其中几个例程的概述：  const std::string& string( )：此例程会返回用于初始化 path 的字符串的副本，其格式符合 path 语法规则。 
　　std::string root_directory( )：在提供了路径的情况下，此 API 将返回根目录，否则将返回空字符串。例如，如果路径包含 /tmp/var1，则此例程将返回 /，即 UNIX 文件系统的根。不过，如果路径是相对路径，如 ../mywork/bin，此例程将返回空字符串。 
　　std::string root_name( )：在给定从文件系统根目录开始的路径的情况下，此例程将返回包含 PATHNAME 的第一个字符的字符串。 
　　std::string leaf( )：在给定绝对路径名称（例如，/home/user1/file2）的情况下，此例程将提供与文件名称对应的字符串（即 file2）。 
　　std::string branch_path( )：这是与 leaf 互补的例程。在给定路径的情况下，将会返回其构造所用的所有元素（除了最后一个元素）。例如，对于使用 /a/b/c 初始化的 path，path.branch_path( ) 将返回 /a/b。对于包含单个元素的路径，如 c，此例程将返回空字符串。 
　　bool empty( )：如果 path 对象包含空字符串（例如 path path1("")），则此例程将返回 True。 
　　boost::filesystem::path::iterator：此例程用于遍历 path 的各个元素。请看清单 5 所示的代码。 
　　清单 5. 使用 path::iterator（begin 和 end 接口） 上述程序的输出依次是 /、usr、local、include，代表了该目录的层次结构。 
　　path operator / (char* lhs, const path& rhs)：此例程是 path 的非成员函数。它将返回使用 lhs 和 rhs 形成的路径的串联值。它将自动插入 / 作为路径分隔符，如清单 6 中所示。 
　　清单 6. 路径字符串的串联 错误处理 
　　文件系统操作经常遇到意外的问题，Boost Filesystem Library 将使用 C++ 异常报告运行时错误。boost::filesystem_error 类派生自 std::runtime_error 类。库中的函数使用filesystem_error 异常报告操作错误。与不同的可能错误类型对应，Boost 头文件定义了相应的错误代码。用户代码通常驻留在 try...catch 块内，使用 filesystem_error 异常来报告相关错误消息。清单 7 提供了重命名文件的小示例，在 from 路径中的文件不存在时引发异常。 
　　清单 7. Boost 中的错误处理 #include#include “boost/filesystem.hpp”int main(){try { boost::filesystem::path path("C:\\src\\hdbase\\j1"); boost::filesystem::path path2("C:\\src\\hdbase\\j2"); boost::filesystem::rename(path, path2); }catch(boost::filesystem::filesystem_error e) { // do the needful  } return 0;}
　　Boost Filesystem Library 中的函数类别 
　　boost::filesystem 提供了不同类别的函数：有些函数（如 is_directory）用于查询文件系统，而其他函数（如 create_directory）则主动对文件系统进行修改。根据各自功能的不同，这些函数可以大略归入以下类别： 
　　属性函数：提供杂项信息，如文件大小、磁盘使用量等。 
　　文件系统操作函数：用于创建常规文件、目录和符号链接；复制和重命名文件；提供删除功能。 
　　实用工具：测试文件的扩展名等。 
　　杂项常规函数：以编程方式更改文件扩展名等。 
　　属性函数 
　　Boost Filesystem Library 包括以下属性函数： 
　　uintmax_t file_size(const path&)：返回常规文件的大小（以字节为单位） 
　　boost::filesystem::space_info space(const path&)：接受路径作为输入，并返回定义如下的 space_info 结构：  根据文件系统所属的磁盘分区，此流程将对该分区的所有目录返回相同的磁盘使用量统计数据（以字节为单位）。例如，对于 C:\src\dir1 和 C:\src\dir2，都会返回相同的磁盘使用数据。 
　　std::time_t last_write_time(const path&)：返回文件的最后修改时间。 
　　void last_write_time(const path&, std::time_t new_time)：修改文件的最后修改时间。 
　　const path& current_path( )：返回程序的当前工作目录的完整路径（注意，此路径与最初运行程序的路径可能不同，因为可能采用编程方式更改目录）。 
　　文件系统操作函数 
　　这组函数负责进行新文件和目录创建、文件删除等操作： 
　　bool create_directory(const path&)：此函数使用给定的路径名称创建目录。（请注意，如果 PATHNAME 本身包含无效字符，则结果经常是由平台定义的。例如，在 UNIX 和 Windows 系统中，星号 (*)、问号 (?) 及其他此类字符视为无效，不能出现在目录名称中。） 
　　bool create_directories(const path&)：与创建单个目录相对，您可以使用此 API 创建目录树。例如，以目录树 /a/b/c 为例，必须在 /tmp 文件夹内创建此目录树。可调用此 API 完成任务，但使用相同的参数调用 create_directory 时将引发异常。 
　　bool create_hard_link (const path& frompath, const path& topath)：此函数在 frompath 和 topath 间创建硬链接。 
　　bool create_symlink(const path& frompath, const path& topath)：此函数在 frompath 和 topath 间创建符号（软）链接。 
　　void copy_file(const path& frompath, const path& topath)：将 frompath 引用的文件的内容和属性复制到 topath 引用的文件中。例程expects a destination file to be absent；如果存在目标文件，则会引发异常。因此，此函数与 UNIX 中系统指定的 cp 命令并不等效。另外，此函数还预期 frompath 变量将引用正确的常规文件。请看以下示例：frompath 引用符号链接 /tmp/file1，而后者反过来引用文件 /tmp/file2；而 topath 可以为 /tmp/file3。在这种情况下，copy_file 将失败。这是此 API 与 cp 命令相比的另一个差别。 
　　void rename(const path& frompath, const path& topath)：此函数是用于重命名文件的 API。可以通过在 topath 参数中指定完整路径名来同时重命名和更改文件的位置，如清单 8 中所示。 
　　清单 8. Boost 中的重命名功能 bool remove(const path& p)：此例程将尝试删除路径 p 所引用的文件或目录。对于目录的情况，如果目录的内容不为空，则此例程将引发异常。警告：此例程并不考虑所删除的内容，即使其他程序在访问同一文件也如此！ 
　　unsigned long remove_all(const path& p)：此 API 尝试删除路径 p 所引用的文件或目录。与 remove 不同，此函数并不会特殊考虑不为空的目录。此函数是 UNIX rm