Alterator/module/first: различия между версиями

Материал из ALT Linux Wiki
м (+scheme)
 
(не показано 13 промежуточных версий 6 участников)
Строка 1: Строка 1:
<onlyinclude>
===Первый модуль===
===Первый модуль===


Лучше один раз увидеть, чем сто раз услышать, поэтому давайте сразу попробуем создать простейший модуль alterator. Сделаем проект '''alterator-simple''' &mdash; модуль который будет изменять значение одной переменной по имени '''parameter'''.
Лучше один раз увидеть, чем сто раз услышать, поэтому давайте сразу попробуем создать простейший модуль {{prg|alterator}}. Сделаем проект {{prg|alterator-simple}} — модуль, который будет изменять значение одной переменной по имени {{term|parameter}}.


==== Бэкенд ====
==== Бэкенд ====


Сначала установим пакет alterator, создадим каталог с проектом и скопируем туда '''стандартный Makefile'''.
Сначала установим пакет {{pkg|alterator}}, создадим каталог с проектом и скопируем туда стандартный {{path|Makefile}}.
<pre>
<source lang="bash">
$ sudo apt-get install alterator
sudo apt-get install alterator
$ mkdir alterator-simple
mkdir alterator-simple
$ cd alterator-simple
cd alterator-simple
$ cp /usr/share/alterator/build/Makefile .
cp /usr/share/alterator/build/Makefile .
</pre>
</source>


В скопированном Makefile изменим значение переменной <tt>NAME</tt> на <tt>simple</tt> и тут же воспользуемся стандартным правилом alterator для создания заготовки бэкенда на shell:
В скопированном {{path|Makefile}} изменим значение переменной {{term|NAME}} на {{term|simple}} и тут же воспользуемся стандартным правилом {{term|alterator}} для создания заготовки бэкенда на {{prg|shell}}:
<pre>
<source lang="bash">
$ make generate-backend-sh
make generate-backend-sh
</pre>
</source>
В результате появится файл <tt>backend3/simple</tt>. Посмотрим на него внимательнее. Основной цикл работы бэкенда — функция '''<tt>message_loop</tt>'''. Функция '''<tt>on_message</tt>''' — главная точка обработки входящих сообщений. Входящие параметры появляются в виде переменных shell с именем вида <tt>$in_name</tt>. Главный параметр '''<tt>action</tt>''' — определяет вид действия, который запрашивается у бэкенда. Основные действия:
В результате появится файл {{path|backend3/simple}}. Посмотрим на него внимательнее. Основной цикл работы бэкенда — функция {{term|message_loop}}. Функция {{term|on_message}} — главная точка обработки входящих сообщений. Входящие параметры появляются в виде переменных {{prg|shell}} с именем вида {{term|$in_name}}. Главный параметр {{term|action}} — определяет вид действия, который запрашивается у бэкенда. Основные действия:
* '''<tt>read</tt>''' — прочитать значение переменной
* {{term|read}} — прочитать значение переменной
* '''<tt>write</tt>''' — изменить значение переменной
* {{term|write}} — изменить значение переменной
* '''<tt>list</tt>''' — получить список значений
* {{term|list}} — получить список значений
Остановимся более подробно на первых двух действиях. Научим бэкенд при запросе '''<tt>read</tt>''' считывать значение переменной '''<tt>parameter</tt>''' из файла, а при запросе '''<tt>write</tt>''' записывать значение переменной '''<tt>parameter</tt>''' обратно в файл.
Остановимся более подробно на первых двух действиях. Научим бэкенд при запросе {{term|read}} считывать значение переменной {{term|parameter}} из файла, а при запросе {{term|write}} записывать значение переменной {{term|parameter}} обратно в файл.
<source lang="bash">
<source lang="bash">
case "$in_action" in
case "$in_action" in
Строка 33: Строка 34:
</source>
</source>


Сразу же проверим бэкенд, поработав с ним через интерфейс командной строки — '''<tt>alterator-cmdline</tt>'''.
Сразу же проверим бэкенд, поработав с ним через интерфейс командной строки — {{prg|alterator-cmdline}}.
<pre>
<pre>
$ alterator-cmdline -l /simple action read
$ sudo alterator-cmdline -l /simple action read
parameter:
parameter:
$ alterator-cmdline -l /simple action write parameter value
$ sudo alterator-cmdline -l /simple action write parameter value
$ alterator-cmdline -l /simple action read
$ sudo alterator-cmdline -l /simple action read
parameter:value
parameter:value
</pre>
</pre>
Можно также заглянуть в файл <tt>/tmp/config</tt> и убедиться, что он содержит строку <tt>'value'</tt>.
Можно также заглянуть в файл {{path|/tmp/config}} и убедиться, что он содержит строку {{term|'value'}}.


