Локализация проектов Delphi - родной способ (ITE - Integrated Translation Environment)

Как ни странно, в интернете полно рассказов про сторонние приложения для локализации ваших проектов, есть сравнительные обзоры разных утилит, но нет практически ничего про родной механизм Delphi для локализации. Более того, когда на форумах кто-то спрашивает, как ему лучше добавить в программу поддержку нескольких языков, ему советуют что угодно, но только не родной механизм Delphi. Видимо, второе является следствием из первого. Хотя ITE был в Delphi... аж с Delphi 5. Ещё один пример проблемы Copy&Paste? Когда решение из лохматых середины 90-х кочует аж до 2010-го? Кто знает.

В общем, эта статья призвана восполнить этот пробел (да, во многом это перевод справки, но далеко не всё).

Примечание: ITE работает для Win32 и Win64, но не для FireMonkey-приложений.

Обзор способов локализации

Локализация в Windows

В Windows каждый исполняемый модуль может содержать ресурсы - грубо говоря, это данные, вынесенные в отдельный блок внутри PE-файла. Бывают они разных типов, среди которых нас будут интересовать таблицы строк. Собственно, это ровно и есть то, что можно предположить по названию: таблица строк, т.е. - массив из строк. Сами строки идентифицируются по численному идентификатору (ID).

Довольно подробно внутреннее устройство таблиц строк мы уже разбирали.

Сама возможность локализации заключается в том, что одна и та же строка в таблице может присутствовать в нескольких экземплярах, идентифицируемых по LangID - идентификатору языка. Т.е. конкретная строка идентифицируется с помощью 2-х параметров: ID строки и ID языка.

Иными словами, исполняемый модуль хранит свои данные в ресурсах (таблицах строк), каждая таблица содержит все переводы строки на разные языки. При загрузке строки из ресурсов, берётся подходящая строка на базе текущего языка пользовательского интерфейса (язык UI).

В действительности, это далеко не самый удобный способ, поскольку для перевода на доп. язык, надо модифицировать сам исполняемый модуль, язык нельзя добавить или удалить как "плагин". Сама ОС не слишком-то использует этот способ, тем не менее, он есть. В основном, как памятник философии старых времён: "но что, если это кому-нибудь нужно"?

Локализация в Delphi

В Delphi используется модификация базового механизма ОС. Заключается она в следующем. Мы по-прежнему используем ресурсы для хранения данных для локализации. Но в этот раз каждый исполняемый модуль содержит только строки для языка по умолчанию. Все прочие языки выносятся в отдельные модули - DLL, которые не содержат исполняемого кода, а содержат только ресурсы (так называемая ресурсная DLL или ресурсный модуль). Создаётся по одной DLL на каждый язык, каждая DLL содержит локализируемые данные программы, переведённые на соответствующий язык. Когда программа обращается к строке в таблице строк, берётся вариант строки из DLL, соответствующей текущему языку, а не из базового модуля.

В том или ином варианте эта же техника применяется и другими программами (написанными не на Delphi), в том числе и самой ОС (например, MUI). В действительности, это весьма (если не самый) распространённый способ.

В WinAPI нет функций, реализующих такую схему (по той простой причине, что вся "схема" заключается в указании одного параметра функции загрузки строки - модуля), поэтому Delphi использует свою реализацию. За счёт "магии компилятора", обращение к строке в ресурсах приводит к вызову функции, выбирающей ресурсную DLL и загружающей строку из неё. Для подробностей работы этого механизма - см. функции LoadResString и FindResourceHInstance в System.pas.

Замечу, что этот механизм всё ещё не исключает совмещения с предыдущим. Поскольку таблица строк всё ещё может содержать несколько вариантов строк в разных языках. Например, базовый модуль может включать в себя русский и английский, а все остальные языки - быть реализованными через ресурсные DLL. К сожалению, этот последний вариант не поддерживается Delphi. Модуль с несколькими языками вам придётся собирать руками (что, впрочем, не так сложно). Как крайний вариант - вы можете включить все языки в один исполняемый модуль. Это если вы не хотите дополнительных файлов.

