Index: trunk/data/validator/opening_hours.js =================================================================== --- trunk/data/validator/opening_hours.js (revision 7174) +++ trunk/data/validator/opening_hours.js (revision 7514) @@ -1,33 +1,41 @@ +/* + * For information see https://github.com/ypid/opening_hours.js + * and the doc directory which contains internal documentation and design. + */ +/* jshint laxbreak: true */ +/* jshint boss: true */ +/* jshint loopfunc: true */ + (function (root, factory) { // constants (holidays, error correction) {{{ // holidays {{{ var holidays = { - 'fr': { + 'fr': { // {{{ 'PH': { // http://fr.wikipedia.org/wiki/F%C3%AAtes_et_jours_f%C3%A9ri%C3%A9s_en_France - "Jour de l'an" : [ 1, 1 ], - "Vendredi saint" : [ 'easter', -2, [ 'Moselle', 'Bas-Rhin', 'Haut-Rhin', 'Guadeloupe', 'Martinique', 'Polynésie française' ] ], - "Lundi de Pâques" : [ 'easter', 1 ], - "Saint-Pierre-Chanel" : [ 4, 28, [ 'Wallis-et-Futuna' ] ], - "Fête du Travail" : [ 5, 1 ], - "Fête de la Victoire" : [ 5, 8 ], - "Abolition de l'esclavage" : [ 5, 22, [ 'Martinique' ] ], - "Abolition de l'esclavage" : [ 5, 27, [ 'Guadeloupe' ] ], - "Jeudi de l'Ascension" : [ 'easter', 39 ], - "Lundi de Pentecôte" : [ 'easter', 50 ], - "Abolition de l'esclavage" : [ 6, 10, [ 'Guyane' ] ], - "Fête de l'autonomie" : [ 6, 29, [ 'Polynésie française' ] ], - "Fête nationale" : [ 7, 14 ], - "Fête Victor Schoelcher" : [ 7, 21, [ 'Guadeloupe', 'Martinique' ] ], - "Fête du Territoire" : [ 7, 29, [ 'Wallis-et-Futuna' ] ], - "Assomption" : [ 8, 15 ], - "Fête de la citoyenneté" : [ 9, 24, [ 'Nouvelle-Calédonie' ] ], - "Toussaint" : [ 11, 1 ], - "Armistice" : [ 11, 11 ], - "Abolition de l'esclavage" : [ 12, 20, [ 'Réunion' ] ], - "Noël" : [ 12, 25 ], - "Saint-Étienne " : [ 12, 26, [ 'Moselle', 'Bas-Rhin', 'Haut-Rhin' ] ] + "Jour de l'an" : [ 1, 1 ], + "Vendredi saint" : [ 'easter', -2, [ 'Moselle', 'Bas-Rhin', 'Haut-Rhin', 'Guadeloupe', 'Martinique', 'Polynésie française' ] ], + "Lundi de Pâques" : [ 'easter', 1 ], + "Saint-Pierre-Chanel" : [ 4, 28, [ 'Wallis-et-Futuna' ] ], + "Fête du Travail" : [ 5, 1 ], + "Fête de la Victoire" : [ 5, 8 ], + "Abolition de l'esclavage" : [ 5, 22, [ 'Martinique' ] ], + "Abolition de l'esclavage" : [ 5, 27, [ 'Guadeloupe' ] ], + "Jeudi de l'Ascension" : [ 'easter', 39 ], + "Lundi de Pentecôte" : [ 'easter', 50 ], + "Abolition de l'esclavage" : [ 6, 10, [ 'Guyane' ] ], + "Fête de l'autonomie" : [ 6, 29, [ 'Polynésie française' ] ], + "Fête nationale" : [ 7, 14 ], + "Fête Victor Schoelcher" : [ 7, 21, [ 'Guadeloupe', 'Martinique' ] ], + "Fête du Territoire" : [ 7, 29, [ 'Wallis-et-Futuna' ] ], + "Assomption" : [ 8, 15 ], + "Fête de la citoyenneté" : [ 9, 24, [ 'Nouvelle-Calédonie' ] ], + "Toussaint" : [ 11, 1 ], + "Armistice" : [ 11, 11 ], + "Abolition de l'esclavage" : [ 12, 20, [ 'Réunion' ] ], + "Noël" : [ 12, 25 ], + "Saint-Étienne " : [ 12, 26, [ 'Moselle', 'Bas-Rhin', 'Haut-Rhin' ] ] } - }, - 'de': { + }, // }}} + 'de': { // {{{ 'PH': { // http://de.wikipedia.org/wiki/Feiertage_in_Deutschland 'Neujahrstag' : [ 1, 1 ], // month 1, day 1, whole Germany @@ -47,5 +55,5 @@ '1. Weihnachtstag' : [ 12, 25 ], '2. Weihnachtstag' : [ 12, 26 ], - // 'Silvester' : [ 12, 31 ], // for testing + // 'Silvester' : [ 12, 31 ], // for testing }, 'Baden-Württemberg': { // does only apply in Baden-Württemberg @@ -53,7 +61,7 @@ // You may use this instead of the country wide with some // additional holidays for some states, if one state - // totally disagrees about how to do public holidays … + // totally disagrees about how to do holidays … // 'PH': { - // '2. Weihnachtstag' : [ 12, 26 ], + // '2. Weihnachtstag' : [ 12, 26 ], // }, @@ -1076,151 +1084,151 @@ ], }, - }, - 'at': { + }, // }}} + 'at': { // {{{ 'PH': { // http://de.wikipedia.org/wiki/Feiertage_in_%C3%96sterreich - 'Neujahrstag' : [ 1, 1 ], - 'Heilige Drei Könige' : [ 1, 6 ], - // 'Josef' : [ 3, 19, [ 'Kärnten', 'Steiermark', 'Tirol', 'Vorarlberg' ] ], - // 'Karfreitag' : [ 'easter', -2 ], - 'Ostermontag' : [ 'easter', 1 ], - 'Staatsfeiertag' : [ 5, 1 ], - // 'Florian' : [ 5, 4, [ 'Oberösterreich' ] ], - 'Christi Himmelfahrt' : [ 'easter', 39 ], - 'Pfingstmontag' : [ 'easter', 50 ], - 'Fronleichnam' : [ 'easter', 60 ], - 'Mariä Himmelfahrt' : [ 8, 15 ], - // 'Rupert' : [ 9, 24, [ 'Salzburg' ] ], - // 'Tag der Volksabstimmung' : [ 10, 10, [ 'Kärnten' ] ], - 'Nationalfeiertag' : [ 10, 26 ], - 'Allerheiligen' : [ 11, 1 ], - // 'Martin' : [ 11, 11, [ 'Burgenland' ] ], - // 'Leopold' : [ 11, 15, [ 'Niederösterreich', 'Wien' ] ], - 'Mariä Empfängnis' : [ 12, 8 ], - // 'Heiliger Abend' : [ 12, 24 ], - 'Christtag' : [ 12, 25 ], - 'Stefanitag' : [ 12, 26 ], - // 'Silvester' : [ 12, 31 ], + 'Neujahrstag' : [ 1, 1 ], + 'Heilige Drei Könige' : [ 1, 6 ], + // 'Josef' : [ 3, 19, [ 'Kärnten', 'Steiermark', 'Tirol', 'Vorarlberg' ] ], + // 'Karfreitag' : [ 'easter', -2 ], + 'Ostermontag' : [ 'easter', 1 ], + 'Staatsfeiertag' : [ 5, 1 ], + // 'Florian' : [ 5, 4, [ 'Oberösterreich' ] ], + 'Christi Himmelfahrt' : [ 'easter', 39 ], + 'Pfingstmontag' : [ 'easter', 50 ], + 'Fronleichnam' : [ 'easter', 60 ], + 'Mariä Himmelfahrt' : [ 8, 15 ], + // 'Rupert' : [ 9, 24, [ 'Salzburg' ] ], + // 'Tag der Volksabstimmung' : [ 10, 10, [ 'Kärnten' ] ], + 'Nationalfeiertag' : [ 10, 26 ], + 'Allerheiligen' : [ 11, 1 ], + // 'Martin' : [ 11, 11, [ 'Burgenland' ] ], + // 'Leopold' : [ 11, 15, [ 'Niederösterreich', 'Wien' ] ], + 'Mariä Empfängnis' : [ 12, 8 ], + // 'Heiliger Abend' : [ 12, 24 ], + 'Christtag' : [ 12, 25 ], + 'Stefanitag' : [ 12, 26 ], + // 'Silvester' : [ 12, 31 ], }, - }, - 'ca': { + }, // }}} + 'ca': { // {{{ 'PH': { // https://en.wikipedia.org/wiki/Public_holidays_in_Canada - "New Year's Day" : [ 1, 1 ], - "Good Friday" : [ 'easter', -2 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Good Friday" : [ 'easter', -2 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Christmas Day" : [ 12, 25 ] }, 'Alberta': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Alberta Family Day" : [ 'firstFebruaryMonday', 14 ], - "Good Friday" : [ 'easter', -2 ], - "Easter Monday" : [ 'easter', 1 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Heritage Day" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ], - "Boxing Day" : [ 12, 26 ] + "New Year's Day" : [ 1, 1 ], + "Alberta Family Day" : [ 'firstFebruaryMonday', 14 ], + "Good Friday" : [ 'easter', -2 ], + "Easter Monday" : [ 'easter', 1 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Heritage Day" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ], + "Boxing Day" : [ 12, 26 ] }, }, 'British Columbia': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Family Day" : [ 'firstFebruaryMonday', 7 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "British Columbia Day" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Family Day" : [ 'firstFebruaryMonday', 7 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "British Columbia Day" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ] }, }, 'Manitoba': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Louis Riel Day" : [ 'firstFebruaryMonday', 14 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Civic Holiday" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Louis Riel Day" : [ 'firstFebruaryMonday', 14 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Civic Holiday" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ] }, }, 'New Brunswick': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "New Brunswick Day" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ], - "Boxing Day" : [ 12, 26 ] + "New Year's Day" : [ 1, 1 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "New Brunswick Day" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ], + "Boxing Day" : [ 12, 26 ] }, }, 'Newfoundland and Labrador': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Saint Patrick's Day" : [ 3, 17 ], - "Good Friday" : [ 'easter', -2 ], - "Saint George's Day" : [ 4, 23 ], - "Discovery Day" : [ 6, 24 ], - "Memorial Day" : [ 7, 1 ], - "Orangemen's Day" : [ 7, 12 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Armistice Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Saint Patrick's Day" : [ 3, 17 ], + "Good Friday" : [ 'easter', -2 ], + "Saint George's Day" : [ 4, 23 ], + "Discovery Day" : [ 6, 24 ], + "Memorial Day" : [ 7, 1 ], + "Orangemen's Day" : [ 7, 12 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Armistice Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ] }, }, 'Northwest Territories': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "National Aboriginal Day" : [ 6, 21 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Civic Holiday" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "National Aboriginal Day" : [ 6, 21 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Civic Holiday" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ] }, }, 'Nova Scotia': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Natal Day" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ], - "Boxing Day" : [ 12, 26 ] + "New Year's Day" : [ 1, 1 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Natal Day" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ], + "Boxing Day" : [ 12, 26 ] }, }, 'Nunavut': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Nunavut Day" : [ 7, 9 ], - "Civic Holiday" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Nunavut Day" : [ 7, 9 ], + "Civic Holiday" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ] }, }, @@ -1242,17 +1250,17 @@ 'Prince Edward Island': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Islander Day" : [ 'firstFebruaryMonday', 14 ], - "Good Friday" : [ 'easter', -2 ], - "Easter Monday" : [ 'easter', 1 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Civic Holiday" : [ 'firstAugustMonday', 0 ], - "Gold Cup Parade Day" : [ 'firstAugustMonday', 18 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ], - "Boxing Day" : [ 12, 26 ] + "New Year's Day" : [ 1, 1 ], + "Islander Day" : [ 'firstFebruaryMonday', 14 ], + "Good Friday" : [ 'easter', -2 ], + "Easter Monday" : [ 'easter', 1 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Civic Holiday" : [ 'firstAugustMonday', 0 ], + "Gold Cup Parade Day" : [ 'firstAugustMonday', 18 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ], + "Boxing Day" : [ 12, 26 ] }, }, @@ -1272,64 +1280,64 @@ 'Saskatchewan': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Family Day" : [ 'firstFebruaryMonday', 14 ], - "Good Friday" : [ 'easter', -2 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Saskatchewan Day" : [ 'firstAugustMonday', 0 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ] + "New Year's Day" : [ 1, 1 ], + "Family Day" : [ 'firstFebruaryMonday', 14 ], + "Good Friday" : [ 'easter', -2 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Saskatchewan Day" : [ 'firstAugustMonday', 0 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ] }, }, 'Yukon': { 'PH': { - "New Year's Day" : [ 1, 1 ], - "Heritage Day" : [ 'lastFebruarySunday', -2 ], - "Good Friday" : [ 'easter', -2 ], - "Easter Monday" : [ 'easter', 1 ], - "Victoria Day" : [ 'victoriaDay', 0 ], - "Canada Day" : [ 'canadaDay', 0 ], - "Discovery Day" : [ 'firstAugustMonday', 14 ], - "Labour Day" : [ 'firstSeptemberMonday', 0 ], - "Thanksgiving" : [ 'firstOctoberMonday', 7 ], - "Remembrance Day" : [ 11, 11 ], - "Christmas Day" : [ 12, 25 ], - "Boxing Day" : [ 12, 26 ] + "New Year's Day" : [ 1, 1 ], + "Heritage Day" : [ 'lastFebruarySunday', -2 ], + "Good Friday" : [ 'easter', -2 ], + "Easter Monday" : [ 'easter', 1 ], + "Victoria Day" : [ 'victoriaDay', 0 ], + "Canada Day" : [ 'canadaDay', 0 ], + "Discovery Day" : [ 'firstAugustMonday', 14 ], + "Labour Day" : [ 'firstSeptemberMonday', 0 ], + "Thanksgiving" : [ 'firstOctoberMonday', 7 ], + "Remembrance Day" : [ 11, 11 ], + "Christmas Day" : [ 12, 25 ], + "Boxing Day" : [ 12, 26 ] }, }, - }, - 'ua': { + }, // }}} + 'ua': { // {{{ 'PH': { // http://uk.wikipedia.org/wiki/%D0%A1%D0%B2%D1%8F%D1%82%D0%B0_%D1%82%D0%B0_%D0%BF%D0%B0%D0%BC%27%D1%8F%D1%82%D0%BD%D1%96_%D0%B4%D0%BD%D1%96_%D0%B2_%D0%A3%D0%BA%D1%80%D0%B0%D1%97%D0%BD%D1%96 - "Новий рік" : [ 1, 1 ], - "Різдво" : [ 1, 7 ], - "Міжнародний жіночий день" : [ 3, 8 ], - "Великдень" : [ 'orthodox easter', 1 ], - "День Праці 1" : [ 5, 1 ], - "День Праці 2" : [ 5, 2 ], - "День Перемоги" : [ 5, 9 ], - "День Конституції України" : [ 6, 28 ], - "День Незалежності України" : [ 8, 24 ], + "Новий рік" : [ 1, 1 ], + "Різдво" : [ 1, 7 ], + "Міжнародний жіночий день" : [ 3, 8 ], + "Великдень" : [ 'orthodox easter', 1 ], + "День Праці 1" : [ 5, 1 ], + "День Праці 2" : [ 5, 2 ], + "День Перемоги" : [ 5, 9 ], + "День Конституції України" : [ 6, 28 ], + "День Незалежності України" : [ 8, 24 ], } - }, - 'si': { + }, // }}} + 'si': { // {{{ 'PH': { // http://www.vlada.si/o_sloveniji/politicni_sistem/prazniki/ - 'novo leto' : [ 1, 1 ], - 'Prešernov dan, slovenski kulturni praznik' : [ 2, 8 ], - 'velikonočna nedelja' : [ 'easter', 0 ], - 'velikonočni ponedeljek' : [ 'easter', 1 ], - 'dan upora proti okupatorju' : [ 4, 27 ], - 'praznik dela 1' : [ 5, 1 ], - 'praznik dela 2' : [ 5, 2 ], - 'binkoštna nedelja - binkošti' : [ 'easter', 49 ], - 'dan državnosti' : [ 6, 25 ], - 'Marijino vnebovzetje' : [ 8, 15 ], - 'dan reformacije' : [ 10, 31 ], - 'dan spomina na mrtve' : [ 11, 1 ], - 'božič' : [ 12, 25 ], - 'dan samostojnosti in enotnosti' : [ 12, 26 ], + 'novo leto' : [ 1, 1 ], + 'Prešernov dan, slovenski kulturni praznik' : [ 2, 8 ], + 'velikonočna nedelja' : [ 'easter', 0 ], + 'velikonočni ponedeljek' : [ 'easter', 1 ], + 'dan upora proti okupatorju' : [ 4, 27 ], + 'praznik dela 1' : [ 5, 1 ], + 'praznik dela 2' : [ 5, 2 ], + 'binkoštna nedelja - binkošti' : [ 'easter', 49 ], + 'dan državnosti' : [ 6, 25 ], + 'Marijino vnebovzetje' : [ 8, 15 ], + 'dan reformacije' : [ 10, 31 ], + 'dan spomina na mrtve' : [ 11, 1 ], + 'božič' : [ 12, 25 ], + 'dan samostojnosti in enotnosti' : [ 12, 26 ], }, - }, + }, // }}} }; // }}} @@ -1341,10 +1349,16 @@ // Key to word_error_correction is the token name except wrong_words var word_error_correction = { - wrong_words: { - 'Assuming "" for ""': { - spring: 'Mar-May', - summer: 'Jun-Aug', - autumn: 'Sep-Nov', - winter: 'Dec-Feb', + wrong_words: { /* {{{ */ + 'Assuming "" for "".': { + 'Frühling': 'Mar-May', + 'Frühjahr': 'Mar-May', + 'Sommer': 'Jun-Aug', + 'Herbst': 'Sep-Nov', + 'winter': 'Dec-Feb', + }, '"" wird als "" interpertiert.': { + 'spring': 'Mar-May', + 'summer': 'Jun-Aug', + 'autumn': 'Sep-Nov', + // 'winter': 'Dec-Feb', // Same as in English. // morning: '08:00-12:00', // evening: '13:00-18:00', @@ -1352,37 +1366,46 @@ 'daytime': 'sunrise-sunset', }, 'Bitte benutze die englische Schreibweise "" für "".': { - sommer: 'summer', + 'sommer': 'summer', 'werktag': 'Mo-Fr', 'werktags': 'Mo-Fr', - }, 'Bitte benutze "" für "". Beispiel: "Mo-Fr 08:00-12:00; Tu off"': { - ruhetag: 'off', - ruhetage: 'off', - geschlossen: 'off', - ausser: 'off', - außer: 'off', + }, 'Bitte benutze "" für "". Beispiel: "Mo-Fr 08:00-12:00; Tu off".': { + 'ruhetag': 'off', + 'ruhetage': 'off', + 'geschlossen': 'off', + 'geschl': 'off', + // 'ausser': 'off', + // 'außer': 'off', }, 'Neem de engelse afkorting "" voor "" alstublieft.': { - 'gesloten': 'off', - 'feestdag': 'PH', + 'gesloten': 'off', + 'feestdag': 'PH', + 'feestdagen': 'PH', }, 'Assuming "" for "". Please avoid using "workday": http://wiki.openstreetmap.org/wiki/Talk:Key:opening_hours#need_syntax_for_holidays_and_workingdays': { - // // Used around 260 times but the problem is, that work day might be different in other countries. - 'wd': 'Mo-Fr', - 'weekday': 'Mo-Fr', - 'weekdays': 'Mo-Fr', - 'vardagar': 'Mo-Fr', - }, 'Please use notation something like "Mo off" instead "".': { - except: 'off', - }, 'Please ommit "" or use a colon instead: "12:00-14:00".': { - h: '', - }, 'Please ommit "".': { - season: '', - hs: '', - hrs: '', - hours: '', - }, 'Please ommit "". The key must not be in the value.': { + // Used around 260 times but the problem is, that work day might be different in other countries. + 'wd': 'Mo-Fr', + 'on work day': 'Mo-Fr', + 'on work days': 'Mo-Fr', + 'weekday': 'Mo-Fr', + 'weekdays': 'Mo-Fr', + 'vardagar': 'Mo-Fr', + }, 'Please use something like "Mo off" instead "".': { + 'except': 'off', + }, 'Please omit "" or use a colon instead: "12:00-14:00".': { + 'h': '', + }, 'Please omit "".': { + 'season': '', + 'hs': '', + 'hrs': '', + 'hours': '', + '·': '', + }, 'Please omit "". The key must not be in the value.': { 'opening_hours=': '', - }, 'Please ommit "". You might want to express open end which can be specified as "12:00+" for example.': { - from: '', - }, 'You can use notation "" for "". You might want to express open end which can be specified as "12:00+" for example.': { + }, 'Please omit "". You might want to express open end which can be specified as "12:00+" for example.': { + 'from': '', + }, 'You can use notation "" for "" in the case that you want to express open end times. Example: "12:00+".': { + 'til late': '+', + 'till late': '+', '-late': '+', + '-open end': '+', + '-openend': '+', }, 'Please use notation "" for "". If the times are unsure or vary consider a comment e.g. 12:00-14:00 "only on sunshine".': { '~': '-', @@ -1392,53 +1415,77 @@ }, 'You can use notation "" for "" temporally if the syntax will still be valid.': { '?': 'unknown "please add this if known"', + }, 'Please use notation "" for "". Although using "–" is typographical correct, the opening_hours syntax is defined with the normal hyphen. Correct typography should be done on application level …': { + '–': '-', }, 'Please use notation "" for "".': { - '→': '-', - '–': '-', - '−': '-', - '=': '-', - 'ー': '-', - to: '-', - 'до': '-', - a: '-', // language unknown - as: '-', // language unknown - 'á': '-', // language unknown - 'ás': '-', // language unknown - 'à': '-', // language unknown - 'às': '-', // language unknown - 'ate': '-', // language unknown - 'till': '-', - 'til': '-', - 'until': '-', - 'through': '-', - and: ',', - '&': ',', - '：': ':', - '°°': ':00', - 'daily': 'Mo-Su', - 'everyday': 'Mo-Su', - 'every day': 'Mo-Su', - always: '24/7', - nonstop: '24/7', - '24x7': '24/7', - 'anytime': '24/7', - 'all day': '24/7', - 'all days': 'Mo-Su', - 'every day': 'Mo-Su', - '7days': 'Mo-Su', - '7j/7': 'Mo-Su', // I guess that it means that - '7/7': 'Mo-Su', // I guess that it means that - '7 days': 'Mo-Su', - '7 days a week': 'Mo-Su', - 'midnight': '00:00', - holiday: 'PH', - holidays: 'PH', + '→': '-', + '−': '-', + '=': '-', + 'ー': '-', + 'to': '-', + 'до': '-', + 'a': '-', // language unknown + 'as': '-', // language unknown + 'á': '-', // language unknown + 'ás': '-', // language unknown + 'às': '-', // language unknown + 'ate': '-', // language unknown + 'till': '-', + 'til': '-', + 'until': '-', + 'through': '-', + 'and': ',', + '&': ',', + // '/': ',', // Can not be corrected as / is a valid token + '：': ':', + '°°': ':00', + 'always': '24/7', + 'nonstop': '24/7', + '24x7': '24/7', + 'anytime': '24/7', + 'all day': '24/7', + 'daily': 'Mo-Su', + 'everyday': 'Mo-Su', + 'every day': 'Mo-Su', + 'all days': 'Mo-Su', + '7j/7': 'Mo-Su', // I guess that it means that + '7/7': 'Mo-Su', // I guess that it means that + /* {{{ + * Fixing this causes to ignore the following warning: "There should be no + * reason to differ more than 6 days from a constrained + * weekdays. If so tell us …". + * The following mistake is expected to occur more often. + */ + '7days': 'Mo-Su', + '7 days': 'Mo-Su', + // }}} + '7 days a week': 'Mo-Su', + '7 days/week': 'Mo-Su', + '24 hours 7 days a week': '24/7', + '24 hours': '00:00-24:00', + 'midday': '12:00', + 'midnight': '00:00', + 'holiday': 'PH', + 'holidays': 'PH', 'public holidays': 'PH', - 'public holiday': 'PH', + 'public holiday': 'PH', + 'day after public holiday': 'PH +1 day', + 'one day after public holiday': 'PH +1 day', + 'day before public holiday': 'PH -1 day', + 'one day before public holiday': 'PH -1 day', + 'school holiday': 'SH', + 'school holidays': 'SH', // summerholiday: 'SH', // summerholidays: 'SH', - weekend: 'Sa,Su', - weekends: 'Sa,Su', - 'daylight': 'sunrise-sunset', - 'оff': 'off', // Russian o + /* Not implemented {{{ */ + // 'day after school holiday': 'SH +1 day', + // 'one day after school holiday': 'SH +1 day', + // 'day before school holiday': 'SH -1 day', + // 'one day before school holiday': 'SH -1 day', + /* }}} */ + 'weekend': 'Sa,Su', + 'weekends': 'Sa,Su', + 'daylight': 'sunrise-sunset', + }, 'Please use notation "" for "". Those characters look very similar but are not the same!': { + 'оff': 'off', // Russian o }, 'Please use time format in 24 hours notation (""). If PM is used you might have to convert the hours to the 24 hours notation.': { 'pm': '', @@ -1449,192 +1496,227 @@ 'uhr': '', 'geöffnet': '', - }, 'Bitte verzichte auf "". Sie möchten eventuell eine Öffnungszeit ohne vorgegebenes Ende angeben. Beispiel: "12:00+"': { - ab: '', - von: '', + 'zwischen': '', + }, 'Bitte verzichte auf "". Sie möchten eventuell eine Öffnungszeit ohne vorgegebenes Ende (Open End) angeben. Beispiel: "12:00+"': { + 'ab': '', + 'von': '', + }, 'Es sieht so aus also möchten Sie zusätzliche Einschränkungen für eine Öffnungszeit geben. Falls sich dies nicht mit der Syntax ausdrücken lässt können Kommentare verwendet werden. Zusätzlich sollte eventuell das Schlüsselwort `open` benutzt werden. Bitte probiere "" für "".': { + 'damen': 'open "Damen"', + 'herren': 'open "Herren"', }, 'Bitte benutze die Schreibweise "" für "".': { - bis: '-', - 'täglich': 'Mo-Su', + 'bis': '-', + 'täglich': 'Mo-Su', + 'schulferien': 'SH', + 'sonn-/feiertag': 'PH,Su', + 'sonn-/feiertags': 'PH,Su', + 'an sonn- und feiertagen': 'PH,Su', + 'nur sonn-/feiertags': 'PH,Su', + }, 'Bitte benutze die Schreibweise "" für "". Es ist war typografisch korrekt aber laut der Spezifikation für opening_hours nicht erlaubt. Siehe auch: http://wiki.openstreetmap.org/wiki/DE:Key:opening_hours:specification.': { + '„': '"', + '“': '"', + '”': '"', + }, 'Please use notation "" for "". The used quote signs might be typographically correct but are not defined in the specification. See http://wiki.openstreetmap.org/wiki/Key:opening_hours:specification.': { + '«': '"', + '»': '"', + '‚': '"', + '‘': '"', + '’': '"', + '「': '"', + '」': '"', + '『': '"', + '』': '"', + }, 'Please use notation "" for "". The used quote signs are not defined in the specification. See http://wiki.openstreetmap.org/wiki/Key:opening_hours:specification.': { + "'": '"', + }, 'You might want to use comments instead of brackets (which are not valid in this context). If you do, replace "" with "".': { + // '（': '"', + // '）': '"', }, 'Bitte benutze die Schreibweise "" als Ersatz für "und" bzw. "u.".': { - und: ',', - u: ',', + 'und': ',', + 'u': ',', }, 'Bitte benutze die englische Abkürzung "" für "".': { - feiertag: 'PH', - feiertags: 'PH', - feiertage: 'PH', - feiertagen: 'PH' + 'feiertag': 'PH', + 'feiertags': 'PH', + 'feiertage': 'PH', + 'feiertagen': 'PH' }, 'S\'il vous plaît utiliser "" pour "".': { - 'fermé': 'off', - 'et': ',', - 'à': '-', + 'fermé': 'off', + 'et': ',', + 'à': '-', 'jours fériés': 'PH', - }, 'Neem de engelse afkorting "" voor "" alstublieft.': { - feestdag: 'PH', - feestdagen: 'PH', } - }, - - month: { + }, /* }}} */ + + month: { /* {{{ */ 'default': { - jan: 0, - feb: 1, - mar: 2, - apr: 3, - may: 4, - jun: 5, - jul: 6, - aug: 7, - sep: 8, - oct: 9, - nov: 10, - dec: 11, + 'jan': 0, + 'feb': 1, + 'mar': 2, + 'apr': 3, + 'may': 4, + 'jun': 5, + 'jul': 6, + 'aug': 7, + 'sep': 8, + 'oct': 9, + 'nov': 10, + 'dec': 11, }, 'Please use the English abbreviation "" for "".': { 'jänner': 0, // Austria - january: 0, - february: 1, - march: 2, - april: 3, - // may: 4, - june: 5, - july: 6, - august: 7, - september: 8, - sept: 8, - october: 9, - november: 10, - december: 11, + 'january': 0, + 'february': 1, + 'march': 2, + 'april': 3, + // 'may': 4, + 'june': 5, + 'july': 6, + 'august': 7, + 'september': 8, + 'sept': 8, + 'october': 9, + 'november': 10, + 'december': 11, }, 'Bitte benutze die englische Abkürzung "" für "".': { - januar: 0, - februar: 1, + 'januar': 0, + 'februar': 1, 'märz': 2, - maerz: 2, - mai: 4, - juni: 5, - juli: 6, - okt: 9, - oktober: 9, - dez: 11, - dezember: 11, + 'maerz': 2, + 'mai': 4, + 'juni': 5, + 'juli': 6, + 'okt': 9, + 'oktober': 9, + 'dez': 11, + 'dezember': 11, }, 'S\'il vous plaît utiliser l\'abréviation "" pour "".': { - janvier: 0, - février: 1, - fév: 1, - mars: 2, - avril: 3, - avr: 3, - mai: 4, - juin: 5, - juillet: 6, - août: 7, - aoû: 7, - septembre: 8, - octobre: 9, - novembre: 10, - décembre: 11, + 'janvier': 0, + 'février': 1, + 'fév': 1, + 'mars': 2, + 'avril': 3, + 'avr': 3, + 'mai': 4, + 'juin': 5, + 'juillet': 6, + 'août': 7, + 'aoû': 7, + 'septembre': 8, + 'octobre': 9, + 'novembre': 10, + 'décembre': 11, }, 'Neem de engelse afkorting "" voor "" alstublieft.': { - januari: 0, - februari: 1, - maart: 2, - mei: 4, - augustus: 7, + 'januari': 0, + 'februari': 1, + 'maart': 2, + 'mei': 4, + 'augustus': 7, } + }, /* }}} */ + + calcday: { + 'default': { + 'day': 'day', + 'days': 'days', + }, }, - weekday: { // good source: http://www.omniglot.com/language/time/days.htm + weekday: { // {{{ Good source: http://www.omniglot.com/language/time/days.htm */ 'default': { - su: 0, - mo: 1, - tu: 2, - we: 3, - th: 4, - fr: 5, - sa: 6, + 'su': 0, + 'mo': 1, + 'tu': 2, + 'we': 3, + 'th': 4, + 'fr': 5, + 'sa': 6, }, 'Assuming "" for ""': { - m: 1, - w: 3, - f: 5, + 'm': 1, + 'w': 3, + 'f': 5, }, 'Please use the abbreviation "" for "".': { - sun: 0, - sunday: 0, - sundays: 0, - mon: 1, - monday: 1, - mondays: 1, - tue: 2, - tuesday: 2, - tuesdays: 2, - wed: 3, - wednesday: 3, - wednesdays: 3, - thu: 4, - thur: 4, - thursday: 4, - thursdays: 4, - fri: 5, - friday: 5, - fridays: 5, - sat: 6, - saturday: 6, - saturdays: 6, + 'sun': 0, + 'sunday': 0, + 'sundays': 0, + 'mon': 1, + 'monday': 1, + 'mondays': 1, + 'tue': 2, + 'tues': 2, // Used here: http://www.westerhambeauty.co.uk/contact.php + 'tuesday': 2, + 'tuesdays': 2, + 'wed': 3, + 'weds': 3, + 'wednesday': 3, + 'wednesdays': 3, + 'thu': 4, + 'thur': 4, + 'thurs': 4, + 'thursday': 4, + 'thursdays': 4, + 'fri': 5, + 'friday': 5, + 'fridays': 5, + 'sat': 6, + 'saturday': 6, + 'saturdays': 6, }, 'Bitte benutze die englische Abkürzung "" für "". Could also mean Saturday in Polish …': { - so: 0, + 'so': 0, }, 'Bitte benutze die englische Abkürzung "" für "".': { - son: 0, - sonntag: 0, + 'son': 0, + 'sonntag': 0, 'sonn-': 0, - sonntags: 0, - montag: 1, - montags: 1, - di: 2, - die: 2, - dienstag: 2, - dienstags: 2, - mi: 3, - mit: 3, - mittwoch: 3, - mittwochs: 3, + 'sonntags': 0, + 'montag': 1, + 'montags': 1, + 'di': 2, + 'die': 2, + 'dienstag': 2, + 'dienstags': 2, + 'mi': 3, + 'mit': 3, + 'mittwoch': 3, + 'mittwochs': 3, 'do': 4, - don: 4, - donnerstag: 4, - donnerstags: 4, - fre: 5, - freitag: 5, - freitags: 5, - sam: 6, - samstag: 6, - samstags: 6, + 'don': 4, + 'donnerstag': 4, + 'donnerstags': 4, + 'fre': 5, + 'freitag': 5, + 'freitags': 5, + 'sam': 6, + 'samstag': 6, + 'samstags': 6, }, 'S\'il vous plaît utiliser l\'abréviation "" pour "".': { - dim: 0, - dimanche: 0, - lu: 1, - lun: 1, - lundi: 1, - mardi: 2, - mer: 3, - mercredi: 3, - je: 4, - jeu: 4, - jeudi: 4, - ve: 5, - ven: 5, - vendredi: 5, - samedi: 6, + 'dim': 0, + 'dimanche': 0, + 'lu': 1, + 'lun': 1, + 'lundi': 1, + 'mardi': 2, + 'mer': 3, + 'mercredi': 3, + 'je': 4, + 'jeu': 4, + 'jeudi': 4, + 've': 5, + 'ven': 5, + 'vendredi': 5, + 'samedi': 6, }, 'Neem de engelse afkorting "" voor "" alstublieft.': { - zo: 0, - zon: 0, - zontag: 0, // correct? - zondag: 0, - maandag: 1, - din: 2, - dinsdag: 2, - wo: 3, - woe: 3, - woensdag: 3, - donderdag: 4, - vr: 5, - vri: 5, - vrijdag: 5, - za: 6, - zat: 6, - zaterdag: 6, + 'zo': 0, + 'zon': 0, + 'zontag': 0, // correct? + 'zondag': 0, + 'maandag': 1, + 'din': 2, + 'dinsdag': 2, + 'wo': 3, + 'woe': 3, + 'woensdag': 3, + 'donderdag': 4, + 'vr': 5, + 'vri': 5, + 'vrijdag': 5, + 'za': 6, + 'zat': 6, + 'zaterdag': 6, }, 'Please use the English abbreviation "" for "".': { // FIXME: Translate to Czech. 'neděle': 0, @@ -1651,6 +1733,5 @@ 'pá': 5, 'sobota': 6, - }, 'Please use the English abbreviation "" for "".': { - // Spanish. + }, 'Please use the English abbreviation "" (Spanish) for "".': { 'martes': 0, 'miércoles': 1, @@ -1660,5 +1741,5 @@ 'domingo': 5, 'lunes': 6, - // Indonesian. + }, 'Please use the English abbreviation "" (Indonesian) for "".': { 'selasa': 0, 'rabu': 1, @@ -1668,5 +1749,5 @@ 'minggu': 5, 'senin': 6, - // Swedish + }, 'Please use the English abbreviation "" (Swedish) for "".': { 'söndag': 0, 'söndagar': 0, @@ -1674,10 +1755,10 @@ 'ma': 1, 'tisdag': 2, - 'onsdag': 3, + 'onsdag': 3, // Same in Danish 'torsdag': 4, 'fredag': 5, 'lördag': 6, 'lördagar': 6, - // Polish + }, 'Please use the English abbreviation "" (Polish) for "".': { 'niedziela': 0, 'niedz': 0, 'n': 0, 'ndz': 0, 'poniedziałek': 1, 'poniedzialek': 1, 'pon': 1, 'pn': 1, @@ -1687,5 +1768,5 @@ 'piątek': 5, 'piatek': 5, 'pt': 5, 'sobota': 6, 'sob': 6, // 'so': 6 // abbreviation also used in German - // Russian + }, 'Please use the English abbreviation "" (Russian) for "".': { 'воскресенье' : 0, 'Вс' : 0, @@ -1704,16 +1785,16 @@ 'суббота' : 6, 'subbota' : 6, - // Danish + }, 'Please use the English abbreviation "" (Danish) for "".': { 'søndag' : 0, 'mandag' : 1, 'tirsdag': 2, - 'onsdag' : 3, + 'onsdag' : 3, // Same in Swedish 'torsdag': 4, 'fredag' : 5, 'lørdag' : 6, }, - }, - - timevar: { // Special time variables which actual value depends on the date and the position of the facility. + }, /* }}} */ + + timevar: { /* {{{ Special time variables which actual value depends on the date and the position of the facility. */ 'default': { 'sunrise': 'sunrise', @@ -1729,5 +1810,5 @@ 'sonnenuntergang': 'sunset', }, - }, + }, /* }}} */ 'event': { // variable events @@ -1755,5 +1836,5 @@ return function(value, nominatiomJSON, oh_mode) { // short constants {{{ - var word_value_replacement = { // if the correct values can not be calculated + var word_value_replacement = { // If the correct values can not be calculated. dawn : 60 * 5 + 30, sunrise : 60 * 6, @@ -1761,15 +1842,17 @@ dusk : 60 * 18 + 30, }; - var months = ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec']; + var months = ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec']; var weekdays = ['Su','Mo','Tu','We','Th','Fr','Sa']; var default_prettify_conf = { - 'leading_zero_hour': true, // enforce leading zero + // Update README.md if changed. + 'zero_pad_hour': true, // enforce ("%02d", hour) 'one_zero_if_hour_zero': false, // only one zero "0" if hour is zero "0" - 'leave_off_closed': true, // leave keywords of and closed as is + 'leave_off_closed': true, // leave keywords "off" and "closed" as is 'keyword_for_off_closed': 'off', // use given keyword instead of "off" or "closed" - 'block_sep_string': ' ', // separate blocks by string - 'print_semicolon': true, // print token which separates normal blocks + 'rule_sep_string': ' ', // separate rules by string + 'print_semicolon': true, // print token which separates normal rules 'leave_weekday_sep_one_day_betw': true, // use the separator (either "," or "-" which is used to separate days which follow to each other like Sa,Su or Su-Mo - 'sep_one_day_between': ',' // separator which should be used + 'sep_one_day_between': ',', // separator which should be used + 'zero_pad_month_and_week_numbers': false, // Format week (e.g. `week 01`) and month day numbers (e.g. `Jan 01`) with "%02d". }; @@ -1777,29 +1860,8 @@ var msec_in_day = 1000 * 60 * minutes_in_day; var msec_in_week = msec_in_day * 7; - // }}} - - // The big picture -- How does this library work? {{{ - //====================================================================== - // Constructor - entry to parsing code - //====================================================================== - // Terminology: - // - // Mo-Fr 10:00-11:00; Th 10:00-12:00 - // \_____block_____/ \____block___/ - // - // The README refers to blocks as rules, which is more intuitive but less clear. - // Because of that only the README uses the term rule in that context. - // In all internal parts of this project, the term block is used. - // - // Mo-Fr Jan 10:00-11:00 - // \__/ \_/ \_________/ - // selectors (left to right: weekday, month, time) - // - // Logic: - // - Tokenize - // Foreach block: - // - Run top-level (block) parser - // - Which calls sub parser for specific selector types - // - Which produce selector functions + + var library_name = 'opening_hours.js'; + var repository_url = 'https://github.com/ypid/' + library_name; + var issues_url = repository_url + '/issues?state=open'; // }}} @@ -1827,32 +1889,43 @@ if (typeof oh_mode == 'undefined') { oh_mode = 0; - } else if (!(typeof oh_mode == 'number' && (oh_mode == 0 || oh_mode == 1 || oh_mode == 2))) { - throw 'The third constructor parameter is oh_mode and must be a number (0, 1 or 2)' + } else if (!(typeof oh_mode == 'number' && (oh_mode === 0 || oh_mode == 1 || oh_mode == 2))) { + throw 'The third constructor parameter is oh_mode and must be a number (0, 1 or 2)'; } // }}} - // put tokenized blocks into list {{{ - if (value.match(/^(\s*;?\s*)+$/)) + // Tokenize value and generate selector functions. {{{ + if (value.match(/^(?:\s*;?\s*)+$/)) throw 'Value contains nothing meaningful which can be parsed'; - var parsing_warnings = []; + var parsing_warnings = []; // Elements are fed into function formatWarnErrorMessage(nrule, at, message) var done_with_warnings = false; // The functions which throw warnings can be called multiple times. - var has_token = {}; + var done_with_selector_reordering = false; + var done_with_selector_reordering_warnings = false; var tokens = tokenize(value); - // console.log(JSON.stringify(tokens, null, '\t')); + // console.log(JSON.stringify(tokens, null, ' ')); var prettified_value = ''; - var used_subparsers = {}; // Used sub parsers for one block, will be reset for each block. Declared in global namespace, because it is manipulation inside various sub parsers. var week_stable = true; - var blocks = []; - - for (var nblock = 0; nblock < tokens.length; nblock++) { - if (tokens[nblock][0].length == 0) continue; - // Block does contain nothing useful e.g. second block of '10:00-12:00;' (empty) which needs to be handled. + var rules = []; + var new_tokens = []; + + for (var nrule = 0; nrule < tokens.length; nrule++) { + if (tokens[nrule][0].length === 0) { + // Rule does contain nothing useful e.g. second rule of '10:00-12:00;' (empty) which needs to be handled. + parsing_warnings.push([nrule, -1, + 'This rule does not contain anything useful. Please remove this empty rule.' + + (nrule == tokens.length - 1 && nrule > 0 && !tokens[nrule][1] ? + ' Might it be possible that you are a programmer and adding a semicolon after each statement is hardwired in your muscle memory ;) ?' + + ' The thing is that the semicolon in the opening_hours syntax is defined as rule separator.' + + ' So for compatibility reasons you should omit this last semicolon.': '') + ]); + continue; + } var continue_at = 0; + var next_rule_is_additional = false; do { - if (continue_at == tokens[nblock][0].length) break; - // Additional block does contain nothing useful e.g. second block of '10:00-12:00,' (empty) which needs to be handled. + if (continue_at == tokens[nrule][0].length) break; + // Additional rule does contain nothing useful e.g. second rule of '10:00-12:00,' (empty) which needs to be handled. var selectors = { @@ -1874,18 +1947,41 @@ date: [], - fallback: tokens[nblock][1], + fallback: tokens[nrule][1], additional: continue_at ? true : false, meaning: true, unknown: false, comment: undefined, - build_from_token_block: undefined, + build_from_token_rule: undefined, }; - selectors.build_from_token_block = [ nblock, continue_at ]; - continue_at = parseGroup(tokens[nblock][0], continue_at, selectors, nblock); - if (typeof continue_at == 'object') + selectors.build_from_token_rule = [ nrule, continue_at, new_tokens.length ]; + continue_at = parseGroup(tokens[nrule][0], continue_at, selectors, nrule); + if (typeof continue_at == 'object') { continue_at = continue_at[0]; - else + } else { continue_at = 0; + } + + // console.log('Current tokens: ' + JSON.stringify(tokens[nrule], null, ' ')); + + new_tokens.push( + [ + tokens[nrule][0].slice( + selectors.build_from_token_rule[1], + continue_at === 0 + ? tokens[nrule][0].length + : continue_at + ), + tokens[nrule][1], + tokens[nrule][2], + ] + ); + + if (next_rule_is_additional && new_tokens.length > 1) { + // Move 'rule separator' from last token of last rule to first token of this rule. + new_tokens[new_tokens.length - 1][0].unshift(new_tokens[new_tokens.length - 2][0].pop()); + } + + next_rule_is_additional = continue_at === 0 ? false : true; if (selectors.year.length > 0) @@ -1903,8 +1999,8 @@ // console.log('weekday: ' + JSON.stringify(selectors.weekday, null, '\t')); - blocks.push(selectors); + rules.push(selectors); // This handles selectors with time ranges wrapping over midnight (e.g. 10:00-02:00) - // it generates wrappers for all selectors and creates a new block. + // it generates wrappers for all selectors and creates a new rule. if (selectors.wraptime.length > 0) { var wrapselectors = { @@ -1917,4 +2013,6 @@ wrapped: true, + // build_from_token_rule: selectors.build_from_token_rule, + // Not (yet) needed. }; @@ -1928,109 +2026,237 @@ } - blocks.push(wrapselectors); + rules.push(wrapselectors); } - } while (continue_at) + } while (continue_at); + } + // console.log(JSON.stringify(tokens, null, ' ')); + // console.log(JSON.stringify(new_tokens, null, ' ')); + // }}} + + /* Format warning or error message for the user. {{{ + * + * :param nrule: Rule number starting with zero. + * :param at: Token position at which the issue occurred. + * :param message: Human readable string with the message. + * :returns: String with position of the warning or error marked for the user. + */ + function formatWarnErrorMessage(nrule, at, message) { + // FIXME: Change to new_tokens. + if (typeof nrule == 'number') { + var pos = 0; + if (nrule == -1) { // Usage of rule index not required because we do have access to value.length. + pos = value.length - at; + } else { // Issue accrued at a later time, position in string needs to be reconstructed. + if (typeof tokens[nrule][0][at] == 'undefined') { + if (typeof tokens[nrule][0] && at == -1) { + pos = value.length; + if (typeof tokens[nrule+1] == 'object' && typeof tokens[nrule+1][2] == 'number') { + pos -= tokens[nrule+1][2]; + } else if (typeof tokens[nrule][2] == 'number') { + pos -= tokens[nrule][2]; + } + } else { + // Given position is invalid. + // + formatLibraryBugMessage('Bug in warning generation code which could not determine the exact position of the warning or error in value.'); + pos = value.length; + if (typeof tokens[nrule][2] != 'undefined') { + // Fallback: Point to last token in the rule which caused the problem. + // Run real_test regularly to fix the problem before a user is confronted with it. + pos -= tokens[nrule][2]; + console.warn('Last token for rule: ' + tokens[nrule]); + console.log(value.substring(0, pos) + ' <--- (' + message + ')'); + console.log('\n'); + } { + console.warn('tokens[nrule][2] is undefined. This is ok if nrule is the last rule.'); + } + } + } else { + pos = value.length; + if (typeof tokens[nrule][0][at+1] != 'undefined') { + pos -= tokens[nrule][0][at+1][2]; + } else if (typeof tokens[nrule][2] != 'undefined') { + pos -= tokens[nrule][2]; + } + } + } + return value.substring(0, pos) + ' <--- (' + message + ')'; + } else if (typeof nrule == 'string') { + return nrule.substring(0, at) + ' <--- (' + message + ')'; + } } // }}} - /* Tokenization function: Splits string into parts. {{{ + /* Format internal library error message. {{{ + * + * :param message: Human readable string with the error message. + * :returns: Error message for the user. + */ + function formatLibraryBugMessage(message) { + if (typeof message == 'undefined') + message = ''; + else + message = ' ' + message; + + message = 'An error occurred during evaluation of the value "' + value + '".' + + ' Please file a bug report here: ' + issues_url + '.' + + message; + console.log(message); + return message; + } + // }}} + + /* Tokenize input stream. {{{ * * :param value: Raw opening_hours value. - * :returns: Tokenized list object. Complex structure. You can print the - * thing as JSON if you would like to know in details. - * The most inner list has the following items: [ internal_value, token_name, value_length ]. + * :returns: Tokenized list object. Complex structure. Check the + * internal documentation in the doc directory for details. */ function tokenize(value) { - var all_tokens = new Array(); - var curr_block_tokens = new Array(); - - var last_block_fallback_terminated = false; - - while (value != '') { + var all_tokens = []; + var curr_rule_tokens = []; + + var last_rule_fallback_terminated = false; + + while (value !== '') { + // console.log("Parsing value: " + value); var tmp; - if (tmp = value.match(/^(?:week\b|open\b|unknown\b)/i)) { + if (tmp = value.match(/^week\b/i)) { // Reserved keywords. - curr_block_tokens.push([tmp[0].toLowerCase(), tmp[0].toLowerCase(), value.length ]); + curr_rule_tokens.push([tmp[0].toLowerCase(), tmp[0].toLowerCase(), value.length ]); + value = value.substr(tmp[0].length); + } else if (tmp = value.match(/^(?:off\b|closed\b|open\b|unknown\b)/i)) { + // Reserved keywords. + curr_rule_tokens.push([tmp[0].toLowerCase(), 'state', value.length ]); value = value.substr(tmp[0].length); } else if (tmp = value.match(/^24\/7/i)) { // Reserved keyword. - has_token[tmp[0]] = true; - curr_block_tokens.push([tmp[0], tmp[0], value.length ]); - value = value.substr(tmp[0].length); - } else if (tmp = value.match(/^(?:off|closed)/i)) { - // Reserved keywords. - curr_block_tokens.push([tmp[0].toLowerCase(), 'closed', value.length ]); + curr_rule_tokens.push([tmp[0], tmp[0], value.length ]); value = value.substr(tmp[0].length); } else if (tmp = value.match(/^(?:PH|SH)/i)) { // special day name (holidays) - curr_block_tokens.push([tmp[0].toUpperCase(), 'holiday', value.length ]); + curr_rule_tokens.push([tmp[0].toUpperCase(), 'holiday', value.length ]); value = value.substr(2); - } else if (tmp = value.match(/^days?/i)) { - curr_block_tokens.push([tmp[0].toLowerCase(), 'calcday', value.length ]); - value = value.substr(tmp[0].length); - } else if (tmp = value.match(/^(&|_|→|–|−|=|opening_hours=|ー|\?|~|～|：|°°|25x7|7[ ]?days( a week|)|all days?|every day|-late|public holidays?|7j?\/7|every day|до|рм|ам|jours fériés|sonn-|[a-zäößàáéøčěíúýřПнВсо]+\b)\.?/i)) { - // Handle all remaining words with error tolerance. + } else if (tmp = value.match(/^(&|_|→|–|−|=|·|opening_hours=|ー|\?|~|～|：|°°|24x7|24 hours 7 days a week|24 hours|7 ?days(?:(?: a |\/)week)?|7j?\/7|all days?|every day|-?(?:(?:till? )?late|open[ ]?end)|(?:(?:one )?day (?:before|after) )?(?:school|public) holidays?|days?\b|до|рм|ам|jours fériés|on work days?|(?:nur |an )?sonn-(?:(?: und |\/)feiertag(?:s|en))?|[a-zäößàáéøčěíúýřПнВсо]+\b|à|á|mo|tu|we|th|fr|sa|su|jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\.?/i)) { + /* Handle all remaining words and specific other characters with error tolerance. + * + * à|á: Word boundary does not work with unicode chars: 'test à test'.match(/\bà\b/i) + * https://stackoverflow.com/questions/10590098/javascript-regexp-word-boundaries-unicode-characters + * Order in the regular expression capturing group is important in some cases. + * + * mo|tu|we|th|fr|sa|su|jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec: Prefer defended keywords + * if used in cases like 'mo12:00-14:00' (when keyword is followed by number). + */ var correct_val = returnCorrectWordOrToken(tmp[1].toLowerCase(), value.length); + // console.log('Error tolerance for string "' + tmp[1] + '" returned "' + correct_val + '".'); if (typeof correct_val == 'object') { - curr_block_tokens.push([ correct_val[0], correct_val[1], value.length ]); + curr_rule_tokens.push([ correct_val[0], correct_val[1], value.length ]); value = value.substr(tmp[0].length); } else if (typeof correct_val == 'string') { if (tmp[1].toLowerCase() == 'pm') { - var hours_token_at = curr_block_tokens.length - 3; - if (hours_token_at > 0) { - if (matchTokens(curr_block_tokens, hours_token_at, - 'number', 'timesep', 'number') - ) { - var hours_token = curr_block_tokens[hours_token_at]; - } else if (matchTokens(curr_block_tokens, hours_token_at + 2, - 'number') - ) { - hours_token_at += 2; - var hours_token = curr_block_tokens[hours_token_at]; + var hours_token_at = curr_rule_tokens.length - 1; + var hours_token; + if (hours_token_at >= 0) { + if (hours_token_at -2 >= 0 && + matchTokens( + curr_rule_tokens, hours_token_at - 2, + 'number', 'timesep', 'number' + ) + ) { + hours_token_at -= 2; + hours_token = curr_rule_tokens[hours_token_at]; + } else if (matchTokens(curr_rule_tokens, hours_token_at, 'number')) { + hours_token = curr_rule_tokens[hours_token_at]; } - if (hours_token[0] <= 12) { + + if (typeof hours_token == 'object' && hours_token[0] <= 12) { hours_token[0] += 12; - curr_block_tokens[hours_token_at] = hours_token; + curr_rule_tokens[hours_token_at] = hours_token; } } } - value = correct_val + value.substr(tmp[0].length); + var correct_tokens = tokenize(correct_val)[0]; + if (correct_tokens[1] === true) { // last_rule_fallback_terminated + throw formatLibraryBugMessage(); + } + for (var i = 0; i < correct_tokens[0].length; i++) { + curr_rule_tokens.push([correct_tokens[0][i][0], correct_tokens[0][i][1], value.length]); + // value.length - tmp[0].length does not have the desired effect for all test cases. + } + + value = value.substr(tmp[0].length); + // value = correct_val + value.substr(tmp[0].length); + // Does not work because it would generate the wrong length for formatWarnErrorMessage. } else { // other single-character tokens - curr_block_tokens.push([value[0].toLowerCase(), value[0].toLowerCase(), value.length - 1 ]); + curr_rule_tokens.push([value[0].toLowerCase(), value[0].toLowerCase(), value.length - 1 ]); value = value.substr(1); } } else if (tmp = value.match(/^\d+/)) { // number - if (tmp[0] > 1900) // Assumed to be a year number. - curr_block_tokens.push([tmp[0], 'year', value.length ]); - else - curr_block_tokens.push([+tmp[0], 'number', value.length ]); + if (Number(tmp[0]) > 1900) { // Assumed to be a year number. + curr_rule_tokens.push([tmp[0], 'year', value.length ]); + if (Number(tmp[0]) >= 2100) // Probably an error + parsing_warnings.push([ -1, value.length - 1, + 'The number ' + Number(tmp[0]) + ' will be interpreted as year.' + + ' This is probably not intended. Times can be specified as "12:00".' + ]); + } else { + curr_rule_tokens.push([Number(tmp[0]), 'number', value.length ]); + } + value = value.substr(tmp[0].length); - } else if (tmp = value.match(/^"([^"]*)"/)) { - // comment - curr_block_tokens.push([tmp[1], 'comment', value.length ]); + } else if (tmp = value.match(/^"([^"]+)"/)) { + // Comment following the specification. + // Any character is allowed inside the comment except " itself. + curr_rule_tokens.push([tmp[1], 'comment', value.length ]); + value = value.substr(tmp[0].length); + } else if (tmp = value.match(/^(["'„“‚‘’«「『])([^"'“”‘’»」』;|]*)(["'”“‘’»」』])/)) { + // Comments with error tolerance. + // The comments still have to be somewhat correct meaning + // the start and end quote signs used have to be + // appropriate. So “testing„ will not match as it is not a + // quote but rather something unknown which the user should + // fix first. + // console.log('Matched: ' + JSON.stringify(tmp)); + for (var pos = 1; pos <= 3; pos += 2) { + // console.log('Pos: ' + pos + ', substring: ' + tmp[pos]); + var correct_val = returnCorrectWordOrToken(tmp[pos], + value.length - (pos == 3 ? tmp[1].length + tmp[2].length : 0) + ); + if (typeof correct_val != 'string' && tmp[pos] != '"') { + throw formatLibraryBugMessage( + 'A character for error tolerance was allowed in the regular expression' + + ' but is not covered by word_error_correction' + + ' which is needed to format a proper message for the user.' + ); + } + } + curr_rule_tokens.push([tmp[2], 'comment', value.length ]); value = value.substr(tmp[0].length); } else if (value.match(/^;/)) { - // semicolon terminates block - // next tokens belong to a new block - all_tokens.push([ curr_block_tokens, last_block_fallback_terminated, value.length ]); + // semicolon terminates rule + // next tokens belong to a new rule + all_tokens.push([ curr_rule_tokens, last_rule_fallback_terminated, value.length ]); value = value.substr(1); - curr_block_tokens = []; - last_block_fallback_terminated = false; + curr_rule_tokens = []; + last_rule_fallback_terminated = false; } else if (value.match(/^\|\|/)) { - // || terminates block - // next tokens belong to a fallback block - if (curr_block_tokens.length == 0) + // || terminates rule + // Next tokens belong to a fallback rule. + if (curr_rule_tokens.length === 0) throw formatWarnErrorMessage(-1, value.length - 2, 'Rule before fallback rule does not contain anything useful'); - all_tokens.push([ curr_block_tokens, last_block_fallback_terminated, value.length ]); + all_tokens.push([ curr_rule_tokens, last_rule_fallback_terminated, value.length ]); + curr_rule_tokens = []; + // curr_rule_tokens = [ [ '||', 'rule separator', value.length ] ]; + // FIXME: Use this. Unknown bug needs to be solved in the process. value = value.substr(2); - curr_block_tokens = []; - last_block_fallback_terminated = true; + last_rule_fallback_terminated = true; } else if (value.match(/^(?:␣|\s)/)) { - // Using "␣" as space is not expected to be a normal mistake. Just ignore it to make using taginfo easier. + // Using "␣" as space is not expected to be a normal + // mistake. Just ignore it to make using taginfo easier. value = value.substr(1); } else if (tmp = value.match(/^\s+/)) { @@ -2041,14 +2267,14 @@ if (value[0] == '.' && !done_with_warnings) parsing_warnings.push([ -1, value.length - 1, 'Please use ":" as hour/minute-separator' ]); - curr_block_tokens.push([ ':', 'timesep', value.length ]); + curr_rule_tokens.push([ ':', 'timesep', value.length ]); value = value.substr(1); } else { // other single-character tokens - curr_block_tokens.push([value[0].toLowerCase(), value[0].toLowerCase(), value.length ]); + curr_rule_tokens.push([value[0].toLowerCase(), value[0].toLowerCase(), value.length ]); value = value.substr(1); } } - all_tokens.push([ curr_block_tokens, last_block_fallback_terminated ]); + all_tokens.push([ curr_rule_tokens, last_rule_fallback_terminated ]); return all_tokens; @@ -2064,5 +2290,5 @@ * * (valid) opening_hours sub string. * * object with [ internal_value, token_name ] if value is correct. - * * undefined if word could not be found (and thus not be corrected). + * * undefined if word could not be found (and thus is not be corrected). */ function returnCorrectWordOrToken(word, value_length) { @@ -2089,10 +2315,9 @@ } if (typeof correct_abbr == 'undefined') { - throw 'Please file a bug for opening_hours.js.' - + ' Including the stacktrace.' + throw formatLibraryBugMessage('Including the stacktrace.'); } if (token_name != 'timevar') { // Everything else than timevar: - // E.g. 'Mo' are start with a upper case letter. + // E.g. 'Mo' start with a upper case letter. // It just looks better. correct_abbr = correct_abbr.charAt(0).toUpperCase() @@ -2118,7 +2343,175 @@ */ function getWarnings(it) { - if (typeof it == 'object') { // getWarnings was called in a state without critical errors. We can do extended tests. - - // Check if 24/7 is used and it does not mean 24/7 because there are other blocks. + if (!done_with_warnings && typeof it == 'object') { + /* getWarnings was called in a state without critical errors. + * We can do extended tests. + */ + + /* Place all tests in this function if an additional (high + * level) test is added and this does not require to rewrite + * big parts of (sub) selector parsers only to get the + * position. If that is the case, then rather place the test + * code in the (sub) selector parser function directly. + */ + + var wide_range_selectors = [ 'year', 'month', 'week', 'holiday' ]; + var small_range_selectors = [ 'weekday', 'time', '24/7', 'state', 'comment']; + + // How many times was a selector_type used per rule? {{{ + var used_selectors = []; + var used_selectors_types_array = []; + var has_token = {}; + + for (var nrule = 0; nrule < new_tokens.length; nrule++) { + if (new_tokens[nrule][0].length === 0) continue; + // Rule does contain nothing useful e.g. second rule of '10:00-12:00;' (empty) which needs to be handled. + + var selector_start_end_type = [ 0, 0, undefined ], + prettified_group_value = []; + // console.log(new_tokens[nrule][0]); + + used_selectors[nrule] = {}; + used_selectors_types_array[nrule] = []; + + do { + selector_start_end_type = getSelectorRange(new_tokens[nrule][0], selector_start_end_type[1]); + // console.log(selector_start_end_type, new_tokens[nrule][0].length); + + if (selector_start_end_type[0] == selector_start_end_type[1] && + new_tokens[nrule][0][selector_start_end_type[0]][0] == '24/7' + ) { + has_token['24/7'] = true; + } + + if (typeof used_selectors[nrule][selector_start_end_type[2]] != 'object') { + used_selectors[nrule][selector_start_end_type[2]] = [ selector_start_end_type[1] ]; + } else { + used_selectors[nrule][selector_start_end_type[2]].push(selector_start_end_type[1]); + } + used_selectors_types_array[nrule].push(selector_start_end_type[2]); + + selector_start_end_type[1]++; + } while (selector_start_end_type[1] < new_tokens[nrule][0].length); + } + // console.log('used_selectors: ' + JSON.stringify(used_selectors, null, ' ')); + // }}} + + for (var nrule = 0; nrule < used_selectors.length; nrule++) { + + /* Check if more than one not connected selector of the same type is used in one rule {{{ */ + for (var selector_type in used_selectors[nrule]) { + // console.log(selector_type + ' use at: ' + used_selectors[nrule][selector_type].length); + if (used_selectors[nrule][selector_type].length > 1) { + parsing_warnings.push([nrule, used_selectors[nrule][selector_type][used_selectors[nrule][selector_type].length - 1], + 'You have used ' + used_selectors[nrule][selector_type].length + + (selector_type.match(/^(?:comment|state)/) ? + ' ' + selector_type + + (selector_type == 'state' ? ' keywords' : 's') + + ' in one rule.' + + ' You may only use one in one rule.' + : + ' not connected ' + selector_type + + (selector_type.match(/^(?:month|weekday)$/) ? 's' : ' ranges') + + ' in one rule.' + + ' This is probably an error.' + + ' Equal selector types can (and should) always be written in conjunction separated by comma or something.' + + ' Example for time ranges "12:00-13:00,15:00-18:00".' + + ' Example for weekdays "Mo-We,Fr".' + ) + + ' Rules can be separated by ";".' ] + ); + done_with_selector_reordering = true; // Correcting the selector order makes no sense if this kind of issue exists. + } + } + /* }}} */ + + /* Check if change default state rule is not the first rule {{{ */ + if ( typeof used_selectors[nrule].state === 'object' + && Object.keys(used_selectors[nrule]).length === 1 + ) { + + if (nrule !== 0) { + parsing_warnings.push([nrule, new_tokens[nrule][0].length - 1, + "This rule which changes the default state (which is closed) for all following rules is not the first rule." + + " The rule will overwrite all previous rules." + + " It can be legitimate to change the default state to open for example" + + " and then only specify for which times the facility is closed." + ]); + } + /* }}} */ + /* Check if a rule (with state open) has no time selector {{{ */ + } else if (typeof used_selectors[nrule].time === 'undefined') { + if ( ( typeof used_selectors[nrule].state === 'object' + && new_tokens[nrule][0][used_selectors[nrule].state[0]][0] === 'open' + && typeof used_selectors[nrule].comment === 'undefined' + ) || ( typeof used_selectors[nrule].comment === 'undefined' + && typeof used_selectors[nrule].state === 'undefined' + ) && + typeof used_selectors[nrule]['24/7'] === 'undefined' + ) { + + parsing_warnings.push([nrule, new_tokens[nrule][0].length - 1, + "This rule is not very explicit because there is no time selector being used." + + " Please add a time selector to this rule or use a comment to make it more explicit." + ]); + } + } + /* }}} */ + + /* Check if empty comment was given {{{ */ + if (typeof used_selectors[nrule].comment === 'object' + && new_tokens[nrule][0][used_selectors[nrule].comment[0]][0].length === 0 + ) { + + parsing_warnings.push([nrule, used_selectors[nrule].comment[0], + "You have used an empty comment." + + " Please either write something in the comment or use the keyword unknown instead." + ]); + } + /* }}} */ + + /* Check if rule with closed|off modifier is additional {{{ */ + /* FIXME: Enable this test. */ + if (typeof new_tokens[nrule][0][0] === 'object' + && new_tokens[nrule][0][0][0] === ',' + && new_tokens[nrule][0][0][1] === 'rule separator' + && typeof used_selectors[nrule].state === 'object' + && ( + new_tokens[nrule][0][used_selectors[nrule].state[0]][0] === 'closed' + || new_tokens[nrule][0][used_selectors[nrule].state[0]][0] === 'off' + ) + ) { + + // parsing_warnings.push([nrule, new_tokens[nrule][0].length - 1, + // "This rule will be evaluated as closed but it was specified as additional rule." + // + " It is enough to specify this rule as normal rule using the \";\" character." + // + " See https://wiki.openstreetmap.org/wiki/Key:opening_hours:specification#explain:rule_modifier:closed." + // ]); + } + /* }}} */ + + /* Check for valid use of {{{ */ + for (var i = 0; i < used_selectors_types_array[nrule].length - 1; i++) { + var selector_type = used_selectors_types_array[nrule][i]; + var next_selector_type = used_selectors_types_array[nrule][i+1]; + if ( ( wide_range_selectors.indexOf(selector_type) != -1 + && wide_range_selectors.indexOf(next_selector_type) != -1 + ) || ( small_range_selectors.indexOf(selector_type) != -1 + && small_range_selectors.indexOf(next_selector_type) != -1) + ) { + + if (new_tokens[nrule][0][used_selectors[nrule][selector_type][0]][0] == ':') { + parsing_warnings.push([nrule, used_selectors[nrule][selector_type][0], + "You have used the optional symbol in the wrong place." + + " Please check the syntax specification to see where it could be used or remove it." + ]); + } + } + } + /* }}} */ + + } + + /* Check if 24/7 is used and it does not mean 24/7 because there are other rules {{{ */ var has_advanced = it.advance(); @@ -2130,7 +2523,12 @@ + ' e.g. "open; Mo 12:00-14:00 off".']); } + /* }}} */ + + prettifyValue(); } + done_with_warnings = true; var warnings = []; + // FIXME: Sort based on parsing_warnings[1], tricky … for (var i = 0; i < parsing_warnings.length; i++) { warnings.push( formatWarnErrorMessage(parsing_warnings[i][0], parsing_warnings[i][1], parsing_warnings[i][2]) ); @@ -2138,7 +2536,219 @@ return warnings; } + + /* Helpers for getWarnings {{{ */ + + /* Check if token is the begin of a selector and why. {{{ + * + * :param tokens: List of token objects. + * :param at: Position where to start. + * :returns: + * * false the current token is not the begin of a selector. + * * Position in token array from where the decision was made that + * the token is the start of a selector. + */ + function tokenIsTheBeginOfSelector(tokens, at) { + if (typeof tokens[at][3] == 'string') { + return 3; + } else if (tokens[at][1] == 'comment' + || tokens[at][1] == 'state' + || tokens[at][1] == '24/7' + || tokens[at][1] == 'rule separator' + ){ + + return 1; + } else { + return false; + } + } + /* }}} */ + + /* Get start and end position of a selector. {{{ + * For example this value 'Mo-We,Fr' will return the position of the + * token lexeme 'Mo' and 'Fr' e.g. there indexes [ 0, 4 ] in the + * selector array of tokens. + * + * :param tokens: List of token objects. + * :param at: Position where to start. + * :returns: Array: + * 0. Index of first token in selector array of tokens. + * 1. Index of last token in selector array of tokens. + * 2. Selector type. + */ + function getSelectorRange(tokens, at) { + var selector_start = at, + selector_end, + pos_in_token_array; + + for (; selector_start >= 0; selector_start--) { + pos_in_token_array = tokenIsTheBeginOfSelector(tokens, selector_start); + if (pos_in_token_array) + break; + } + selector_end = selector_start; + + if (pos_in_token_array === 1) { + // Selector consists of a single token. + + // Include tailing colon. + if (selector_end + 1 < tokens.length && tokens[selector_end + 1][0] == ':') + selector_end++; + + return [ selector_start, selector_end, tokens[selector_start][pos_in_token_array] ]; + } + + for (selector_end++; selector_end < tokens.length ; selector_end++) { + if (tokenIsTheBeginOfSelector(tokens, selector_end)) + return [ selector_start, selector_end - 1, tokens[selector_start][pos_in_token_array] ]; + } + + return [ selector_start, selector_end - 1, tokens[selector_start][pos_in_token_array] ]; + } + /* }}} */ + /* }}} */ + /* }}} */ + + /* Prettify raw value from user. {{{ + * The value is generated by putting the tokens back together to a string. + * + * :param argument_hash: Hash which can contain: + * 'conf': Configuration hash. + * 'get_internals: If true export internal data structures. + * 'rule_index: Only prettify the rule with this index. + * :returns: Prettified value string or object if get_internals is true. + */ + function prettifyValue(argument_hash) { + var user_conf = {}, + get_internals = false, + rule_index; + if (typeof argument_hash != 'undefined') { + + if (typeof argument_hash.conf === 'object') + user_conf = argument_hash.conf; + + if (typeof argument_hash.rule_index === 'number') + rule_index = argument_hash.rule_index; + + if (argument_hash.get_internals === true) + get_internals = true; + } + + for (var key in default_prettify_conf) { + if (typeof user_conf[key] == 'undefined') + user_conf[key] = default_prettify_conf[key]; + } + + prettified_value = ''; + var prettified_value_array = []; + + for (var nrule = 0; nrule < new_tokens.length; nrule++) { + if (new_tokens[nrule][0].length === 0) continue; + // Rule does contain nothing useful e.g. second rule of '10:00-12:00;' (empty) which needs to be handled. + + if (typeof rule_index == 'number') { + if (rule_index != nrule) continue; + } else { + if (nrule !== 0) + prettified_value += ( + new_tokens[nrule][1] + ? user_conf.rule_sep_string + '|| ' + : ( + new_tokens[nrule][0][0][1] == 'rule separator' + ? ',' + : ( + user_conf.print_semicolon + ? ';' + : '' + ) + ) + + user_conf.rule_sep_string); + } + + var selector_start_end_type = [ 0, 0, undefined ], + prettified_group_value = []; + // console.log(new_tokens[nrule][0]); + var count = 0; + + + do { + selector_start_end_type = getSelectorRange(new_tokens[nrule][0], selector_start_end_type[1]); + // console.log(selector_start_end_type, new_tokens[nrule][0].length, count); + + if (count > 50) { + throw formatLibraryBugMessage('infinite loop'); + } + + if (selector_start_end_type[2] != 'rule separator') { + prettified_group_value.push( + [ + selector_start_end_type, + prettifySelector( + new_tokens[nrule][0], + selector_start_end_type[0], + selector_start_end_type[1], + selector_start_end_type[2], + user_conf + ), + ] + ); + } + + selector_start_end_type[1]++; + count++; + // console.log(selector_start_end_type, new_tokens[nrule][0].length, count); + } while (selector_start_end_type[1] < new_tokens[nrule][0].length); + // console.log('Prettified value: ' + JSON.stringify(prettified_group_value, null, ' ')); + var not_sorted_prettified_group_value = prettified_group_value.slice(); + + if (!done_with_selector_reordering) { + prettified_group_value.sort( + function (a, b) { + var selector_order = [ 'year', 'month', 'week', 'holiday', 'weekday', 'time', '24/7', 'state', 'comment']; + return selector_order.indexOf(a[0][2]) - selector_order.indexOf(b[0][2]); + } + ); + } + var old_prettified_value_length = prettified_value.length; + + prettified_value += prettified_group_value.map( + function (array) { + return array[1]; + } + ).join(' '); + + prettified_value_array.push( prettified_group_value ); + + if (!done_with_selector_reordering_warnings) { + for (var i = 0, l = not_sorted_prettified_group_value.length; i < l; i++) { + if (not_sorted_prettified_group_value[i] != prettified_group_value[i]) { + // console.log(i + ': ' + prettified_group_value[i][0][2]); + var length = i + old_prettified_value_length; // i: Number of spaces in string. + for (var x = 0; x <= i; x++) { + length += prettified_group_value[x][1].length; + // console.log('Length: ' + length + ' ' + prettified_group_value[x][1]); + } + // console.log(length); + parsing_warnings.push([ prettified_value, length, + 'The selector "' + prettified_group_value[i][0][2] + '" was switched with' + + ' the selector "' + not_sorted_prettified_group_value[i][0][2] + '"' + + ' for readablitity and compatibiltity reasons.' + ]); + } + } + } + } + + done_with_selector_reordering_warnings = true; + // console.log(JSON.stringify(prettified_value_array, null, ' ')); + + if (get_internals) { + return [ prettified_value_array, new_tokens ]; + } else { + return prettified_value; + } + } // }}} - /* Function to check token array for specific pattern {{{ + /* Check selector array of tokens for specific token name pattern. {{{ * * :param tokens: List of token objects. @@ -2173,5 +2783,5 @@ return res; return [ res[0], new Date(res[1].getTime() - shift) ]; - } + }; } // }}} @@ -2180,17 +2790,14 @@ * * :param tokens: List of token objects. - * :param at: Position at which the matching should begin. + * :param at: Position where to start. * :param selectors: Reference to selector object. - * :param nblock: Block number starting with 0. - * :param conf: Configuration for prettifyValue. + * :param nrule: Rule number starting with 0. * :returns: See selector code. */ - function parseGroup(tokens, at, selectors, nblock, conf) { - var prettified_group_value = ''; - used_subparsers = { 'time ranges': [ ] }; + function parseGroup(tokens, at, selectors, nrule) { + var rule_modifier_specified = false; // console.log(tokens); // useful for debugging of tokenize while (at < tokens.length) { - var old_at = at; // console.log('Parsing at position', at +':', tokens[at]); if (matchTokens(tokens, at, 'weekday')) { @@ -2212,5 +2819,6 @@ || matchTokens(tokens, at, 'year', 'event') || matchTokens(tokens, at, 'event')) { - at = parseMonthdayRange(tokens, at, nblock); + + at = parseMonthdayRange(tokens, at, nrule); week_stable = false; } else if (matchTokens(tokens, at, 'year')) { @@ -2219,21 +2827,20 @@ } else if (matchTokens(tokens, at, 'month')) { at = parseMonthRange(tokens, at); - // week_stable = false; // decided based on actual values + // week_stable = false; // Decided based on the actual value/tokens. } else if (matchTokens(tokens, at, 'week')) { - at = parseWeekRange(tokens, at + 1); - week_stable = false; - - // if (prettified_group_value[-1] != ' ') - // prettified_group_value = prettified_group_value.substring(0, prettified_group_value.length - 1); - } else if (at != 0 && at != tokens.length - 1 && tokens[at][0] == ':') { - // Ignore colon if they appear somewhere else than as time separator. - // Except the start or end of the value. - // This provides compatibility with the syntax proposed by Netzwolf: - // http://wiki.openstreetmap.org/wiki/Key:opening_hours:specification - if (!done_with_warnings && (matchTokens(tokens, at-1, 'weekday') || matchTokens(tokens, at-1, 'holiday'))) - parsing_warnings.push([nblock, at, 'Please don’t use ":" after ' + tokens[at-1][1] + '.']); - - if (prettified_group_value[-1] != ' ') - prettified_group_value = prettified_group_value.substring(0, prettified_group_value.length - 1); + tokens[at][3] = 'week'; + at = parseWeekRange(tokens, at); + + } else if (at !== 0 && at != tokens.length - 1 && tokens[at][0] == ':') { + /* Ignore colon if they appear somewhere else than as time separator. + * Except the start or end of the value. + * This provides compatibility with the syntax proposed by Netzwolf: + * http://wiki.openstreetmap.org/wiki/Key:opening_hours:specification#separator_for_readability + * Check for valid use of is implemented in function getWarnings(). + */ + + if (!done_with_warnings && matchTokens(tokens, at-1, 'holiday')) + parsing_warnings.push([nrule, at, 'Please don’t use ":" after ' + tokens[at-1][1] + '.']); + at++; } else if (matchTokens(tokens, at, 'number', 'timesep') @@ -2241,112 +2848,68 @@ || matchTokens(tokens, at, '(', 'timevar') || matchTokens(tokens, at, 'number', '-')) { + at = parseTimeRange(tokens, at, selectors, false); - used_subparsers['time ranges'].push(at); - } else if (matchTokens(tokens, at, 'closed')) { - selectors.meaning = false; + } else if (matchTokens(tokens, at, 'state')) { + + if (tokens[at][0] == 'open') { + selectors.meaning = true; + } else if (tokens[at][0] == 'closed' || tokens[at][0] == 'off') { + selectors.meaning = false; + } else { + selectors.meaning = false; + selectors.unknown = true; + } + + rule_modifier_specified = true; at++; - if (matchTokens(tokens, at, ',')) // additional block + if (typeof tokens[at] == 'object' && tokens[at][0] == ',') // additional rule at = [ at + 1 ]; - if (typeof used_subparsers['state keywords'] != 'object') - used_subparsers['state keywords'] = [ at ]; - else - used_subparsers['state keywords'].push(at); - } else if (matchTokens(tokens, at, 'open')) { - selectors.meaning = true; - at++; - if (matchTokens(tokens, at, ',')) // additional block - at = [ at + 1 ]; - - if (typeof used_subparsers['state keywords'] != 'object') - used_subparsers['state keywords'] = [ at ]; - else - used_subparsers['state keywords'].push(at); - } else if (matchTokens(tokens, at, 'unknown')) { - selectors.meaning = false; - selectors.unknown = true; - at++; - if (matchTokens(tokens, at, ',')) // additional block - at = [ at + 1 ]; - - if (typeof used_subparsers['state keywords'] != 'object') - used_subparsers['state keywords'] = [ at ]; - else - used_subparsers['state keywords'].push(at); } else if (matchTokens(tokens, at, 'comment')) { selectors.comment = tokens[at][0]; - if (at > 0) { - if (!matchTokens(tokens, at - 1, 'open') - && !matchTokens(tokens, at - 1, 'closed')) { - // Then it is unknown. Either with unknown explicitly - // specified or just a comment behind. - selectors.meaning = false; - selectors.unknown = true; - } - } else { // block starts with comment - selectors.time.push(function(date) { return [true]; }); - // Not needed. If there is no selector it automatically matches everything. - // WRONG: This only works if there is no other selector in this selector group ... + if (!rule_modifier_specified) { + // Then it is unknown. Either with unknown explicitly + // specified or just a comment. selectors.meaning = false; selectors.unknown = true; } + + rule_modifier_specified = true; at++; - if (matchTokens(tokens, at, ',')) // additional block + if (typeof tokens[at] == 'object' && tokens[at][0] == ',') // additional rule at = [ at + 1 ]; - - if (typeof used_subparsers['comments'] != 'object') - used_subparsers['comments'] = [ at ]; - else - used_subparsers['comments'].push(at); + } else if ((at === 0 || at == tokens.length - 1) && matchTokens(tokens, at, 'rule separator')) { + at++; + console.log("value: " + nrule); + // throw formatLibraryBugMessage('Not implemented yet.'); } else { var warnings = getWarnings(); - throw formatWarnErrorMessage(nblock, at, 'Unexpected token: "' + tokens[at][1] + throw formatWarnErrorMessage(nrule, at, 'Unexpected token: "' + tokens[at][1] + '" This means that the syntax is not valid at that point or it is currently not supported.') + (warnings ? ' ' + warnings.join('; ') : ''); } - if (typeof conf != 'undefined') { - // 'Mo: 12:00-13:00' -> 'Mo 12:00-13:00' - if (used_subparsers['time ranges'] && old_at > 1 && tokens[old_at-1][0] == ':' - && matchTokens(tokens, old_at - 2, 'weekday')) - prettified_group_value = prettified_group_value.substring(0, prettified_group_value.length - 2) + ' '; - - // 'week 1, week 3' -> 'week 1,week 3' - if (prettified_group_value.substr(prettified_group_value.length -2, 2) == ', ' - && matchTokens(tokens, old_at, 'week')) - prettified_group_value = prettified_group_value.substring(0, prettified_group_value.length - 1); - - prettified_group_value += prettifySelector(tokens, old_at, at, conf, used_subparsers['time ranges'].length); - } - - if (typeof at == 'object') // additional block + if (typeof at == 'object') { // additional rule + tokens[at[0] - 1][1] = 'rule separator'; break; - } - - prettified_value += prettified_group_value.replace(/\s+$/, ''); - - if (!done_with_warnings) { - for (var subparser_name in used_subparsers) { - if (used_subparsers[subparser_name].length > 1) { - parsing_warnings.push([nblock, used_subparsers[subparser_name][used_subparsers[subparser_name].length - 1] - 1, - 'You have used ' + used_subparsers[subparser_name].length - + (subparser_name.match(/^(?:comments|state keywords)/) ? - ' ' + subparser_name + ' in one rule.' - + ' You may only use one in one rule.' - : - ' not connected ' + subparser_name + ' in one rule.' - + ' This is probably an error.' - + ' Equal selector types can (and should) always be written in conjunction separated by comma or something.' - + ' Example for time ranges "12:00-13:00,15:00-18:00".' - + ' Example for weekdays "Mo-We,Fr".' - ) - + ' Rules can be separated by ";".' ] - ); - } } } return at; + } + + function get_last_token_pos_in_token_group(tokens, at, last_at) { + for (at++; at < last_at; at++) { + if (typeof tokens[at] != 'undefined') { + if (typeof tokens[at][3] == 'string' + || tokens[at][1] == 'comment' + || tokens[at][1] == 'state'){ + + return at - 1; + } + } + } + return last_at; } // }}} @@ -2370,9 +2933,9 @@ * * :param date: Date object. - * :param day: Integer number for day of week. Starting with zero (Sunday). + * :param weekday: Integer number for day of week. Starting with zero (Sunday). * :returns: Moved date object. */ - function dateAtNextWeekday(date, day) { - var delta = day - date.getDay(); + function dateAtNextWeekday(date, weekday) { + var delta = weekday - date.getDay(); return new Date(date.getFullYear(), date.getMonth(), date.getDate() + delta + (delta < 0 ? 7 : 0)); } @@ -2421,5 +2984,5 @@ // Negative number func(-tokens[at+1][0], -tokens[at+1][0], at); - at += 2 + at += 2; } else if (matchTokens(tokens, at, 'number')) { // Single number @@ -2427,5 +2990,5 @@ at++; } else { - throw formatWarnErrorMessage(nblock, at + matchTokens(tokens, at, '-'), + throw formatWarnErrorMessage(nrule, at + matchTokens(tokens, at, '-'), 'Unexpected token in number range: ' + tokens[at][1]); } @@ -2453,15 +3016,15 @@ // bad number - if (from == 0 || from < -5 || from > 5) - throw formatWarnErrorMessage(nblock, at, + if (from === 0 || from < -5 || from > 5) + throw formatWarnErrorMessage(nrule, at, 'Number between -5 and 5 (except 0) expected'); if (from == to) { - if (number != 0) - throw formatWarnErrorMessage(nblock, at, + if (number !== 0) + throw formatWarnErrorMessage(nrule, at, 'You can not use more than one constrained weekday in a month range'); number = from; } else { - throw formatWarnErrorMessage(nblock, at+2, + throw formatWarnErrorMessage(nrule, at+2, 'You can not use a range of constrained weekdays in a month range'); } @@ -2469,5 +3032,5 @@ if (!matchTokens(tokens, endat, ']')) - throw formatWarnErrorMessage(nblock, endat, '"]" expected.'); + throw formatWarnErrorMessage(nrule, endat, '"]" expected.'); return [ number, endat + 1 ]; @@ -2476,13 +3039,4 @@ // Check if period is ok. Period 0 or 1 don’t make much sense. - /* List parser for constrained weekdays in month range {{{ - * e.g. Su[-1] which selects the last Sunday of the month. - * - * :param tokens: List of token objects. - * :param at: Position where to start. - * :returns: Array: - * 0. Constrained weekday number. - * 1. Position at which the token does not belong to the list any more (after ']' token). - */ function checkPeriod(at, period, period_type, parm_string) { if (done_with_warnings) @@ -2490,17 +3044,26 @@ if (period === 0) { - throw formatWarnErrorMessage(nblock, at, + throw formatWarnErrorMessage(nrule, at, 'You can not use '+ period_type +' ranges with period equals zero.'); } else if (period === 1) { if (typeof parm_string == 'string' && parm_string == 'no_end_year') - parsing_warnings.push([nblock, at, + parsing_warnings.push([nrule, at, 'Please don’t use '+ period_type +' ranges with period equals one.' + ' If you want to express that a facility is open starting from a year without limit use "+".']); else - parsing_warnings.push([nblock, at, + parsing_warnings.push([nrule, at, 'Please don’t use '+ period_type +' ranges with period equals one.']); } } + /* Get date moved to constrained weekday (and moved for add_days. {{{ + * E.g. used for 'Aug Su[-1] -1 day'. + * + * :param year: Year as integer. + * :param month: Month as integer starting with zero. + * :param weekday: Integer number for day of week. Starting with zero (Sunday). + * :param constrained_weekday: Position where to start. + * :returns: Date object. + */ function getDateForConstrainedWeekday(year, month, weekday, constrained_weekday, add_days) { var tmp_date = dateAtNextWeekday( @@ -2514,34 +3077,14 @@ return tmp_date; } - - function formatWarnErrorMessage(nblock, at, message) { - var pos = 0; - if (nblock == -1) { // Usage of block index not required because we do have access to value.length. - pos = value.length - at; - } else { // Issue accrued at a later time, position in string needs to be reconstructed. - if (typeof tokens[nblock][0][at] == 'undefined') { - pos = value.length; - if (typeof tokens[nblock][0][tokens[nblock][0].length-1] != 'undefined') { - // pos -= tokens[nblock][0][tokens[nblock][0].length-1][2]; - console.warn("FIXME"); - } - } else { - pos = value.length; - if (typeof tokens[nblock][0][at+1] != 'undefined') { - pos -= tokens[nblock][0][at+1][2]; - } else if (typeof tokens[nblock][2] != 'undefined') { - pos -= tokens[nblock][2]; - } else { - } - } - } - return value.substring(0, pos) + ' <--- (' + message + ')'; - } - - // check if date is valid - function isValidDate(month, day, nblock, at) { - // month == 0 is Jan - - // May use this instead. Does not say, what is wrong as good was implementation below. + // }}} + + /* Check if date is valid. {{{ + * + * :param month: Month as integer starting with zero. + * :param date: Day of month as integer. + * :returns: undefined. There is no real return value. This function just throws an exception if something is wrong. + */ + function checkIfDateIsValid(month, day, nrule, at) { + // May use this instead. The problem is that this does not give feedback as precise as the code which is used in this function. // var testDate = new Date(year, month, day); // if (testDate.getDate() != day || testDate.getMonth() != month || testDate.getFullYear() != year) { @@ -2551,21 +3094,33 @@ // https://en.wikipedia.org/wiki/Month#Julian_and_Gregorian_calendars if (day < 1 || day > 31) - throw formatWarnErrorMessage(nblock, at, 'Day must be between 1 and 31.'); + throw formatWarnErrorMessage(nrule, at, 'Day must be between 1 and 31.'); if ((month==3 || month==5 || month==8 || month==10) && day==31) - throw formatWarnErrorMessage(nblock, at, 'Month ' + months[month] + " doesn't have 31 days.!"); + throw formatWarnErrorMessage(nrule, at, 'Month ' + months[month] + " doesn't have 31 days.!"); if (month == 1 && day == 30) - throw formatWarnErrorMessage(nblock, at, 'Month ' + months[1]+ " either has 28 or 29 days (leap years)."); + throw formatWarnErrorMessage(nrule, at, 'Month ' + months[1]+ " either has 28 or 29 days (leap years)."); } // }}} - - // Time range parser (10:00-12:00,14:00-16:00) {{{ - // - // extended_open_end: