RU:JOSM/Модули/CommandLine

Общий принцип

При загрузке jOSM плагин автоматически сканирует каталог JOSM/plugins/CommandLine и загружает описания из xml-файлов. Все успешно загруженные команды попадают в список автодополнения.

Алгоритм действий при работе с плагином:

1. Поставить курсор в командную строку. Это можно сделать кликом мыши или нажатием клавиши Enter.
2. Ввести название команды (после ввода двух символов начнут предлагаться варианты завершения. Чтобы принять вариант, достаточно нажать Enter).
3. Плагин по очереди запросит у вас все необходимые параметры. Если в параметре допускается только один объект, после его указания начнется ввод следующего параметра. Параметр типа length (длины, радиусы и т.п. можно указывать перетаскиванием, при этом значение будет писаться внизу экрана jOSM, в статусной строке)
4. Параметры будут переданы в исполняемый файл так, как описаны в xml.
5. Отработав, команда вернет результат в плагин, и он проведет нужные изменения в активном слое. При этом доступна отмена стандартными средствами jOSM.

Поддерживается история введенных команд в течение сеанса (перемещение по списку осуществляется курсорными клавишами "вверх" и "вниз"). Последнюю выполненную команду можно повторить, введя пустую строку и нажав Enter.

Стандартные команды

Стандартные команды написаны с использованием языка Python и требуют установленного интерпретатора этого языка. Работоспособность проверялась на Python 2.5.4, 2.6.4 и 3.1.3

Формат файла-описателя

Описатель представляет собой файл в формате xml, содержащий описание только одной (временное ограничение) команды.

<?xml version="1.0" encoding="UTF-8"?>
<command version="3" name="Mirror" run="python mirror.py {First point} {Second point} {Copy}">
	<parameter required="true" type="any" maxinstances="0">
		<name>Objects</name>
		<description>Objects for mirroring</description>
	</parameter>
	<parameter required="true" type="point">
		<name>First point</name>
		<description>First point of mirror line</description>
	</parameter>
	<parameter required="true" type="point">
		<name>Second point</name>
		<description>Second point of mirror line</description>
	</parameter>
	<parameter required="true" type="relay">
		<name>Copy</name>
		<description>Copy</description>
		<value>Yes</value>
		<value>No</value>
	</parameter>
</command>

Передача параметров

Существуют параметры трех типов:

1. Объекты OSM (node, way, relation, any). Они передаются в скрипт через стандартный ввод.
2. Параметры с возможностью ручного ввода (number, length, point, relay, string). Они передаются в скрипт как аргумент командной строки.
3. Треки. Передаются в скрипт через стандартный ввод после всех остальных параметров (на текущий момент).

В начале передаются все зависимости аргументов (узлы полигонов, участники отношений и т.п.)

Даже если команда не имеет параметров типа объектов OSM, в начале все равно будет передан пустой osm xml с зависимостями:

<?xml version="1.0" encoding="UTF-8"?>
<osm></osm>

Типы параметров

Формат ответа

Скрипт должен подготовить и вывести в свой стандартный вывод josm xml. Кратко: новые объекты должны иметь отрицательный id, изменяемые объекты должны иметь атрибут action='modify', удаляемые объекты должны иметь атрибут action='delete'.

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

Имеется возможность отправлять в плагин комментарии для сообщения информации пользователю. Комментарии могут передаваться в любой момент, в том числе перед заголовком XML. Например:

<!--Merging nodes...-->