filesystem_helper.h File Reference

Go to the source code of this file.

Data Structures
class	_IsTypeByte< TVal >
class	_stream_reader_formatter_translator< isBigEndian >
class	_stream_writer_formatter_translator< isBigEndian >
class	file_chain
class	file_chain_readonly
class	file_path_canonical
class	file_path_display
class	fileRestorePositionScope
class	reader_bigmem
class	reader_bigmem_mirror
class	reader_limited
class	reader_membuffer_base
class	reader_membuffer_mirror
class	reader_membuffer_simple
class	stream_reader_chunk
class	stream_reader_dummy
class	stream_reader_formatter< isBigEndian >
class	stream_reader_formatter_simple< BE >
class	stream_reader_formatter_simple_ref< BE >
class	stream_reader_limited_ref
class	stream_reader_memblock_ref
class	stream_writer_buffer_append_ref_t< t_storage >
class	stream_writer_buffer_simple
class	stream_writer_chunk
class	stream_writer_chunk_dwordheader
class	stream_writer_formatter< isBigEndian >
class	stream_writer_formatter_simple< BE >

Functions
	__DECLARE_INT_OVERLOADS (char)
	__DECLARE_INT_OVERLOADS (signed char)
	__DECLARE_INT_OVERLOADS (unsigned char)
	__DECLARE_INT_OVERLOADS (signed long long)
	__DECLARE_INT_OVERLOADS (unsigned long long)
	__DECLARE_INT_OVERLOADS (wchar_t)
	FB2K_STREAM_READER_OVERLOAD (GUID)
	FB2K_STREAM_READER_OVERLOAD (pfc::string)
	FB2K_STREAM_READER_OVERLOAD (pfc::string_base)
	FB2K_STREAM_READER_OVERLOAD (float)
	FB2K_STREAM_READER_OVERLOAD (double)
	FB2K_STREAM_READER_OVERLOAD (bool)
	FB2K_STREAM_WRITER_OVERLOAD (GUID)
	FB2K_STREAM_WRITER_OVERLOAD (pfc::string)
	FB2K_STREAM_WRITER_OVERLOAD (pfc::string_base)
	FB2K_STREAM_WRITER_OVERLOAD (float)
	FB2K_STREAM_WRITER_OVERLOAD (double)
	FB2K_STREAM_WRITER_OVERLOAD (bool)
bool	fb2kFileSelfTest (file::ptr f, abort_callback &aborter)
template<bool isBigEndian, typename TVal , size_t Count>
stream_writer_formatter< isBigEndian > &	operator<< (stream_writer_formatter< isBigEndian > &p_stream, TVal const (&p_array)[Count])
template<bool isBigEndian, typename TVal , size_t Count>
stream_reader_formatter< isBigEndian > &	operator>> (stream_reader_formatter< isBigEndian > &p_stream, TVal(&p_array)[Count])

---

Data Structure Documentation

class _IsTypeByte

template<typename TVal>
class _IsTypeByte< TVal >

Definition at line 494 of file filesystem_helper.h.

Data Fields
	__unnamed__

Function Documentation

__DECLARE_INT_OVERLOADS

(

char

)

__DECLARE_INT_OVERLOADS

(

signed

char

)

__DECLARE_INT_OVERLOADS

(

unsigned

char

)

__DECLARE_INT_OVERLOADS

(

signed long

long

)

__DECLARE_INT_OVERLOADS

(

unsigned long

long

)

__DECLARE_INT_OVERLOADS

(

wchar_t

)

FB2K_STREAM_READER_OVERLOAD

(

GUID

)

Definition at line 523 of file filesystem_helper.h.

                                  {
    return stream >> value.Data1 >> value.Data2 >> value.Data3 >> value.Data4;
}

FB2K_STREAM_READER_OVERLOAD

(

pfc::string

)

Definition at line 531 of file filesystem_helper.h.

                                       {
    t_uint32 len; stream >> len;
    value = stream.m_stream.read_string_ex(len,stream.m_abort);
    return stream;
}

FB2K_STREAM_READER_OVERLOAD

(

pfc::string_base

)

Definition at line 543 of file filesystem_helper.h.

                                            {
    stream.m_stream.read_string(value, stream.m_abort);
    return stream;
}

FB2K_STREAM_READER_OVERLOAD

(

float

)

Definition at line 563 of file filesystem_helper.h.

                                   {
    union { float f; t_uint32 i;} u;
    stream >> u.i; value = u.f;
    return stream;
}

FB2K_STREAM_READER_OVERLOAD

(

double

)

Definition at line 576 of file filesystem_helper.h.

                                    {
    union { double f; t_uint64 i;} u;
    stream >> u.i; value = u.f;
    return stream;
}

FB2K_STREAM_READER_OVERLOAD

(

bool

)

Definition at line 586 of file filesystem_helper.h.

                                  {
    t_uint8 temp; stream >> temp; value = temp != 0;
    return stream;
}

FB2K_STREAM_WRITER_OVERLOAD

(

GUID

)

Definition at line 527 of file filesystem_helper.h.

                                  {
    return stream << value.Data1 << value.Data2 << value.Data3 << value.Data4;
}

FB2K_STREAM_WRITER_OVERLOAD

(

pfc::string

)

