UsbFat: PrintFile Class Reference

#include <ArduinoFiles.h>

Inheritance diagram for PrintFile:

Collaboration diagram for PrintFile:

Public Member Functions
int	available ()

void	clearError ()

void	clearWriteError ()

bool	close ()

bool	contiguousRange (uint32_t bgnBlock, uint32_t endBlock)

bool	createContiguous (FatFile dirFile, const char path, uint32_t size)

uint32_t	curCluster () const

uint32_t	curPosition () const

bool	dirEntry (dir_t *dir)

uint16_t	dirIndex ()

uint32_t	dirSize ()

void	dmpFile (print_t *pr, uint32_t pos, size_t n)

bool	exists (const char *path)

int16_t	fgets (char str, int16_t num, char delim=0)

uint8_t	fileAttr () const

uint32_t	fileSize () const

uint32_t	firstCluster () const

void	flush ()

uint8_t	getError ()

bool	getName (char *name, size_t size)

void	getpos (FatPos_t *pos)

bool	getSFN (char *name)

bool	getWriteError ()

bool	isDir () const

bool	isFile () const

bool	isHidden () const

bool	isLFN () const

bool	isOpen () const

bool	isReadOnly () const

bool	isRoot () const

bool	isRoot32 () const

bool	isRootFixed () const

bool	isSubDir () const

bool	isSystem () const

void	ls (uint8_t flags=0)

void	ls (print_t *pr, uint8_t flags=0, uint8_t indent=0)

bool	mkdir (FatFile dir, const char path, bool pFlag=true)

bool	open (FatFileSystem fs, const char path, uint8_t oflag)

bool	open (FatFile *dirFile, uint16_t index, uint8_t oflag)

bool	open (FatFile dirFile, const char path, uint8_t oflag)

bool	open (const char *path, uint8_t oflag=O_READ)

bool	openNext (FatFile *dirFile, uint8_t oflag=O_READ)

bool	openRoot (FatVolume *vol)

int	peek ()

bool	printCreateDateTime (print_t *pr)

int	printField (float value, char term, uint8_t prec=2)

int	printField (int16_t value, char term)

int	printField (uint16_t value, char term)

int	printField (int32_t value, char term)

int	printField (uint32_t value, char term)

	PrintFile (const char *path, uint8_t oflag)

size_t	printFileSize (print_t *pr)

bool	printModifyDateTime (print_t *pr)

size_t	printName ()

size_t	printName (print_t *pr)

size_t	printSFN (print_t *pr)

int	read ()

int	read (void *buf, size_t nbyte)

int8_t	readDir (dir_t *dir)

bool	remove ()

bool	rename (FatFile dirFile, const char newPath)

void	rewind ()

bool	rmdir ()

bool	rmRfStar ()

bool	seekCur (int32_t offset)

bool	seekEnd (int32_t offset=0)

bool	seekSet (uint32_t pos)

void	setpos (FatPos_t *pos)

bool	sync ()

bool	timestamp (FatFile *file)

bool	timestamp (uint8_t flags, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)

bool	truncate (uint32_t length)

FatVolume *	volume () const

size_t	write (uint8_t b)

size_t	write (const uint8_t *buf, size_t size)

int	write (const char *str)

int	write (const void *buf, size_t nbyte)

Static Public Member Functions
static FatFile *	cwd ()

static void	dateTimeCallback (void(dateTime)(uint16_t date, uint16_t *time))

static void	dateTimeCallbackCancel ()

static uint8_t	dirName (const dir_t dir, char name)

static bool	legal83Char (uint8_t c)

static void	printFatDate (uint16_t fatDate)

static void	printFatDate (print_t *pr, uint16_t fatDate)

static void	printFatTime (uint16_t fatTime)

static void	printFatTime (print_t *pr, uint16_t fatTime)

static bool	remove (FatFile dirFile, const char path)

static bool	setCwd (FatFile *dir)

Detailed Description

FatFile with Print.

Constructor & Destructor Documentation

PrintFile::PrintFile	(	const char *	path,
		uint8_t	oflag
	)

inline

Create a file object and open it in the current working directory.

Parameters

[in]	path	A path with a valid 8.3 DOS name for a file to be opened.
[in]	oflag	Values for oflag are constructed by a bitwise-inclusive OR of open flags. see FatFile::open(FatFile, const char, uint8_t).

