view liboctave/system/oct-time.cc @ 31605:e88a07dec498 stable

maint: Use macros to begin/end C++ namespaces. * oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE, OCTAVE_END_NAMESPACE) that can be used to start/end a namespace. * mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc, auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h, besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc, defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc, display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc, ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h, event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc, fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc, help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h, interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc, latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h, lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc, ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h, mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc, oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h, oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc, pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc, sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc, variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h, __delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh, mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h, cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h, cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc, op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc, op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h, anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h, comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc, oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h, pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h, pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h, pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h, pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc, pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h, range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc, chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h, oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h, oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc, qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc, randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc, sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc, child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc, file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h, mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h, oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h, file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc, lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h, oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h, oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h, oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h, pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h, url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author Rik <rik@octave.org>
date Thu, 01 Dec 2022 14:23:45 -0800
parents 243b51ec9ff0
children aac27ad79be6
line wrap: on
line source

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1999-2022 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if defined (HAVE_CONFIG_H)
#  include "config.h"
#endif

#include <cmath>
#include <ctime>

#include <iomanip>
#include <limits>
#include <ostream>

#if defined (OCTAVE_USE_WINDOWS_API)
#  include <windows.h>
#endif

#include "lo-error.h"
#include "lo-utils.h"
#include "lo-sysdep.h"
#include "oct-locbuf.h"
#include "oct-time.h"
#include "octave-preserve-stream-state.h"
#include "strftime-wrapper.h"
#include "strptime-wrapper.h"
#include "time-wrappers.h"

OCTAVE_BEGIN_NAMESPACE(octave)

OCTAVE_BEGIN_NAMESPACE(sys)

    time::time (double d)
      : m_ot_unix_time (static_cast<OCTAVE_TIME_T> (d)), m_ot_usec (0)
    {
      double ip;
      m_ot_usec = static_cast<int> (std::modf (d, &ip) * 1e6);
    }

    time::time (const base_tm& tm)
      : m_ot_unix_time (), m_ot_usec ()
    {
      struct ::tm t;

      t.tm_sec = tm.sec ();
      t.tm_min = tm.min ();
      t.tm_hour = tm.hour ();
      t.tm_mday = tm.mday ();
      t.tm_mon = tm.mon ();
      t.tm_year = tm.year ();
      t.tm_wday = tm.wday ();
      t.tm_yday = tm.yday ();
      t.tm_isdst = tm.isdst ();

#if defined (HAVE_TM_GMTOFF)
      t.tm_gmtoff = tm.gmtoff ();
#endif

#if defined (HAVE_STRUCT_TM_TM_ZONE)
      std::string s = tm.zone ();
      char *ps = strsave (s.c_str ());
      t.tm_zone = ps;
#endif

      m_ot_unix_time = octave_mktime_wrapper (&t);

#if defined (HAVE_STRUCT_TM_TM_ZONE)
      delete [] ps;
#endif

      m_ot_usec = tm.usec ();
    }

    std::string
    time::ctime (void) const
    {
      return localtime (*this).asctime ();
    }

    std::ostream&
    operator << (std::ostream& os, const time& ot)
    {
      preserve_stream_state stream_state (os);

      os << ot.m_ot_unix_time << '.'
         << std::setw (6) << std::setfill ('0') << ot.m_ot_usec;

      return os;
    }

    void
    time::stamp (void)
    {
      time_t ot_unix_time;
      octave_gettimeofday_wrapper (&ot_unix_time, &m_ot_usec);
      m_ot_unix_time = ot_unix_time;
    }

    // From the mktime() manual page:
    //
    //     The mktime() function converts a broken-down time structure,
    //     expressed as local time, to calendar time representation.
    //
    //     <snip>
    //
    //     If structure members are outside their legal interval, they
    //     will be normalized (so that, e.g., 40 October is changed into
    //     9 November).
    //
    // So, we no longer check limits here.

#define DEFINE_SET_FIELD_FCN(type, f, lo, hi)   \
    base_tm&                                    \
    base_tm::f (type v)                         \
    {                                           \
      m_ ## f = v;                              \
                                                \
      return *this;                             \
    }

#define DEFINE_SET_INT_FIELD_FCN(f, lo, hi)     \
    DEFINE_SET_FIELD_FCN (int, f, lo, hi)

    DEFINE_SET_INT_FIELD_FCN (usec, 0, 1000000)
    DEFINE_SET_INT_FIELD_FCN (sec, 0, 61)
    DEFINE_SET_INT_FIELD_FCN (min, 0, 59)
    DEFINE_SET_INT_FIELD_FCN (hour, 0, 23)
    DEFINE_SET_INT_FIELD_FCN (mday, 1, 31)
    DEFINE_SET_INT_FIELD_FCN (mon, 0, 11)
    DEFINE_SET_INT_FIELD_FCN (year, std::numeric_limits<int>::min (),
                              std::numeric_limitd<int>::max ())
    DEFINE_SET_INT_FIELD_FCN (wday, 0, 6)
    DEFINE_SET_INT_FIELD_FCN (yday, 0, 365)
    DEFINE_SET_INT_FIELD_FCN (isdst, 0, 1)
    DEFINE_SET_FIELD_FCN (long, gmtoff, -86400, 0)

    base_tm&
    base_tm::zone (const std::string& s)
    {
      m_zone = s;
      return *this;
    }

