ucommon

fsys Class Reference

A container for generic and o/s portable threadsafe file system functions. More...

#include <fsys.h>

Inheritance diagram for fsys:

Public Types

enum  access_t {
  ACCESS_RDONLY, ACCESS_WRONLY, ACCESS_REWRITE, ACCESS_RDWR = ACCESS_REWRITE,
  ACCESS_APPEND, ACCESS_SHARED, ACCESS_DIRECTORY, ACCESS_STREAM,
  ACCESS_RANDOM
}
 

Enumerated file access modes.


typedef long offset_t
 File offset type.

Public Member Functions

void assign (fd_t descriptor)
 Assign descriptor directly.
void close (void)
 Close a fsys resource.
void create (char *path, access_t access, unsigned mode)
 Open a file descriptor directly.
int drop (offset_t size=0)
 Drop cached data from start of file.
int err (void)
 Get last error.
 fsys (char *path, access_t access, unsigned permission)
 Create a fsys descriptor by creating a file.
 fsys (fsys &descriptor)
 Copy (dup) an existing fsys descriptor.
 fsys ()
 Construct an unattached fsys descriptor.
 fsys (char *path, access_t access)
 Create a fsys descriptor by opening an existing file or directory.
fd_t getHandle (void)
 Get the native system descriptor handle of the file descriptor.
void open (char *path, access_t access)
 Open a file or directory.
 operator bool ()
 Test if file descriptor is open.
 operator fd_t ()
 Get the descriptor from the object by casting reference.
bool operator! ()
 Test if file descriptor is closed.
fd_t operator* ()
 Get the descriptor from the object by pointer reference.
void operator= (fd_t descriptor)
 Assing file descriptor from system descriptor.
void operator= (fsys &descriptor)
 Assign file descriptor by duplicating another descriptor.
ssize_t read (void *buffer, size_t count)
 Read data from descriptor or scan directory.
int seek (offset_t offset)
 Set the position of a file descriptor.
int stat (struct stat *buffer)
 Get status of open descriptor.
int sync (void)
 Commit changes to the filesystem.
int trunc (offset_t offset)
 Truncate file to specified length.
ssize_t write (void *buffer, size_t count)
 Write data to descriptor.
 ~fsys ()
 Close and release a file descriptor.

Static Public Member Functions

static int access (char *path, unsigned mode)
 Test path access.
static void assign (fsys &object, fd_t descriptor)
 Assign a descriptor directly.
static int change (char *path, unsigned mode)
 Change file access mode.
static int changeDir (char *path)
 Set directory prefix (chdir).
static void close (fsys &descriptor)
 Close a file descriptor or directory directly.
static void create (fsys &object, char *path, access_t access, unsigned mode)
 create a file descriptor or directory directly.
static int createDir (char *path, unsigned mode)
 Simple direct method to create a directory.
static int drop (fsys &descriptor, offset_t size)
 Drop cached data from a file descriptor.
static void * find (fsys &module, char *symbol)
 Find symbol in loaded module.
static int getPrefix (char *path, size_t size)
 Get current directory prefix (pwd).
static bool isdev (struct stat *inode)
static bool isdir (char *path)
 Test if path is a directory.
static bool isdir (struct stat *inode)
static bool isdisk (struct stat *inode)
static bool isfile (char *path)
 Test if path is a file.
static bool isfile (struct stat *inode)
static bool islink (struct stat *inode)
static bool issys (struct stat *inode)
static int load (char *path)
 Load an unmaged plugin directly.
static void load (fsys &module, char *path)
 Load a plugin into memory.
static void open (fsys &object, char *path, access_t access)
 Open a file or directory.
static ssize_t read (fsys &descriptor, void *buffer, size_t count)
 Read data from file descriptor or directory.
static int remapError (void)
static int remove (char *path)
 Remove a file.
static int removeDir (char *path)
 Simple direct method to remove a directory.
static int rename (char *oldpath, char *newpath)
 Rename a file.
static int seek (fsys &descriptor, offset_t offset)
 Set the position of a file descriptor.
static int stat (char *path, struct stat *buffer)
 Stat a file.
static void unload (fsys &module)
 unload a specific plugin.
static ssize_t write (fsys &descriptor, void *buffer, size_t count)
 write data to file descriptor.

Static Public Attributes

static offset_t end
 Used to mark "append" in set position operations.

Protected Attributes

int error
fd_t fd
void * ptr

