tpie::file< T > Class Template Reference

Central file abstraction. More...

#include <tpie/file.h>

Inherits tpie::file_base.

Classes
class	stream
	Central stream abstraction. More...

Public Types
typedef T	item_type
	Type of items stored in the file. More...

Public Member Functions
	file (double blockFactor=1.0, file_accessor::file_accessor *fileAccessor=NULL)
	Construct a file object with the given block factor and file accessor. More...
stream_size_type	size () const throw ()
void	close ()
void	truncate (stream_size_type s)
	Truncate file to given size. More...
bool	is_readable () const throw ()
	Check if we can read from the file. More...
bool	is_writable () const throw ()
	Check if we can write to the file. More...
memory_size_type	block_size () const
	Get the size of a block in bytes. More...
memory_size_type	block_items () const
	Get the number of items per block. More...
void	read_user_data (TT &data)
	Read the user data associated with the file. More...
memory_size_type	read_user_data (void *data, memory_size_type count)
	Read variable length user data associated with the file. More...
void	write_user_data (const TT &data)
	Write user data to the stream. More...
void	write_user_data (const void *data, memory_size_type count)
	Write variable length user data associated with the file. More...
memory_size_type	user_data_size () const
	Get current user data size. More...
memory_size_type	max_user_data_size () const
	Get maximum user data size. More...
const std::string &	path () const throw ()
	The path of the file opened or the empty string. More...
void	open (const std::string &path, access_type accessType=access_read_write, memory_size_type userDataSize=0, cache_hint cacheHint=access_sequential)
	Open a file. More...
void	open (memory_size_type userDataSize=0, cache_hint cacheHint=access_sequential)
	Open an anonymous temporary file. More...
void	open (temp_file &file, access_type accessType=access_read_write, memory_size_type userDataSize=0, cache_hint cacheHint=access_sequential)
	Open a temporary file. More...
bool	is_open () const
	Check if file is open. More...
stream_size_type	file_size () const throw ()
	Get the size of the file measured in items. More...

Static Public Member Functions
static memory_size_type	memory_usage (bool includeDefaultFileAccessor=true)
	Calculate the memory usage of a file. More...
static memory_size_type	block_size (double blockFactor) throw ()
	Calculate the block size in bytes used by a stream. More...
static double	calculate_block_factor (memory_size_type blockSize) throw ()
	Find the block factor that would result in the given block size measured in bytes. More...
static memory_size_type	block_memory_usage (double blockFactor)
	Amount of memory used by a single block given the block factor. More...

Protected Member Functions
void	update_size (stream_size_type size)
void	create_block ()
void	delete_block ()
block_t *	get_block (stream_size_type block)
void	free_block (block_t *block)
void	open_inner (const std::string &path, access_type accessType, memory_size_type userDataSize, cache_hint cacheHint)
void	read_block (BT &b, stream_size_type block)
void	get_block_check (stream_size_type block)

Protected Attributes
boost::intrusive::list< block_t >	m_used
boost::intrusive::list< block_t >	m_free
memory_size_type	m_blockItems
memory_size_type	m_blockSize
bool	m_canRead
bool	m_canWrite
bool	m_open
memory_size_type	m_itemSize
file_accessor::file_accessor *	m_fileAccessor
tpie::unique_ptr< temp_file >	m_ownedTempFile
temp_file *	m_tempFile
stream_size_type	m_size

Static Protected Attributes
static block_t	m_emptyBlock

Detailed Description

template<typename T>
class tpie::file< T >

Central file abstraction.

Definition at line 39 of file file.h.

Member Typedef Documentation

item_type

template<typename T >

typedef T tpie::file< T >::item_type

Type of items stored in the file.

Definition at line 42 of file file.h.

Constructor & Destructor Documentation

file()

template<typename T >

tpie::file< T >::file ( double  blockFactor = 1.0, file_accessor::file_accessor *  fileAccessor = NULL  )

inline

Construct a file object with the given block factor and file accessor.

Parameters

blockFactor	The relative size of a block compared to the default. To find the block factor corresponding to an absolute block size, use file_base::calculate_block_factor.
fileAccessor	The file accessor to use, if none is supplied a default will be used.

Definition at line 63 of file file.h.

                                                        :
        file_base(sizeof(T), blockFactor, fileAccessor) {};

Referenced by tpie::file< T >::memory_usage().

Member Function Documentation

