BerndPol Создание проекта В &tdevelop; разработка программного обеспечения организована в рамках проектов. Проект содержит всё, что относится к данному задаче программирования: файлы исходного кода, файлы данных, средства управления, в том числе система сборки, доступ ко всем компонентам и к любым дополнительным инструментам. Словом всё, что нужно для получения реально работающей программы. Такая организация позволяет легко переключаться между независимыми задачами. Это очень удобно, если вы работаете над несколькими приложениями одновременно, что бывает очень часто. Откройте проект в &tdevelop; и вы сразу сможете продолжить работу над ним с того места, где остановились в прошлый раз. проект новый При создании нового проекта нужно выполнить множество формальных процедур: указать структуру папок проекта, создать базовые заголовочные файлы и файлы реализации, осуществить первоначальную настройку сборочной системы и так далее. &tdevelop; обеспечивает простой способ создания нового проекта — Мастер создания нового проекта. Его можно запустить из меню ПроектСоздать проект. Мастер проекта значительно упрощает и автоматизирует создание нового проекта: На первом этапе вы можете использовать один из предлагаемых шаблонов проектов. Там же необходимо указать некоторую общую информацию по проекту: названия приложения, его размещения и так далее. На следующем шаге решите, будете ли вы использовать систему контроля версий, такую, как например, CVS, и, если будете, укажите необходимые данные. Выберите шаблоны для заголовочных файлов и файлов реализации (если есть). Теперь осталось сгенерировать начальные файлы, структуру папок, начальные заголовочные файлы, файлы реализации и служебные файлы для управления проектом, например каркас для make. И это всё! Теперь у вас есть база для начала продуктивной работы. А теперь рассмотрим это более подробно... диалог Новый проект проект Новый проект диалог проект шаблоны шаблоны проект Чтобы создать новый проект, выберите пункт Создать проект из меню Проект: Начало создания проекта Диалог разделён на две части. В верхней вы можете выбрать язык программирования, который будет использоваться для написания программы, нижняя служит для ввода некоторой общей информации. проект тип приложения проект язык программирования проект язык язык язык программирования приложение тип Слева вверху находится список доступных языков программирования, например: C++ C++ новый проект C C новый проект C++ C++ новый проект База данных (проекты на SQL) SQL новый проект База данных новый проект Fortran Fortran новый проект Haskell Haskell новый проект Java Java новый проект PHP PHP новый проект Pascal Pascal новый проект Perl Perl новый проект Python Python новый проект Ruby Ruby новый проект Оболочка (скрипты на Bash) Bash новый проект оболочка новый проект Эти папки не содержат собственно средств языка, в них располагаются только шаблоны новых проектов, то есть отправная точка для начала разработки на том или другом языке. Если вы раскроете все папки, то увидите множество отдельных шаблонов в зависимости от типа поставленной задачи и сферы применения. При выборе шаблона в правой части окна показывается его краткое описание и снимок экрана главного окна приложения, основанного на выбранном шаблоне. Выберите шаблон, наиболее точно отвечающий вашим целям. Затем введите общую информацию, как описано ниже. Каждый шаблон привязан к определённой системе управления проектом. проект свойства свойства приложение имя имя приложение проект папка папка проект Расположение новый проект проект автор проект электронная почта автор электронная почта проект main.cpp main.cpp проект лицензия лицензия В нижнем разделе Свойства диалога Новый проект можно указать его свойства — данные для построения структуры проекта. Введите его в верхнее поле свойств с соответствующим названием. В нашем примере это MyApp. Обратите внимание, что в имени разрешается использовать только такие символы: английские буквы в нижнем и верхнем регистрах цифры символ подчёркивания Эти ограничения установлены в связи с тем, что указанное имя будет использовано для именования некоторых классов в создаваемом проекте. Поэтому ограничения на имя приложения отражают ограничения на именование переменных в языках программирования. Также имя приложения будет использовано при формировании конечного расположения создаваемого проекта. Имя приложения переводится в нижний регистр и добавляется к указанному расположению. Если сформированный по имени приложения путь уже существует, кнопка Далее > будет неактивна (серого цвета) и мастер известит вас об этом ещё и сообщением. Есть два способа выбрать другой каталог для вашего приложения — указать другое имя или изменить расположение проектов. Второй вариант можно осуществить во втором поле свойств с названием Расположение. Здесь вы должны ввести путь к каталогу, в котором будет создан подкаталог с именем проекта (в котором, в свою очередь, будут созданы другие подкаталоги разработки). Полный путь к проекту будет показан в поле Конечное расположение. При открытии диалога поле Расположение заполняется автоматически. Значение для него берётся из поля Каталог проектов по умолчанию: в главном разделе диалога настройки KDevelop. В нашем случае в качестве основного пути для новых проектов используется каталог /home/devel/projects/. Убедитесь что каталог проекта, указанный в поле Конечное расположение не существует в вашей файловой системе. Однако путь, указанный в поле Расположение должен существовать. Если это не так, мастер создания проекта сообщит об этом добавлением (неверно) в строку Конечное расположение. Настройка CVS для создаваемого проекта Данные, которые показываются на втором шаге, не являются критичными для проекта. Просто укажите ваше имя (то есть имя автора программы, к которому можно будет обращаться по поводу её работы и развития) в поле Автор и правильный адрес электронной почты в поле Электронная почта чтобы пользователи программы могли поддерживать с вами связь. Мастер постарается заполнить их значениями, взятыми из соответствующих разделов Центра управления KDE. Эта информация будет встроена в шаблоны программных файлов. Например, для программ &kde; C++ вы сможете найти её в начале файла main.cpp. Из всех полей, необязательным является Электронная почта, так как не все разработчики могут иметь доступ в Интернет. Введите номер версии, с которого нужно начать, и лицензию, в соответствии с которой вы хотите распространять ваше приложение. Если вы выбрали тип приложения (например, C или C++), к которому существуют шаблоны программных файлов, на следующих этапах вы можете увидеть уведомление о лицензии в (см. раздел «Шаблоны программных файлов»). Если вы выбрали другую лицензию, вам нужно будет ввести её текст самостоятельно. Информация о версии и используемой лицензии также будет встроена в шаблоны программных файлов, в форме, удобной для изменения. Нажмите кнопку Далее >. CVS новый проект проект CVS база данных CVS версия база данных версия CVS Здесь вы можете выбрать систему контроля версий. Здесь всё зависит от проекта, подробности о &CVS; вы можете найти в главе Использование &CVS;. По умолчанию Система контроля версий для проекта Не используется. Если вы не хотите использовать эту функцию, просто нажмите Далее >. В нашем примере мы используем &CVS;. Если вы выберете эту систему контроля версий, будут показаны поля, которые нужно заполнить. Настройка CVS для создаваемого проекта Система контроля версий, такая как &CVS; (Concurrent Versions System, система конкурирующих версий) записывает копии файлов проекта в некоторое подобие базы данных. В &CVS; вы можете передать файлы (commit) в репозиторий или загрузить их обратно (checkoutили update). Особенностью системы контроля версий является структурный метод хранения файлов, который всегда позволяет вернуться к более раннему состоянию разработки, если вы допустили неисправимые ошибки. &CVS; также позволяет сотрудничать нескольким разработчикам в большом проекте (как &tdevelop;), не вмешиваясь в работу друг друга. CVS репозиторий репозиторий CVS CVS локальный CVS удалённый локальный репозиторий CVS :local: CVS :local: &CVS; ведёт собственную базу данных версий файлов, которая хранится в так называемом корне &CVS;. Вам нужно будет указать путь к корню &CVS;, если вы хотите использовать эту систему управления версиями. Расположение локального &CVS;. Если вы разрабатываете программу самостоятельно, использование &CVS; локально пригодится как удобная система резервного копирования. Обычно она располагается в вашем домашнем каталоге под именем cvsroot: /home/devel/cvsroot (где devel — имя пользователя в системе) Это краткая форма — на самом деле, перед ней должна быть приставка :local:. Использование краткой формы разрешено только если она начинается со слэша (/). То есть полный адрес корня локального &CVS; будет выглядеть так: :local:/home/devel/cvsroot. Введите путь к корню &CVS;. Создание локального корня &CVS;. Если локальный корень &CVS; не существует, &tdevelop; может изменить это с помощью команды &CVS;. Для этого нажмите кнопку Создать локальный репозиторий. &tdevelop; только передаёт команды системе &CVS; на создание репозитория, не делая ничего самостоятельно. К счастью, &CVS; продуман достаточно хорошо, и, перед созданием нового репозитория &CVS; в указанном вами каталоге, проверяет наличие в нём уже существующего корня &CVS; в нём. Удалённый &CVS;.Возможно вы захотите расположить репозиторий на удалённом сервере, особенно если над проектом работает несколько разработчиков. Тогда введите URL репозитория &CVS; в поле Репозиторий. Например, чтобы подключиться к серверу &CVS; &kde;: :pserver:mylogin@cvs.kde.org:/home/kde, где mylogin соответствует имени регистрации вашей учётной записи &CVS; в репозитории &kde;. удалённый репозиторий :pserver: :ext: CVS :local: CVS :pserver: CVS :ext: Есть два типа удалённых серверов &CVS;: это pserver, использующий авторизацию без шифрования, и ext, в котором доступно шифрование rsh или ssh. Они различаются по приставке в URL: :pserver: для password protected server (сервера, защищённого паролем) без шифрования и :ext: для сервера, поддерживающего шифрование rsh или ssh. Например: :ext:mylogin@cvs.cervisia.sourceforge.net:/cvsroot/cervisia позволит получить доступ к исходному коду Cervisia, программы работы с &CVS;, на сервере SourceForge. Если вы хотите получить доступ к серверу &CVS; с шифрованием rsh или ssh, укажите протокол шифрования. Для этого необходимо установить значение переменной среды окружения CVS_RSH как rsh или ssh. Если вы собираетесь использовать шифрование для &CVS;, прочитайте главу Использование &CVS;. CVS репозиторий репозиторий CVS Теперь нужно указать где следует сохранять файлы проекта в &CVS;. Это место называется репозиторием. В принципе, вы можете выбрать любое имя для репозитория &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 и C++. Для некоторых других языков есть только шаблоны файлов исходного кода. Для остальных языков программирования всё ещё нет готовых шаблонов. Если для проекта есть возможность использования шаблонов, в начале файлов проекта с исходным кодом будет добавлен комментарий о лицензии, например для программ на 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. * ***************************************************************************/ Другие шаблоны будут иметь подобную информацию в соответствующим языку формате. Шаблоны файлов исходного кода будут также содержать информацию на основе данных, указанных ранее в мастере создания проектов, а именно содержимом полей Автор, Электронная почта и Лицензия. шаблоны проект изменение проект шаблоны изменение Шаблоны, которые вы редактируете в диалоге Новый проект будут использованы при создании нового заголовочного файла или файла реализации в проекте. В начале каждого файла будет расположена некоторая информация, зависящая от шаблона. Вы не ограничены вставкой обычного текста, &tdevelop; распознаёт несколько переменных, которые будут заменены на содержимое заданных полей. Это может быть информация об авторе, электронной почте или лицензии. Включение информации для &doxygen; Если, к примеру, вы хотите чтобы документация по &API;, генерируемая программой &doxygen;, содержала также дополнительное краткое описание файла, включите в шаблон такой код: /** * \file $MODULE$.cpp * \brief (здесь нужно поставить краткое описание файла). **/ Каждый раз, когда вы будете создавать новый файл исходного кода, &tdevelop; заменит $MODULE$ именем создаваемого файла. Например, если вы создали новый класс C++ с именем ASimpleTest, в начале файла asimpletest.cpp будет такой текст: /** * \file asimpletest.cpp * \brief (здесь нужно поставить краткое описание файла). **/ И теперь останется ввести краткое описание файла после слова \brief, не оставляя служебного, каждый раз одинакового, кода. Файл с лицензией Также вы можете включить информацию о лицензии. Для этого используется переменная $LICENSEFILE$: // Файл $LICENSEFILE$ содержит полный текст лицензии. Мастер приложений заменит $LICENSEFILE$ на имя файла, содержащего лицензию, например: // Файл COPYING содержит полный текст лицензии. для лицензии GPL, или // Файл LICENSE.BSD содержит полный текст лицензии. если вы решили распространять свою программу под лицензией BSD. &tdevelop; поддерживает большое количество переменных. Подробно это изложено в разделе Изменение шаблонов главы Средства редактирования. Шаблоны, которые вы установили здесь, будут задействованы после создания проекта. Информация, выбранная вами, будет находится в начале каждого созданного в рамках проекта файла исходного кода. Вы можете изменить текст шаблонов вручную после создания проекта. проект новый построение проект начальное построение Теперь почти всё сделано. На последнем шаге кнопка Далее > сменяется на Готово. Подумайте дважды перед её нажатием! Вы пока ещё имеете возможность вернуться < Назад и изменить введённые данные. Если вы используете &CVS; локально, проверьте ещё раз имя репозитория (указанного подкаталога не должно существовать). Чтобы отменить создание проекта, нажмите соответствующую кнопку, иначе нажмите Готово, при этом в окне Сообщения будут выводится подробные действия, выполняемые мастером создания проекта. Если вы выбрали использование &CVS;, после создания дерева каталогов проекта, будет запущена программа &CVS;, очищающая предыдущее содержимое окна сообщений и выводящая собственные сообщения. В большинстве случаев после завершения создания &tdevelop; автоматически откроет важные файлы проекта (это зависит от выбранного шаблона проекта). Не забудьте проверить предлагаемые по умолчанию значения. Например, вы можете изменить комментарии, добавляемые в начало файлов исходного кода. Шаблоны файлов находятся в подкаталоге templates базового каталога вашего проекта. Мы рекомендуем вас перед тем, как набивать собственный код, собрать новый проект. В большинстве случаев при этом не должно возникнуть никаких проблем. Чтобы начать всё сначала, удалите каталог проекта и его хранилище в корне &CVS; (если таковой имеется) и начните создание нового проекта заново. сборочная конфигурация по умолчанию предупреждение конфигурации сборки предупреждение сборки по умолчанию предупреждение конфигурация сборки по умолчанию Перед сборкой вашего проекта в первый раз, откройте Проект Конфигурация сборки. Там будет три профиля сборки: default, optimized и debug. Из-за некоторых ограничений в autoconf/automake, не используйте конфигурацию default. это приведёт к повреждению внутренней структуры каталогов, и вы не сможете использовать конфигурации optimized и debug. Если тип приложения, которое вы выбрали, предлагает только default, естественно, используйте его. (.. в процессе написания ..)