Другие средства

Другие средства используют самые разнообразные способы. Но достаточно редко при этом используются ресурсы. Чаще всего локализированные данные оформляются отдельным текстовым файлом (ini, XML и custom-форматы).

Наиболее популярные сторонние решения:

• dxGetText - адаптация GNU GetText для Delphi.
• TJvTranslator из JVCL.
• TsiLang - платный, но зато и самый мощный.

Плюсы/минусы каждого подхода смотрите самостоятельно. Лично мне нравится ITE (иначе писал бы я эту статью).

Локализация приложений с использованием Translation Manager

Утилиты для переводов

Delphi включает в себя набор утилит для локализации приложений (Translation Tools). Они доступны как для Delphi, так и для C++ Builder-а и работают для проектов любых типов.

Утилиты представлены в двух вариантах:

• Встроенный Translation Manager (Integrated Translation Manager - ITM) - является частью IDE. Он помогает вам локализовать ваши проекты. ITM может создавать локализированные версии проектов для разных языков. Состоит он из таких частей:
  
  
  • Resource DLL Wizard (мастер создания ресурсных DLL) - создаёт проекты ресурсных DLL для выбранных вами языков. Вызывается через Project > Languages > Add.
  • Translation Editor - показывает табличку ресурсов. В каждой колонке показан оригинал, перевод, комментарий и т.п. Именно в нём вы делаете перевод своей программы. Вызывается через View > Translation Manager > Translation Editor или просто щелчком по файлу с ресурсами в менеджере проектов.
  • Translation Repository - предоставляет центральное хранилище для переводов. Попросту говоря, словарик. Это хранилище общее для всех проектов. Вы можете брать оттуда готовый перевод при локализации проекта или занести свой перевод в хранилище, когда вы закончили локализацию проекта. Вызывается по View > Translation Manager > Translation Repository.
  • Translation Tools Options - настройки утилит локализации. Вызывается по Tools > Options > Translation Tools Options.

• Внешний Translation Manager (External Translation Manager - ETM) - это автономная программа, которая может быть запущена на любой машине, даже без Delphi. Вы можете использовать её для локализации своих проектов без IDE. У ETM практически такая же функциональность, как и у Translation Editor, но с несколькими дополнительными менюшками, обусловленными автономной природой. ETM не может создавать новые проекты, но может импортировать существующие проекты. Вы можете дать ETM переводчикам, чтобы они могли делать переводы вашей программы.

Подготовка проекта

Ну, прежде чем приступать к локализации, вам надо бы сохранить проект. Также убедитесь, что он вообще компилируется.

Далее, вам нужно писать код специальным образом. Во-первых, если вы хороший программист, то вы не используете "волшебные значения" у себя в программе, а объявляете соответствующие константы. Например, вместо:

procedure TForm1.Button1Click(Sender: TObject);
begin
  A := StrToFloat(Edit1.Text) * 3.14;
  ShowMessage('Результат: ' + FloatToStrF(A, ffFixed, ...));
end;

Вы пишете:

procedure TForm1.Button1Click(Sender: TObject);
const
  Pi      = 3.14;
  SResult = 'Результат: %f';
begin
  A := StrToFloat(Edit1.Text) * Pi;
  ShowMessage(Format(SResult, [A]));
end;

Если вы так делаете - вам повезло. Нет - пора бы начинать делать :)

В любом случае, смысл в том, что все свои данные вы должны разделить на те, которые могут меняться в другом языке и те, которые нет. Как правило, почти все строковые данные относятся к первой категории, за исключением некоторых случаев. Например, если вы парсите XML, то '<' и '>' не должны меняться в зависимости от языка.

Все строковые данные в своём коде вы должны оформить в виде констант. Если строка должна локализироваться - помещайте её в секцию resourcestring. Если нет - пихайте в const. Например:

resourcestring
  rsResult = 'Результат: %f%s';

procedure TForm1.Button1Click(Sender: TObject);
const
  Pi        = 3.14;
  SDegrees  = '°';