block_items()

memory_size_type tpie::file_base_crtp< file_base >::block_items

inlineinherited

Get the number of items per block.

Definition at line 106 of file file_base_crtp.h.

                                         {
        return m_blockItems;
    }

block_memory_usage()

static memory_size_type tpie::file_base_crtp< file_base >::block_memory_usage ( double  blockFactor )

inlinestaticinherited

Amount of memory used by a single block given the block factor.

Definition at line 99 of file file_base_crtp.h.

                                                                          {
        return block_size(blockFactor);
    }

block_size() [1/2]

memory_size_type tpie::file_base_crtp< file_base >::block_size

inlineinherited

Get the size of a block in bytes.

Definition at line 113 of file file_base_crtp.h.

                                        {
        return m_blockSize;
    }

block_size() [2/2]

static memory_size_type tpie::file_base_crtp< file_base >::block_size ( double  blockFactor ) throw ( )

inlinestaticinherited

Calculate the block size in bytes used by a stream.

We have block_size(calculate_block_factor(b)) ~= b.

Parameters

blockFactor

Factor of the global block size to use.

Returns

Size in bytes.

Definition at line 79 of file file_base_crtp.h.

                                                                           {
        return static_cast<memory_size_type>(get_block_size() * blockFactor);
    }

calculate_block_factor()

static double tpie::file_base_crtp< file_base >::calculate_block_factor ( memory_size_type  blockSize ) throw ( )

inlinestaticinherited

Find the block factor that would result in the given block size measured in bytes.

We have calculate_block_factor(block_size(f)) ~= f.

Parameters

blockSize

The sought block size.

Returns

The block factor needed to achieve this block size.

Definition at line 92 of file file_base_crtp.h.

                                                                                     {
        return (double)blockSize / (double)block_size(1.0);
    }

file_size()

stream_size_type tpie::file_base_crtp< file_base >::file_size throw ( )

inlineinherited

Get the size of the file measured in items.

If there are streams of this file that have extended the stream length but have not yet flushed these writes, we might report an incorrect size.

Returns

The number of items in the file.

Definition at line 269 of file file_base_crtp.h.

                                                      {
        return m_size;
    }

is_open()

bool tpie::file_base_crtp< file_base >::is_open

inlineinherited

Check if file is open.

Definition at line 257 of file file_base_crtp.h.

                                {
        return m_open;
    }

is_readable()

bool tpie::file_base_crtp< file_base >::is_readable throw ( )

inlineinherited

Check if we can read from the file.

Returns

True if we can read from the file.

Definition at line 57 of file file_base_crtp.h.

                                     {
        return m_canRead;
    }

is_writable()

bool tpie::file_base_crtp< file_base >::is_writable throw ( )

inlineinherited

Check if we can write to the file.

Returns

True if we can write to the file.

Definition at line 66 of file file_base_crtp.h.

                                     {
        return m_canWrite;
    }

max_user_data_size()

memory_size_type tpie::file_base_crtp< file_base >::max_user_data_size

inlineinherited

Get maximum user data size.

Definition at line 184 of file file_base_crtp.h.

                                                {
        assert(m_open);
        return m_fileAccessor->max_user_data_size();
    }

memory_usage()

template<typename T >

static memory_size_type tpie::file< T >::memory_usage ( bool  includeDefaultFileAccessor = true )

inlinestatic

Calculate the memory usage of a file.

Definition at line 47 of file file.h.

                                                                                      {
        memory_size_type x = sizeof(file);
        if (includeDefaultFileAccessor)
            x += default_file_accessor::memory_usage();
        return x;
    }

References tpie::file< T >::file(), and tpie::file_accessor::stream_accessor_base< file_accessor_t >::memory_usage().

open() [1/3]

void tpie::file_base_crtp< file_base >::open ( const std::string &  path, access_type  accessType = access_read_write, memory_size_type  userDataSize = 0, cache_hint  cacheHint = access_sequential  )

inlineinherited

Open a file.

Parameters

path	The path of the file to open.
accessType	The mode of operation.
userDataSize	The size of the user data we want to store in the file.

Definition at line 208 of file file_base_crtp.h.

                                                             {
        self().close();
        self().open_inner(path, accessType, userDataSize, cacheHint);
    }

open() [2/3]

void tpie::file_base_crtp< file_base >::open ( memory_size_type  userDataSize = 0, cache_hint  cacheHint = access_sequential  )

