Dummy implementation of CGUIFileSysWrap. More...

#include <GUIFileSysWrapDummy.h>

Inheritance diagram for CGUIFileSysWrapDummy:

Public Member Functions
	CGUIFileSysWrapDummy ()

	~CGUIFileSysWrapDummy ()

virtual eC_Bool	CheckIfDirectoryExists (const eC_String &kPath) const

virtual eC_Bool	CheckIfFileExists (const eC_String &kPath) const

virtual eC_Bool	CheckIfFileOrDirectoryExists (const eC_String &kPath) const

virtual eC_Bool	CpFile (eC_String kSource, eC_String kDest, eC_Bool bOverwrite=false, eC_Bool bCopyEvenIfIdentical=true)

virtual CGUIDirectory *	DirAlloc (const eC_String &kPath, const CGUIDirectory::StringList_t &kNameFilter, eC_UInt uiFilter=CGUIDirectory::ALL, CGUIDirectory::SortFlag_t eSort=CGUIDirectory::NAME, eC_Bool bCaseInsensitive=true) const

virtual CGUIDirectory *	DirAlloc (const eC_String &kPath="", const eC_String &kNameFilter="") const

virtual const eC_String &	GetDirSeparator () const

virtual const CGUIDirInfo::DirInfoPtrList_t &	GetDrives ()

virtual eC_String	GetExecutablePath ()

virtual eC_String	GetHomePath () const

virtual const eC_String &	GetRootPath () const

virtual eC_Bool	IsDrive (const eC_String &kDirStr) const

virtual eC_Bool	IsStrAbsolute (const eC_String &kStr) const

virtual eC_String	MakePlatformPath (const eC_String &kOrgPath) const

virtual eC_Bool	RemoveFile (const eC_String &kPath) const

virtual eC_Bool	SetCurrentPath (const eC_String &kPath)

Public Member Functions inherited from CGUIFileSysWrap
	CGUIFileSysWrap ()

virtual	~CGUIFileSysWrap ()
	Destructor, frees the drives list.

virtual eC_Bool	CheckIfDirectoryExists (const eC_String &kPath) const =0

virtual eC_Bool	CheckIfFileExists (const eC_String &kPath) const =0

virtual eC_Bool	CheckIfFileOrDirectoryExists (const eC_String &kPath) const =0

virtual eC_Bool	CpFile (eC_String kSource, eC_String kDest, eC_Bool bOverwrite=false, eC_Bool bCopyEvenIfIdentical=true)=0

virtual eC_Bool	CreateRelativePath (const eC_String &kFromPath, const eC_String &kToPath, eC_String &kResultPath) const

void	DeInit ()

virtual CGUIDirectory *	DirAlloc (const eC_String &kPath, const CGUIDirectory::StringList_t &kNameFilter, eC_UInt uiFilter=CGUIDirectory::ALL, CGUIDirectory::SortFlag_t eSort=CGUIDirectory::NAME, eC_Bool bCaseInsensitive=true) const =0

virtual CGUIDirectory *	DirAlloc (const eC_String &kPath="", const eC_String &kNameFilter="") const =0

eC_String	GetCurrentPath () const

virtual const eC_String &	GetDirSeparator () const =0

virtual const CGUIDirInfo::DirInfoPtrList_t &	GetDrives ()=0

virtual eC_String	GetExecutablePath ()=0

eC_String	GetFileBaseName (const eC_String &rkFileName) const
	Extracts the base name of a file from a name that includes a path. More...

virtual time_t	GetFileDateTime (const eC_String &kPath) const

eC_String	GetFileName (const eC_String &rkFileName) const
	Extracts the file name from a file name that includes a path. More...

virtual long	GetFileSize (const eC_String &kPath) const

eC_String	GetFileSuffix (const eC_String &rkFileName) const
	Extracts the extension of a file name. More...

virtual eC_String	GetHomePath () const =0

eC_String	GetPath (const eC_String &rkFileName) const
	Extracts the path from a file name that includes a path. More...

const eC_String &	GetPOSIXDirSeparator () const

virtual const eC_String &	GetRootPath () const =0

const eC_String &	GetWinDirSeparator () const

virtual eC_Bool	IsDrive (const eC_String &kDirStr) const =0

virtual eC_Bool	IsStrAbsolute (const eC_String &kStr) const =0

eC_Bool	MakeAbsolutePath (const eC_String &kRelPath, eC_String &kAbsPath) const

