iocsh.cpp File Reference

#include <exception>
#include <stddef.h>
#include <string.h>
#include <stdio.h>
#include <ctype.h>
#include <errno.h>
#include "epicsMath.h"
#include "errlog.h"
#include "macLib.h"
#include "epicsStdio.h"
#include "epicsString.h"
#include "epicsStdlib.h"
#include "epicsThread.h"
#include "epicsMutex.h"
#include "envDefs.h"
#include "registry.h"
#include "epicsReadline.h"
#include "cantProceed.h"
#include "iocsh.h"

Include dependency graph for iocsh.cpp:

Go to the source code of this file.

Classes
struct	iocshCommand
struct	iocshVariable
struct	iocshRedirect
struct	iocshScope
struct	iocshContext
class	IocshRegister

Macros
#define	NREDIRECTS   5
#define	USAGE()   fprintf(epicsGetStderr(), "Usage: on error [continue | break | halt | wait <delay>]\n")

Enumerations
enum	OnError { Continue, Break, Halt }

Functions
void epicsStdCall	iocshRegister (const iocshFuncDef *piocshFuncDef, iocshCallFunc func)
const iocshCmdDef *epicsStdCall	iocshFindCommand (const char *name)
void epicsStdCall	iocshRegisterVariable (const iocshVarDef *piocshVarDef)
const iocshVarDef *epicsStdCall	iocshFindVariable (const char *name)
void epicsStdCall	iocshFree (void)
int	iocshSetError (int err)
	Signal error from an IOC shell function. More...
int epicsStdCall	iocsh (const char *pathname)
int epicsStdCall	iocshCmd (const char *cmd)
int epicsStdCall	iocshLoad (const char *pathname, const char *macros)
int epicsStdCall	iocshRun (const char *cmd, const char *macros)
void epicsStdCall	iocshEnvClear (const char *name)

Variables
struct dbBase **	iocshPpdbbase

Macro Definition Documentation

#define NREDIRECTS   5

Definition at line 66 of file iocsh.cpp.

#define USAGE

(

)

fprintf(epicsGetStderr(), "Usage: on error [continue | break | halt | wait <delay>]\n")

Enumeration Type Documentation

enum OnError

Enumerator
Continue
Break
Halt

Definition at line 514 of file iocsh.cpp.

             {
    Continue,
    Break,
    Halt
} OnError;

Function Documentation

int epicsStdCall iocsh

(

const char *

pathname

)

shorthand for

iocshLoad(pathname, NULL) 

Definition at line 1011 of file iocsh.cpp.

{
    return iocshLoad(pathname, NULL);
}

int epicsStdCall iocshCmd

(

const char *

cmd

)

shorthand for

iocshRun(cmd, NULL) 

Definition at line 1017 of file iocsh.cpp.

{
    return iocshRun(cmd, NULL);
}

void epicsStdCall iocshEnvClear

(

const char *

name

)

Definition at line 1054 of file iocsh.cpp.

{
    iocshContext *context;

    if (iocshContextId) {
        context = (iocshContext *) epicsThreadPrivateGet(iocshContextId);

        if (context != NULL) {
            macPutValue(context->handle, name, NULL);
        }
    }
}

const iocshCmdDef* epicsStdCall iocshFindCommand

(

const char *

name

)

Definition at line 154 of file iocsh.cpp.

{
    return (iocshCmdDef *) registryFind(iocshCmdID, name);
}

const iocshVarDef* epicsStdCall iocshFindVariable

(

const char *

name

)

Definition at line 222 of file iocsh.cpp.

{
    struct iocshVariable *temp = (iocshVariable *) registryFind(iocshVarID, name);
    return temp ? temp->pVarDef : 0;
}

void epicsStdCall iocshFree

(

void

)

Definition at line 231 of file iocsh.cpp.

{
    struct iocshCommand *pc;
    struct iocshVariable *pv;

    iocshTableLock ();
    for (pc = iocshCommandHead ; pc != NULL ; ) {
        struct iocshCommand * nc = pc->next;
        free (pc);
        pc = nc;
    }
    for (pv = iocshVariableHead ; pv != NULL ; ) {
        struct iocshVariable *nv = pv->next;
        free (pv);
        pv = nv;
    }
    iocshCommandHead = NULL;
    iocshVariableHead = NULL;
    iocshTableUnlock ();
}

int epicsStdCall iocshLoad	(	const char *	pathname,
		const char *	macros
	)

Read and evaluate IOC shell commands from the given file.

Parameters

