hal_filesystem.h

Go to the documentation of this file.

/*
 *  filesystem_hal.h
 *
 *  Copyright 2014 Michael Zillgith
 *
 *  This file is part of libIEC61850.
 *
 *  libIEC61850 is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  libIEC61850 is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with libIEC61850.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */

#ifndef FILESYSTEM_HAL_H_
#define FILESYSTEM_HAL_H_

#ifdef __cplusplus
extern "C" {
#endif

typedef void* FileHandle;
typedef struct sDirectoryHandle* DirectoryHandle;

#ifndef CONFIG_SYSTEM_FILE_SEPARATOR
#define CONFIG_SYSTEM_FILE_SEPARATOR '/'
#endif

FileHandle
FileSystem_openFile(char* pathName, bool readWrite);

int
FileSystem_readFile(FileHandle handle, uint8_t* buffer, int maxSize);

int
FileSystem_writeFile(FileHandle handle, uint8_t* buffer, int size);

void
FileSystem_closeFile(FileHandle handle);

bool
FileSystem_getFileInfo(char* filename, uint32_t* fileSize, uint64_t* lastModificationTimestamp);

bool
FileSystem_deleteFile(char* filename);

bool
FileSystem_renameFile(char* oldFilename, char* newFilename);

DirectoryHandle
FileSystem_openDirectory(char* directoryName);

char*
FileSystem_readDirectory(DirectoryHandle directory, bool* isDirectory);


void
FileSystem_closeDirectory(DirectoryHandle directory);

void
FileSystem_setBasePath(char* basePath);

#ifdef __cplusplus
}
#endif

#endif /* FILESYSTEM_HAL_H_ */