Bernd
Pol
Сергей
Бобыкин

    _myst@mail.ru

Перевод на русский язык

# Начало работы с &kdevelop;.

Теперь, когда вы только установили среду разработки &kdevelop;, как вы собираетесь её применять? Это сложное приложение, освоить его непросто, особенно, если вы ещё не использовали такой тип интегрированных сред разработки.

Мы попробуем помочь вам в этом на примере создания простого приложения на C++ для KDE. Для этого мы рассмотрим следующие темы:

- Знакомство с элементами пользовательского интерфейса.
- Начальная настройка.
- Создание нового проекта.
- Работа с документами.
- Компиляция проекта.
- Добавление в проект классов.
- Отладка проекта.
- Основные инструменты сборки программ и пользовательской документации.
- Последнее, но не менее важное, комбинации клавиш

Перед тем, как начать, нужно прояснить один важный момент.

## Предназначение программы.

Как уже говорилось, &kdevelop; — это интегрированная среда разработки. Это означает, что &kdevelop; сама по себе является не средством разработки, но графической оболочкой для упрощения доступа к различным инструментам, многие из которых требуют сложных команд, запускаемых из текстовой консоли.

Хотя &kdevelop; упрощает многие задачи программирования, значительная часть сложности этих инструментов ещё лежит на плечах разработчика. Для полного понимания &kdevelop;, вам необходимо понимать, как они работают.

Поэтому мы не можем научить вас разрабатывать программное обеспечение, но познакомим с тем, каким образом &kdevelop; упрощает процесс создания программ. Если вы хотите узнать больше о назначении интегрированных сред разработки, возможно вас заинтересует глава «Разработка ПО в &UNIX;», особенно раздел «Концепции и средства интегрирования».

Излагая материал, мы предполагаем, что &kdevelop; у вас запускается в режиме Упрощённый IDEAl. В других режимах интерфейса, некоторые элементы могут располагаться в других местах и вести себя немного иначе. Если вы не знаете в каком режиме интерфейса работает среда, выберите Настройка Настроить KDevelop... Интерфейс пользователя и посмотрите.

## Первое знакомство с &kdevelop;

Эта глава посвящена тому, что вы увидите, когда впервые запустите &kdevelop;. В ней вы узнаете:

- описание интерфейса программы;
- как получить справку;
- структуру меню;
- предназначение боковых панелей.

### Описание интерфейса программы

При первом запуске &kdevelop;, вы увидите окно, похожее на это:

Начальное расположение элементов в окне &kdevelop;.

В реальности окно будет больше, но элементы в нём будут точно такими же.

#### Рабочая область и боковые панели

В начале среда работает, в так называемом режиме интерфейса IDEAl. Рабочее пространство слева, снизу и справа окружено рядами кнопок, которые действуют наподобие вкладок. Если вы нажмёте на одну из них, откроется боковая панель для выполнения определённой задачи.

#### Меню и панели инструментов

Вверху окна находится обычная панель меню, под которой следуют несколько панелей инструментов. Некоторые из них изначально пустые. Они будут заполнены после открытия проекта.

#### Строка состояния

Внизу находится строка состояния. Она показывает краткую информацию.

### Как получить справку

Помимо меню Справка, отвечающее на конкретные вопросы, можно использовать строку состояния и два вида всплывающих подсказок, предоставляющих краткую справку.

#### Как узнать назначение пункта меню.

При наведении курсора на пункт меню, в строке состояния выводится краткое пояснение к нему. В большинстве случаев это просто название, но для некоторых пунктов — описание команды.

#### Как узнать название элемента интерфейса

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

#### Как узнать назначение элемента интерфейса

Для многих элементов среды доступна дополнительная информация через расширенную подсказку. Выберите команду меню Справка Что это? или нажмите комбинацию клавиш &Shift;F1. Рядом с указателем мыши появится знак вопроса. Выберите интересующий элемент и полу́чите дополнительную информацию о нём, если она имеется. Этим способом также можно выбирать любые меню и их пункты (и активные, и неактивные).

### Структура меню

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

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

Файл

  #### Обычные действия

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

  #### Вернуть все

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

Правка

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

  #### Обычные действия

  Отмена и повтор, работа с буфером обмена, варианты выделения текстовых фрагментов.

  #### Поиск и замена

  Существует два очень мощных средства поиска: Правка Найти в файлах... и Правка Поиск-выбор-замена.... Они позволяют выполнять поиск и замену не только в пределах текущего документа, но и глобально.

  #### Комплексные операции

  Переформатирование документа, несколько видов дополнения набираемого текста.

Вид

  Среди прочих данное меню содержит следующие операции:

  #### История просмотра

  Перемещение по открытым документам.

  #### Отслеживание ошибок

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

  #### Управление редактором

  В случае использования компонента &kate; (встроенный текстовый редактор) будут доступны:

  - управление переносом строк в окне документа;

  - показ или скрытие полосы закладок, номеров строк, закладок на полосе прокрутки;

  - управление показом сворачиваемых блоков исходного кода.

Проект

  Вся работа в &kdevelop; основана на проектах, которые собирают воедино файлы исходного кода, файлы управления сборкой и другую информацию. Данное меню содержит команды управления проектом. В частности:

  #### Открытие

  Создание, открытие и импорт из других сред.

  #### Параметры

  Установка параметров.

  #### Управление классами

  Добавление новых классов и управление иерархией наследования.

  #### Подготовка к распространению

  Сборка дистрибутивных пакетов для распространения в Интернете.

Сборка

  Команды компиляции и документирования проекта:

  #### Компиляция, сборка, выполнение

  Компилирование и сборка всего проекта или его части, запуск разрабатываемой программы.

  #### Подготовка к сборке

  Набор операций этой группы зависит от используемой в проекте сборочной системы. Например, в случае automake это могут быть команды для выполнения `Makefile.cvs` и скрипта `configure`.

  #### Установка приложения

  Установка приложения в локальные и системные (доступные только для root) каталоги.

  #### Документация по API

  Сборка или удаление документации по API на базе Doxygen.

Отладка

  Для использования этого меню приложение нужно скомпилировать с отладочной информацией (это можно сделать через команду меню Проект Параметры проекта...). Меню содержит следующие операции:

  #### Обычные операции по отладке

  Первая часть меню представляет собой вариант графического интерфейса к GDB &GNU;. Она включает в себя запуск и останов приложения в отладчике, несколько вариантов пошагового выполнения.

  #### Точки останова

  Устанавливать точки останова в исходном коде приложения можно несколькими способами. Один из них — команда Установить/снять точку останова.

  #### Комплексные операции по отладке

  Остальные пункты меню представляют более сложные средства исследования программы. Чтобы узнать подробности, воспользуйтесь комбинацией клавиш &Shift;F1.

Скрипты

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

Окно

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

  В зависимости от модуля расширения редактора, который вы используете, также могут присутствовать и другие команды. Так, используемый по умолчанию модуль редактора Kate позволяет разделять окно редактора по горизонтали или вертикали.

Сервис

  Среда обладает широкими возможностями по настройке. Можно выбрать любимый текстовый редактор и инструменты (внешние или в виде модулей), расширяющие функциональность среды. Бо́льшая часть этих возможностей собрана в данном меню.

  #### Комплексное редактирование

  Верхняя часть меню содержит команды текущего модуля редактора. Его можно выбрать с помощью команды меню Настройка Настроить KDevelop... Редактор.

  #### Работа с веб-страницами

  Если текущее окно содержит страницу HTML (например, файл документации), меню будет содержать команды навигации по веб-страницам.

  #### Другие команды

  Обычно меню содержит много других команд. Это зависит от имеющихся инструментов. Используйте комбинацию клавиш &Shift; F1 для получения дополнительной информации об их назначении.

