date.h

Go to the documentation of this file.

/*
 * date.h
 *
 * Copyright (c) 2003,2010 Thomas A. Vaughan
 * 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 of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 *
 * Basic date functions.  The fact that I have to write these is ridiculous.
 */

#ifndef WAVEPACKET_UTIL_DATE_H__
#define WAVEPACKET_UTIL_DATE_H__


// includes --------------------------------------------------------------------
#include "common/common.h"


/// \ingroup util
/*@{*/

/*
 * Get numeric value for month string (1-12, 0 on error)
 */
int GetMonthFromString(IN const char * month) throw();


/*
 * Get string displayable date
 */
void getDisplayableDateFromNetTime(IN long time, OUT std::string& display);
const char * getDateString(IN long timestamp);
void getDateStringFromNetTime(IN long time, OUT std::string& display);
long getNetTimeFromDateString(IN const char * date) throw();

/*
 * Get day-of-week index (0 = Sunday, 1 = Monday, 2 = Tuesday, etc.)
 */
int getWeekdayFromNetTime(IN long time) throw();
const char * GetWeekday(IN int weekday_index) throw();
const char * GetMonth(IN int month_index) throw();


/*
 * time buckets
 *
 * NOTE: buckets using GMT, not PST or any other timezone!
 */

long getDayBucket(IN long timestamp) throw();
long getWeekBucket(IN long timestamp) throw();
long getMonthBucket(IN long timestamp) throw();
long getYearBucket(IN long timestamp) throw();

std::string getDayBucketName(IN long day_bucket);
std::string getWeekBucketName(IN long week_bucket);
std::string getMonthBucketName(IN long month_bucket);
std::string getYearBucketName(IN long year_bucket);

#endif  // WAVEPACKET_UTIL_DATE_H__