summaryrefslogtreecommitdiff
path: root/support/dktools/dk3ufi.h
blob: 85be0624efbbfb97768a2be4af9627680a4b563c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
Copyright (C) 2012-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk3ufi.ctr
*/

/**	@file dk3ufi.h Header file for the dk3ufi module.
*/

#ifndef DK3UFI_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3UFI_H_INCLUDED 1


#line 9 "dk3ufi.ctr"

#include "dk3types.h"

/**	Unique file identifier.
	If two files produce the same UFI they are both links
	to the same file or different file name notations
	pointing to the same file, i.e. "x.txt" and "./x.txt".
*/
typedef struct {
#if DK3_ON_WINDOWS
  DWORD		volser;		/**< Volume serial number. */
  DWORD		indhigh;	/**< Higner index part. */
  DWORD		indlow;		/**< Lower index part. */
#else
  dk3_um_t	device;		/**< Device number. */
  dk3_um_t	inode;		/**< Inode number. */
#endif
} dk3_ufi_t;



#ifdef __cplusplus
extern "C" {
#endif

/**	Obtain unique identifier for file.
	@param	pd	Result buffer pointer.
	@param	fn	File name to check.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3ufi_get_app(dk3_ufi_t *pd, dkChar const *fn, dk3_app_t *app);

/**	Obtain unique identifier for file.
	@param	pd	Result buffer pointer.
	@param	fn	File name to check (8-bit character string).
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3ufi_c8_get_app(dk3_ufi_t *pd, char const *fn, dk3_app_t *app);

/**	Obtain unique identifier for file.
	@param	pd	Result buffer pointer.
	@param	fn	File name to check.
	@return	1 on success, 0 on error.
*/
int
dk3ufi_get(dk3_ufi_t *pd, dkChar const *fn);

/**	Obtain unique identifier for file.
	@param	pd	Result buffer pointer.
	@param	fn	File name to check (8-bit character string).
	@return	1 on success, 0 on error.
*/
int
dk3ufi_c8_get(dk3_ufi_t *pd, char const *fn);

/**	Compare two file identifiers.
	@param	l	Left identifier.
	@param	r	Right identifier.
	@param	cr	Comparison criteria (ignored).
	@return	Comparison result.
*/
int
dk3ufi_compare(void const *l, void const *r, int cr);

#ifdef __cplusplus
}
#endif


#endif