Настройка

  Данное меню позволяет показывать или скрывать меню, панели инструментов и строку состояния. А также настраивать комбинации клавиш, панели инструментов, уведомления, редактор и общее поведение среды.

Справка

  В этом меню можно открыть руководство пользователя KDevelop, искать термины в различных файлах документации, открывать страницы man (традиционный формат документации для UNIX) и страницы info (формат документации проекта GNU). Более того, здесь можно отправить отчёт об ошибках и получить информацию о версии программы и её авторах.

### Назначение боковых панелей

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

- #### Левый ряд

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

- #### Нижний ряд

  Окна сообщений различных инструментов.

- #### Правый ряд

  Доступ к документации и инструментам сборки.

Число вкладок боковых панелей изменится после открытия проекта. Тогда будет доступно больше инструментов. Фактическое число боковых панелей зависит от доступных программе инструментов. Подробно об этом рассказано в главе «Настройка &kdevelop;».

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

Перемещение и выделение

  #### Файлы

  Панель для перемещения по дереву каталогов и выбора файлов для работы, как в &konqueror;. Нажатие левой кнопки мыши на файле открывает его в окне редактора. Нажатие правой кнопкой мыши в области выбора файлов открывает контекстное меню с командами перемещения и управления файлом.

  #### Окна

  Список окон с файлами, открытых в данный момент. Нажатие левой кнопкой мыши на окне в списке активирует окно в рабочей области. Используйте эту функцию для быстрой навигации по большому количеству открытых файлов. Более того, это окно — средство организации открытых файлов в сеанс. Это полезно в очень больших и сложных проектах, помогая разработчику концентрироваться на разных задачах. Нажатие правой кнопкой на окне открывает контекстное меню для управления файлом в окне.

Окна сообщений

  #### Приложение

  Показывает вывод приложения, запущенного в среде.

  #### Diff

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

  #### Сообщения

  Показывает сообщения, сгенерированные вызванными из среды инструментами сборки (см. меню Сборка).

  #### Поиск в файлах

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

  #### Заменить

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

  Глобальный поиск с заменой доступен только после загрузки проекта. В противном случае команда меню Правка Поиск-выбор-замена... будет неактивна.

  #### Konsole

  Окно эмулятора терминала Konsole, где можно вводить команды традиционного для &UNIX; интерфейса командной строки.

Документация и управление сборкой

  #### Документация

  Предоставляет удалённый доступ ко всей документации в структурированном виде. А также несколько видов прямого доступа к руководствам по &kde; или &Qt;.

  См. главы «Документация» и «Настройка документации».

  #### Заготовки

  Коллекция текстовых заготовок для повторного использования во время редактирования. Заготовки могут иметь параметры.

  См. главы «Заготовки кода» и «Настройка заготовок кода».

## Немного настройки

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

Более подробно настройка среды освещена в главе «Настройка &kdevelop;».

### Главное

Для настройки выберите команду меню Настройка Настроить KDevelop.... Она откроет диалог Настройка KDevelop с разделом Главное.

Диалог настройки &kdevelop;

Большинство параметров по умолчанию должны вас устроить, но, возможно, вы захотите некоторые из них изменить.

#### Каталог проектов по умолчанию

При первом запуске среда, скорее всего, настроена на ваш домашний каталог. Однако большинство пользователей предпочитает иметь специальный каталог для хранения своих проектов. Введите в это поле название корневого каталога, в котором хотите хранить свои проекты. Также его можно выбрать в дереве каталогов, если нажать справа кнопку «Выбор файла или папки» со значком папки.

В наших примерах мы будем использовать выдуманное имя пользователя `devel`. Заменяйте его своим. Наш пользователь будет использовать каталог `/home/devel/projects` как каталог проектов. Название `projects` тоже заменяйте названием своего каталога для проектов.

По умолчанию для каждого нового проекта среда создаёт отдельный подкаталог в каталоге проектов. Например, в нашем случае все файлы проекта «Hello» будут располагаться в каталоге `/home/devel/projects/hello`.

Конечно, при необходимости вы можете временно переопределить каталоги. См. главу «&appwizard;».

#### Вывод компилятора

Когда среда компилирует исходный текст, сообщения make и других инструментов сборки будут выводиться в окно Сообщения в нижней части рабочей области. Обычно эти сообщения очень многословны. Для большего удобства просмотра имеются встроенные средства их сокращения.

В зависимости от используемой вами версии среды параметр Вывод компилятора может иметь предустановленное значение «Полный», в этом режиме сообщения выводятся полностью. Если он для вас не удобен, выберите режим «Очень краткий» из выпадающего списка.

Имейте в виду, в этом режиме в окне Сообщения будет показываться только самая основная информация. В случае возникновения ошибок (во время сборки, например), скорее всего, вы захотите видеть, если не полные, то значительно более подробные сообщения. Полное содержание сообщений не теряется. Его можно увидеть с помощью команды «Полный вывод компилятора» контекстного меню окна Сообщения.

### Создание индекса для поиска в документации

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

Откройте боковую панель Документация в правой части главного окна и откройте на ней вкладку Поиск.

Вкладка создания поискового индекса.

Теперь нажмите кнопку Обновить конфигурацию, чтобы убедиться, что основные инструменты поиска установлены правильно. Должен появиться диалог с сообщением «Конфигурационный файл обновлён». Нажмите кнопку OK и он исчезнет.

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

Среда создаёт индекс для поиска в документации.

Этот процесс может занять определённое время в зависимости от объёма документации и мощности вашей машины. В конце концов кнопка Отмена будет заменена кнопкой OK. Нажмите её для продолжения.

- Обычно это работает идеально. Но в некоторых случаях программа htdig, которая используется средой для выполнения полнотекстового поиска, может быть неправильно настроена. См. главу «Индексирование документации».

- Чтобы была возможность осуществлять поиск по API &kde; и &Qt;, KDELibs Apidocs должны быть установлены до установки &kdevelop;. Если у вас проблемы с генерацией индекса или выполнением примеров поиска идентификаторов ниже в этой главе, убедитесь, что эта документация существует и доступна среде. См. Установка &kdevelop;.

## Создание проекта

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

К счастью, это очень легко. Для этого в среде имеется так называемый Мастер проектов (см. главу "Начало работы — создание проекта").

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

- Создание нового проекта с помощью мастера.
- Файлы, создаваемые в проекте.
- Дополнительные боковые панели, показываемые при открытом проекте.

### Создание нового проекта

Давайте, создадим простой проект приложения &kde; «Hello World». Для этого выполните следующие действия:

1. Запустите мастер командой меню Проект Создать проект....