==== Графический интерфейс ====
==== Графический интерфейс ====
Строка 51: Строка 52:
$ make generate-ui-qt
$ make generate-ui-qt
</pre>
</pre>
В результате появятся файлы <tt>applications/simple.desktop</tt> и <tt>ui/simple/index.scm</tt> . Во втором мы сохраним следующее описание интерфейса:
В результате появятся файлы <tt>applications/simple.desktop</tt> и <tt>ui/simple/index.scm</tt> . Во втором мы сохраним следующее описание интерфейса на языке [[Scheme]]:
<source lang="scheme">
<source lang="lisp">
(document:surround "/std/frame")
(document:surround "/std/frame")


Строка 58: Строка 59:
</source>
</source>
Первая строчка служебная. Вторая — сообщает о требовании создать метку с текстом <tt>'Simple module'</tt>. Подобные конструкции можно вкладывать друг в друга, например:
Первая строчка служебная. Вторая — сообщает о требовании создать метку с текстом <tt>'Simple module'</tt>. Подобные конструкции можно вкладывать друг в друга, например:
<source lang="scheme">
<source lang="lisp">
...
...
(hbox
(hbox
Строка 67: Строка 68:


Для запуска интерфейса воспользуемся утилитой '''alterator-standalone'''. В качестве единственного параметра данная утилита принимает имя файла описания модуля (без суффикса desktop), в нашем случае это <tt>'simple'</tt>.
Для запуска интерфейса воспользуемся утилитой '''alterator-standalone'''. В качестве единственного параметра данная утилита принимает имя файла описания модуля (без суффикса desktop), в нашем случае это <tt>'simple'</tt>.
Находясь в каталоге с проектом, выполняем:
<pre>
<pre>
$ /usr/sbin/alterator-standalone -l
$ sudo /usr/sbin/alterator-standalone -l simple
</pre>
</pre>
В результате на экране появится окно [[Image:Alterator-simple1.png|thumb|left|первый графический интерфейс]] с надписью 'Simple module'.
В результате на экране появится окно [[Image:Alterator-simple1.png|thumb|left|первый графический интерфейс]] с надписью 'Simple module'.
Строка 80: Строка 82:


Суммируя сказанное получаем следующее описание интерфейса:
Суммируя сказанное получаем следующее описание интерфейса:
<source lang="scheme">
<source lang="lisp">
(document:surround "/std/frame")
(document:surround "/std/frame")


Строка 101: Строка 103:
Запустив интерфейс вы уже сможете считывать и редактировать содержимое файла /tmp/config.[[Image:Alterator-simple2.png|thumb|left|графический интерфейс, работающий с бэкендом]]
Запустив интерфейс вы уже сможете считывать и редактировать содержимое файла /tmp/config.[[Image:Alterator-simple2.png|thumb|left|графический интерфейс, работающий с бэкендом]]


====Web-интерфейс====
==== Web-интерфейс ====


На этом возможности alterator не исчерпываются. Давайте создадим и web-интерфейс управления файлом /tmp/config. Поставим дополнительные пакеты, запустим необходимые сервисы и привычно воспользуемся стандартным правилом make для создания заготовки описания web-интерфейса.
На этом возможности alterator не исчерпываются. Давайте создадим и web-интерфейс управления файлом /tmp/config. Поставим дополнительные пакеты, запустим необходимые сервисы и привычно воспользуемся стандартным правилом make для создания заготовки описания web-интерфейса.
<pre>
<pre>
$ sudo apt-get install alterator-fbi
$ sudo apt-get install alterator-fbi ahttpd
$ make generate-ui-html
$ make generate-ui-html
</pre>
</pre>
Сервис '''ahttpd''' - генератор интерфейса со встроенным web сервером. Может работать как сервис. А при запуске с параметром '-l' не уходит в фоновый режим и начинает использовать файлы с описанием интерфейса и бакенды из локального каталога. Таким образом можно заниматься отладкой своего проекта.
Сервис '''ahttpd''' — генератор интерфейса со встроенным web сервером. Может работать как сервис. А при запуске с параметром '-l' не уходит в фоновый режим и начинает использовать файлы с описанием интерфейса и бэкенды из локального каталога. Таким образом можно заниматься отладкой своего проекта.


Файл с описанием интерфейса templates/simple/index.html, самый обычный html-файл.
Файл с описанием интерфейса templates/simple/index.html, самый обычный html-файл.
Строка 120: Строка 122:
</html>
</html>
</source>
</source>
Запускаем службу ahttpd:
<pre>
$ sudo service ahttpd start
</pre>
Находясь в рабочем каталоге, запускаем ahttpd:
Находясь в рабочем каталоге, запускаем ahttpd:
<pre>
<pre>
$ /usr/sbin/ahttpd -l
$ /usr/sbin/ahttpd -l
</pre>
</pre>
После чего в любимом браузере отправляемся по адресу 'https://localhost:8080/simple'.
После чего в любимом браузере отправляемся по адресу <tt><nowiki>https://localhost:8080/simple</nowiki></tt>.
[[Image:Alterator-simple3.png|thumb|left|первый web-интерфейс]]
[[Image:Alterator-simple3.png|thumb|left|первый web-интерфейс]]


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


Теперь, как и в случае с графическим интерфейсом необходимо наладить взаимодействие с бакендом. Здесь не требуется прописывать каких-либо дополнительных инструкций, достаточно добавить текстовое поле и дать ему имя совпадающее с именем параметра:
Теперь, как и в случае с графическим интерфейсом необходимо наладить взаимодействие с бэкендом. Здесь не требуется прописывать каких-либо дополнительных инструкций, достаточно добавить текстовое поле и дать ему имя совпадающее с именем параметра:
<br clear="all" />
<source lang="html4strict">
<source lang="html4strict">
<html wf="form">
<html wf="form">
Строка 140: Строка 147:
</html>
</html>
</source>
</source>
[[Image:Alterator-simple4.png|thumb|left|web-интерфейс, работающий с бакендом]]
[[Image:Alterator-simple4.png|thumb|left|web-интерфейс, работающий с бэкендом]]
Обновив страницу в web-браузере мы уже сможем ,как и в случае с графическим интерфейсом, менять содержимое файла /tmp/config.
Обновив страницу в web-браузере мы уже сможем, как и в случае с графическим интерфейсом, менять содержимое файла /tmp/config.
<br clear="all" />
</onlyinclude>
 
 
{{Alterator modules-nav}}
[[category:devel]]

Текущая версия от 10:20, 10 декабря 2018

Первый модуль

Лучше один раз увидеть, чем сто раз услышать, поэтому давайте сразу попробуем создать простейший модуль alterator. Сделаем проект alterator-simple — модуль, который будет изменять значение одной переменной по имени parameter.

Бэкенд

Сначала установим пакет alterator, создадим каталог с проектом и скопируем туда стандартный Makefile.

sudo apt-get install alterator
mkdir alterator-simple
cd alterator-simple
cp /usr/share/alterator/build/Makefile .

В скопированном Makefile изменим значение переменной NAME на simple и тут же воспользуемся стандартным правилом alterator для создания заготовки бэкенда на shell:

make generate-backend-sh

В результате появится файл backend3/simple. Посмотрим на него внимательнее. Основной цикл работы бэкенда — функция message_loop. Функция on_message — главная точка обработки входящих сообщений. Входящие параметры появляются в виде переменных shell с именем вида $in_name. Главный параметр action — определяет вид действия, который запрашивается у бэкенда. Основные действия:

  • read — прочитать значение переменной
  • write — изменить значение переменной
  • list — получить список значений

Остановимся более подробно на первых двух действиях. Научим бэкенд при запросе read считывать значение переменной parameter из файла, а при запросе write записывать значение переменной parameter обратно в файл.

case "$in_action" in
    read)
        write_string_param parameter "$(cat /tmp/config 2>/dev/null)"
        ;;
    write)
        [ -n "$in_parameter" ] && echo "$in_parameter" >/tmp/config
        ;;
