mesonbuild/modules/i18n.py - meson - Git at Google

 # Copyright 2016 The Meson development team

 # 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.

 from os import path
 import shutil
 import typing as T

 from . import ExtensionModule, ModuleReturnValue
 from .. import build
 from .. import mesonlib
 from .. import mlog
 from ..interpreter.type_checking import CT_BUILD_BY_DEFAULT, CT_INPUT_KW, CT_INSTALL_DIR_KW, CT_INSTALL_TAG_KW, CT_OUTPUT_KW, INSTALL_KW, NoneType, in_set_validator
 from ..interpreterbase import FeatureNew
 from ..interpreterbase.decorators import ContainerTypeInfo, KwargInfo, noPosargs, typed_kwargs, typed_pos_args
 from ..scripts.gettext import read_linguas

 if T.TYPE_CHECKING:
     from typing_extensions import Literal, TypedDict

     from . import ModuleState
     from ..build import Target
     from ..interpreter import Interpreter
     from ..interpreterbase import TYPE_var
     from ..programs import ExternalProgram

     class MergeFile(TypedDict):

         input: T.List[T.Union[
             str, build.BuildTarget, build.CustomTarget, build.CustomTargetIndex,
             build.ExtractedObjects, build.GeneratedList, ExternalProgram,
             mesonlib.File]]
         output: T.List[str]
         build_by_default: bool
         install: bool
         install_dir: T.List[T.Union[str, bool]]
         install_tag: T.List[str]
         args: T.List[str]
         data_dirs: T.List[str]
         po_dir: str
         type: Literal['xml', 'desktop']

     class Gettext(TypedDict):

         args: T.List[str]
         data_dirs: T.List[str]
         install: bool
         install_dir: T.Optional[str]
         languages: T.List[str]
         preset: T.Optional[str]


 _ARGS: KwargInfo[T.List[str]] = KwargInfo(
     'args',
     ContainerTypeInfo(list, str),
     default=[],
     listify=True,
 )

 _DATA_DIRS: KwargInfo[T.List[str]] = KwargInfo(
     'data_dirs',
     ContainerTypeInfo(list, str),
     default=[],
     listify=True
 )

 PRESET_ARGS = {
     'glib': [
         '--from-code=UTF-8',
         '--add-comments',

         # https://developer.gnome.org/glib/stable/glib-I18N.html
         '--keyword=_',
         '--keyword=N_',
         '--keyword=C_:1c,2',
         '--keyword=NC_:1c,2',
         '--keyword=g_dcgettext:2',
         '--keyword=g_dngettext:2,3',
         '--keyword=g_dpgettext2:2c,3',

         '--flag=N_:1:pass-c-format',
         '--flag=C_:2:pass-c-format',
         '--flag=NC_:2:pass-c-format',
         '--flag=g_dngettext:2:pass-c-format',
         '--flag=g_strdup_printf:1:c-format',
         '--flag=g_string_printf:2:c-format',
         '--flag=g_string_append_printf:2:c-format',
         '--flag=g_error_new:3:c-format',
         '--flag=g_set_error:4:c-format',
         '--flag=g_markup_printf_escaped:1:c-format',
         '--flag=g_log:3:c-format',
         '--flag=g_print:1:c-format',
         '--flag=g_printerr:1:c-format',
         '--flag=g_printf:1:c-format',
         '--flag=g_fprintf:2:c-format',
         '--flag=g_sprintf:2:c-format',
         '--flag=g_snprintf:3:c-format',
     ]
 }


 class I18nModule(ExtensionModule):
     def __init__(self, interpreter: 'Interpreter'):
         super().__init__(interpreter)
         self.methods.update({
             'merge_file': self.merge_file,
             'gettext': self.gettext,
         })

     @staticmethod
     def nogettext_warning() -> None:
         mlog.warning('Gettext not found, all translation targets will be ignored.', once=True)

     @staticmethod
     def _get_data_dirs(state: 'ModuleState', dirs: T.Iterable[str]) -> T.List[str]:
         """Returns source directories of relative paths"""
         src_dir = path.join(state.environment.get_source_dir(), state.subdir)
         return [path.join(src_dir, d) for d in dirs]

     @FeatureNew('i18n.merge_file', '0.37.0')
     @noPosargs
     @typed_kwargs(
         'i18n.merge_file',
         CT_BUILD_BY_DEFAULT,
         CT_INPUT_KW,
         CT_INSTALL_DIR_KW,
         CT_INSTALL_TAG_KW,
         CT_OUTPUT_KW,
         INSTALL_KW,
         _ARGS.evolve(since='0.51.0'),
         _DATA_DIRS,
         KwargInfo('po_dir', str, required=True),
         KwargInfo('type', str, default='xml', validator=in_set_validator({'xml', 'desktop'})),
     )
     def merge_file(self, state: 'ModuleState', args: T.List['TYPE_var'], kwargs: 'MergeFile') -> ModuleReturnValue:
         if not shutil.which('xgettext'):
             self.nogettext_warning()
             return ModuleReturnValue(None, [])
         podir = path.join(state.build_to_src, state.subdir, kwargs['po_dir'])

         ddirs = self._get_data_dirs(state, kwargs['data_dirs'])
         datadirs = '--datadirs=' + ':'.join(ddirs) if ddirs else None

         command: T.List[T.Union[str, build.BuildTarget, build.CustomTarget,
                                 build.CustomTargetIndex, 'ExternalProgram', mesonlib.File]] = []
         command.extend(state.environment.get_build_command())
         command.extend([
             '--internal', 'msgfmthelper',
             '@INPUT@', '@OUTPUT@', kwargs['type'], podir
         ])
         if datadirs:
             command.append(datadirs)

         if kwargs['args']:
             command.append('--')
             command.extend(kwargs['args'])

         build_by_default = kwargs['build_by_default']
         if build_by_default is None:
             build_by_default = kwargs['install']

         real_kwargs = {
             'build_by_default': build_by_default,
             'command': command,
             'install': kwargs['install'],
             'install_dir': kwargs['install_dir'],
             'output': kwargs['output'],
             'input': kwargs['input'],
             'install_tag': kwargs['install_tag'],
         }

         # We only use this input file to create a name of the custom target.
         # Thus we can ignore the other entries.
         inputfile = kwargs['input'][0]
         if isinstance(inputfile, str):
             inputfile = mesonlib.File.from_source_file(state.environment.source_dir,
                                                        state.subdir, inputfile)
         if isinstance(inputfile, mesonlib.File):
             # output could be '@BASENAME@' in which case we need to do substitutions
             # to get a unique target name.
             outputs = kwargs['output']
             ifile_abs = inputfile.absolute_path(state.environment.source_dir,
                                                 state.environment.build_dir)
             values = mesonlib.get_filenames_templates_dict([ifile_abs], None)
             outputs = mesonlib.substitute_values(outputs, values)
             output = outputs[0]
             ct = build.CustomTarget(
                 output + '_' + state.subdir.replace('/', '@').replace('\\', '@') + '_merge',
                 state.subdir, state.subproject, T.cast(T.Dict[str, T.Any], real_kwargs))
         else:
             ct = build.CustomTarget(
                 kwargs['output'][0] + '_merge', state.subdir, state.subproject,
                 T.cast(T.Dict[str, T.Any], real_kwargs))

         return ModuleReturnValue(ct, [ct])

     @typed_pos_args('i81n.gettex', str)
     @typed_kwargs(
         'i18n.gettext',
         _ARGS,
         _DATA_DIRS,
         INSTALL_KW.evolve(default=True),
         KwargInfo('install_dir', (str, NoneType), since='0.50.0'),
         KwargInfo('languages', ContainerTypeInfo(list, str), default=[], listify=True),
         KwargInfo(
             'preset',
             (str, NoneType),
             validator=in_set_validator(set(PRESET_ARGS)),
             since='0.37.0',
         ),
     )
     def gettext(self, state: 'ModuleState', args: T.Tuple[str], kwargs: 'Gettext') -> ModuleReturnValue:
         if not shutil.which('xgettext'):
             self.nogettext_warning()
             return ModuleReturnValue(None, [])
         packagename = args[0]
         pkg_arg = f'--pkgname={packagename}'

         languages = kwargs['languages']
         lang_arg = '--langs=' + '@@'.join(languages) if languages else None

         _datadirs = ':'.join(self._get_data_dirs(state, kwargs['data_dirs']))
         datadirs = f'--datadirs={_datadirs}' if _datadirs else None

         extra_args = kwargs['args']
         targets: T.List['Target'] = []
         gmotargets: T.List['build.CustomTarget'] = []

         preset = kwargs['preset']
         if preset:
             preset_args = PRESET_ARGS[preset]
             extra_args = list(mesonlib.OrderedSet(preset_args + extra_args))

         extra_arg = '--extra-args=' + '@@'.join(extra_args) if extra_args else None

         potargs = state.environment.get_build_command() + ['--internal', 'gettext', 'pot', pkg_arg]
         if datadirs:
             potargs.append(datadirs)
         if extra_arg:
             potargs.append(extra_arg)
         pottarget = build.RunTarget(packagename + '-pot', potargs, [], state.subdir, state.subproject)
         targets.append(pottarget)

         install = kwargs['install']
         install_dir = kwargs['install_dir'] or state.environment.coredata.get_option(mesonlib.OptionKey('localedir'))
         assert isinstance(install_dir, str), 'for mypy'
         if not languages:
             languages = read_linguas(path.join(state.environment.source_dir, state.subdir))
         for l in languages:
             po_file = mesonlib.File.from_source_file(state.environment.source_dir,
                                                      state.subdir, l+'.po')
             gmo_kwargs = {'command': ['msgfmt', '@INPUT@', '-o', '@OUTPUT@'],
                           'input': po_file,
                           'output': packagename+'.mo',
                           'install': install,
                           # We have multiple files all installed as packagename+'.mo' in different install subdirs.
                           # What we really wanted to do, probably, is have a rename: kwarg, but that's not available
                           # to custom_targets. Crude hack: set the build target's subdir manually.
                           # Bonus: the build tree has something usable as an uninstalled bindtextdomain() target dir.
                           'install_dir': path.join(install_dir, l, 'LC_MESSAGES'),
                           'install_tag': 'i18n',
                           }
             gmotarget = build.CustomTarget(f'{packagename}-{l}.mo', path.join(state.subdir, l, 'LC_MESSAGES'), state.subproject, gmo_kwargs)
             targets.append(gmotarget)
             gmotargets.append(gmotarget)

         allgmotarget = build.AliasTarget(packagename + '-gmo', gmotargets, state.subdir, state.subproject)
         targets.append(allgmotarget)

         updatepoargs = state.environment.get_build_command() + ['--internal', 'gettext', 'update_po', pkg_arg]
         if lang_arg:
             updatepoargs.append(lang_arg)
         if datadirs:
             updatepoargs.append(datadirs)
         if extra_arg:
             updatepoargs.append(extra_arg)
         updatepotarget = build.RunTarget(packagename + '-update-po', updatepoargs, [], state.subdir, state.subproject)
         targets.append(updatepotarget)

         return ModuleReturnValue([gmotargets, pottarget, updatepotarget], targets)

 def initialize(interp: 'Interpreter') -> I18nModule:
     return I18nModule(interp)
	# Copyright 2016 The Meson development team

	# 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.

	from os import path
	import shutil
	import typing as T

	from . import ExtensionModule, ModuleReturnValue
	from .. import build
	from .. import mesonlib
	from .. import mlog
	from ..interpreter.type_checking import CT_BUILD_BY_DEFAULT, CT_INPUT_KW, CT_INSTALL_DIR_KW, CT_INSTALL_TAG_KW, CT_OUTPUT_KW, INSTALL_KW, NoneType, in_set_validator
	from ..interpreterbase import FeatureNew
	from ..interpreterbase.decorators import ContainerTypeInfo, KwargInfo, noPosargs, typed_kwargs, typed_pos_args
	from ..scripts.gettext import read_linguas

	if T.TYPE_CHECKING:
	from typing_extensions import Literal, TypedDict

	from . import ModuleState
	from ..build import Target
	from ..interpreter import Interpreter
	from ..interpreterbase import TYPE_var
	from ..programs import ExternalProgram

	class MergeFile(TypedDict):

	input: T.List[T.Union[
	str, build.BuildTarget, build.CustomTarget, build.CustomTargetIndex,
	build.ExtractedObjects, build.GeneratedList, ExternalProgram,
	mesonlib.File]]
	output: T.List[str]
	build_by_default: bool
	install: bool
	install_dir: T.List[T.Union[str, bool]]
	install_tag: T.List[str]
	args: T.List[str]
	data_dirs: T.List[str]
	po_dir: str
	type: Literal['xml', 'desktop']

	class Gettext(TypedDict):

	args: T.List[str]
	data_dirs: T.List[str]
	install: bool
	install_dir: T.Optional[str]
	languages: T.List[str]
	preset: T.Optional[str]


	_ARGS: KwargInfo[T.List[str]] = KwargInfo(
	'args',
	ContainerTypeInfo(list, str),
	default=[],
	listify=True,
	)

	_DATA_DIRS: KwargInfo[T.List[str]] = KwargInfo(
	'data_dirs',
	ContainerTypeInfo(list, str),
	default=[],
	listify=True
	)

	PRESET_ARGS = {
	'glib': [
	'--from-code=UTF-8',
	'--add-comments',

	# https://developer.gnome.org/glib/stable/glib-I18N.html
	'--keyword=_',
	'--keyword=N_',
	'--keyword=C_:1c,2',
	'--keyword=NC_:1c,2',
	'--keyword=g_dcgettext:2',
	'--keyword=g_dngettext:2,3',
	'--keyword=g_dpgettext2:2c,3',

	'--flag=N_:1:pass-c-format',
	'--flag=C_:2:pass-c-format',
	'--flag=NC_:2:pass-c-format',
	'--flag=g_dngettext:2:pass-c-format',
	'--flag=g_strdup_printf:1:c-format',
	'--flag=g_string_printf:2:c-format',
	'--flag=g_string_append_printf:2:c-format',
	'--flag=g_error_new:3:c-format',
	'--flag=g_set_error:4:c-format',
	'--flag=g_markup_printf_escaped:1:c-format',
	'--flag=g_log:3:c-format',
	'--flag=g_print:1:c-format',
	'--flag=g_printerr:1:c-format',
	'--flag=g_printf:1:c-format',
	'--flag=g_fprintf:2:c-format',
	'--flag=g_sprintf:2:c-format',
	'--flag=g_snprintf:3:c-format',
	]
	}


	class I18nModule(ExtensionModule):
	def __init__(self, interpreter: 'Interpreter'):
	super().__init__(interpreter)
	self.methods.update({
	'merge_file': self.merge_file,
	'gettext': self.gettext,
	})

	@staticmethod
	def nogettext_warning() -> None:
	mlog.warning('Gettext not found, all translation targets will be ignored.', once=True)

	@staticmethod
	def _get_data_dirs(state: 'ModuleState', dirs: T.Iterable[str]) -> T.List[str]:
	"""Returns source directories of relative paths"""
	src_dir = path.join(state.environment.get_source_dir(), state.subdir)
	return [path.join(src_dir, d) for d in dirs]

	@FeatureNew('i18n.merge_file', '0.37.0')
	@noPosargs
	@typed_kwargs(
	'i18n.merge_file',
	CT_BUILD_BY_DEFAULT,
	CT_INPUT_KW,
	CT_INSTALL_DIR_KW,
	CT_INSTALL_TAG_KW,
	CT_OUTPUT_KW,
	INSTALL_KW,
	_ARGS.evolve(since='0.51.0'),
	_DATA_DIRS,
	KwargInfo('po_dir', str, required=True),
	KwargInfo('type', str, default='xml', validator=in_set_validator({'xml', 'desktop'})),
	)
	def merge_file(self, state: 'ModuleState', args: T.List['TYPE_var'], kwargs: 'MergeFile') -> ModuleReturnValue:
	if not shutil.which('xgettext'):
	self.nogettext_warning()
	return ModuleReturnValue(None, [])
	podir = path.join(state.build_to_src, state.subdir, kwargs['po_dir'])

	ddirs = self._get_data_dirs(state, kwargs['data_dirs'])
	datadirs = '--datadirs=' + ':'.join(ddirs) if ddirs else None

	command: T.List[T.Union[str, build.BuildTarget, build.CustomTarget,
	build.CustomTargetIndex, 'ExternalProgram', mesonlib.File]] = []
	command.extend(state.environment.get_build_command())
	command.extend([
	'--internal', 'msgfmthelper',
	'@INPUT@', '@OUTPUT@', kwargs['type'], podir
	])
	if datadirs:
	command.append(datadirs)

	if kwargs['args']:
	command.append('--')
	command.extend(kwargs['args'])

	build_by_default = kwargs['build_by_default']
	if build_by_default is None:
	build_by_default = kwargs['install']

	real_kwargs = {
	'build_by_default': build_by_default,
	'command': command,
	'install': kwargs['install'],
	'install_dir': kwargs['install_dir'],
	'output': kwargs['output'],
	'input': kwargs['input'],
	'install_tag': kwargs['install_tag'],
	}

	# We only use this input file to create a name of the custom target.
	# Thus we can ignore the other entries.
	inputfile = kwargs['input'][0]
	if isinstance(inputfile, str):
	inputfile = mesonlib.File.from_source_file(state.environment.source_dir,
	state.subdir, inputfile)
	if isinstance(inputfile, mesonlib.File):
	# output could be '@BASENAME@' in which case we need to do substitutions
	# to get a unique target name.
	outputs = kwargs['output']
	ifile_abs = inputfile.absolute_path(state.environment.source_dir,
	state.environment.build_dir)
	values = mesonlib.get_filenames_templates_dict([ifile_abs], None)
	outputs = mesonlib.substitute_values(outputs, values)
	output = outputs[0]
	ct = build.CustomTarget(
	output + '_' + state.subdir.replace('/', '@').replace('\\', '@') + '_merge',
	state.subdir, state.subproject, T.cast(T.Dict[str, T.Any], real_kwargs))
	else:
	ct = build.CustomTarget(
	kwargs['output'][0] + '_merge', state.subdir, state.subproject,
	T.cast(T.Dict[str, T.Any], real_kwargs))

	return ModuleReturnValue(ct, [ct])

	@typed_pos_args('i81n.gettex', str)
	@typed_kwargs(
	'i18n.gettext',
	_ARGS,
	_DATA_DIRS,
	INSTALL_KW.evolve(default=True),
	KwargInfo('install_dir', (str, NoneType), since='0.50.0'),
	KwargInfo('languages', ContainerTypeInfo(list, str), default=[], listify=True),
	KwargInfo(
	'preset',
	(str, NoneType),
	validator=in_set_validator(set(PRESET_ARGS)),
	since='0.37.0',
	),
	)
	def gettext(self, state: 'ModuleState', args: T.Tuple[str], kwargs: 'Gettext') -> ModuleReturnValue:
	if not shutil.which('xgettext'):
	self.nogettext_warning()
	return ModuleReturnValue(None, [])
	packagename = args[0]
	pkg_arg = f'--pkgname={packagename}'

	languages = kwargs['languages']
	lang_arg = '--langs=' + '@@'.join(languages) if languages else None

	_datadirs = ':'.join(self._get_data_dirs(state, kwargs['data_dirs']))
	datadirs = f'--datadirs={_datadirs}' if _datadirs else None

	extra_args = kwargs['args']
	targets: T.List['Target'] = []
	gmotargets: T.List['build.CustomTarget'] = []

	preset = kwargs['preset']
	if preset:
	preset_args = PRESET_ARGS[preset]
	extra_args = list(mesonlib.OrderedSet(preset_args + extra_args))

	extra_arg = '--extra-args=' + '@@'.join(extra_args) if extra_args else None

	potargs = state.environment.get_build_command() + ['--internal', 'gettext', 'pot', pkg_arg]
	if datadirs:
	potargs.append(datadirs)
	if extra_arg:
	potargs.append(extra_arg)
	pottarget = build.RunTarget(packagename + '-pot', potargs, [], state.subdir, state.subproject)
	targets.append(pottarget)

	install = kwargs['install']
	install_dir = kwargs['install_dir'] or state.environment.coredata.get_option(mesonlib.OptionKey('localedir'))
	assert isinstance(install_dir, str), 'for mypy'
	if not languages:
	languages = read_linguas(path.join(state.environment.source_dir, state.subdir))
	for l in languages:
	po_file = mesonlib.File.from_source_file(state.environment.source_dir,
	state.subdir, l+'.po')
	gmo_kwargs = {'command': ['msgfmt', '@INPUT@', '-o', '@OUTPUT@'],
	'input': po_file,
	'output': packagename+'.mo',
	'install': install,
	# We have multiple files all installed as packagename+'.mo' in different install subdirs.
	# What we really wanted to do, probably, is have a rename: kwarg, but that's not available
	# to custom_targets. Crude hack: set the build target's subdir manually.
	# Bonus: the build tree has something usable as an uninstalled bindtextdomain() target dir.
	'install_dir': path.join(install_dir, l, 'LC_MESSAGES'),
	'install_tag': 'i18n',
	}
	gmotarget = build.CustomTarget(f'{packagename}-{l}.mo', path.join(state.subdir, l, 'LC_MESSAGES'), state.subproject, gmo_kwargs)
	targets.append(gmotarget)
	gmotargets.append(gmotarget)

	allgmotarget = build.AliasTarget(packagename + '-gmo', gmotargets, state.subdir, state.subproject)
	targets.append(allgmotarget)

	updatepoargs = state.environment.get_build_command() + ['--internal', 'gettext', 'update_po', pkg_arg]
	if lang_arg:
	updatepoargs.append(lang_arg)
	if datadirs:
	updatepoargs.append(datadirs)
	if extra_arg:
	updatepoargs.append(extra_arg)
	updatepotarget = build.RunTarget(packagename + '-update-po', updatepoargs, [], state.subdir, state.subproject)
	targets.append(updatepotarget)

	return ModuleReturnValue([gmotargets, pottarget, updatepotarget], targets)

	def initialize(interp: 'Interpreter') -> I18nModule:
	return I18nModule(interp)