cli_file.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 */
 
#ifndef _CLI_FILE_H_
#define _CLI_FILE_H_
 
#include <stdint.h>        // for uint32_t
 
#include "cli.h"
#include "cne_common.h"        // for CNDP_API
 
// IWYU pragma: no_forward_declare ci_node
struct cli_node;
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CLI_FILE_SIZE 1024
 
enum {
    /* File operations opt */
    CLI_FILE_RD     = 0x0001, 
    CLI_FILE_WR     = 0x0002, 
    CLI_FILE_APPEND = 0x0004, 
    CLI_FILE_OPEN   = 0x0008, 
    CLI_FILE_CLOSE  = 0x0010, 
    CLI_FILE_CREATE = 0x0020, 
    /* File seek operations */
    CLI_SEEK_SET = 0x0100, 
    CLI_SEEK_CUR = 0x0200, 
    CLI_SEEK_END = 0x0400, 
    /* File information in cli_node.fflags */
    CLI_DATA_RDONLY = 0x1000, 
    CLI_FREE_DATA   = 0x2000, 
    CLI_DATA_EXPAND = 0x4000  
};
 
#define file_set(f, v) \
    do {               \
        (f) |= (v);    \
    } while ((0))
#define file_clr(f, v) \
    do {               \
        (f) &= ~(v);   \
    } while ((0))
 
static inline int
is_file_set(uint32_t opt, uint32_t cmpflags)
{
    return opt & cmpflags;
}
 
static inline int
is_file_rd(uint32_t opt)
{
    return is_file_set(opt, CLI_FILE_RD);
}
 
static inline int
is_file_wr(uint32_t opt)
{
    return is_file_set(opt, CLI_FILE_WR);
}
 
static inline int
is_file_append(uint32_t opt)
{
    return is_file_set(opt, CLI_FILE_APPEND);
}
 
static inline int
is_file_open(uint32_t opt)
{
    return is_file_set(opt, CLI_FILE_OPEN);
}
 
static inline int
is_file_close(uint32_t opt)
{
    return is_file_set(opt, CLI_FILE_CLOSE);
}
 
static inline int
is_file_create(uint32_t opt)
{
    return is_file_set(opt, CLI_FILE_CREATE);
}
 
static inline int
is_data_rdonly(uint32_t flags)
{
    return is_file_set(flags, CLI_DATA_RDONLY);
}
 
static inline int
is_file_eq(uint32_t opt, uint32_t cmpflags)
{
    return ((opt & cmpflags) == cmpflags);
}
 
static inline int
is_seek_set(uint32_t opt)
{
    return is_file_set(opt, CLI_SEEK_SET);
}
 
static inline int
is_seek_cur(uint32_t opt)
{
    return is_file_set(opt, CLI_SEEK_CUR);
}
 
static inline int
is_seek_end(uint32_t opt)
{
    return is_file_set(opt, CLI_SEEK_END);
}
 
CNDP_API struct cli_node *cli_file_open(const char *path, const char *type);
 
CNDP_API int cli_file_close(struct cli_node *node);
 
CNDP_API int cli_file_read(struct cli_node *node, char *buff, int len);
 
CNDP_API int cli_file_write(struct cli_node *node, char *buff, int len);
 
CNDP_API int cli_file_seek(struct cli_node *node, int offset, uint32_t whence);
 
CNDP_API int cli_readline(struct cli_node *node, char *buff, int len);
 
CNDP_API struct cli_node *cli_file_create(const char *path, const char *type);
 
CNDP_API int cli_file_handler(struct cli_node *node, char *buff, int len, uint32_t opt);
 
CNDP_API int cli_system(char *p);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CLI_FILE_H_ */