source: vis_dev/vis-2.3/src/cmd/cmdFile.c @ 36

/**CFile***********************************************************************

  FileName    [cmdFile.c]

  PackageName [cmd]

  Synopsis    [File open, and file completion.]

  Author      [Originated from SIS]

  Copyright   [Copyright (c) 1994-1996 The Regents of the Univ. of California.
  All rights reserved.

  Permission is hereby granted, without written agreement and without license
  or royalty fees, to use, copy, modify, and distribute this software and its
  documentation for any purpose, provided that the above copyright notice and
  the following two paragraphs appear in all copies of this software.

  IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN
  "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO PROVIDE
  MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.]

******************************************************************************/

#include "cmdInt.h"

#if HAVE_READLINE_READLINE_H
#include <readline/readline.h>
#else
EXTERN char *readline(char *);
#endif
#if HAVE_READLINE_HISTORY_H
#include <readline/history.h>
#else
EXTERN void add_history(char *);
#endif

static char rcsid[] UNUSED = "$Id: cmdFile.c,v 1.24 2009/04/11 18:25:50 fabio Exp $";

/*---------------------------------------------------------------------------*/
/* Constant declarations                                                     */
/*---------------------------------------------------------------------------*/
#ifdef ESC
#undef ESC
#endif
#define ESC     '\033'
#define BEEP    '\007'
#define HIST    '%'
#define SUBST   '^'

#define STDIN   0
#define STDOUT  1


/*---------------------------------------------------------------------------*/
/* Variable declarations                                                     */
/*---------------------------------------------------------------------------*/
static char visHistChar = HIST;       /* can be changed by "set hist_char" */
static char *seperator = " \t\n;";


/**AutomaticStart*************************************************************/

/*---------------------------------------------------------------------------*/
/* Static function prototypes                                                */
/*---------------------------------------------------------------------------*/

#if HAVE_IOCTL_WITH_TIOCGETC
static int cmp(const void * s1, const void * s2);
static int match(char * newmatch, char * lastmatch, char * actual);
#endif
static int getnum(char ** linep);
static char * getarg(char * line, int num);
static char * bad_event(int n);
static char * do_subst(char * dest, char * new_);
static void print_prompt(char * prompt);
#if HAVE_LIBREADLINE
static char * removeWhiteSpaces(char *string);
#endif

/**AutomaticEnd***************************************************************/


/*---------------------------------------------------------------------------*/
/* Definition of exported functions                                          */
/*---------------------------------------------------------------------------*/



/**Function********************************************************************

  Synopsis    [Opens the file with the given mode.]

  Description [Opens the file with the given mode (see fopen()).  Tilde
  expansion (~user/ or ~/) is performed on the fileName, and "-" is allowed as
  a synonym for stdin (or stdout, depending on the mode).  If the file cannot
  be opened, a message is reported using perror(); the silent flag, if true,
  suppresses this error action.  In either case, A NULL file pointer is
  returned if any error occurs.  The fileName (after tilde expansion) is
  returned in the pointer realFileName, if realFileName is non-empty.  This
  is a pointer which should be free'd when you are done with it.]

  SideEffects []

******************************************************************************/
FILE *
Cmd_FileOpen(
  char * fileName,
  char * mode,
  char ** realFileName_p,
  int  silent)
{
  char *realFileName, *path, *user_path;
  char *lib_name;
  FILE *fp;

  if (strcmp(fileName, "-") == 0) {
    if (strcmp(mode, "w") == 0) {
      realFileName = util_strsav("stdout");
      fp = stdout;
    }
    else {
      realFileName = util_strsav("stdin");
      fp = stdin;
    }
  }
  else {
    realFileName = NIL(char);
    if (strcmp(mode, "r") == 0) {
      user_path = Cmd_FlagReadByName("open_path");
      if (user_path != NIL(char)) {
        lib_name = Vm_VisObtainLibrary();
        path = ALLOC(char, strlen(user_path)+strlen(lib_name)+10);
        (void) sprintf(path, "%s:%s", user_path, lib_name);

        /*
         * If the fileName begins with ./, ../, ~/, or /, AND the file doesn't
         * actually exist, then VIS will look in the open path (which includes
         * the sis library) for the file.  This could lead to unexpected behavior:
         * the user is looking for ./msu.genlib, and since that isn't there, the
         * users gets sis_lib/msu.genlib, and no error is reported.  The following
         * pseudo code fixes this:
         *
         * if (the beginning of file_name is : ./ || ../ || ~/ || /) {
         * realFileName = util_file_search(fileName, NIL(char), "r");
         * } else
         */
        realFileName = util_file_search(fileName, path, "r");
        FREE(path);
        FREE(lib_name);
      }
    }
    if (realFileName == NIL(char)) {
      realFileName = util_tilde_expand(fileName);
    }
    if (strcmp(mode, "r") == 0 && !util_check_file(realFileName, mode)) {
      FREE(realFileName);
      return NIL(FILE);
    }
    if ((fp = fopen(realFileName, mode)) == NIL(FILE)) {
      if (! silent) {
        perror(realFileName);
      }
    }
  }
  if (realFileName_p != 0) {
    *realFileName_p = realFileName;
  }
  else {
    FREE(realFileName);
  }
  return fp;
}