Member Function Documentation

int PrintFile::available ( )

inline

Returns: number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available.

void FatFile::clearError ( )

inlineinherited

Clear all error bits.

void FatFile::clearWriteError ( )

inlineinherited

Set writeError to zero

bool FatFile::close ( )

inherited

Close a file and force cached data and directory information to be written to the storage device.

Returns: The value true is returned for success and the value false is returned for failure.

bool FatFile::contiguousRange	(	uint32_t *	bgnBlock,
		uint32_t *	endBlock
	)

inherited

Check for contiguous file and return its raw block range.

Parameters

[out]	bgnBlock	the first block address for the file.
[out]	endBlock	the last block address for the file.

Returns: The value true is returned for success and the value false is returned for failure.

bool FatFile::createContiguous	(	FatFile *	dirFile,
		const char *	path,
		uint32_t	size
	)

inherited

Create and open a new contiguous file of a specified size.

Note: This function only supports short DOS 8.3 names. See open() for more information.

Parameters

[in]	dirFile	The directory where the file will be created.
[in]	path	A path with a valid DOS 8.3 file name.
[in]	size	The desired file size.

Returns: The value true is returned for success and the value false, is returned for failure.

uint32_t FatFile::curCluster ( ) const

inlineinherited

Returns: The current cluster number for a file or directory.

uint32_t FatFile::curPosition ( ) const

inlineinherited

Returns: The current position for a file or directory.

static FatFile* FatFile::cwd ( )

inlinestaticinherited

Returns: Current working directory

static void FatFile::dateTimeCallback ( void(*)(uint16_t *date, uint16_t *time) dateTime )

inlinestaticinherited

Set the date/time callback function

Parameters

[in] dateTime The user's call back function. The callback function is of the form:

void dateTime(uint16_t* date, uint16_t* time) {
  uint16_t year;
  uint8_t month, day, hour, minute, second;
  // User gets date and time from GPS or real-time clock here
  // return date using FAT_DATE macro to format fields
  *date = FAT_DATE(year, month, day);
  // return time using FAT_TIME macro to format fields
  *time = FAT_TIME(hour, minute, second);
}

Sets the function that is called when a file is created or when a file's directory entry is modified by sync(). All timestamps, access, creation, and modify, are set when a file is created. sync() maintains the last access date and last modify date/time.

See the timestamp() function.

static void FatFile::dateTimeCallbackCancel ( )

inlinestaticinherited

Cancel the date/time callback function.

bool FatFile::dirEntry ( dir_t * dir )

inherited

Return a file's directory entry.

Parameters

[out] dir Location for return of the file's directory entry.

Returns: The value true is returned for success and the value false is returned for failure.

uint16_t FatFile::dirIndex ( )

inlineinherited

Returns: The index of this file in it's directory.

uint8_t FatFile::dirName	(	const dir_t *	dir,
		char *	name
	)

staticinherited

Format the name field of dir into the 13 byte array name in standard 8.3 short name format.

Parameters

[in]	dir	The directory structure containing the name.
[out]	name	A 13 byte char array for the formatted name.

Returns: length of the name.

uint32_t FatFile::dirSize ( )

inherited

Returns: The number of bytes allocated to a directory or zero if an error occurs.

void FatFile::dmpFile	(	print_t *	pr,
		uint32_t	pos,
		size_t	n
	)

inherited

Dump file in Hex

Parameters

[in]	pr	Print stream for list.
[in]	pos	Start position in file.
[in]	n	number of locations to dump.

bool FatFile::exists ( const char * path )

inlineinherited

Test for the existence of a file in a directory

Parameters

[in] path Path of the file to be tested for.

The calling instance must be an open directory file.

dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.

Returns: true if the file exists else false.

int16_t FatFile::fgets	(	char *	str,
		int16_t	num,
		char *	delim = `0`
	)

inherited

Get a string from a file.

fgets() reads bytes from a file into the array pointed to by str, until num - 1 bytes are read, or a delimiter is read and transferred to str, or end-of-file is encountered. The string is then terminated with a null byte.

fgets() deletes CR, '\r', from the string. This insures only a '\n' terminates the string for Windows text files which use CRLF for newline.

Parameters

[out]	str	Pointer to the array where the string is stored.
[in]	num	Maximum number of characters to be read (including the final null byte). Usually the length of the array str is used.
[in]	delim	Optional set of delimiters. The default is "\n".

