iocsh.h File Reference

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

Include dependency graph for iocsh.h:

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

Go to the source code of this file.

Classes
union	iocshArgBuf
struct	iocshVarDef
struct	iocshArg
struct	iocshFuncDef
struct	iocshCmdDef

Macros
#define	IOCSH_STATIC_FUNC   static EPICS_ALWAYS_INLINE
#define	IOCSHFUNCDEF_HAS_USAGE

Typedefs
typedef union iocshArgBuf	iocshArgBuf
typedef struct iocshVarDef	iocshVarDef
typedef struct iocshArg	iocshArg
typedef struct iocshFuncDef	iocshFuncDef
typedef void(*	iocshCallFunc) (const iocshArgBuf *argBuf)
typedef struct iocshCmdDef	iocshCmdDef

Enumerations
enum	iocshArgType {   iocshArgInt, iocshArgDouble, iocshArgString, iocshArgPdbbase,   iocshArgArgv, iocshArgPersistentString }

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

Variables
LIBCOM_API struct dbBase **	iocshPpdbbase

Macro Definition Documentation

#define IOCSH_STATIC_FUNC   static EPICS_ALWAYS_INLINE

Definition at line 23 of file iocsh.h.

#define IOCSHFUNCDEF_HAS_USAGE

Definition at line 67 of file iocsh.h.

Typedef Documentation

typedef struct iocshArg iocshArg

typedef union iocshArgBuf iocshArgBuf

typedef void(* iocshCallFunc) (const iocshArgBuf *argBuf)

Definition at line 69 of file iocsh.h.

typedef struct iocshCmdDef iocshCmdDef

typedef struct iocshFuncDef iocshFuncDef

typedef struct iocshVarDef iocshVarDef

Enumeration Type Documentation

enum iocshArgType

Enumerator
iocshArgInt
iocshArgDouble
iocshArgString
iocshArgPdbbase
iocshArgArgv
iocshArgPersistentString

Definition at line 30 of file iocsh.h.

             {
    iocshArgInt,
    iocshArgDouble,
    iocshArgString,
    iocshArgPdbbase,
    iocshArgArgv,
    iocshArgPersistentString
}iocshArgType;

Function Documentation

LIBCOM_API int epicsStdCall iocsh

(

const char *

pathname

)

shorthand for

iocshLoad(pathname, NULL) 

Definition at line 1011 of file iocsh.cpp.

{
    return iocshLoad(pathname, NULL);
}

LIBCOM_API int epicsStdCall iocshCmd

(

const char *

cmd

)

shorthand for

iocshRun(cmd, NULL) 

Definition at line 1017 of file iocsh.cpp.

{
    return iocshRun(cmd, NULL);
}

LIBCOM_API 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);
        }
    }
}

LIBCOM_API const iocshCmdDef* epicsStdCall iocshFindCommand

(

const char *

name

)

Definition at line 154 of file iocsh.cpp.

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

LIBCOM_API 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;
}

LIBCOM_API 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 ();
}

LIBCOM_API 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);
}

LIBCOM_API 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 ();
}

LIBCOM_API 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 ();
}

LIBCOM_API 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);
}

LIBCOM_API 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

LIBCOM_API struct dbBase** iocshPpdbbase

Definition at line 41 of file iocsh.cpp.