/*---------------------------------------------------------------------------*/
/* Definition of internal and static functions                               */
/*---------------------------------------------------------------------------*/

#if HAVE_IOCTL_WITH_TIOCGETC

/*
 * Words are seperated by any of the characters in `seperator'.  The seperator
 * is used to distinguish words from each other in file completion and history
 * substitution. The recommeded seperator string is " \t\n;".
 */

static int cmp(const void * s1, const void * s2);
static int match(char * newmatch, char * lastmatch, char * actual);
static int getnum(char ** linep);

/**Function********************************************************************

  Synopsis [Duplicates the function of fgets, but also provides file
  completion in the same style as csh]

  Description [ Input is read from `stream' and returned in `buf'.  Up to
  `size' bytes will be placed into `buf'.  If `stream' is not stdin, is
  equivalent to calling fgets(buf, size, stream).

  `prompt' is the prompt you want to appear at the beginning of the line.  The
  caller does not have to print the prompt string before calling this routine.
  The prompt has to be reprinted if the user hits ^D.

  The file completion routines are derived from the source code for csh, which
  is copyrighted by the Regents of the University of California.]

  SideEffects []

******************************************************************************/
char *
CmdFgetsFilec(
  char * buf,
  int  size,
  FILE * stream,
  char * prompt)
{
  int n_read, i, len, maxlen, col, sno, modname;
  struct tchars tchars, oldtchars;
  DIR *dir;
  struct dirent *dp;
#if HAVE_LIBREADLINE
  char *dupline;
  char *cleanLine;
#endif

#if HAVE_TERM_INTERRUPTS
  int omask;
  struct sgttyb tty, oldtty;    /* To mask interuupts */
  int pending = LPENDIN;
#endif

  char *last_word, *file, *path, *name, *line;
  char last_char, found[MAXNAMLEN];
  array_t *names = NIL(array_t);  /* initialize so that lint doesn't complain */

  sno = fileno(stream);
  if (sno != STDIN || !isatty(sno)){
    if (prompt != NIL(char)){
      (void) print_prompt(prompt);
      (void) fflush(stdout);
    }
    return (fgets(buf, size, stream));
  }
  else if (Cmd_FlagReadByName("filec") == NIL(char)) {
#if HAVE_LIBREADLINE
    /* Effectively read one line of input printing the prompt */
    dupline = (char *)readline(prompt);
    cleanLine = removeWhiteSpaces(dupline);

    /* Check if an EOF has been read */
    if (cleanLine != NIL(char)) {
      /* If the line is non empty, add it to the history */
      if (*cleanLine) {
        add_history(cleanLine);
      }

      /* Copy the contents of cleanLine to buf, to simulate fgets */
      strncpy(buf, cleanLine, size);
      if (strlen(cleanLine) >= size) {
        buf[size-1] = '\0';
      }
      line = buf;
    }
    else {
      line = NIL(char);
    }
    FREE(dupline);
#else
    /* Get rid of the trailing newline */
    if (prompt != NIL(char)){
      (void) print_prompt(prompt);
      (void) fflush(stdout);
    }
    line = fgets(buf, size, stream);
    if (line != NIL(char)) {
      len = strlen(line);
      if (len > 0 && line[len-1] == '\n') {
        line[len-1] = '\0';
      }
    }
#endif
    return line;
  } else {
    if (prompt != NIL(char)){
      (void) print_prompt(prompt);
      (void) fflush(stdout);
    }
  }

  /* Allow hitting ESCAPE to break a read() */

  (void) ioctl(sno, TIOCGETC, (char *) &tchars);
  oldtchars = tchars;
  tchars.t_brkc = ESC;
  (void) ioctl(sno, TIOCSETC, (char *) &tchars);

  while ((n_read = read(sno, buf, size)) > 0) {
    buf[n_read] = '\0';
    last_word = &buf[n_read - 1];
    last_char = *last_word;
    if (last_char == '\n' || n_read == size) {
      (void) ioctl(sno, TIOCSETC, (char *) &oldtchars);
      *last_word = '\0';
      return(buf);
    }
    if (last_char == ESC) {
      *last_word-- = '\0';
      (void) fprintf(stdout, "\b\b  \b\b");
    }
    else {
      names = array_alloc(char *, 10);
      (void) fputc('\n', stdout);
    }
    for (; last_word >= buf; --last_word) {
      if (strchr(seperator, *last_word) != NIL(char)) {
        break;
      }
    }
    last_word++;
    file = strrchr(buf, '/');
    if (file == NIL(char)) {
      file = last_word;
      modname = 0;
      path = ".";
    }
    else {
      *file++ = '\0';
      modname = 1;
      path = (*last_word == '~') ? util_tilde_expand(last_word) :
          last_word;
    }
    len = strlen(file);
    dir = opendir(path);
    if (dir == NIL(DIR) || len > MAXNAMLEN) {
      (void) fputc(BEEP, stdout);
    }
    else {
      *found = '\0';
      maxlen = 0;
      while ((dp = readdir(dir)) != NIL(struct dirent)) {
        if (strncmp(file, dp->d_name, len) == 0) {
          if (last_char == ESC) {
            if (match(dp->d_name, found, file) == 0) {
              break;
            }
          }
          else if (len != 0 || *(dp->d_name) != '.') {
            if (maxlen < NAMLEN(dp)) {
              maxlen = NAMLEN(dp);
            }
            array_insert_last(char *, names, util_strsav(dp->d_name));
          }
        }
      }
      (void) closedir(dir);
        if (last_char == ESC) {
          if (*found == '\0' || strcmp(found, file) == 0) {
            (void) fputc(BEEP, stdout);
          }
          else {
            (void) strcpy(file, found);
            (void) fprintf(stdout, "%s", &buf[n_read - 1]);
          }
        }
        else {
          maxlen += 2;
          col = maxlen;
          array_sort(names, cmp);
          for (i = 0; i < array_n(names); i++) {
            name = array_fetch(char *, names, i);
            (void) fprintf(stdout, "%-*s", maxlen, name);
            FREE(name);
            col += maxlen;
            if (col >= 80) {
              col = maxlen;
              (void) fputc('\n', stdout);
            }
          }
          array_free(names);
          if (col != maxlen) {
            (void) fputc('\n', stdout);
          }
        }
      }
      (void) fflush(stdout);
      if (modname != 0) {
        if (path != last_word) {
          FREE(path);
        }
        *--file = '/';
      }

#if HAVE_TERM_INTERRUPTS
      /* mask interrupts temporarily */
      omask = sigblock(sigmask(SIGINT));
      (void) ioctl(STDOUT, TIOCGETP, (char *)&tty);
      oldtty = tty;
      tty.sg_flags &= ~(ECHO|CRMOD);
      (void) ioctl(STDOUT, TIOCSETN, (char *)&tty);
#endif

      /* reprint prompt */
      (void) write(STDOUT, "\r", 1);
      print_prompt(prompt);

      /* shove chars from buf back into the input queue */
      for (i = 0; buf[i]; i++) {
        (void) ioctl(STDOUT, TIOCSTI, &buf[i]);
      }
#if HAVE_TERM_INTERRUPTS
      /* restore interrupts */
      (void) ioctl(STDOUT, TIOCSETN, (char *)&oldtty);
      (void) sigsetmask(omask);
      (void) ioctl(STDOUT, TIOCLBIS, (char *) &pending);
#endif
    }
    /* restore read() behavior */
    (void) ioctl(sno, TIOCSETC, (char *) &oldtchars);
    return(NIL(char));
}

