2014-01-08 17:47:34 +01:00
|
|
|
/****************************************************************************
|
2018-05-29 21:21:26 +02:00
|
|
|
* libs/libc/stdio/lib_libfgets.c
|
2014-01-08 17:47:34 +01:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
|
|
* this work for additional information regarding copyright ownership. The
|
|
|
|
* ASF licenses this file to you 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
|
2014-01-08 17:47:34 +01:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2014-01-08 17:47:34 +01:00
|
|
|
*
|
2021-03-02 15:54:21 +01:00
|
|
|
* 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.
|
2014-01-08 17:47:34 +01:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <unistd.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <ctype.h>
|
|
|
|
#include <assert.h>
|
|
|
|
#include <debug.h>
|
|
|
|
|
2015-12-30 00:31:17 +01:00
|
|
|
#include "libc.h"
|
2014-01-14 20:30:22 +01:00
|
|
|
|
2014-01-08 17:47:34 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Pre-processor Definitions
|
|
|
|
****************************************************************************/
|
2019-11-13 02:43:42 +01:00
|
|
|
|
2014-01-08 17:47:34 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: consume_eol
|
|
|
|
*
|
|
|
|
* Description:
|
2021-03-02 14:33:27 +01:00
|
|
|
* If 'consume' is true, then consume_eol() will read and discard bytes
|
|
|
|
* from 'stream' until an EOF or a newline encountered or until a read
|
|
|
|
* error occurs.
|
2014-01-08 17:47:34 +01:00
|
|
|
*
|
2015-10-03 01:43:18 +02:00
|
|
|
****************************************************************************/
|
2014-01-08 17:47:34 +01:00
|
|
|
|
|
|
|
static void consume_eol(FILE *stream, bool consume)
|
|
|
|
{
|
|
|
|
if (consume)
|
|
|
|
{
|
|
|
|
int ch;
|
|
|
|
|
|
|
|
do
|
|
|
|
{
|
2023-08-30 09:40:39 +02:00
|
|
|
ch = fgetc_unlocked(stream);
|
2014-01-08 17:47:34 +01:00
|
|
|
}
|
|
|
|
while (ch != EOF && ch != '\n');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: lib_fgets
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* lib_fgets() implements the core logic for both fgets() and gets_s().
|
|
|
|
* lib_fgets() reads in at most one less than 'buflen' characters from
|
|
|
|
* stream and stores them into the buffer pointed to by 'buf'. Reading
|
|
|
|
* stops after an EOF or a newline encountered or after a read error
|
|
|
|
* occurs.
|
|
|
|
*
|
|
|
|
* If a newline is read, it is stored into the buffer only if 'keepnl' is
|
|
|
|
* set true. A null terminator is always stored after the last character
|
|
|
|
* in the buffer.
|
|
|
|
*
|
|
|
|
* If 'buflen'-1 bytes were read into 'buf' without encountering an EOF
|
|
|
|
* or newline then the following behavior depends on the value of
|
|
|
|
* 'consume': If consume is true, then lib_fgets() will continue reading
|
|
|
|
* bytes and discarding them until an EOF or a newline encountered or
|
|
|
|
* until a read error occurs. Otherwise, lib_fgets() returns with the
|
|
|
|
* remaining of the incoming stream buffer.
|
|
|
|
*
|
2015-10-03 01:43:18 +02:00
|
|
|
****************************************************************************/
|
2014-01-08 17:47:34 +01:00
|
|
|
|
2023-08-30 09:40:39 +02:00
|
|
|
FAR char *lib_fgets_unlocked(FAR char *buf, size_t buflen, FILE *stream,
|
|
|
|
bool keepnl, bool consume)
|
2014-01-08 17:47:34 +01:00
|
|
|
{
|
2014-01-14 20:30:22 +01:00
|
|
|
size_t nch = 0;
|
2014-01-08 17:47:34 +01:00
|
|
|
|
|
|
|
/* Sanity checks */
|
|
|
|
|
2023-08-27 21:33:44 +02:00
|
|
|
if (!stream || !buf)
|
2014-01-08 17:47:34 +01:00
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Make sure that we have a buffer and space for at least one character */
|
|
|
|
|
|
|
|
if (buflen < 1)
|
|
|
|
{
|
|
|
|
consume_eol(stream, consume);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Make sure that we have space for something in addition to the NUL
|
|
|
|
* terminator.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (buflen < 2)
|
|
|
|
{
|
|
|
|
*buf = '\0';
|
|
|
|
consume_eol(stream, consume);
|
|
|
|
return buf;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Read characters until we have a full line. On each the loop we must
|
|
|
|
* be assured that there are two free bytes in the line buffer: One for
|
|
|
|
* the next character and one for the null terminator.
|
|
|
|
*/
|
|
|
|
|
2015-10-12 15:45:02 +02:00
|
|
|
for (; ; )
|
2014-01-08 17:47:34 +01:00
|
|
|
{
|
|
|
|
/* Get the next character */
|
|
|
|
|
2023-08-30 09:40:39 +02:00
|
|
|
int ch = fgetc_unlocked(stream);
|
2014-01-08 17:47:34 +01:00
|
|
|
|
|
|
|
/* Check for end-of-line. This is tricky only in that some
|
|
|
|
* environments may return CR as end-of-line, others LF, and
|
|
|
|
* others both.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (ch == '\n')
|
|
|
|
{
|
2023-02-22 19:25:20 +01:00
|
|
|
/* Convert \r\n to \n */
|
|
|
|
|
|
|
|
if (nch > 0 && buf[nch - 1] == '\r')
|
|
|
|
{
|
|
|
|
--nch;
|
|
|
|
}
|
|
|
|
|
2014-01-08 17:47:34 +01:00
|
|
|
if (keepnl)
|
|
|
|
{
|
|
|
|
/* Store newline is stored in the buffer */
|
|
|
|
|
|
|
|
buf[nch++] = '\n';
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Terminate the string */
|
|
|
|
|
|
|
|
buf[nch] = '\0';
|
|
|
|
return buf;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Check for end-of-file */
|
|
|
|
|
|
|
|
else if (ch == EOF)
|
|
|
|
{
|
|
|
|
/* End of file with no data? */
|
|
|
|
|
2023-02-22 19:25:20 +01:00
|
|
|
if (nch == 0)
|
2014-01-08 17:47:34 +01:00
|
|
|
{
|
|
|
|
/* Yes.. return NULL as the end of file mark */
|
|
|
|
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* No, terminate the accumulated string */
|
|
|
|
|
|
|
|
buf[nch] = '\0';
|
|
|
|
return buf;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-04-07 11:05:27 +02:00
|
|
|
/* Otherwise, put the character in the line buffer */
|
2014-01-08 17:47:34 +01:00
|
|
|
|
2021-04-07 11:05:27 +02:00
|
|
|
else
|
2014-01-08 17:47:34 +01:00
|
|
|
{
|
|
|
|
buf[nch++] = ch;
|
|
|
|
|
|
|
|
/* Check if there is room for another character and the line's
|
|
|
|
* NUL terminator. If not then we have to end the line now,
|
|
|
|
* perhaps consuming any data up to the end-of-line.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (nch + 1 >= buflen)
|
|
|
|
{
|
|
|
|
buf[nch] = '\0';
|
|
|
|
consume_eol(stream, consume);
|
|
|
|
return buf;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2023-08-30 09:40:39 +02:00
|
|
|
|
|
|
|
FAR char *lib_fgets(FAR char *buf, size_t buflen, FILE *stream,
|
|
|
|
bool keepnl, bool consume)
|
|
|
|
{
|
|
|
|
FAR char *ret;
|
|
|
|
|
|
|
|
flockfile(stream);
|
|
|
|
ret = lib_fgets_unlocked(buf, buflen, stream, keepnl, consume);
|
|
|
|
funlockfile(stream);
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|