Back to index

tetex-bin  3.0
Defines | Functions | Variables
write_entry.c File Reference
#include <curses.priv.h>
#include <sys/stat.h>
#include <tic.h>
#include <term_entry.h>

Go to the source code of this file.

Defines

#define S_ISDIR(mode)   ((mode & S_IFMT) == S_IFDIR)
#define TRACE_OUT(p)   /*nothing */
#define HI(x)   ((x) / 256)
#define LO(x)   ((x) % 256)
#define LITTLE_ENDIAN(p, x)   (p)[0] = LO(x), (p)[1] = HI(x)
#define WRITE_STRING(str)   (fwrite(str, sizeof(char), strlen(str) + 1, fp) == strlen(str) + 1)
#define even_boundary(value)   ((value) % 2 != 0 && fwrite(&zero, sizeof(char), 1, fp) != 1)

Functions

static int write_object (FILE *, TERMTYPE *)
static void write_file (char *filename, TERMTYPE *tp)
static int make_directory (const char *path)
 _nc_set_writedir (char *dir)
static void check_writeable (int code)
void _nc_write_entry (TERMTYPE *const tp)
static int compute_offsets (char **Strings, unsigned strmax, short *offsets)
static void convert_shorts (unsigned char *buf, short *Numbers, unsigned count)
 _nc_tic_written (void)

Variables

static int total_written

Define Documentation

#define even_boundary (   value)    ((value) % 2 != 0 && fwrite(&zero, sizeof(char), 1, fp) != 1)

Definition at line 404 of file write_entry.c.

#define HI (   x)    ((x) / 256)

Definition at line 361 of file write_entry.c.

#define LITTLE_ENDIAN (   p,
  x 
)    (p)[0] = LO(x), (p)[1] = HI(x)

Definition at line 363 of file write_entry.c.

#define LO (   x)    ((x) % 256)

Definition at line 362 of file write_entry.c.

#define S_ISDIR (   mode)    ((mode & S_IFMT) == S_IFDIR)

Definition at line 46 of file write_entry.c.

#define TRACE_OUT (   p)    /*nothing */

Definition at line 52 of file write_entry.c.

#define WRITE_STRING (   str)    (fwrite(str, sizeof(char), strlen(str) + 1, fp) == strlen(str) + 1)

Definition at line 365 of file write_entry.c.


Function Documentation

_nc_set_writedir ( char *  dir)

Definition at line 113 of file write_entry.c.

{
    const char *destination;
    char actual[PATH_MAX];

    if (dir == 0
       && use_terminfo_vars())
       dir = getenv("TERMINFO");

    if (dir != 0)
       (void) _nc_tic_dir(dir);

    destination = _nc_tic_dir(0);
    if (make_directory(destination) < 0) {
       char *home = _nc_home_terminfo();

       if (home != 0) {
           destination = home;
           if (make_directory(destination) < 0)
              _nc_err_abort("%s: permission denied (errno %d)",
                           destination, errno);
       }
    }

    /*
     * Note: because of this code, this logic should be exercised
     * *once only* per run.
     */
    if (chdir(_nc_tic_dir(destination)) < 0
       || getcwd(actual, sizeof(actual)) == 0)
       _nc_err_abort("%s: not a directory", destination);
    _nc_keep_tic_dir(strdup(actual));
}

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 588 of file write_entry.c.

{
    return total_written;
}
void _nc_write_entry ( TERMTYPE *const  tp)

Definition at line 207 of file write_entry.c.

