| |
| /* |
| * Copyright 2006 The Android Open Source Project |
| * |
| * Use of this source code is governed by a BSD-style license that can be |
| * found in the LICENSE file. |
| */ |
| |
| |
| // TODO: add unittests for all these operations |
| |
| #ifndef SkOSFile_DEFINED |
| #define SkOSFile_DEFINED |
| |
| #include "SkString.h" |
| |
| #if defined(SK_BUILD_FOR_MAC) || defined(SK_BUILD_FOR_UNIX) || defined(SK_BUILD_FOR_ANDROID) || defined(SK_BUILD_FOR_IOS) |
| #include <dirent.h> |
| #endif |
| |
| #include <stddef.h> // ptrdiff_t |
| |
| struct SkFILE; |
| |
| enum SkFILE_Flags { |
| kRead_SkFILE_Flag = 0x01, |
| kWrite_SkFILE_Flag = 0x02 |
| }; |
| |
| #ifdef _WIN32 |
| const static char SkPATH_SEPARATOR = '\\'; |
| #else |
| const static char SkPATH_SEPARATOR = '/'; |
| #endif |
| |
| SkFILE* sk_fopen(const char path[], SkFILE_Flags); |
| void sk_fclose(SkFILE*); |
| |
| size_t sk_fgetsize(SkFILE*); |
| /** Return true if the file could seek back to the beginning |
| */ |
| bool sk_frewind(SkFILE*); |
| |
| size_t sk_fread(void* buffer, size_t byteCount, SkFILE*); |
| size_t sk_fwrite(const void* buffer, size_t byteCount, SkFILE*); |
| |
| char* sk_fgets(char* str, int size, SkFILE* f); |
| |
| void sk_fflush(SkFILE*); |
| |
| bool sk_fseek(SkFILE*, size_t); |
| bool sk_fmove(SkFILE*, long); |
| size_t sk_ftell(SkFILE*); |
| |
| /** 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. |
| */ |
| void* sk_fmmap(SkFILE* f, 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. |
| */ |
| void* sk_fdmmap(int fd, 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. |
| */ |
| void sk_fmunmap(const void* addr, size_t length); |
| |
| /** Returns true if the two point at the exact same filesystem object. */ |
| bool sk_fidentical(SkFILE* a, SkFILE* b); |
| |
| /** Returns the underlying file descriptor for the given file. |
| * The return value will be < 0 on failure. |
| */ |
| int sk_fileno(SkFILE* f); |
| |
| // Returns true if something (file, directory, ???) exists at this path. |
| bool sk_exists(const char *path); |
| |
| // Returns true if a directory exists at this path. |
| bool sk_isdir(const char *path); |
| |
| // Have we reached the end of the file? |
| int sk_feof(SkFILE *); |
| |
| |
| // Create a new directory at this path; returns true if successful. |
| // If the directory already existed, this will return true. |
| // Description of the error, if any, will be written to stderr. |
| bool sk_mkdir(const char* path); |
| |
| class SkOSFile { |
| public: |
| class Iter { |
| public: |
| Iter(); |
| Iter(const char path[], const char suffix[] = NULL); |
| ~Iter(); |
| |
| void reset(const char path[], const char suffix[] = NULL); |
| /** If getDir is true, only returns directories. |
| Results are undefined if true and false calls are |
| interleaved on a single iterator. |
| */ |
| bool next(SkString* name, bool getDir = false); |
| |
| private: |
| #ifdef SK_BUILD_FOR_WIN |
| HANDLE fHandle; |
| uint16_t* fPath16; |
| #elif defined(SK_BUILD_FOR_MAC) || defined(SK_BUILD_FOR_UNIX) || defined(SK_BUILD_FOR_ANDROID) || defined(SK_BUILD_FOR_IOS) |
| DIR* fDIR; |
| SkString fPath, fSuffix; |
| #endif |
| }; |
| }; |
| |
| class SkUTF16_Str { |
| public: |
| SkUTF16_Str(const char src[]); |
| ~SkUTF16_Str() |
| { |
| sk_free(fStr); |
| } |
| const uint16_t* get() const { return fStr; } |
| |
| private: |
| uint16_t* fStr; |
| }; |
| |
| /** |
| * Functions for modifying SkStrings which represent paths on the filesystem. |
| */ |
| class SkOSPath { |
| public: |
| /** |
| * Assembles rootPath and relativePath into a single path, like this: |
| * rootPath/relativePath. |
| * It is okay to call with a NULL rootPath and/or relativePath. A path |
| * separator will still be inserted. |
| * |
| * Uses SkPATH_SEPARATOR, to work on all platforms. |
| */ |
| static SkString SkPathJoin(const char *rootPath, const char *relativePath); |
| |
| /** |
| * Return the name of the file, ignoring the directory structure. |
| * Behaves like python's os.path.basename. If the fullPath is |
| * /dir/subdir/, an empty string is returned. |
| * @param fullPath Full path to the file. |
| * @return SkString The basename of the file - anything beyond the |
| * final slash, or the full name if there is no slash. |
| */ |
| static SkString SkBasename(const char* fullPath); |
| }; |
| #endif |