lws-vfs.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2018 Andy Green <andy@warmcat.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation:
 *  version 2.1 of the License.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *  MA  02110-1301  USA
 *
 * included from libwebsockets.h
 */
 
 
#if defined(LWS_WITH_ESP32)
/* sdk preprocessor defs? compiler issue? gets confused with member names */
#define LWS_FOP_OPEN            _open
#define LWS_FOP_CLOSE           _close
#define LWS_FOP_SEEK_CUR        _seek_cur
#define LWS_FOP_READ            _read
#define LWS_FOP_WRITE           _write
#else
#define LWS_FOP_OPEN            open
#define LWS_FOP_CLOSE           close
#define LWS_FOP_SEEK_CUR        seek_cur
#define LWS_FOP_READ            read
#define LWS_FOP_WRITE           write
#endif
 
#define LWS_FOP_FLAGS_MASK                 ((1 << 23) - 1)
#define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
#define LWS_FOP_FLAG_COMPR_IS_GZIP         (1 << 25)
#define LWS_FOP_FLAG_MOD_TIME_VALID        (1 << 26)
#define LWS_FOP_FLAG_VIRTUAL               (1 << 27)
 
struct lws_plat_file_ops;
 
struct lws_fop_fd {
        lws_filefd_type                 fd;
        const struct lws_plat_file_ops  *fops;
        void                            *filesystem_priv;
        lws_filepos_t                   pos;
        lws_filepos_t                   len;
        lws_fop_flags_t                 flags;
        uint32_t                        mod_time;
};
typedef struct lws_fop_fd *lws_fop_fd_t;
 
struct lws_fops_index {
        const char *sig;        /* NULL or vfs signature, eg, ".zip/" */
        uint8_t len;            /* length of above string */
};
 
struct lws_plat_file_ops {
        lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
                                     const char *filename, const char *vpath,
                                     lws_fop_flags_t *flags);
        int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
        lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
                                          lws_fileofs_t offset_from_cur_pos);
        int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
                            uint8_t *buf, lws_filepos_t len);
        int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
                             uint8_t *buf, lws_filepos_t len);
        struct lws_fops_index fi[3];
        const struct lws_plat_file_ops *next;
        /* Add new things just above here ---^
         * This is part of the ABI, don't needlessly break compatibility */
};
 
LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
lws_get_fops(struct lws_context *context);
LWS_VISIBLE LWS_EXTERN void
lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
lws_vfs_tell(lws_fop_fd_t fop_fd);
LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
lws_vfs_get_length(lws_fop_fd_t fop_fd);
LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
LWS_VISIBLE LWS_EXTERN lws_fileofs_t
lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
LWS_VISIBLE LWS_EXTERN lws_fileofs_t
lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
 
extern struct lws_plat_file_ops fops_zip;
 
LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
                  lws_fop_flags_t *flags);
 
static LWS_INLINE int
lws_vfs_file_close(lws_fop_fd_t *fop_fd)
{
        if (*fop_fd && (*fop_fd)->fops)
                return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
 
        return 0;
}
 
static LWS_INLINE lws_fileofs_t
lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
{
        return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
}
static LWS_INLINE int LWS_WARN_UNUSED_RESULT
lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
                   uint8_t *buf, lws_filepos_t len)
{
        return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
}
static LWS_INLINE int LWS_WARN_UNUSED_RESULT
lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
                    uint8_t *buf, lws_filepos_t len)
{
        return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
}
 
/* these are the platform file operations implementations... they can
 * be called directly and used in fops arrays
 */
 
LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
_lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
                    const char *vpath, lws_fop_flags_t *flags);
LWS_VISIBLE LWS_EXTERN int
_lws_plat_file_close(lws_fop_fd_t *fop_fd);
LWS_VISIBLE LWS_EXTERN lws_fileofs_t
_lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
LWS_VISIBLE LWS_EXTERN int
_lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
                    uint8_t *buf, lws_filepos_t len);
LWS_VISIBLE LWS_EXTERN int
_lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
                     uint8_t *buf, lws_filepos_t len);
 
LWS_VISIBLE LWS_EXTERN int
lws_alloc_vfs_file(struct lws_context *context, const char *filename,
                   uint8_t **buf, lws_filepos_t *amount);