{
    struct stat statbuf;
    char name_list[MAX_TERMINFO_LENGTH];
    char *first_name, *other_names;
    char *ptr;
    char filename[PATH_MAX];
    char linkname[PATH_MAX];
#if USE_SYMLINKS
    char symlinkname[PATH_MAX];
#if !HAVE_LINK
#undef HAVE_LINK
#define HAVE_LINK 1
#endif
#endif /* USE_SYMLINKS */
    static int call_count;
    static time_t start_time;      /* time at start of writes */

    if (call_count++ == 0) {
       start_time = 0;
    }

    (void) strcpy(name_list, tp->term_names);
    DEBUG(7, ("Name list = '%s'", name_list));

    first_name = name_list;

    ptr = &name_list[strlen(name_list) - 1];
    other_names = ptr + 1;

    while (ptr > name_list && *ptr != '|')
       ptr--;

    if (ptr != name_list) {
       *ptr = '\0';

       for (ptr = name_list; *ptr != '\0' && *ptr != '|'; ptr++)
           continue;

       if (*ptr == '\0')
           other_names = ptr;
       else {
           *ptr = '\0';
           other_names = ptr + 1;
       }
    }

    DEBUG(7, ("First name = '%s'", first_name));
    DEBUG(7, ("Other names = '%s'", other_names));

    _nc_set_type(first_name);

    if (strlen(first_name) > sizeof(filename) - 3)
       _nc_warning("terminal name too long.");

    sprintf(filename, "%c/%s", first_name[0], first_name);

    /*
     * Has this primary name been written since the first call to
     * write_entry()?  If so, the newer write will step on the older,
     * so warn the user.
     */
    if (start_time > 0 &&
       stat(filename, &statbuf) >= 0
       && statbuf.st_mtime >= start_time) {
       _nc_warning("name multiply defined.");
    }

    check_writeable(first_name[0]);
    write_file(filename, tp);

    if (start_time == 0) {
       if (stat(filename, &statbuf) < 0
           || (start_time = statbuf.st_mtime) == 0) {
           _nc_syserr_abort("error obtaining time from %s/%s",
                          _nc_tic_dir(0), filename);
       }
    }
    while (*other_names != '\0') {
       ptr = other_names++;
       while (*other_names != '|' && *other_names != '\0')
           other_names++;

       if (*other_names != '\0')
           *(other_names++) = '\0';

       if (strlen(ptr) > sizeof(linkname) - 3) {
           _nc_warning("terminal alias %s too long.", ptr);
           continue;
       }
       if (strchr(ptr, '/') != 0) {
           _nc_warning("cannot link alias %s.", ptr);
           continue;
       }

       check_writeable(ptr[0]);
       sprintf(linkname, "%c/%s", ptr[0], ptr);

       if (strcmp(filename, linkname) == 0) {
           _nc_warning("self-synonym ignored");
       } else if (stat(linkname, &statbuf) >= 0 &&
                 statbuf.st_mtime < start_time) {
           _nc_warning("alias %s multiply defined.", ptr);
       } else if (_nc_access(linkname, W_OK) == 0)
#if HAVE_LINK
       {
           int code;
#if USE_SYMLINKS
           strcpy(symlinkname, "../");
           strncat(symlinkname, filename, sizeof(symlinkname) - 4);
           symlinkname[sizeof(symlinkname) - 1] = '\0';
#endif /* USE_SYMLINKS */
#if HAVE_REMOVE
           code = remove(linkname);
#else
           code = unlink(linkname);
#endif
           if (code != 0 && errno == ENOENT)
              code = 0;
#if USE_SYMLINKS
           if (symlink(symlinkname, linkname) < 0)
#else
           if (link(filename, linkname) < 0)
#endif /* USE_SYMLINKS */
           {
              /*
               * If there wasn't anything there, and we cannot
               * link to the target because it is the same as the
               * target, then the source must be on a filesystem
               * that uses caseless filenames, such as Win32, etc.
               */
              if (code == 0 && errno == EEXIST)
                  _nc_warning("can't link %s to %s", filename, linkname);
              else if (code == 0 && (errno == EPERM || errno == ENOENT))
                  write_file(linkname, tp);
              else {
#if MIXEDCASE_FILENAMES
                  _nc_syserr_abort("can't link %s to %s", filename, linkname);
#else
                  _nc_warning("can't link %s to %s (errno=%d)", filename,
                            linkname, errno);
#endif
              }
           } else {
              DEBUG(1, ("Linked %s", linkname));
           }
       }
#else /* just make copies */
           write_file(linkname, tp);
#endif /* HAVE_LINK */
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void check_writeable ( int  code) [static]

Definition at line 161 of file write_entry.c.

{
    static const char dirnames[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
    static bool verified[sizeof(dirnames)];

    char dir[2];
    char *s = 0;

    if (code == 0 || (s = strchr(dirnames, code)) == 0)
       _nc_err_abort("Illegal terminfo subdirectory \"%c\"", code);

    if (verified[s - dirnames])
       return;

    dir[0] = code;
    dir[1] = '\0';
    if (make_directory(dir) < 0) {
       _nc_err_abort("%s/%s: permission denied", _nc_tic_dir(0), dir);
    }

    verified[s - dirnames] = TRUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static int compute_offsets ( char **  Strings,
unsigned  strmax,
short offsets 
) [static]

Definition at line 368 of file write_entry.c.

{
    size_t nextfree = 0;
    unsigned i;

    for (i = 0; i < strmax; i++) {
       if (Strings[i] == ABSENT_STRING) {
           offsets[i] = -1;
       } else if (Strings[i] == CANCELLED_STRING) {
           offsets[i] = -2;
       } else {
           offsets[i] = nextfree;
           nextfree += strlen(Strings[i]) + 1;
           TRACE_OUT(("put Strings[%d]=%s(%d)", i, _nc_visbuf(Strings[i]), nextfree));
       }
    }
    return nextfree;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void convert_shorts ( unsigned char *  buf,
short Numbers,
unsigned  count 
) [static]

Definition at line 388 of file write_entry.c.

{
    unsigned i;
    for (i = 0; i < count; i++) {
       if (Numbers[i] == ABSENT_NUMERIC) {       /* HI/LO won't work */
           buf[2 * i] = buf[2 * i + 1] = 0377;
       } else if (Numbers[i] == CANCELLED_NUMERIC) {    /* HI/LO won't work */
           buf[2 * i] = 0376;
           buf[2 * i + 1] = 0377;
       } else {
           LITTLE_ENDIAN(buf + 2 * i, Numbers[i]);
           TRACE_OUT(("put Numbers[%d]=%d", i, Numbers[i]));
       }
    }
}

Here is the caller graph for this function:

static int make_directory ( const char *  path) [static]

Definition at line 83 of file write_entry.c.

{
    int rc;
    struct stat statbuf;
    char fullpath[PATH_MAX];
    const char *destination = _nc_tic_dir(0);

    if (path == destination || *path == '/') {
       if (strlen(path) + 1 > sizeof(fullpath))
           return (-1);
       (void) strcpy(fullpath, path);
    } else {
       if (strlen(destination) + strlen(path) + 2 > sizeof(fullpath))
           return (-1);
       (void) sprintf(fullpath, "%s/%s", destination, path);
    }

    if ((rc = stat(path, &statbuf)) < 0) {
       rc = mkdir(path, 0777);
    } else {
       if (_nc_access(path, R_OK | W_OK | X_OK) < 0) {
           rc = -1;         /* permission denied */
       } else if (!(S_ISDIR(statbuf.st_mode))) {
           rc = -1;         /* not a directory */
       }
    }
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void write_file ( char *  filename,
TERMTYPE *  tp 
) [static]

Definition at line 62 of file write_entry.c.

{
    FILE *fp = (_nc_access(filename, W_OK) == 0) ? fopen(filename, "wb") : 0;
    if (fp == 0) {
       perror(filename);
       _nc_syserr_abort("can't open %s/%s", _nc_tic_dir(0), filename);
    }
    DEBUG(1, ("Created %s", filename));

    if (write_object(fp, tp) == ERR) {
       _nc_syserr_abort("error writing %s/%s", _nc_tic_dir(0), filename);
    }
    fclose(fp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

static int write_object ( FILE fp,
TERMTYPE *  tp 
) [static]

Definition at line 408 of file write_entry.c.

{
    char *namelist;
    size_t namelen, boolmax, nummax, strmax;
    char zero = '\0';
    size_t i;
    short nextfree;
    short offsets[MAX_ENTRY_SIZE / 2];
    unsigned char buf[MAX_ENTRY_SIZE];
    unsigned last_bool = BOOLWRITE;
    unsigned last_num = NUMWRITE;
    unsigned last_str = STRWRITE;

#if NCURSES_XNAMES
    /*
     * Normally we limit the list of values to exclude the "obsolete"
     * capabilities.  However, if we are accepting extended names, add
     * these as well, since they are used for supporting translation
     * to/from termcap.
     */
    if (_nc_user_definable) {
       last_bool = BOOLCOUNT;
       last_num = NUMCOUNT;
       last_str = STRCOUNT;
    }
#endif

    namelist = tp->term_names;
    namelen = strlen(namelist) + 1;

    boolmax = 0;
    for (i = 0; i < last_bool; i++) {
       if (tp->Booleans[i] == TRUE)
           boolmax = i + 1;
    }

    nummax = 0;
    for (i = 0; i < last_num; i++) {
       if (tp->Numbers[i] != ABSENT_NUMERIC)
           nummax = i + 1;
    }

    strmax = 0;
    for (i = 0; i < last_str; i++) {
       if (tp->Strings[i] != ABSENT_STRING)
           strmax = i + 1;
    }

    nextfree = compute_offsets(tp->Strings, strmax, offsets);

    /* fill in the header */
    LITTLE_ENDIAN(buf, MAGIC);
    LITTLE_ENDIAN(buf + 2, min(namelen, MAX_NAME_SIZE + 1));
    LITTLE_ENDIAN(buf + 4, boolmax);
    LITTLE_ENDIAN(buf + 6, nummax);
    LITTLE_ENDIAN(buf + 8, strmax);
    LITTLE_ENDIAN(buf + 10, nextfree);

    /* write out the header */
    TRACE_OUT(("Header of %s @%ld", namelist, ftell(fp)));
    if (fwrite(buf, 12, 1, fp) != 1
       || fwrite(namelist, sizeof(char), namelen, fp) != namelen)
         return (ERR);

    for (i = 0; i < boolmax; i++)
       if (tp->Booleans[i] == TRUE)
           buf[i] = TRUE;
       else
           buf[i] = FALSE;
    if (fwrite(buf, sizeof(char), boolmax, fp) != boolmax)
         return (ERR);

    if (even_boundary(namelen + boolmax))
       return (ERR);

    TRACE_OUT(("Numerics begin at %04lx", ftell(fp)));

    /* the numerics */
    convert_shorts(buf, tp->Numbers, nummax);
    if (fwrite(buf, 2, nummax, fp) != nummax)
       return (ERR);

    TRACE_OUT(("String offsets begin at %04lx", ftell(fp)));

    /* the string offsets */
    convert_shorts(buf, offsets, strmax);
    if (fwrite(buf, 2, strmax, fp) != strmax)
       return (ERR);

    TRACE_OUT(("String table begins at %04lx", ftell(fp)));

    /* the strings */
    for (i = 0; i < strmax; i++)
       if (VALID_STRING(tp->Strings[i]))
           if (!WRITE_STRING(tp->Strings[i]))
              return (ERR);

#if NCURSES_XNAMES
    if (NUM_EXT_NAMES(tp)) {
       unsigned extcnt = NUM_EXT_NAMES(tp);

       if (even_boundary(nextfree))
           return (ERR);

       nextfree = compute_offsets(tp->Strings + STRCOUNT, tp->ext_Strings, offsets);
       TRACE_OUT(("after extended string capabilities, nextfree=%d", nextfree));
       nextfree += compute_offsets(tp->ext_Names, extcnt, offsets + tp->ext_Strings);
       TRACE_OUT(("after extended capnames, nextfree=%d", nextfree));
       strmax = tp->ext_Strings + extcnt;

       /*
        * Write the extended header
        */
       LITTLE_ENDIAN(buf + 0, tp->ext_Booleans);
       LITTLE_ENDIAN(buf + 2, tp->ext_Numbers);
       LITTLE_ENDIAN(buf + 4, tp->ext_Strings);
       LITTLE_ENDIAN(buf + 6, strmax);
       LITTLE_ENDIAN(buf + 8, nextfree);
       TRACE_OUT(("WRITE extended-header @%ld", ftell(fp)));
       if (fwrite(buf, 10, 1, fp) != 1)
           return (ERR);

       TRACE_OUT(("WRITE %d booleans @%ld", tp->ext_Booleans, ftell(fp)));
       if (tp->ext_Booleans
           && fwrite(tp->Booleans + BOOLCOUNT, sizeof(char),
                    tp->ext_Booleans, fp) != tp->ext_Booleans)
             return (ERR);

       if (even_boundary(tp->ext_Booleans))
           return (ERR);

       TRACE_OUT(("WRITE %d numbers @%ld", tp->ext_Numbers, ftell(fp)));
       if (tp->ext_Numbers) {
           convert_shorts(buf, tp->Numbers + NUMCOUNT, tp->ext_Numbers);
           if (fwrite(buf, 2, tp->ext_Numbers, fp) != tp->ext_Numbers)
              return (ERR);
       }

       /*
        * Convert the offsets for the ext_Strings and ext_Names tables,
        * in that order.
        */
       convert_shorts(buf, offsets, strmax);
       TRACE_OUT(("WRITE offsets @%ld", ftell(fp)));
       if (fwrite(buf, 2, strmax, fp) != strmax)
           return (ERR);

       /*
        * Write the string table after the offset tables so we do not
        * have to do anything about alignment.
        */
       for (i = 0; i < tp->ext_Strings; i++) {
           if (VALID_STRING(tp->Strings[i + STRCOUNT])) {
              TRACE_OUT(("WRITE ext_Strings[%d]=%s", i,
                        _nc_visbuf(tp->Strings[i + STRCOUNT])));
              if (!WRITE_STRING(tp->Strings[i + STRCOUNT]))
                  return (ERR);
           }
       }

       /*
        * Write the extended names
        */
       for (i = 0; i < extcnt; i++) {
           TRACE_OUT(("WRITE ext_Names[%d]=%s", i, tp->ext_Names[i]));
           if (!WRITE_STRING(tp->ext_Names[i]))
              return (ERR);
       }

    }
#endif /* NCURSES_XNAMES */

    total_written++;
    return (OK);
}

Here is the call graph for this function:

Here is the caller graph for this function:


Variable Documentation

int total_written [static]

Definition at line 57 of file write_entry.c.