This is locale.egg.info, produced by makeinfo version 4.7 from eggdoc-output.texi. INFO-DIR-SECTION The Algorithmic Language Scheme START-INFO-DIR-ENTRY * locale.egg: (locale.egg). Provides locale operations. END-INFO-DIR-ENTRY  File: locale.egg.info, Node: Top, Next: About this egg, Up: (dir) locale egg ********** Provides locale operations. Written by Kon Lovett (mailto:klovett@pacbell.net) This manual corresponds to version 0.2 of the locale extension library for Chicken Scheme. * Menu: * About this egg:: * Documentation:: * License:: * Index::  File: locale.egg.info, Node: About this egg, Next: Documentation, Prev: Top, Up: Top 1 About this egg **************** * Menu: * Version history:: * Usage:: * Requirements::  File: locale.egg.info, Node: Version history, Next: Usage, Up: About this egg 1.1 Version history =================== `0.2' Exports `0.1' Initial release  File: locale.egg.info, Node: Usage, Next: Requirements, Prev: Version history, Up: About this egg 1.2 Usage ========= Load this egg like so: `(require-extension locale)'  File: locale.egg.info, Node: Requirements, Prev: Usage, Up: About this egg 1.3 Requirements ================ This egg requires the following extensions: `miscmacros'  File: locale.egg.info, Node: Documentation, Next: License, Prev: About this egg, Up: Top 2 Documentation *************** locale is a set of routines supporting locale query operations. The environment locale information is queried upon module load and the corresponding parameters are set. NOTE: This is a work in progress. Currently only the Posix locale information is supported. Plans are to support the native MacOS X and Windows locale APIs. Changes to this API are almost certain. * Menu: * Timezone:: * Locale:: * Locale Category::  File: locale.egg.info, Node: Timezone, Next: Locale, Up: Documentation 2.1 Timezone ============ Access to local timezone information. A timezone object is composed of a Standard Time Name and Offset, and an optional Summer or Daylight Savings Time Name and Offset. The offset is seconds west (negative) or east (positive) of UTC. The name is some locally accepted timezone name, such as PST. A Daylight Savings Time start rule and end rule are optional components. Timezone component selectors are 'std-name, 'std-offset, 'dst-name, 'dst-offset, 'dst-start, 'dst-end. -- parameter: current-timezone (current-timezone [VALUE]) The currently defined timezone. The specified `VALUE' is either a timezone string value, or #f, indicating no timezone. When no timezone value is set the default timezone is UTC. -- procedure: current-timezone-components (current-timezone-components) Returns the timezone-components object corresponding to the current-timezone. -- procedure: timezone-components? (timezone-components? TIMEZONE-COMPONENTS) Is the specified `TIMEZONE-COMPONENTS' object actually a timezone-components object? -- procedure: timezone-component-ref (timezone-component-ref TIMEZONE-COMPONENTS SELECTOR [DEFAULT #f]) Returns the timezone-component `SELECTOR' of the `TIMEZONE-COMPONENTS' object, or the `DEFAULT' for a missing component. -- procedure: set-timezone-component! (set-timezone-component! TIMEZONE-COMPONENTS SELECTOR VALUE) Sets the timezone-component `SELECTOR' of the `TIMEZONE-COMPONENTS' object to `VALUE'. -- procedure: timezone-dst-rule-julian-noleap? (timezone-dst-rule-julian-noleap? TIMEZONE-RULE) Is the specified `TIMEZONE-RULE' object actually a daylight saving time julian day without leap seconds object? -- procedure: timezone-dst-rule-julian-leap? (timezone-dst-rule-julian-leap? TIMEZONE-RULE) Is the specified `TIMEZONE-RULE' object actually a daylight saving time julian day assuming leap seconds object? -- procedure: timezone-dst-rule-mwd? (timezone-dst-rule-mwd? TIMEZONE-RULE) Is the specified `TIMEZONE-RULE' object actually a daylight saving time month.week.day object? -- procedure: timezone-dst-rule-offset (timezone-dst-rule-offset TIMEZONE-RULE) Returns the seconds within day offset component of the specified `TIMEZONE-RULE' object. -- procedure: timezone-dst-rule-julian (timezone-dst-rule-julian TIMEZONE-RULE) Returns the julian day component of the specified `TIMEZONE-RULE' object. -- procedure: timezone-dst-rule-month (timezone-dst-rule-month TIMEZONE-RULE) Returns the month of year component of the specified `TIMEZONE-RULE' object. -- procedure: timezone-dst-rule-week (timezone-dst-rule-week TIMEZONE-RULE) Returns the week of month component of the specified `TIMEZONE-RULE' object. -- procedure: timezone-dst-rule-day (timezone-dst-rule-day TIMEZONE-RULE) Returns the day of week component of the specified `TIMEZONE-RULE' object. -- procedure: make-timezone-dst-rule-julian-leap (make-timezone-dst-rule-julian-leap JULIAN-DAY OFFSET) Returns a daylight saving time julian day assuming leap seconds rule object. -- procedure: make-timezone-dst-rule-julian-noleap (make-timezone-dst-rule-julian-noleap JULIAN-DAY OFFSET) Returns a daylight saving time julian day without leap seconds rule object. -- procedure: make-timezone-dst-rule-mwd (make-timezone-dst-rule-mwd MONTH WEEK DAY OFFSET) Returns a daylight saving time month.week.day rule object. -- procedure: posix-timezone-value->timezone-components (posix-timezone-value->timezone-components STRING [SOURCE "POSIX"]) Parses a POSIX timezone string specification, `STRING', and returns the corresponding timezone-components object, or #f when a parse error occurs. A #f or empty string value is mapped to the default timezone. The optional `SOURCE' indicates what locale system supplied the string. -- procedure: posix-load-timezone (posix-load-timezone) Initialize the current-timezone from the TZ environment variable.  File: locale.egg.info, Node: Locale, Next: Locale Category, Prev: Timezone, Up: Documentation 2.2 Locale ========== Access to locale information. A locale object is composed of a Language, an optional Script, an optional Region, an optional Codeset, and an optional Modifier. The language should be an ISO 639-1 or ISO 639-2 name. The Script should be a RFC 3066bis name. The region should be an ISO 3166-1 name. The codeset and modifier forms are locale dependent. Locale component selectors are 'language, 'script, 'region, 'codeset, and 'modifier. -- parameter: current-locale (current-locale [VALUE]) The currently defined locale. The specified `VALUE' is either a locale string value, or #f, indicating locale independence. When no locale value is set the default locale is #f. -- procedure: current-locale-components (current-locale-components) Returns the locale-components object corresponding to the current-locale. -- procedure: locale-components? (locale-components? LOCALE-COMPONENTS) Is the specified `LOCALE-COMPONENTS' object actually a locale-components object? -- procedure: locale-component-ref (locale-component-ref LOCALE-COMPONENTS SELECTOR [DEFAULT #f]) Returns the locale-component `SELECTOR' of the `LOCALE-COMPONENTS' object, or the `DEFAULT' for a missing component. -- procedure: set-locale-component! (set-locale-component! LOCALE-COMPONENTS SELECTOR VALUE) Sets the locale-component `SELECTOR' of the `LOCALE-COMPONENTS' object to `VALUE'. -- procedure: posix-locale-value->locale-components (posix-locale-value->locale-components STRING [SOURCE "POSIX"]) Parses a POSIX locale string specification, `STRING', and returns the corresponding locale-components object, or #f when a parse error occurs. A #f or empty string value is mapped to the default locale. The optional `SOURCE' indicates what locale system supplied the string. -- procedure: posix-load-locale (posix-load-locale) Initialize the current-locale from the LC_* or LANG environment variables. When both the LC_ALL and LANG environment variables are not set the current-locale is #f, even though some locale-catagories may have values. LC_ALL or LANG should be set if any locale catagories are set.  File: locale.egg.info, Node: Locale Category, Prev: Locale, Up: Documentation 2.3 Locale Category =================== Access to the locale information by category. The locale category selectors are 'COLLATE, 'CTYPE, 'MESSAGES, 'MONETARY, 'NUMERIC, and 'TIME. -- procedure: set-locale-category! (set-locale-category! CATEGORY LOCALE-COMPONENTS) Sets the specified `CATEGORY' to the specified `LOCALE-COMPONENTS' object. -- procedure: locale-category-ref (locale-category-ref CATEGORY) Returns the specified `CATEGORY' locale-components object, or #f if the category is not valued.  File: locale.egg.info, Node: License, Next: Index, Prev: Documentation, Up: Top 3 License ********* Copyright (c) 2005, Kon Lovett. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  File: locale.egg.info, Node: Index, Prev: License, Up: Top Index ***** [index] * Menu: * current-locale: Locale. (line 17) * current-locale-components: Locale. (line 24) * current-timezone: Timezone. (line 17) * current-timezone-components: Timezone. (line 24) * locale-category-ref: Locale Category. (line 18) * locale-component-ref: Locale. (line 36) * locale-components?: Locale. (line 30) * make-timezone-dst-rule-julian-leap: Timezone. (line 97) * make-timezone-dst-rule-julian-noleap: Timezone. (line 103) * make-timezone-dst-rule-mwd: Timezone. (line 109) * posix-load-locale: Locale. (line 57) * posix-load-timezone: Timezone. (line 123) * posix-locale-value->locale-components: Locale. (line 48) * posix-timezone-value->timezone-components: Timezone. (line 114) * set-locale-category!: Locale Category. (line 12) * set-locale-component!: Locale. (line 42) * set-timezone-component!: Timezone. (line 43) * timezone-component-ref: Timezone. (line 36) * timezone-components?: Timezone. (line 30) * timezone-dst-rule-day: Timezone. (line 91) * timezone-dst-rule-julian: Timezone. (line 73) * timezone-dst-rule-julian-leap?: Timezone. (line 55) * timezone-dst-rule-julian-noleap?: Timezone. (line 49) * timezone-dst-rule-month: Timezone. (line 79) * timezone-dst-rule-mwd?: Timezone. (line 61) * timezone-dst-rule-offset: Timezone. (line 67) * timezone-dst-rule-week: Timezone. (line 85)  Tag Table: Node: Top231 Node: About this egg571 Node: Version history755 Node: Usage928 Node: Requirements1111 Node: Documentation1289 Node: Timezone1850 Node: Locale6280 Node: Locale Category8737 Node: License9379 Node: Index10562  End Tag Table