#else

/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
char *
CmdFgetsFilec(
  char * buf,
  int  size,
  FILE * stream,
  char * prompt)
{
#if HAVE_LIBREADLINE
  char *dupline;
  char *cleanLine;
#endif
  char *line;
  int sno;
#if !HAVE_LIBREADLINE
  int len;
#endif

  sno = fileno(stream);
  if (sno != STDIN || !isatty(sno)){
    if (prompt != NIL(char)){
      (void) print_prompt(prompt);
      (void) fflush(stdout);
    }
    return (fgets(buf, size, stream));
  } else {
#if HAVE_LIBREADLINE
    /* Effectively read one line of input printing the prompt */
    dupline = (char *)readline(prompt);
    cleanLine = removeWhiteSpaces(dupline);

    /* Check if an EOF has been read */
    if (cleanLine != NIL(char)) {
      /* If the line is non empty, add it to the history */
      if (*cleanLine) {
        add_history(cleanLine);
      }

      /* Copy the contents of cleanLine to buf, to simulate fgets */
      strncpy(buf, cleanLine, size);
      if ((int) strlen(cleanLine) >= size) {
        buf[size-1] = '\0';
      }
      line = buf;
    }
    else {
      line = NIL(char);
    }
    FREE(dupline);
#else
    /* Get rid of the trailing newline */
    if (prompt != NIL(char)){
      (void) print_prompt(prompt);
      (void) fflush(stdout);
    }
    line = fgets(buf, size, stream);
    if (line != NIL(char)) {
      len = strlen(line);
      if (len > 0 && line[len-1] == '\n') {
        line[len-1] = '\0';
      }
    }
#endif
    return line;
  }

}