begin
  A := StrToFloat(Edit1.Text) * Pi;
  ShowMessage(Format(rsResult, [A, SDegrees]));
end;

Правило стиля: если вы используете resourcestring, то идентификатор обычно начинается с "rs" или "S". Для строк в const такого правила нет, но префикс "S" выглядит достаточно удобно. Вы можете захотеть различать типы строк в коде (rs/S) или использовать всегда одинаковое наименование (S/S) - ваш выбор.

Рассматривайте строки в ресурсах как обычные константы. Вы можете использовать в тексте идентификатор строки и компилятор сам позаботится о загрузке этой строки из модуля ресурсов. Вам ничего не нужно для этого делать. Более того, вам также ничего не надо делать для получения локализованной версии строки. Никаких вызовов типа GetTranslatedString(SResult). Используйте константу напрямую, а магия компилятора сделает остальное - загрузит нужный язык и подставит перевод. Достаточно просто.

Блоки resourcestring обычно располагаются в модуле сразу после implementation или же их выносят в отдельный модуль типа StrConsts.pas. Поступайте как вам угодно.

Оформив код таким образом, вбейте значения для языка по умолчанию во все строковые константы, а также строковые свойства компонент на формах. Как правило, язык по умолчанию - это английский. Но для "домашней" программы это вполне может быть русский.

Ещё раз сохраните всё и убедитесь, что проект компилируется.

Resource DLL Wizard/добавление нового языка

Прежде чем приступить к собственно переводу, вам нужно добавить языки в ваш проект. Делается это с помощью Resource DLL Wizard. Выберите в меню Project > Languages > Add или File > New > Other > Delphi Projects > Resource DLL Wizard.

На первом шаге вы выбираете проекты, для которых вы добавляете язык (обычно это только один проект; несколько их будет, если их несколько в группе проектов в менеджере проектов), и для каждого проекта вы указываете язык по умолчанию. Обычно это английский (409) или русский (419).

Язык по умолчанию - это тот язык, на котором будет программа, если не найден более подходящий язык.

Далее вы выбираете один или несколько языков, которые хотите добавить:

Полный список доступных языков можно посмотреть в справке.

На следующем шаге вам предложат сменить пути для проектов ресурсных DLL. По умолчанию, эти проекты размещаются в подпапках проекта. Имя подпапки = аббревиатуре языка по ISO 639x. Например, если ваш проект лежит в C:\...\Projects\My Project 1\, и вы выбрали три языка (русский, японский и итальянский), то Resource DLL Wizard создаст три новых проекта, разместив их в папках C:\...\My Project 1\RUS\, C:\...\My Project 1\JPN\ и C:\...\My Project 1\ITA\ соответственно. Достаточно разумный выбор, поэтому чаще всего вы пропускаете этот шаг.

После ещё нескольких маловажных вопросов (щёлкайте просто Next/Yes), Resource DLL Wizard создаст вам проекты:

Как видите, для одного головного проекта я добавил три языка, и Resource DLL Wizard создал мне три дополнительных проекта. В каждом проекте есть несколько файлов - по одному на каждый модуль с DFM или блоком resourcestring.

Вы можете запускать процедуру добавления нового языка в любой момент. Просто выбирайте эту же команду, щёлкайте на дополнительном языке - и Next/Next/Next. Также, язык можно удалить, если он стал не нужен - в том же меню есть команда Remove (она не удаляет файлы с диска, а просто удаляет проект из группы проектов).

Translation Editor/перевод проектов

После добавления языков в проект, вы можете использовать Translation Editor для просмотра и редактирования VCL-форм и строковых ресурсов.

Проще всего дважды щёлкнуть по нужному файлу (dfm или rc) в проекте ресурсной DLL. Откроется такое окно:

Как вы видите, у вас есть несколько колонок с информацией о данных для локализации. Вы можете скрыть ненужные колонки, сортировать по любой колонке - делается это кнопками на тулбаре. Понятно, что самые важные колонки - это оригинал и перевод. Просто щёлкайте по ячейке, которую вы хотите перевести и вводите текст.