virtual eC_String	MakeDirectoryPath (const eC_String &kPath) const

virtual eC_Bool	MakeNormalizedPlatformPath (const eC_String &kOrgPath, eC_String &kResultPath) const

virtual eC_String	MakePlatformPath (const eC_String &kOrgPath) const =0

virtual eC_File *	OpenPlatformFile (const eC_String &kPath, eC_Flag uiMode=eC_File::FS_WRITEACCESS\|eC_File::FS_READACCESS) const

virtual eC_Bool	RemoveFile (const eC_String &kPath) const =0

void	SeparateString (const eC_String &kOrgStr, eC_String &kLeftStr, eC_String &kRightStr, const eC_String &kSeparator, eC_Bool bFromLeft) const

virtual eC_Bool	SetCurrentPath (const eC_String &kPath)=0

Additional Inherited Members
Static Public Member Functions inherited from CGUIFileSysWrap
static CGUIFileSysWrap &	GetInstance ()

Static Public Attributes inherited from CGUIFileSysWrap
static const eC_String	ms_DirSepPOSIX
	Directory seperator used for *NIX file system.

static const eC_String	ms_DirSepWin
	Directory separator used for windows file system.

Protected Attributes inherited from CGUIFileSysWrap
eC_String	m_kCurrentPath

CGUIDirInfo::DirInfoPtrList_t	m_kDrivesList

Detailed Description

Dummy implementation of CGUIFileSysWrap.

This class is used for systems that have no file system. Its methods return default values.

Constructor & Destructor Documentation

◆ CGUIFileSysWrapDummy()

CGUIFileSysWrapDummy::CGUIFileSysWrapDummy ( )

Constructor.

◆ ~CGUIFileSysWrapDummy()

CGUIFileSysWrapDummy::~CGUIFileSysWrapDummy ( )

inline

Destructor.

Member Function Documentation

◆ CheckIfDirectoryExists()

eC_Bool CGUIFileSysWrapDummy::CheckIfDirectoryExists ( const eC_String & kPath ) const

virtual

Checks if a directory at given path exists.

Parameters

kPath Path to directory for which the existence should be checked.

Returns: True If the directory specified via the path exists or False if its not a directory (for example file).

Implements CGUIFileSysWrap.

◆ CheckIfFileExists()

eC_Bool CGUIFileSysWrapDummy::CheckIfFileExists ( const eC_String & kPath ) const

virtual

Checks if a file at a given path exists.

Parameters

kPath Path to a file for which the existence should be checked.

Returns: True If the file specified via the path exists or False if it is not a file (for example a directory) or a symlink.

Implements CGUIFileSysWrap.

◆ CheckIfFileOrDirectoryExists()

eC_Bool CGUIFileSysWrapDummy::CheckIfFileOrDirectoryExists ( const eC_String & kPath ) const

virtual

Checks if a given path exists. The object specified might be a file or directory.

Parameters

kPath Path to a file or directory for which the existence should be checked.

Returns: True If the object specified via the path exists otherwise False.

Implements CGUIFileSysWrap.

◆ CpFile()

eC_Bool CGUIFileSysWrapDummy::CpFile	(	eC_String	kSource,
		eC_String	kDest,
		eC_Bool	bOverwrite = `false`,
		eC_Bool	bCopyEvenIfIdentical = `true`
	)

virtual

Dummy implementation of the copy file functionality.

Parameters

kSource	The source file name including path. If it is a relative path, the current working directory of the file system wrapper is used to complete the path.
kDest	The destination directory or file. If it is a relative path the current working directory of the file system wrapper is used to complete the path.
bOverwrite	Pass true to overwrite the destination file if it already exists.
bCopyEvenIfIdentical	True if we want to copy the files even if they already exist and are identical (modification date, modification time and size). False if we want to skip copying the files which already exists and have the same date,time of modification and size.

Returns: always False.

Implements CGUIFileSysWrap.

◆ DirAlloc() [1/2]

CGUIDirectory * CGUIFileSysWrapDummy::DirAlloc	(	const eC_String &	kPath,
		const CGUIDirectory::StringList_t &	kNameFilter,
		eC_UInt	uiFilter = `CGUIDirectory::ALL`,
		CGUIDirectory::SortFlag_t	eSort = `CGUIDirectory::NAME`,
		eC_Bool	bCaseInsensitive = `true`
	)		const

virtual

Returns a NULL pointer.

Parameters

