ТОМ: язык программирования

Справочник по языку программирования платформы ТОМ.

страничка в разработке...

Типы данных

Основные типы

Значения основных типов данных могут участвовать в выражениях и присваиваться переменным и свойствам объектов.

number

Число. Числовым типом может быть представлено любое целое число. Над данными числового типа действуют основные арифметические операции.

bool

Логический тип данных. Может принимать значение "да" (true) или "нет" (false). Над данными логического типа действуют операции булевой алгебры.

object

Объект. Объектным типом может быть представлен любой существующий объект. Значения этого типа предоставляют доступ к свойствам и методам объекта.

Помимо ссылки на объект, объектный тип данных несет дополнительную информацию о количестве объектов (.num) и о положении объекта (.pos).

Объектные переменные возвращаемые парсером, дополнительно несут информацию о том каким словом был назван объект в команде (.str) и в какой форме находится это слово (.key).

string

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

key

Лингвистический ключ - строка специального формата. В лингвистических операциях может применяться без кавычек.

lexeme

Лексема - строка специального формата

null

Пустое значение. Обращение к несуществующим свойствам, функциям и переменным всегда возвращает null. В логических операциях null выполняет роль 3го логического значения "неизвестно". Все остальные операции с null всегда возвращают null.

Производные типы

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

object.form

Объект с указанными аспектом и формой

object.item

Группа объектов, принадлежащих другому объекту, с указанными аспектом и формой

Преобразование типов

При использовании в операции данных различных типов, интерпретатор пытается привести правый операнд к типу левого операнда.

Например:

5 + "5" == 5 + 5 == 10

"5" + 5 == "5" + "5" == "55"

Операторы

=

Оператор "=" используется:

• Для присвоения значений:

Синтаксис: A = Б

где: A - переменная или свойство, Б - значение или вычисляемое выражение

результат: переменной (свойству) А присваивается значение Б.

• Для определения строчных синонимов:

Синтаксис: "А" = "Б" = "В"

где: А, Б, В - строки, не содержащие пробелов

результат: при парсинге строки Б и В подменяются строкой А

• Для определения объектов-синонимов:

Синтаксис: A = Б

где: А и Б - объекты

результат: объект Б становится синонимом объекта А.

+, -, *, /

Математические операторы

==, !=-<>, >, <, >=, <=

Операторы сравнения значений

Логические операции

! / не

Логическое отрицание

не true = false

не false = true

не null = null

| / or / или

Логическое сложение

true или true = true

true или false = true

true или null = true

false или true = true

false или false = false

false или null = null

null или true = true

null или false = null

null или null = null

& / and / и

Логическое умножение

true и true = true

true и false = false

true и null = null

false и true = false

false и false = false

false и null = false

null и true = null

null и false = false

null и null = null

Лингвистические операторы

Для синтеза текста в выражениях используются операторы:

~, *, :

Оператор :

Оператор аспекта. Используется для указания аспекта объекта. В качестве аспекта может использоваться имя любого текстового свойства этого объекта. По умолчанию используется свойство title.

Пример:

unique Test //создаем объект и задаем текстовые свойства
.title = "тестов% объект%; Мр; Ип; Ип=ы,; Рп=ого,а;"
.description = "описание тестового объекта"
.add_property = "дополнительное свойство"

Выводим аспекты объекта:

%{Test:title} 
%{Test:description}
%{Test:add_property}

На экран выводится:

тестовый объект
описание тестового объекта
дополнительное свойство

Применение аспекта имеет смысл для свойств с типом лексема. Для обычных строковых свойств оператор ":" эквивалентен оператору "."

Для сравнения:

%{Test:title} //лексема
%{Test.title} 
%
%{Test:description} //строка
%{Test.description}

На экран выводится:

тестовый объект
тестов% объект%; Мр; Ип; Ип=ы,; Рп=ого,а;

описание тестового объекта
описание тестового объекта

Оператор *

Оператор используется для согласования формы объекта с лингвистическим ключом или другим объектом.

Оператор ~

Оператор используется для выделения части лингвистического ключа.

Команды языка

%

Вывод текста на экран. Текстом считается вся строка после знака %.

%Тест //на экран будет выведен текст "Тест"

debug / отладка

• debug on / отладка вкл - включает режим отладки;
• debug off / отладка выкл - выключает режим отладки;
• debug "message" / отладка "сообщение" - в режиме отладки выводит сообщение на экран.

run / запустить