Returns: For success fgets() returns the length of the string in str. If no data is read, fgets() returns zero for EOF or -1 if an error occurred.

uint8_t FatFile::fileAttr ( ) const

inlineinherited

Type of file. You should use isFile() or isDir() instead of fileType() if possible.

Returns: The file or directory type.

uint32_t FatFile::fileSize ( ) const

inlineinherited

Returns: The total number of bytes in a file.

uint32_t FatFile::firstCluster ( ) const

inlineinherited

Returns: The first cluster number for a file or directory.

void PrintFile::flush ( )

inline

Ensure that any bytes written to the file are saved to the SD card.

uint8_t FatFile::getError ( )

inlineinherited

Returns: All error bits.

bool FatFile::getName	(	char *	name,
		size_t	size
	)

inherited

Get a file's name followed by a zero byte.

Parameters

[out]	name	An array of characters for the file's name.
[in]	size	The size of the array in bytes. The array must be at least 13 bytes long. The file's name will be truncated if the file's name is too long.

Returns: The value true, is returned for success and the value false, is returned for failure.

void FatFile::getpos ( FatPos_t * pos )

inherited

get position for streams

Parameters

[out] pos struct to receive position

bool FatFile::getSFN ( char * name )

inherited

Get a file's Short File Name followed by a zero byte.

Parameters

[out] name An array of characters for the file's name. The array must be at least 13 bytes long.

Returns: The value true, is returned for success and the value false, is returned for failure.

bool FatFile::getWriteError ( )

inlineinherited

Returns: value of writeError

bool FatFile::isDir ( ) const

inlineinherited

Returns: True if this is a directory else false.

bool FatFile::isFile ( ) const

inlineinherited

Returns: True if this is a normal file else false.

bool FatFile::isHidden ( ) const

inlineinherited

Returns: True if this is a hidden file else false.

bool FatFile::isLFN ( ) const

inlineinherited

Returns: true if this file has a Long File Name.

bool FatFile::isOpen ( ) const

inlineinherited

Returns: True if this is an open file/directory else false.

bool FatFile::isReadOnly ( ) const

inlineinherited

Returns: True if file is read-only

bool FatFile::isRoot ( ) const

inlineinherited

Returns: True if this is the root directory.

bool FatFile::isRoot32 ( ) const

inlineinherited

Returns: True if this is the FAT32 root directory.

bool FatFile::isRootFixed ( ) const

inlineinherited

Returns: True if this is the FAT12 of FAT16 root directory.

bool FatFile::isSubDir ( ) const

inlineinherited

Returns: True if this is a subdirectory else false.

bool FatFile::isSystem ( ) const

inlineinherited

Returns: True if this is a system file else false.

static bool FatFile::legal83Char ( uint8_t c )

inlinestaticinherited

Check for a legal 8.3 character.

Parameters

[in] c Character to be checked.

Returns: true for a legal 8.3 character else false.

void FatFile::ls ( uint8_t flags = 0 )

inlineinherited

List directory contents.

Parameters

[in] flags The inclusive OR of

LS_DATE - Print file modification date

LS_SIZE - Print file size.

LS_R - Recursive list of subdirectories.

void FatFile::ls	(	print_t *	pr,
		uint8_t	flags = `0`,
		uint8_t	indent = `0`
	)

inherited

List directory contents.

Parameters

[in]	pr	Print stream for list.
[in]	flags	The inclusive OR of

LS_DATE - Print file modification date

LS_SIZE - Print file size.

LS_R - Recursive list of subdirectories.

Parameters

[in] indent Amount of space before file name. Used for recursive list to indicate subdirectory level.

bool FatFile::mkdir	(	FatFile *	dir,
		const char *	path,
		bool	pFlag = `true`
	)

inherited

Make a new directory.

Parameters

[in]	dir	An open FatFile instance for the directory that will contain the new directory.
[in]	path	A path with a valid 8.3 DOS name for the new directory.
[in]	pFlag	Create missing parent directories if true.

Returns: The value true is returned for success and the value false is returned for failure.

bool FatFile::open	(	FatFileSystem *	fs,
		const char *	path,
		uint8_t	oflag
	)

inherited

Open a file in the volume working directory of a FatFileSystem.

Parameters