Detailed Description

A container for generic and o/s portable threadsafe file system functions.

These are based roughly on their posix equivilents. For libpth, the system calls are wrapped. The native file descriptor or handle may be used, but it is best to use "class fsys" instead because it can capture the errno of a file operation in a threadsafe and platform independent manner, including for mswindows targets.

Definition at line 125 of file fsys.h.


Constructor & Destructor Documentation

fsys::fsys ( fsys descriptor)

Copy (dup) an existing fsys descriptor.

Parameters:
descriptorto copy from.
fsys::fsys ( char *  path,
access_t  access 
)

Create a fsys descriptor by opening an existing file or directory.

Parameters:
pathof file to open for created descriptor.
accessmode of file.
fsys::fsys ( char *  path,
access_t  access,
unsigned  permission 
)

Create a fsys descriptor by creating a file.

Parameters:
pathof file to create for descriptor.
accessmode of file access.
permissionmode of file.

Member Function Documentation

static int fsys::access ( char *  path,
unsigned  mode 
) [static]

Test path access.

Parameters:
pathto test.
modeto test for.
Returns:
error number or 0 on success.
void fsys::assign ( fd_t  descriptor) [inline]

Assign descriptor directly.

Parameters:
descriptorto assign.

Definition at line 417 of file fsys.h.

static void fsys::assign ( fsys object,
fd_t  descriptor 
) [inline, static]

Assign a descriptor directly.

Parameters:
objectto assign descriptor to.
descriptorto assign.

Definition at line 425 of file fsys.h.

static int fsys::change ( char *  path,
unsigned  mode 
) [static]

Change file access mode.

Parameters:
pathto change.
modeto assign.
Returns:
error number or 0 on success.
static int fsys::changeDir ( char *  path) [static]

Set directory prefix (chdir).

Parameters:
pathto change to.
Returns:
error number or 0 on success.
static void fsys::close ( fsys descriptor) [inline, static]

Close a file descriptor or directory directly.

Parameters:
descriptorto close.

Definition at line 455 of file fsys.h.

Here is the call graph for this function:

void fsys::create ( char *  path,
access_t  access,
unsigned  mode 
)

Open a file descriptor directly.

Parameters:
pathof file to create.
accessmode of descriptor.
modeof file if created.
static void fsys::create ( fsys object,
char *  path,
access_t  access,
unsigned  mode 
) [inline, static]

create a file descriptor or directory directly.

Parameters:
objectto assign descriptor for created file.
pathof file to create.
accessmode of descriptor.
modeof file if created.

Definition at line 486 of file fsys.h.

static int fsys::createDir ( char *  path,
unsigned  mode 
) [static]

Simple direct method to create a directory.

Parameters:
pathof directory to create.
modeof directory.
Returns:
error number or 0 on success.
int fsys::drop ( offset_t  size = 0)

Drop cached data from start of file.

Parameters:
sizeof region to drop or until end of file.
Returns:
error number or 0 on success.
static int fsys::drop ( fsys descriptor,
offset_t  size 
) [inline, static]

Drop cached data from a file descriptor.

Parameters:
descriptorto set.
sizeof region from start of file to drop or all.
Returns:
error number or 0 on success.

Definition at line 403 of file fsys.h.

Here is the call graph for this function:

int fsys::err ( void  ) [inline]

Get last error.

Returns:
error number.

Definition at line 467 of file fsys.h.

static void* fsys::find ( fsys module,
char *  symbol 
) [static]

Find symbol in loaded module.

Parameters:
moduleto search.
symbolto search for.
Returns:
address of symbol or NULL if not found.
fd_t fsys::getHandle ( void  ) [inline]

Get the native system descriptor handle of the file descriptor.

Returns:
native os descriptor.

Definition at line 245 of file fsys.h.

static int fsys::getPrefix ( char *  path,
size_t  size 
) [static]

Get current directory prefix (pwd).

Parameters:
pathto save directory into.
sizeof path we can save.
Returns:
error number or 0 on success.
static bool fsys::isdir ( char *  path) [static]

Test if path is a directory.

Parameters:
pathto test.
Returns:
true if exists and is directory.
static bool fsys::isfile ( char *  path) [static]

Test if path is a file.

Parameters:
pathto test.
Returns:
true if exists and is file.
static void fsys::load ( fsys module,
char *  path 
) [static]

Load a plugin into memory.