inlineinherited

Open an anonymous temporary file.

The temporary file is deleted when this file is closed.

Definition at line 220 of file file_base_crtp.h.

                                                             {
        self().close();
        m_ownedTempFile.reset(tpie_new<temp_file>());
        m_tempFile=m_ownedTempFile.get();
        self().open_inner(m_tempFile->path(), access_read_write, userDataSize, cacheHint);
    }

open() [3/3]

void tpie::file_base_crtp< file_base >::open ( temp_file &  file, access_type  accessType = access_read_write, memory_size_type  userDataSize = 0, cache_hint  cacheHint = access_sequential  )

inlineinherited

Open a temporary file.

The temporary file is not deleted when this file is closed, so several tpie::file objects may use the same temporary file consecutively.

Definition at line 233 of file file_base_crtp.h.

                                                             {
        self().close();
        m_tempFile=&file;
        self().open_inner(m_tempFile->path(), accessType, userDataSize, cacheHint);
    }

path()

const std::string& tpie::file_base_crtp< file_base >::path throw ( )

inlineinherited

The path of the file opened or the empty string.

Returns

The path of the currently opened file.

Definition at line 195 of file file_base_crtp.h.

                                                  {
        assert(m_open);
        return m_fileAccessor->path();
    }

read_user_data() [1/2]

void tpie::file_base_crtp< file_base >::read_user_data ( TT &  data )

inlineinherited

Read the user data associated with the file.

Parameters

data	Where to store the user data.

Template Parameters

TT	The type of user data. sizeof(TT) must be less than or equal to the maximum user data size of the stream. TT must be trivially copyable.

Definition at line 126 of file file_base_crtp.h.

                                   {
        assert(m_open);
        if (sizeof(TT) != user_data_size()) throw io_exception("Wrong user data size");
        m_fileAccessor->read_user_data(reinterpret_cast<void*>(&data), sizeof(TT));
    }

read_user_data() [2/2]

memory_size_type tpie::file_base_crtp< file_base >::read_user_data ( void *  data, memory_size_type  count  )

inlineinherited

Read variable length user data associated with the file.

Parameters

data	The buffer in which to write data.
count	The size of the buffer.

Returns

Number of bytes of user data actually read.

Definition at line 139 of file file_base_crtp.h.

                                                                         {
        assert(m_open);
        return m_fileAccessor->read_user_data(data, count);
    }

truncate()

void tpie::file_base::truncate ( stream_size_type  s )

inlineinherited

Truncate file to given size.

May only be used when no streams are opened to this file.

Definition at line 181 of file file_base.h.

                                      {
        assert(m_open);
        if (!m_used.empty()) {
            throw io_exception("Tried to truncate a file with one or more open streams");
        }
        m_size = s;
        m_fileAccessor->truncate(s);
        if (m_tempFile)
            m_tempFile->update_recorded_size(m_fileAccessor->byte_size());
    }

user_data_size()

memory_size_type tpie::file_base_crtp< file_base >::user_data_size

inlineinherited

Get current user data size.

Definition at line 176 of file file_base_crtp.h.

                                            {
        assert(m_open);
        return m_fileAccessor->user_data_size();
    }

write_user_data() [1/2]

void tpie::file_base_crtp< file_base >::write_user_data ( const TT &  data )

inlineinherited

Write user data to the stream.

Parameters

data	The user data to store in the stream.

Template Parameters

TT	The type of user data. sizeof(TT) must be less than or equal to the maximum user data size of the stream. TT must be trivially copyable.

Definition at line 153 of file file_base_crtp.h.

                                          {
        assert(m_open);
        if (sizeof(TT) > max_user_data_size()) throw io_exception("Wrong user data size");
        m_fileAccessor->write_user_data(reinterpret_cast<const void*>(&data), sizeof(TT));
    }

write_user_data() [2/2]

void tpie::file_base_crtp< file_base >::write_user_data ( const void *  data, memory_size_type  count  )

inlineinherited

Write variable length user data associated with the file.

Throws a stream_exception if the size of the user data exceeds the maximum user data size of the stream.

Parameters

data	The buffer from which to read data.
count	The size of the user data.

Definition at line 168 of file file_base_crtp.h.

                                                                    {
        assert(m_open);
        m_fileAccessor->write_user_data(data, count);
    }

---

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

• file.h