SkOSFile.h File Reference

#include <stdio.h>
#include "include/core/SkString.h"
#include "include/private/base/SkTemplates.h"

Go to the source code of this file.

Classes
class	SkOSFile
class	SkOSFile::Iter

Enumerations
enum	SkFILE_Flags { kRead_SkFILE_Flag = 0x01 , kWrite_SkFILE_Flag = 0x02 }

Functions
FILE *	sk_fopen (const char path[], SkFILE_Flags)
void	sk_fclose (FILE *)
size_t	sk_fgetsize (FILE *)
size_t	sk_fwrite (const void *buffer, size_t byteCount, FILE *)
void	sk_fflush (FILE *)
void	sk_fsync (FILE *)
size_t	sk_ftell (FILE *)
void *	sk_fmmap (FILE *f, size_t *length)
void *	sk_fdmmap (int fd, size_t *length)
void	sk_fmunmap (const void *addr, size_t length)
bool	sk_fidentical (FILE *a, FILE *b)
int	sk_fileno (FILE *f)
bool	sk_exists (const char *path, SkFILE_Flags=(SkFILE_Flags) 0)
bool	sk_isdir (const char *path)
size_t	sk_qread (FILE *, void *buffer, size_t count, size_t offset)
bool	sk_mkdir (const char *path)

Enumeration Type Documentation

SkFILE_Flags

enum SkFILE_Flags

Enumerator
kRead_SkFILE_Flag
kWrite_SkFILE_Flag

Definition at line 19 of file SkOSFile.h.

                  {
    kRead_SkFILE_Flag   = 0x01,
    kWrite_SkFILE_Flag  = 0x02
};

Function Documentation

sk_exists()

bool sk_exists	(	const char *	path,
		SkFILE_Flags	flags = (SkFILE_Flags) 0
	)

Returns true if something (file, directory, ???) exists at this path, and has the specified access flags.

Definition at line 34 of file SkOSFile_posix.cpp.

                                                     {
    int mode = F_OK;
    if (flags & kRead_SkFILE_Flag) {
        mode |= R_OK;
    }
    if (flags & kWrite_SkFILE_Flag) {
        mode |= W_OK;
    }
#ifdef SK_BUILD_FOR_IOS
    // if the default path fails, check the bundle (but only if read-only)
    if (0 == access(path, mode)) {
        return true;
    } else {
        return (kRead_SkFILE_Flag == flags && ios_get_path_in_bundle(path, nullptr));
    }
#else
    return (0 == access(path, mode));
#endif
}

sk_fclose()

void sk_fclose

(

FILE *

f

)

Definition at line 135 of file SkOSFile_stdio.cpp.

                        {
    if (f) {
        fclose(f);
    }
}

sk_fdmmap()

void * sk_fdmmap	(	int	fd,
		size_t *	length
	)

Maps a file descriptor into memory. Returns the address and length on success, NULL otherwise. The mapping is read only. When finished with the mapping, free the returned pointer with sk_fmunmap.

Definition at line 84 of file SkOSFile_posix.cpp.

                                      {
    struct stat status = {};
    if (0 != fstat(fd, &status)) {
        return nullptr;
    }
    if (!S_ISREG(status.st_mode)) {
        return nullptr;
    }
    if (!SkTFitsIn<size_t>(status.st_size)) {
        return nullptr;
    }
    size_t fileSize = static_cast<size_t>(status.st_size);
 
    void* addr = mmap(nullptr, fileSize, PROT_READ, MAP_PRIVATE, fd, 0);
    if (MAP_FAILED == addr) {
        return nullptr;
    }
 
    *size = fileSize;
    return addr;
}

sk_fflush()

void sk_fflush

(

FILE *

f

)

Definition at line 122 of file SkOSFile_stdio.cpp.

                        {
    SkASSERT(f);
    fflush(f);
}

sk_fgetsize()

size_t sk_fgetsize

(

FILE *

f

)

Definition at line 99 of file SkOSFile_stdio.cpp.

                            {
    SkASSERT(f);
 
    long curr = ftell(f); // remember where we are
    if (curr < 0) {
        return 0;
    }
 
    fseek(f, 0, SEEK_END); // go to the end
    long size = ftell(f); // record the size
    if (size < 0) {
        size = 0;
    }
 
    fseek(f, curr, SEEK_SET); // go back to our prev location
    return size;
}

sk_fidentical()

bool sk_fidentical	(	FILE *	a,
		FILE *	b
	)

Returns true if the two point at the exact same filesystem object.

Definition at line 73 of file SkOSFile_posix.cpp.

                                     {
    SkFILEID aID, bID;
    return sk_ino(a, &aID) && sk_ino(b, &bID)
           && aID.ino == bID.ino
           && aID.dev == bID.dev;
}

sk_fileno()

int sk_fileno

(

FILE *

f

)