...

Сразу же проверим бэкенд, поработав с ним через интерфейс командной строки — alterator-cmdline.

$ sudo alterator-cmdline -l /simple action read
parameter:
$ sudo alterator-cmdline -l /simple action write parameter value
$ sudo alterator-cmdline -l /simple action read
parameter:value

Можно также заглянуть в файл /tmp/config и убедиться, что он содержит строку 'value'.

Графический интерфейс

Интерфейс командой строки хорошо, но графический — ещё лучше. Установим необходимые дополнительные пакеты и опять воспользуемся стандартными правилами, предоставляемыми alterator для создания простейшего описания интерфейса, а также специального файла, содержащего описание модуля. Последний потребуется для приложения, визуализирующего интерфейс.

$ sudo apt-get install alterator-standalone
$ make generate-desktop-file
$ make generate-ui-qt

В результате появятся файлы applications/simple.desktop и ui/simple/index.scm . Во втором мы сохраним следующее описание интерфейса на языке Scheme:

(document:surround "/std/frame")

(label text "Simple module")

Первая строчка служебная. Вторая — сообщает о требовании создать метку с текстом 'Simple module'. Подобные конструкции можно вкладывать друг в друга, например:

...
(hbox
 (label text "First")
 (label text "Second"))

интерфейс из двух меток, сгруппированных горизонтально.