• run "file name" / запустить "имя файла" - запускает на исполнение указанный файл.

run "help.txt" //очистка данных, выполнение модуля help.txt

При этом происходит потеря всех текущих данных.

include / загрузить

• include "file name" / загрузить "имя файла" - загружает и выполняет указанный файл.

include "help.txt" //выполнение модуля help.txt поверх существующих данных

Используется для модульной организации кода.

Переменные

Интерпретатор использует не типизированные переменные. Любой переменной можно присвоить значения любого типа.

Переменная, определенная в методе объекта, существует до конца выполнения метода.

Неинициализированная переменная имеет значение null.

var / переменная

Синтаксис: var X

Синтаксис: переменная X

Результат: создана переменная X, значение переменное равно null.

Синтаксис: var X = 0

Синтаксис: переменная X = 0

Результат: создана и инициализирована переменная X.

Константы

null / пусто

• Используется в выражениях. Задает пустое значение.

true, yes / истина, да

• Используется в выражениях. Задает истинное логическое значение.

false, no / ложь, нет

• Используется в выражениях. Задает ложное логическое значение.

Объекты

Под объектом подразумевается некоторая сущность, обладающая именем, свойствами и поведением.

Каждый объект принадлежит к одной из категорий и может принадлежать некоторому классу. Категория и класс объекта в свою очередь частично (или полностью) определяют поведение объекта.

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

Свойства объектов

Свойство объекта - это переменная, связанная с объектом. Все данные объекта хранятся в его свойствах. Доступ к свойствам осуществляется по их имени.

Элементы объекта

Объект может содержать в себе множество вложенных объектов. Смысловая интерпретация вложения одного объекта в другой может быть различной и зависит как от категорий объектов так и от замысла автора игры. Обращение к вложенным объектам осуществляется через специальное свойство .item / .элемент

Корзинка.item //возвращает все объекты внутри корзинки

Корзинка.item.num //возвращает количество объектов внутри корзинки

Корзинка.item[3] //возвращает 3й объект в корзинке

Для вложенных объектов предусмотрен фильтр по аспекту

Корзинка.item:пирожок //возвращает все объекты, для которых определено свойство .пирожок

Корзинка.item:пирожок.num //возвращает количество пирожков внутри корзинки

Корзинка.item:пирожок[1] //возвращает 1й пирожок из корзинки

Методы объектов

Метод - это функция, принадлежащая объекту.

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

Категории объектов

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

Узнать категорию объекта можно с помощью специального свойства .ctg

location / локация

Объекты категории location используются для организации пространства игры. При входе персонажа в локацию автоматически отображается наименование (.title) и описание (.description) локации.

Пример:

location комната //создаем новую локацию
.title = "маленькая комната" //задаем наименование
.description = "это светлое и уютное помещение." //задаем описание

или

локация комната //создаем новую локацию
.наименование = "маленькая комната" //задаем наименование
.описание = "это светлое и уютное помещение." //задаем описание

Локация может содержать в себе другие локации, уникальные и счетные объекты, мыслимые объекты. Для элементов локации подразумевается что они находятся в этой локации.

unique / уникальное

unique - категория уникальных объектов, существующих в единственном экземпляре.

Пример:

unique кувшин //создаем уникальный объект
комната + кувшин //помещаем объект в локацию

или

уникальное кувшин //создаем уникальный объект
комната + кувшин //помещаем объект в локацию

Положение уникального объекта всегда однозначно определено и может быть получено через специальное свойство .pos, а локация через свойство .loc

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

class / класс

Под классом подразумевается объект, который задает некоторое общее поведение для других объектов. Таким образом, любой объект может принадлежать или не принадлежать определенному классу, то есть обладать или не обладать поведением, которое данный класс подразумевает.

counting / счетное

counting - категория счетных, неразличимых объектов.

mental / мыслимое

mental - категория мыслимых, не существующих физически объектов.

action / действие

action - специальная категория объектов, предназначенная для описания команд, распознаваемых парсером.

Шаблоны

Переменные в шаблоне

Шаблон может включать в себя переменные различных типов. Переменная задается специальным знаком и именем после знака. После имени переменной может быть указан аспект и лингвистический ключ. Например:

.шаблон = "осмотреть @Объект:Предмет*ВпЕч"

где:

• @ - символ, указывающий тип переменной;
• Объект - имя переменной;
• Предмет - аспект объекта;
• ВпЕч - лингвистический ключ.

В шаблоне возможно использование следующих типов переменных:

• @ - объекты, присутствующие в текущей локации;
• ~ - объекты, присутствующие в локации и подходящие для действия, но не упомянутые в команде напрямую;
• & - объекты, независимо от их местонахождения;
• # - числовая переменная;
• $ - строковая переменная.

Перехват системных команд

Если шаблон совпадает с одной из системных команд и действие будет выполнено без ошибки - стандартная обработка команды выполняться не будет.

Пример:

action NoSave
.шаблон = "save=сохранить"

Мышонок.NoSave( ){ %сохранение запрещено! }

проверки

Методы объектов action используются в качестве проверок и вызываются парсером в процессе обработки анализируемой команды.

Проверка считается проваленной, если возвращает непустое строковое значение. Парсер выводит эту строку как сообщение об ошибке.

Использование методов в качестве проверок имеет некоторые принципиальные отличия:

• Все переменные, определенные в проверяемом шаблоне, доступны во время выполнения проверки, независимо от того, указаны ли они в аргументах метода.

• Все проверки работают в общем контексте. Т.e. переменная, созданная при выполнении проверки, доступна во всех проверках, выполняемых позже.

• При наследовании объекта action от класса, методы класса также используются в качестве проверок. При перегрузке метода класса в наследнике, в качестве проверки выполняется метод наследника.

Проверки переменных

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

action Осмотреть //создаем действие осмотреть
.pat = "осмотреть @Предмет" //добавляем шаблон с переменной "Предмет"
.Предмет(Предмет) //добавляем проверку для переменной "Предмет"
{ if(Предмет==pers)
    return "ты не можешь себя увидеть!" //сообщение об ошибке
}

phrase / фраза

phrase - специальная категория, предназначенная для описания диалоговых фраз, распознаваемых парсером.

event / событие

event - специальная категория, предназначенная для описания произошедших событий, распознаваемых парсером.

Предопределенные объекты

global / глобал

global - системный объект. Используется для хранения глобальных переменных и функций. Создается при старте системы.

global.title содержит наименование системы "ТОМ"

global.description - номер версии и прочую информацию.

Свойства и методы global доступны в контексте других объектов как глобальные функции и переменные.

pers / перс

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

Персонажем может быть только уникальный объект.

При старте системы pers == global

Управление персонажем:

unique главный_герой //создаем уникальный объект
pers = главный_герой //передаем управление на новый объект

this / это

Во время выполнения метода, this указывает на объект, которому принадлежит выполняемый метод.

actor / актер

actor указывает на объект, от имени которого выполняется действие. actor не изменяется при вызове методов других объектов. По умолчанию значения всех относительных свойств возвращаются относительно объекта actor.

act / акт

act указывает на объект категории action и соответствует действию, выполняемому в данный момент. act имеет смысл в методах, вызываемых парсером и после парсера. Во всех остальных случаях значение act равно null.

Предопределенные свойства

Свойства всех типов

Для любого типа данных возможен доступ к дополнительным полям.

(Но не для всех типов данных эти поля имеют смысл).

.typ / .тип

(только для чтения)

Возвращает строковое значение соответстующее типу значения.

Работает для всех типов данных.

.str / .строка

(только для чтения)

Для строки возвращает ту же строку.

Для объекта, полученного из парсера, возвращает слово, которым объект назван в команде.

Для объекта, полученного функцией set( ), возвращает строку, использованную в функции.

Для прочих типов возвращает пустую строку.

.num / .число

(только для чтения)

Для числа возвращает то же число.

Для объекта возвращает количество объектов.

Для прочих типов возвращает 0.

.obj / .объект

(только для чтения)

Возвращает "чистый" объект без примеси количества и положения.

.key / .ключ

(только для чтения)

.pos / .поз

(только для чтения)

Свойства объектов

.name / .имя

Возвращает программное имя объекта.

(только для чтения)

.loc / .лок

Возвращает локацию, в которой находится объект.

Для уникальных объектов локация всегда определена. Для прочих категорий - зависит от обстоятельств.

(только для чтения)

.cls / .класс

Синтаксис: O.cls

Где: O - любой объект.

Возвращает объект, являющийся классом для объекта O.

Если класс не задан, O.cls возвращает null.

Для смены класса, свойству объекта .cls необходимо присвоить новое значение:

O.cls = С

Где: C - объект категории class.

.ctg / .категория

Синтаксис: O.ctg

Где: O - любой объект.

Возвращает строковое значение соответстующее категории объекта O.

(только для чтения)

.syn / .синоним