Definition at line 537 of file filesystem_helper.h.

                                       {
    stream << pfc::downcast_guarded<t_uint32>(value.length());
    stream.write_raw(value.ptr(),value.length());
    return stream;
}

FB2K_STREAM_WRITER_OVERLOAD

(

pfc::string_base

)

Definition at line 547 of file filesystem_helper.h.

                                            {
    const char * val = value.get_ptr();
    const t_size len = strlen(val);
    stream << pfc::downcast_guarded<t_uint32>(len);
    stream.write_raw(val,len);
    return stream;
}

FB2K_STREAM_WRITER_OVERLOAD

(

float

)

Definition at line 556 of file filesystem_helper.h.

                                   {
    union {
        float f; t_uint32 i;
    } u; u.f = value;
    return stream << u.i;
}

FB2K_STREAM_WRITER_OVERLOAD

(

double

)

Definition at line 569 of file filesystem_helper.h.

                                    {
    union {
        double f; t_uint64 i;
    } u; u.f = value;
    return stream << u.i;
}

FB2K_STREAM_WRITER_OVERLOAD

(

bool

)

Definition at line 582 of file filesystem_helper.h.

                                  {
    t_uint8 temp = value ? 1 : 0;
    return stream << temp;
}

bool fb2kFileSelfTest	(	file::ptr	f,
		abort_callback &	aborter
	)

Debug self-test function for testing a file object implementation, performs various behavior validity checks, random access etc. Output goes to fb2k console. Returns true on success, false on failure (buggy file object implementation).

Definition at line 139 of file filesystem_helper.cpp.

                                                           {
    try {
        pfc::array_t<uint8_t> fileContent;
        f->reopen(aborter);
        f->read_till_eof(fileContent, aborter);

        {
            t_filesize sizeClaimed = f->get_size(aborter);
            if (sizeClaimed == filesize_invalid) {
                FB2K_console_formatter() << "File sanity: file reports unknown size, actual size read is " << fileContent.get_size();
            }
            else {
                if (sizeClaimed != fileContent.get_size()) {
                    FB2K_console_formatter() << "File sanity: file reports size of " << sizeClaimed << ", actual size read is " << fileContent.get_size();
                    throw std::runtime_error("File size mismatch");
                }
                else {
                    FB2K_console_formatter() << "File sanity: file size check OK: " << sizeClaimed;
                }
            }
        }

        {
            FB2K_console_formatter() << "File sanity: testing N-first-bytes reads...";
            const size_t sizeUpTo = pfc::min_t<size_t>(fileContent.get_size(), 1024 * 1024);
            pfc::array_staticsize_t<uint8_t> buf1;
            buf1.set_size_discard(sizeUpTo);

            for (size_t w = 1; w <= sizeUpTo; w <<= 1) {
                f->reopen(aborter);
                size_t did = f->read(buf1.get_ptr(), w, aborter);
                if (did != w) {
                    FB2K_console_formatter() << "File sanity: premature EOF reading first " << w << " bytes, got " << did;
                    throw std::runtime_error("Premature EOF");
                }
                if (memcmp(fileContent.get_ptr(), buf1.get_ptr(), did) != 0) {
                    FB2K_console_formatter() << "File sanity: file content mismatch reading first " << w << " bytes";
                    throw std::runtime_error("File content mismatch");
                }
            }
        }
        if (f->can_seek()) {
            FB2K_console_formatter() << "File sanity: testing random access...";

            {
                size_t sizeUpTo = pfc::min_t<size_t>(fileContent.get_size(), 1024 * 1024);
                for (size_t w = 1; w < sizeUpTo; w <<= 1) {
                    fileSanitySeek(f, fileContent, w, aborter);
                }
                fileSanitySeek(f, fileContent, fileContent.get_size(), aborter);
                for (size_t w = 1; w < sizeUpTo; w <<= 1) {
                    fileSanitySeek(f, fileContent, fileContent.get_size() - w, aborter);
                }
                fileSanitySeek(f, fileContent, fileContent.get_size() / 2, aborter);
            }
        }
        FB2K_console_formatter() << "File sanity test: all OK";
        return true;
    }
    catch (std::exception const & e) {
        FB2K_console_formatter() << "File sanity test failure: " << e.what();
        return false;
    }
}

template<bool isBigEndian, typename TVal , size_t Count>

stream_writer_formatter<isBigEndian>& operator<<	(	stream_writer_formatter< isBigEndian > &	p_stream,
		TVal const (&)	p_array[Count]
	)

Definition at line 508 of file filesystem_helper.h.

                                                                                                                                                                                       {
    if (_IsTypeByte<TVal>::value) {
        p_stream.write_raw(p_array,Count);
    } else {
        for(t_size walk = 0; walk < Count; ++walk) p_stream << p_array[walk];
    }
    return p_stream;
}

template<bool isBigEndian, typename TVal , size_t Count>

stream_reader_formatter<isBigEndian>& operator>>	(	stream_reader_formatter< isBigEndian > &	p_stream,
		TVal(&)	p_array[Count]
	)

Definition at line 499 of file filesystem_helper.h.

                                                                                                                                                                                 {
    if (_IsTypeByte<TVal>::value) {
        p_stream.read_raw(p_array,Count);
    } else {
        for(t_size walk = 0; walk < Count; ++walk) p_stream >> p_array[walk];
    }
    return p_stream;
}