Sayonara Player
Functions
Util::File Namespace Reference

FileUtils functions. More...

Functions

QString clean_filename (const QString &filename)
 formatter for filepaths. Removes double separators and replaces them with os specific separators. More...
 
QString calc_file_extension (const QString &filename)
 calc_file_extension More...
 
QByteArray calc_md5_sum (const QString &filename)
 
void remove_files_in_directory (const QString &dir_name, const QStringList &filters)
 Remove all files from directory. More...
 
void remove_files_in_directory (const QString &dir_name)
 
void delete_files (const QStringList &files)
 Remove all given files (also directories can be specified) More...
 
QString get_parent_directory (const QString &path)
 get parent directory of a filepath More...
 
QString get_filename_of_path (const QString &path)
 extract pure filename from a complete file path More...
 
void split_filename (const QString &src, QString &dir, QString &filename)
 split filename into the dir and filename More...
 
QStringList split_directories (const QString &path)
 returns all parts of a directory path More...
 
QString get_file_extension (const QString &filename)
 get file extension More...
 
QStringList get_parent_directories (const QStringList &list)
 extract parent folder of a file list (see also get_parent_directory(const QString& path) More...
 
QString get_absolute_filename (const QString &filename)
 get absolute filename of file More...
 
bool create_directories (const QString &path)
 create all directories necessary to access path More...
 
bool create_symlink (const QString &source, const QString &target)
 create_symlink More...
 
QString calc_filesize_str (uint64_t filesize)
 convert filesize to string More...
 
bool is_absolute (const QString &filename)
 Tell whether filename is absolute. More...
 
bool write_file (const QByteArray &raw_data, const QString &filename)
 Write raw data to file. More...
 
bool read_file_into_str (const QString &filename, QString &content)
 read a complete file into a string More...
 
bool read_file_into_byte_arr (const QString &filename, QByteArray &content)
 read a complete file into a byte array More...
 
bool check_file (const QString &filepath)
 Check, if file is valid. Web URLs are always valid. More...
 
bool is_in_sayonara_dir (const QString &path)
 is_in_sayonara_dir More...
 
QString get_common_directory (const QStringList &paths)
 get_common_directory More...
 
QString get_common_directory (QString dir1, QString dir2)
 get_common_directory More...
 
bool create_dir (const QString &dir_name)
 create_dir More...
 
bool copy_dir (const QString &src_dir, const QString &target_dir)
 copy_dir More...
 
QString move_dir (const QString &src_dir, const QString &target_dir)
 move_dir More...
 
bool rename_dir (const QString &src_dir, const QString &new_name)
 rename_dir More...
 
bool can_copy_dir (const QString &src_dir, const QString &target_dir)
 can_copy_dir More...
 
bool move_file (const QString &file, const QString &dir)
 move_file More...
 
bool copy_file (const QString &file, const QString &dir)
 copy_file More...
 
bool move_files (const QStringList &files, const QString &dir)
 move_files More...
 
bool rename_file (const QString &old_name, const QString &new_name)
 rename_file More...
 
bool copy_files (const QStringList &files, const QString &dir)
 copy_files More...
 
bool is_url (const QString &str)
 is_url More...
 
bool is_www (const QString &str)
 is_www More...
 
bool is_file (const QString &filename)
 is_file More...
 
bool is_dir (const QString &filename)
 is_dir More...
 
bool is_soundfile (const QString &filename)
 is_soundfile More...
 
bool is_playlistfile (const QString &filename)
 is_playlistfile More...
 
bool is_imagefile (const QString &filename)
 is_imagefile More...
 
bool exists (const QString &filename)
 exists More...
 

Detailed Description

FileUtils functions.

Function Documentation

◆ calc_file_extension()

QString Util::File::calc_file_extension ( const QString &  filename)

calc_file_extension

Parameters
filename
Returns

◆ calc_filesize_str()

QString Util::File::calc_filesize_str ( uint64_t  filesize)

convert filesize to string

Parameters
filesizein bytes
Returns
converted string

◆ can_copy_dir()

bool Util::File::can_copy_dir ( const QString &  src_dir,
const QString &  target_dir 
)

can_copy_dir

Parameters
src_dir
target_dir
Returns

◆ check_file()

bool Util::File::check_file ( const QString &  filepath)

Check, if file is valid. Web URLs are always valid.

Parameters
filepathpath to file or resource
Returns
true, if file exists or if Web URL. false else

◆ clean_filename()

QString Util::File::clean_filename ( const QString &  filename)

formatter for filepaths. Removes double separators and replaces them with os specific separators.

Parameters
filenameinput filename
Returns
nicely formatted filename

◆ copy_dir()

bool Util::File::copy_dir ( const QString &  src_dir,
const QString &  target_dir 
)

copy_dir

Parameters
src_dir
target_dir
Returns

◆ copy_file()

bool Util::File::copy_file ( const QString &  file,
const QString &  dir 
)

copy_file

Parameters
file
dir
Returns

◆ copy_files()

bool Util::File::copy_files ( const QStringList &  files,
const QString &  dir 
)

copy_files

Parameters
files
dir
Returns

◆ create_dir()

bool Util::File::create_dir ( const QString &  dir_name)

create_dir

Parameters
dir_name
Returns

◆ create_directories()

bool Util::File::create_directories ( const QString &  path)

create all directories necessary to access path

Parameters
pathfull target path

◆ create_symlink()

bool Util::File::create_symlink ( const QString &  source,
const QString &  target 
)

create_symlink

Parameters
source
target
Returns

◆ delete_files()

void Util::File::delete_files ( const QStringList &  files)

Remove all given files (also directories can be specified)

Parameters
fileslist of files

◆ exists()

bool Util::File::exists ( const QString &  filename)

exists

Parameters
filename
Returns

◆ get_absolute_filename()

QString Util::File::get_absolute_filename ( const QString &  filename)

get absolute filename of file

Parameters
filename
Returns

◆ get_common_directory() [1/2]

QString Util::File::get_common_directory ( const QStringList &  paths)

get_common_directory

Parameters
paths
Returns

◆ get_common_directory() [2/2]

QString Util::File::get_common_directory ( QString  dir1,
QString  dir2 
)

get_common_directory

Parameters
dir1
dir2
Returns

◆ get_file_extension()

QString Util::File::get_file_extension ( const QString &  filename)

get file extension

Parameters
filenamefilename to get the extension for
Returns
extension string

◆ get_filename_of_path()

QString Util::File::get_filename_of_path ( const QString &  path)

extract pure filename from a complete file path

Parameters
pathcomplete file path
Returns
pure filename

◆ get_parent_directories()

QStringList Util::File::get_parent_directories ( const QStringList &  list)

extract parent folder of a file list (see also get_parent_directory(const QString& path)

Parameters
listfile list
Returns
List of parent folders

◆ get_parent_directory()

QString Util::File::get_parent_directory ( const QString &  path)

get parent directory of a filepath

Parameters
pathFile- or directory path
Returns

◆ is_absolute()

bool Util::File::is_absolute ( const QString &  filename)

Tell whether filename is absolute.

Parameters
filenamethe filename to check
Returns
true if filename is absolute, false else

◆ is_dir()

bool Util::File::is_dir ( const QString &  filename)

is_dir

Parameters
filename
Returns

◆ is_file()

bool Util::File::is_file ( const QString &  filename)

is_file

Parameters
filename
Returns

◆ is_imagefile()

bool Util::File::is_imagefile ( const QString &  filename)

is_imagefile

Parameters
filename
Returns

◆ is_in_sayonara_dir()

bool Util::File::is_in_sayonara_dir ( const QString &  path)

is_in_sayonara_dir

Parameters
path
Returns

◆ is_playlistfile()

bool Util::File::is_playlistfile ( const QString &  filename)

is_playlistfile

Parameters
filename
Returns

◆ is_soundfile()

bool Util::File::is_soundfile ( const QString &  filename)

is_soundfile

Parameters
filename
Returns

◆ is_url()

bool Util::File::is_url ( const QString &  str)

is_url

Parameters
str
Returns

◆ is_www()

bool Util::File::is_www ( const QString &  str)

is_www

Parameters
str
Returns

◆ move_dir()

QString Util::File::move_dir ( const QString &  src_dir,
const QString &  target_dir 
)

move_dir

Parameters
src_dir
target_dir
Returns

◆ move_file()

bool Util::File::move_file ( const QString &  file,
const QString &  dir 
)

move_file

Parameters
file
dir
Returns

◆ move_files()

bool Util::File::move_files ( const QStringList &  files,
const QString &  dir 
)

move_files

Parameters
files
dir
Returns

◆ read_file_into_byte_arr()

bool Util::File::read_file_into_byte_arr ( const QString &  filename,
QByteArray &  content 
)

read a complete file into a byte array

Parameters
filenamefilename
contenttarget reference to content
Returns
true if file could be read, false else

◆ read_file_into_str()

bool Util::File::read_file_into_str ( const QString &  filename,
QString &  content 
)

read a complete file into a string

Parameters
filenamefilename
contenttarget reference to content
Returns
true if file could be read, false else

◆ remove_files_in_directory()

void Util::File::remove_files_in_directory ( const QString &  dir_name,
const QStringList &  filters 
)

Remove all files from directory.

Parameters
dir_namedirectory name
filtersfile name filters

◆ rename_dir()

bool Util::File::rename_dir ( const QString &  src_dir,
const QString &  new_name 
)

rename_dir

Parameters
src_dir
new_name
Returns

◆ rename_file()

bool Util::File::rename_file ( const QString &  old_name,
const QString &  new_name 
)

rename_file

Parameters
old_name
new_name
Returns

◆ split_directories()

QStringList Util::File::split_directories ( const QString &  path)

returns all parts of a directory path

Parameters
path
Returns

◆ split_filename()

void Util::File::split_filename ( const QString &  src,
QString &  dir,
QString &  filename 
)

split filename into the dir and filename

Parameters
src
path
filename

◆ write_file()

bool Util::File::write_file ( const QByteArray &  raw_data,
const QString &  filename 
)

Write raw data to file.

Parameters
raw_dataraw data
filenametarget_filename
Returns
true if successful, false else