/*

Copyright (C) 2017 LiveCode Ltd.

This file is part of LiveCode.

LiveCode is free software; you can redistribute it and/or modify it under

the terms of the GNU General Public License v3 as published by the Free

Software Foundation.

LiveCode 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 LiveCode. If not see <http://www.gnu.org/licenses/>. */

/**

This library provides access to the tz timezone database

Tags: DateTime, Library

*/

library com.livecode.library.timezone

metadata version is "1.0.0"

metadata author is "LiveCode"

metadata title is "Time zone Library"

use com.livecode.engine

use com.livecode.foreign

public foreign type TimeStruct binds to "MCAggregateTypeInfo:EEEEEEEEE"

public type Time is UInt64

foreign handler TimeZoneSetLocale(in pName as ZStringNative) returns nothing \

binds to "tz>tzsetlcl"

foreign handler TimeFromLocalTimeStruct(inout pStruct as TimeStruct) returns Time \

binds to "tz>mktime_tz"

foreign handler GMTimeStruct(inout pTime as Time, out pStruct as TimeStruct) returns Pointer \

binds to "tz>gmtime_r"

foreign handler LocalTimeStruct(inout pTime as Time, out rStruct as TimeStruct) returns Pointer \

binds to "tz>localtime_r"

foreign handler SetTZDataDir(in pDir as ZStringNative) returns CBool \

binds to "tz>tzsetdir"

private variable mInited as Boolean

handler __DataDir() returns String

return my resources folder & "/zoneinfo"

end handler

handler __EnsureDataDir()

if mInited then

return

end if

unsafe

if not SetTZDataDir(__DataDir()) then

throw "Unable to set data folder"

else

put true into mInited

end if

end unsafe

end handler