2. Появится диалог Новый проект. Вверху на вкладке Все проекты находится список языков программирования.

   1. Мы хотим создать C++ приложение для &kde;, поэтому нажмите на + слева от C++, чтобы открыть эту ветвь.

   2. Ветвь содержит список возможных типов приложений на этом языке. Мы будем собирать приложение для &kde;, поэтому откройте подраздел, нажав + рядом с KDE

   3. Теперь вам предлагаются несколько шаблонов проекта. Перейдите в конец ветви и выберите Простое приложение KDE с формой.

      Справа будет показан предварительный вид приложения и его краткое описание.

      Выбор шаблона для проекта «Hello World»

   4. Нашему приложению нужно название. Найдите блок Свойства внизу диалога и введите подходящее название в поле Имя приложения.

      В нашем примере это «Hello», но вы можете использовать любое, какое вам нравится. Главное, чтобы в названии содержались только буквы, цифры и символы подчёркивания. Мастер никакие другие символы в названии не принимает.

   5. Убедитесь, что текстовое поле Расположение внизу содержит название каталога ваших проектов, установленного в главе «Немного настройки». Если это не так, введите его или выберите из списка каталогов, открываемого кнопкой с изображением папки справа от поля ввода.

      Если всё сделано правильно, надпись Конечное расположение внизу будет показывать путь к каталогу проекта. Если же к нему добавлено слово «(неверно)», попробуйте другое название проекта и/или проверьте наличие каталога проектов в файловой системе и пра́ва записи в него.

   6. Если нет никаких ошибок, кнопка Далее внизу диалога становится активной. Нажмите её для продолжения.

3. Вы перейдёте на шаг Параметры проекта. Проверьте правильность полей Автор и Электронная почта. Обычно по умолчанию они содержат параметры пользователя &kde; (см. диалог Профиль пользователя Центра управления KDE). Измените их, если они вас не устраивают.

   Введите ваше имя и (не обязательно) адрес электронной почты.

   Вы должны по крайней мере ввести значение поля Автор. Это обязательно. Оно необходимо для подготовки файлов приложения.

   Если нет никаких ошибок, кнопка Далее станет активной. Нажмите её для продолжения.

4. Шаги Система управления версиями, Шаблон для файлов .h и Шаблон для файлов .cpp пока не представляют интереса. Пропустите их, нажимая кнопку Далее и кнопку Готово на последнем шаге.

Вот и всё! Мастер создаст набор начальных файлов в каталоге Конечное расположение (см. пункт 2с).

Когда создание файлов завершится, среда откроет окно редактора для файла реализации главного окна приложения (в нашем примере это файл `hello.cpp`), чтобы вы могли сразу же приняться за работу.

### Начальные файлы

Хотя наш проект довольно простой, мастер создал целую группу файлов исходного кода и управления проектом. Вы можете их легко увидеть, если откроете боковую панель Файлы слева внизу. Его содержание показано на иллюстрации ниже.

Начальные файлы нашего проекта

Для демонстрации файлов, созданных мастером, мы открыли бо́льшую часть ветвей в боковой панели Файлы слева. Ветвь открывается простым нажатием левой кнопкой мыши на её названии в дереве.

С этой же целью справа мы открыли ветви в боковой панели Проект Automake, где перечислены некоторые файлы исходного кода проекта.

#### Указание авторских прав

Все приложения, удовлетворяющие требованиям проекта &GNU;, должны быть обеспечены авторскими правами. Уведомление о них требуется в файлах исходного кода и во время выполнения приложения. Мастер уже поместил соответствующую информацию об авторских правах и лицензировании в файлы проекта.

##### Сведения об авторских правах в файлах исходного кода.