Также вы можете фильтровать строки таблицы (скажем, показать только не переведённые), менять статус строк, производить поиск (перейти к следующей не переведённой строке), переключать редактор в single line/multi line - всё это делается кнопками на тулбаре и из контекстного меню. Дополнительно, вы можете снабжать строки комментариями для переводчика.

Обратите внимание, что вы можете редактировать не только строки, но и любые другие свойства компонентов. Это важно, если в каком-то языке у вас не влезает какая-то надпись - в этом случае вы просто раздвигаете компоненты, чтобы она влезла. Две кнопки с рисунком форм в верхнем тулбаре позволяют вам показать исходную и транслированную версии форм. Т.е. вы можете посмотреть, как будет выглядеть окно, не запуская программу на выполнение. Более того, нажав на кнопку "Stay on top" чуть правее, вы можете зафиксировать формы, пока вы выполняете перевод. Любое изменение в Translation Editor тут же отображается на предпросмотре форм. Более того, вы можете не вводить свойства, а просто таскать компоненты по форме:

Очень удобно, надо сказать. Понятно, что если вы откроете на редактирование rc-файл, то никаких форм там не будет - просто строки и инструменты для строк.

В конце не забудьте нажать кнопочку Save (вы также можете настроить авто-сохранение в настройках ITE).

Translation Repository/использование хранилища

Translation Repository позволяет вам хранить базу данных переводов, которая разделяется между всеми проектами (и может разделяться несколькими разработчиками). Работая в Translation Editor, вы можете извлекать уже переведённые строки из хранилища Translation Repository и сохранять в него новые переводы.

По умолчанию, каждый раз, когда вы создаёте/обновляете ресурсный модуль, все значения в нём извлекаются из словаря Translation Repository. Если же перевода в нём нет, то используется базовый вариант (строка из главного проекта). Вы также можете редактировать переводы прямо в Translation Repository через его собственный интерфейс:

Translation Repository хранит свои данные в XML-файле с расширением .tmx.

По умолчанию, БД Translation Repository хранится в файле default.tmx в папке RAD Studio\bin. К сожалению, это не слишком удачное место, потому что часто запись в эту папку запрещена. Поэтому я рекомендую вам сразу же скопировать этот файл куда-то в более пригодное место - в Мои документы или Application Data. Сделать это можно командой "Save as" в окне Translation Repository. Кроме того, этот файл указывается в диалоге настроек Translation Repository Options (Tools > Options > Translation Tools Options > Repository).

External Translation Manager/делегация перевода другому человеку

ETM доступен только в новых Delphi (начиная с D2009 - скажите спасибо введению поддержки Unicode). Вы можете использовать ETM, если вам недоступна Delphi. Например, для выполнения перевода переводчиком, а не программистом ;)

Подготовка ETM

Чтобы использовать ETM как автономное приложение, вам надо просто скопировать необходимые файлы на другую машину и зарегистрировать *.bpl в ETM:
1. Создайте в любом месте папку для файлов ETM.
2. Скопируйте следующие обязательные файлы из вашей папки RAD Studio\n.n\Bin в папку, созданную на шаге 1:

• etm.exe
• designide<nnn>.bpl
• dfm<nnn>.bpl
• itecore<nnn>.bpl
• rc<nnn>.bpl
• vclide<nnn>.bpl

А также такие файлы (опционально):

• dcl31w<nnn>.bpl
• dclact<nnn>.bpl
• dclado<nnn>.bpl
• dclbcbsmp<nnn>.bpl
• dclbde<nnn>.bpl
• dclDataSnapIndy10ServerTransport<nnn>.bpl
• dclDataSnapProviderClient<nnn>.bpl
• dclDataSnapServer<nnn>.bpl
• dcldb<nnn>.bpl
• dcldbx<nnn>.bpl
• dcldbxcds<nnn>.bpl
• dclib<nnn>.bpl
• dclIe<nnn>.bpl
• dclIndyCore<nnn>.bpl
• dclIndyProtocols<nnn>.bpl
• dclmcn<nnn>.bpl
• dclmid<nnn>.bpl
• dclnet<nnn>.bpl
• dclribbon<nnn>.bpl
• dclsmp<nnn>.bpl
• dclstd<nnn>.bpl
• dclTee8<nnn>.bpl
• dcltouch<nnn>.bpl
• dclwbm<nnn>.bpl

