antville/code/Global/i18n.js
Tobi Schäfer d2501c2d3a Replace for..each loops with for..of
💡 Needs Helma with enabled ES6 features in Rhino
2023-08-27 00:09:17 +02:00

140 lines
4.8 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// The Antville Project
// http://code.google.com/p/antville
//
// Copyright 20012014 by the Workers of Antville.
//
// Licensed under the Apache License, Version 2.0 (the ``License'');
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ``AS IS'' BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileOverview Contains redefined or additional methods for
* internationalization and localization.
*/
/**
* This method is called from the build script to extract gettext call strings from scripts and skins.
* @param {String} script The filename of the script containing the MessageParser code.
* @param {String} scanDirs The list of directory names to be scanned for i18n.
* @param {String} potFile The filename for the output POT file.
*/
Root.prototype.extractMessages = function(script, scanDirs, potFile) {
var temp = {print: global.print, readFile: global.readFile};
global.print = function(str) {app.log(str);}
global.readFile = function(fpath, encoding) {
res.push();
var file = new helma.File(fpath);
file.open({charset: encoding || 'UTF-8'});
var str;
while ((str = file.readln()) !== null) {
res.writeln(str);
}
file.close();
return res.pop();
}
var args = ['-o', potFile, '-e', 'utf-8'];
for (let dir of scanDirs.split(' ')) {
args.push(app.dir + '/../' + dir);
}
var file = new helma.File(script);
var MessageParser = new Function(file.readAll());
MessageParser.apply(global, args);
global.print = temp.print;
global.readFile = temp.readFile;
return;
}
/**
* This method is useful for disambiguation of messages (single words most of the time) that have different meanings depending on the context. Example: comment the verb 'to comment' vs the noun 'a comment'.
* @param {Object} key The message ID.
* @param {Object} context The context of the message.
* @example cgettext('comment', 'verb')
* @returns {String}
*/
function cgettext(key, context) {
var msgId = cgettext.getKey(key, context);
var text = jala.i18n.translate(msgId);
return text === msgId ? key : text;
}
/**
* Helper method to define the message ID depending on the context.
* @param {Object} key The message ID.
* @param {Object} context The context of the message.
* @returns {String} The message ID, probably suffixed with '//' plus the context
* @example cgettext.getKey('comment', 'verb') ===> 'comment // verb'
*/
cgettext.getKey = function(key, context) {
return context ? key + ' // ' + context : key;
}
/**
* Helma macro wrapper for the gettext() method.
* @param {Object} param The default Helma macro parameter object.
* @param {String} text The text used as message ID.
* @returns {String} Either the translated or the original text.
* @see jala.i18n.gettext
*/
function gettext_macro(param, text /*, value1, value2, ...*/) {
if (!text) {
return;
}
var re = gettext_macro.REGEX;
var args = [text.toString().replace(re, String.SPACE)];
for (var i=2; i<arguments.length; i+=1) {
args.push(arguments[i]);
}
if (param.context) {
return cgettext.call(this, args[0], param.context);
}
return gettext.apply(this, args);
}
/**
* The regular expression used to reduce multiple whitespace characters.
* @constant
*/
gettext_macro.REGEX = /\s+/g;
/**
* Helma macro wrapper for the ngettext() method.
* @param {Object} param The default Helma macro parameter object.
* @param {String} singular The text used as the singular message ID.
* @param {String} plural The text used as the plural message ID.
* @returns String Either the translated or the original string.
* @see jala.i18n.ngettext
*/
function ngettext_macro(param, singular, plural /*, value1, value2, ...*/) {
if (!singular || !plural) {
return;
}
var re = gettext_macro.REGEX;
var args = [singular.toString().replace(re, String.SPACE), plural.replace(re, String.SPACE)];
for (var i=3; i<arguments.length; i+=1) {
args.push(arguments[i]);
}
return ngettext.apply(this, args);
}
/**
* Helma macro wrapper for the markgettext() method.
* @param {Object} param The default Helma macro parameter object.
* @param {Object} singular The text used as the singular message ID.
* @param {Object} plural The text used as the plural message ID.
* @see jala.i18n.markgettext
*/
function markgettext_macro(param, singular, plural) {
return markgettext.call(this, singular, plural);
}
// The gettext for this message is not found by the parser o_O
markgettext('Press CTRL & C to copy to clipboard.');