Помните шаг «Параметры проекта» во время создания нового проекта? Там нужно было предоставить ваше имя и адрес электронной почты, как разработчика. Теперь посмотрите на верхнюю часть окна редактирования файла hello.cpp. Мастер поместил их в заголовок лицензирования каждого созданного файла исходного кода.

    /***************************************************************************
     *   Copyright (C) 2006 by Joe User   *
     *   joe@user.com   *
     *                                                                         *
     *   This program is free software; you can redistribute it and/or modify  *

Этот заголовок добавляется во все файлы исходного кода, которые создаются в среде. Среда хранит эти параметры в файлах шаблонов (в каталоге `templates`).

##### Информация об авторских правах во время выполнения приложения

Во время работы приложения &kde; пользователь может посмотреть информацию о программе (обычно через меню Справка). Необходимый для этого код автоматически генерируется средой. Он находится в файле `main.cpp`. См. пример ниже:

    int main(int argc, char **argv)
    {
        KAboutData about("hello", I18N_NOOP("Hello"), version, description,
                         KAboutData::License_GPL, "(C) 2006 Joe User", 0, 0,
                         "joe@user.com");
        about.addAuthor( "Joe User", 0, "joe@user.com" );

Он добавляет имя главного разработчика (в нашем случае «Joe User») и адрес электронной почты на вкладку с информацией об авторских правах и вкладку Авторы диалога О программе.

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

#### Начальные файлы исходного кода

Мастер поместил исходные файлы в подкаталог `src` каталога проекта. Как вы, возможно, и ожидали, там находятся `main.cpp`, `hello.h` и `hello.cpp`.

В типичном приложении &kde; есть несколько дополнительных файлов, а именно:

- `hello.desktop` — метаданные для интеграции приложения в &kde;.

- `hi16-app-hello.png` и `hi32-app-hello.png` — значки приложения (по умолчанию).

- `helloui.rc` — описание интерфейса пользователя (на данный момент меню).

#### Начальная документация приложения

В подкаталоге `doc/en` находится файл `index.docbook`. Это шаблон для создания пользовательской документации.

#### Проектные и вспомогательные файлы

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

Список всех проектных файлов можно увидеть в окне Проект Automake внизу справа на рабочей области. Как мы скоро увидим, &automanag; использует их содержание для управления сборкой.

Файлы, не выделенные полужирным шрифтом, имеют второстепенное значение и принадлежат нескольким различным классам:

- ##### Управление сборкой проекта

  Файлы этого класса управляют компиляцией, установкой, созданием документации и так далее. Если проект использует механизм &GNU; autotools, как в нашем примере, то в каждом его каталоге будет лежать файл `Makefile.am`. Это разновидность файлов для утилиты make, содержащие правила сборки. Они будут обрабатываться вместе с различными файлами программы `configure` во время сборки. В результате в каждом каталоге будет создан окончательный файл `Makefile`. Этот файл содержит правила для утилиты make, с помощью которых она будет создавать двоичные файлы приложения.

  За содержанием файлов `Makefile.am` нужно следить во время всего процесса разработки. К счастью, среда с помощью инструмента &automanag; почти полностью избавляет вас от этой проблемы. В своей основе &automanag; — графическая оболочка для работы с содержанием файла `Makefile.am`.

  Остальные файлы управления сборкой проекта — `configure.in.in` и `subdirs` — лежат в корневом каталоге проекта. Они будут обрабатываться определёнными файлами из специального каталога администрирования &kde; (`admin`) для создания файлов `configure` и `Makefile` и последующей сборки двоичных файлов приложения.

- ##### Файлы управления средой

  Среда сама нуждается в некоторых управляющих файлах. Они находятся в корневом каталоге проекта. в нашем примере это `hello.kdevelop`, `hello.kdevelop.pcs` и `hello.kdevses`.

  Особенно важен файл `xxx.kdevelop` (где «xxx» — название проекта). Это главный файл проекта KDevelop. Он необходим для загрузки проекта в среду.

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

- ##### Файлы описания проекта GNU

  Для любого приложения, удовлетворяющего требованиям проекта &GNU;, в корневом каталоге проекта обязательно должны присутствовать несколько файлов: `AUTHORS`, `ChangeLog`, `INSTALL`, `COPYING` (содержит текст лицензии GNU GPL); `INSTALL`, `NEWS`, `README` и `TODO`.

- ##### Другие файлы

  Несколько не упомянутых ранее файлов:

  - `Doxyfile`. Управляет созданием документации по &API; проекта.

  - Каталог `templates` содержит шаблоны файлов, которые среда использует как заготовки для создания новых исходных файлов. Вы можете в любое время их изменить. Новое содержание будет использовано при последующем создании исходных файлов соответствующих типов.

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

  - Каталог `po` предназначен для локализации приложения. Это существенная часть файлов проекта (содержит файл `Makefile.am`), но, в основном, они используются в процессе перевода, который не особенно интересует разработчика приложения.

  - Каталог `admin`. Он нужен приложениям &kde;. так как нём хранятся файлы, необходимые для обслуживания исходного кода и двоичных файлов приложения, а также для их правильной интеграции в среду &kde;.

### Дополнительные боковые панели

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

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

#### Инструменты перемещения и выделения (левая сторона)

- ##### Закладки

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

- ##### Классы

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

- ##### Группы

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

- ##### Переменные

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

#### Сообщения (нижняя сторона)

- ##### Valgrind

  Результаты программы Valgrind (средство анализа программы во время выполнения). Используется, например, для поиска утечек памяти.

- ##### Безопасность

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

- ##### Точки останова

  Панель для управления точками останова в файлах исходного кода. Используется в вместе с отладчиком.

- ##### CTags

  Панель для работы с базой данных идентификаторов. С её помощью можно искать идентификаторы в файлах исходного кода. Для создания базы используется программа CTags. Результаты поиска объединяются в список. Нажатие левой кнопкой мыши на элементе списка открывает в окне редактора файл с идентификатором.

- ##### Проблемы

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

#### Управление исходным кодом (правая сторона)

- ##### Проект Automake

  Инструмент &automanag; — это графическая оболочка для работы с содержанием файлов `Makefile.am`, расположенных в каждом каталоге проекта. Он имеет два поля управления. Верхнее показывает часть подкаталогов проекта, которые содержат проектные файлы. Каждый такой подкаталог должен иметь файл `Makefile.am`. В &automanag; он называется подпроект.

  Нажатие левой кнопкой мыши на подпроекте показывает его проектные файлы в нижнем поле. Файлы группируются в соответствии их ролью в файле `Makefile.am` данного подпроекта.

  &automanag; — очень мощный инструмент для управления проектом и его подпроектами, а также функциями проектных файлов в процессе сборки приложения. Ниже мы рассмотрим его основные особенности. Более подробное описание в главе «Сборка и управление проектом».

## Советы по работе с документами.

В нашем примере &appwizard; оставил файл `hello.cpp` открытым в окне редактора, чтобы вы могли немедленно приступить к работе. Мы предполагаем, что вы умеете пользоваться редактором, поэтому не будем вдаваться в подробности. Однако среда обладает несколькими полезными функциями для управления окнами редактора и документами. Их мы и рассмотрим.

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

### Быстрое переключение между заголовочным файлом и файлом реализации

Среда предлагает простой и быстрый способ переключения с файла реализации (`.cpp`) на соответствующий заголовочный файл (`.h`) и наоборот. Нажмите правой кнопкой мыши в окне редактора — появится меню, как на иллюстрации ниже.

Переключение между файлом реализации и заголовочным файлом.

Выберите пункт Переключить заголовочный файл и файл реализации. Среда найдёт соответствующий заголовочный файл или файл реализации и откроет его в другом окне редактора. В нашем примере, если вы нажали правой кнопкой мыши в файле `hello.cpp`, будет показан файл `hello.h`, и курсор переместится в его окно.

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

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

### Доступ к объявлениям и определениям

Но что если вы работаете над файлом исходного кода и хотите найти объявление или определение идентификатора? Это тоже нетрудно. По существу, всё, что вам нужно сделать — это нажать правой кнопкой мыши на интересующем вас идентификаторе.

Однако, нужно разделять две различных ситуации:

- доступ к идентификаторам, определённым вне проекта и
- работу с внутренними идентификаторами проекта.

#### Внешние объявления и определения

В самом типичном случае, вы будете искать идентификатор, определённый за пределами проекта. В проектах &kde; такие идентификаторы, скорее всего, документированы в библиотеках &kde; и &Qt;. Если &kde; и &kdevelop; установлены правильно, то должен быть доступ к документации по API и возможность поиска идентификаторов в ней.

Давайте рассмотрим пример. Найдите в окне редактора файла `hello.cpp` следующие строки:

    Hello::Hello()
        : KMainWindow( 0, "Hello" )
    {

Нажмите правую кнопку мыши на `KMainWindow`. Откроется меню. Выберите в нём пункт Искать в документации: KMainWindow и отпустите кнопку. Откроется боковая панель Документация, показывающая `KMainWindow` как элемент поиска в разделе Поиск. Через мгновенье в рабочей области откроется новое окно редактора, показывающее страницу справочника по API KDE с описанием класса `KMainWindow`.

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

Поиск идентификаторов во внешней документации.

Вы могли бы выбрать пункт Поиск в документации: KMainWindow. В этом случае была бы показана вкладка Поиск боковой панели Документация, обычно предлагающая выбор страниц, содержащих искомую строку (в нашем примере это классы `KMainWindow` и `KMainWindowInterface`). Выберите любую из них, и она будет показана в окне редактора.

Если это не сработало, возможно, не был создан индекс документации. См. предыдущий раздел.

#### Внутренние объявления и определения проекта

Поиск во внешней документации имеет свои ограничения. С помощью него нельзя найти идентификатор, который используется только внутри текущего проекта. Решение этой проблемы есть: среда может использовать индексы, созданные программой CTags для поиска в исходных текстах проекта.

Чтобы воспользоваться этой функцией в нашем проекте, мы должны сначала создать индекс. Это делается с помощью боковой панели CTags, расположенной внизу рабочей области.

Когда вы нажмёте на кнопку вкладки CTags, откроется боковая панель. В её правом нижнем углу вы обнаружите кнопку Создать индекс.

Нажмите её.

Подождите несколько секунд. Надпись База данных CTags не найдена слева от этой кнопке сменится текущей датой. Теперь можно искать идентификаторы.

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

Существует несколько способов поиска идентификаторов в проекте.

- ##### Использование боковой панели CTags

  Это просто. Начните вводить название идентификатора в поле Поиск внизу слева. Среда попытается дополнить вводимое слово и показать все идентификаторы, которые начинаются с последовательности символов в поле.

  Если, например, вы хотите узнать, где используется идентификатор «Hello» в нашем проекте, наберите в поле Поиск «H». Среда немедленно примется за дело и покажет результат, подобный следующему:

  Поиск идентификатора с помощью боковой панели CTags.

  Если вы нажмёте левой кнопкой мыши на один из элементов списка, среда откроет в окне редактора файл и установит курсор в соответствующее место.

- ##### Использование контекстного меню в файле исходного кода

  Это удобно, когда вы работаете с определённым исходным файлом. Допустим, вы изучаете файл `main.cpp` нашего проекта. Там вы находите строку

      Hello *mainWin = 0;

  и задаётесь вопросом: «Для чего используется данная переменная?». Чтобы это выяснить, просто нажмите правой кнопкой мыши на идентификаторе «Hello». Появится меню, содержащее в конце необходимые для перехода пункты.

  Получение информации CTags об идентификаторе в проекте.

  Нажмите левой кнопкой мыши на интересующем пункте. Выберите CTags: перейти к определению «Hello». Среда незамедлительно откроет файл `hello.cpp` в новом окне редактора и переместит курсор прямо к определению класса:

      Hello::Hello()
          : KMainWindow( 0, "Hello" )
      {

- ##### Глобальный поиск

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

  - запустить глобальный поиск командой меню Правка Найти в файлах...;

  - использовать контекстное меню окна редактора.

  Мы продемонстрируем второй способ на нашем проекте. Содержание открываемого меню будет, в целом, идентичным. Давайте предположим, что мы изучаем исходный код в файле `hello.cpp`, курсор находится на первом идентификаторе «Hello», и мы хотим узнать, в каких файлах и сколько раз встречается данный идентификатор. Это типичный случай, в котором используется глобальный поиск.

  Теперь, удерживая курсор мыши над идентификатором «Hello», нажмите правую кнопку мыши и выберите в появившемся контекстном меню пункт Grep: Hello.

  Запуск глобального поиска из окна редактора.

  Появится диалог Поиск в файлах (точно такой же, как по команде меню Правка Найти в файлах...).

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

  Это очень мощный инструмент для выполнения поиска с помощью утилит find и grep во всём проекте. Мы не будем здесь углубляться в детали, вы можете поэкспериментировать с его возможностями сами. В данный момент в поле Образец уже должно быть помещено наше слово. В противном случае введите его в поле и нажмите кнопку Поиск внизу справа.

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

  В этой боковой панели два места особенно интересны.

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

  - Внизу находится список найденного. В нашем примере должно быть «*** 11 совпадений найдено ***».

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

### Упорядочение окон редактора

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

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

#### Очистка полосы вкладок

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

##### Одновременное закрытие нескольких окон

Групповое закрытие окон существует и в других приложениях &kde;. Оно доступно через меню Окно или контекстное меню вкладки окна. С его помощью можно закрыть:

- текущее окно;

- все окна кроме текущего;

- все окна (только через меню Окно).

##### Закрытие выбранных окон

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

Давайте рассмотрим этот метод на простом примере. Допустим, в нашем проекте «Hello» открыто для редактирования несколько файлов: `hello.cpp`, `hello.h`, `helloui.rc`, `hello.desktop` и `main.cpp`. Мы хотим закрыть все кроме `hello.cpp`. Самый простой способ это сделать — воспользоваться боковой панелью Окна. Для удобства список открытых файлов упорядочен по алфавиту. Процедура удаления занимает несколько шагов:

1. Откройте панель Окна и, удерживая клавишу Ctrl нажатой, выберите файлы, которые хотите закрыть.

2. Откройте контекстное меню любого выделенного файла в списке.

3. Выберите в нём команду Закрыть выделенные.

Закрытие выделенных окон редактора одним действием.

Выделенные окна будут закрыты.

#### Упорядочение вкладок окон редактора

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

##### Основная настройка: размещение новых вкладок.

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

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

1. Выберите команду меню Настройка Настроить KDevelop....

2. В открывшемся диалоге выберите раздел Интерфейс пользователя.

3. В её левом нижнем углу найдите группу Использование вкладок. Уберите флажок Открывать новую вкладку после текущей.

4. Перезапустите &kdevelop;. Теперь новые вкладки окон редактора будут добавляться с правого края на панели вкладок.

К сожалению, этот параметр нельзя изменять во время работы. Вам придётся заранее решить, какой вариант поведения вам больше подходит.

##### Упорядочение вкладок

Так как задачи в процессе разработки меняются, возникает необходимость упорядочить окна редактора. Сделать это в &kdevelop; не сложно.

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

#### Просмотр нескольких файлов одновременно

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

Для выполнения деления есть две команды. Они доступны в меню Окно и в контекстных меню окна и его вкладки. Рассмотрим их действие на примере нашего проекта.

Допустим, есть два открытых файла исходного кода: `hello.cpp` и `hello.h`. Так как во время работы с файлом `hello.cpp` часто возникает необходимость обращаться к объявлениям в заголовочном файле `hello.h`, вы хотите видеть оба файла одновременно.

Чтобы это сделать, откройте контекстное меню вкладки `hello.h`.

Деление рабочей области на две части.

Выберите команду Разделить горизонтально. Текущая рабочая область будет поделена пополам, окно `hello.h` будет помещено в нижнюю половину.

Рабочая область, разделённая по горизонтали.

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

Здесь стоит отметить несколько нюансов:

- Части рабочей области функционируют независимо друг от друга. Это значит, что новые окна-вкладки будут открываться в той части, где находится текущее окно. Любую часть можно тоже делить на части и так далее, таким образом, количество одновременно видимых окон неограниченно.

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

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

#### Одновременное редактирование заголовочных файлов и файлов реализации C++

Существует изящное применение описанной возможности. Среда позволяет автоматически показывать `.cpp` и соответствующий `.h` файлы рядом, а также работать с обоими файлами синхронно: при выделении объявления в заголовочном файле, среда будет перемещать курсор к соответствующему определению в файле реализации и наоборот.

Данная функция по умолчанию выключена. Если вы хотите её использовать, вам нужно её включить.

Для этого выберите команду меню Проект Параметры проекта. Появится диалог Параметры проекта. Перейдите в раздел Поддержка C++, а затем на вкладку Навигация.

Включение показа заголовочного файла и файла реализации C++ рядом.

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

Чтобы увидеть эту функцию в действии, закройте в проекте «Hello» окна редактора для файлов `hello.cpp` и `hello.h`. Теперь снова выберите файл `hello.cpp` в подкаталоге `src` каталога проекта. Откроется окно редактора, как обычно. Но если вы сейчас откроете файл `hello.h`, среда автоматически разделит рабочую область и откроет окно редактора для этого файла прямо под окном `hello.cpp`.

Теперь найдите в окне редактора файла `hello.cpp` следующее определение конструктора:

    Hello::Hello()

— и поместите в него курсор. Посмотрите в окно файла `hello.h` внизу. Среда покажет в нём соответствующее объявление этого конструктора.

Автоматический переход к объявлению конструктора.

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

#### Объединение открытых окон в сеансы

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

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

Мы покажем эту возможность снова на примере проекта «Hello». Предположим, вы хотите всегда открывать файлы `main.cpp`, `hello.h` и `main.cpp` одним действием не зависимо от того, что делали до этого. Для этого нужно сначала создать новый сеанс, который называется, скажем, «sources».

Использование сеансов для запоминания групп файлов.

Объединение файлов в сеанс занимает несколько шагов.

1. Создание нового сеанса.

   1. Нажмите кнопку Новый сеанс в верхней левой части боковой панели Окна.

   2. Откроется диалог. Введите название сеанса в поле Введите название сеанса (например, «sources»).

   3. Закройте диалог кнопкой OK. Созданный сеанс появится в выпадающем меню панели инструментов.

2. Новый сеанс изначально пуст. В него нужно добавить файлы.

   1. Откройте все файлы, которые хотите добавить в сеанс. В нашем примере это будут `hello.cpp`, `hello.h` и `main.cpp`.

   2. Нажмите кнопку Сохранить сеанс на панели инструментов. Не забудьте это сделать, иначе список файлов не будет запомнен.

Всё. Когда вы выберите сеанс sources в выпадающем меню Открыть сеанс, среда закроет все открытые в данный момент окна редактора и откроет запомненные в сеансе файлы (в нашем примере это `hello.cpp`, `hello.h` и `main.cpp`).

Количество сеансов в проекте неограниченно. Если хотите изменить содержание сеанса, просто обновите список файлов и нажмите Сохранить сеанс. Удаляется сеанс нажатием кнопки Удалить сеанс справа на панели инструментов.

Более того, вы можете заставить среду открывать данный сеанс по умолчанию при загрузке проекта. Просто выберите сеанс в выпадающем списке в разделе Окна в диалоговом окне, открываемом командой меню Проекты Параметры проекта.

Настройка среды на открытие определённого сеанса при загрузке проекта.

### Отслеживание типичных проблем

Когда вы открываете файл с исходным кодом, среда делает анализ его содержимого. Это позволяет встроенному инспектору проблем проверить исходный текст на наличие типичных ошибок и предупредить пользователя о подозрительных местах.

Давайте посмотрим, как это работает, на примере нашего проекта.

- Откройте файл `main.cpp`.

- Убедитесь, что он ещё содержит где-то в конце следующую строку:

      /// @todo do something with the command line args

  Она была вставлена Мастером проектов при создании проекта (см. главу Создание нового проекта).

- Теперь откройте боковую панель Проблемы в нижнем ряду вкладок. Если всё сделано правильно, появится сообщение об этой заметке «todo»:

  Среда предупреждает о строках в исходном коде, которые содержат маркер «todo».

Формат команды `/// @todo` предназначен для специальной обработки программой Doxygen, которую мы рассмотрим в главе «Документация». Не обязательно использовать именно этот формат, более распространённые маркеры `TODO` и `FIXME` тоже распознаются.

Например, если вы вставите комментарии, содержащие `TODO` и `FIXME`, в файл `hello.cpp`,

    Hello::Hello()
        : KMainWindow( 0, "Hello" )
    {
        // set the shell's ui resource file
        // TODO check the user interface
        setXMLFile("helloui.rc");

        // FIXME change to a better suited greeting
        new QLabel( "Hello World", this, "hello label" );
    }

то увидите их на боковой панели Проблемы:

Отчёт о строках текущего файла, требующих внимания.

Обратите внимание на другие вкладки боковой панели Проблемы, особенно на Fixme и Todo. Если вы их откроете, то найдёте в них все строки помеченные маркерами `FIXME` и `TODO`, которые были обнаружены в текущем сеансе. Например, заметки `TODO` будут выглядеть следующим образом:

Перечисление `TODO`.

Однако, вкладка Ошибки содержит не все ошибки, допущенные вами в коде. Это работа для других инструментов, например, инструментов сборки. Но вы можете найти здесь предупреждения о некоторых типичных ошибках программирования, которые могли бы остаться незамеченными и, возможно, трудноуловимыми во время отладки.

Вы оце́ните генератор отчётов о проблемах по достоинству. Регулярно поглядывайте на боковую панель Проблемы во время разработки.

## Компиляция проекта

Компиляция в &kdevelop; требует выполнения нескольких подготовительных действий, за которыми следует непосредственно сборка приложения. Все они доступны через меню Сборка.

Сборка проекта занимает несколько шагов.

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

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

- Основной цикл сборки (кратко).
- Основные средства конфигурации проекта.

### Основной цикл сборки

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

- Инициализация проекта для первой сборки.
- Выполнение начальной конфигурации.
- Сборка проекта.
- Запуск приложения.

Описание предполагает, что ваш проект основан на &GNU; autotools, которые используются при выборе соответствующего шаблона при создании проекта. Если вы выбрали другой шаблон проекта, например, основанный на сборке диспетчером проектов &Qt; QMake, будут доступны другие возможности или недоступно никаких. Обратитесь к документации соответствующего инструмента сборки, чтобы узнать, как управлять проектом и собирать его.

#### Инициализация проекта для сборки

Когда &appwizard; создавал проект «Hello», он оставил его в «сыром» состоянии. Инструменты &GNU; autotools требуют выполнения нескольких действий по инициализации перед компиляцией и компоновкой приложения. Если вы попытаетесь собрать проект в таком «сыром» состоянии, например, выбрав команду меню Собрать Собрать проект или нажав клавишу F8, то получите следующее предупреждение:

Попытка сборки «сырого» проекта на базе automake.

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

Как уже было сказано, компиляция и компоновка приложения выполняется через меню Сборка. Откройте его и выберите команду Запустить automake и родственные программы.

Запуск основной инициализации.

Среда откроет боковую панель Сообщения внизу, в которой будет показывать сообщения инструментов сборки. В случае отсутствия ошибок, последняя строка будет содержать сообщение «`*** Успешное завершение ***`».

Если вы прокрутите список сообщений вверх, то найдёте командную строку, которой среда вызывала инструменты сборки. Пример командной строки:

    cd '/home/devel/projects/hello' && \
    WANT_AUTOCONF_2_5="1" WANT_AUTOMAKE_1_6="1" gmake -f Makefile.cvs

Она говорит о том, что сначала среда перешла в корневой каталог нашего проекта. Затем установила определённые переменные окружения, сообщая системе сборки версии утилит autoconf и automake, используемых для данной инициализации. И наконец передала программе сборки (в нашем случае это &GNU; gmake) файл с правилами сборки.

Файл с правилами сборки был автоматически создан и настроен при создании проекта. Он содержит команды необходимые для правильной инициализации проекта, чтобы приложение могло работать в &kde;. Эти команды создадут скрипт `configure`, необходимый для выполнения следующего шага.

#### Начальная настройка проекта «Hello»

Конфигурация означает подгонку процесса сборки под аппаратные и программные особенности вашей системы. Это основное требование в процессе сборки на основе &GNU; autotools.

Когда основная инициализация automake успешно завершится, можно запускать скрипт configure, так как только после этой инициализации необходимые для его работы файлы станут доступны. Чтобы запустить его выберите команду меню Сборка Запустить configure.

Среда при необходимости опять откроет боковую панель Сообщения для показа сообщений скрипта configure. Если не возникнет никаких ошибок, последними сообщениями будут «`Good - your configure finished. Start make now`» и «`*** Успешное завершение ***`», добавленное средой.

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

    mkdir '/home/devel/projects/hello/debug' && \
    cd '/home/devel/projects/hello/debug' && \
    CXXFLAGS="-O0 -g3" "/home/devel/projects/hello/configure" --enable-debug=full

Здесь есть несколько интересных деталей.

- Во-первых, для сборки среда использует специальный подкаталог в дереве каталога проекта. Каталог сборки `debug` (показанный слева) содержит основную структуру проекта и набор файлов, связанных со сборкой: несколько файлов, созданных `configure`, и дополнительно по одному файлу `Makefile` на каждый подкаталог.

- Ниже, в разделе «Настройка проекта» мы рассмотрим причины, по которым используются отдельные подкаталоги для сборки. Сейчас достаточно знать, что среда создала каталог `debug` перед вызовом configure, и что этот скрипт создал его подкаталоги и все `Makefiles` в них.

- Затем, из каталога сборки `debug` среда вызывает скрипт `configure`, расположенный в корневом каталоге проекта, настроив переменные окружения, среди которых флаги `CXXFLAGS="-O0 -g3"` для компилятора &gcc; (-O0 — выключение оптимизации, -g3 — генерация полной отладочной информации).

- В последнюю очередь запускается скрипт `configure` с параметром `--enable-debug=full`, который означает, что каждый `Makefile` будет создаваться с правилом для компиляции и компоновки с отладочной информацией.

Эти параметры настраиваются для каждого проекта индивидуально. Более подробно это описано в главе «Управление проектом».

#### Сборка проекта

Теперь можно собирать (компилировать и компоновать) приложение. В меню Сборка есть три команды компиляции.

Команды для сборки двоичных файлов.

Пункты снизу вверх:

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

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

- Собрать проект. Эта команда то, что нам сейчас нужно. Она будет обрабатывать проект целиком, компилируя и компонуя все необходимые файлы.

Происходящее в каталоге `debug`, созданном во время предыдущего запуска `configure`, может быть интересным. Поэтому держите все его подкаталоги в развёрнутом состоянии, как показано выше. Выберите команду Сборка Собрать проект (или нажмите клавишу F8), чтобы начать сборку. Снова внизу откроется боковая панель Сообщения, показывающая вывод инструментов сборки. Вместе с этим в подкаталоге `debug` появятся некоторые файлы.

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

    cd '/home/devel/projects/hello/debug' && \
    WANT_AUTOCONF_2_5="1" WANT_AUTOMAKE_1_6="1" gmake -k

Среда переключилась на подкаталог `debug`, чтобы запустить находящийся там файл `Makefile`. Как и на этапе инициализации, она установила специальные переменные окружения перед вызовом gmake.

Обратите внимание на параметр `-k` в командной строке gmake. Он запрещает прерывание процесса сборки при возникновении ошибок. Это значит, что среда будет выводить все сообщения об ошибках в окно Сообщения. Если в этом окне присутствуют ошибки, используйте средства среды: нажмите на сообщение об ошибке в окне Сообщения и среда покажет ошибочное место в исходном файле.

Что же произошло внутри каталога `debug`? Ничего особенного. Появилось несколько файлов в ветвях `doc/en` и `src`. Наиболее интересный среди них файл `hello` в каталоге `/home/devel/projects/hello/debug/src/`. Это двоичный файл приложения. Всё, что осталось сделать, это запустить его.

#### Запуск приложения

Чтобы запустить приложение, либо выберите команду меню Сборка Выполнить программу, либо нажмите комбинацию клавиш Shift F9, либо нажмите кнопку Выполнить программу на панели Панель инструментов «Сборка», показанной внизу.

Запуск приложения с помощью панели Панель инструментов «Сборка».

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

    ./hello

Эта строка показывает, что среда знает, где находится исполняемый файл приложения. Место поиска исполняемого файла — настраиваемый параметр (см. главу "Управление проектом").

За строкой `./hello`, скорее всего, будет следовать предупреждающее сообщение. Не обращайте в данный момент на него внимания. Оно не помешает запустить наше приложение.

Наше первое приложение Hello.

Закройте приложение. Если не возникнет никаких ошибок, среда выведет в окно боковой панели Приложение сообщение «`*** Нормальное завершение ***`».

### Настройка проекта

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

- Конфигурации сборки
- Настройка поведения скрипта `configure`.
- Рекомендации по запуску утилиты make.
- Местонахождение исполняемого файла и параметры его запуска

#### Параметры сборки

Когда мы первый раз запускали скрипт `configure` в разделе «Начальная настройка проекта «Hello»», мы обратили внимание на то, что среда создала специальный подкаталог `debug`. В данном разделе мы обсудим некоторые следствия этого.

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

Чтобы выяснить текущую конфигурацию сборки, обратитесь к меню Проект Конфигурация сборки.

Различные конфигурации сборки проекта.

В случае нашего проекта есть три конфигурации. В других случаях может быть изначально только одна — default.

Текущая конфигурация слева имеет флажок. Переключение между конфигурациями осуществляется выбором соответствующего пункта меню.

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

debug

  Используйте эту конфигурацию во время разработки проекта. Сборка осуществляется отдельно от каталогов исходного текста в специальном подкаталоге `debug`, то есть все объектные, вспомогательные и исполняемые файлы будут помещаться в этот подкаталог, а не в каталоги проекта с исходным кодом. Сценарий `configure` получит параметр `--enable-debug=full`, будет установлена переменная окружения `CXXFLAGS="-O0 -g3"`, указывающая компилятору &gcc; не оптимизировать код и добавить полную отладочную информацию в выходные двоичные файлы.

optimized

  Эта конфигурация используется для сборки окончательного приложения C++. Сборка происходит отдельно от каталогов исходного кода в специальном подкаталоге `optimized`. Никаких специальных аргументов в `configure` не передаётся, устанавливается переменная окружения `CXXFLAGS="-O2 -g0"`, указывающая компилятору &gcc; оптимизировать код и не добавлять отладочную информацию в генерируемые двоичные файлы.

default

  Термин «default» обозначает стандартные параметры, используемые во время сборки приложения из консоли утилитами командной строки: &GNU; configure и make или gmake. В отличие от конфигураций debug или optimized специальный каталог для сборки не используется. Приложение будет собираться в каталогах с исходным кодом. Для инструментов сборки (например, &gcc;) будут использоваться параметры по умолчанию.

  Подумайте дважды прежде, чем выбирать конфигурацию default!

  Она не может использоваться параллельно с конфигурацией debug или optimized. Выполнение любой сборочной операции, использующей конфигурацию default, приведёт к невозможности использовать другие конфигурации. Это вызвано определёнными особенностями процесса создания файлов `Makefile` посредством automake и autoconf.

Возникает вопрос: «А зачем вообще использовать разные конфигурации сборки, когда они даже выглядят несовместимыми друг с другом?» Ответ: они упрощают цикл «редактирование-компиляция-отладка». Дополнительные отладочные инструкции, добавляемые в двоичные файлы, а также хитроумные изменения в структуре программного кода при его оптимизации влияют на поведение программы во время выполнения. Поэтому во многих случаях, когда логическая структура некоторой подпрограммы кажется правильной, вы можете проверить, корректно ли её поведение в более реальных условиях.

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

Таким образом, вместо очистки и перекомпиляции заново с другими параметрами, вам нужно лишь переключиться с конфигурации debug на optimize, скомпилировать изменения исходного кода и протестировать приложение в других условиях, а в случае проблем просто переключиться обратно на debug и продолжить работу.

Последнее замечание: многие параметры конфигурации сборки можно настраивать. Также можно определить свои конфигурации, если это требуется вашему процессу разработки. Мы рассмотрим эти возможности в следующем разделе.

#### Параметры конфигурации проекта

Конфигурация приложения особенно важна при сборке с помощью &GNU; autotools. Она обычно осуществляется запуском `configure` с определёнными параметрами и/или специальными флагами в переменных окружения перед запуском `configure` (например, переменная `CXXFLAGS`, упоминавшаяся выше).

Вы можете устанавливать бо́льшую часть параметров конфигурации проекта с помощью графического интерфейса, предлагаемого средой. Выберите команду меню Проект Параметры проекта и в открывшемся диалоге перейдите в раздел Параметры configure.

Здесь могут быть определены почти все параметры configure.

Как видите, в этом разделе можно устанавливать довольно много параметров. Сейчас мы рассмотрим лишь малую их часть, касающуюся нашего проекта. Подробности читайте в главе «Настройка проектов». Если хотите узнать смысл различных устанавливаемых флагов, введите в консоли команду `info make` (или `info:make` в &konqueror;) и перейдите в раздел Implicit Rules Implicit Variables.

Диалог имеет несколько вкладок. Вкладка Главное содержит часто используемые параметры, остальные вкладки — специфичные параметры компилятора. В любом случае, фактическое содержимое диалога определяется текущей конфигурацией сборки.

Конфигурация сборки, чьи параметры должны быть определены, выбирается в выпадающем списке Конфигурация в верхней части диалога Параметры configure.

Выбор конфигурации сборки.

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

##### Главное

На вкладке Главное находятся следующие параметры:

- ###### Параметры командной строки

  Это параметры, которые передаются в скрипт `configure` во время сборки. См. пример в разделе «Начальная настройка проекта «Hello».

- ###### Каталог сборки

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

- ###### Основной каталог с исходным кодом

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

- ###### Параметры препроцессора C/C++ (CPPFLAGS)

  Это параметры препроцессора. Среда будет их использовать при установке значений временных переменных окружения перед вызовом инструментов сборки. См. пример в разделе «Начальная конфигурация проекта «Hello»».

- ###### Параметры компоновщика (LDFLAGS)

  Это дополнительная информация для инструмента компоновки ld о том, где искать дополнительные библиотеки. Тоже входит в состав набора временных переменных окружения.

- ###### Переменные окружения

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

##### Специфичные параметры компилятора

Остальные вкладки диалога Параметры configure содержат параметры для компилятора. Они однотипно структурированы, поэтому достаточно рассмотреть вкладку C++.

Выбор компилятора и его переменных окружения.

Здесь можно устанавливать следующие параметры:

- ###### Компилятор C++

  Компилятор, который среда должна использовать. Список содержит только те компиляторы, которые известны среде.

- ###### Команда компилятора (CXX)

  Этот параметр предназначен для опытных пользователей. Он нужен только, если используется нестандартный компилятор C++, и содержит команду его вызова.

- ###### Параметры компилятора (CXXFLAGS)

  Здесь можно определить любые дополнительные параметры, которые среда передаст (через `Makefile`) компилятору. Некоторые значения параметров будут предустановлены в соответствии с выбранной в выпадающем списке Конфигурация конфигурацией сборки.

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

  Диалог для определения поведения компилятора &GNU; C++.

  На рисунке мы намеренно выделили вкладку Оптимизация. Обратите внимание, параметр Нет оптимизации был предустановлен (соответствуя параметру `-O0` в конфигурации сборки `debug`).

  К сожалению, на данный момент вы не можете выбирать все параметры из данного диалога. Например, параметр `-g3`, используемый в конфигурации сборки `debug`, потребовалось бы изменять вручную, если бы это понадобилось.

#### Правила сборки проекта программой make

Вы можете также настроить вызов программы make из среды во время сборки проекта. Выберите команду меню Проект Параметры проекта и в открывшемся диалоге выберите раздел Параметры make. Справа откроется диалог Параметры make.

Определите, как среда должна вызывать программу make.

На данный момент здесь особо нечего изменять. Единственный параметр, представляющий интерес в большинстве случаев — флажок Прервать после первой ошибки. В большинстве проектов он выключен. Это соответствует параметру `-k` программы gmake, который мы встречали во время начальной сборки нашего проекта.

Это имеет смысл в среде такой, как &kdevelop;, которая будет протоколировать любые сообщения об ошибках во время сборки. После завершения процесса сборки, вы можете легко перемещаться между сообщениями с помощью боковой панели Сообщения. Используйте для этого команды меню Вид Следующая ошибка и Вид Предыдущая ошибка или соответственно клавишу F4 и комбинацию клавиш Shift F4. Среда будет автоматически активировать окно редактора файла исходного кода и устанавливать курсор на строку с ошибкой.

С другой стороны, если вы хотите, чтобы сборка останавливалась при первой же ошибке, установите параметр Прервать после первой ошибки в этом диалоге. Тогда среда будет вызывать gmake без параметра `-k`.

#### Запуск исполняемого файла

Когда сборка завершена, вы можете легко запускать приложение прямо из среды. Используйте для этого команду меню Сборка Выполнить программу, комбинацию клавиш Shift F9 или кнопку Выполнить программу на панели Панель инструментов «Сборка».

Нажмите кнопку Выполнить программу на панели инструментов.

Но где же находится запускаемый исполняемый файл? Как заставить среду добавить параметры при его вызове? Или как запустить приложение в терминале само по себе, чтобы проверить её интерактивное поведение в консоли?

Всё это определяется параметрами проекта. Выберите команду меню Проект Параметры проекта, а затем перейдите в раздел Параметры запуска.

Параметры местонахождения и запуска исполняемого файла программы.

В данном диалоге много параметров. Они собраны в четыре группы:

- ##### Главная программа

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

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

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

  - Запуск из каталога сборки в соответствии с текущей конфигурацией сборки. Название этого каталога было установлено на вкладке Главное.

    Это корневой каталог, где среда будет искать исполняемый файл. Он меняется автоматически, в зависимости от выбора в меню Проект Конфигурации сборки.

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

  - Запуск исполняемого файла из указанного каталога. Снова, это только корневой каталог, в котором будет производиться поиск исполняемого файла.

    Используйте этот вариант, если, например, хотите запускать уже установленную программу вместо её версии из каталогов проекта.

- ##### Исполняемый файл

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

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

- ##### Переменные окружения

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

- ##### Параметры

  Два флажка внизу вкладки.

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

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

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

## Расширение проекта. Диспетчер проектов.

(в процессе написания)

### Краткий обзор механизма automake

(в процессе написания)

### Помещение значков в отдельный каталог.

(в процессе написания)

### Добавление новых классов

(в процессе написания)

Будьте осторожны, когда выбираете названия файлов классов. Потом их будет очень трудно изменить.

### Подпроект

(в процессе написания)

#### Концентрация на работе: активная цель.

(в процессе написания)

### Реструктуризация проекта

(в процессе написания)

## Отладка

(в процессе написания)

## О документации по проекта.

&kde; использует docbook для генерации руководства пользователя по проекту. Руководство пользователя доступно через команду меню Справка Руководство пользователя Ваше приложение во время работы вашего приложения &kde;. После сборки проекта руководство пользователя появляется в Центре справки &kde;. Оно объясняет пользователю, как работает приложение, какими функциями обладает и как его настраивать.

Все шаблоны проектов &kde; в &kdevelop; имеют подкаталог, который содержит шаблон руководства пользователя `index.docbook` в папке «en». Его нужно отредактировать. Начните с изменения персональных данных: имени, адреса электронной почты и так далее. Посмотрите на комментарии в файле и попробуйте следовать их указаниям, они помогут вам сделать первые шаги в составлении документации. Пересоберите проект, чтобы увидеть изменения в руководстве вашего приложения.

Вам нужно установить проект командой меню Сборка Установить или Установить (с правами root), чтобы увидеть руководство пользователя вашего проекта в Центре справки KDE.

Дополнительная информация о синтаксисе docbook находится сайте документации &kde;.

## Последнее, но не менее важное — комбинации клавиш

(в процессе написания)

## Что дальше

(в процессе написания)

### Часто возникающие проблемы

- Краткий обзор
- Страницы вопросов и ответов
- Форум
- Списки рассылки

### Работа с проектами

(в процессе написания)

#### Использование существующих проектов &kdevelop;

(в процессе написания)

#### Импорт внешних проектов

(в процессе написания)