/* vifm
* Copyright (C) 2011 xaizek.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef VIFM__UTILS__FSDATA_H__
#define VIFM__UTILS__FSDATA_H__
/* Structure that maps arbitrary data onto file system tree. Each node can
* contain arbitrary amount of data, with size changed on every set operation.
* No additional checks are performed in get/set functions. */
#include <stddef.h> /* size_t */
/* Declaration of opaque fsdata type. */
typedef struct fsdata_t fsdata_t;
/* Type of callback for fsdata_traverse(). Intermediate nodes created
* indirectly are reported as invalid. parent_data is NULL for root nodes.
* Should return non-zero to stop traverser. */
typedef int (*fsdata_traverser_func)(const char name[], int valid,
const void *parent_data, void *data, void *arg);
/* Type of callback for fsdata_map_parents(). */
typedef void (*fsdata_visit_func)(void *data, void *arg);
/* prefix mode causes queries to return nearest match when exact match is not
* available. Non-zero resolve_paths enables path resolution, which also
* forbids use of nonexistent files. Returns NULL on error. */
fsdata_t * fsdata_create(int prefix, int resolve_paths);
/* Frees memory from the structure. Freeing of NULL fsd is OK. */
void fsdata_free(fsdata_t *fsd);
/* Assigns (possibly with overwrite) data to specified path. Returns zero on
* success, otherwise non-zero is returned. */
int fsdata_set(fsdata_t *fsd, const char path[], const void *data, size_t len);
/* Retrieves data associated with the path (or closest predecessor on prefix
* matches). Doesn't change data content if path absent. Returns zero on
* success and non-zero on error. */
int fsdata_get(fsdata_t *fsd, const char path[], void *data, size_t len);
/* Invokes visitor once per valid parent node of specified path. Returns zero
* on success or non-zero if path wasn't found. */
int fsdata_map_parents(fsdata_t *fsd, const char path[],
fsdata_visit_func visitor, void *arg);
/* Calls the callback for each node. Return non-zero if traversing was stopped
* prematurely, otherwise zero is returned. */
int fsdata_traverse(fsdata_t *fsd, fsdata_traverser_func traverser, void *arg);
#endif /* VIFM__UTILS__FSDATA_H__ */
/* vim: set tabstop=2 softtabstop=2 shiftwidth=2 noexpandtab cinoptions-=(0 : */
/* vim: set cinoptions+=t0 filetype=c : */
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"
Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/vifm
Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/vifm
You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a
pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master