cosmopolitan/libc/stdio/getline.c

/*-*- mode:c;indent-tabs-mode:nil;c-basic-offset:2;tab-width:8;coding:utf-8 -*-│
│ vi: set et ft=c ts=2 sts=2 sw=2 fenc=utf-8                               :vi │
╞══════════════════════════════════════════════════════════════════════════════╡
│ Copyright 2020 Justine Alexandra Roberts Tunney                              │
│                                                                              │
│ Permission to use, copy, modify, and/or distribute this software for         │
│ any purpose with or without fee is hereby granted, provided that the         │
│ above copyright notice and this permission notice appear in all copies.      │
│                                                                              │
│ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL                │
│ WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED                │
│ WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE             │
│ AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL         │
│ DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR        │
│ PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER               │
│ TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR             │
│ PERFORMANCE OF THIS SOFTWARE.                                                │
╚─────────────────────────────────────────────────────────────────────────────*/
#include "libc/stdio/stdio.h"

/**
 * Reads line from stream, e.g.
 *
 *     char *line = NULL;
 *     size_t linesize = 0;
 *     while (getline(&line, &linesize, stdin) > 0) {
 *       chomp(line);
 *       printf("%s\n", line);
 *     }
 *     free(line);
 *
 * This function delegates to getdelim(), which provides further
 * documentation. Concerning lines, please note the \n or \r\n are
 * included in results, and can be removed with chomp().
 *
 * When reading from the console on Windows in `ICANON` mode, the
 * returned line will end with `\r\n` rather than `\n`.
 *
 * @param linebuf is the caller's buffer (in/out) which is extended
 *     automatically. *line may be NULL but only if *capacity is 0;
 *     NUL-termination is guaranteed FTMP
 * @return number of bytes read, including delim, excluding NUL, or -1
 *     w/ errno on EOF or error; see ferror() and feof()
 * @see fgetln(), xgetline(), getdelim(), gettok_r()
 */
ssize_t getline(char **linebuf, size_t *capacity, FILE *f) {
  return getdelim(linebuf, capacity, '\n', f);
}