utils.h File Reference

Detailed Description

Various useful utility functions.

Definition in file utils.h.

#include <stdexcept>
#include <iostream>
#include <sstream>
#include <hn/osdep.h>
#include <hn/endian.h>
#include <hn/gettickcount.h>
#include <sys/stat.h>
#include <boost/static_assert.hpp>
#include <boost/scoped_array.hpp>
#include <boost/shared_array.hpp>
#include <boost/filesystem/path.hpp>

Include dependency graph for utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


Namespaces
namespace	Utils
Specializations for reading various datas
template<class T>
T	getVal (std::istream &i)
	Primary template is not implemented, and causes compile-time error if instanciated.
template<class T>
T	getVal (std::istream &i, uint16_t len)
Writing function template specializations.
template<>
void	putVal (std::ostream &o, uint8_t val)
template<>
void	putVal (std::ostream &o, uint16_t val)
template<>
void	putVal (std::ostream &o, uint32_t val)
template<>
void	putVal (std::ostream &o, uint64_t val)
template<>
void	putVal (std::ostream &o, float val)
template<>
void	putVal (std::ostream &o, const std::string &str)
template<>
void	putVal (std::ostream &o, std::string str)
void	putVal (std::ostream &o, const std::string &str, uint16_t len)
void	putVal (std::ostream &o, const char *const str, uint16_t len)
void	putVal (std::ostream &o, const uint8_t *const str, uint16_t len)
void	putVal (std::ostream &o, const boost::shared_array< char > &str, uint16_t len)
Functions
std::string	decode (const std::string &data)
std::string	decode (const std::string &data, uint32_t length)
std::string	decode (boost::shared_array< char > data, uint32_t len)
std::string	encode (const std::string &data)
std::string	encode (const std::string &data, uint32_t length)
std::string	encode (boost::shared_array< char > data, uint32_t len)
void	copyString (const char src, char &dest)
	Copy string from source to destination, overwriting destination memory.
uint64_t	getFileSize (const boost::filesystem::path &loc)
	Retrieve the size of a file.
uint32_t	getModDate (const boost::filesystem::path &loc)
	Retrieve the last modification date of a file.
template<class T>
void	putVal (std::ostream &o, T val)
	Write.
template<class T>
std::ostream &	hexDump (std::ostream &o, T val)
	Dumps the hexadecimal representation of a value to stream.
template<typename T>
std::string	hexDump (T val)
	Creates hexadecimal dump of value into a string.
template<typename T>
std::string	hexDump (T *val)
	Specalization - for dumping pointer types.
std::string	bytesToString (uint64_t bytes)
	Convert bytes to string representation.

Function Documentation

std::string bytesToString ( uint64_t bytes ) [inline]

Convert bytes to string representation.

Parameters:

bytes

Amount of bytes to check

Returns:: Human-readable string, e.g. "4.56 GB"

Definition at line 392 of file utils.h.

Referenced by SchedBase::handleEvents(), PartData::printCompleted(), and FilesList::~FilesList().

void copyString	(	const char *	src,
		char *&	dest
	)	`[inline]`

Copy string from source to destination, overwriting destination memory.

This function assumes source string is null-terminated, and copies until the terminating zero (including it). The destination pointer is passed by reference and modified as neccesery during memory reallocations to point to newly allocated memory region.

Parameters:

	src	Source, null-terminated string
	dest	Destination

Definition at line 90 of file utils.h.

Referenced by AudioMetaData::setAlbum(), AudioMetaData::setArtist(), ImageMetaData::setComment(), ArchiveMetaData::setComment(), AudioMetaData::setComment(), AudioMetaData::setComposer(), AudioMetaData::setCopyright(), AudioMetaData::setEncoded(), AudioMetaData::setGenre(), AudioMetaData::setOrigArtist(), AudioMetaData::setTitle(), and AudioMetaData::setUrl().

std::string decode	(	boost::shared_array< char >	data,
		uint32_t	len
	)	`[inline]`

Definition at line 67 of file utils.h.

References Utils::decode().