#endif /* HAVE_IOCTL_WITH_TIOCGETC */


#if HAVE_IOCTL_WITH_TIOCGETC
/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static int
cmp(
  const void * s1,
  const void * s2)
{
    return(strcmp(*(char **)s1, *(char **)s2));
}


/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static int
match(
  char * newmatch,
  char * lastmatch,
  char * actual)
{
  int i = 0;

  if (*actual == '\0' && *newmatch == '.') {
    return(1);
  }
  if (*lastmatch == '\0') {
    (void) strcpy(lastmatch, newmatch);
    return(1);
  }
  while (*newmatch++ == *lastmatch) {
    lastmatch++;
    i++;
  }
  *lastmatch = '\0';
  return(i);
}
/* #endif */ /* defined(hpux) */

#endif



/**Function********************************************************************

  Synopsis    [Simple history substitution routine.]

  Description [Simple history substitution routine. Not, repeat NOT, the
  complete csh history substitution mechanism.

  In the following ^ is the SUBST character and ! is the HIST character.
  Deals with:
        !!                      last command
        !stuff                  last command that began with "stuff"
        !*                      all but 0'th argument of last command
        !$                      last argument of last command
        !:n                     n'th argument of last command
        !n                      repeat the n'th command
        !-n                     repeat n'th previous command
        ^old^new                replace "old" w/ "new" in previous command


  Trailing spaces are significant. Removes all initial spaces.

  Returns `line' if no changes were made.  Returns pointer to a static buffer
  if any changes were made.  Sets `changed' to 1 if a history substitution
  took place, o/w set to 0.  Returns NULL if error occurred.]

  SideEffects []

******************************************************************************/
char *
CmdHistorySubstitution(
  char * line,
  int * changed)
{
  static char buf[1024], c;
  char *value;
  char *last, *old, *new_, *start, *b, *l;
  int n, len, i, num, internal_change;

  *changed = 0;
  internal_change = 0;
  while (isspace((int)(*line))) {
    line++;
  }
  if (*line == '\0') {
    return(line);
  }
  n = array_n(vm_commandHistoryArray);
  last = (n > 0) ?
    array_fetch(char *, vm_commandHistoryArray, n - 1) : (char *) "";

  b = buf;
  if (*line == SUBST) {
    old = line + 1;
    new_ = strchr(old, SUBST);
    if (new_ == NIL(char)) {
      goto bad_modify;
    }
    *new_++ = '\0';                   /* makes change in contents of line */
    start = strstr(last, old);
    if (start == NIL(char)) {
      *--new_ = SUBST;
      bad_modify:
      (void) fprintf(vis_stderr, "** cmd error: Modifier failed\n");
      return(NIL(char));
    }
    while (last != start) {
      *b++ = *last++;
    }
    b = do_subst(b, new_);
    last += strlen(old);
    while ((*b++ = *last++)) {
    }
    *changed = 1;
    return(buf);
  }

  if ((value = Cmd_FlagReadByName("history_char")) != NIL(char)){
    visHistChar = *value;
  }

  for (l = line; (*b = *l); l++) {
    if (*l == visHistChar) {
      /*
       * If a \ immediately preceeds a HIST char, pass just HIST char
       * Otherwise pass both \ and the character.
       */
      if (l > line && l[-1] == '\\') {
        b[-1] = visHistChar;
        internal_change = 1;
        continue;
      }
      if (n == 0) {
        return(bad_event(0));
      }
      l++;
      /* Cannot use a switch since the history char is a variable !!! */
      if (*l == visHistChar){
        /* replace !! in line with last */
        b = do_subst(b, last);
      }
      else if (*l == '$'){
        /* replace !$ in line with last arg of last */
        b = do_subst(b, getarg(last, -1));
      }
      else if (*l == '*'){
        b = do_subst(b, getarg(last, -2));
      }
      else if (*l == ':'){
        /* replace !:n in line with n'th arg of last */
        l++;
        num = getnum(&l);
        new_ = getarg(last, num);
        if (new_ == NIL(char)) {
          (void) fprintf(vis_stderr, "** cmd error: Bad %c arg selector\n", visHistChar);
          return(NIL(char));
        }
        b = do_subst(b, new_);
      }
      else if (*l == '-'){
        /* replace !-n in line with n'th prev cmd */
        l++;
        num = getnum(&l);
        if (num > n || num == 0) {
          return(bad_event(n - num + 1));
        }
        b = do_subst(b, array_fetch(char *, vm_commandHistoryArray, n - num));
      }
      else {
        /* replace !n in line with n'th command */
        if (isdigit((int)(*l))) {
          num = getnum(&l);
          if (num > n || num == 0) {
            return(bad_event(num));
          }
          b = do_subst(b, array_fetch(char *, vm_commandHistoryArray, num - 1));
        }
        else {  /* replace !boo w/ last cmd beginning w/ boo */
          start = l;
          while (*l && strchr(seperator, *l) == NIL(char)) {
            l++;
          }
          c = *l;
          *l = '\0';
          len = strlen(start);
          for (i = n - 1; i >= 0; i--) {
            old = array_fetch(char *, vm_commandHistoryArray, i);
            if (strncmp(old, start, len) == 0) {
              b = do_subst(b, old);
              break;
            }
          }
          if (i < 0) {
            (void) fprintf(vis_stderr, "** cmd error: Event not found: %s\n", start);
            *l = c;
            return(NIL(char));
          }
          *l-- = c;

        }
      }
      *changed = 1;
    }
    else {
      b++;
    }
  }
  if (*changed != 0 || internal_change != 0) {
    return(buf);
  }
  return(line);
}