Из папки Windows\System32 (SysWOW64 для 64-х битной Windows) также нужно взять такие обязательные файлы:

• rtl<nnn>.bpl
• vcl<nnn>.bpl
• vclactnband<nnn>.bpl
• vclimg<nnn>.bpl
• vclx<nnn>.bpl
• xmlrtl<nnn>.bpl

и следующие опциональные файлы:

• *<nnn>.bpl

Где nnn - это версия вашей Delphi. Например, RAD Studio 2009 имеет версию 120, а 2010 - 140. Т.е., designide<nnn>.bpl становится designide120.bpl или designide140.bpl.
3. Упакуйте папку с ETM в архив и передайте человеку, который будет выполнять перевод.

P.S. Не спрашивайте меня, зачем нужны опциональные файлы - я понятия не имею, а справка молчит. Но есть подозрение, что это надо для приложений с пакетами. Хотя зачем - непонятно.

Установка ETM

1. Распакуйте архив с ETM в любую папку. Предпочтительно - в C:\Program Files\.
2. Запустите ETM, дважды щёлкнув по etm.exe.
3. Выполните команду Tools > Options > Packages.
4. Нажмите кнопку "Add".
5. В открывшемся диалоге перейдите в папку с ETM и выберите все design-time пакеты (dcl*.bpl).

Подготовка проекта для перевода в ETM

Разработчик должен создать в проекте языки, как я описывал это выше. Файлы ресурсных DLL сохраняются в отдельных папках.

Для перевода проекта, вам нужно передать переводчику файлы:

• Папку с ресурсной DLL для конкретного языка
• Файл проекта dproj/cbproj
• Хранилище переводов (*.tmx)

Использование ETM для перевода проектов

Собственно, вы запускаете ETM, открываете в нём файл проекта или группу проектов (как обычно: File/Open) и начинаете редактировать:

Вкладка Project содержит настройки проекта. Вкладка Workspace - рабочие данные. Выбрав корневой узел, вы получите статистику, а выбрав конкретный файл - увидите обычный Translation Editor:

Вы должны выполнить перевод, сохранить его и отправить изменённые файлы (папку с ресурсной DLL) разработчику. Разработчик перезапишет свои файлы вашей версией и скомпилирует ресурсную DLL с локализованной версией программы.

Deploy проекта

Для этого вам надо сделать полную сборку всех проектов, включая ресурсные DLL. Желательно перед сборкой также выполнить обновление ресурсных DLL (см. ниже).

В результате вы получите главный файл (exe или DLL) и по файлу на каждый язык. Эти файлы являются DLL, но имеют расширения, обозначающие язык. Например, Project1.exe и Project1.RUS, Project1.JPN и Project1.ITA (в некоторых случаях расширение может иметь вид en-US). Вы можете распространять все файлы вместе или же распространять только exe, а файлы языков выложить для отдельного скачивания - ваш выбор.

В любом случае, чтобы это работало, достаточно просто скинуть файлы языков в ту же папку, что и программа, и они автоматически подцепятся при следующем запуске программы.

К сожалению, выделить отдельную папку для хранения языковых файлов (типа подпапки Languages) нельзя (ну, не используя хаки, конечно же).

Прочее

Обновление переводов при изменениях проекта

После того, как вы закончили перевод проекта, вы можете потом ещё работать над ним и вносить какие-то изменения, в результате которых в проект добавятся новые данные для локализации (ну или удалятся). Любые такие изменения не появятся автоматически в других проектах.

Чтобы обновить ресурсные DLL сохраните и скомпилируйте проект (если вы используете ETM - откройте проект заново), затем выполните команду: Project > Languages > Update localized projects (Project > Run updates в ETM). После этого ваши изменения будут отражены и в ресурсных DLL. Вы сможете дополнить перевод и пересобрать все проекты.

