Sed: руководство: различия между версиями
Содержимое удалено Содержимое добавлено
Строка 802:
=== Препроцессоры ===
На базе Sed можно строить простые текстовые препроцессоры, т.е. программы, которые приводят форматирование или структуру текстового файла к некоторому типовому виду. Обычно это нужно в ситуациях, когда требуется создать много файлов с однотипной структурой (например, форм для отчетов), которые затем будут переданы другой программе или ручного заполнения человеком.
Для создания однотипных файлов обычно подготавливается шаблонный файл, в котором используется специальные отметки (''токены''), называющие позицию, но не конкретизирующие содержимое фрагмента на этой позиции. Когда вы отдаете этот файл Sed, то он заменяет токены на то содержимое, которое вы попросите. Это могут быть элементы другого языка разметки или простой текст.
В данном примере мы попробуем написать препроцессор для генерации файла отчета. Наши отчеты будут простыми текстовыми файлами без каких-либо языков разметки. Для начала мы договоримся о токенах, которые могут встречаться в шаблонном файле.
* ''Заголовок''. Мы будем поддерживать заголовки двух уровней. Для обозначения заголовка мы введем токен <code>h.<цифра>.<текст заголовка></code>, где цифра означает уровень заголовка, начиная с единицы. Под цифрой 0 мы будем иметь в виду шапку документа.
* ''Простые замены''. В наш отчет будут добавляться типовая информация типа версия препроцессора, сгенерировавшего отчет; время генерации и автор. Мы будем использовать для это соответствующие токены: <code>DATE</code>, <code>VERSION</code>, <code>AUTHOR</code>.
* ''Типовой фрагмент''. В отчет будут добавляться типовые фрагменты текста, такие как ''нижний колонтитул'' (<code>FOOTER</code>) и информацию о лицензии (<code>LICENSE</code>).
Шаблонный файл отчета пусть будет размечен так (<code>report_templ.txt</code>):
<source lang="">
h.0.report
DATE
VERSION
AUTHOR
h.1.License
LICENSE
h.1.Preface
h.1.Section 1
h.2.Section 1.1
FOOTER
</source>
Мы будем вызывать Sed не сами по себе, а в рамках Bash-сценария, так как Sed не имеет возможности получать некоторые подстановки типа даты и автора. Для начала создадим файл с кодом Sed, которые решает простейшие задачи форматирования.
<source lang="bash">
#
# Файл: report.rules.sed
#
# Подстановка постоянных фрагментов из других файлов
/LICENSE/ {
# Вставляем содержимое файла с лицензией
r license.txt
d
}
/FOOTER/ {
# Вставляем содержимое файла с нижним колонтитулом
r footer.txt
d
}
# Генерируем стандартное содержимое
/h\.[[:digit:]]*\..*/ {
/h\.0\..*/ {
# Окантовка заголовка
i ================================================================================
a ================================================================================
# Заголовок переводится в верхний регистр. Директива \U работает только в GNU Sed
s/h\.0\.\(.*\)/ \U\1/
}
/h\.[1-2]\.*/ {
/h\.1\..*/ {
# Окантовка заголовка первого уровня
i --------------------------------------------------------------------------------
a --------------------------------------------------------------------------------
# Добавляем пустую строку
a
}
/h\.2\..*/ {
# Окантовка заголовка второго уровня
a --------------------------------------------------------------------------------
a
}
# Заменяем текст в заголовках
s/h\.[1-2]\.\(.*\)/ \1/
}
}
# Печатаем результаты
p
</source>
Правила файла <code>report.rules.sed</code> позволяют назначить стандартное форматирование для токенов заголовков, а также подставляет содержимое файла с лицензией <code>license.txt</code> и файла с нижним колонтитулом <code>footer.txt</code>. Чтобы заголовки выделялись в тексте, мы используем псевдографику через подчеркивание разными символами. Данные правила также преобразуют токены заголовков шаблона в нормальные строки.
Содержимое файла с лицензией <code>license.txt</code> пусть будет следующим:
<source lang="">
MIT License
Copyright (c) YEAR AUTHOR1
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
</source>
В файле с лицензией мы используем два токена <code>YEAR</code> и <code>AUTHOR1</code>, чтобы эти части динамически заменялись. Файл с нижним колонтитулом <code>footer.txt</code> имеет такое содержимое:
<source lang="">
================================================================================
This file was generated on TODAY at TIME
</source>
Здесь также есть заменяемые части.
Теперь оформим вызов в виде Bash скрипта.
<source lang="bash">
#!/bin/bash
VERSION=0.1
TEMPLATE_PATH=report_templ.txt
SED_RULES='report.rules.sed'
REPORT_NAME=$(mktemp -u XXXXXXXXXX.report.txt)
# Подстановки
DATE=$(date --rfc-3339=seconds)
DATE1=$(date --rfc-3339=date)
TIME=$(date +%T)
YEAR=$(date +%Y)
AUTHOR=$(whoami)
[[ -f $TEMPLATE_PATH && -f $SED_RULES ]] || { echo "Error: Not found '$TEMPLATE_PATH' or '$SED_RULES' file"; exit 1;}
echo "New report has name '$REPORT_NAME'"
# Базовая процедура
sed -nf "$SED_RULES" \
"$TEMPLATE_PATH" >"$REPORT_NAME"
# Разрешаем подстановки
sed -i \
-e 's/VERSION/Version: '"$VERSION"'/' \
-e 's/DATE/Creation date: '"$DATE"'/' \
-e 's/TODAY/'"$DATE1"'/' \
-e 's/TIME/'"$TIME"'/' \
-e 's/YEAR/'"$YEAR"'/' \
-e 's/^AUTHOR$/Author: '"$AUTHOR"'/' \
-e 's/\<AUTHOR1\>/'"$AUTHOR"'/' "$REPORT_NAME"
if [[ -f $REPORT_NAME ]]; then
echo "======="
echo "PREVIEW"
echo "======="
cat "$REPORT_NAME"
fi
exit 0
</source>
Каждый вызов данного сценария генерирует новый файл с отчетом, имя для которого генерируется случайно. Для того чтобы сценарий правильно работал, все необходимые файлы должны лежать рядом с ним. В конце процедуры отобразиться превью файла, поэтому файл с отчетом можно дополнительно не открывать.
Попробуем сделать вызов.
<source lang="bash">
./gen-rep.sh
New report has name 'SXWtKYofTQ.report.txt'
=======
PREVIEW
=======
================================================================================
REPORT
================================================================================
Creation date: 2022-09-07 14:26:05+03:00
Version: 0.1
Author: john
--------------------------------------------------------------------------------
License
--------------------------------------------------------------------------------
MIT License
Copyright (c) 2022 john
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
--------------------------------------------------------------------------------
Preface
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Section 1
--------------------------------------------------------------------------------
Section 1.1
--------------------------------------------------------------------------------
================================================================================
This file was generated on 2022-09-07 at 14:26:05
</source>
Обратите внимание, что не все части в нашем сценарии переносятся. Так, следующая конструкция поддерживается только в GNU Sed <code>s/h\.0\.\(.*\)/ \U\1/</code>.
== Продвинутые приемы ==
| |||