pathname	Path to script file
macros	NULL or a comma seperated list of macro definitions. eg. "VAR1=x,VAR2=y"

Returns

0 on success, non-zero on error

Definition at line 1023 of file iocsh.cpp.

{
    if (pathname)
        epicsEnvSet("IOCSH_STARTUP_SCRIPT", pathname);
    return iocshBody(pathname, NULL, macros);
}

void epicsStdCall iocshRegister	(	const iocshFuncDef *	piocshFuncDef,
		iocshCallFunc	func
	)

Definition at line 111 of file iocsh.cpp.

{
    struct iocshCommand *l, *p, *n;
    int i;

    iocshTableLock ();
    for (l = NULL, p = iocshCommandHead ; p != NULL ; l = p, p = p->next) {
        i = strcmp (piocshFuncDef->name, p->def.pFuncDef->name);
        if (i == 0) {
            p->def.pFuncDef = piocshFuncDef;
            p->def.func = func;
            iocshTableUnlock ();
            return;
        }
        if (i < 0)
            break;
    }
    n = (struct iocshCommand *) callocMustSucceed (1, sizeof *n,
        "iocshRegister");
    if (!registryAdd(iocshCmdID, piocshFuncDef->name, (void *)n)) {
        free (n);
        iocshTableUnlock ();
        errlogPrintf ("iocshRegister failed to add %s\n", piocshFuncDef->name);
        return;
    }
    if (l == NULL) {
        n->next = iocshCommandHead;
        iocshCommandHead = n;
    }
    else {
        n->next = l->next;
        l->next = n;
    }
    n->def.pFuncDef = piocshFuncDef;
    n->def.func = func;
    iocshTableUnlock ();
}

void epicsStdCall iocshRegisterVariable

(

const iocshVarDef *

piocshVarDef

)

Definition at line 167 of file iocsh.cpp.

{
    struct iocshVariable *l, *p, *n;
    int i;
    int found;

    iocshTableLock ();
    while ((piocshVarDef != NULL)
        && (piocshVarDef->name != NULL)
        && (*piocshVarDef->name != '\0')) {
        if (iocshVariableHead == NULL)
            iocshRegister(&varFuncDef,varCallFunc);
        found = 0;
        for (l = NULL, p = iocshVariableHead ; p != NULL ; l = p, p = p->next) {
            i = strcmp (piocshVarDef->name, p->pVarDef->name);
            if (i == 0) {
                if (p->pVarDef != piocshVarDef) {
                    errlogPrintf("Warning: iocshRegisterVariable redefining %s.\n",
                        piocshVarDef->name);
                    p->pVarDef = piocshVarDef;
                }
                found = 1;
                break;
            }
            if (i < 0)
                break;
        }
        if (!found) {
            n = (struct iocshVariable *) callocMustSucceed(1, sizeof *n,
                "iocshRegisterVariable");
            if (!registryAdd(iocshVarID, piocshVarDef->name, (void *)n)) {
                free(n);
                iocshTableUnlock();
                errlogPrintf("iocshRegisterVariable failed to add %s.\n",
                    piocshVarDef->name);
                return;
            }
            if (l == NULL) {
                n->next = iocshVariableHead;
                iocshVariableHead = n;
            }
            else {
                n->next = l->next;
                l->next = n;
            }
            n->pVarDef = piocshVarDef;
        }
        piocshVarDef++;
    }
    iocshTableUnlock ();
}

int epicsStdCall iocshRun	(	const char *	cmd,
		const char *	macros
	)

Evaluate a single IOC shell command

Parameters

cmd	Command string. eg. "echo \"something or other"" \param macros NULL or a comma seperated list of macro definitions. eg. "VAR1=x,VAR2=y"

Returns

0 on success, non-zero on error

Definition at line 1031 of file iocsh.cpp.

{
    if (cmd == NULL)
        return 0;
    return iocshBody(NULL, cmd, macros);
}

int iocshSetError

(

int

err

)

Signal error from an IOC shell function.

Parameters

err	0 - success (no op), !=0 - error

Returns

The err argument value.

Definition at line 536 of file iocsh.cpp.

{
    iocshContext *ctxt;
    if (err && iocshContextId) {
        ctxt = (iocshContext *) epicsThreadPrivateGet(iocshContextId);

        if(ctxt && ctxt->scope) ctxt->scope->errored = 1;
    }
    return err;
}

Variable Documentation

struct dbBase** iocshPpdbbase

Definition at line 41 of file iocsh.cpp.