Sayonara Player
Functions
Util::File Namespace Reference

FileUtils functions. More...

Functions

QString cleanFilename (const QString &filename)
 formatter for filepaths. Removes double separators and replaces them with os specific separators. More...
 
QByteArray getMD5Sum (const QString &filename)
 
void removeFilesInDirectory (const QString &dirName, const QStringList &filters)
 Remove all files from directory. More...
 
void removeFilesInDirectory (const QString &dirName)
 
void deleteFiles (const QStringList &files)
 Remove all given files (also directories can be specified) More...
 
QString getParentDirectory (const QString &path)
 get parent directory of a filepath More...
 
QString getFilenameOfPath (const QString &path)
 extract pure filename from a complete file path More...
 
void splitFilename (const QString &src, QString &dir, QString &filename)
 split filename into the dir and filename More...
 
std::pair< QString, QString > splitFilename (const QString &src)
 
QStringList splitDirectories (const QString &path)
 returns all parts of a directory path More...
 
QString getFileExtension (const QString &filename)
 get file extension More...
 
QStringList getParentDirectories (const QStringList &list)
 extract parent folder of a file list (see also get_parentDirectory(const QString& path) More...
 
QString getAbsoluteFilename (const QString &filename)
 get absolute filename of file More...
 
bool createDirectories (const QString &path)
 create all directories necessary to access path More...
 
bool createSymlink (const QString &source, const QString &target)
 create_symlink More...
 
QString getFilesizeString (Filesize filesize)
 convert filesize to string More...
 
bool isAbsolute (const QString &filename)
 Tell whether filename is absolute. More...
 
QList< QChar > invalidFilenameChars ()
 
bool writeFile (const QByteArray &raw_data, const QString &filename)
 Write raw data to file. More...
 
bool readFileIntoString (const QString &filename, QString &content)
 read a complete file into a string More...
 
bool readFileIntoByteArray (const QString &filename, QByteArray &content)
 read a complete file into a byte array More...
 
bool checkFile (const QString &filepath)
 Check, if file is valid. Web URLs are always valid. More...
 
QString getCommonDirectory (const QStringList &paths)
 get_commonDirectory More...
 
QString getCommonDirectory (QString dir1, QString dir2)
 get_commonDirectory More...
 
bool createDir (const QString &dirName)
 createDir More...
 
bool copyDir (const QString &srcDir, const QString &targetDirectory, QString &new_filename)
 copyDir More...
 
bool moveDir (const QString &srcDir, const QString &targetDirectory, QString &new_filename)
 moveDir More...
 
bool renameDir (const QString &srcDir, const QString &newName)
 renameDir More...
 
bool canCopyDir (const QString &srcDir, const QString &targetDirectory)
 can_copyDir More...
 
bool moveFile (const QString &file, const QString &dir, QString &newName)
 move_file More...
 
bool copyFile (const QString &file, const QString &dir, QString &newName)
 copy_file More...
 
bool moveFiles (const QStringList &files, const QString &dir, QStringList &newNames)
 move_files More...
 
bool renameFile (const QString &oldName, const QString &newName)
 rename_file More...
 
bool copyFiles (const QStringList &files, const QString &dir, QStringList &new_files)
 copy_files More...
 
bool isUrl (const QString &str)
 is_url More...
 
bool isWWW (const QString &str)
 is_www More...
 
bool isFile (const QString &filename)
 is_file More...
 
bool isDir (const QString &filename)
 isDir More...
 
bool isSoundFile (const QString &extension)
 is_soundfile More...
 
bool isPlaylistFile (const QString &extension)
 is_playlistfile More...
 
bool isImageFile (const QString &extension)
 is_imagefile More...
 
bool exists (const QString &filename)
 exists More...
 
bool isSamePath (const QString &filename1, const QString &filename2)
 Compares two filepaths by cleaning them. More...
 
bool isSubdir (const QString &dir, const QString &parentDir)
 Checks if dir is a subdir of parentDir. More...
 

Detailed Description

FileUtils functions.

Function Documentation

◆ canCopyDir()

bool Util::File::canCopyDir ( const QString &  srcDir,
const QString &  targetDirectory 
)

can_copyDir

Parameters
srcDir
targetDirectory
Returns

◆ checkFile()

bool Util::File::checkFile ( 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

◆ cleanFilename()

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

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

Parameters
filenameinput filename
Returns
nicely formatted filename

◆ copyDir()

bool Util::File::copyDir ( const QString &  srcDir,
const QString &  targetDirectory,
QString &  new_filename 
)

copyDir

Parameters
srcDir
targetDirectory
Returns

◆ copyFile()

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

copy_file

Parameters
file
dir
Returns

◆ copyFiles()

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

copy_files

Parameters
files
dir
Returns

◆ createDir()

bool Util::File::createDir ( const QString &  dirName)

createDir

Parameters
dirName
Returns

◆ createDirectories()

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

create all directories necessary to access path

Parameters
pathfull target path

◆ createSymlink()

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

create_symlink

Parameters
source
target
Returns

◆ deleteFiles()

void Util::File::deleteFiles ( 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

◆ getAbsoluteFilename()

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

get absolute filename of file

Parameters
filename
Returns

◆ getCommonDirectory() [1/2]

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

get_commonDirectory

Parameters
paths
Returns

◆ getCommonDirectory() [2/2]

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

get_commonDirectory

Parameters
dir1
dir2
Returns

◆ getFileExtension()

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

get file extension

Parameters
filenamefilename to get the extension for
Returns
extension string

◆ getFilenameOfPath()

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

extract pure filename from a complete file path

Parameters
pathcomplete file path
Returns
pure filename

◆ getFilesizeString()

QString Util::File::getFilesizeString ( Filesize  filesize)

convert filesize to string

Parameters
filesizein bytes
Returns
converted string

◆ getParentDirectories()

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

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

Parameters
listfile list
Returns
List of parent folders

◆ getParentDirectory()

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

get parent directory of a filepath

Parameters
pathFile- or directory path
Returns

◆ isAbsolute()

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

Tell whether filename is absolute.

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

◆ isDir()

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

isDir

Parameters
filename
Returns

◆ isFile()

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

is_file

Parameters
filename
Returns

◆ isImageFile()

bool Util::File::isImageFile ( const QString &  extension)

is_imagefile

Parameters
extension
Returns

◆ isPlaylistFile()

bool Util::File::isPlaylistFile ( const QString &  extension)

is_playlistfile

Parameters
extension
Returns

◆ isSamePath()

bool Util::File::isSamePath ( const QString &  filename1,
const QString &  filename2 
)

Compares two filepaths by cleaning them.

Parameters
filename1
filename2
Returns

◆ isSoundFile()

bool Util::File::isSoundFile ( const QString &  extension)

is_soundfile

Parameters
extension
Returns

◆ isSubdir()

bool Util::File::isSubdir ( const QString &  dir,
const QString &  parentDir 
)

Checks if dir is a subdir of parentDir.

Parameters
dirthe dir of interest
otherDirthe maybe-parentdir
Returns

◆ isUrl()

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

is_url

Parameters
str
Returns

◆ isWWW()

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

is_www

Parameters
str
Returns

◆ moveDir()

bool Util::File::moveDir ( const QString &  srcDir,
const QString &  targetDirectory,
QString &  new_filename 
)

moveDir

Parameters
srcDir
targetDirectory
Returns

◆ moveFile()

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

move_file

Parameters
file
dir
Returns

◆ moveFiles()

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

move_files

Parameters
files
dir
Returns

◆ readFileIntoByteArray()

bool Util::File::readFileIntoByteArray ( 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

◆ readFileIntoString()

bool Util::File::readFileIntoString ( 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

◆ removeFilesInDirectory()

void Util::File::removeFilesInDirectory ( const QString &  dirName,
const QStringList &  filters 
)

Remove all files from directory.

Parameters
dirNamedirectory name
filtersfile name filters

◆ renameDir()

bool Util::File::renameDir ( const QString &  srcDir,
const QString &  newName 
)

renameDir

Parameters
srcDir
newName
Returns

◆ renameFile()

bool Util::File::renameFile ( const QString &  oldName,
const QString &  newName 
)

rename_file

Parameters
oldName
newName
Returns

◆ splitDirectories()

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

returns all parts of a directory path

Parameters
path
Returns

◆ splitFilename()

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

split filename into the dir and filename

Parameters
src
path
filename

◆ writeFile()

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

Write raw data to file.

Parameters
raw_dataraw data
filenametarget_filename
Returns
true if successful, false else