Файлы, создаваемые утилитами перевода

Расширение файла	Описание
.dfm	Утилиты перевода хранят для каждого целевого языка отдельный файл формы .dfm для каждой формы в вашем приложении. Эти файлы включают в себя данные (включая переводы строк), которые вы видите в Translation Editor.
.rc	Resource DLL Wizard использует созданный компилятором .drc файл для создания .rc файла для каждого целевого языка. Эти .rc файлы содержат строковые ресурсы, которые были объявлены в блоках resourcestring в вашем коде.
.tmx	Translation Repository хранит свою базу переводов в файле .tmx file. Вы можете завести больше одного словаря в нескольких .tmx файлах.
.{bds}proj	Translation Manager хранит проекты ресурсных DLL в разных папках (указываются при создании языка), а ссылки на эти проекты хранятся в файле проекта .dproj, .cbproj или .bdsproj.

Примечание: вам не следует редактировать эти файлы вручную.

Активный язык проекта

При запуске через F9 (Run/Run) загружается язык базового модуля. Но вы можете указать, что хотите загружать конкретный язык (ресурсную DLL). Для этого выполните команду Project > Languages > Set active. Укажите язык и при следующем запуске программы будет использоваться именно он. Для отмены этой настройки выполните эту же команду, но из списка доступных языков выберите базовый модуль.

Заметьте, что эта настройка не влияет на язык, используемый при реальном выполнении программы вне отладчика на клиентских машинах. В свободном прогоне загружается ресурсная DLL, определяемая языком пользовательского интерфейса. Т.е., грубо говоря, если кнопки в MessageBox написаны на японском - будет выбран японский язык. На русском - загружаем русскую DLL. И т.д. Это не то же самое, что язык в региональных настройках, клавиатурные раскладки или язык для не-unicode программ - это всё другие, не связанные вещи. В младших редакциях Windows язык UI жёстко зашит в систему и сменить его нельзя. Хотите сменить язык - ставьте другую версию ОС. В старших - вы можете устанавливать языковые пакеты и менять язык интерфейса по требованию (MUI) - для смены языка особых прав не надо (в отличие от его установки), нужно только сделать re-logon (выйти/зайти). Более того, каждый пользователь в системе может иметь свою настройку языка интерфейса:

В большинстве случае такое поведение - это то, что вы хотите. Если пользователь работает в немецкой Windows, ему нет смысла запускать вашу программу на русском или английском. Иначе он давно бы поставил себе русскую/английскую Windows (или сменил бы язык UI, если его редакция Windows это позволяет).

Поэтому лично я считаю, что ручной выбор языка в программе - показатель того, что вы не можете написать нормально авто-определение языка, а не действительно необходимая фишка.

Тем не менее, если вы хотите это сделать, то вы можете это сделать. Для задания override на текущий язык вам нужно отредактировать ключ реестра Software\CodeGear\Locales (для старых версий Delphi - Software\Borland\Delphi\Locales или Software\Borland\Locales) в HKCU или HKLM (смотря на кого меняете настройку): добавив строковый (REG_SZ) параметр, имя которого равно полному пути к вашему exe или DLL библиотеке, а значение равно имени языка, например, ru-RU или en-US. В справке Delphi даже есть подходящая процедура для этого:

procedure SetLocalOverrides(const AFileName, ALocaleOverride: string);
var
  Reg: TRegistry;
begin
  Reg := TRegistry.Create;
  try
    if Reg.OpenKey('Software\CoderGear\Locales', True) then
      Reg.WriteString(ALocalOverride, AFileName);
  finally
    Reg.Free;
  end;
end;

Вы можете посмотреть демонстрационную программу в комплекте демок Delphi: это проект RichEdit, в котором есть три языка (английский, французский и японский) и реализовано переключение между ними в run-time. Вы можете посмотреть, как это делается. Демку можно найти в папке демок. Это либо папка Demos в папке самой Delphi для старых Delphi, либо папка Demos в Моих документах (All users). В меню пуск на неё может быть создан ярлык. Или же вы можете её просто скачать c SVN.