SCOL - черновик хэлпа

[Оlеg75]

5. Управление файлами
5.1. COL - разделы
5.2. Типы файлов
5.2.1. Нормальные файлы [?]
5.2.2. Подписанные файлы [?]
5.3. Файлы управления API [?]
5.4. Расширения файлов с функцией чтения [?]
5.5. Файлы выбора интерфейса

6. События - [driven (?)] и программирование графического интерфейса
6.1. Основные принципы
6.1.1. Частные каналы [?]
6.1.2. Управление событиями
6.2. Примеры
6.2.1. Окна
6.2.2. Таймеры

7. 3D - программирование
7.1. Основные концепции 3D
7.1.1. Сцена
7.1.2. Сессия
7.1.3. Материал
7.1.4. Производительность
7.1.5. Характеристики SCOL 3D Voy@ger
7.2. 3D-формат файлов [?]
7.3. Манипуляции с 3D API
7.3.1. Новые типы
7.3.2. Сессия
7.3.3. Общее управление объектами
7.3.4. Управление материалами
7.3.5. Управление текстурами
7.3.6. Управление рендерингом и связь с 2D - интерфейсом
7.4. Управление столкновениями
7.4.1. Принципы
7.4.2. API

8. [Bignum (?)] программирование
8.1. Введение
8.2. API
8.3. Пример

9. SQL
9.1. Введение
9.2. API
9.2.1. Подключение созданной функции
9.2.2. Отключение функции
9.2.3. Запрос функции
9.3. Примеры

[Оlеg75]

1. Описание

Данная глава, включающая описание SCOL, поможет вам сделать первые шаги в этой среде программирования.

1.1. Описание виртуальной машины SCOL

[Внимание! Некоторые главы мне придётся переработать с учётом той версии виртуальной машины, которая установлена у меня на компьютере. Так как в данном (вольном) переводе документации многое в основном будет привязываться именно к программированию в среде движка OpenSpace3D, то я иногда буду отступать от основного текста оригинала, и дополнять его необходимыми на мой взгляд сведениями. Большие отступления от основного текста постараюсь выделять цитатой и иногда зелёным цветом. Качество самого хэлпа думаю от этого не пострадает ]

Виртуальная машина SCOL - это программа, основанная на технологии SCOL. Виртуальная машина создаёт виртуальную версию "идеальной" машины со следующими характеристиками:
-- Автоматическое управление памятью. Разработчики не должны сами заботиться о резервировании и об освобождении памяти.
-- "Машинным языком" этой виртуальной машины является язык SCOL
-- В виртуальную машину встроено полное управление сетью, [маскируемое (?)] языком SCOL
-- Есть много библиотек, позволяющих подключать к виртуальной машине графические, звуковые, и другие интерфейсы пользователя, о которых будет в дальнейшем рассказано в этой документации.

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

Windows-версия виртуальной машины, которая называется Scol Voy@ger (на данный момент последняя её версия - 6.4.5 от марта 2015 года), при установке размещается по пути C:\Program Files (x86)\Scol Voyager для 64-битных систем и C:\Program Files\Scol Voyager для 32-битных систем. В моём случае SCOL-машина установилась автоматически при установке движка OpenSpace3D. При этом нужно явно указать, что хотите дополнительно её скачать. Весит она примерно 70 мегабайт. Можно также SCOL Voy@ger 6.4.5 скачать и отдельно по этой ссылке http://www.scolring.org/rsc/scol_plugin.exe
В этом случае SCOL-машину можно без проблем использовать даже без установки OpenSpace3D.

А вот структура файлов и каталогов виртуальной машины, автоматически (вместе с OpenSpace3D) установленной на моём компьютере:



В правой части окна исполняемый файл Scol.exe , запускающий машину - выделен. Слева, если вы заметили, среди прочих каталогов располагается папка Moya_pervaya_programma. Там находятся файлы с кодом первой программы на языке SCOL, которую скоро и рассмотрим.

[Оlеg75]

1.2. Связь между виртуальной машиной SCOL и файлами на вашем компьютере

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

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

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

[далее идёт пока непонятная краткая информация про кэш и разделы в структуре каталогов виртуальной машины. По причине несоответствия путей и названий каталогов на моём компьютере - пока эту информацию пропущу]

1.3. Реализация окружения

1.3.1. Установка SCOL [Информация скорее всего устарела]