(только для чтения)

.lex / .лексема

(только для записи)

.pat / .шаблон

Cвойство используется для установки парсерных шаблонов для объектов категорий action, phrase и event. Количество шаблонов для одного объекта не ограничено.

(только для записи)

Пример

action осмотреть //создаем действие "осмотреть"
.pat = "осмотреть" //задаем 1й шаблон
.pat = "осмотреть @объект" //задаем 2й шаблон
.pat = "осмотреть @какой @объект" //задаем 3й шаблон

.item / .элемент

Свойство .item предоставляет доступ к вложенным объектам.

Предопределенные методы объектов

Для каждого объекта можно задать реакцию на события, которые с ним происходят.

Нижеописанные методы выполняют обработку событий:

.ChkMoveObj( ) / .ПроверкаПеремещенияОбъекта( )

Метод вызывается перед попыткой перемещения объекта. В этом методе можно разместить проверки на возможность перемещения. Если метод возвратит true - перемещение выполняется, если false - отменяется.

.BefMoveObj( ) / .ПередПеремещениемОбъекта( )

Метод вызывается перед перемещением объекта.

.AftMoveObj( ) / .ПослеПеремещенияОбъекта( )

Метод вызывается после перемещения объекта.

.background( ) / ФоновыеДействия( )

Метод используется для описания фоновых действий.

После каждого хода вызывается для объекта global, локации, в которой находится pers, и для всех объектов, находящихся в той же локации что и pers, за исключением самого объекта pers.

.persbackground( ) / ФоновыеДействияПерсонажа( )

Метод используется для описания фоновых действий объекта pers.

После каждого хода вызывается только для объекта pers.

Теги

ТОМ поддерживает вставку управляющих тегов в выводимый текст. Теги обрабатываются на стороне интерфейсной оболочки. Различные оболочки могут поддерживать различные наборы тегов. Для механизмов ядра ТОМа теги абсолютно прозрачны и ни как не влияют на его работу. Также есть несколько служебных тегов вставляемых в текст автоматически.

Теги TOMа

Ниже описаны теги, автоматически вставляемые ТОМом в выводимый текст в специальных случаях:

<location></location>

При входе персонажа в локацию автоматически отображается название локации и её описание. Название локации при этом заключается в тег:

<location>Название локации</location>

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

<menu></menu>, <menu_item></menu_item>

Для локаций автоматически генерируется строка меню. Строка меню включает специальные теги и имет следующий формат:

<menu>Заголовок меню: 
<menu_item>1 элемент меню</menu_item>, 
<menu_item>2 элемент меню</menu_item>,
<menu_item>3 элемент меню</menu_item></menu>

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

Теги оболочки ConTOM

Интерфейсная оболочка ConTOM обрабатывает теги:

• <location></location> - выделяет наименование локации цветом.
• <menu></menu> - выделяет строку меню цветом.
• <pause> - приостанавливает вывод текста до нажатия любой кнопки.
• <font color=Color> - изменяет цвет шрифта. Color должен быть из списка: black, navy, green, teal, maroon, purple, olive, silver, gray, blue, lime, aqua, red, fuchsia, yellow или white.
• </font> - возвращает серый цвет шрифта.

Все прочие теги консольной оболочкой игнорируются и не влияют на ее работу.

Системные команды

В данном разделе описаны команды вводимые игроком, реакция на которые предопределена на уровне платформы.

Автору игры не нужно делать никаких дополнительных усилий для обработки этих команд, но при необходимости есть возможность перехвата системных команд в коде игры.

help, помощь, ?

Команда help запускает на исполнение файл help.txt из каталога игры. Авторам рекомендуется размещать в этом файле помощь по прохождению игры.

run, start, запустить

Команда позволяет выбрать и запустить новую игру из файла с расширением .tom, .txt или .tgs

При выборе файла с расширением .tgs загрузка происходит аналогично команде load.

save, сохранить

Команда save позволяет сохранить текущее состояние игры в файл с расширением .tgs

Сохранять файлы необходимо в каталог игры.

Файлы сохраненной игры имеет обычный текстовый формат.

load, загрузить

Команда load восстанавливает состояние игры из файла .tgs, сохраненного ранее командой save.

undo, отмена

В текущей версии ТОМа команда не реализована.

restart, заново

Команда restart запускает игру с начала, либо загружает последнее сохранение, сохраненное командой save или загруженное командой load.

exit, quit, выход

Команда закрывает приложение без сохранения данных.