kPath	The kPath for the directory that is passed as a parameter of the CGUIDirectory constructor.
kNameFilter	The name filters to filter the directory that is passed as a parameter of the CGUIDirectory constructor.
uiFilter	The filter attribute to filter the directory that is passed as a parameter of the CGUIDirectory constructor.
eSort	The sort kind to sort the directory that is passed as a parameter of the CGUIDirectory constructor.
bCaseInsensitive	The bool value to indicate whether sort the elements in the directory case-insensitive or not. This is also a parameter of the CGUIDirectory constructor.

Returns: NULL pointer.

Implements CGUIFileSysWrap.

◆ DirAlloc() [2/2]

CGUIDirectory * CGUIFileSysWrapDummy::DirAlloc	(	const eC_String &	kPath = `""`,
		const eC_String &	kNameFilter = `""`
	)		const

virtual

Return a NULL pointer.

Parameters

kPath	The directory path; directly passed to the CGUIDirectory constructor.
kNameFilter	The filter string; directly passed to the CGUIDirectory constructor.

Returns: NULL pointer.

Implements CGUIFileSysWrap.

◆ GetDirSeparator()

const eC_String & CGUIFileSysWrapDummy::GetDirSeparator ( ) const

virtual

Gets the directory separator.

Returns: Empty string as default value.

Implements CGUIFileSysWrap.

◆ GetDrives()

const CGUIDirInfo::DirInfoPtrList_t & CGUIFileSysWrapDummy::GetDrives ( )

virtual

Returns the saved list in the file system class that contains no items inside.

Returns: The saved list in the file system class that contains no items inside.

Implements CGUIFileSysWrap.

◆ GetExecutablePath()

eC_String CGUIFileSysWrapDummy::GetExecutablePath ( )

virtual

Returns the absolute path to the current executable

Returns: executable path

Implements CGUIFileSysWrap.

◆ GetHomePath()

eC_String CGUIFileSysWrapDummy::GetHomePath ( ) const

virtual

Get the current user's home path. It returns empty string.

Returns: Empty string as default value.

Implements CGUIFileSysWrap.

◆ GetRootPath()

const eC_String & CGUIFileSysWrapDummy::GetRootPath ( ) const

virtual

Gets the absolute path for the root directory. It returns empty string.

Returns: Empty string as default value.

Implements CGUIFileSysWrap.

◆ IsDrive()

eC_Bool CGUIFileSysWrapDummy::IsDrive ( const eC_String & kDirStr ) const

virtual

Return false per default.

Parameters

kDirStr The directory string to be checked.

Returns: False.

Implements CGUIFileSysWrap.

◆ IsStrAbsolute()

eC_Bool CGUIFileSysWrapDummy::IsStrAbsolute ( const eC_String & kStr ) const

virtual

Return false per default.

Parameters

kStr	The given path.

Returns: False.

Implements CGUIFileSysWrap.

◆ MakePlatformPath()

eC_String CGUIFileSysWrapDummy::MakePlatformPath ( const eC_String & kOrgPath ) const

virtual

Returns an empty string.

Parameters

kOrgPath The original path to be adapted.

Returns: The original path.

Implements CGUIFileSysWrap.

◆ RemoveFile()

eC_Bool CGUIFileSysWrapDummy::RemoveFile ( const eC_String & kPath ) const

virtual

Removes the file specified with the given absolute path name

Parameters

kPath Name of the file to be deleted

Returns: True if successful; otherwise False.

Implements CGUIFileSysWrap.

◆ SetCurrentPath()

eC_Bool CGUIFileSysWrapDummy::SetCurrentPath ( const eC_String & kPath )

virtual

Sets the application's current working directory to a specified path. It does nothing and just return true.

Parameters

kPath Ignored.

Returns: True.

Implements CGUIFileSysWrap.

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

GUIFileSysWrapDummy.h
GUIFileSysWrapDummy.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUIFileSysWrapDummy()

◆ ~CGUIFileSysWrapDummy()

Member Function Documentation

◆ CheckIfDirectoryExists()

◆ CheckIfFileExists()

◆ CheckIfFileOrDirectoryExists()

◆ CpFile()

◆ DirAlloc() [1/2]

◆ DirAlloc() [2/2]

◆ GetDirSeparator()

◆ GetDrives()

◆ GetExecutablePath()

◆ GetHomePath()

◆ GetRootPath()

◆ IsDrive()

◆ IsStrAbsolute()

◆ MakePlatformPath()

◆ RemoveFile()

◆ SetCurrentPath()