shell.h File Reference

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

Go to the source code of this file.

Classes
struct	ArgvInfo
struct	Command

Macros
#define	kIdleInterval   20
#define	kIdleBatchLaunch   180
#define	kBeepAfterCmdTime   15
#define	kNoMax   (-1)
#define	kNoMin   (-1)
#define	kAbbreviatedMatchAllowed   0
#define	kExactMatchRequired   1
#define	kAmbiguousCommand   ((CommandPtr) -1)
#define	kNoCommand   ((CommandPtr) 0)
#define	kCmdHidden   00001
#define	kCmdMustBeConnected   00002
#define	kCmdMustBeDisconnected   00004
#define	kCompleteRemoteFile   00010
#define	kCompleteRemoteDir   00020
#define	kCompleteLocalFile   00040
#define	kCompleteLocalDir   00100
#define	kCompleteBookmark   00200
#define	kCompletePrefOpt   00400

Typedefs
typedef struct ArgvInfo	ArgvInfo
typedef struct ArgvInfo *	ArgvInfoPtr
typedef struct Command *	CommandPtr
typedef void(*	CmdProc) (const int argc, const char **const argv, const CommandPtr cmdp, const ArgvInfoPtr aip)
typedef struct Command	Command

Functions
void	InitCommandList (void)
CommandPtr	GetCommandByIndex (const int)
CommandPtr	GetCommandByName (const char *const, int)
void	PrintCmdHelp (CommandPtr)
void	PrintCmdUsage (CommandPtr)
int	MakeArgv (char *, int *, const char **, int, char *, size_t, int *, int)
void	XferCanceller (int)
void	BackToTop (int)
void	Cancel (int)
void	CommandShell (void)

Macro Definition Documentation

kAbbreviatedMatchAllowed

#define kAbbreviatedMatchAllowed   0

Definition at line 50 of file shell.h.

kAmbiguousCommand

#define kAmbiguousCommand   ((CommandPtr) -1)

Definition at line 54 of file shell.h.

kBeepAfterCmdTime

#define kBeepAfterCmdTime   15

Definition at line 26 of file shell.h.

kCmdHidden

#define kCmdHidden   00001

Definition at line 58 of file shell.h.

kCmdMustBeConnected

#define kCmdMustBeConnected   00002

Definition at line 59 of file shell.h.

kCmdMustBeDisconnected

#define kCmdMustBeDisconnected   00004

Definition at line 60 of file shell.h.

kCompleteBookmark

#define kCompleteBookmark   00200

Definition at line 65 of file shell.h.

kCompleteLocalDir

#define kCompleteLocalDir   00100

Definition at line 64 of file shell.h.

kCompleteLocalFile

#define kCompleteLocalFile   00040

Definition at line 63 of file shell.h.

kCompletePrefOpt

#define kCompletePrefOpt   00400

Definition at line 66 of file shell.h.

kCompleteRemoteDir

#define kCompleteRemoteDir   00020

Definition at line 62 of file shell.h.

kCompleteRemoteFile

#define kCompleteRemoteFile   00010

Definition at line 61 of file shell.h.

kExactMatchRequired

#define kExactMatchRequired   1

Definition at line 51 of file shell.h.

kIdleBatchLaunch

#define kIdleBatchLaunch   180

Definition at line 21 of file shell.h.

kIdleInterval

#define kIdleInterval   20

Definition at line 16 of file shell.h.

kNoCommand

#define kNoCommand   ((CommandPtr) 0)

Definition at line 55 of file shell.h.

kNoMax

#define kNoMax   (-1)

Definition at line 34 of file shell.h.

kNoMin

#define kNoMin   (-1)

Definition at line 35 of file shell.h.

Typedef Documentation

ArgvInfo

typedef struct ArgvInfo ArgvInfo

ArgvInfoPtr

typedef struct ArgvInfo * ArgvInfoPtr

CmdProc

typedef void(* CmdProc) (const int argc, const char **const argv, const CommandPtr cmdp, const ArgvInfoPtr aip)

Definition at line 29 of file shell.h.

Command

typedef struct Command Command

CommandPtr

typedef struct Command* CommandPtr

Definition at line 28 of file shell.h.

Function Documentation

BackToTop()

void BackToTop

(

int

sigNum

)

Definition at line 452 of file shell.c.

