epicsReadline.h File Reference

Command-line editing functions. More...

#include <libComAPI.h>
#include <stdio.h>

Include dependency graph for epicsReadline.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
LIBCOM_API void *epicsStdCall	epicsReadlineBegin (FILE *in)
	Create a command-line context. More...
LIBCOM_API char *epicsStdCall	epicsReadline (const char *prompt, void *context)
	Read a line of input. More...
LIBCOM_API void epicsStdCall	epicsReadlineEnd (void *context)
	Destroy a command-line context. More...

Detailed Description

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.

Definition in file epicsReadline.h.

Function Documentation

LIBCOM_API char* epicsStdCall epicsReadline	(	const char *	prompt,
		void *	context
	)

Read a line of input.

Parameters

prompt	Prompt string
context	To read from

Returns

Line read

Definition at line 81 of file epicsReadline.c.

{
    struct readlineContext *rc = context;
    FILE *in;
    char *line;
    int c;      /* char is unsigned on some archs, EOF is -ve */
    int linelen = 0;
    int linesize = 50;

    if (rc->osd)
        return osdReadline(prompt, rc);

    free(rc->line);
    rc->line = NULL;
    if ((in = rc->in) == NULL) {
        in = stdin;
        if (prompt) {
            fputs(prompt, stdout);
            fflush(stdout);
        }
    }
    line = (char *)malloc(linesize);
    if (line == NULL) {
        printf("Out of memory!\n");
        return NULL;
    }
    while ((c = getc(in)) !=  '\n') {
        if (c == EOF) {
            if (ferror(in)) {
                if ((errno == EINTR) || (errno == EPIPE)) {
                    clearerr(in);
                    continue;
                }
            }
            free (line);
            return NULL;
        }
        if ((linelen + 1) >= linesize) {
            char *cp;

            linesize += 50;
            cp = (char *)realloc(line, linesize);
            if (cp == NULL) {
                printf("Out of memory!\n");
                free(line);
                return NULL;
            }
            line = cp;
        }
        line[linelen++] = c;
    }
    line[linelen] = '\0';
    rc->line = line;
    return line;
}

LIBCOM_API void* epicsStdCall epicsReadlineBegin

(

FILE *

in

)

Create a command-line context.

Parameters

in	Filehandle to read from

Returns

Command-line context

Definition at line 64 of file epicsReadline.c.

{
    struct readlineContext *rc = calloc(1, sizeof(*rc));

    if (rc) {
        rc->in = in;
        rc->line = NULL;
        if (!envGetConfigParamPtr(&IOCSH_HISTEDIT_DISABLE))
            osdReadlineBegin(rc);
    }
    return rc;
}

LIBCOM_API void epicsStdCall epicsReadlineEnd

(

void *

context

)

Destroy a command-line context.

Parameters

context

Command-line context to destroy

Definition at line 141 of file epicsReadline.c.

{
    if (context) {
        struct readlineContext *rc = context;

        if (rc->osd)
            osdReadlineEnd(rc);
        else
            free(rc->line);
        free(rc);
    }
}