Tcl Source Code

.sp
\fB::msgcat::mcmset \fIlocale src-trans-list\fR
.sp
.VS "TIP 404"
\fB::msgcat::mcflset \fIsrc-string \fR?\fItranslate-string\fR?
.sp
\fB::msgcat::mcflmset \fIsrc-trans-list\fR
.sp
\fB::msgcat::mcconfig\fR ?\fIoption\fR? ?\fIvalue\fR?
.VE "TIP 404"
.sp
\fB::msgcat::mcunknown \fIlocale src-string\fR
.BE
.SH DESCRIPTION
.PP
The \fBmsgcat\fR package provides a set of functions

current locale.  The default action is to return
\fIsrc-string\fR.  This procedure can be redefined by the
application, for example to log error messages for each unknown
string.  The \fB::msgcat::mcunknown\fR procedure is invoked at the
same stack context as the call to \fB::msgcat::mc\fR.  The return value
of \fB::msgcat::mcunknown\fR is used as the return value for the call
to \fB::msgcat::mc\fR.  
.TP
\fB::msgcat::mcconfig\fR ?\fIoption\fR? ?\fIvalue\fR?
.VS "TIP 404"
This routine is used to query or set the configuration of the package.
Without either \fIoption\fR or \fIvalue\fR, this returns the list of options
that are supported by the msgcat package. With just \fIoption\fR, it returns
the current value of that option, and with both \fIoption\fR and \fIvalue\fR
it sets the particualr option to the value.
.RS
.PP
The following options are currently supported:
.VE "TIP 404"
.TP
\fB\-mcfilelocale\fR
.VS "TIP 404"
This option describes the locale that is assumed (for the purposes of
\fB::msgcat::mcflset\fR and \fB::msgcat::mcflmset\fR) by the processing of the
message catalog file being loaded with \fB::msgcat::mcload\fR. An empty string
indicates the root locale. Note that while this value may be set, it is not
recommended that user code does so, as this value is also directly manipulated
by \fB::msgcat::mcload\fR.
.RE
.VE "TIP 404"
.SH "LOCALE SPECIFICATION"
.PP
The locale is specified to \fBmsgcat\fR by a locale string
passed to \fB::msgcat::mclocale\fR.
The locale string consists of
a language code, an optional country code, and an optional
system-specific code, each separated by

package require Tcl 8.5
# When the version number changes, be sure to update the pkgIndex.tcl file,
# and the installation directory in the Makefiles.
package provide msgcat 1.5.0

namespace eval msgcat {
    namespace export mc mcload mclocale mcmax mcmset mcpreferences mcset \
	    mcunknown mcconfig mcflset mcflmset

    # Records the current locale as passed to mclocale
    variable Locale ""

    # Records the list of locales to search
    variable Loclist {}

    # Records the locale of the currently sourced message catalogue file; this
    # would be problematic if anyone were to recursively load a message
    # catalog for a different locale from inside a catalog, but that's not a
    # case that we really need to worry about.
    variable FileLocale ""

    # Records the mapping between source strings and translated strings.  The
    # dict key is of the form "<locale> <namespace> <src>", where locale and
    # namespace should be themselves dict values and the value is
    # the translated string.
    variable Msgs [dict create]

	if {[file exists $langfile]} {
	    incr x
	    set FileLocale [string tolower [file tail [file rootname $langfile]]]
	    if {"root" eq $FileLocale} {
		set FileLocale ""
	    }
	    uplevel 1 [list ::source -encoding utf-8 $langfile]
	    set FileLocale ""
	}
    }
    return $x
}

# msgcat::mcset --
#

# Results:
#	Returns the new locale.

proc msgcat::mcflset {src {dest ""}} {
    variable FileLocale
    variable Msgs





    if {[llength [info level 0]] == 2} { ;# dest not specified
	set dest $src
    }

    set ns [uplevel 1 [list ::namespace current]]
    dict set Msgs $FileLocale $ns $src $dest
    return $dest

# Results:
#	Returns the number of pairs processed

proc msgcat::mcflmset {pairs} {
    variable FileLocale
    variable Msgs





    set length [llength $pairs]
    if {$length % 2} {
	return -code error "bad translation list:\
		should be \"[lindex [info level 0] 0] locale {src dest ...}\""
    }

    set ns [uplevel 1 [list ::namespace current]]

	set len [string length $translated]
	if {$len>$max} {
	    set max $len
	}
    }
    return $max
}

proc msgcat::mcconfig {option {value "\u0000\u0000\u0000"}} {
    # Handle sentinel
    if {$value eq "\u0000\u0000\u0000"} {
	unset value
    }

    switch $option {
	-mcfilelocale {
	    variable FileLocale
	    if {[info exists value]} {
		set FileLocale $value
	    }
	    return $FileLocale
	}
	default {
	    return -code error \
		"unknown property \"$option\": must be -mcfilelocale"
	}
    }
}

# Convert the locale values stored in environment variables to a form
# suitable for passing to [mclocale]
proc msgcat::ConvertLocale {value} {
    # Assume $value is of form: $language[_$territory][.$codeset][@modifier]
    # Convert to form: $language[_$territory][_$modifier]
    #