time.c

Go to the documentation of this file.

/**
 * @file time.c
 * @brief Contains time-related functions: mtime(), convert_date_time(), mtimes().
 *
 * @copyright 
 *   - (c) 2002 The University of Chicago, as Operator of Argonne National Laboratory.
 *   - (c) 2002 The Regents of the University of California, as Operator of Los Alamos National Laboratory.
 *
 * @license 
 * This file is distributed under the terms of the Software License Agreement
 * found in the file LICENSE included with this distribution.
 *
 * @author M. Borland, C. Saunders, R. Soliday
 */
#include "mdb.h"
#include "time_utils.h"
#include <ctype.h>
#include <time.h>
 
#ifdef VAX_VMS
 
static const char *const month[12] = {
  "january", "february", "march",
  "april", "may", "june", "july",
  "august", "september", "october",
  "november", "december"};
 
/**
 * @brief Converts a time string into a DATE_TIME structure.
 *
 * The input should have the format "day month year hours:minutes" with the
 * month written out (e.g., "June" rather than "6").
 *
 * @param dt Pointer to the DATE_TIME structure to populate.
 * @param ct0 String containing the time specification.
 * @return 1 on success, 0 on failure, or NO_TIME if the format is invalid.
 */
 
convert_date_time(dt, ct0)
  DATE_TIME *dt;
  char *ct0;
{
  register char *ptr, *ct;
  register long i, l;
 
  /* copy the string */
  cp_str(&ct, ct0);
 
  /* shift everything to lower case */
  ptr = ct;
  while (*ptr) {
    *ptr = tolower(*ptr);
    ptr++;
  }
 
  /* scan the day */
  if (!get_long(&(dt->day), ct))
    return (0);
 
  /* scan the month */
  ptr = get_token(ct);
  l = strlen(ptr);
  for (i = 0; i < 12; i++)
    if (strncmp(ptr, month[i], l) == 0)
      break;
  if (i == 12)
    return (0);
  dt->month = i + 1;
 
  if (!get_long(&(dt->year), ct))
    return (0);
  if (dt->year < 100)
    dt->year += 1900;
 
  dt->hrs = 0;
  dt->mins = 0;
  dt->secs = 0;
  while (*ct == ' ' && *ct)
    ct++;
  if (sscanf(ct, "%ld:%ld", &(dt->hrs), &(dt->mins)) != 2)
    return (NO_TIME);
 
  return (1);
}
#endif
 
static const char *const MonthAbbreviation[12] = {
  "Jan", "Feb", "Mar", "Apr", "May", "Jun",
  "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
 
/**
 * @brief Generates a formatted time string.
 *
 * This function returns a compact local time string.
 * 
 * **Format Comparison:**
 * - `ctime`: "wkd mmm dd hh:mm:ss 19yy\n"
 * - `mtime`: "dd mmm yy hh:mm"
 *
 * @return A pointer to the newly allocated formatted time string.
 */
char *mtime(void) {
  char *mt;
  struct tm timeBreakdown;
  time_t i;
 
  while ((mt = tmalloc((unsigned)30 * sizeof(*mt))) == NULL)
    puts("allocation failure in mtime()");
  time(&i);
  if (!mdb_localtime_copy(&i, &timeBreakdown)) {
    mt[0] = 0;
    return mt;
  }
 
  sprintf(mt, "%d %s %02d %02d:%02d",
          timeBreakdown.tm_mday,
          MonthAbbreviation[timeBreakdown.tm_mon],
          (timeBreakdown.tm_year + 1900) % 100,
          timeBreakdown.tm_hour,
          timeBreakdown.tm_min);
  return (mt);
}
 
/**
 * @brief Generates a detailed formatted time string.
 *
 * This function returns a compact local time string including seconds.
 * 
 * **Format Comparison:**
 * - `ctime`: "wkd mmm dd hh:mm:ss 19yy\n"
 * - `mtimes`: "dd mmm yy hh:mm:ss"
 *
 * @return A pointer to the newly allocated detailed formatted time string.
 */
char *mtimes(void) {
  char *mt;
  struct tm timeBreakdown;
  time_t i;
 
  while ((mt = tmalloc((unsigned)30 * sizeof(*mt))) == NULL)
    puts("allocation failure in mtime()");
  time(&i);
  if (!mdb_localtime_copy(&i, &timeBreakdown)) {
    mt[0] = 0;
    return mt;
  }
 
  sprintf(mt, "%d %s %02d %02d:%02d:%02d",
          timeBreakdown.tm_mday,
          MonthAbbreviation[timeBreakdown.tm_mon],
          (timeBreakdown.tm_year + 1900) % 100,
          timeBreakdown.tm_hour,
          timeBreakdown.tm_min,
          timeBreakdown.tm_sec);
  return (mt);
}