Bernd
Pol

# Начало — Мастер программ

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

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

## Новые проекты

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

&kdevelop; обеспечивает простой способ создания нового проекта — Мастер приложений. Его можно запустить из меню Проект Создать.

Мастер приложений значительно упрощает и автоматизирует создание нового проекта

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

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

3. Теперь решите, будете ли вы использовать систему контроля версий, такую, как, например, CVS, и, если будете, введите требуемые данные.

4. Выберите шаблоны для начальных заголовочных и исходных файлов (если есть).

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

Voilà — и это всё. Теперь у вас есть база для начала продуктивной работы.

А теперь рассмотрим это более подробно...

### Первоначальные шаги

Чтобы создать новый проект, выберите пункт Создать проект из меню Проект:

первый шаг создания проекта

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

#### Выбор языка программирования и типа приложения

Вверху справа находится список доступных языков программирования, например:

- Ada

- C

- C++

- База данных (SQL)

- Fortran

- Haskell

- Java

- PHP

- Pascal

- Perl

- Python

- Ruby

- Оболочка (Сценарии Bash)

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

При выборе шаблона отображается его краткое описание и снимок экрана главного окна приложения, основанного на выбранном шаблоне.

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

##### Выбор системы управления проектом

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

#### Указание общей информации

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

##### Название приложения

Введите его в верхнее поле свойств с соответствующим названием. В нашем примере это MyApp.

Обратите внимание, что в названии разрешается использовать только такие символы:

- буквы в нижнем и верхнем регистрах

- цифры

- символ подчёркивания

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

##### Каталог проекта

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

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

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

##### Начальный путь

Есть два способа выбрать другой каталог для вашего приложения — выбрать для него другое имя или путь.

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

Мастер приложений автоматически скопирует начальное значение в поле Расположение. Оно определяется из поля Каталог с проектами по умолчанию: на этапе базовой конфигурации. В нашем случае в качестве основного пути для новых проектов используется каталог `/home/devel/projects/`.

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

Тем временем путь, указанный в поле Расположение должен существовать. Если это не так, мастер приложений сообщит об этом добавлением (неправильно) в строку Окончательное расположение.

##### Личная информация

Заполните приведённые здесь поля если вы хотите, чтобы все знали имя создателя программы.

1. Мастер приложений пытается заполнить их значениями, взятыми из соответствующих разделов Центра управления KDE.

2. Личная информация будет встроена в выбранный шаблон. Например, для программ &kde; C++ вы сможете найти её в начале `main.cpp`.

3. Из всех полей, необязательным является E-mail, т.к. не все разработчики могут иметь доступ к Сети.

##### Версия и лицензия

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

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

Если вы выбрали другую лицензию, вам нужно будет ввести её текст самостоятельно.

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

Нажмите кнопку Далее >.

### Выбор системы контроля версий

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

Здесь всё зависит от проекта, подробности о &CVS; вы можете найти в главе Использование &CVS;.

#### Система контроля версий не нужна

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

#### Использование &CVS;

В нашем примере мы используем &CVS;. Если вы выберете её Мастер приложений активирует поля, которые нужно будет заполнить.

Настройка CVS для вновь созданного проекта

Система контроля версий, такая как &CVS; (Concurrent Versions System, система конкурирующих версий) записывает копии файлов проекта в некоторое подобие базы данных. В &CVS; вы можете закачать файлы (commit) в хранилище, или загрузить их обратно (checkout/update). Особенностью системы контроля версий является структурный метод хранения файлов, который всегда позволяет вернуться к более раннему состоянию разработки, если вы допустили неисправимые ошибки. &CVS; также позволяет сотрудничать нескольким разработчикам в большом проекте (как &kdevelop;) не вмешиваясь в работу друг друга.

#### &CVS; Root

&CVS; ведёт собственную базу данных версий ваших файлов, которая хранится в т.н. корне &CVS; (&CVS; root). Вам нужно будет указать путь к этому корневому каталогу.

Локальный корневой каталог &CVS;. Если вы разрабатываете программу самостоятельно, локальная база данных &CVS; пригодится как удобная система резервного копирования. Обычно она располагается в вашем домашнем каталоге, под именем `cvsroot`:

``/home/devel/cvsroot`` (где `devel` — имя пользователя в системе)

Это краткая форма -- на самом деле перед ней должна быть приставка `:local:`. Использование краткой формы разрешено только если она начинается со слэша (`/`). Т.е. полный адрес локального каталога &CVS; (local &CVS; root) будет выглядеть так: `:local:/home/devel/cvsroot`

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

Инициализация нового корня &CVS;. Если корень &CVS; не существует, &kdevelop; может изменить это с помощью команды &CVS;. Для этого отметьте Инициализировать корень ниже поля Корень CVS.

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

Удалённый корневой каталог &CVS;.. Возможно вы захотите расположить хранилище на удалённом сервере, особенно если над проектом работает несколько разработчиков. Тогда введите URL корня &CVS; в поле Корень CVS. Например, чтобы подключиться к &CVS;-серверу &kde;:

``:pserver:mylogin@cvs.kde.org:/home/kde``, где mylogin соответствует имени регистрации вашей учётной записи &CVS; в репозитории &kde;.

#### Виды удалённых серверов &CVS;

Есть два типа удалённых серверов &CVS;, это pserver, использующий авторизацию без шифрования, и ext, в котором доступно шифрование rsh или ssh. Они различаются по приставке в URL:

`:pserver:`

для password protected server

`:ext:`

для шифрования rsh или ssh. Например:

``:ext:mylogin@cvs.cervisia.sourceforge.net:/cvsroot/cervisia``

