Создание Pzl-Компоненты: различия между версиями

Материал из wikiru.visual-prolog.com

 
(не показана 21 промежуточная версия этого же участника)
Строка 1: Строка 1:
{{copyright}}
Pzl-Компонента - это пакет системы программирования Visual Prolog. IDE системы Visual Prolog создает и помещает пакет в текущий проект. Elementary PzlStudio не работает с открытыми проектами и, соответственно, выполняет лишь элементарную операцию создания pzl-компоненты, независомо от проекта. Этот пакет далее может быть помещен в любой pzl-контейнер.
Pzl-Компонента - это пакет системы программирования Visual Prolog. IDE системы Visual Prolog создает и помещает пакет в текущий проект. Elementary PzlStudio не работает с открытыми проектами и, соответственно, выполняет лишь элементарную операцию создания pzl-компоненты, независомо от проекта. Этот пакет далее может быть помещен в любой pzl-контейнер.


Строка 15: Строка 17:
*[[#Директория pzl-Копоненты|Sub-Directory]] - Маршрут к поддиректории, в которой будет создан пакет компоненты.
*[[#Директория pzl-Копоненты|Sub-Directory]] - Маршрут к поддиректории, в которой будет создан пакет компоненты.
*[[#Имя Компоненты|Component Name]] - Имя создаваемой Компоненты (это будет имя пакета .pack)
*[[#Имя Компоненты|Component Name]] - Имя создаваемой Компоненты (это будет имя пакета .pack)
*[[#Имя Класса|Class Name]] - Имя класса Компоненты
*[[#Имя Класса|Class Name]] - Имя '''Класса''' Компоненты
*[[#Имя Интейрфейса|Interface Name]] - Имя интерфейса компоненты
*[[#Имя Интерфейса|Interface Name]] - Имя '''Интерфейса''' Компоненты
*[[#Условное имя компоненты|Component Alias]] - Условное имя компоненты
*[[#Условное имя компоненты|Component Alias]] - '''Условное имя''' Компоненты
*[[#Идентификатор компоненты|Component ID]] - Идентификатор компоненты
*[[#Идентификатор компоненты|Component ID]] - '''Идентификатор''' Компоненты
*[[#Автономная Запускаемость|RunAble]] - Автономная Запускаемость
*[[#Автономная Запускаемость|RunAble]] - Автономная Запускаемость
*[[#Пользовательский интерфейс|UI Strategy]] - Пользовательский интерфейс
*[[#Пользовательский интерфейс|UI Strategy]] - Пользовательский интерфейс
Строка 73: Строка 75:
'''''Обращаем внимание на то, что имя конечной  директории pzl-Компоненты и имя компоненты (пакета) могут различаться, хотя первоначально они будет предложены одинаковыми.'''''
'''''Обращаем внимание на то, что имя конечной  директории pzl-Компоненты и имя компоненты (пакета) могут различаться, хотя первоначально они будет предложены одинаковыми.'''''


==Имя контейнера==
==Имя Компоненты==
Имя контейнера определяет имя файла проекта <Имя Контейнера>.prj6. Должно быть не менее 8 символов.
Имя компоненты определяет имя набора файлов пакета
*<Имя Компоненты>.pack,
*<Имя Компоненты>.ph,
*<Имя Компоненты>.cl,
*<Имя Компоненты>.i,
*<Имя Компоненты>.pro
 
==Имя Интерфейса==
Имя интерфейса определяет базовый интерфейс компоненты, то есть интерфейс, который наделяет класс компоненты способностью порождать объект.
<vip>
interface iMyInterface
    supports pzlComponent
...
</vip>
Базовый интерфейс будет содержать также необходимые [[Pzl-Компонента#Предопределенные константы интерфейса pzl-компоненты|атрибуты базового интерфейса]].
 
Имя базового интерфейса Pzl-Компоненты не может совпадать с [[#Имя Класса|именем класса]]. Если это требование не соблюдается, то появится сообщение об ошибке.
 
[[Изображение:PzlStudio NewComponentError SameName.png]]
 
Имя базового интерфейса не может быть пустым.


==Уровень лицензии==
==Имя Класса==
Pzl-Система использует принцип лицензирования.  
Имя класса определяет базовый класс компоненты, то есть класс, который будет использован для создания экземпляра компоненты.


Лицензии различаются по уровням:
<vip>
*Public - публичная
class myComponent : iMyComponent
*Commercial - коммерческая
    open core
*Exclusive - эксклюзивная (исключительная)
...
*SuperExclusive
</vip>
Имя базового класса Pzl-Компоненты не может совпадать с [[#Имя Интерфейса|именем интерфейса]]. Если это требование не соблюдается, то появится сообщение об ошибке.


Уровень лицензии устанавливается:
Имя класса не может быть пустым.
*для главного приложения - библиотекой pzlPort_X.lib
*для pzl-Контейнера - библиотекой pzlContainer_X.lib
где X - идентификатор уровня лицензии.


Dll-Контейнер не может иметь уровень SuperExclusive. Этот уровень может иметь только PzlPort, причем, созданный компанией-разработчиком Pzl-Технологии.
==Условное имя компоненты==


Соответствие уровня лицензии и идентификатора библиотеки приведено ниже:
Условное имя компоненты может быть любой (не пустой и не содержащей пробелов) строкой символов и служит для условного именования компонент, например "ТекстовыйРедактор".
*Public - pzlContainer_P.lib
*Commercial - pzlContainer_C.lib
*Exclusive - pzlContainer_EX.lib  (X - персонифицирующий идентификатор)


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


PzlStudio предлагает значение по умолчанию - Public, которому соответствует библиотека pzlContainer_P.lib.
Идентификатор компоненты при ее назначении в форме может быть:
*либо любой (не пустой и не содержащей пробелов) строкой символов
*либо строкой символов, соответствующей уникальному идентификатору UID.


При выборе уровня лицензии, Elemantary PzlStudio автоматически установливает имя библиотеки в поле '''''Container Library''''' (это поле не редактируется, а является справочным). Если выбирается уровень лицензии Exclusive, то Вам предлагается файловый диалог со списком имеющихся в Вашем распоряжении библиотек. Вы должны выбрать одну из библиотек, относящися к библиотекам уровня Exclusive. Если выбрана библиотека, не относящаяся к уровню Exclusive, то появляется сообщение
Первая форма идентификатора получается простым набором текста, являющегося идентификатором компоненты


[[Изображение:PzlContainerLicenseLevelErrorDlg.png]]
[[Image:PzlStudio_ComponentIDAsString.png]]


==Библиотека Pzl-Контейнера==
Вторая форма идентификатора получается нажатием кнопки справа.
Это поле не редактируется и является справочным. Отражает имя библиотеки pzlContainer_X.lib, соответствующее уровню [[#Уровень лицензии|лицензии]] главного приложения.


==Версия Pzl-Контейнера==
[[Image:PzlStudio_ComponentIDAsUID.png]]
Версия Pzl-Конейнера является строкой, контролируемой только пользователем. Все, что делает Elementary PzlStudio с этой информацией - помещает ее в качестве значения константы pzlContainerVersion_C в файле PzlConfig.i после его создания.


<vip>
==Автономная Запускаемость==
interface iPzlConfig
constants
    pzlContainerVersion_C="1.0;001".


% Container Configuration
Параметр Автономной Запускаемости (RunAble) определяет возможность выполнения компонентой своей функции самостоятельно.
constants


end interface iPzlConfig
В форме может быть выбрано одно из двух значений: '''Yes''' и '''No'''. Если выбрано '''Yes''', то компонента будет поддерживать интерфейс '''SpbRun'''
<vip>
interface iMyInterface
    supports pzlComponent
    supports spbRun
...
</vip>
</vip>
и в файле <Имя Компоненты>.pro будет создан код, который должен быть конкретизирован:
<vip>
clauses
  spbRun(_UserText).
</vip>
==Пользовательский интерфейс==
Параметр Пользовательский Интерфейс определяет тип пользовательского интерфейса и выбирается из списка возможных значений:
*VPI - традиционный механизм графики
*GUI - объектный механизм графики
*Consol - консольный - без графического интерфейса.


==Атрибуты из базовых свойств==
==Атрибуты из базовых свойств==

Текущая версия на 12:38, 19 ноября 2007

Автор: Виктор Юхтенко

Pzl-Компонента - это пакет системы программирования Visual Prolog. IDE системы Visual Prolog создает и помещает пакет в текущий проект. Elementary PzlStudio не работает с открытыми проектами и, соответственно, выполняет лишь элементарную операцию создания pzl-компоненты, независомо от проекта. Этот пакет далее может быть помещен в любой pzl-контейнер.


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

Заполнив эти данные и нажав кнопку, Вы получаете готовую Pzl-Компоненту, которая теперь может быть включена в любой из pzl-контейнеров (в составе исполняемого приложения или в DLL).

Вызов операции

Форма для создания pzl-Компоненты вызывается через меню File/New.../Component.

PzlStudio CreateNewComponent.png

Перечень свойств в вызванной форме включает

  • Components Base Directory - Базовая директория Ваших Компонент
  • Sub-Directory - Маршрут к поддиректории, в которой будет создан пакет компоненты.
  • Component Name - Имя создаваемой Компоненты (это будет имя пакета .pack)
  • Class Name - Имя Класса Компоненты
  • Interface Name - Имя Интерфейса Компоненты
  • Component Alias - Условное имя Компоненты
  • Component ID - Идентификатор Компоненты
  • RunAble - Автономная Запускаемость
  • UI Strategy - Пользовательский интерфейс
  • Company - имя компании
  • Author - имя автора
  • Copyright - авторские права

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

Операция выполняется по нажатию на кнопку Create (Создать).

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

После выполнения операции форма остается активной и Вы можете продолжить создание pzl-Компонент.

Кнопка Close (Закрыть) закрывает форму.

Выполнение операции

При успешном выполнении операции в окно сообщений среды Elementary PzlStudio выводится отчет о создании компоненты.

PzlStudio CreatedNewComponentReport.png

Созданную таким образом Pzl-Компоненту можно теперь включать в контейнеры.

Параметры для создания Pzl-Компоненты

Базовая Директория Компонент

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


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

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

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

PzlStudio ChangeBaseComponentsDirectory.png

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

Директория pzl-Компоненты

Директория Pzl-Компоненты - это именно та директория, в которую будут помещены все файлы пакета компоненты.

Директория Pzl-Компоненты следует рассматривать как маршрут (например, в форме Дир1/Дир2/Дир3 или просто Дир1), который в совокупности с Базовой директорией компонент даст окончательный маршрут к директории, где будут создаваться файлы компоненты.

Поле Директория pzl-Компоенты не может быть пустым.

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

Если Директория pzl-Компоненты по каким-либо причинам не может быть создана, то появится диалог с сообщением об ошибке.


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

Имя Компоненты

Имя компоненты определяет имя набора файлов пакета

  • <Имя Компоненты>.pack,
  • <Имя Компоненты>.ph,
  • <Имя Компоненты>.cl,
  • <Имя Компоненты>.i,
  • <Имя Компоненты>.pro

Имя Интерфейса

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

interface iMyInterface
    supports pzlComponent
...

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

Имя базового интерфейса Pzl-Компоненты не может совпадать с именем класса. Если это требование не соблюдается, то появится сообщение об ошибке.

PzlStudio NewComponentError SameName.png

Имя базового интерфейса не может быть пустым.

Имя Класса

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

class myComponent : iMyComponent
    open core
...

Имя базового класса Pzl-Компоненты не может совпадать с именем интерфейса. Если это требование не соблюдается, то появится сообщение об ошибке.

Имя класса не может быть пустым.

Условное имя компоненты

Условное имя компоненты может быть любой (не пустой и не содержащей пробелов) строкой символов и служит для условного именования компонент, например "ТекстовыйРедактор".

Идентификатор компоненты

Идентификатор компоненты при ее назначении в форме может быть:

  • либо любой (не пустой и не содержащей пробелов) строкой символов
  • либо строкой символов, соответствующей уникальному идентификатору UID.

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

PzlStudio ComponentIDAsString.png

Вторая форма идентификатора получается нажатием кнопки справа.

PzlStudio ComponentIDAsUID.png

Автономная Запускаемость

Параметр Автономной Запускаемости (RunAble) определяет возможность выполнения компонентой своей функции самостоятельно.

В форме может быть выбрано одно из двух значений: Yes и No. Если выбрано Yes, то компонента будет поддерживать интерфейс SpbRun

interface iMyInterface
    supports pzlComponent
    supports spbRun
...

и в файле <Имя Компоненты>.pro будет создан код, который должен быть конкретизирован:

clauses
  spbRun(_UserText).

Пользовательский интерфейс

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

  • VPI - традиционный механизм графики
  • GUI - объектный механизм графики
  • Consol - консольный - без графического интерфейса.

Атрибуты из базовых свойств

Последние три позиции в форме

  • Company
  • Author
  • Copyright

устанавливаются в Базовых свойствах и здесь могут быть переопределены в случае, отличном от типового. Если Вы их здесь изменили, то значения этих параметров в Базовых свойствах не изменяются.

Ссылки