mirror of
https://github.com/nextcloud/desktop.git
synced 2024-12-11 18:26:31 +03:00
99 lines
3.2 KiB
C
99 lines
3.2 KiB
C
/*
|
|
* libcsync -- a library to sync a directory with another
|
|
*
|
|
* Copyright (c) 2008 by Andreas Schneider <mail@cynapses.org>
|
|
*
|
|
* 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 _CSYNC_UPDATE_H
|
|
#define _CSYNC_UPDATE_H
|
|
|
|
#include "csync.h"
|
|
#include "vio/csync_vio_file_stat.h"
|
|
|
|
/**
|
|
* @file csync_update.h
|
|
*
|
|
* @brief Update Detection
|
|
*
|
|
* TODO
|
|
*
|
|
* @defgroup csyncUpdateDetectionInternals csync update detection internals
|
|
* @ingroup csyncInternalAPI
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Types for files
|
|
*/
|
|
enum csync_ftw_flags_e {
|
|
CSYNC_FTW_FLAG_FILE, /* Regular file. */
|
|
CSYNC_FTW_FLAG_DIR, /* Directory. */
|
|
CSYNC_FTW_FLAG_DNR, /* Unreadable directory. */
|
|
CSYNC_FTW_FLAG_NSTAT, /* Unstatable file. */
|
|
CSYNC_FTW_FLAG_SLINK, /* Symbolic link. */
|
|
CSYNC_FTW_FLAG_SPEC, /* Special file (fifo, ...). */
|
|
/* These flags are only passed from the `nftw' function. */
|
|
CSYNC_FTW_FLAG_DP, /* Directory, all subdirs have been visited. */
|
|
CSYNC_FTW_FLAG_SLN /* Symbolic link naming non-existing file. */
|
|
};
|
|
|
|
typedef int (*csync_walker_fn) (CSYNC *ctx, const char *file,
|
|
const csync_vio_file_stat_t *fs, enum csync_ftw_flags_e flag);
|
|
|
|
/**
|
|
* @brief The walker function to use in the file tree walker.
|
|
*
|
|
* @param ctx The used csync context.
|
|
*
|
|
* @param file The file we are researching.
|
|
*
|
|
* @param fs The stat information we got.
|
|
*
|
|
* @param flag The flag describing the type of the file.
|
|
*
|
|
* @return 0 on success, < 0 on error.
|
|
*/
|
|
int csync_walker(CSYNC *ctx, const char *file, const csync_vio_file_stat_t *fs,
|
|
enum csync_ftw_flags_e flag);
|
|
|
|
/**
|
|
* @brief The file tree walker.
|
|
*
|
|
* This function walks through the directory tree that is located under the uri
|
|
* specified. It calls a walker function which is provided as a function pointer
|
|
* once for each entry in the tree. By default, directories are handled before
|
|
* the files and subdirectories they contain (pre-order traversal).
|
|
*
|
|
* @param ctx The csync context to use.
|
|
*
|
|
* @param uri The uri/path to the directory tree to walk.
|
|
*
|
|
* @param fn The walker function to call once for each entry.
|
|
*
|
|
* @param depth The max depth to walk down the tree.
|
|
*
|
|
* @return 0 on success, < 0 on error. If fn() returns non-zero, then the tree
|
|
* walk is terminated and the value returned by fn() is returned as the
|
|
* result.
|
|
*/
|
|
int csync_ftw(CSYNC *ctx, const char *uri, csync_walker_fn fn,
|
|
unsigned int depth);
|
|
|
|
#endif /* _CSYNC_UPDATE_H */
|
|
|
|
/* vim: set ft=c.doxygen ts=8 sw=2 et cindent: */
|