time_util.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef TIME_UTIL_H
#define TIME_UTIL_H
 
#include <time.h>
 
#include "typedefs.h"
#include "grassroots_util_library.h"
 
 
#ifdef __cplusplus
extern "C" 
{
#endif
 
 
GRASSROOTS_UTIL_API bool ConvertCompactStringToTime (const char * const time_s, struct tm *time_p, int *offset_p);
 
 
GRASSROOTS_UTIL_API bool ConvertCompactStringToEpochTime (const char * const time_s, time_t *time_p);
 
 
 
GRASSROOTS_UTIL_API bool ConvertDropboxStringToTime (const char * const time_s, struct tm *time_p, int *offset_p);
 
 
GRASSROOTS_UTIL_API bool ConvertDropboxStringToEpochTime (const char * const time_s, time_t *time_p);
 
 
 
GRASSROOTS_UTIL_API bool GetPresentTime (struct tm *tm_p);
 
 
 
GRASSROOTS_UTIL_API char *GetTimeAsString (const struct tm * const time_p, const bool include_time_flag, const char *time_delimiter_p);
 
GRASSROOTS_UTIL_API void FreeTimeString (char *time_s);
 
 
GRASSROOTS_UTIL_API bool SetTimeFromString (struct tm * const time_p, const char *time_s);
 
 
 
GRASSROOTS_UTIL_API bool SetTimeFromDDMMYYYYString (struct tm * const time_p, const char *time_s);
 
 
 
GRASSROOTS_UTIL_API struct tm *GetTimeFromString (const char *time_s);
 
 
GRASSROOTS_UTIL_API void AddIntervalToTime (struct tm *time_p, const int days);
 
 
GRASSROOTS_UTIL_API struct tm *AllocateTime (void);
 
 
GRASSROOTS_UTIL_API void FreeTime (struct tm *time_p);
 
 
GRASSROOTS_UTIL_API void CopyTime (const struct tm *src_p, struct tm *dest_p);
 
GRASSROOTS_UTIL_API struct tm *DuplicateTime (const struct tm *src_p);
 
 
GRASSROOTS_UTIL_API void SetDateValuesForTime (struct tm *time_p, const int year, const int month, const int day);
 
 
GRASSROOTS_UTIL_API void ClearTime (struct tm *time_p);
 
 
GRASSROOTS_UTIL_API bool IsValidDate (struct tm *time_p);
 
 
GRASSROOTS_UTIL_API int CompareDates (const struct tm *time_0_p, const struct tm *time_1_p, const bool dates_only_flag);
 
 
 
GRASSROOTS_UTIL_API bool MayStringIncludeTime (const char * const time_s);
 
 
GRASSROOTS_UTIL_API void FreeTimeArray (struct tm **values_pp, const size_t num_values);
 
#ifdef __cplusplus
}
#endif
 
 
#endif    /* #ifndef TIME_UTIL_H */