pantheios/util/time/currenttime.h

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        pantheios/util/time/currenttime.h
 *
 * Purpose:     Functions for retrieving and formatting the current time.
 *
 * Created:     22nd August 2006
 * Updated:     10th August 2009
 *
 * Home:        http://www.pantheios.org/
 *
 * Copyright (c) 2006-2009, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the
 *   names of any contributors may be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ////////////////////////////////////////////////////////////////////// */


#ifndef PANTHEIOS_INCL_PANTHEIOS_UTIL_TIME_H_CURRENTTIME
#define PANTHEIOS_INCL_PANTHEIOS_UTIL_TIME_H_CURRENTTIME

/* /////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
# define PANTHEIOS_VER_PANTHEIOS_UTIL_TIME_H_CURRENTTIME_MAJOR      2
# define PANTHEIOS_VER_PANTHEIOS_UTIL_TIME_H_CURRENTTIME_MINOR      1
# define PANTHEIOS_VER_PANTHEIOS_UTIL_TIME_H_CURRENTTIME_REVISION   1
# define PANTHEIOS_VER_PANTHEIOS_UTIL_TIME_H_CURRENTTIME_EDIT       18
#endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

#ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
# include <pantheios/pantheios.h>
#endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */

/* /////////////////////////////////////////////////////////////////////////
 * Typedefs
 */

struct pan_beutil_time_t
{
#if !defined(PANTHEIOS_NO_NAMESPACE) && \
    !defined(PANTHEIOS_DOCUMENTATION_SKIP_SECTION)
    typedef ::pantheios::pan_char_t pan_char_t;
#endif /* !PANTHEIOS_NO_NAMESPACE */

    size_t              capacity;       
    size_t              len;            
    pan_char_t*         str;            
    pan_char_t const*   strftimeFmt;    
#ifdef __cplusplus

    pan_beutil_time_t(size_t cap, pan_char_t* s, pan_char_t const* f = NULL)
        : capacity(cap)
        , len(0)
        , str(s)
        , strftimeFmt(f)
    {}
#endif /* __cplusplus */
};
#ifndef __cplusplus
typedef struct pan_beutil_time_t pan_beutil_time_t;
#endif /* !__cplusplus */

/* /////////////////////////////////////////////////////////////////////////
 * Constants & definitions
 */

#define PANTHEIOS_GETCURRENTTIME_F_USE_SYSTEM_TIME          (0x00000001)

#define PANTHEIOS_GETCURRENTTIME_F_USE_UNIX_FORMAT          (0x00000002)

#define PANTHEIOS_GETCURRENTTIME_F_HIDE_DATE                (0x00000010)

#define PANTHEIOS_GETCURRENTTIME_F_HIDE_TIME                (0x00000020)

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_SECONDS         (0x00000000)

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_TENTHS          (0x00000100)

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_HUNDREDTHS      (0x00000200)

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MILLISECS       (0x00000300)

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MICROSECS       (0x00000600)

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MAX             PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MICROSECS

#define PANTHEIOS_GETCURRENTTIME_F_TIME_RES_MASK            (0x00000f00)

#define PANTHEIOS_GETCURRENTTIME_F_FAVOUR_SPEED             (0x00001000)

#define PANTHEIOS_GETCURRENTTIME_F_FAVOUR_ACCURACY          (0x00002000)

/* /////////////////////////////////////////////////////////////////////////
 * Functions
 */

PANTHEIOS_CALL(size_t) pantheios_util_getCurrentTime(pan_beutil_time_t* tm, int flags);

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

#endif /* !PANTHEIOS_INCL_PANTHEIOS_UTIL_TIME_H_CURRENTTIME */

/* ///////////////////////////// end of file //////////////////////////// */

pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011