Differential file search comparison function and hook structure. More...

#include <stdbool.h>

Include dependency graph for deng.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	deng_hooks_s
	Hook functions for file system search events. More...

Typedefs
typedef bool(*	deng_filter_t) (const char *fp)
	Filter function for ignoring files during the search process.

Enumerations
enum	deng_notif_t { DENG_NOTIF_FILE_FOUND , DENG_NOTIF_STAGE_DONE }
	Notification events for the file search process. More...

enum	deng_fevent_t { DENG_FEVENT_NEW , DENG_FEVENT_DEL , DENG_FEVENT_MOD }
	File change event types for the file comparison process. More...

Functions
int	dengsearch (const char sd, deng_filter_t filter, const struct deng_hooks_s hooks, const struct index_s old, struct index_s new)
	Recursively scans directory `sd` and compares the file system state with a previously saved index. Any new, modified, deleted, or unmodified files are reported to the caller via the provided hooks structure, `hooks`. The index state `new` is then updated with the current file system state.

Detailed Description

Differential file search comparison function and hook structure.

Typedef Documentation

◆ deng_filter_t

deng_filter_t

Filter function for ignoring files during the search process.

Parameters

fp	The file path to filter

Returns: true if the file should be ignored, otherwise false

Enumeration Type Documentation

◆ deng_fevent_t

enum deng_fevent_t

File change event types for the file comparison process.

Enumerator
DENG_FEVENT_NEW	New file event.
DENG_FEVENT_DEL	Deleted file event.
DENG_FEVENT_MOD	Modified file event.

◆ deng_notif_t

enum deng_notif_t

Notification events for the file search process.

Enumerator
DENG_NOTIF_FILE_FOUND	Occurs when a file will be processed.
DENG_NOTIF_STAGE_DONE	Occurs when a stage has been fully processed.

Function Documentation

◆ dengsearch()

int dengsearch	(	const char *	sd,
		deng_filter_t	filter,
		const struct deng_hooks_s *	hooks,
		const struct index_s *	old,
		struct index_s *	new
	)

Recursively scans directory sd and compares the file system state with a previously saved index. Any new, modified, deleted, or unmodified files are reported to the caller via the provided hooks structure, hooks. The index state new is then updated with the current file system state.

Parameters

sd	The directory to scan for conditionally ignoring files
filter	The file filter function
hooks	The file event hook functions
old	The previous index state
new	The current index state

Returns: 0 if successful, otherwise a non-zero error code.

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Typedefs

Enumerations

Functions