diff options
Diffstat (limited to 'src/common/getline.h')
-rw-r--r-- | src/common/getline.h | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/common/getline.h b/src/common/getline.h new file mode 100644 index 0000000..8a0574a --- /dev/null +++ b/src/common/getline.h @@ -0,0 +1,51 @@ +/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + */ +/*! + * \file getline.h + * + * \author Daniel Salzman <daniel.salzman@nic.cz> + * \author Jan Vcelak <jan.vcelak@nic.cz> + * + * \brief Multiplatform getline wrapper. + * + * \addtogroup common_lib + * @{ + */ + +#ifndef _GETLINE_H_ +#define _GETLINE_H_ + +#include <stdio.h> +#include <sys/types.h> + +/*! + * \brief Reads a line from a stream. + * + * This function has the same semantics as POSIX.1-2008 getline(). + * If necessary, the output buffer will be allocated/reallocated. + * + * \param lineptr Output buffer. + * \param n Output buffer size. + * \param stream Input stream. + * + * \retval Number of characters read, including new line delimiter, + * not including terminating. -1 on error or EOF. + */ +ssize_t knot_getline(char **lineptr, size_t *n, FILE *stream); + +#endif // _GETLINE_H_ + +/*! @} */ |