#if ! defined STRFTIME_BUF_INITIAL_SIZE
#  define STRFTIME_BUF_INITIAL_SIZE 128
#endif

    std::string
    base_tm::strftime (const std::string& fmt) const
    {
      std::string retval;

      if (! fmt.empty ())
        {
          struct ::tm t;

          t.tm_sec = m_sec;
          t.tm_min = m_min;
          t.tm_hour = m_hour;
          t.tm_mday = m_mday;
          t.tm_mon = m_mon;
          t.tm_year = m_year;
          t.tm_wday = m_wday;
          t.tm_yday = m_yday;
          t.tm_isdst = m_isdst;

#if defined (HAVE_TM_GMTOFF)
          t.tm_gmtoff = m_gmtoff;
#endif

#if defined (HAVE_STRUCT_TM_TM_ZONE)
          char *ps = strsave (m_zone.c_str ());
          t.tm_zone = ps;
#endif

          const char *fmt_str = fmt.c_str ();

          char *buf = nullptr;
          std::size_t bufsize = STRFTIME_BUF_INITIAL_SIZE;
          std::size_t chars_written = 0;

          while (chars_written == 0)
            {
              delete [] buf;
              buf = new char [bufsize];
              buf[0] = '\0';

              chars_written
                = octave_strftime_wrapper (buf, bufsize, fmt_str, &t);

              bufsize *= 2;
            }

#if defined (HAVE_STRUCT_TM_TM_ZONE)
          delete [] ps;
#endif

          retval = buf;

          delete [] buf;
        }

      return retval;
    }

    void
    base_tm::init (void *p)
    {
      if (! p)
        return;

      struct ::tm *t = static_cast<struct ::tm *> (p);

      m_sec = t->tm_sec;
      m_min = t->tm_min;
      m_hour = t->tm_hour;
      m_mday = t->tm_mday;
      m_mon = t->tm_mon;
      m_year = t->tm_year;
      m_wday = t->tm_wday;
      m_yday = t->tm_yday;
      m_isdst = t->tm_isdst;

#if defined (HAVE_TM_GMTOFF)
      m_gmtoff = t->tm_gmtoff;
#elif defined (OCTAVE_USE_WINDOWS_API)
      TIME_ZONE_INFORMATION tzi;

      GetTimeZoneInformationForYear (m_year, nullptr, &tzi);

      if (m_isdst)
        m_gmtoff = -60 * (tzi.Bias + tzi.DaylightBias);
      else
        m_gmtoff = -60 * (tzi.Bias + tzi.StandardBias);
#endif

#if defined (HAVE_STRUCT_TM_TM_ZONE)
      if (t->tm_zone)
        m_zone = t->tm_zone;
#elif defined (OCTAVE_USE_WINDOWS_API)
      if (m_isdst)
        m_zone = sys::u8_from_wstring (tzi.DaylightName);
      else
        m_zone = sys::u8_from_wstring (tzi.StandardName);
#elif defined (HAVE_TZNAME)
      if (t->tm_isdst == 0 || t->tm_isdst == 1)
        m_zone = tzname[t->tm_isdst];
#endif
    }

    void
    localtime::init (const time& ot)
    {
      m_usec = ot.usec ();

      time_t t = ot.unix_time ();

      base_tm::init (std::localtime (&t));
    }

    void
    gmtime::init (const time& ot)
    {
      m_usec = ot.usec ();

      time_t t = ot.unix_time ();

      base_tm::init (std::gmtime (&t));
    }

    void
    strptime::init (const std::string& str, const std::string& fmt)
    {
      struct ::tm t;

      t.tm_sec = 0;
      t.tm_min = 0;
      t.tm_hour = 0;
      t.tm_mday = 0;
      t.tm_mon = -1;
      t.tm_year = std::numeric_limits<int>::min ();
      t.tm_wday = 0;
      t.tm_yday = 0;
      t.tm_isdst = 0;

#if defined (HAVE_TM_GMTOFF)
      t.tm_gmtoff = 0;
#endif

#if defined (HAVE_STRUCT_TM_TM_ZONE)
      char *ps = strsave ("");
      t.tm_zone = ps;
#endif

      const char *p = str.c_str ();

      char *q = octave_strptime_wrapper (p, fmt.c_str (), &t);

      // Fill in wday and yday, but only if mday is valid and the mon and year
      // are filled in, avoiding issues with mktime and invalid dates.
      if (t.tm_mday != 0 && t.tm_mon >= 0
          && t.tm_year != std::numeric_limits<int>::min ())
        {
          t.tm_isdst = -1;
          octave_mktime_wrapper (&t);
        }

      if (t.tm_mon < 0)
        t.tm_mon = 0;

      if (t.tm_year == std::numeric_limits<int>::min ())
        t.tm_year = 0;

      if (q)
        m_nchars = q - p + 1;
      else
        m_nchars = 0;

      base_tm::init (&t);

#if defined (HAVE_STRUCT_TM_TM_ZONE)
      delete [] ps;
#endif
    }

    void
    cpu_time::stamp (void)
    {
      time_t usr_sec, sys_sec;
      octave_cpu_time (&usr_sec, &sys_sec, &m_usr_usec, &m_sys_usec);
      m_usr_sec = usr_sec;
      m_sys_sec = sys_sec;
    }

    void
    resource_usage::stamp (void)
    {
      time_t usr_sec, sys_sec;
      long usr_usec, sys_usec;

      octave_getrusage_wrapper (&usr_sec, &sys_sec, &usr_usec,
                                &sys_usec, &m_maxrss, &m_ixrss,
                                &m_idrss, &m_isrss, &m_minflt,
                                &m_majflt, &m_nswap, &m_inblock,
                                &m_oublock, &m_msgsnd, &m_msgrcv,
                                &m_nsignals, &m_nvcsw, &m_nivcsw);

      m_cpu = cpu_time (usr_sec, sys_sec, usr_usec, sys_usec);
    }

OCTAVE_END_NAMESPACE(sys)
OCTAVE_END_NAMESPACE(octave)