summaryrefslogtreecommitdiffstats
path: root/libparc/parc/algol/parc_RandomAccessFile.h
blob: f4f20150ab2b661e3bdb7c69d67bc8d672f38138 (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
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file parc_RandomAccessFile.h
 * @ingroup inputoutput
 * @brief A wrapper that provides random access to a file.
 *
 */
#ifndef PARCLibrary_RandomAccessFile
#define PARCLibrary_RandomAccessFile
#include <stdbool.h>

#include <parc/algol/parc_JSON.h>
#include <parc/algol/parc_HashCode.h>
#include <parc/algol/parc_File.h>

struct PARCRandomAccessFile;
typedef struct PARCRandomAccessFile PARCRandomAccessFile;

typedef enum {
    PARCRandomAccessFilePosition_Start,
    PARCRandomAccessFilePosition_End,
    PARCRandomAccessFilePosition_Current
} PARCRandomAccessFilePosition;

/**
 * Increase the number of references to a `PARCRandomAccessFile` instance.
 *
 * Note that new `PARCRandomAccessFile` is not created,
 * only that the given `PARCRandomAccessFile` reference count is incremented.
 * Discard the reference by invoking `parcRandomAccessFile_Release`.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 *
 * @return The same value as @p instance.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     PARCRandomAccessFile *b = parcRandomAccessFile_Acquire();
 *
 *     parcRandomAccessFile_Release(&a);
 *     parcRandomAccessFile_Release(&b);
 * }
 * @endcode
 */
PARCRandomAccessFile *parcRandomAccessFile_Acquire(const PARCRandomAccessFile *instance);

#ifdef PARCLibrary_DISABLE_VALIDATION
#  define parcRandomAccessFile_OptionalAssertValid(_instance_)
#else
#  define parcRandomAccessFile_OptionalAssertValid(_instance_) parcRandomAccessFile_AssertValid(_instance_)
#endif

/**
 * Assert that the given `PARCRandomAccessFile` instance is valid.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     parcRandomAccessFile_AssertValid(a);
 *
 *     printf("Instance is valid.\n");
 *
 *     parcRandomAccessFile_Release(&b);
 * }
 * @endcode
 */
void parcRandomAccessFile_AssertValid(const PARCRandomAccessFile *instance);

/**
 * Print a human readable representation of the given `PARCRandomAccessFile`.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 * @param [in] indentation The indentation level to use for printing.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     parcRandomAccessFile_Display(a, 0);
 *
 *     parcRandomAccessFile_Release(&a);
 * }
 * @endcode
 */
void parcRandomAccessFile_Display(const PARCRandomAccessFile *instance, int indentation);

/**
 * Determine if two `PARCRandomAccessFile` instances are equal.
 *
 * The following equivalence relations on non-null `PARCRandomAccessFile` instances are maintained: *
 *   * It is reflexive: for any non-null reference value x, `parcRandomAccessFile_Equals(x, x)` must return true.
 *
 *   * It is symmetric: for any non-null reference values x and y, `parcRandomAccessFile_Equals(x, y)` must return true if and only if
 *        `parcRandomAccessFile_Equals(y x)` returns true.
 *
 *   * It is transitive: for any non-null reference values x, y, and z, if
 *        `parcRandomAccessFile_Equals(x, y)` returns true and
 *        `parcRandomAccessFile_Equals(y, z)` returns true,
 *        then `parcRandomAccessFile_Equals(x, z)` must return true.
 *
 *   * It is consistent: for any non-null reference values x and y, multiple invocations of `parcRandomAccessFile_Equals(x, y)`
 *         consistently return true or consistently return false.
 *
 *   * For any non-null reference value x, `parcRandomAccessFile_Equals(x, NULL)` must return false.
 *
 * @param [in] x A pointer to a valid PARCRandomAccessFile instance.
 * @param [in] y A pointer to a valid PARCRandomAccessFile instance.
 *
 * @return true The instances x and y are equal.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *     PARCRandomAccessFile *b = parcRandomAccessFile_Open(..);
 *
 *     if (parcRandomAccessFile_Equals(a, b)) {
 *         printf("Instances are equal.\n");
 *     }
 *
 *     parcRandomAccessFile_Release(&a);
 *     parcRandomAccessFile_Release(&b);
 * }
 * @endcode
 * @see parcRandomAccessFile_HashCode
 */
bool parcRandomAccessFile_Equals(const PARCRandomAccessFile *x, const PARCRandomAccessFile *y);

/**
 * Returns a hash code value for the given instance.
 *
 * The general contract of `HashCode` is:
 *
 * Whenever it is invoked on the same instance more than once during an execution of an application,
 * the `HashCode` function must consistently return the same value,
 * provided no information used in a corresponding comparisons on the instance is modified.
 *
 * This value need not remain consistent from one execution of an application to another execution of the same application.
 * If two instances are equal according to the {@link parcRandomAccessFile_Equals} method,
 * then calling the {@link parcRandomAccessFile_HashCode} method on each of the two instances must produce the same integer result.
 *
 * It is not required that if two instances are unequal according to the
 * {@link parcRandomAccessFile_Equals} function,
 * then calling the `parcRandomAccessFile_HashCode`
 * method on each of the two objects must produce distinct integer results.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 *
 * @return The hashcode for the given instance.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open..();
 *
 *     PARCHashCode hashValue = parcRandomAccessFile_HashCode(buffer);
 *     parcRandomAccessFile_Release(&a);
 * }
 * @endcode
 */
PARCHashCode parcRandomAccessFile_HashCode(const PARCRandomAccessFile *instance);

/**
 * Determine if an instance of `PARCRandomAccessFile` is valid.
 *
 * Valid means the internal state of the type is consistent with its required current or future behaviour.
 * This may include the validation of internal instances of types.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 *
 * @return true The instance is valid.
 * @return false The instance is not valid.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     if (parcRandomAccessFile_IsValid(a)) {
 *         printf("Instance is valid.\n");
 *     }
 *
 *     parcRandomAccessFile_Release(&a);
 * }
 * @endcode
 *
 */
bool parcRandomAccessFile_IsValid(const PARCRandomAccessFile *instance);

/**
 * Open a new `PARCRandomAccessFile` instance.
 *
 * @param [in] file A `PARCFile` which refers to the file to open for random access.
 *
 * @retval `PARCRandomAccessFile` A new instance
 * @retval NULL An error occurred.
 *
 * Example:
 * @code
 * {
 *     PARCFile *file = parcFile_Create("/tmp/file_chunker.tmp");
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(file);
 *
 *     if (parcRandomAccessFile_IsValid(a)) {
 *         printf("Instance is valid.\n");
 *     }
 *
 *     parcRandomAccessFile_Release(&a);
 * }
 * @endcode
 *
 */
PARCRandomAccessFile *parcRandomAccessFile_Open(PARCFile *file);

/**
 * Release a previously acquired reference to the given `PARCRandomAccessFile` instance,
 * decrementing the reference count for the instance.
 *
 * The pointer to the instance is set to NULL as a side-effect of this function.
 *
 * If the invocation causes the last reference to the instance to be released,
 * the instance is deallocated and the instance's implementation will perform
 * additional cleanup and release other privately held references.
 *
 * @param [in,out] instancePtr A pointer to a pointer to the instance to release.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     parcRandomAccessFile_Release(&a);
 * }
 * @endcode
 */
void parcRandomAccessFile_Release(PARCRandomAccessFile **instancePtr);

/**
 * Create a `PARCJSON` instance (representation) of the given object.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 *
 * @return NULL Memory could not be allocated to contain the `PARCJSON` instance.
 * @return non-NULL An allocated C string that must be deallocated via parcMemory_Deallocate().
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     PARCJSON *json = parcRandomAccessFile_ToJSON(a);
 *
 *     printf("JSON representation: %s\n", parcJSON_ToString(json));
 *     parcJSON_Release(&json);
 *
 *     parcRandomAccessFile_Release(&a);
 * }
 * @endcode
 */
PARCJSON *parcRandomAccessFile_ToJSON(const PARCRandomAccessFile *instance);

/**
 * Produce a null-terminated string representation of the specified `PARCRandomAccessFile`.
 *
 * The result must be freed by the caller via {@link parcMemory_Deallocate}.
 *
 * @param [in] instance A pointer to a valid PARCRandomAccessFile instance.
 *
 * @return NULL Cannot allocate memory.
 * @return non-NULL A pointer to an allocated, null-terminated C string that must be deallocated via {@link parcMemory_Deallocate}.
 *
 * Example:
 * @code
 * {
 *     PARCRandomAccessFile *a = parcRandomAccessFile_Open(..);
 *
 *     char *string = parcRandomAccessFile_ToString(a);
 *
 *     parcRandomAccessFile_Release(&a);
 *
 *     parcMemory_Deallocate(&string);
 * }
 * @endcode
 *
 * @see parcRandomAccessFile_Display
 */
char *parcRandomAccessFile_ToString(const PARCRandomAccessFile *instance);

/**
 * Close a `PARCRandomAccessFile` instance.
 *
 * @param [in] fileHandle A `PARCRandomAccessFile.`
 *
 * @retval true The file was closed successfully.
 * @retval false An error occurred.
 *
 * Example:
 * @code
 * {
 *     PARCFile *file = parcFile_Create("/tmp/file_chunker.tmp");
 *     PARCRandomAccessFile *handle = parcRandomAccessFile_Open(file);
 *
 *     // use the handle
 *
 *     parcRandomAccessFile_Close(handle);
 *     parcRandomAccessFile_Release(&handle);
 * }
 * @endcode
 *
 * @see parcRandomAccessFile_Open
 */
bool parcRandomAccessFile_Close(PARCRandomAccessFile *fileHandle);

/**
 * Read bytes into the provided `PARCBuffer` until the buffer limit is or the source EOF
 * is reached.
 *
 * @param [in] fileHandle A `PARCRandomAccessFile` from which to read.
 * @param [in,out] buffer A `PARCBuffer` into which data is read.
 *
 * @return The number of bytes read.
 *
 * Example:
 * @code
 * {
 *     PARCFile *file = parcFile_Create("/tmp/file_chunker.tmp");
 *     PARCRandomAccessFile *handle = parcRandomAccessFile_Open(file);
 *
 *     PARCBuffer *buffer = parcBuffer_Allocate(1024);
 *     size_t numBytes = parcRandomAccessFile_Read(handle, buffer);
 *
 *     // use the data in `buffer`
 *
 *     parcRandomAccessFile_Close(handle);
 *     parcRandomAccessFile_Release(&handle);
 * }
 * @endcode
 *
 * @see parcRandomAccessFile_Write
 */
size_t parcRandomAccessFile_Read(PARCRandomAccessFile *fileHandle, PARCBuffer *buffer);

/**
 * Write bytes from the provided `PARCBuffer` to the source file until the limit is reached.
 *
 * @param [in] fileHandle A `PARCRandomAccessFile` to which data is written.
 * @param [in,out] buffer A `PARCBuffer` into which data is read.
 *
 * @return The number of bytes written.
 *
 * Example:
 * @code
 * {
 *     PARCFile *file = parcFile_Create("/tmp/file_chunker.tmp");
 *     PARCRandomAccessFile *handle = parcRandomAccessFile_Open(file);
 *
 *     PARCBuffer *buffer = parcBuffer_WrapCString("important data to go in the file");
 *     size_t numBytes = parcRandomAccessFile_Write(handle, buffer);
 *
 *     // continue writing to the file if needed
 *
 *     parcRandomAccessFile_Close(handle);
 *     parcRandomAccessFile_Release(&handle);
 * }
 * @endcode
 *
 * @see parcRandomAccessFile_Read
 */
size_t parcRandomAccessFile_Write(PARCRandomAccessFile *fileHandle, PARCBuffer *buffer);

/**
 * Seek to the position in the file specified as an offset from the position.
 *
 * The position can be one of:
 *     PARCRandomAccessFilePosition_Start
 *     PARCRandomAccessFilePosition_End
 *     PARCRandomAccessFilePosition_Current
 *
 * @param [in] fileHandle A `PARCRandomAccessFile` to which data is written.
 * @param [in] offset The number of bytes to offset from the provided position.
 * @param [in] position The base posititon from which the offset is calculated.
 *
 * @return The number of bytes seeked.
 *
 * Example:
 * @code
 * {
 *     PARCFile *file = parcFile_Create("/tmp/file_chunker.tmp");
 *     PARCRandomAccessFile *handle = parcRandomAccessFile_Open(file);
 *
 *     size_t fileSize = parcFile_GetFileSize(file);
 *     parcRandomAccessFile_Seek(handle, -1, PARCRandomAccessFilePosition_End);
 *
 *     // use the last byte of the file
 *
 *     parcRandomAccessFile_Close(handle);
 *     parcRandomAccessFile_Release(&handle);
 * }
 * @endcode
 *
 * @see parcRandomAccessFile_Read
 */
size_t parcRandomAccessFile_Seek(PARCRandomAccessFile *fileHandle, long offset, PARCRandomAccessFilePosition position);
#endif