/*************************************************************************\ * Copyright (c) 2014 UChicago Argonne LLC, as Operator of Argonne * National Laboratory. * Copyright (c) 2002 The Regents of the University of California, as * Operator of Los Alamos National Laboratory. * SPDX-License-Identifier: EPICS * EPICS BASE is distributed subject to a Software License Agreement found * in file LICENSE that is included with this distribution. \*************************************************************************/ /** * \file epicsReadline.h * \brief Command-line editing functions * \author Eric Norum * * Provides a generalized API for command line history and line-editing. * The implementation of this API can call GNU Readline, libtecla, and on * VxWorks the ledLib routines, according to the EPICS build configuration. */ #ifndef INC_epicsReadline_H #define INC_epicsReadline_H #ifdef __cplusplus extern "C" { #endif #include #include /** * \brief Create a command-line context * \param in Filehandle to read from * \return Command-line context */ LIBCOM_API void * epicsStdCall epicsReadlineBegin (FILE *in); /** * \brief Read a line of input * \param prompt Prompt string * \param context To read from * \return Line read */ LIBCOM_API char * epicsStdCall epicsReadline (const char *prompt, void *context); /** * \brief Destroy a command-line context * \param context Command-line context to destroy */ LIBCOM_API void epicsStdCall epicsReadlineEnd (void *context); #ifdef __cplusplus } #endif #endif /* INC_epicsReadline_H */