constant kTimeZones is [ \

"Africa/Abidjan", \

"Africa/Accra", \

"Africa/Addis_Ababa", \

"Africa/Algiers", \

"Africa/Asmara", \

"Africa/Asmera", \

"Africa/Bamako", \

"Africa/Bangui", \

"Africa/Banjul", \

"Africa/Bissau", \

"Africa/Blantyre", \

"Africa/Brazzaville", \

"Africa/Bujumbura", \

"Africa/Cairo", \

"Africa/Casablanca", \

"Africa/Ceuta", \

"Africa/Conakry", \

"Africa/Dakar", \

"Africa/Dar_es_Salaam", \

"Africa/Djibouti", \

"Africa/Douala", \

"Africa/El_Aaiun", \

"Africa/Freetown", \

"Africa/Gaborone", \

"Africa/Harare", \

"Africa/Johannesburg", \

"Africa/Juba", \

"Africa/Kampala", \

"Africa/Khartoum", \

"Africa/Kigali", \

"Africa/Kinshasa", \

"Africa/Lagos", \

"Africa/Libreville", \

"Africa/Lome", \

"Africa/Luanda", \

"Africa/Lubumbashi", \

"Africa/Lusaka", \

"Africa/Malabo", \

"Africa/Maputo", \

"Africa/Maseru", \

"Africa/Mbabane", \

"Africa/Mogadishu", \

"Africa/Monrovia", \

"Africa/Nairobi", \

"Africa/Ndjamena", \

"Africa/Niamey", \

"Africa/Nouakchott", \

"Africa/Ouagadougou", \

"Africa/Porto-Novo", \

"Africa/Sao_Tome", \

"Africa/Timbuktu", \

"Africa/Tripoli", \

"Africa/Tunis", \

"Africa/Windhoek", \

"America/Adak", \

"America/Anchorage", \

"America/Anguilla", \

"America/Antigua", \

"America/Araguaina", \

"America/Argentina/Buenos_Aires", \

"America/Argentina/Catamarca", \

"America/Argentina/ComodRivadavia", \

"America/Argentina/Cordoba", \

"America/Argentina/Jujuy", \

"America/Argentina/La_Rioja", \

"America/Argentina/Mendoza", \

"America/Argentina/Rio_Gallegos", \

"America/Argentina/Salta", \

"America/Argentina/San_Juan", \

"America/Argentina/San_Luis", \

"America/Argentina/Tucuman", \

"America/Argentina/Ushuaia", \

"America/Aruba", \

"America/Asuncion", \

"America/Atikokan", \

"America/Atka", \

"America/Bahia", \

"America/Bahia_Banderas", \

"America/Barbados", \

"America/Belem", \

"America/Belize", \

"America/Blanc-Sablon", \

"America/Boa_Vista", \

"America/Bogota", \

"America/Boise", \

"America/Buenos_Aires", \

"America/Cambridge_Bay", \

"America/Campo_Grande", \

"America/Cancun", \

"America/Caracas", \

"America/Catamarca", \

"America/Cayenne", \

"America/Cayman", \

"America/Chicago", \

"America/Chihuahua", \

"America/Coral_Harbour", \

"America/Cordoba", \

"America/Costa_Rica", \

"America/Creston", \

"America/Cuiaba", \

"America/Curacao", \

"America/Danmarkshavn", \

"America/Dawson", \

"America/Dawson_Creek", \

"America/Denver", \

"America/Detroit", \

"America/Dominica", \

"America/Edmonton", \

"America/Eirunepe", \

"America/El_Salvador", \

"America/Ensenada", \

"America/Fort_Nelson", \

"America/Fort_Wayne", \

"America/Fortaleza", \

"America/Glace_Bay", \

"America/Godthab", \

"America/Goose_Bay", \

"America/Grand_Turk", \

"America/Grenada", \

"America/Guadeloupe", \

"America/Guatemala", \

"America/Guayaquil", \

"America/Guyana", \

"America/Halifax", \

"America/Havana", \

"America/Hermosillo", \

"America/Indiana/Indianapolis", \

"America/Indiana/Knox", \

"America/Indiana/Marengo", \

"America/Indiana/Petersburg", \

"America/Indiana/Tell_City", \

"America/Indiana/Vevay", \

"America/Indiana/Vincennes", \

"America/Indiana/Winamac", \

"America/Indianapolis", \

"America/Inuvik", \

"America/Iqaluit", \

"America/Jamaica", \

"America/Jujuy", \

"America/Juneau", \

"America/Kentucky/Louisville", \

"America/Kentucky/Monticello", \

"America/Knox_IN", \

"America/Kralendijk", \

"America/La_Paz", \

"America/Lima", \

"America/Los_Angeles", \

"America/Louisville", \

"America/Lower_Princes", \

"America/Maceio", \

"America/Managua", \

"America/Manaus", \

"America/Marigot", \

"America/Martinique", \

"America/Matamoros", \

"America/Mazatlan", \

"America/Mendoza", \

"America/Menominee", \

"America/Merida", \

"America/Metlakatla", \

"America/Mexico_City", \

"America/Miquelon", \

"America/Moncton", \

"America/Monterrey", \

"America/Montevideo", \

"America/Montreal", \

"America/Montserrat", \

"America/Nassau", \

"America/New_York", \

"America/Nipigon", \

"America/Nome", \

"America/Noronha", \

"America/North_Dakota/Beulah", \

"America/North_Dakota/Center", \

"America/North_Dakota/New_Salem", \

"America/Ojinaga", \

"America/Panama", \

"America/Pangnirtung", \

"America/Paramaribo", \

"America/Phoenix", \

"America/Port-au-Prince", \

"America/Port_of_Spain", \

"America/Porto_Acre", \

"America/Porto_Velho", \

"America/Puerto_Rico", \

"America/Punta_Arenas", \

"America/Rainy_River", \

"America/Rankin_Inlet", \

"America/Recife", \

"America/Regina", \

"America/Resolute", \

"America/Rio_Branco", \

"America/Rosario", \

"America/Santa_Isabel", \

"America/Santarem", \

"America/Santiago", \

"America/Santo_Domingo", \

"America/Sao_Paulo", \

"America/Scoresbysund", \

"America/Shiprock", \

"America/Sitka", \

"America/St_Barthelemy", \

"America/St_Johns", \

"America/St_Kitts", \

"America/St_Lucia", \

"America/St_Thomas", \

"America/St_Vincent", \

"America/Swift_Current", \

"America/Tegucigalpa", \

"America/Thule", \

"America/Thunder_Bay", \

"America/Tijuana", \

"America/Toronto", \

"America/Tortola", \

"America/Vancouver", \

"America/Virgin", \

"America/Whitehorse", \

"America/Winnipeg", \

"America/Yakutat", \

"America/Yellowknife", \

"Antarctica/Casey", \

"Antarctica/Davis", \

"Antarctica/DumontDUrville", \

"Antarctica/Macquarie", \

"Antarctica/Mawson", \

"Antarctica/McMurdo", \

"Antarctica/Palmer", \

"Antarctica/Rothera", \

"Antarctica/South_Pole", \

"Antarctica/Syowa", \

"Antarctica/Troll", \

"Antarctica/Vostok", \

"Arctic/Longyearbyen", \

"Asia/Aden", \

"Asia/Almaty", \

"Asia/Amman", \

"Asia/Anadyr", \

"Asia/Aqtau", \

"Asia/Aqtobe", \

"Asia/Ashgabat", \

"Asia/Ashkhabad", \

"Asia/Atyrau", \

"Asia/Baghdad", \

"Asia/Bahrain", \

"Asia/Baku", \

"Asia/Bangkok", \

"Asia/Barnaul", \

"Asia/Beirut", \

"Asia/Bishkek", \

"Asia/Brunei", \

"Asia/Calcutta", \

"Asia/Chita", \

"Asia/Choibalsan", \

"Asia/Chongqing", \

"Asia/Chungking", \

"Asia/Colombo", \

"Asia/Dacca", \

"Asia/Damascus", \

"Asia/Dhaka", \

"Asia/Dili", \

"Asia/Dubai", \

"Asia/Dushanbe", \

"Asia/Famagusta", \

"Asia/Gaza", \

"Asia/Harbin", \

"Asia/Hebron", \

"Asia/Ho_Chi_Minh", \

"Asia/Hong_Kong", \

"Asia/Hovd", \

"Asia/Irkutsk", \

"Asia/Istanbul", \

"Asia/Jakarta", \

"Asia/Jayapura", \

"Asia/Jerusalem", \

"Asia/Kabul", \

"Asia/Kamchatka", \

"Asia/Karachi", \

"Asia/Kashgar", \

"Asia/Kathmandu", \

"Asia/Katmandu", \

"Asia/Khandyga", \

"Asia/Kolkata", \

"Asia/Krasnoyarsk", \

"Asia/Kuala_Lumpur", \

"Asia/Kuching", \

"Asia/Kuwait", \

"Asia/Macao", \

"Asia/Macau", \

"Asia/Magadan", \

"Asia/Makassar", \

"Asia/Manila", \

"Asia/Muscat", \

"Asia/Nicosia", \

"Asia/Novokuznetsk", \

"Asia/Novosibirsk", \

"Asia/Omsk", \

"Asia/Oral", \

"Asia/Phnom_Penh", \

"Asia/Pontianak", \

"Asia/Pyongyang", \

"Asia/Qatar", \

"Asia/Qyzylorda", \

"Asia/Rangoon", \

"Asia/Riyadh", \

"Asia/Saigon", \

"Asia/Sakhalin", \

"Asia/Samarkand", \

"Asia/Seoul", \

"Asia/Shanghai", \

"Asia/Singapore", \

"Asia/Srednekolymsk", \

"Asia/Taipei", \

"Asia/Tashkent", \

"Asia/Tbilisi", \

"Asia/Tehran", \

"Asia/Tel_Aviv", \

"Asia/Thimbu", \

"Asia/Thimphu", \

"Asia/Tokyo", \

"Asia/Tomsk", \

"Asia/Ujung_Pandang", \

"Asia/Ulaanbaatar", \

"Asia/Ulan_Bator", \

"Asia/Urumqi", \

"Asia/Ust-Nera", \

"Asia/Vientiane", \

"Asia/Vladivostok", \

"Asia/Yakutsk", \

"Asia/Yangon", \

"Asia/Yekaterinburg", \

"Asia/Yerevan", \

"Atlantic/Azores", \

"Atlantic/Bermuda", \

"Atlantic/Canary", \

"Atlantic/Cape_Verde", \

"Atlantic/Faeroe", \

"Atlantic/Faroe", \

"Atlantic/Jan_Mayen", \

"Atlantic/Madeira", \

"Atlantic/Reykjavik", \

"Atlantic/South_Georgia", \

"Atlantic/St_Helena", \

"Atlantic/Stanley", \

"Australia/ACT", \

"Australia/Adelaide", \

"Australia/Brisbane", \

"Australia/Broken_Hill", \

"Australia/Canberra", \

"Australia/Currie", \

"Australia/Darwin", \

"Australia/Eucla", \

"Australia/Hobart", \

"Australia/LHI", \

"Australia/Lindeman", \

"Australia/Lord_Howe", \

"Australia/Melbourne", \

"Australia/North", \

"Australia/NSW", \

"Australia/Perth", \

"Australia/Queensland", \

"Australia/South", \

"Australia/Sydney", \

"Australia/Tasmania", \

"Australia/Victoria", \

"Australia/West", \

"Australia/Yancowinna", \

"Brazil/Acre", \

"Brazil/DeNoronha", \

"Brazil/East", \

"Brazil/West", \

"Canada/Atlantic", \

"Canada/Central", \

"Canada/Eastern", \

"Canada/Mountain", \

"Canada/Newfoundland", \

"Canada/Pacific", \

"Canada/Saskatchewan", \

"Canada/Yukon", \

"CET", \

"Chile/Continental", \

"Chile/EasterIsland", \

"CST6CDT", \

"Cuba", \

"EET", \

"Egypt", \

"Eire", \

"EST", \

"EST5EDT", \

"Etc/GMT", \

"Etc/GMT+0", \

"Etc/GMT+1", \

"Etc/GMT+10", \

"Etc/GMT+11", \

"Etc/GMT+12", \

"Etc/GMT+2", \

"Etc/GMT+3", \

"Etc/GMT+4", \

"Etc/GMT+5", \

"Etc/GMT+6", \

"Etc/GMT+7", \

"Etc/GMT+8", \

"Etc/GMT+9", \

"Etc/GMT-0", \

"Etc/GMT-1", \

"Etc/GMT-10", \

"Etc/GMT-11", \

"Etc/GMT-12", \

"Etc/GMT-13", \

"Etc/GMT-14", \

"Etc/GMT-2", \

"Etc/GMT-3", \

"Etc/GMT-4", \

"Etc/GMT-5", \

"Etc/GMT-6", \

"Etc/GMT-7", \

"Etc/GMT-8", \

"Etc/GMT-9", \

"Etc/GMT0", \

"Etc/Greenwich", \

"Etc/UCT", \

"Etc/Universal", \

"Etc/UTC", \

"Etc/Zulu", \

"Europe/Amsterdam", \

"Europe/Andorra", \

"Europe/Astrakhan", \

"Europe/Athens", \

"Europe/Belfast", \

"Europe/Belgrade", \

"Europe/Berlin", \

"Europe/Bratislava", \

"Europe/Brussels", \

"Europe/Bucharest", \

"Europe/Budapest", \

"Europe/Busingen", \

"Europe/Chisinau", \

"Europe/Copenhagen", \

"Europe/Dublin", \

"Europe/Gibraltar", \

"Europe/Guernsey", \

"Europe/Helsinki", \

"Europe/Isle_of_Man", \

"Europe/Istanbul", \

"Europe/Jersey", \

"Europe/Kaliningrad", \

"Europe/Kiev", \

"Europe/Kirov", \

"Europe/Lisbon", \

"Europe/Ljubljana", \

"Europe/London", \

"Europe/Luxembourg", \

"Europe/Madrid", \

"Europe/Malta", \

"Europe/Mariehamn", \

"Europe/Minsk", \

"Europe/Monaco", \

"Europe/Moscow", \

"Europe/Nicosia", \

"Europe/Oslo", \

"Europe/Paris", \

"Europe/Podgorica", \

"Europe/Prague", \

"Europe/Riga", \

"Europe/Rome", \

"Europe/Samara", \

"Europe/San_Marino", \

"Europe/Sarajevo", \

"Europe/Saratov", \

"Europe/Simferopol", \

"Europe/Skopje", \

"Europe/Sofia", \

"Europe/Stockholm", \

"Europe/Tallinn", \

"Europe/Tirane", \

"Europe/Tiraspol", \

"Europe/Ulyanovsk", \

"Europe/Uzhgorod", \

"Europe/Vaduz", \

"Europe/Vatican", \

"Europe/Vienna", \

"Europe/Vilnius", \

"Europe/Volgograd", \

"Europe/Warsaw", \

"Europe/Zagreb", \

"Europe/Zaporozhye", \

"Europe/Zurich", \

"Factory", \

"GB", \

"GB-Eire", \

"GMT", \

"GMT+0", \

"GMT-0", \

"GMT0", \

"Greenwich", \

"Hongkong", \

"HST", \

"Iceland", \

"Indian/Antananarivo", \

"Indian/Chagos", \

"Indian/Christmas", \

"Indian/Cocos", \

"Indian/Comoro", \

"Indian/Kerguelen", \

"Indian/Mahe", \

"Indian/Maldives", \

"Indian/Mauritius", \

"Indian/Mayotte", \

"Indian/Reunion", \

"Iran", \

"Israel", \

"Jamaica", \

"Japan", \

"Kwajalein", \

"Libya", \

"MET", \

"Mexico/BajaNorte", \

"Mexico/BajaSur", \

"Mexico/General", \

"MST", \

"MST7MDT", \

"Navajo", \

"NZ", \

"NZ-CHAT", \

"Pacific/Apia", \

"Pacific/Auckland", \

"Pacific/Bougainville", \

"Pacific/Chatham", \

"Pacific/Chuuk", \

"Pacific/Easter", \

"Pacific/Efate", \

"Pacific/Enderbury", \

"Pacific/Fakaofo", \

"Pacific/Fiji", \

"Pacific/Funafuti", \

"Pacific/Galapagos", \

"Pacific/Gambier", \

"Pacific/Guadalcanal", \

"Pacific/Guam", \

"Pacific/Honolulu", \

"Pacific/Johnston", \

"Pacific/Kiritimati", \

"Pacific/Kosrae", \

"Pacific/Kwajalein", \

"Pacific/Majuro", \

"Pacific/Marquesas", \

"Pacific/Midway", \

"Pacific/Nauru", \

"Pacific/Niue", \

"Pacific/Norfolk", \

"Pacific/Noumea", \

"Pacific/Pago_Pago", \

"Pacific/Palau", \

"Pacific/Pitcairn", \

"Pacific/Pohnpei", \

"Pacific/Ponape", \

"Pacific/Port_Moresby", \

"Pacific/Rarotonga", \

"Pacific/Saipan", \

"Pacific/Samoa", \

"Pacific/Tahiti", \

"Pacific/Tarawa", \

"Pacific/Tongatapu", \

"Pacific/Truk", \

"Pacific/Wake", \

"Pacific/Wallis", \

"Pacific/Yap", \

"Poland", \

"Portugal", \

"PRC", \

"PST8PDT", \

"ROC", \

"ROK", \

"Singapore", \

"Turkey", \

"UCT", \

"Universal", \

"US/Alaska", \

"US/Aleutian", \

"US/Arizona", \

"US/Central", \

"US/East-Indiana", \

"US/Eastern", \

"US/Hawaii", \

"US/Indiana-Starke", \

"US/Michigan", \

"US/Mountain", \

"US/Pacific", \

"US/Samoa", \

"UTC", \

"W-SU", \

"WET", \

"Zulu" \

]