Returns the underlying file descriptor for the given file. The return value will be < 0 on failure.

Definition at line 106 of file SkOSFile_posix.cpp.

                       {
    return fileno(f);
}

sk_fmmap()

void * sk_fmmap	(	FILE *	f,
		size_t *	length
	)

Maps a file into memory. Returns the address and length on success, NULL otherwise. The mapping is read only. When finished with the mapping, free the returned pointer with sk_fmunmap.

Definition at line 110 of file SkOSFile_posix.cpp.

                                      {
    int fd = sk_fileno(f);
    if (fd < 0) {
        return nullptr;
    }
 
    return sk_fdmmap(fd, size);
}

sk_fmunmap()

void sk_fmunmap	(	const void *	addr,
		size_t	length
	)

Unmaps a file previously mapped by sk_fmmap or sk_fdmmap. The length parameter must be the same as returned from sk_fmmap.

Definition at line 80 of file SkOSFile_posix.cpp.

                                                 {
    munmap(const_cast<void*>(addr), length);
}

sk_fopen()

FILE * sk_fopen	(	const char	path[],
		SkFILE_Flags	flags
	)

Definition at line 64 of file SkOSFile_stdio.cpp.

                                                      {
    char    perm[4] = {0, 0, 0, 0};
    char*   p = perm;
 
    if (flags & kRead_SkFILE_Flag) {
        *p++ = 'r';
    }
    if (flags & kWrite_SkFILE_Flag) {
        *p++ = 'w';
    }
    *p = 'b';
 
    FILE* file = nullptr;
#ifdef _WIN32
    file = fopen_win(path, perm);
#else
    file = fopen(path, perm);
#endif
#ifdef SK_BUILD_FOR_IOS
    // if not found in default path and read-only, try to open from bundle
    if (!file && kRead_SkFILE_Flag == flags) {
        SkString bundlePath;
        if (ios_get_path_in_bundle(path, &bundlePath)) {
            file = fopen(bundlePath.c_str(), perm);
        }
    }
#endif
 
    if (nullptr == file && (flags & kWrite_SkFILE_Flag)) {
        SkDEBUGF("sk_fopen: fopen(\"%s\", \"%s\") returned nullptr (errno:%d): %s\n",
                 path, perm, errno, strerror(errno));
    }
    return file;
}

sk_fsync()

void sk_fsync

(

FILE *

f

)

Definition at line 27 of file SkOSFile_posix.cpp.

                       {
#if !defined(SK_BUILD_FOR_ANDROID) && !defined(__UCLIBC__) && !defined(_NEWLIB_VERSION)
    int fd = fileno(f);
    fsync(fd);
#endif
}

sk_ftell()

size_t sk_ftell

(

FILE *

f

)

Definition at line 127 of file SkOSFile_stdio.cpp.

                         {
    long curr = ftell(f);
    if (curr < 0) {
        return 0;
    }
    return curr;
}

sk_fwrite()

size_t sk_fwrite	(	const void *	buffer,
		size_t	byteCount,
		FILE *	f
	)

Definition at line 117 of file SkOSFile_stdio.cpp.

                                                                {
    SkASSERT(f);
    return fwrite(buffer, 1, byteCount, f);
}

sk_isdir()

bool sk_isdir

(

const char *

path

)

Definition at line 141 of file SkOSFile_stdio.cpp.

                                {
    struct stat status = {};
    if (0 != stat(path, &status)) {
#ifdef SK_BUILD_FOR_IOS
        // check the bundle directory if not in default path
        SkString bundlePath;
        if (ios_get_path_in_bundle(path, &bundlePath)) {
            if (0 != stat(bundlePath.c_str(), &status)) {
                return false;
            }
        }
#else
        return false;
#endif
    }
    return SkToBool(status.st_mode & S_IFDIR);
}

sk_mkdir()

bool sk_mkdir

(

const char *

path

)

Definition at line 159 of file SkOSFile_stdio.cpp.

                                {
    if (sk_isdir(path)) {
        return true;
    }
    if (sk_exists(path)) {
        fprintf(stderr,
                "sk_mkdir: path '%s' already exists but is not a directory\n",
                path);
        return false;
    }
 
    int retval;
#ifdef _WIN32
    retval = _mkdir(path);
#else
    retval = mkdir(path, 0777);
    if (retval) {
      perror("mkdir() failed with error: ");
    }
#endif
    return 0 == retval;
}

sk_qread()

size_t sk_qread	(	FILE *	file,
		void *	buffer,
		size_t	count,
		size_t	offset
	)

Definition at line 119 of file SkOSFile_posix.cpp.

                                                                       {
    int fd = sk_fileno(file);
    if (fd < 0) {
        return SIZE_MAX;
    }
    ssize_t bytesRead = pread(fd, buffer, count, offset);
    if (bytesRead < 0) {
        return SIZE_MAX;
    }
    return bytesRead;
}