Changeset 8925 in project


Ignore:
Timestamp:
02/25/08 16:56:47 (12 years ago)
Author:
Kon Lovett
Message:

Save.

Location:
release/3/locale
Files:
2 edited
1 copied

Legend:

Unmodified
Added
Removed
  • release/3/locale/tags/0.3.3/locale-eggdoc.scm

    r8924 r8925  
    3333                (description (p "Provides locale operations."))
    3434                (author (url "mailto:klovett@pacbell.net" "Kon Lovett"))
     35
     36                (usage)
     37                (download "locale.egg")
     38                (requires (url "miscmacros.html" "miscmacros"))
     39
     40                (documentation
     41                        (p "locale is a set of routines supporting locale query operations.
     42                        The environment locale information is queried upon module load and the
     43                        corresponding parameters are set.")
     44
     45                        (p "NOTE: This is a work in progress. Currently only the Posix locale
     46                        information is supported. Plans are to support the native MacOS X and Windows locale
     47                        APIs. Changes to this API are almost certain.")
     48
     49                        (subsection "Timezone"
     50
     51                                (p "Access to local timezone information. A timezone object is composed of a
     52                                Standard Time Name and Offset, and an optional Summer or Daylight Savings
     53                                Time Name and Offset. The offset is seconds west (positive) or east (negative)
     54                                of UTC. The name is some locally accepted timezone name, such as PST. A
     55                                Daylight Savings Time start rule and end rule are optional components.")
     56
     57                                (p "Timezone component selectors are 'std-name, 'std-offset, 'dst-name, 'dst-offset,
     58                                'dst-start, 'dst-end.")
     59
     60                                (group
     61                                        (parameter "(current-timezone [VALUE])"
     62                                                (p "The currently defined timezone. The specified " (tt "VALUE")
     63                                                " is either a timezone string value, or #f, indicating no timezone. When
     64                                                no timezone value is set the default timezone is UTC.")
     65                                        )
     66
     67                                        (procedure "(current-timezone-components)"
     68                                                (p "Returns the timezone-components object corresponding to the current-timezone.")
     69                                        )
     70
     71                                        (procedure "(timezone-components? TIMEZONE-COMPONENTS)"
     72                                                (p "Is the specified " (tt "TIMEZONE-COMPONENTS") " object actually a
     73                                                timezone-components object?")
     74                                        )
     75
     76                                        (procedure "(timezone-component-ref TIMEZONE-COMPONENTS SELECTOR [DEFAULT #f])"
     77                                                (p "Returns the timezone-component " (tt "SELECTOR") " of the "
     78                                                (tt "TIMEZONE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
     79                                                missing component.")
     80                                        )
     81
     82                                        (procedure "(set-timezone-component! TIMEZONE-COMPONENTS SELECTOR VALUE)"
     83                                                (p "Sets the timezone-component " (tt "SELECTOR") " of the "
     84                                                (tt "TIMEZONE-COMPONENTS") " object to " (tt "VALUE") ".")
     85                                        )
     86
     87                                        (procedure "(timezone-dst-rule-julian-noleap? TIMEZONE-RULE)"
     88                                                (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
     89                                                a daylight saving time julian day without leap seconds object?")
     90                                        )
     91
     92                                        (procedure "(timezone-dst-rule-julian-leap? TIMEZONE-RULE)"
     93                                                (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
     94                                                a daylight saving time julian day assuming leap seconds object?")
     95                                        )
     96
     97                                        (procedure "(timezone-dst-rule-mwd? TIMEZONE-RULE)"
     98                                                (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
     99                                                a daylight saving time month.week.day object?")
     100                                        )
     101
     102                                        (procedure "(timezone-dst-rule-offset TIMEZONE-RULE)"
     103                                                (p "Returns the seconds within day offset component of the specified "
     104                                                (tt "TIMEZONE-RULE") " object.")
     105                                        )
     106
     107                                        (procedure "(timezone-dst-rule-julian TIMEZONE-RULE)"
     108                                                (p "Returns the julian day component of the specified "
     109                                                (tt "TIMEZONE-RULE") " object.")
     110                                        )
     111
     112                                        (procedure "(timezone-dst-rule-month TIMEZONE-RULE)"
     113                                                (p "Returns the month of year component of the specified "
     114                                                (tt "TIMEZONE-RULE") " object.")
     115                                        )
     116
     117                                        (procedure "(timezone-dst-rule-week TIMEZONE-RULE)"
     118                                                (p "Returns the week of month component of the specified "
     119                                                (tt "TIMEZONE-RULE") " object.")
     120                                        )
     121
     122                                        (procedure "(timezone-dst-rule-day TIMEZONE-RULE)"
     123                                                (p "Returns the day of week component of the specified "
     124                                                (tt "TIMEZONE-RULE") " object.")
     125                                        )
     126
     127                                        (procedure "(make-timezone-dst-rule-julian-leap JULIAN-DAY OFFSET)"
     128                                                (p "Returns a daylight saving time julian day assuming leap seconds rule object.")
     129                                        )
     130
     131                                        (procedure "(make-timezone-dst-rule-julian-noleap JULIAN-DAY OFFSET)"
     132                                                (p "Returns a daylight saving time julian day without leap seconds rule object.")
     133                                        )
     134
     135                                        (procedure "(make-timezone-dst-rule-mwd MONTH WEEK DAY OFFSET)"
     136                                                (p "Returns a daylight saving time month.week.day rule object.")
     137                                        )
     138
     139                                        (procedure "(posix-timezone-value->timezone-components STRING [SOURCE \"POSIX\"])"
     140                                                (p "Parses a POSIX timezone string specification, " (tt "STRING") ", and
     141                                                returns the corresponding timezone-components object, or #f when a parse
     142                                                error occurs. A #f or empty string value is mapped to the default timezone. The
     143                                                optional " (tt "SOURCE") " indicates what locale system supplied the string.")
     144                                        )
     145
     146                                        (procedure "(posix-load-timezone)"
     147                                                (p "Initialize the current-timezone from the TZ environment variable.")
     148                                        )
     149                                )
     150                        )
     151
     152                        (subsection "Locale"
     153
     154                                (p "Access to locale information. A locale object is composed of a
     155                                Language, an optional Script, an optional Region, an optional Codeset, and an
     156                                optional Modifier. The language should be an ISO 639-1 or ISO 639-2 name. The
     157                                Script should be a RFC 3066bis name. The region should be an ISO 3166-1 name.
     158                                The codeset and modifier forms are locale dependent.")
     159
     160                                (p "Locale component selectors are 'language, 'script, 'region, 'codeset, and 'modifier.")
     161
     162                                (group
     163                                        (parameter "(current-locale [VALUE])"
     164                                                (p "The currently defined locale. The specified " (tt "VALUE")
     165                                                " is either a locale string value, or #f, indicating locale independence.
     166                                                When no locale value is set the default locale is #f.")
     167                                        )
     168
     169                                        (procedure "(current-locale-components)"
     170                                                (p "Returns the locale-components object corresponding to the current-locale.")
     171                                        )
     172
     173                                        (procedure "(locale-components? LOCALE-COMPONENTS)"
     174                                                (p "Is the specified " (tt "LOCALE-COMPONENTS") " object actually a
     175                                                locale-components object?")
     176                                        )
     177
     178                                        (procedure "(locale-component-ref LOCALE-COMPONENTS SELECTOR [DEFAULT #f])"
     179                                                (p "Returns the locale-component " (tt "SELECTOR") " of the "
     180                                                (tt "LOCALE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
     181                                                missing component.")
     182                                        )
     183
     184                                        (procedure "(set-locale-component! LOCALE-COMPONENTS SELECTOR VALUE)"
     185                                                (p "Sets the locale-component " (tt "SELECTOR") " of the "
     186                                                (tt "LOCALE-COMPONENTS") " object to " (tt "VALUE") ".")
     187                                        )
     188
     189                                        (procedure "(posix-locale-value->locale-components STRING [SOURCE \"POSIX\"])"
     190                                                (p "Parses a POSIX locale string specification, " (tt "STRING") ", and
     191                                                returns the corresponding locale-components object, or #f when a parse
     192                                                error occurs. A #f or empty string value is mapped to the default locale. The
     193                                                optional " (tt "SOURCE") " indicates what locale system supplied the string.")
     194                                        )
     195
     196                                        (procedure "(posix-load-locale)"
     197                                                (p "Initialize the current-locale from the LC_* or LANG environment variables. When
     198                                                both the LC_ALL and LANG environment variables are not set the current-locale is #f,
     199                                                even though some locale-categories may have values. LC_ALL or LANG should be
     200                                                set if any locale categories are set.")
     201                                        )
     202                                )
     203                        )
     204
     205                        (subsection "Locale Category"
     206
     207                                (p "Access to the locale information by category.")
     208
     209                                (p "The locale category selectors are
     210                                'COLLATE, 'CTYPE, 'MESSAGES, 'MONETARY, 'NUMERIC, and 'TIME.")
     211
     212                                (group
     213                                        (procedure "(set-locale-category! CATEGORY LOCALE-COMPONENTS)"
     214                                                (p "Sets the specified " (tt "CATEGORY") " to the specified "
     215                                                (tt "LOCALE-COMPONENTS") " object.")
     216                                        )
     217
     218                                        (procedure "(locale-category-ref CATEGORY)"
     219                                                (p "Returns the specified " (tt "CATEGORY") " locale-components object, or #f
     220                                                if the category is not valued.")
     221                                        )
     222
     223                                )
     224                        )
     225                )
     226
     227    #;(examples ,examples)
     228
    35229                (history
    36230                        (version "0.3.3" "Removed use of 'critical-section'")
     
    41235                        (version "0.1" "Initial release"))
    42236
    43                 (usage)
    44                 (download "locale.egg")
    45                 (requires (url "miscmacros.html" "miscmacros"))
    46 
    47                 (documentation
    48                         (p "locale is a set of routines supporting locale query operations.
    49                         The environment locale information is queried upon module load and the
    50                         corresponding parameters are set.")
    51 
    52                         (p "NOTE: This is a work in progress. Currently only the Posix locale
    53                         information is supported. Plans are to support the native MacOS X and Windows locale
    54                         APIs. Changes to this API are almost certain.")
    55 
    56                         (subsection "Timezone"
    57 
    58                                 (p "Access to local timezone information. A timezone object is composed of a
    59                                 Standard Time Name and Offset, and an optional Summer or Daylight Savings
    60                                 Time Name and Offset. The offset is seconds west (positive) or east (negative)
    61                                 of UTC. The name is some locally accepted timezone name, such as PST. A
    62                                 Daylight Savings Time start rule and end rule are optional components.")
    63 
    64                                 (p "Timezone component selectors are 'std-name, 'std-offset, 'dst-name, 'dst-offset,
    65                                 'dst-start, 'dst-end.")
    66 
    67                                 (group
    68                                         (parameter "(current-timezone [VALUE])"
    69                                                 (p "The currently defined timezone. The specified " (tt "VALUE")
    70                                                 " is either a timezone string value, or #f, indicating no timezone. When
    71                                                 no timezone value is set the default timezone is UTC.")
    72                                         )
    73 
    74                                         (procedure "(current-timezone-components)"
    75                                                 (p "Returns the timezone-components object corresponding to the current-timezone.")
    76                                         )
    77 
    78                                         (procedure "(timezone-components? TIMEZONE-COMPONENTS)"
    79                                                 (p "Is the specified " (tt "TIMEZONE-COMPONENTS") " object actually a
    80                                                 timezone-components object?")
    81                                         )
    82 
    83                                         (procedure "(timezone-component-ref TIMEZONE-COMPONENTS SELECTOR [DEFAULT #f])"
    84                                                 (p "Returns the timezone-component " (tt "SELECTOR") " of the "
    85                                                 (tt "TIMEZONE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
    86                                                 missing component.")
    87                                         )
    88 
    89                                         (procedure "(set-timezone-component! TIMEZONE-COMPONENTS SELECTOR VALUE)"
    90                                                 (p "Sets the timezone-component " (tt "SELECTOR") " of the "
    91                                                 (tt "TIMEZONE-COMPONENTS") " object to " (tt "VALUE") ".")
    92                                         )
    93 
    94                                         (procedure "(timezone-dst-rule-julian-noleap? TIMEZONE-RULE)"
    95                                                 (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
    96                                                 a daylight saving time julian day without leap seconds object?")
    97                                         )
    98 
    99                                         (procedure "(timezone-dst-rule-julian-leap? TIMEZONE-RULE)"
    100                                                 (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
    101                                                 a daylight saving time julian day assuming leap seconds object?")
    102                                         )
    103 
    104                                         (procedure "(timezone-dst-rule-mwd? TIMEZONE-RULE)"
    105                                                 (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
    106                                                 a daylight saving time month.week.day object?")
    107                                         )
    108 
    109                                         (procedure "(timezone-dst-rule-offset TIMEZONE-RULE)"
    110                                                 (p "Returns the seconds within day offset component of the specified "
    111                                                 (tt "TIMEZONE-RULE") " object.")
    112                                         )
    113 
    114                                         (procedure "(timezone-dst-rule-julian TIMEZONE-RULE)"
    115                                                 (p "Returns the julian day component of the specified "
    116                                                 (tt "TIMEZONE-RULE") " object.")
    117                                         )
    118 
    119                                         (procedure "(timezone-dst-rule-month TIMEZONE-RULE)"
    120                                                 (p "Returns the month of year component of the specified "
    121                                                 (tt "TIMEZONE-RULE") " object.")
    122                                         )
    123 
    124                                         (procedure "(timezone-dst-rule-week TIMEZONE-RULE)"
    125                                                 (p "Returns the week of month component of the specified "
    126                                                 (tt "TIMEZONE-RULE") " object.")
    127                                         )
    128 
    129                                         (procedure "(timezone-dst-rule-day TIMEZONE-RULE)"
    130                                                 (p "Returns the day of week component of the specified "
    131                                                 (tt "TIMEZONE-RULE") " object.")
    132                                         )
    133 
    134                                         (procedure "(make-timezone-dst-rule-julian-leap JULIAN-DAY OFFSET)"
    135                                                 (p "Returns a daylight saving time julian day assuming leap seconds rule object.")
    136                                         )
    137 
    138                                         (procedure "(make-timezone-dst-rule-julian-noleap JULIAN-DAY OFFSET)"
    139                                                 (p "Returns a daylight saving time julian day without leap seconds rule object.")
    140                                         )
    141 
    142                                         (procedure "(make-timezone-dst-rule-mwd MONTH WEEK DAY OFFSET)"
    143                                                 (p "Returns a daylight saving time month.week.day rule object.")
    144                                         )
    145 
    146                                         (procedure "(posix-timezone-value->timezone-components STRING [SOURCE \"POSIX\"])"
    147                                                 (p "Parses a POSIX timezone string specification, " (tt "STRING") ", and
    148                                                 returns the corresponding timezone-components object, or #f when a parse
    149                                                 error occurs. A #f or empty string value is mapped to the default timezone. The
    150                                                 optional " (tt "SOURCE") " indicates what locale system supplied the string.")
    151                                         )
    152 
    153                                         (procedure "(posix-load-timezone)"
    154                                                 (p "Initialize the current-timezone from the TZ environment variable.")
    155                                         )
    156                                 )
    157                         )
    158 
    159                         (subsection "Locale"
    160 
    161                                 (p "Access to locale information. A locale object is composed of a
    162                                 Language, an optional Script, an optional Region, an optional Codeset, and an
    163                                 optional Modifier. The language should be an ISO 639-1 or ISO 639-2 name. The
    164                                 Script should be a RFC 3066bis name. The region should be an ISO 3166-1 name.
    165                                 The codeset and modifier forms are locale dependent.")
    166 
    167                                 (p "Locale component selectors are 'language, 'script, 'region, 'codeset, and 'modifier.")
    168 
    169                                 (group
    170                                         (parameter "(current-locale [VALUE])"
    171                                                 (p "The currently defined locale. The specified " (tt "VALUE")
    172                                                 " is either a locale string value, or #f, indicating locale independence.
    173                                                 When no locale value is set the default locale is #f.")
    174                                         )
    175 
    176                                         (procedure "(current-locale-components)"
    177                                                 (p "Returns the locale-components object corresponding to the current-locale.")
    178                                         )
    179 
    180                                         (procedure "(locale-components? LOCALE-COMPONENTS)"
    181                                                 (p "Is the specified " (tt "LOCALE-COMPONENTS") " object actually a
    182                                                 locale-components object?")
    183                                         )
    184 
    185                                         (procedure "(locale-component-ref LOCALE-COMPONENTS SELECTOR [DEFAULT #f])"
    186                                                 (p "Returns the locale-component " (tt "SELECTOR") " of the "
    187                                                 (tt "LOCALE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
    188                                                 missing component.")
    189                                         )
    190 
    191                                         (procedure "(set-locale-component! LOCALE-COMPONENTS SELECTOR VALUE)"
    192                                                 (p "Sets the locale-component " (tt "SELECTOR") " of the "
    193                                                 (tt "LOCALE-COMPONENTS") " object to " (tt "VALUE") ".")
    194                                         )
    195 
    196                                         (procedure "(posix-locale-value->locale-components STRING [SOURCE \"POSIX\"])"
    197                                                 (p "Parses a POSIX locale string specification, " (tt "STRING") ", and
    198                                                 returns the corresponding locale-components object, or #f when a parse
    199                                                 error occurs. A #f or empty string value is mapped to the default locale. The
    200                                                 optional " (tt "SOURCE") " indicates what locale system supplied the string.")
    201                                         )
    202 
    203                                         (procedure "(posix-load-locale)"
    204                                                 (p "Initialize the current-locale from the LC_* or LANG environment variables. When
    205                                                 both the LC_ALL and LANG environment variables are not set the current-locale is #f,
    206                                                 even though some locale-categories may have values. LC_ALL or LANG should be
    207                                                 set if any locale categories are set.")
    208                                         )
    209                                 )
    210                         )
    211 
    212                         (subsection "Locale Category"
    213 
    214                                 (p "Access to the locale information by category.")
    215 
    216                                 (p "The locale category selectors are
    217                                 'COLLATE, 'CTYPE, 'MESSAGES, 'MONETARY, 'NUMERIC, and 'TIME.")
    218 
    219                                 (group
    220                                         (procedure "(set-locale-category! CATEGORY LOCALE-COMPONENTS)"
    221                                                 (p "Sets the specified " (tt "CATEGORY") " to the specified "
    222                                                 (tt "LOCALE-COMPONENTS") " object.")
    223                                         )
    224 
    225                                         (procedure "(locale-category-ref CATEGORY)"
    226                                                 (p "Returns the specified " (tt "CATEGORY") " locale-components object, or #f
    227                                                 if the category is not valued.")
    228                                         )
    229 
    230                                 )
    231                         )
    232 
    233                         #;(examples ,examples)
    234                 )
    235237                (section "License" (pre ,license))
    236238        )
  • release/3/locale/trunk/locale-eggdoc.scm

    r8924 r8925  
    3333                (description (p "Provides locale operations."))
    3434                (author (url "mailto:klovett@pacbell.net" "Kon Lovett"))
     35
     36                (usage)
     37                (download "locale.egg")
     38                (requires (url "miscmacros.html" "miscmacros"))
     39
     40                (documentation
     41                        (p "locale is a set of routines supporting locale query operations.
     42                        The environment locale information is queried upon module load and the
     43                        corresponding parameters are set.")
     44
     45                        (p "NOTE: This is a work in progress. Currently only the Posix locale
     46                        information is supported. Plans are to support the native MacOS X and Windows locale
     47                        APIs. Changes to this API are almost certain.")
     48
     49                        (subsection "Timezone"
     50
     51                                (p "Access to local timezone information. A timezone object is composed of a
     52                                Standard Time Name and Offset, and an optional Summer or Daylight Savings
     53                                Time Name and Offset. The offset is seconds west (positive) or east (negative)
     54                                of UTC. The name is some locally accepted timezone name, such as PST. A
     55                                Daylight Savings Time start rule and end rule are optional components.")
     56
     57                                (p "Timezone component selectors are 'std-name, 'std-offset, 'dst-name, 'dst-offset,
     58                                'dst-start, 'dst-end.")
     59
     60                                (group
     61                                        (parameter "(current-timezone [VALUE])"
     62                                                (p "The currently defined timezone. The specified " (tt "VALUE")
     63                                                " is either a timezone string value, or #f, indicating no timezone. When
     64                                                no timezone value is set the default timezone is UTC.")
     65                                        )
     66
     67                                        (procedure "(current-timezone-components)"
     68                                                (p "Returns the timezone-components object corresponding to the current-timezone.")
     69                                        )
     70
     71                                        (procedure "(timezone-components? TIMEZONE-COMPONENTS)"
     72                                                (p "Is the specified " (tt "TIMEZONE-COMPONENTS") " object actually a
     73                                                timezone-components object?")
     74                                        )
     75
     76                                        (procedure "(timezone-component-ref TIMEZONE-COMPONENTS SELECTOR [DEFAULT #f])"
     77                                                (p "Returns the timezone-component " (tt "SELECTOR") " of the "
     78                                                (tt "TIMEZONE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
     79                                                missing component.")
     80                                        )
     81
     82                                        (procedure "(set-timezone-component! TIMEZONE-COMPONENTS SELECTOR VALUE)"
     83                                                (p "Sets the timezone-component " (tt "SELECTOR") " of the "
     84                                                (tt "TIMEZONE-COMPONENTS") " object to " (tt "VALUE") ".")
     85                                        )
     86
     87                                        (procedure "(timezone-dst-rule-julian-noleap? TIMEZONE-RULE)"
     88                                                (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
     89                                                a daylight saving time julian day without leap seconds object?")
     90                                        )
     91
     92                                        (procedure "(timezone-dst-rule-julian-leap? TIMEZONE-RULE)"
     93                                                (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
     94                                                a daylight saving time julian day assuming leap seconds object?")
     95                                        )
     96
     97                                        (procedure "(timezone-dst-rule-mwd? TIMEZONE-RULE)"
     98                                                (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
     99                                                a daylight saving time month.week.day object?")
     100                                        )
     101
     102                                        (procedure "(timezone-dst-rule-offset TIMEZONE-RULE)"
     103                                                (p "Returns the seconds within day offset component of the specified "
     104                                                (tt "TIMEZONE-RULE") " object.")
     105                                        )
     106
     107                                        (procedure "(timezone-dst-rule-julian TIMEZONE-RULE)"
     108                                                (p "Returns the julian day component of the specified "
     109                                                (tt "TIMEZONE-RULE") " object.")
     110                                        )
     111
     112                                        (procedure "(timezone-dst-rule-month TIMEZONE-RULE)"
     113                                                (p "Returns the month of year component of the specified "
     114                                                (tt "TIMEZONE-RULE") " object.")
     115                                        )
     116
     117                                        (procedure "(timezone-dst-rule-week TIMEZONE-RULE)"
     118                                                (p "Returns the week of month component of the specified "
     119                                                (tt "TIMEZONE-RULE") " object.")
     120                                        )
     121
     122                                        (procedure "(timezone-dst-rule-day TIMEZONE-RULE)"
     123                                                (p "Returns the day of week component of the specified "
     124                                                (tt "TIMEZONE-RULE") " object.")
     125                                        )
     126
     127                                        (procedure "(make-timezone-dst-rule-julian-leap JULIAN-DAY OFFSET)"
     128                                                (p "Returns a daylight saving time julian day assuming leap seconds rule object.")
     129                                        )
     130
     131                                        (procedure "(make-timezone-dst-rule-julian-noleap JULIAN-DAY OFFSET)"
     132                                                (p "Returns a daylight saving time julian day without leap seconds rule object.")
     133                                        )
     134
     135                                        (procedure "(make-timezone-dst-rule-mwd MONTH WEEK DAY OFFSET)"
     136                                                (p "Returns a daylight saving time month.week.day rule object.")
     137                                        )
     138
     139                                        (procedure "(posix-timezone-value->timezone-components STRING [SOURCE \"POSIX\"])"
     140                                                (p "Parses a POSIX timezone string specification, " (tt "STRING") ", and
     141                                                returns the corresponding timezone-components object, or #f when a parse
     142                                                error occurs. A #f or empty string value is mapped to the default timezone. The
     143                                                optional " (tt "SOURCE") " indicates what locale system supplied the string.")
     144                                        )
     145
     146                                        (procedure "(posix-load-timezone)"
     147                                                (p "Initialize the current-timezone from the TZ environment variable.")
     148                                        )
     149                                )
     150                        )
     151
     152                        (subsection "Locale"
     153
     154                                (p "Access to locale information. A locale object is composed of a
     155                                Language, an optional Script, an optional Region, an optional Codeset, and an
     156                                optional Modifier. The language should be an ISO 639-1 or ISO 639-2 name. The
     157                                Script should be a RFC 3066bis name. The region should be an ISO 3166-1 name.
     158                                The codeset and modifier forms are locale dependent.")
     159
     160                                (p "Locale component selectors are 'language, 'script, 'region, 'codeset, and 'modifier.")
     161
     162                                (group
     163                                        (parameter "(current-locale [VALUE])"
     164                                                (p "The currently defined locale. The specified " (tt "VALUE")
     165                                                " is either a locale string value, or #f, indicating locale independence.
     166                                                When no locale value is set the default locale is #f.")
     167                                        )
     168
     169                                        (procedure "(current-locale-components)"
     170                                                (p "Returns the locale-components object corresponding to the current-locale.")
     171                                        )
     172
     173                                        (procedure "(locale-components? LOCALE-COMPONENTS)"
     174                                                (p "Is the specified " (tt "LOCALE-COMPONENTS") " object actually a
     175                                                locale-components object?")
     176                                        )
     177
     178                                        (procedure "(locale-component-ref LOCALE-COMPONENTS SELECTOR [DEFAULT #f])"
     179                                                (p "Returns the locale-component " (tt "SELECTOR") " of the "
     180                                                (tt "LOCALE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
     181                                                missing component.")
     182                                        )
     183
     184                                        (procedure "(set-locale-component! LOCALE-COMPONENTS SELECTOR VALUE)"
     185                                                (p "Sets the locale-component " (tt "SELECTOR") " of the "
     186                                                (tt "LOCALE-COMPONENTS") " object to " (tt "VALUE") ".")
     187                                        )
     188
     189                                        (procedure "(posix-locale-value->locale-components STRING [SOURCE \"POSIX\"])"
     190                                                (p "Parses a POSIX locale string specification, " (tt "STRING") ", and
     191                                                returns the corresponding locale-components object, or #f when a parse
     192                                                error occurs. A #f or empty string value is mapped to the default locale. The
     193                                                optional " (tt "SOURCE") " indicates what locale system supplied the string.")
     194                                        )
     195
     196                                        (procedure "(posix-load-locale)"
     197                                                (p "Initialize the current-locale from the LC_* or LANG environment variables. When
     198                                                both the LC_ALL and LANG environment variables are not set the current-locale is #f,
     199                                                even though some locale-categories may have values. LC_ALL or LANG should be
     200                                                set if any locale categories are set.")
     201                                        )
     202                                )
     203                        )
     204
     205                        (subsection "Locale Category"
     206
     207                                (p "Access to the locale information by category.")
     208
     209                                (p "The locale category selectors are
     210                                'COLLATE, 'CTYPE, 'MESSAGES, 'MONETARY, 'NUMERIC, and 'TIME.")
     211
     212                                (group
     213                                        (procedure "(set-locale-category! CATEGORY LOCALE-COMPONENTS)"
     214                                                (p "Sets the specified " (tt "CATEGORY") " to the specified "
     215                                                (tt "LOCALE-COMPONENTS") " object.")
     216                                        )
     217
     218                                        (procedure "(locale-category-ref CATEGORY)"
     219                                                (p "Returns the specified " (tt "CATEGORY") " locale-components object, or #f
     220                                                if the category is not valued.")
     221                                        )
     222
     223                                )
     224                        )
     225                )
     226
     227    #;(examples ,examples)
     228
    35229                (history
    36230                        (version "0.3.3" "Removed use of 'critical-section'")
     
    41235                        (version "0.1" "Initial release"))
    42236
    43                 (usage)
    44                 (download "locale.egg")
    45                 (requires (url "miscmacros.html" "miscmacros"))
    46 
    47                 (documentation
    48                         (p "locale is a set of routines supporting locale query operations.
    49                         The environment locale information is queried upon module load and the
    50                         corresponding parameters are set.")
    51 
    52                         (p "NOTE: This is a work in progress. Currently only the Posix locale
    53                         information is supported. Plans are to support the native MacOS X and Windows locale
    54                         APIs. Changes to this API are almost certain.")
    55 
    56                         (subsection "Timezone"
    57 
    58                                 (p "Access to local timezone information. A timezone object is composed of a
    59                                 Standard Time Name and Offset, and an optional Summer or Daylight Savings
    60                                 Time Name and Offset. The offset is seconds west (positive) or east (negative)
    61                                 of UTC. The name is some locally accepted timezone name, such as PST. A
    62                                 Daylight Savings Time start rule and end rule are optional components.")
    63 
    64                                 (p "Timezone component selectors are 'std-name, 'std-offset, 'dst-name, 'dst-offset,
    65                                 'dst-start, 'dst-end.")
    66 
    67                                 (group
    68                                         (parameter "(current-timezone [VALUE])"
    69                                                 (p "The currently defined timezone. The specified " (tt "VALUE")
    70                                                 " is either a timezone string value, or #f, indicating no timezone. When
    71                                                 no timezone value is set the default timezone is UTC.")
    72                                         )
    73 
    74                                         (procedure "(current-timezone-components)"
    75                                                 (p "Returns the timezone-components object corresponding to the current-timezone.")
    76                                         )
    77 
    78                                         (procedure "(timezone-components? TIMEZONE-COMPONENTS)"
    79                                                 (p "Is the specified " (tt "TIMEZONE-COMPONENTS") " object actually a
    80                                                 timezone-components object?")
    81                                         )
    82 
    83                                         (procedure "(timezone-component-ref TIMEZONE-COMPONENTS SELECTOR [DEFAULT #f])"
    84                                                 (p "Returns the timezone-component " (tt "SELECTOR") " of the "
    85                                                 (tt "TIMEZONE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
    86                                                 missing component.")
    87                                         )
    88 
    89                                         (procedure "(set-timezone-component! TIMEZONE-COMPONENTS SELECTOR VALUE)"
    90                                                 (p "Sets the timezone-component " (tt "SELECTOR") " of the "
    91                                                 (tt "TIMEZONE-COMPONENTS") " object to " (tt "VALUE") ".")
    92                                         )
    93 
    94                                         (procedure "(timezone-dst-rule-julian-noleap? TIMEZONE-RULE)"
    95                                                 (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
    96                                                 a daylight saving time julian day without leap seconds object?")
    97                                         )
    98 
    99                                         (procedure "(timezone-dst-rule-julian-leap? TIMEZONE-RULE)"
    100                                                 (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
    101                                                 a daylight saving time julian day assuming leap seconds object?")
    102                                         )
    103 
    104                                         (procedure "(timezone-dst-rule-mwd? TIMEZONE-RULE)"
    105                                                 (p "Is the specified " (tt "TIMEZONE-RULE") " object actually
    106                                                 a daylight saving time month.week.day object?")
    107                                         )
    108 
    109                                         (procedure "(timezone-dst-rule-offset TIMEZONE-RULE)"
    110                                                 (p "Returns the seconds within day offset component of the specified "
    111                                                 (tt "TIMEZONE-RULE") " object.")
    112                                         )
    113 
    114                                         (procedure "(timezone-dst-rule-julian TIMEZONE-RULE)"
    115                                                 (p "Returns the julian day component of the specified "
    116                                                 (tt "TIMEZONE-RULE") " object.")
    117                                         )
    118 
    119                                         (procedure "(timezone-dst-rule-month TIMEZONE-RULE)"
    120                                                 (p "Returns the month of year component of the specified "
    121                                                 (tt "TIMEZONE-RULE") " object.")
    122                                         )
    123 
    124                                         (procedure "(timezone-dst-rule-week TIMEZONE-RULE)"
    125                                                 (p "Returns the week of month component of the specified "
    126                                                 (tt "TIMEZONE-RULE") " object.")
    127                                         )
    128 
    129                                         (procedure "(timezone-dst-rule-day TIMEZONE-RULE)"
    130                                                 (p "Returns the day of week component of the specified "
    131                                                 (tt "TIMEZONE-RULE") " object.")
    132                                         )
    133 
    134                                         (procedure "(make-timezone-dst-rule-julian-leap JULIAN-DAY OFFSET)"
    135                                                 (p "Returns a daylight saving time julian day assuming leap seconds rule object.")
    136                                         )
    137 
    138                                         (procedure "(make-timezone-dst-rule-julian-noleap JULIAN-DAY OFFSET)"
    139                                                 (p "Returns a daylight saving time julian day without leap seconds rule object.")
    140                                         )
    141 
    142                                         (procedure "(make-timezone-dst-rule-mwd MONTH WEEK DAY OFFSET)"
    143                                                 (p "Returns a daylight saving time month.week.day rule object.")
    144                                         )
    145 
    146                                         (procedure "(posix-timezone-value->timezone-components STRING [SOURCE \"POSIX\"])"
    147                                                 (p "Parses a POSIX timezone string specification, " (tt "STRING") ", and
    148                                                 returns the corresponding timezone-components object, or #f when a parse
    149                                                 error occurs. A #f or empty string value is mapped to the default timezone. The
    150                                                 optional " (tt "SOURCE") " indicates what locale system supplied the string.")
    151                                         )
    152 
    153                                         (procedure "(posix-load-timezone)"
    154                                                 (p "Initialize the current-timezone from the TZ environment variable.")
    155                                         )
    156                                 )
    157                         )
    158 
    159                         (subsection "Locale"
    160 
    161                                 (p "Access to locale information. A locale object is composed of a
    162                                 Language, an optional Script, an optional Region, an optional Codeset, and an
    163                                 optional Modifier. The language should be an ISO 639-1 or ISO 639-2 name. The
    164                                 Script should be a RFC 3066bis name. The region should be an ISO 3166-1 name.
    165                                 The codeset and modifier forms are locale dependent.")
    166 
    167                                 (p "Locale component selectors are 'language, 'script, 'region, 'codeset, and 'modifier.")
    168 
    169                                 (group
    170                                         (parameter "(current-locale [VALUE])"
    171                                                 (p "The currently defined locale. The specified " (tt "VALUE")
    172                                                 " is either a locale string value, or #f, indicating locale independence.
    173                                                 When no locale value is set the default locale is #f.")
    174                                         )
    175 
    176                                         (procedure "(current-locale-components)"
    177                                                 (p "Returns the locale-components object corresponding to the current-locale.")
    178                                         )
    179 
    180                                         (procedure "(locale-components? LOCALE-COMPONENTS)"
    181                                                 (p "Is the specified " (tt "LOCALE-COMPONENTS") " object actually a
    182                                                 locale-components object?")
    183                                         )
    184 
    185                                         (procedure "(locale-component-ref LOCALE-COMPONENTS SELECTOR [DEFAULT #f])"
    186                                                 (p "Returns the locale-component " (tt "SELECTOR") " of the "
    187                                                 (tt "LOCALE-COMPONENTS") " object, or the " (tt "DEFAULT") " for a
    188                                                 missing component.")
    189                                         )
    190 
    191                                         (procedure "(set-locale-component! LOCALE-COMPONENTS SELECTOR VALUE)"
    192                                                 (p "Sets the locale-component " (tt "SELECTOR") " of the "
    193                                                 (tt "LOCALE-COMPONENTS") " object to " (tt "VALUE") ".")
    194                                         )
    195 
    196                                         (procedure "(posix-locale-value->locale-components STRING [SOURCE \"POSIX\"])"
    197                                                 (p "Parses a POSIX locale string specification, " (tt "STRING") ", and
    198                                                 returns the corresponding locale-components object, or #f when a parse
    199                                                 error occurs. A #f or empty string value is mapped to the default locale. The
    200                                                 optional " (tt "SOURCE") " indicates what locale system supplied the string.")
    201                                         )
    202 
    203                                         (procedure "(posix-load-locale)"
    204                                                 (p "Initialize the current-locale from the LC_* or LANG environment variables. When
    205                                                 both the LC_ALL and LANG environment variables are not set the current-locale is #f,
    206                                                 even though some locale-categories may have values. LC_ALL or LANG should be
    207                                                 set if any locale categories are set.")
    208                                         )
    209                                 )
    210                         )
    211 
    212                         (subsection "Locale Category"
    213 
    214                                 (p "Access to the locale information by category.")
    215 
    216                                 (p "The locale category selectors are
    217                                 'COLLATE, 'CTYPE, 'MESSAGES, 'MONETARY, 'NUMERIC, and 'TIME.")
    218 
    219                                 (group
    220                                         (procedure "(set-locale-category! CATEGORY LOCALE-COMPONENTS)"
    221                                                 (p "Sets the specified " (tt "CATEGORY") " to the specified "
    222                                                 (tt "LOCALE-COMPONENTS") " object.")
    223                                         )
    224 
    225                                         (procedure "(locale-category-ref CATEGORY)"
    226                                                 (p "Returns the specified " (tt "CATEGORY") " locale-components object, or #f
    227                                                 if the category is not valued.")
    228                                         )
    229 
    230                                 )
    231                         )
    232 
    233                         #;(examples ,examples)
    234                 )
    235237                (section "License" (pre ,license))
    236238        )
Note: See TracChangeset for help on using the changeset viewer.