From: PHO Date: Fri, 26 Mar 2010 08:39:44 +0000 (+0900) Subject: Finished docs X-Git-Tag: RELEASE-0.1.0.1~3 X-Git-Url: http://git.cielonegro.org/gitweb.cgi?p=time-http.git;a=commitdiff_plain;h=42ffc2dd3bba56145796d381e2570739c32d7d74 Finished docs --- diff --git a/Data/Time/Asctime.hs b/Data/Time/Asctime.hs index fd5cca0..2eef569 100644 --- a/Data/Time/Asctime.hs +++ b/Data/Time/Asctime.hs @@ -1,4 +1,4 @@ --- |This module is for ANSI C's asctime() format. +-- |This module provides functions for ANSI C's asctime() format. -- -- ANSI C's asctime() format looks like: -- diff --git a/Data/Time/RFC1123.hs b/Data/Time/RFC1123.hs index bf68f05..43594c5 100644 --- a/Data/Time/RFC1123.hs +++ b/Data/Time/RFC1123.hs @@ -1,3 +1,14 @@ +-- |This module provides functions to parse and format RFC 1123 date +-- and time formats. +-- +-- The format is basically same as RFC 822, but the syntax for @date@ +-- is changed from: +-- +-- > year ::= 2DIGIT +-- +-- to: +-- +-- > year ::= 4DIGIT module Data.Time.RFC1123 ( format , parse @@ -12,12 +23,7 @@ import Data.Time.HTTP.Common import Data.Time.RFC822 (showRFC822TimeZone) import Data.Time.RFC1123.Parsec -{- - The syntax for the date is hereby changed to: - - date = 1*2DIGIT month 2*4DIGIT --} - +-- |Format a 'ZonedTime' in RFC 1123. format :: ZonedTime -> String format zonedTime = let localTime = zonedTimeToLocalTime zonedTime @@ -43,6 +49,8 @@ format zonedTime , showRFC822TimeZone timeZone ] +-- |Parse an RFC 1123 date and time string. When the string can't be +-- parsed, it returns 'Nothing'. parse :: String -> Maybe ZonedTime parse src = case P.parse p "" src of Right zt -> Just zt diff --git a/Data/Time/RFC1123/Parsec.hs b/Data/Time/RFC1123/Parsec.hs index ccdf0bf..08c989c 100644 --- a/Data/Time/RFC1123/Parsec.hs +++ b/Data/Time/RFC1123/Parsec.hs @@ -12,7 +12,7 @@ import Data.Time.HTTP.Common import Data.Time.RFC822.Parsec import Text.Parsec - +-- |This is a parsec parser for RFC 1123 date and time strings. rfc1123DateAndTime :: Stream s m Char => ParsecT s u m ZonedTime rfc1123DateAndTime = dateTime diff --git a/Data/Time/RFC733.hs b/Data/Time/RFC733.hs index 615ce2a..119d01d 100644 --- a/Data/Time/RFC733.hs +++ b/Data/Time/RFC733.hs @@ -1,3 +1,42 @@ +-- |This module provides functions to parse and format RFC 733 date +-- and time formats. +-- +-- The syntax is as follows: +-- +-- > date-time ::= [ day-of-week ", " ] date SP time ("-" | SP) zone +-- > day-of-week ::= "Monday" | "Mon" | "Tuesday" | "Tue" +-- > | "Wednesday" | "Wed" | "Thursday" | "Thu" +-- > | "Friday" | "Fri" | "Saturday" | "Sat" +-- > | "Sunday" | "Sun" +-- > date ::= day ("-" | SP) month ("-" | SP) year +-- > day ::= 2DIGIT +-- > year ::= 2DIGIT | 4DIGIT +-- > month ::= "January" | "Jan" | "February" | "Feb" +-- > | "March" | "Mar" | "April" | "Apr" +-- > | "May" | "June" | "Jun" +-- > | "July" | "Jul" | "August" | "Aug" +-- > | "September" | "Sep" | "October" | "Oct" +-- > | "November" | "Nov" | "December" | "Dec" +-- > time ::= hour [ ":" ] minute [ [ ":" ] second ] +-- > hour ::= 2DIGIT +-- > minute ::= 2DIGIT +-- > second ::= 2DIGIT +-- > zone ::= "GMT" ; Universal Time +-- > | "NST" ; Newfoundland: -3:30 +-- > | "AST" | "ADT" ; Atlantic : -4 / -3 +-- > | "EST" | "EDT" ; Eastern : -5 / -4 +-- > | "CST" | "CDT" ; Central : -6 / -5 +-- > | "MST" | "MDT" ; Mountain : -7 / -6 +-- > | "PST" | "PDT" ; Pacific : -8 / -7 +-- > | "YST" | "YDT" ; Yukon : -9 / -8 +-- > | "HST" | "HDT" ; Haw/Ala : -10 / -9 +-- > | "BST" | "BDT" ; Bering : -11 / -10 +-- > | "Z" ; GMT +-- > | "A" ; -1 +-- > | "M" ; -12 +-- > | "N" ; +1 +-- > | "Y" ; +12 +-- > | ("+" | "-") 4DIGIT ; Local diff: HHMM module Data.Time.RFC733 ( format , parse @@ -11,48 +50,7 @@ import Data.Time.Calendar.WeekDate import Data.Time.HTTP.Common import Data.Time.RFC733.Parsec -{- -date-time = [ day-of-week "," ] date time - -day-of-week = "Monday" / "Mon" / "Tuesday" / "Tue" - / "Wednesday" / "Wed" / "Thursday" / "Thu" - / "Friday" / "Fri" / "Saturday" / "Sat" - / "Sunday" / "Sun" - -date = 1*2DIGIT ["-"] month ; day month year - ["-"] (2DIGIT /4DIGIT) ; e.g. 20 Aug [19]77 - -month = "January" / "Jan" / "February" / "Feb" - / "March" / "Mar" / "April" / "Apr" - / "May" / "June" / "Jun" - / "July" / "Jul" / "August" / "Aug" - / "September" / "Sep" / "October" / "Oct" - / "November" / "Nov" / "December" / "Dec" - -time = hour zone ; ANSI and Military - ; (seconds optional) - -hour = 2DIGIT [":"] 2DIGIT [ [":"] 2DIGIT ] - ; 0000[00] - 2359[59] - -zone = ( ["-"] ( "GMT" ; Relative to GMT: - ; North American - / "NST" / ; Newfoundland:-3:30 - / "AST" / "ADT" ; Atlantic: - 4/ - 3 - / "EST" / "EDT" ; Eastern: - 5/ - 4 - / "CST" / "CDT" ; Central: - 6/ - 5 - / "MST" / "MDT" ; Mountain: - 7/ - 6 - / "PST" / "PDT" ; Pacific: - 8/ - 7 - / "YST" / "YDT" ; Yukon: - 9/ - 8 - / "HST" / "HDT" ; Haw/Ala -10/ - 9 - / "BST" / "BDT" ; Bering: -11/ -10 - 1ALPHA )) ; Military: Z = GMT; - ; A:-1; (J not used) - ; M:-12; N:+1; Y:+12 - / ( ("+" / "-") 4DIGIT ) ; Local differential - ; hours/min. (HHMM) --} - +-- |Format a 'ZonedTime' in RFC 733. format :: ZonedTime -> String format zonedTime = let localTime = zonedTimeToLocalTime zonedTime @@ -74,10 +72,12 @@ format zonedTime , show2 (todMin timeOfDay) , ":" , show2 (floor (todSec timeOfDay)) - , " " + , "-" , show4digitsTZ timeZone ] +-- |Parse an RFC 733 date and time string. When the string can't be +-- parsed, it returns 'Nothing'. parse :: String -> Maybe ZonedTime parse src = case P.parse p "" src of Right zt -> Just zt diff --git a/Data/Time/RFC733/Parsec.hs b/Data/Time/RFC733/Parsec.hs index 6746a3e..f266193 100644 --- a/Data/Time/RFC733/Parsec.hs +++ b/Data/Time/RFC733/Parsec.hs @@ -11,7 +11,7 @@ import Data.Time.Calendar.WeekDate import Data.Time.HTTP.Common import Text.Parsec - +-- |This is a parsec parser for RFC 733 date and time strings. rfc733DateAndTime :: Stream s m Char => ParsecT s u m ZonedTime rfc733DateAndTime = dateTime @@ -48,7 +48,7 @@ date = do day <- read2 time :: Stream s m Char => ParsecT s u m (TimeOfDay, TimeZone) time = do tod <- hour - _ <- char ' ' + _ <- char '-' <|> char ' ' tz <- zone return (tod, tz) diff --git a/Data/Time/RFC822.hs b/Data/Time/RFC822.hs index 1352e6d..4c8e333 100644 --- a/Data/Time/RFC822.hs +++ b/Data/Time/RFC822.hs @@ -1,3 +1,34 @@ +{-# OPTIONS_HADDOCK prune #-} + +-- |This module provides functions to parse and format RFC 822 date +-- and time formats. +-- +-- The syntax is as follows: +-- +-- > date-time ::= [ day-of-week ", " ] date SP time SP zone +-- > day-of-week ::= "Mon" | "Tue" | "Wed" | "Thu" +-- > | "Fri" | "Sat" | "Sun" +-- > date ::= day SP month SP year +-- > day ::= 2DIGIT +-- > year ::= 2DIGIT ; Yes, only 2 digits. +-- > month ::= "Jan" | "Feb" | "Mar" | "Apr" +-- > | "May" | "Jun" | "Jul" | "Aug" +-- > | "Sep" | "Oct" | "Nov" | "Dec" +-- > time ::= hour ":" minute [ ":" second ] +-- > hour ::= 2DIGIT +-- > minute ::= 2DIGIT +-- > second ::= 2DIGIT +-- > zone ::= "UT" | "GMT" ; Universal Time +-- > | "EST" | "EDT" ; Eastern : -5 / -4 +-- > | "CST" | "CDT" ; Central : -6 / -5 +-- > | "MST" | "MDT" ; Mountain: -7 / -6 +-- > | "PST" | "PDT" ; Pacific : -8 / -7 +-- > | "Z" ; UT +-- > | "A" ; -1 +-- > | "M" ; -12 +-- > | "N" ; +1 +-- > | "Y" ; +12 +-- > | ("+" | "-") 4DIGIT ; Local diff: HHMM module Data.Time.RFC822 ( format , parse @@ -14,39 +45,7 @@ import Data.Time.Calendar.WeekDate import Data.Time.HTTP.Common import Data.Time.RFC822.Parsec - -{- - date-time = [ day "," ] date time ; dd mm yy - ; hh:mm:ss zzz - - day = "Mon" / "Tue" / "Wed" / "Thu" - / "Fri" / "Sat" / "Sun" - - date = 1*2DIGIT month 2DIGIT ; day month year - ; e.g. 20 Jun 82 - - month = "Jan" / "Feb" / "Mar" / "Apr" - / "May" / "Jun" / "Jul" / "Aug" - / "Sep" / "Oct" / "Nov" / "Dec" - - time = hour zone ; ANSI and Military - - hour = 2DIGIT ":" 2DIGIT [":" 2DIGIT] - ; 00:00:00 - 23:59:59 - - zone = "UT" / "GMT" ; Universal Time - ; North American : UT - / "EST" / "EDT" ; Eastern: - 5/ - 4 - / "CST" / "CDT" ; Central: - 6/ - 5 - / "MST" / "MDT" ; Mountain: - 7/ - 6 - / "PST" / "PDT" ; Pacific: - 8/ - 7 - / 1ALPHA ; Military: Z = UT; - ; A:-1; (J not used) - ; M:-12; N:+1; Y:+12 - / ( ("+" / "-") 4DIGIT ) ; Local differential - ; hours+min. (HHMM) --} - +-- |Format a 'ZonedTime' in RFC 822. format :: ZonedTime -> String format zonedTime = let localTime = zonedTimeToLocalTime zonedTime @@ -77,6 +76,8 @@ showRFC822TimeZone tz | timeZoneMinutes tz == 0 = "GMT" | otherwise = show4digitsTZ tz +-- |Parse an RFC 822 date and time string. When the string can't be +-- parsed, it returns 'Nothing'. parse :: String -> Maybe ZonedTime parse src = case P.parse p "" src of Right zt -> Just zt diff --git a/Data/Time/RFC822/Parsec.hs b/Data/Time/RFC822/Parsec.hs index 5d73ca8..0ab2985 100644 --- a/Data/Time/RFC822/Parsec.hs +++ b/Data/Time/RFC822/Parsec.hs @@ -1,4 +1,6 @@ {-# LANGUAGE FlexibleContexts #-} +{-# OPTIONS_HADDOCK prune #-} + module Data.Time.RFC822.Parsec ( rfc822DateAndTime @@ -14,7 +16,7 @@ import Data.Time.Calendar.WeekDate import Data.Time.HTTP.Common import Text.Parsec - +-- |This is a parsec parser for RFC 822 date and time strings. rfc822DateAndTime :: Stream s m Char => ParsecT s u m ZonedTime rfc822DateAndTime = dateTime