You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
4.0 KiB
100 lines
4.0 KiB
/**************************************************************************** |
|
* apps/include/readline.h |
|
* |
|
* Copyright (C) 2011 Gregory Nutt. All rights reserved. |
|
* Author: Gregory Nutt <gnutt@nuttx.org> |
|
* |
|
* Redistribution and use in source and binary forms, with or without |
|
* modification, are permitted provided that the following conditions |
|
* are met: |
|
* |
|
* 1. Redistributions of source code must retain the above copyright |
|
* notice, this list of conditions and the following disclaimer. |
|
* 2. Redistributions in binary form must reproduce the above copyright |
|
* notice, this list of conditions and the following disclaimer in |
|
* the documentation and/or other materials provided with the |
|
* distribution. |
|
* 3. Neither the name NuttX nor the names of its contributors may be |
|
* used to endorse or promote products derived from this software |
|
* without specific prior written permission. |
|
* |
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS |
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
* POSSIBILITY OF SUCH DAMAGE. |
|
* |
|
****************************************************************************/ |
|
|
|
#ifndef __APPS_INCLUDE_READLINE_H |
|
#define __APPS_INCLUDE_READLINE_H |
|
|
|
/**************************************************************************** |
|
* Included Files |
|
****************************************************************************/ |
|
|
|
#include <nuttx/config.h> |
|
|
|
/**************************************************************************** |
|
* Pre-Processor Definitions |
|
****************************************************************************/ |
|
|
|
/**************************************************************************** |
|
* Public Data |
|
****************************************************************************/ |
|
|
|
#ifdef __cplusplus |
|
#define EXTERN extern "C" |
|
extern "C" { |
|
#else |
|
#define EXTERN extern |
|
#endif |
|
|
|
/**************************************************************************** |
|
* Public Function Prototypes |
|
****************************************************************************/ |
|
|
|
/**************************************************************************** |
|
* Name: readline |
|
* |
|
* readline() reads in at most one less than 'buflen' characters from |
|
* 'instream' and stores them into the buffer pointed to by 'buf'. |
|
* Characters are echoed on 'outstream'. Reading stops after an EOF or a |
|
* newline. If a newline is read, it is stored into the buffer. A null |
|
* terminator is stored after the last character in the buffer. |
|
* |
|
* This version of realine assumes that we are reading and writing to |
|
* a VT100 console. This will not work well if 'instream' or 'outstream' |
|
* corresponds to a raw byte steam. |
|
* |
|
* This function is inspired by the GNU readline but is an entirely |
|
* different creature. |
|
* |
|
* Input Parameters: |
|
* buf - The user allocated buffer to be filled. |
|
* buflen - the size of the buffer. |
|
* instream - The stream to read characters from |
|
* outstream - The stream to each characters to. |
|
* |
|
* Returned values: |
|
* On success, the (positive) number of bytes transferred is returned. |
|
* A length of zero would indicated an end of file condition. An failure, |
|
* a negated errno value is returned. |
|
* |
|
**************************************************************************/ |
|
|
|
EXTERN ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream); |
|
|
|
#undef EXTERN |
|
#ifdef __cplusplus |
|
} |
|
#endif |
|
|
|
#endif /* __APPS_INCLUDE_READLINE_H */
|
|
|