sopc_filesystem.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_FILESYSTEM_H_
#define SOPC_FILESYSTEM_H_
 
#include <stdio.h>
#include <stdlib.h>
#include "sopc_array.h"
 
typedef enum
{
    SOPC_FileSystem_Creation_OK = 0,
    SOPC_FileSystem_Creation_Error_PathAlreadyExists,
    SOPC_FileSystem_Creation_Error_PathPrefixInvalid,
    SOPC_FileSystem_Creation_Error_PathResolutionIssue,
    SOPC_FileSystem_Creation_Error_PathPermisionDenied,
    SOPC_FileSystem_Creation_Error_UnknownIssue
} SOPC_FileSystem_CreationResult;
 
typedef enum
{
    SOPC_FileSystem_Remove_OK = 0,
    SOPC_FileSystem_Remove_Error_PathNotEmpty,
    SOPC_FileSystem_Remove_Error_PathInvalid,
    SOPC_FileSystem_Remove_Error_PathPermisionDenied,
    SOPC_FileSystem_Remove_Error_UnknownIssue
} SOPC_FileSystem_RemoveResult;
 
typedef enum
{
    SOPC_FileSystem_GetDir_OK = 0,
    SOPC_FileSystem_GetDir_Error_InvalidParameters,
    SOPC_FileSystem_GetDir_Error_PathInvalid,
    SOPC_FileSystem_GetDir_Error_UnknownIssue
} SOPC_FileSystem_GetDirResult;
 
typedef struct SOPC_FileSystem_Dir SOPC_FileSystem_Dir;
 
SOPC_FileSystem_CreationResult SOPC_FileSystem_mkdir(const char* directoryPath);
 
SOPC_FileSystem_RemoveResult SOPC_FileSystem_rmdir(const char* directoryPath);
 
SOPC_FileSystem_GetDirResult SOPC_FileSystem_GetDirFilePaths(const char* directoryPath, SOPC_Array** ppFilePaths);
 
FILE* SOPC_FileSystem_fmemopen(void* buf, size_t size, const char* opentype);
 
#endif // SOPC_FILESYSTEM_H_