позволит получить доступ к корню &CVS; фронт-энда &CVS;, Cervisia.

Если вы хотите использовать сервер &CVS; с шифрованием rsh или ssh, укажите протокол шифрования. Введите `rsh` или `ssh` в поле CVS_RSH в диалоге создания нового проекта, на странице Система контроля версий.

Если вы собираетесь использовать шифрование, прочитайте главу Использование &CVS;.

#### Хранилище &CVS;

Теперь нужно указать где следует сохранять файлы проекта в корне &CVS;. это место называется хранилищем или репозиторием (repository).

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

Введите имя хранилища, которое вы хотите использовать в поле Хранилище CVS диалога создание нового проекта, на странице Система контроля версий.

Обратите внимание, на то, что нельзя использовать уже существующее хранилище! Система &CVS; сообщает только о конфликтах, так что вы можете потерять файлы с не уникальным именем!

#### Остающиеся поля

Осталось совсем немного. Остальные поля заполнены за вас автоматически:

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

Поле Сообщение содержит комментарий, который будет добавлен к первой версии файлов в хранилище &CVS;.

Поле Метка выпуска содержит тег (ветку) &CVS;, с которым выйдет первый выпуск вашего приложения. С помощью тега вы всегда сможете вернуться к состоянию разработки на данный момент. Для подробностей см. Использование &CVS;.

По умолчанию предлагается тег start.

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

    * cd '/home/devel/test' && cvs -d '/home/devel/mycvsroot' \
      import -m 'new project' '' 'vendor' 'start' &&\
      sh /opt/kde3/share/apps/kdevcvs/buildcvs.sh . '' \
      '/home/devel/mycvsroot'
    * cvs [import aborted]: /home/devel/mycvsroot/CVSROOT: No such file or
      directory
    * *** Exited with status: 1 ***

Если это произошло, инициализируйте &CVS; самостоятельно, или удалите каталог проекта и начните процесс создания проекта сначала.

После ввода всех данных &CVS;, нажмите Далее >.

Чтобы исправить ошибку на предыдущей странице, нажмите кнопку < Назад.

### Выбор шаблонов заголовочных/исходных файлов

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

Для некоторых языков программирования всё ещё нет готовых шаблонов.

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

    /***************************************************************************
     *   Copyright (C) 2003 by Your Name                                       *
     *   you@you.com                                                           *
     *                                                                         *
     *   This program is free software; you can redistribute it and/or modify  *
     *   it under the terms of the GNU General Public License as published by  *
     *   the Free Software Foundation; either version 2 of the License, or     *
     *   (at your option) any later version.                                   *
     *                                                                         *
     *   This program is distributed in the hope that it will be useful,       *
     *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
     *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
     *   GNU General Public License for more details.                          *
     *                                                                         *
     *   You should have received a copy of the GNU General Public License     *
     *   along with this program; if not, write to the                         *
     *   Free Software Foundation, Inc.,                                       *
     *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
     ***************************************************************************/

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

На основе данных, введенных в мастере создания проектов, в т.ч. поля Автор и E-mail, информации о лицензии, шаблоны исходных файлов будут дополнены соответствующим кодом.

#### Изменение шаблонов

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

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

Включение информации для &doxygen;

  Если, например, вы хотите чтобы &API;-документация, генерируемая программой &doxygen;, содержала также дополнительное краткое описание файла, включите в шаблон такой код:

      /**
       * \file $MODULE$.cpp
       * \brief (здесь нужно поставить краткое описание файла).
       **/

  И каждый раз, когда вы будете создавать новый исходный файл, &kdevelop; заменит `$MODULE$` именем создаваемого файла. Например, если вы создали новый класс C++ с именем `ASimpleTest`, в начале файла `asimpletest.cpp` будет такой текст:

      /**
       * \file asimpletest.cpp
       * \brief (здесь нужно поставить краткое описание файла).
       **/

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

Файл с лицензией

  Также вы можете включить информацию о лицензии. Для этого используется переменная `$LICENSEFILE$`:

      //   See $LICENSEFILE$ for the full license text.

  Мастер приложений заменит `computeroutput >$LICENSEFILE$` на имя файла, содержащего лицензию, например:

      //   See COPYING for the full license text.

  для лицензии GPL, или

      //   See LICENSE.BSD for the full license text.

  если вы решили распространять свою программу под лицензией BSD

  &kdevelop; распознаёт много больше переменных. Для подробностей см. Изменение шаблонов в главе Средства правки.

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

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

Теперь почти всё сделано. На последней странице кнопка Далее > сменяется на Готово.

Подумайте дважды перед её нажатием! Вы пока ещё имеете возможность вернуться < Назад и изменить введенные данные. Если вы используете локальный &CVS;, проверьте ещё раз имя хранилища (указанного подкаталога не должно существовать).

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

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

В большинстве случаев, после завершения создания, &kdevelop; автоматически откроет исходные файлы важных частей (это зависит от выбранного шаблона)

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

Затем, перед вводом какого-либо кода, откомпилируйте новый проект. В большинстве случаев при этом проблем возникнуть не должно. Чтобы начать всё сначала, удалите каталог проекта и его хранилище в корне &CVS; (если таковой имеется) и начните создание нового проекта заново.

Перед компиляцией вашего проекта в первый раз, зайдите в Проект Build Configuration. Там будет три вида компиляции: default, optimized и debug.

Из-за некоторых ограничений в текущей установке autoconf/automake, не используйте default. это приведёт к повреждению внутренней структуры каталогов, и вы не сможете использовать предустановку optimized и debug.

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