File: libsystem_file.h

package info (click to toggle)
libewf 20100226-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 6,840 kB
  • ctags: 2,937
  • sloc: ansic: 100,745; sh: 10,115; makefile: 533
file content (124 lines) | stat: -rw-r--r-- 3,534 bytes parent folder | download
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
 * File functions
 *
 * Copyright (c) 2006-2009, Joachim Metz <forensics@hoffmannbv.nl>,
 * Hoffmann Investigations.
 *
 * Refer to AUTHORS for acknowledgements.
 *
 * This software is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This software 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 Lesser General Public License
 * along with this software.  If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined( _LIBSYSTEM_FILE_H )
#define _LIBSYSTEM_FILE_H

#include <common.h>
#include <types.h>

#include <liberror.h>

#include "libsystem_string.h"

#if defined( __cplusplus )
extern "C" {
#endif

/* The file access flags
 * bit 1	set to 1 for read access
 * bit 2	set to 1 for write access
 * bit 3	set to 1 to truncate an existing file on write
 * bit 4-8	not used
 */
#define LIBSYSTEM_FILE_FLAG_READ		0x01
#define LIBSYSTEM_FILE_FLAG_WRITE		0x02
#define LIBSYSTEM_FILE_FLAG_TRUNCATE		0x04

/* The file access macros
 */
#define LIBSYSTEM_FILE_OPEN_READ			( LIBSYSTEM_FILE_FLAG_READ )
#define LIBSYSTEM_FILE_OPEN_WRITE			( LIBSYSTEM_FILE_FLAG_WRITE )
#define LIBSYSTEM_FILE_OPEN_READ_WRITE			( LIBSYSTEM_FILE_FLAG_READ | LIBSYSTEM_FILE_FLAG_WRITE )
#define LIBSYSTEM_FILE_OPEN_WRITE_TRUNCATE		( LIBSYSTEM_FILE_FLAG_WRITE | LIBSYSTEM_FILE_FLAG_TRUNCATE )
#define LIBSYSTEM_FILE_OPEN_READ_WRITE_TRUNCATE		( LIBSYSTEM_FILE_FLAG_READ | LIBSYSTEM_FILE_FLAG_WRITE | LIBSYSTEM_FILE_FLAG_TRUNCATE )

/* Platform specific macros
 *  */
#if defined( _MSC_VER )
#define  LIBSYSTEM_FILE_LARGE_INTEGER_ZERO	{ 0, 0 }

#elif defined( __BORLANDC__ )
#define  LIBSYSTEM_FILE_LARGE_INTEGER_ZERO	{ 0 }

#endif

#if defined( WINAPI) && !defined( USE_CRT_FUNCTIONS )
typedef HANDLE libsystem_file_handle_t;

#define LIBSYSTEM_FILE_HANDLE_EMPTY	INVALID_HANDLE_VALUE
#else
typedef int libsystem_file_handle_t;

#define LIBSYSTEM_FILE_HANDLE_EMPTY	-1
#endif

#if defined( HAVE_OPEN ) || defined( WINAPI )
int libsystem_file_open(
     libsystem_file_handle_t *file_handle,
     const libsystem_character_t *filename,
     int flags,
     liberror_error_t **error );
#endif

#if defined( HAVE_CLOSE ) || defined( WINAPI )
int libsystem_file_close(
     libsystem_file_handle_t *file_handle,
     liberror_error_t **error );
#endif

#if defined( HAVE_READ ) || defined( WINAPI )
ssize_t libsystem_file_read(
         libsystem_file_handle_t file_handle,
         uint8_t *buffer,
         size_t size,
         liberror_error_t **error );
#endif

#if defined( HAVE_WRITE ) || defined( WINAPI )
ssize_t libsystem_file_write(
         libsystem_file_handle_t file_handle,
         uint8_t *buffer,
         size_t size,
         liberror_error_t **error );
#endif

#if defined( HAVE_LSEEK ) || defined( WINAPI )
off64_t libsystem_file_seek_offset(
         libsystem_file_handle_t file_handle,
         off64_t offset,
         int whence,
         liberror_error_t **error );
#endif

#if ( defined( HAVE_OPEN ) && defined( HAVE_CLOSE ) ) || defined( WINAPI )
int libsystem_file_exists(
     const libsystem_character_t *filename,
     liberror_error_t **error );
#endif

#if defined( __cplusplus )
}
#endif

#endif