/**

Convert local time to universal time

Example:

local tDateTime

put "2018,2,14,13,38,0,4" into tDateTime

convert tDateTime to seconds

put ToUniversalTime(tDateTime, "Africa/Windhoek") into tDateTime

convert tDateTime to dateitems

-- tDateTime contains "2018,2,14,11,38,0,4"

Parameters:

pSeconds:

The local time

pTimeZone:

The time zone, in the form returned by the <TimeZones> function.

Returns:

The universal time

Description:

Use the <ToUniversalTime> function to find the universal time, given the

local time for the specified time zone.

References:

TimeZones (handler)

*/

public handler ToUniversalTime(in pSeconds as Time, in pTimeZone as String) returns Time

__EnsureDataDir()

unsafe

variable tTimeStruct as TimeStruct

GMTimeStruct(pSeconds, tTimeStruct)

-- Invalidate daylight savings value

put -1 into the last element of tTimeStruct

TimeZoneSetLocale(pTimeZone)

return TimeFromLocalTimeStruct(tTimeStruct)

end unsafe

end handler

/**

Convert universal time to local time

Example:

local tDateTime

put "2018,2,14,13,38,0,4" into tDateTime

convert tDateTime to seconds

put FromUniversalTime(tDateTime, "Antarctica/Vostok") into tDateTime

convert tDateTime to dateitems

-- tDateTime contains "2018,2,14,19,38,0,4"

Parameters:

pSeconds:

The universal time, i.e. seconds since the beginning of the epoch.

pTimeZone:

The time zone, in the form returned by the <TimeZones> function.

Returns:

The local time

Description:

Use the <FromUniversalTime> function to find the local time for the

specified timezone, given the universal time.

References:

TimeZones (handler)

*/

public handler FromUniversalTime(in pSeconds as Time, in pTimeZone as String) returns Time

__EnsureDataDir()

unsafe

TimeZoneSetLocale(pTimeZone)

variable tTimeStruct as TimeStruct

LocalTimeStruct(pSeconds, tTimeStruct)

-- Invalidate daylight savings value

put -1 into the last element of tTimeStruct

TimeZoneSetLocale("")

return TimeFromLocalTimeStruct(tTimeStruct)

end unsafe

end handler

/**

List the time zones used by the Time zone library

Example:

-- List all time zones and their times

local tList, tTime, tData

put the seconds into tTime

repeat for each line tLine in TimeZones()

put tLine & tab & FromUniversalTime(tTime, tLine) into tData

if tList is empty then

put tData into tList

else

put tData & return after tList

end if

end repeat

Returns:

A list of time zones, one per line.

Description:

Use the <TimeZones> function to find a list of valid timezones used by <ToUniversalTime> and <FromUniversalTime>,

References:

ToUniversalTime (handler), FromUniversalTime (handler)

*/

public handler TimeZones() returns String

variable tResult as String

combine kTimeZones with "\n" into tResult

return tResult

end handler

end library