/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static int
getnum(
  char ** linep)
{
  int num = 0;
  char *line = *linep;

  for (; isdigit((int)(*line)); line++) {
    num *= 10;
    num += *line - '0';
  }
  *linep = line - 1;
  return(num);
}


/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static char *
getarg(
  char * line,
  int  num)
{
  static char buf[128];
  char *b, *c;
  int i;

  if (num == -1) {
    i = 123456;
  }
  else if (num == -2) {
    i = 1;
  }
  else {
    i = num;
  }

  c = line;
  do {
    b = line = c;
    while (*line && strchr(seperator, *line) == NIL(char)) {
      line++;
    }
    c = line;
    while (*c && strchr(seperator, *c) != NIL(char)) {
      c++;
    }
    if (*c == '\0') {
      break;
    }
  } while (--i >= 0);

  if (i > 0) {
    if (num == -1) {
      return(b);
    }
    return(NIL(char));
  }
  if (num < 0) {
    return(b);
  }
  c = buf;
  do {
    *c++ = *b++;
  } while (b < line && c < &buf[127]);
  *c = '\0';
  return(buf);
}


/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static char *
bad_event(
  int  n)
{
  (void) fprintf(vis_stderr, "** cmd error: Event %d not found\n", n);
  return(NIL(char));
}


/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static char *
do_subst(
  char * dest,
  char * new_)
{
  while ((*dest = *new_++)) {
    dest++;
  }
  return(dest);
}


/**Function********************************************************************

  Synopsis    [required]

  Description [optional]

  SideEffects [required]

  SeeAlso     [optional]

******************************************************************************/
static void
print_prompt(
  char * prompt)
{
  char buf[256];

  if (prompt == NIL(char)) return;

  while (*prompt != '\0') {
    if (*prompt == visHistChar) {
      (void) sprintf(buf, "%d", array_n(vm_commandHistoryArray) + 1);
      if (write(STDOUT, buf, (int) strlen(buf)) == -1) exit(-1);
    }
    else {
      if (write(STDOUT, prompt, 1) == -1) exit(-1);
    }
    prompt++;
  }
}

#ifdef HAVE_LIBREADLINE
/**Function********************************************************************

  Synopsis [Removes tabs and spaces from the beginning and end of string.]

  SideEffects        []

******************************************************************************/
static char *
removeWhiteSpaces(
  char *string)
{
  char *left;
  char *right;

  if (string == NIL(char)) {
    return NIL(char);
  }

  /* Traverse the beginning of the string */
  for (left = string; *left == ' ' || *left == '\t'; left++);

  /* If we reached the end of the string */
  if (*left == 0) {
    return left;
  }

  /* Traverse the end of the string */
  right = left + strlen(left) - 1;
  while (right > left && (*right == ' ' || *right == '\t')) {
    right--;
  }
  /* Set the new end of string */
  *++right = '\0';

  return left;
} /* End of removeWhiteSpaces */
#endif