sol-util-file.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * 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.
 */

#pragma once

#include <sol-macros.h>
#include <sol-buffer.h>

#include <dirent.h>
#include <sys/types.h>
#include <stdarg.h>
#include <stdbool.h>
#include <strings.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SOL_UTIL_MAX_READ_ATTEMPTS 10

enum sol_util_iterate_dir_reason {
    SOL_UTIL_ITERATE_DIR_STOP = 0, 
    SOL_UTIL_ITERATE_DIR_CONTINUE = 1 
};

int sol_util_write_file(const char *path, const char *fmt, ...) SOL_ATTR_PRINTF(2, 3);

int sol_util_vwrite_file(const char *path, const char *fmt, va_list args) SOL_ATTR_PRINTF(2, 0);

ssize_t sol_util_write_file_slice(const char *path, struct sol_str_slice slice);

int sol_util_read_file(const char *path, const char *fmt, ...) SOL_ATTR_SCANF(2, 3);

int sol_util_vread_file(const char *path, const char *fmt, va_list args) SOL_ATTR_SCANF(2, 0);

struct sol_buffer *sol_util_load_file_fd_raw(int fd)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

char *sol_util_load_file_string(const char *filename, size_t *size)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

char *sol_util_load_file_fd_string(int fd, size_t *size)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

int sol_util_load_file_fd_buffer(int fd, struct sol_buffer *buf)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

int sol_util_load_file_buffer(const char *filename, struct sol_buffer *buf)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

int sol_util_get_rootdir(char *out, size_t size)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

int sol_util_fd_set_flag(int fd, int flag)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

ssize_t sol_util_fill_buffer(int fd, struct sol_buffer *buffer, size_t size);

static inline int
sol_util_fill_buffer_exactly(int fd, struct sol_buffer *buffer, size_t size)
{
    ssize_t ret = sol_util_fill_buffer(fd, buffer, size);

    if (ret < 0)
        return (int)ret;
    else if ((size_t)ret < size)
        return -EIO;

    return 0;
}

int sol_util_iterate_dir(const char *path,
    enum sol_util_iterate_dir_reason (*iterate_dir_cb)(void *data,
    const char *dir_path,
    struct dirent *ent), const void *data);

int sol_util_move_file(const char *old_path, const char *new_path, mode_t mode);

bool sol_util_busy_wait_file(const char *path, uint64_t nanoseconds);

struct sol_str_slice sol_util_file_get_basename(struct sol_str_slice path);

int sol_util_create_recursive_dirs(const struct sol_str_slice path, mode_t mode);

int sol_util_get_user_config_dir(struct sol_buffer *buffer);

int sol_util_file_encode_filename(struct sol_buffer *buf, const struct sol_str_slice value);

#ifdef __cplusplus
}
#endif