-
Notifications
You must be signed in to change notification settings - Fork 1
/
ggets.h
81 lines (71 loc) · 2.59 KB
/
ggets.h
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
/** ggets.h
*
* Reimplementations of Chuck B. Falconer's `ggets` and `fggets`. Unlike the
* original versions, these grows the allocated buffer exponentially instead
* of linearly.
*
* Copyright (C) 2020 James D. Lin <[email protected]>
*
* The latest version of this file can be downloaded from:
* <https://github.com/jamesderlin/getline-compatible>
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*/
#ifndef GGETS_COMPATIBLE_H
#define GGETS_COMPATIBLE_H
#include <stdio.h>
#include <wchar.h>
/** fggets
*
* A version of `fgets` that automatically allocates a sufficiently large
* buffer and that automatically strips any trailing newline.
*
* Note that unlike `getline` and `fgets`, `fggets` cannot distinguish
* between a final line that is terminated with a newline and a final line
* that is unterminated.
*
* PARAMETERS:
* OUT line : Set to the allocated line.
* IN/OUT stream : The file stream to read from.
*
* RETURNS:
* Returns 0 on success.
*
* Returns EOF if the end-of-file indicator for `stream` is set.
*
* Returns a positive value on failure. On memory allocation failure,
* `*line` may be set to a partially read line. For all other types of
* failure, `*line` will be set to `NULL`.
*
* If `*line` is non-`NULL`, the caller is responsible for freeing the
* memory when done.
*/
int fggets(char** line, FILE* stream);
/** ggets
*
* Equivalent to `fggets(line, stdin)`.
*/
int ggets(char** line);
/** fggets_univ
*
* A version of `fggets` that recognizes CR, LF, or CR-LF as line endings,
* regardless of the platform and of `stream`'s mode.
*/
int fggets_univ(char** line, FILE* stream);
#endif /* GGETS_COMPATIBLE_H */