fnet_fs.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  Licensed 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.
*
***************************************************************************
*
*  FNET File System API.
*
***************************************************************************/

#ifndef _FNET_FS_H_

#define _FNET_FS_H_

#if FNET_CFG_FS || defined(__DOXYGEN__)

/**************************************************************************/ 
typedef void *fnet_fs_dir_t;

/**************************************************************************/ 
typedef void *fnet_fs_file_t;

/**************************************************************************/ 
#define FNET_FS_SPLITTER            '/'

/**************************************************************************/ 
#define FNET_FS_EOF     (-1)

/**************************************************************************/ 
typedef enum
{
    FNET_FS_SEEK_SET = 0,   
    FNET_FS_SEEK_CUR,       
    FNET_FS_SEEK_END        
}
fnet_fs_seek_origin_t;

/**************************************************************************/ 
typedef enum
{
    DT_UNKNOWN = 0,     
    DT_REG,             
    DT_DIR              
} fnet_fs_d_type_t;


/**************************************************************************/ 
typedef struct
{
    fnet_uint32_t           d_ino;      
    fnet_fs_d_type_t        d_type;    
    const fnet_char_t      *d_name;    
    fnet_size_t             d_size;     
} fnet_fs_dirent_t;

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_return_t fnet_fs_init(void);

/***************************************************************************/ 
void fnet_fs_release(void);

/***************************************************************************/ 
fnet_return_t fnet_fs_mount( fnet_char_t *fs_name, const fnet_char_t *mount_name, const void *arg );

/***************************************************************************/ 
fnet_return_t fnet_fs_unmount( const fnet_char_t *mount_name );

/***************************************************************************/ 
fnet_fs_dir_t fnet_fs_opendir( const fnet_char_t *dirname);

/***************************************************************************/ 
fnet_return_t fnet_fs_closedir( fnet_fs_dir_t dir);

/***************************************************************************/ 
fnet_return_t fnet_fs_readdir(fnet_fs_dir_t dir, fnet_fs_dirent_t *dirent);

/***************************************************************************/ 
void fnet_fs_rewinddir( fnet_fs_dir_t dir );

/***************************************************************************/ 
fnet_fs_file_t fnet_fs_fopen(const fnet_char_t *filename, const fnet_char_t *mode);

/***************************************************************************/ 
fnet_fs_file_t fnet_fs_fopen_re(const fnet_char_t *filename, const fnet_char_t *mode, fnet_fs_dir_t dir);

/***************************************************************************/ 
fnet_return_t fnet_fs_fclose(fnet_fs_file_t file);

/***************************************************************************/ 
fnet_size_t fnet_fs_fread(void *buf, fnet_size_t size, fnet_fs_file_t file);

/***************************************************************************/ 
void fnet_fs_rewind( fnet_fs_file_t file );

/***************************************************************************/ 
fnet_bool_t fnet_fs_feof(fnet_fs_file_t file);

/***************************************************************************/ 
fnet_int32_t fnet_fs_fgetc(fnet_fs_file_t file);

/***************************************************************************/ 
fnet_return_t fnet_fs_fseek (fnet_fs_file_t file, fnet_int32_t offset, fnet_fs_seek_origin_t origin);

/***************************************************************************/ 
fnet_int32_t fnet_fs_ftell (fnet_fs_file_t file);

/***************************************************************************/ 
fnet_return_t fnet_fs_finfo (fnet_fs_file_t file, fnet_fs_dirent_t *dirent);

#if defined(__cplusplus)
}
#endif

#endif /* FNET_CFG_FS */

#endif /* _FNET_FS_H_ */