{
    gGotSig = sigNum;
    if (sigNum == SIGPIPE) {
        if (gRunningCommand == 1) {
            (void) fprintf(stderr, "Unexpected broken pipe.\n");
            gRunningCommand = 0;
        } else {
            SetXtermTitle("RESTORE");
            exit(1);
        }
    } else if (sigNum == SIGINT) {
        if (gRunningCommand == 0)
            gDoneApplication = 1;
    }
    if (gMayBackToTopJmp > 0) {
#ifdef HAVE_SIGSETJMP
        siglongjmp(gBackToTopJmp, 1);
#else   /* HAVE_SIGSETJMP */
        longjmp(gBackToTopJmp, 1);
#endif  /* HAVE_SIGSETJMP */
    }
}   /* BackToTop */

Referenced by CommandShell().

Cancel()

void Cancel

(

int

sigNum

)

Definition at line 481 of file shell.c.

{
    if (gMayCancelJmp != 0) {
        gGotSig = sigNum;
        gMayCancelJmp = 0;
#ifdef HAVE_SIGSETJMP
        siglongjmp(gCancelJmp, 1);
#else   /* HAVE_SIGSETJMP */
        longjmp(gCancelJmp, 1);
#endif  /* HAVE_SIGSETJMP */
    }
}   /* Cancel */

Referenced by CreatePartitionPage(), DECLARE_INTERFACE_(), DECLSPEC_ALIGN(), ListCmd(), LocalListCmd(), PageCmd(), and ShowPartitionSizeInputBox().

CommandShell()

void CommandShell

(

void

)

Definition at line 499 of file shell.c.

{
    int tUsed, bUsed;
    ArgvInfo ai;
    char prompt[64];
    char *lineRead;
#if defined(WIN32) || defined(_WINDOWS)
#else
    int sj;
#endif
    time_t cmdStart, cmdStop;
 
    /* Execution may jump back to this point to restart the shell. */
#if defined(WIN32) || defined(_WINDOWS)
 
#elif defined(HAVE_SIGSETJMP)
    sj = sigsetjmp(gBackToTopJmp, 1);
#else   /* HAVE_SIGSETJMP */
    sj = setjmp(gBackToTopJmp);
#endif  /* HAVE_SIGSETJMP */
 
#if defined(WIN32) || defined(_WINDOWS)
#else
    if (sj != 0) {
        Trace(0, "Caught signal %d, back at top.\n", gGotSig);
        if (gGotSig == SIGALRM) {
            (void) printf("\nRemote host was not responding, closing down the session.");
            FTPShutdownHost(&gConn);
        } else{
            (void) printf("\nInterrupted.\n");
            if (gCancelCtrl != 0) {
                gCancelCtrl = 0;
                (void) printf("Closing down the current FTP session: ");
                FTPShutdownHost(&gConn);
                (void) sleep(1);
                (void) printf("done.\n");
            }
        }
    }
 
    gMayBackToTopJmp = 1;
#endif
 
 
    ++gEventNumber;
 
    while (gDoneApplication == 0) {
#if defined(WIN32) || defined(_WINDOWS)
#else
        (void) NcSignal(SIGINT, BackToTop);
        (void) NcSignal(SIGPIPE, BackToTop);
        (void) NcSignal(SIGALRM, BackToTop);
#endif
 
        MakePrompt(prompt, sizeof(prompt));
 
        if (gConn.connected == 0) {
            SetXtermTitle("DEFAULT");
        } else {
            SetXtermTitle("%s - NcFTP", gConn.host);
        }
 
        lineRead = Readline(prompt);
        if (lineRead == NULL) {
            /* EOF, Control-D */
            (void) printf("\n");
            break;
        }
        Trace(0, "> %s\n", lineRead);
        AddHistory(lineRead);
        for (tUsed = 0;;) {
            (void) memset(&ai, 0, sizeof(ai));
            bUsed = MakeArgv(lineRead + tUsed, &ai.cargc, ai.cargv,
                (int) (sizeof(ai.cargv) / sizeof(char *)),
                ai.argbuf, sizeof(ai.argbuf),
                ai.noglobargv, 0);
            if (bUsed <= 0)
                break;
            tUsed += bUsed;
            if (ai.cargc == 0)
                continue;
            gRunningCommand = 1;
            (void) time(&cmdStart);
            if (DoCommand(&ai) < 0) {
                (void) time(&cmdStop);
                gRunningCommand = 0;
                break;
            }
            (void) time(&cmdStop);
            gRunningCommand = 0;
            if ((cmdStop - cmdStart) > kBeepAfterCmdTime) {
                /* Let the user know that a time-consuming
                 * operation has completed.
                 */
#if defined(WIN32) || defined(_WINDOWS)
                MessageBeep(MB_OK);
#else
                (void) fprintf(stderr, "\007");
#endif
            }
            ++gEventNumber;
        }
 
        free(lineRead);
    }
 
    CloseHost();
    gMayBackToTopJmp = 0;
}   /* Shell */

