smash::RenamingFilePtr Class Reference

#include <file.h>

A RAII type to replace std::FILE *.

While open, the file name ends with ".unfinished".

Automatically closes and renames the file to the original when it goes out of scope.

Definition at line 73 of file file.h.

Collaboration diagram for smash::RenamingFilePtr:

Public Member Functions
	RenamingFilePtr (const bf::path &filename, const std::string &mode)
	Construct a RenamingFilePtr. More...
FILE *	get ()
	Get the underlying FILE* pointer. More...
	~RenamingFilePtr ()
	Close the file and rename it. More...

Private Attributes
FILE *	file_
	Internal file pointer. More...
bf::path	filename_
	Path of the finished file. More...
bf::path	filename_unfinished_
	Path of the unfinished file. More...

Constructor & Destructor Documentation

RenamingFilePtr()

smash::RenamingFilePtr::RenamingFilePtr	(	const bf::path &	filename,
		const std::string &	mode
	)

Construct a RenamingFilePtr.

Parameters

[in]	filename	Path to the file.
[in]	mode	The mode in which the file should be opened (see std::fopen).

Returns

The constructed object.

Definition at line 19 of file file.cc.

                                                        {
  filename_ = filename;
  filename_unfinished_ = filename;
  filename_unfinished_ += ".unfinished";
  file_ = std::fopen(filename_unfinished_.c_str(), mode.c_str());
}

Here is the call graph for this function:

~RenamingFilePtr()

smash::RenamingFilePtr::~RenamingFilePtr

(

)

Close the file and rename it.

Definition at line 29 of file file.cc.

                                  {
  std::fclose(file_);
  bf::rename(filename_unfinished_, filename_);
}

Member Function Documentation

get()

FILE * smash::RenamingFilePtr::get

(

)

Get the underlying FILE* pointer.

Definition at line 27 of file file.cc.

{ return file_; }

Here is the caller graph for this function:

Member Data Documentation

file_

FILE* smash::RenamingFilePtr::file_

private

Internal file pointer.

Definition at line 91 of file file.h.

filename_

bf::path smash::RenamingFilePtr::filename_

private

Path of the finished file.

Definition at line 93 of file file.h.

filename_unfinished_

bf::path smash::RenamingFilePtr::filename_unfinished_

private

Path of the unfinished file.

Definition at line 95 of file file.h.

---

The documentation for this class was generated from the following files:

• src/include/smash/file.h
• src/file.cc