1.3.2. Специальная конфигурация

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

Тем не менее логи могут быть полезны разработчикам. В частности, они указывают на ошибки синтаксиса или на ошибки компиляции в целом. Кроме того, некоторые функции языка SCOL во время выполнения программы могут быть записаны в лог-файл. Часто это помогает эффективно отладить программу.

Теперь посмотрим как настроить машину на создание лог-файлов.

-- Запустите виртуальную машину
-- В трее появится значок машины

-- Жмём правой кнопкой по этой иконке
-- Выбираем Advanced... > expert Mode
-- Появится окно, в котором строку "echo 0" надо заменить на "#echo 0" (символ # используется для добавления комментариев к строке). Также замените строку с "log no" на "log yes". На скрине получившиеся строки выделены. Жмите Ок.


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

1.3.3. Девелопинг (развитие)

Для разработки программ в виртуальной машине SCOL потребуется какой-либо внешний текстовый редактор для ввода кода. Можно пользоваться обычным встроенным в Windows блокнотом, но лучше если редактор будет более продвинутый с возможностью использовать подсветку и отступы для разных языков программирования. Если редактор позволяет - выберите в его настройках отображение синтаксиса языка С.

Я буду использовать Notepad++. Чтобы там выбрать нужный синтаксис, выбираем в меню Синтаксисы > C > C

[Оlеg75]

2. Hello World

Начнём с самой известной программы, которая выводит на экран сообщение Hello World! (Привет мир), и сделаем три версии этой программы. Если в этой главе что-то останется непонятным, будьте терпеливы - в следующих главах всё будет подробно объяснено.

2.1. Первая версия

Итак, первым делом открываем корневой каталог виртуальной машины SCOL C:\Program Files (x86)\Scol Voyager
Пока не будет сказано иное - все наши программы размещаем в папке с названием Partition_LockedApp. Открываем её и внутри создаём папку с названием Moya_pervaya_programma. Внутри уже этой программы создаём два файла. Поступаем просто - правой кнопкой мыши на свободном пространстве и выбираем Создать > Текстовый документ. Когда два текстовых файла созданы, меняем их расширения с txt на pkg и scol. Будьте внимательны, в Windows должно быть включено отображение расширений файлов, иначе если добавите к имени точку и расширения то файлы всё равно останутся текстовыми.

Чтобы настроить отображение расширений в Windows 8 нужно в проводнике выбрать меню Вид > Параметры. Откроется окно, в котором выбираем вкладку Вид. Далее в списке Файлы и папки ищем строку Скрывать расширения для зарегистрированных типов файлов и снимаем слева галочку. После - жмём Ок.

Теперь даём одинаковые имена получившимся файлам. Я назвал их Hello_mir
Всё, заготовка у нас есть. Осталось вписать в эти файлы нужные коды. Принцип тут такой - файл с расширением scol будет содержать команды для запуска файла с расширением pkg. А в последнем, в свою очередь, будет уже записана сама программа.

Открываем файл с расширением scol с помощью Notepad++. Если этот редактор у вас не портативный, а установлен в системе, то достаточно кликнуть правой кнопкой мыши по файлу и выбрать в контекстном меню команду "Edit with Notepad++" Далее, если этого ещё не сделали, выбираем в Нотепад++ синтаксис языка Си. И пишем код.

Код будет таким:

_load "Moya_pervaya_programma/Hello_mir.pkg"
main

Сохраняем код, закрываем редактор. Открываем таким же образом файл с расширением pkg. Вписываем туда следующие строки:

 /* commentary */
fun main()=
_showconsole;
_fooS ">>>>>>>>>>>> Hello Mir!";;

Сохраняем. Закрываем редактор.
Пришло время запустить нашу программу. Для этого запускаем двойным кликом файл с расширением scol. В итоге откроется вот такое консольное окно:



Внизу консольного окна виден результат работы программы. Программа напечатала строку >>>>>>>>>>>> Hello Mir!
Содержимое окна консоли также тесно связано с сообщениями, записываемыми в лог-файлы.
Также хочу заметить, что логи и многое другое хранится на диске C в папке с документами по этому пути C:\Users\имя_пользователя\Documents
После установки движка OpenSpace3D и SCOL-машины, там появятся две папки с названиями OpenSpace3D и Scol Voyager. Такое задание - каждый пусть самостоятельно откроет эти папки и просмотрит всё что там находится.