Parameters:
modulefor management.
pathto plugin.
static int fsys::load ( char *  path) [static]

Load an unmaged plugin directly.

Parameters:
pathto plugin.
Returns:
error number or 0 on success.
static void fsys::open ( fsys object,
char *  path,
access_t  access 
) [inline, static]

Open a file or directory.

Parameters:
objectto assign descriptor for opened file.
pathof file to open.
accessmode of descriptor.

Definition at line 476 of file fsys.h.

void fsys::open ( char *  path,
access_t  access 
)

Open a file or directory.

Parameters:
pathof file to open.
accessmode of descriptor.
fsys::operator bool ( ) [inline]

Test if file descriptor is open.

Returns:
true if open.

Definition at line 219 of file fsys.h.

fsys::operator fd_t ( ) [inline]

Get the descriptor from the object by casting reference.

Returns:
low level file handle.

Definition at line 212 of file fsys.h.

bool fsys::operator! ( ) [inline]

Test if file descriptor is closed.

Returns:
true if closed.

Definition at line 226 of file fsys.h.

fd_t fsys::operator* ( ) [inline]

Get the descriptor from the object by pointer reference.

Returns:
low level file handle.

Definition at line 205 of file fsys.h.

void fsys::operator= ( fd_t  descriptor)

Assing file descriptor from system descriptor.

Parameters:
descriptorto dup from.
void fsys::operator= ( fsys descriptor)

Assign file descriptor by duplicating another descriptor.

Parameters:
descriptorto dup from.
ssize_t fsys::read ( void *  buffer,
size_t  count 
)

Read data from descriptor or scan directory.

Parameters:
bufferto read into.
countof bytes to read.
Returns:
bytes transferred, -1 if error.
static ssize_t fsys::read ( fsys descriptor,
void *  buffer,
size_t  count 
) [inline, static]

Read data from file descriptor or directory.

Parameters:
descriptorto read from.
bufferto read into.
countof bytes to read.
Returns:
bytes transferred, -1 if error.

Definition at line 375 of file fsys.h.

Here is the call graph for this function:

static int fsys::remove ( char *  path) [static]

Remove a file.

Parameters:
pathof file.
Returns:
error number or 0 on success.
static int fsys::removeDir ( char *  path) [static]

Simple direct method to remove a directory.

Parameters:
pathto remove.
Returns:
error number or 0 on success.
static int fsys::rename ( char *  oldpath,
char *  newpath 
) [static]

Rename a file.

Parameters:
oldpathto rename from.
newpathto rename to.
Returns:
error number or 0 on success.
int fsys::seek ( offset_t  offset)

Set the position of a file descriptor.

Parameters:
offsetfrom start of file or "end" to append.
Returns:
error number or 0 on success.

Reimplemented in fbuf.

static int fsys::seek ( fsys descriptor,
offset_t  offset 
) [inline, static]

Set the position of a file descriptor.

Parameters:
descriptorto set.
offsetfrom start of file or "end" to append.
Returns:
error number or 0 on success.

Definition at line 394 of file fsys.h.

Here is the call graph for this function:

static int fsys::stat ( char *  path,
struct stat *  buffer 
) [static]

Stat a file.

Parameters:
pathof file to stat.
bufferto save stat info.
Returns:
error number or 0 on success.
int fsys::stat ( struct stat *  buffer)

Get status of open descriptor.

Parameters:
bufferto save status info in.
Returns:
error number or 0 on success.
int fsys::sync ( void  )

Commit changes to the filesystem.

Returns:
error number or 0 on success.
int fsys::trunc ( offset_t  offset)

Truncate file to specified length.

The file pointer is positioned to the new end of file.

Parameters:
offsetto truncate to.
Returns:
true if truncate successful.

Reimplemented in fbuf.

static void fsys::unload ( fsys module) [static]

unload a specific plugin.

Parameters:
moduleto unload
static ssize_t fsys::write ( fsys descriptor,
void *  buffer,
size_t  count 
) [inline, static]

write data to file descriptor.

Parameters:
descriptorto write to.
bufferto write from.
countof bytes to write.
Returns:
bytes transferred, -1 if error.

Definition at line 385 of file fsys.h.

Here is the call graph for this function:

ssize_t fsys::write ( void *  buffer,
size_t  count 
)

Write data to descriptor.

Parameters:
bufferto write from.
countof bytes to write.
Returns:
bytes transferred, -1 if error.

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