Рис. 1: Пример создания программы в LY X
Описан опыт использования текстового процессора LY X как среды создания „грамотных” программ с использованием пакета NoWeb.
Программный продукт, в общем случае, включает с себя не только тексты программ, но и различную документацию: проектную, техническую, пользовательскую и маркетинговую. В зависимости от объема программы, требований к программе и выразительности технических средств [1], некоторые виды данной документации могут отсутствовать, или включаться в исходный текст программы в виде комментариев.
Проектная и техническая документация включает информацию о оказывающих влияние на программу в целом архитектурных решениях, принимаемых на этапах планирования, проектирования и разработки. Выделение документации в отдельные документы, естественное и неизбежное в случае больших проектов, приводит к серьезной проблеме синхронизации документации и исходного кода. Значимость данной проблемы в плане технической документации и один из методов решения — создание самодокументируемых программ — описана Фредериком Бруксом [2].
Одним из способов „обхода” проблемы синхронизации проектной документации и текста программы, является использование „грамотного программирования” — методики которая предлагает программисту объединить проектную и техническую документацию вместе и исходным текстом программы в рамках одного единого документа.
В рамках данной статьи будет кратко описана идеология и история грамотного программирования, приведен пример программирования в текстовом процессоре LY X.
„Грамотное программирование” (в дальнейшем ГП) — это методика написания программ делающая упор не на написании собственно кода программы, а на последовательном письменном рассмотрении всех тех задач которые решает программист получивший задание, от начала и до самого конца. При этом текст собственно программы генерируется автоматически на основе полученного документа.
ГП может использоваться (и используется) для написания программ в которых объем и/или ценность знаний относительно велика по сравнению с объемом кода. При этом время написания программ увеличивается, но возрастает и „время жизни” программы, снижается стоимость сопровождения.
Первыми системами грамотного программирования были системы WEB [3]и CWEB [4], которые использовались для создания системы верстки TeX и шрифтовой системы METAFONT. Данный опыт, был, по мнению автора, удачным так-как указанные программы, несмотря на их сложность, были созданы силами одного программиста за короткое время и получили широкое распространение. Тексты данных программ были опубликованы в виде отдельных книг [5, 6]. В интервью, говоря о влиянии методологии ГП на создание этих программ и других программ, Д. Кнут говорит:
Этот подход не только позволил мне писать и поддерживать программы быстрее и надежнее, чем когда бы то ни было раньше, и он не только был для меня самым большим источником удовольствия, начиная с 1980-х гг. – он иногда оказывался незаменимым. Некоторые из моих основных программ, такие как метасимулятор MMIX, не могли бы быть написаны с применением любой другой методологии, о которой я когда-либо слышал. Сложность была просто чересчур устрашающей, чтобы с ней можно было справиться на основе моих ограниченных умственных возможностей; без применения грамотного программирования все предприятие потерпело бы полную неудачу.
Для того, чтобы использовать ГП необходимы средства извлечения текста программ из документа, и дополнительной подготовки документа к печати. Совокупность этих средств я называю системой грамотного программирования.
Особенностями первых систем грамотного программирования были [7]:
использование языка разметки TeX, как средства оформления документации;
широкое использование макросов как средств обобщенного программирования;
автоматическое создание указателей переменных, функций, типов и модулей для того, чтобы облегчить анализ созданных программ.
Опыт использования грамотного программирования с точки зрения повторного использования программ и обучения был описан С.Бартом и его последователями. Например, в статьях [7, 8] описан опыт переноса системы TeX и родственных программ (MetaPOST, MetaFONT) на новую платформу — систему Data General AOS, при этом упоминается, что полный перенос сложной и большой программы на новую аппаратную платформу занял три дня.
Опыт использования грамотного программирования при обучении программированию и решению задач (CS1) также оказался положительным [9], при этом была обнаружена зависимость между умением использовать грамотное программирование и пониманием следующего курса — CS2.
Другой эксперимент, связанный с разработкой и поддержкой разработки программ, был проведен и описан Норманом Рамси [10]. В рамках эксперимента, в ходе которого небольшая группа программистов разрабатывала систему семантического анализа программ на языке Ада, была подтверждена эффективность методики грамотного программирования, которая облегчила взаимодействие между программистами, способствовала созданию высококачественной и полезной документации. При этом участники заявляли о следующих недостатках технических средств ГП: сложность системы TeX, как системы подготовки документации; неудобство текстового редактора emacs; отсутствие практической пользы от средств художественного оформления текстов программ, которые, к тому-же игнорируют отступы и разрывы строк сделанные программистами, исходя из логики программы.
Технически грамотное программирование состоит из нескольких независимых частей, каждая из которых может отсутствовать. К этим частям, по крайнем мере, относятся: возможность оформления комментариев, использования формул, таблиц, изображений и т.п. в комментариях, создание текста программы и технической документации к нему из одного единого документа, обобщенного программирования с помощью системы макросов, автоматическое типографское оформление текста программ и функций, автоматическое создание списка функций, переменных и модулей, автоматический контроль ссылок на переменные и функции, использование системы верстки TeX/LaTeX для оформления документации.
Так-как требования и вкусы программистов различаются, а создание системы грамотного программирования сравнительно несложная задача, было разработано большое количество систем грамотного программирования.
В настоящее время эксплуатируются следующие системы с полной реализацией всех частей грамотного программирования для одного или нескольких языков программирования: WEB[3], CWEB [4], FWEB [11].
Между тем, распространение получили системы грамотного программирования без возможности вывода кода программ с выделением синтаксиса и некоторые возможности WEB для индексации, но с поддержкой макросов: FunnelWEB [12], nuweb [13], fangle [14] и некоторые другие.
Норман Рамси, исходя из результатов своего эксперимента [10], предпочел отказаться как от макросов, так и от оформления исходного кода выводимых программ и создал свою систему грамотного программирования noweb [15]. Данная система отличается простотой и внутренней ортогональностью. Возможно, это самая простая система грамотного программирования из возможных, для её описания достаточно двух-трех абзацев.
Помимо систем грамотного программирования общего назначения, существуют, используются системы специальные, ориентированные не только на один язык программирования, но и на одну узкую область использования, например для статистической обработки данных — система Sweave и [16].
Наконец, поддержка некоторых элементов грамотного программирования встраивается как с среды разработки, например LEP[17] для IDE Eclipse, так и в языки программирования, такие как Haskel [18].
Для эффективного создания программ недостаточно иметь систему грамотного программирования — нужна среда для создания программ. В качестве среды могут использоваться как обычный текстовой редактор, возможно настроенный соответствующим образом как emacs [19] и vim, так и специализированные редакторы, ориентированные именного на литературное программирование, такие как Leo [20, 21], RWINED [16] и HOPS [22], предлагающие расширенные средства навигации по документу и визуализации диаграмм, графиков и т.п.
Эффективное создание программ предусматривает полную концентрацию программиста, на том, что он делает в данный момент, и устранение всего, что мешает концентрации [1]. Для создания программ в некоторых областях, эффективным может быть использование обычного текстового редактора. Возможно, старейшей их таких система является система WinWordWeb [23], которая в настоящее время не поддерживается, или, например, использование простой системы грамотного программирования noweb, вместе с текстовым процессором LY X [24].
Подход грамотного программирования используется сравнительно редко [25] и считается экзотическим. Говорят, что для того, чтобы писать грамотные программы, надо уметь не только программировать, но и писать ясные, структурированные тексты [26], что два этих умения редко встречаются у одного и того-же программиста.
С этим можно поспорить.
Грамотное программирования, возможно, действительно не подходит для программирования массового. С другой стороны, не существует стиля или методики программирования, будь то экстремальное программирования, или методы быстрой разработки или разработки через тестирование который подходил бы для всех задач и для всех программистов.
Данный метод идеально работает в тех случаях, когда надо рассмотреть и задачу, и алгоритм и решение, когда объяснение само по себе является ценностью.
Он хорош для использования в научной среде [27], в тех случаях когда решение надо обосновывать.
Существуют примеры успешного использования данного подхода для создания книг по программированию или описанию тех или иных методик расчетов [28, 29, 30, 31].
Поэтому хотя грамотное программирование, конечно, никогда не станет превалирующим методом программирования, но никогда и не умрет. Оно постепенно найдет свою нишу, и сделает жизнь там немного лучше.
Thinking with Style (Daniel Lanovaz, Los GatosТехнология грамотного программирования (далее в тексте — ГП) описана в книге Д. Кнута „Literate programming”. На русском языке краткое описание ГП опубликовал Андрей Зубнинский [32].
Инструментальные средства ГП были предложены в конце 80-х годов и соответствовали уровню языков и сред того времени. Предполагалось, что документ ГП это текст в формате TeX созданный в обычном текстовом редакторе, при этом в документ включаются кусочки программ и управляющие конструкции системы ГП. Пригодный к печати текст документации и исходный текст программы будут генерироваться подготовленного документа. Язык ГП был достаточно развитым, он позволял получать текст программы полиграфического качества для распространенных языков программирования, поддерживал использование макросов.
Опыт использования ГП для разработки значительной по объему программы (33 000 строк) силами группы из семи сотрудников описан в статье Нормана Рамсея [10]. Данный опыт показал как перспективность данной технологии, так и недостатки её использования и реализации. В частности, ориентация на высокое качество печатного варианта программы не оправдывает себя, и вредит в том случае, если программист не может фактически управлять размером отступов и переносами строк текста программы. Далее, использование сложного языка верстки TeX мешает использованию технологии, к тому-же TeX недостаточно выразителен и не содержит средств для вставки диаграмм, графиков и т.п. С другой стороны, было обнаружено что качество и кода и документации растут, если программист описывает что, зачем и как делает та или иная часть программы. В конечном итоге, к качеству и полезности документации к программе не было никаких претензий.
В настоящее в время, необходимость изучения дополнительного (и сложного) языка верстки, мешает использованию „грамотного программирования” даже областях, для которых оно идеально подходит, а сложность и непривычность инструментальных средств делает его применение достаточно редким, о чем и говорится в статье А.Зубнинского. Необходимо сказать, что проектирование удобных инструментальных средств для грамотного программирования чрезвычайно сложная задача, а их наличие — жизненно важно для использования технологии.
Поэтому продолжаются попытки создания инструментальных средств ГП, к которым можно отнести текстовой редактор Leo [20, 21], расширения редакторов emacs [19] и vim, редакторов RWINED [16] и HOPS [22], средства ГП встроены в язык программирования Haskell [33], существует версия языка программирования статистических расчетов R — Sweave [17], ориентированная именно на ГП. Все это говорит о том, что ГП действительно позволяет сконцентрироваться на болевой точке современного программирования и повысить качество программ, хотя и ценой сравнительно больших первоначальных затрат.
Использование ГП в образовании описано в статье [34] .
В данной статье описывается опыт использования текстового процессора LY X для ГП [35].
Свободный текстовой процессор LY X , созданный Маттиасом Эттрихом и другими разработчиками, придерживается идеологии WYSIWYM (what you see is what you mean, примерный перевод — „видишь то, что подразумеваешь”), слегка напоминает популярный редактор Microsoft Word, и генерирует файлы для системы TeX [36]. Более того, данный текстовой процессор содержит средства интеграции с простой системой ГП NoWeb [15]. (Несколько более мощная система ГП fangle тоже может использоваться для ГП. Кроме этого LY X содержит средства интеграции и с системой ГП на языке R Sweave.)
Использование текстового процессора LY X для создания программ в стиле „грамотного программирования” целесообразно в некоторых предметных областях, связанных с разработкой методов и алгоритмов обработки данных, что подтверждается практикой авторов. Было обнаружено, что использование текстового процессора удобно при создании … программ (Рис.1).
В данной статье описан пример использования программы LY X для создания учебных программ.
Эта работа не является в полной мере пионерской. Авторам удалось найти текст лекции Х.Рамачадрана, посвященной использованию LY X для программирования в scilab [37]. Данная работа отличается ориентацией на использование LY X в реальном программировании, что требует создания средств локализации ошибок, интеграции системы сборки программ и т.п.
LY X — свободный процессор документов, основанный на системе компьютерной вёрстки LaTeX, первые версии которого были созданы Маттиасом Эттихом, ведущим разработчиком KDE.
К особенностям программы можно отнести:
удобный интерфейс пользователя, напоминающий популярный текстовой редактор Microsoft Word;
ориентацию на определение структуры документа, и автоматическую верстку представления на основе механизма шаблонов;
наличие средств для использования БД библиографических источников, создания перекрестных ссылок, автоматического формирования предметных указателей, оглавлений и других навигационных элементов;
возможность автоматического экспорта текста документа в форматы html, pdf и другие;
наличие встроенного самоучителя, переведенного на русский язык;
отсутствие возможности создания собственных стилей, так-как набор используемых стилей жестко задан шаблоном документа.
В настоящее время тестовой процессор LY X это мощное и удобное средство создания значительных по объему документов, гарантирующее профессиональное качество печатного документа.
По сравнению с другими системами грамотного программирования система NoWeb отличается простотой. Исходный файл документа системы — это обычный файл в формате LaTeX и с расширением .nw. В этом файле находятся определения кусочков кода программы — так называемых чанков.
Чанк определяется следующим образом:
<<имя чанка>>=
текст чанка строка 1
текст чанка строка 2
<<имя чанка 2>>
текст чанка строка 2
Начинается чанк с новой строки и символов „<<”. Имя чанка может включать пробелы и любые другие символы, доступные в тексте LaTeX. текст чанка завершается строкой с символом „@”. Чанк может включать ссылки на другие чанки, в тексте это <<имя чанка 2>>.
Команда notangle позволяет выделить из документа чанки с определенным корнем и сохранить их в файл.
Пример документа noweb и полученного текста программы приведен в таблице 1.
|
|
|
|
|
документ NoWeb |
команда |
текст программы |
|
|
|
|
|
|
|
|
|
Программа должна находить
наибольший общий делитель двух целых чисел с помощью алгоритма Евклида. <<NOD.cpp>>= #include <stdio.h> <<функции>> int main(){ <<основная функция>> return 0; } @ Получим два числа, НОД которых необходимо найти. <<основная функция>>= int a, b; scanf( "%d %d", &a, &b ); @ Алгоритм вычисления НОД реализуем с помощью рекурсивной функции. <<функции>>= int NOD(int a, int b ){ <<NOD>> } @ вызовем её и выведем ответ: <<основная функция>>= printf( "NOD(%d,%d) = %d\n", a, b, NOD(a,b) ); @ Заполним определение функции NOD реализовав рекурсивный алгоритм [1]. 1. НОД(0, n) = n; <<NOD>>= if( a == 0 ) return b; @ 2. НОД(m, 0) = m; <<NOD>>= if( b == 0 ) return a; @ 3. НОД(m, m) = m; <<NOD>>= if( a == b ) return a; @ 4. n>m -> НОД(n, m) = НОД( n % m, m) <<NOD>>= if( a > b ) return NOD(a%b, b); @ 4. n<m -> НОД(n, m) = НОД( n , m % n) <<NOD>>= if( a < b ) return NOD(a, b%a); @ |
notangle \
-RNOD.cpp \ a.nw \ >NOD.cpp |
#include <stdio.h>
int NOD(int a, int b ){ if( a == 0 ) return b; if( b == 0 ) return a; if( a == b ) return a; if( a > b ) return NOD(a%b, b); if( a < b ) return NOD(a, b%a); } int main(){ int a, b; scanf( "%d %d", &a, &b ); printf( "NOD(%d,%d) = %d\n", a, b, NOD(a,b) ); return 0; } |
|
|
|
|
Преведенный пример показывает исключительную лаконичность языка NoWeb. Для извлечения текста программы достаточно знать имя корневого чанка (в данном случае это NOD.cpp. Особенностью системы является то, что чанк NOD определяется несколько раз, при этом результат „раскрутки” чанка включает все его определения, объединенные последовательно. Еще одной особенностью является сохранение ведущих пробелов строк, что позволяется использовать систему NoWeb для создания программ на языке python.
В файле /etc/ImageMagick-6/policy.xml закоментировать строки:
<!-- <policy domain="coder" rights="none" pattern="PS" /> -->
<!-- <policy domain="coder" rights="none" pattern="EPS" /> -->
<!-- <policy domain="coder" rights="none" pattern="PDF" /> -->
и добавить следующие:
<policy domain="coder" rights="read | write" pattern="PDF" />
<policy domain="coder" rights="read | write" pattern="EPS" />
<policy domain="coder" rights="read | write" pattern="PS" />
sudo apt-get install noweb
sudo apt-get install texlive-full texlive-lang-cyrillic cm-super lmodern latex2html gv source-highlight tidy
sudo apt-get install lyx elyxer ttf-lyx enchant aspell-ru aspell-en aspell
Меню → Инструменты → Переконфигурировать
Настройка проверки правописания Меню → Инструменты → Настройки...
Выбрать Настройки языка → Проверка правописания
spellchecker engine: Enchant
другие языки: ru
Выбрать Настройки языка → Язык
Язык пользовательского интерфейса: По умолчанию
Настройка формата вывода Меню → Инструменты → Настройки → Обработка файлов
В разделе „Форматы вывода по умолчанию”
Выбрать DVI или PDF (ps2pdf)
Это связано с тем, что стандартный формат PDF (XeTex) не позволяет использовать кириллицу в текстах программ
Настройка документа Меню → Документ → Настройки...
Класс документа Выбрать класс документа article (Noweb).
Поле „Custom” оставить пустым
или
Выбрать класс документа article а в Меню → Документ → Модули... выбрать noweb
Шрифты Для всех начертаний поставить по умолчанию.
Выбрать размер шрифта (11pt).
Кодировка шрифта LateX выбрать — Указано пользователем — T2A
выбрать „Русский”
указать „другой”, выбрать Юникод (utf8)
указать стиль кавычек отличный от „лапок”
Уменьшим размер текста программ В „Преамбула Latex” добавить
\@ifundefined{lstset}{}{
\noweboptions{longchunks,smallcode}
\lstset{
basicstyle=\footnotesize,
breaklines=true,
breakatwhitespace=true,
resetmargins=true,
xleftmargin=3em
}
}
\noweboptions{smallcode}
Свойства PDF Поставить галочку в поле „Использовать поддержку PDF”.
Во вкладке „Гиперссылки” поставить галочку в поле „разрывать ссылки через строки”.
Смягчим требования к качеству переносов В „Преамбула Latex” добавить
\sloppy
Настроим связь между LY X-текстом и графическим образом документа dvi Связь между текстовым редактором LY X и просмотрщиком xdvi значительно облегчает исправление ошибок и контроль за внешним видом документа.
Для отображения файлов dvi надо использовать программу xdvi. Для этого надо в Меню → Инструменты → Настройки...→ Обработка файлов → File formats выбрать формат dvi, ввести в поле просмотрщик : xdvi и нажать „сохранить”.
Кроме этого, надо изменить настройки документа, включив использование SyncTex при построении dvi файла. Для этого в форме Документ → Настройки → Вывод надо взвести флаг „Synchronize with Output” и выбрать в выпадающем списке „Custom macro” значение „\usepackage[active]{srcltx}”.
Затем надо включить прямую связь между документом LY X и просмотрщиком dvi поместив в строку
Меню → Инструменты → Настройки...→ Вывод→ Общий→ DVI command:
значение
xdvi -sourceposition "$$n: $$t" $$o
После этого, если в панели инструментов нажата кнопка „Enable Forward/Reverse Search” то, если запущен просмотрщик dvi, то можно перемещать позицию страницы в просмотрщике в позицию курсора выбрав Меню → Навигация → Forward Search и выполнять обратную операцию с помощью комбинации Ctrl + щелчок левой кнопкой мыши.
Программа, создаваемая с помощью LY X и NoWeb, должна компилироваться, и, возможно, запускаться по мере создания. Данные операции не могут эффективно выполняться вручную, и, поэтому, во-первых, в документ надо включать команды для сборки, тестирования и т.п., а во-вторых LY X надо настроить так, чтобы он использовал эти включенные в текст команды.
Стартовый скрипт компиляции Следующий текст
#!/bin/bash
# Скрипт сборки проектов noweb из lyx
# извлекает из noweb скрипт сборки build-script проекта
# и запускает его
export LANG=C
#################
# скрипт сборки сможет обращаться к данным переменным
#################
export PROJ_DIR="$1" # директория где находится файл *.lyx
export NOWEB_SOURCE="$2" # имя файла *.nw (создается автоматически lyx во временной директории)
export LYX_TMP="$3" # временная директория, используемая lyx
export NW="${LYX_TMP}/${NOWEB_SOURCE}" # имя файла *.nw
# отладочный выход
echo "build-script started"
echo -n " " PROJ_DIR="$PROJ_DIR"
echo -n " " NOWEB_SOURCE="$NOWEB_SOURCE"
echo
echo -n " " LYX_TMP="$LYX_TMP"
echo -n " " NW="<$NW>"
echo
export ERR_FILE="${NW}.make_err" # сообщения о ошибках запишем в данный файл
B="${NW}.build-script" # скрипт сборки проекта
notangle -Rbuild-script "${NW}" >"$B" 2>"${ERR_FILE}"
/bin/bash "$B" >"${ERR_FILE}" 2>&1
надо поместить в файл $HOME/bin/build-script сделав его исполняемым с помощью команды:
chmod +x $HOME/bin/build-script
Данный скрипт инициализирует переменные окружения :
PROJ_DIR — с именем головной директории проекта
NOWEB_SOURCE — с именем noweb-файла, полученного из документа LY X
LYX_TMP — имя временной директории, в которой размещен документ LY X и, возможно, другие временные файлы
NW — абсолютное имя NoWeb файла.
ERR_FILE — имя файла с сообщениями о ошибках компиляции;
извлекает из документа скрипт сборки/тестирования и запускает его. При этом сообщения времени компиляции сохраняются в файле с расширением .make_err .
Для того, чтобы LY X стал использовать данный скрипт надо добавить в список конверторов (Меню → Инструменты → Настройки → Обработка файлов → Конверторы) конветор из NoWeb в Программа указав в поле ввода Преобразователь
build-script $$r $$i $$p
Теперь мы можем создавая программу указывать команды, выполнить которые нужно для сборки приложения, его запуска, проверки и т.п.
Приведем пример.
Пример использования сборки программы. Можно организовать извлечение текста файла a.cpp из документа и его компиляцию с помощью компилятора gcc
написав в документе
Если программа успешно откомпилирована, можно её автоматически запустить.
Компилятор выводит на экран сообщения о ошибках, используя для этого канал ошибок (stderr).
Скрипт build-script записывает сообщения о ошибках в файл с расширением make_err. При этом указываются номера строк, в которых обнаружены ошибки, но это строки не документа lyx а файла с текстом программы (например a.cpp). Формат вывода сообщения о ошибках определяется компилятором (в данном случае gcc).
Для того, чтобы LY X мог помочь в локализации ошибок выход программы должен быть представлен в формате TeX:
! <Краткое сообщение о ошибке>
l.200 <начало строки с ошибкой>
<конец строки с ошибкой>
<многострочное описание ошибки>
<пустая строка>
где 200 — номер строки в документе NoWeb.
Следовательно, задача заключается в том, чтобы
связать номера строк программы на языке программирования с номерами строк документа NoWeb,
преобразовать сообщения о ошибках к формату TeX и
передать их в программу LY X.
Cвязать номера строк программы на языке программирования с номерами строк документа NoWeb можно во время извлечения текста программы из документа NoWeb, если извлечение делать не с помощью программы notangle а с помощью скрипта-оболочки LNW_notangle.sh (он размещен в директории scripts).
Скрипт LNW_notangle.sh в свою очередь дважды использует notangle для построения текста программы, один раз дополняя исходный текст специальными метками (-L’#line %L "%F"%N’). В результате работы он формирует текст программы (например файл a.cpp ) и файл связывающий номера строк NoWeb файла с номерами строк файла программы. Данный файл имеет расширение .nwindex .
Скрипты LNW_notangle.sh LNW_make_nwindex.py LNW_del_mix_nl.py, тексты которых можно найти в директории scripts, необходимо поместить в каталог $HOME/bin/ и сделать исполнимыми
chmod +x $HOME/bin/LNW_notangle.sh $HOME/bin/LNW_make_nwindex.py $HOME/bin/LNW_del_mix_nl.py
Преобразовать сообщения о ошибках, к формату TeX и произвести подмену номеров строк можно с помощью скрипта LNW-listerrors. (Он тоже находится в директории scripts). Указать LY X, что нужно использовать данный скрипт можно указав в поле ввода Дополнительно конвертора из NoWeb в Программа (Меню → Инструменты → Настройки → Обработка файлов → Конверторы)
parselog=LNW-listerrors
Скрипт LNW-listerrors использует программу LNW_parse_errors.py для преобразования текста с сообщением об ошибках. (текст программы находится в директории scripts. Его надо скопировать в $HOME/bin и сделать исполняемым).
Теперь, использовать для извлечения текстов программ LNW_notangle.sh, то-есть в вышеприведенном примере с компиляцией a.cpp заменить
notangle -Ra.cpp "${LYX_TMP}/${NOWEB_SOURCE}" >a.cpp на LNW_notangle.sh a.cpp то LY X автоматически укажет на обнаруженные в ходе компиляции синтаксические ошибки.
Иногда noweb не может извлечь документацию к программе из текста (сгенерировать файл TeX).
Обычно это связано с тем, что пропущены ограничители начала/конца блоков с текстом программы, опущены символы = и т.п.
Для того, чтобы локализовать ошибки, достаточно преобразовать сообщения о ошибках к формату TeX.
Для этого были написаны два скрипта. Один вызывает программу noweave сохраняя сообщения о ошибках, а второй — преобразовывает сохраненные сообщения к формату TeX.
Для того, чтобы данные скрипты начали использоваться надо
сохранить скрипты LNW_noweave.sh и LNW_noweave_parse_errors.sh в директории $HOME/bin (их можно взять в директории scripts) и сделать их исполнимыми
chmod +x $HOME/bin/LNW_noweave.sh $HOME/bin/LNW_noweave_parse_errors.sh
настроить конверторы из NoWeb в LaTeX (pdflatex)и в LaTeX (plain) указав в поле конвертер LNW_noweave.sh $$i $$o
а в поле Преобразователь —-
parselog=LNW_noweave_parse_errors.sh
Добавляем новый проект в репозиторий svn (созданный ранее командой svnadmin create /path/to/project)
svn import . \
svn+ssh://SD@icecube.satellite.dvo.ru/home/SD/Runx/svn/repos/new_project \
-m "First Import"
Получение начальной версии на свой компьютер (создание локальной версии) в текущую директорию
svn checkout \
svn+ssh://SD@icecube.satellite.dvo.ru/home/SD/Runx/svn/repos/new_project
Обновить до текущей рабочей версии
svn update
Работа с программой LY X для набора обычных текстов (включающих оглавление, изображения и таблицы) не является сложной. Использование её позволяет достичь высокого качества набора, хотя для достижения эксклюзивных результатов придется обратится к специалистам по системе TeX и литературе. При наборе текста в LY X (как и в некоторых других программах) лучше не концентрироваться на внешнем виде документа, а, вместо этого, сконцентрироваться на его структуре. Как правило выбор правильной структуры гарантирует хороший внешний вид, который можно улучшить позднее, после того как содержание документа будет полностью готово.
Прекрасным введением в работу является переведенный Максимом Дзюманенко на русский язык самоучитель, включенный в поставку программы.
Программа вывода простых чисел организована следующим образомgitk
Проверку того, является ли число простым, можно вынести в отдельную функцию:
Тогда проверка будет выглядеть следующим образом:
Определим функцию проверки, используя перебор, при этом должны нассматриваться делители от 2 до 
:
Соберем программу в файл
Компиляция и запуск программы:
В игре „длинные нарды” играющие должны сначала вывести свои 15 фишек на последние 6 позиций игрового поля, в „дом”, а затем „выбросить” их с доски. Тот, кто выбросит фишки первым — выигрывает.
Ход, который может сделать игрок определяется случайным образом, с помощью двух костей. Если игроку выпали, например, 3 и 4, то игрок может сходить на 3 и 4, а может на 4 и 3. Если выпадает два одинаковых значения — „дубль”, пример 3 3, то игрок ходит не два а четыре раза — 3, 3, 3, 3.ru
Пронумеруем позиции игрового поля числами с 5 до 0. Пусть на каждой позиции ai фишек (в начале игры ∑ ai = 15). Тогда одиночный ход на L позиций (L ∈ [1,6]) это перенос фишки в с позиции i на позицию j = i - L + 1. Если эта позиция находится за пределами доски (j < 0) то фишка выбрасывается если выполняется одно из двух условий: j = -1 или ∑ j=(i+1)…5ai = 0.
Вопрос, какое среднее число бросков потребуется игроку, чтобы „выбросить” все свои фишки с доски?
Какое положение фишек является оптимальным для начала выброса?
Пусть есть позиция, заданная в виде массива из шести элементов, для которой мы должны определить среднее количество оставшихся бросков.
Если позиция пустая, то ответ очевиден — ноль.
Если позиция не пустая мы должны просмотреть комбинации костей, которые могут выпасть, для каждой из них найти лучшие ходы фишек.
![{pos = 0 : 0 S(pos) = 1∑ ( ) pos ⁄= 0 : 36 k1∈[1,6],k2∈[1,6] 1 + minstep∈MS (pos,k1,k2)S (N ext(pos,step))](lyx-notes1x.png)
здесь MS — множество возможных ходов из позиции pos если выпали кости k1,k2, а Next — позиция в которую переходит игра после шага step из позиции pos.
Данную задачу можно решить численно с помощью рекурсивного вычисления значения функции S(pos). В ходе решения придется многократно находить значения функции для одних и тех-же позиция, поэтому необходимо сохранять уже найденные решения в словаре.
Программу напишем на языке python.
Позицию будем описывать как массив из шести элементов, по числу позиций „дома”. В элементе массива будет содержаться число фишек, находящихся в данной позиции или ноль, если позиция пуста.
Тогда функция S будет выглядеть следующим образом:
Индексы для кеша позиций должны быть уникальными целыми числами, при этом на одной позиции не может находиться более 15 фишек одновременно.
Поэтому:
А проверку того, является ли позиция конечной целью игры можно выполнить так:
Перейдем к определению функции SM, которая должна возвратить список позиций в которые могут перейти фишки если на костях выпало k1, k2.
Рассмотрим сначала более простую задачу, при которой надо рассмотреть бросок не пары, а одной кости. При этом если бросок производится из конечной позиции игры, мы конечную позицию и возвращаем, считая что игра закончилась при игре предыдущей костью.
Тогда полный список позиций можно получить следующим образом
Вычисление значения результат лучшего хода из позиции pos, для броска k1, k2 лучше вынести в отдельную функцию. Тогда
Получим ответ на вопрос, какое среднее количество бросков надо сделать игроку из указанной позиции для завершения игры.
Для ответа на второй вопрос (о оптимальной позиции начала выброса) сначала надо получить набор всех начальных позиций.
После этого мы может получить ответ на второй вопрос, учитывая про этом среднее количество бросков, которое дополнительно потребовалось игроку, чтобы занять начальную позицию.
Соберем программу.
и добавим в скрипт сборки строки для её извлечения из документа и проверки.
Программа написана.
Обнаруженная оптимальная позиция для начала выброса — [0, 0, 0, 3, 5, 7 ].
Созданная система грамотного программирования использоуется с лаборатории спутникового мониторинга ИАПУ ДВО РАН.
Опыт ее использования показал, что она действительно помогает создавать хорошие, полезные и долгоживущие программы.
[1] Спольски Джоэл. Джоэл о программировании. Символ-Плюс, 2006.
[2] Брукс Ф.П. Мифический человеко-месяц, или Как создаются программные системы: [пер. с англ.]. Символ-Плюс, 2009. URL: http://books.google.ru/books?id=OZwJRQAACAAJ.
[3] Knuth D.E. The WEB system of structured documentation. Department of Computer Science, Stanford University, 1983.
[4] Levy S., Knuth D.E. The CWEB system of structured documentation // Report STAN. CS. 1994. Т. 90. с. 200.
[5] Knuth D.E. TEX: the program. Computers & typesetting № т. 2. Addison-Wesley Pub. Co., 1986. URL: http://books.google.ru/books?id=EOVGAQAAIAAJ.
[6] Knuth D.E., Bibby D. Metafont: The Program. Computers & Typesetting. Pearson Education, Limited, 1998. URL: http://books.google.ru/books?id=aerEOwAACAAJ.
[7] Childs Bart. Literate Programming, A Practitioner’s View // TIGboat. 1992. Т. 13, № 4. с. 457–457.
[8] Childs B., Sametinger J. Analysis of literate programs from the viewpoint of reuse // Software - Concepts and Tools. 1997. Т. 18, № 1. с. 35.
[9] Childs B., Dunn D., Lively W. Teaching CS/1 courses in a literate manner // TUGboat. 1995. Т. 16, № 3. с. 300–309.
[10] Ramsey Norman, Marceau Carla. Literate Programming on a Team Project // Software—Practice & Experience. 1991. Т. 21, № 7. с. 677–683.
[11] Krommes John A. FWEB - A WEB system of structured documentation for multiple languages. URL: http://w3.pppl.gov/ krommes/fweb_toc.html.
[12] Williams Ross. FunnelWeb User’s Manual: ftp.adelaide.edu.au in /pub/compression and /pub/funnelweb: Adelaide, South Australia, Australia: University of Adelaide, 1992.
[13] Briggs Preston. Nuweb, A Simple Literate Programming Tool: cs.rice.edu:/public/ preston: Houston, TX, USA: Rice University, 1993.
[14] Liddicott Sam. Fangle - Introduction. URL: http://www.nongnu.org/fangle.
[15] Ramsey N. Literate programming simplified // IEEE Software. 1994. Т. 11, № 5. с. 97–105.
[16] Wolf H.P. RWINED the all-in-one editor for data analysis and easy to use creation of LaTeX based documents with R. URL: http://www.wiwi.uni-bielefeld.de/ wolf/software/rwined/rwined.html.
[17] Leisch Friedrich. Sweave User Manual. 2005. URL: http://www.ci.tuwien.ac.at/ leisch/Sweave.
[18] Literate programming // http://www.haskell.org/haskellwiki/Literate_programming.
[19] Kortright E., Cordes D. Cnest and Cscope: Tools for the literate programming environment // Proceedings / IEEE Southeastcon ’92, April 12–15, 1992, Birmingham, Alabama. 1109 Spring Street, Suite 300, Silver Spring, MD 20910, USA: IEEE Computer Society Press, 1992. с. 604–609 (vol. 2). 2 vol.
[20] Ream E. K. Leo and Literate Programming. Web document and software. 2002. URL: http://personalpages.tds.net/ edream/design.html.
[21] Ream E. K. Leo Literate Editor with Outlines. Web document and software. 2002. URL: http://personalpages.tds.net/ edream/intro.html.
[22] Kahl Wolfram. The Term Graph Programming System HOPS // Tool Support for System Specification, Development and Verification, Advances in Computing Science. Springer. ISBN, 1999. с. 136–149.
[23] Wittenberg Lee. Announcements for WinWord WEB. 1993. URL: http://www.literateprogramming.com/best/awinwordweb.html.
[24] Lasgouttes Jean-Marc, Nielsen Asger Alstrup, Wienskoski Edmar Jr. [и др.]. Messages in thread ’Lyx as a WYSIWIG editor for Literate Programming’. URL: http://marc.info/?t=102747851200039&r=1&w=2.
[25] Childs Bart. Thirty years of literate programming and more? // TUGboat. 2010. Т. 31, № 2. с. 183–188.
[26] Hildebrand J.D. Literate programming: It’s not going to happen. 2012. [Online; accessed 12-January-2013]. URL: http://www.sdtimes.com/blog/post/2012/02/15/Literate-programming-Its-not-going-to-happen.aspx.
[27] A Multi-Language Computing Environment for Literate Programming and Reproducible Research / Eric Schulte, Dan Davison, Thomas Dye [и др.] // Journal of Statistical Software. 2012. Т. 46, № 3. с. ??–?? URL: http://www.jstatsoft.org/v46/i03.
[28] Ruckert Martin. Understanding MP3: syntax, semantics, mathematics, and algorithms. vieweg-it. Braunschweig, Germany: Vieweg & Son, 2005. С. xiii + 247. URL: http://www.gbv.de/dms/bowker/toc/9783528059057.
[29] Potse Mark, Linnenbank AndrГ� C, Grimbergen Cornelis A. Software design for analysis of multichannel intracardial and body surface electrocardiograms // Computer Methods and Programs in Biomedicine. 2002. Т. 69, № 3. с. 225–236. URL: http://www.sciencedirect.com/science/article/pii/S0169260702000147.
[30] Pharr M., Humphreys G. Physically Based Rendering: From Theory to Implementation. Morgan Kaufmann. Elsevier Science, 2010. URL: http://books.google.ru/books?id=9nJBAJhTxt8C.
[31] Hinchliffe A. Chemical Modelling: Applications and Theory. Specialist Periodical Reports № т. 4. Rsc Publishing, 2006. URL: http://books.google.ru/books?id=Hhxm8nSWI98C.
[32] Зубинский Андрей. Грамотное программирование // Компьютерное обозрение. 2002. URL: http://ko.com.ua/gramotnoe_programmirovanie_9950.
[33] Jones S.L.P. Haskell 98 Language and Libraries: The Revised Report. Journal of functional programming. Cambridge University Press, 2003. URL: http://www.google.ru/books?id=mMGQgcnCxjAC.
[34] Cockburn Andy, Churcher Neville. Towards literate tools for novice programmers // Proceedings of the 2nd Australasian conference on Computer science education. ACSE ’97. New York, NY, USA: ACM, 1996. с. 107–116. URL: http://doi.acm.org/10.1145/299359.299376; http://ir.canterbury.ac.nz/bitstream/10092/3166/1/45282_Churcher.pdf.
[35] Kastrup D. Revisiting WYSIWYG paradigms for authoring LATEX // Proceedings of the 2002 Annual Meeting, TUGboat. Т. 23. 2002.
[36] Knuth D.E., Bibby D. The TeXbook. Addison-Wesley, 1986. Т. 1993.
[37] Ramachandran H. Literate Programming with Lyx. 2009. URL: http://www.ee.iitm.ac.in/ hsr/ec205/lyx2.pdf.