Referenced by main().

GetCommandByIndex()

CommandPtr GetCommandByIndex

(

const int

i

)

Definition at line 140 of file shell.c.

{
    if ((i < 0) || (i >= (int) gNumCommands))
        return (kNoCommand);
    return (&gCommands[i]);
}                                      /* GetCommandByIndex */

Referenced by CommandCompletionFunction().

GetCommandByName()

CommandPtr GetCommandByName	(	const char * const	name,
		int	wantExactMatch
	)

Definition at line 156 of file shell.c.

{
    CommandPtr canp, canp2;
 
    /* First check for an exact match.  Otherwise if you if asked for
     * 'cd', it would match both 'cd' and 'cdup' and return an
     * ambiguous name error, despite having the exact name for 'cd.'
     */
    canp = (CommandPtr) bsearch(name, gCommands, gNumCommands, sizeof(Command), (bsearch_proc_t) CommandExactSearchCmp);
 
    if (canp == kNoCommand && !wantExactMatch) {
        /* Now see if the user typed an abbreviation unique enough
         * to match only one name in the list.
         */
        canp = (CommandPtr) bsearch(name, gCommands, gNumCommands, sizeof(Command), (bsearch_proc_t) CommandSubSearchCmp);
 
        if (canp != kNoCommand) {
            /* Check the entry above us and see if the name we're looking
             * for would match that, too.
             */
            if (canp != &gCommands[0]) {
                canp2 = canp - 1;
                if (CommandSubSearchCmp(name, canp2) == 0)
                    return kAmbiguousCommand;
            }
            /* Check the entry below us and see if the name we're looking
             * for would match that one.
             */
            if (canp != &gCommands[gNumCommands - 1]) {
                canp2 = canp + 1;
                if (CommandSubSearchCmp(name, canp2) == 0)
                    return kAmbiguousCommand;
            }
        }
    }
    return canp;
}                                      /* GetCommandByName */

Referenced by CompletionFunction(), DoCommand(), and HelpCmd().

InitCommandList()

void InitCommandList

(

void

)

Definition at line 90 of file shell.c.

{
    qsort(gCommands, gNumCommands, sizeof(Command), (qsort_proc_t) CommandSortCmp);
}   /* InitCommandList */

Referenced by PreInit().

MakeArgv()

int MakeArgv	(	char *	line,
		int *	cargc,
		const char **	cargv,
		int	cargcmax,
		char *	dbuf,
		size_t	dbufsize,
		int *	noglobargv,
		int	readlineHacks
	)

Definition at line 221 of file shell.c.