[in]	fs	File System where the file is located.
[in]	path	with a valid 8.3 DOS name for a file to be opened.
[in]	oflag	bitwise-inclusive OR of open mode flags. See see FatFile::open(FatFile, const char, uint8_t).

Returns: The value true is returned for success and the value false is returned for failure.

bool FatFile::open	(	FatFile *	dirFile,
		uint16_t	index,
		uint8_t	oflag
	)

inherited

Open a file by index.

Parameters

[in]	dirFile	An open FatFile instance for the directory.
[in]	index	The index of the directory entry for the file to be opened. The value for index is (directory file position)/32.
[in]	oflag	bitwise-inclusive OR of open mode flags. See see FatFile::open(FatFile, const char, uint8_t).

See open() by path for definition of flags.

Returns: true for success or false for failure.

bool FatFile::open	(	FatFile *	dirFile,
		const char *	path,
		uint8_t	oflag
	)

inherited

Open a file or directory by name.

Parameters

[in]	dirFile	An open FatFile instance for the directory containing the file to be opened.
[in]	path	A path with a valid 8.3 DOS name for a file to be opened.
[in]	oflag	Values for oflag are constructed by a bitwise-inclusive OR of flags from the following list

O_READ - Open for reading.

O_RDONLY - Same as O_READ.

O_WRITE - Open for writing.

O_WRONLY - Same as O_WRITE.

O_RDWR - Open for reading and writing.

O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.

O_AT_END - Set the initial position at the end of the file.

O_CREAT - If the file exists, this flag has no effect except as noted under O_EXCL below. Otherwise, the file shall be created

O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.

O_SYNC - Call sync() after each write. This flag should not be used with write(uint8_t) or any functions do character at a time writes since sync() will be called after each byte.

O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.

WARNING: A given file must not be opened by more than one FatFile object or file corruption may occur.

Note: Directory files must be opened read only. Write and truncation is not allowed for directory files.

Returns: The value true is returned for success and the value false is returned for failure.

bool FatFile::open	(	const char *	path,
		uint8_t	oflag = `O_READ`
	)

inlineinherited

Open a file in the current working directory.

Parameters

[in]	path	A path with a valid 8.3 DOS name for a file to be opened.
[in]	oflag	bitwise-inclusive OR of open mode flags. See see FatFile::open(FatFile, const char, uint8_t).

Returns: The value true is returned for success and the value false is returned for failure.

bool FatFile::openNext	(	FatFile *	dirFile,
		uint8_t	oflag = `O_READ`
	)

inherited

Open the next file or subdirectory in a directory.

Parameters

[in]	dirFile	An open FatFile instance for the directory containing the file to be opened.
[in]	oflag	bitwise-inclusive OR of open mode flags. See see FatFile::open(FatFile, const char, uint8_t).

Returns: true for success or false for failure.

bool FatFile::openRoot ( FatVolume * vol )

inherited

Open a volume's root directory.

Parameters

[in] vol The FAT volume containing the root directory to be opened.

Returns: The value true is returned for success and the value false is returned for failure.

int PrintFile::peek ( )

inline

Return the next available byte without consuming it.

Returns: The byte if no error and not at eof else -1;

bool FatFile::printCreateDateTime ( print_t * pr )

inherited

Print a file's creation date and time

Parameters

[in] pr Print stream for output.

Returns: The value true is returned for success and the value false is returned for failure.

static void FatFile::printFatDate ( uint16_t fatDate )

inlinestaticinherited

Print a directory date field.

Format is yyyy-mm-dd.

Parameters

[in] fatDate The date field from a directory entry.

void FatFile::printFatDate	(	print_t *	pr,
		uint16_t	fatDate
	)

staticinherited

Print a directory date field.

Format is yyyy-mm-dd.

Parameters

[in]	pr	Print stream for output.
[in]	fatDate	The date field from a directory entry.

static void FatFile::printFatTime ( uint16_t fatTime )

inlinestaticinherited

Print a directory time field.

Format is hh:mm:ss.

Parameters

[in] fatTime The time field from a directory entry.

void FatFile::printFatTime	(	print_t *	pr,
		uint16_t	fatTime
	)

staticinherited

Print a directory time field.

Format is hh:mm:ss.

Parameters

[in]	pr	Print stream for output.
[in]	fatTime	The time field from a directory entry.

int FatFile::printField	(	float	value,
		char	term,
		uint8_t	prec = `2`
	)

inherited