Для запуска интерфейса воспользуемся утилитой alterator-standalone. В качестве единственного параметра данная утилита принимает имя файла описания модуля (без суффикса desktop), в нашем случае это 'simple'. Находясь в каталоге с проектом, выполняем:

$ sudo /usr/sbin/alterator-standalone -l simple

В результате на экране появится окно

первый графический интерфейс

с надписью 'Simple module'.

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

  • woo-read-first — прочитать данные из бэкенда
  • woo-get-option — получить значение параметра из ответа бэкенда
  • woo-write — записать данные в бэкенд

Первый обработчик события (loaded) будет вызываться при старте интерфейса, в этом обработчике будет происходить запрос «read» к бэкенду и полученное значение переменной 'parameter' будет записано в текстовое поле. Второй обработчик события (clicked) будет вызываться при нажатии на кнопку OK и в результате его работы будет происходить запрос «write» к бэкенду на изменение значения переменной 'parameter' на то, что записано в текстовом поле.

Суммируя сказанное получаем следующее описание интерфейса:

(document:surround "/std/frame")

(hbox
 (label text "Parameter value:")
 (document:id parameter (edit)))

(button text "OK"
  (when clicked
    (woo-write "/simple" 'parameter (parameter value))))

(document:root
  (when loaded
     (let ((data (woo-read-first "/simple")))
       (parameter value (woo-get-option data 'parameter)))))

Функция document:id назначает текстовому полю идентификатор по которому потом можно к нему ссылаться. А document:root — ссылка на текущее окно.

Запустив интерфейс вы уже сможете считывать и редактировать содержимое файла /tmp/config.

графический интерфейс, работающий с бэкендом

Web-интерфейс

На этом возможности alterator не исчерпываются. Давайте создадим и web-интерфейс управления файлом /tmp/config. Поставим дополнительные пакеты, запустим необходимые сервисы и привычно воспользуемся стандартным правилом make для создания заготовки описания web-интерфейса.

$ sudo apt-get install alterator-fbi ahttpd
$ make generate-ui-html

Сервис ahttpd — генератор интерфейса со встроенным web сервером. Может работать как сервис. А при запуске с параметром '-l' не уходит в фоновый режим и начинает использовать файлы с описанием интерфейса и бэкенды из локального каталога. Таким образом можно заниматься отладкой своего проекта.

Файл с описанием интерфейса templates/simple/index.html, самый обычный html-файл.

<html wf="form">
    <body>
        <form method="POST">
            <p>Simple</p>
        </form>
    </body>
</html>

Запускаем службу ahttpd:

$ sudo service ahttpd start

Находясь в рабочем каталоге, запускаем ahttpd:

$ /usr/sbin/ahttpd -l

После чего в любимом браузере отправляемся по адресу https://localhost:8080/simple.

первый web-интерфейс

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

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

<html wf="form">
    <body>
        <form method="POST">
            <p>Parameter value:<input type="text" class="text" name="parameter"/></p>
            <input type="submit" class="btn" value="OK"/>
        </form>
    </body>
</html>
web-интерфейс, работающий с бэкендом

Обновив страницу в web-браузере мы уже сможем, как и в случае с графическим интерфейсом, менять содержимое файла /tmp/config.