{
    int c;
    int retval;
    char *dlim;
    char *dcp;
    char *scp;
    char *arg;
 
    *cargc = 0;
    scp = line;
    dlim = dbuf + dbufsize - 1;
    dcp = dbuf;
 
    for (*cargc = 0; *cargc < cargcmax; ) {
        /* Eat preceding junk. */
        for ( ; ; scp++) {
            c = *scp;
            if (c == '\0')
                goto done;
            if (isspace(c))
                continue;
            if ((c == ';') || (c == '\n')) {
                scp++;
                goto done;
            }
            break;
        }
 
        arg = dcp;
        cargv[*cargc] = arg;
        noglobargv[*cargc] = 0;
        (*cargc)++;
 
        /* Special hack so that "!cmd" is always split into "!" "cmd" */
        if ((*cargc == 1) && (*scp == '!')) {
            if (scp[1] == '!') {
                scp[1] = '\0';
            } else if ((scp[1] != '\0') && (!isspace((int) scp[1]))) {
                cargv[0] = "!";
                scp++;
                arg = dcp;
                cargv[*cargc] = arg;
                noglobargv[*cargc] = 0;
                (*cargc)++;
            }
        }
 
        /* Add characters to the new argument. */
        for ( ; ; ) {
            c = *scp;
            if (c == '\0')
                break;
            if (isspace(c))
                break;
            if ((c == ';') || (c == '\n')) {
                break;
            }
 
            scp++;
 
            if (c == '\'') {
                for ( ; ; ) {
                    c = *scp++;
                    if (c == '\0') {
                        if (readlineHacks != 0)
                            break;
                        /* Syntax error */
                        (void) fprintf(stderr, "Error: Unbalanced quotes.\n");
                        return (-1);
                    }
                    if (c == '\'')
                        break;
 
                    /* Add char. */
                    if (dcp >= dlim)
                        goto toolong;
                    *dcp++ = c;
 
                    if (strchr(kGlobChars, c) != NULL) {
                        /* User quoted glob characters,
                         * so mark this argument for
                         * noglob.
                         */
                        noglobargv[*cargc - 1] = 1;
                    }
                }
            } else if (c == '"') {
                for ( ; ; ) {
                    c = *scp++;
                    if (c == '\0') {
                        if (readlineHacks != 0)
                            break;
                        /* Syntax error */
                        (void) fprintf(stderr, "Error: Unbalanced quotes.\n");
                        return (-1);
                    }
                    if (c == '"')
                        break;
 
                    /* Add char. */
                    if (dcp >= dlim)
                        goto toolong;
                    *dcp++ = c;
 
                    if (strchr(kGlobChars, c) != NULL) {
                        /* User quoted glob characters,
                         * so mark this argument for
                         * noglob.
                         */
                        noglobargv[*cargc - 1] = 1;
                    }
                }
            } else
#if defined(WIN32) || defined(_WINDOWS)
                if (c == '|') {
#else
                if (c == '\\') {
#endif
                /* Add next character, verbatim. */
                c = *scp++;
                if (c == '\0')
                    break;
 
                /* Add char. */
                if (dcp >= dlim)
                    goto toolong;
                *dcp++ = c;
            } else {
                /* Add char. */
                if (dcp >= dlim)
                    goto toolong;
                *dcp++ = c;
            }
        }
 
        *dcp++ = '\0';
    }
 
    (void) fprintf(stderr, "Error: Argument list too long.\n");
    *cargc = 0;
    cargv[*cargc] = NULL;
    return (-1);
 
done:
    retval = (int) (scp - line);
    cargv[*cargc] = NULL;
    return (retval);
 
toolong:
    (void) fprintf(stderr, "Error: Line too long.\n");
    *cargc = 0;
    cargv[*cargc] = NULL;
    return (-1);
}   /* MakeArgv */

Referenced by CommandShell(), and CompletionFunction().

PrintCmdHelp()

void PrintCmdHelp

(

CommandPtr

c

)

Definition at line 200 of file shell.c.

{
    (void) printf("%s: %s.\n", c->name, c->help);
}                                      /* PrintCmdHelp */

Referenced by HelpCmd().

PrintCmdUsage()

void PrintCmdUsage

(

CommandPtr

c

)

Definition at line 210 of file shell.c.

{
    if (c->usage != NULL)
        (void) printf("Usage: %s %s\n", c->name, c->usage);
}                                      /* PrintCmdUsage */

Referenced by ChdirCmd(), DeleteCmd(), DoCommand(), GetCmd(), HelpCmd(), ListCmd(), LocalListCmd(), LookupCmd(), MkdirCmd(), MlsCmd(), OpenCmd(), PutCmd(), RmdirCmd(), SpoolGetCmd(), and SpoolPutCmd().

XferCanceller()

void XferCanceller

(

int

sigNum

)

Definition at line 419 of file shell.c.

{
    gGotSig = sigNum;
    if (gConn.cancelXfer > 0) {
#if defined(WIN32) || defined(_WINDOWS)
        signal(SIGINT, SIG_DFL);
#else
        /* User already tried it once, they
         * must think it's locked up.
         *
         * Jump back to the top, and
         * close down the current session.
         */
        gCancelCtrl = 1;
        if (gMayBackToTopJmp > 0) {
#ifdef HAVE_SIGSETJMP
            siglongjmp(gBackToTopJmp, 1);
#else   /* HAVE_SIGSETJMP */
            longjmp(gBackToTopJmp, 1);
#endif  /* HAVE_SIGSETJMP */
        }
#endif
    }
    gConn.cancelXfer++;
}   /* XferCanceller */

Referenced by GetCmd(), and PutCmd().