Skip to content

Публичный интерфейс библиотеки autumn

Аннотации

Список аннотаций

Желуди

Детальки

Прилепляемые коллекции

Классы

Модули

Напильники

Приемки

Перечисления


АннотацияЖелудь

ПриСозданииОбъекта

bsl
// Помечает указанный класс как желудь - компонент, жизненным циклом которого управляет фреймворк ОСень.
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
//                       как оно возвращается функцией `ТипЗнч`.
//
// Пример:
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "")

АннотацияПластилин

ПриСозданииОбъекта

bsl
// Маркерная аннотация для указания, что прилепляемая частица
// является желудем. Основной способ связывания желудей между собой.
//
// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
// или методом установки значения.
//
// Параметры:
//   Значение - Строка - Имя прилепляемого желудя. Если не заполнено, используется имя параметра конструктора/поля
//                       класса или часть имени метода для установки значения.
//   Тип - Строка - Тип прилепляемого желудя. В случае передачи значения "Желудь", будет внедрен желудь как таковой.
//                  Так же может быть указан тип-коллекция: "Массив", "ТаблицаЗначений" и другие. Полный список
//                  доступных типов см. в библиотеке
//                  [autumn-collections](https://github.com/autumn-library/autumn-collections).
//   Блестяшка - Произвольный - Повторяемый параметр. Передаваемые в прилепляемый желудь произвольные значения.
//
// Пример:
//
//  1.
//  &Желудь
//  Процедура ПриСозданииОбъекта(&Пластилин ДругойЖелудь)
//
//  2.
//  &Желудь
//  Процедура ПриСозданииОбъекта(
//  .  &Пластилин(Значение = "ДругойЖелудь", Тип = "Массив", Блестяшка = "Парам1", Блестяшка = "Парам2") Зависимость
//	)
//
//  3.
//  &Пластилин
//  Перем ДругойЖелудь;
//
//  4.
//  &Завязь
//  Функция МойЖелудь(&Пластилин ДругойЖелудь) Экспорт
//
//  5.
//  &Пластилин
//  Процедура УстановитьДругойЖелудь(Зависимость) Экспорт
//
Процедура ПриСозданииОбъекта(Повторяемый = Блестяшка = Неопределено)

АннотацияДуб

ПриСозданииОбъекта

bsl
// Помечает указанный класс как фабрику компонентов - дуб, из которого появляются желуди.
// `&Дуб` сам по себе тоже является желудем, то есть может запрашивать прилепление частиц,
// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
//
// Дуб обычно содержит методы, помеченные аннотацией `&Завязь`, которые возвращают желуди, но
// может содержать и другие методы, не связанные непосредственно с созданием желудей.
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
//                       как оно возвращается функцией `ТипЗнч`.
// Пример:
// &Дуб
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
// .
// &Завязь
// Функция ПользовательскийЖелудь() Экспорт
// .   Возврат Новый ПользовательскийЖелудь();
// КонецФункции
//
Процедура ПриСозданииОбъекта(Значение = "")

АннотацияЗавязь

ПриСозданииОбъекта

bsl
// Помечает функцию как функцию, создающую желудь.
//
// Может иметь параметры, каждый из которых должен быть промаркирован как &Пластилин, &Деталька или &Блестяшка.
// В указанные параметры автоматически будут прилеплены соответствующие частицы при создании желудя.
//
// Может размещаться над экспортной функцией в классе, проаннотированном как `&Дуб`, или над методом-лямбдой,
// передаваемой в качестве параметра в `Поделка.ДобавитьЗавязь()`.
//
// Параметры:
//   Значение - Строка - Имя создаваемого желудя. По умолчанию будет использовано имя метода.
//   Тип - Строка - Тип создаваемого желудя. 
//                  Требуется если по имени желудя не получается однозначного определить его тип.
//
// Пример:
// &Завязь
// Функция ПользовательскийЖелудь(&Пластилин Зависимость, &Деталька ВажнаяНастройка) Экспорт
// .   Возврат Новый ПользовательскийЖелудь(Зависимость, ВажнаяНастройка);
// КонецФункции
//
Процедура ПриСозданииОбъекта(Значение = "", Тип = "")

АннотацияДеталька

ПриСозданииОбъекта

bsl
// Маркерная аннотация для указания, что прилепляемая частица
// является настройкой приложения.
//
// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
// или методом установки значения.
//
// Параметры:
//   Значение - Строка - Ключ настройки. См. библиотеку [configor](https://github.com/oscript-library/configor)
//                       для полного описания синтаксиса.
//                       Если не заполнено, используется имя параметра конструктора/поля класса
//                       или часть имени метода для установки значения.
//   ЗначениеПоУмолчанию - Произвольный - Значение, которое принимает деталька, если не задано из-вне. 
//
// Пример:
//
//  1.
//  &Деталька
//  Перем ПутьКФайлу;
//
//  2.
//  &Деталька(Значение = "Настройки.ПутьКФайлу", ЗначениеПоУмолчанию = "./file.txt")
//  Перем ПутьКФайлу;
//
//  3.
//  &Желудь
//  Процедура ПриСозданииОбъекта(&Деталька ПутьКФайлу)
//
//  4.
//  &Деталька
//  Процедура УстановитьПутьКФайлу(Значение) Экспорт
//
//  5.
//  &Завязь
//  Функция МойЖелудь(&Деталька ПутьКФайлу) Экспорт
//
Процедура ПриСозданииОбъекта(Значение = "", ЗначениеПоУмолчанию = Неопределено)

АннотацияБлестяшка

ПриСозданииОбъекта

bsl
// Маркерная аннотация для указания, что прилепляемая частица
// является произвольным значением, передаваемым в конструктор желудя.
//
// Может быть использована только над параметром конструктора/метода завязи желудя.
//
// Пример:
//
// 1.
// &Желудь
// Процедура ПриСозданииОбъекта(&Блестяшка ПроизвольноеЗначение)
//
// 2.
// &Завязь
// Функция МойЖелудь(&Блестяшка ПроизвольноеЗначение) Экспорт
//
Процедура ПриСозданииОбъекта()

АннотацияТабакерка

ПриСозданииОбъекта

bsl
// Пометка, что прилепляемая частица прилепляется не непосредственно, а через специальный объект
// типа `Табакерка`, который позволяет получить частицу программно и отложенно.
//
// Может использоваться для внедрения компанейских желудей, внедрения желудя самого в себя, 
// для разрыва циклических зависимостей, для передачи дополнительных параметров прилепляемого желудя и т.п.
//
// Используется совместно с аннотациями `&Пластилин` и `&Деталька`.
//
// Пример:
//
// 1.
// &Табакерка
// &Пластилин("ДругойЖелудь")
// Перем ТабакеркаСДругимЖелудем;
// .
// ДругойЖелудь = ТабакеркаСДругимЖелудем.Достать();
// ДругойЖелудь.КакойТоМетод();
// ...
// 2.
// &Табакерка
// &Пластилин("ДругойЖелудь")
// Перем ТабакеркаСДругимЖелудем;
// .
// МассивБлестяшек = Новый Массив;
// МассивБлестяшек.Добавить("Парам1");
// .
// ДругойЖелудь = ТабакеркаСДругимЖелудем.Достать(МассивБлестяшек);
// ДругойЖелудь.КакойТоМетод();
//
Процедура ПриСозданииОбъекта()

АннотацияФинальныйШтрих

ПриСозданииОбъекта

bsl
// Процедуры, помеченные аннотацией "ФинальныйШтрих" будут вызваны в конце инициализации желудя,
// после отработки конструктора/метода завязи и всех напильников, применяемых на желуде.
// Во время выполнения процедуры доступны все прилепляемые частицы, прилепленные как через конструктор,
// так и через поля класса и методы-сеттеры.
//
// Желудь может содержать несколько процедур, помеченных аннотацией "ФинальныйШтрих".
// Порядок их вызова не гарантируется.
//
// Процедура должна быть помечена `Экспорт`ная.
//
// Пример:
// 
// &ФинальныйШтрих
// Процедура ПостИнициализация() Экспорт
// .   Сообщить("Я выполнилась после конструктора объекта");
// КонецПроцедуры
// .
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта()

АннотацияНапильник

ПриСозданииОбъекта

bsl
// Специальный тип желудя для дополнительной обработки других желудей в процессе их создания.
//
// Может использоваться для добавления дополнительных действий или свойств создаваемым желудям. Метод `ОбработатьЖелудь`
// **может** возвращать другой объект, который подменит текущий желудь, или обертку-декоратор над текущим желудем.
//
// Каждый `&Напильник` дополнительно имеет `&Прозвище("Напильник")`.
//
// Напильник сам по себе является желудем, однако в силу своей специфики он может запрашивать прилепление только
// &Деталек и Поделки.
//
// Желудь, помеченный аннотацией `&Напильник`, должен реализовать следующий интерфейс:
// * `Функция ОбработатьЖелудь(Желудь, ОпределениеЖелудя) Экспорт`
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя желудя, под которым напильник добавляется в контекст Поделки.
//   ПрименяетсяТолькоНа - Строка - Повторяемый параметр. Ограничивает применение напильника только на желудях
//                                  с указанными именами.
//
// Пример:
// &Напильник
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Повторяемый = ПрименяетсяТолькоНа = Неопределено)

МожетПрименятьсяНа

bsl
// Проверить, может ли текущий напильник применяться на указанном желуде.
//
// Параметры:
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение желудя, для которого проверяется
//                                           применимость текущего напильника.
//
//  Возвращаемое значение:
//   Булево - Истина, если напильник может применяться на указанном желуде, иначе Ложь.
//
Функция МожетПрименятьсяНа(ОпределениеЖелудя)

АннотацияЗаготовка

ПриСозданииОбъекта

bsl
// Специальный тип желудя для выполнения дополнительных действий в момент помещения класса в контекст Поделки.
//
// Может использоваться для добавления динамической загрузки новых классов в систему типов OneScript или
// дополнительных импортов библиотек через директиву `#Использовать`.
//
// Каждая `&Заготовка` дополнительно имеет `&Прозвище("Заготовка")` и &Спецификация("Инициализация").
//
// Желудь, помеченный аннотацией `&Заготовка`, должен реализовать следующий интерфейс:
// * `Процедура ПриИнициализацииПоделки(Поделка) Экспорт`
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя желудя, под которым заготовка добавляется в контекст Поделки.
//
// Пример:
// &Заготовка
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "")

АннотацияРогатка

ПриСозданииОбъекта

bsl
// Специальный тип желудя, автоматически выполняемый при запуске приложения (`Поделка.ЗапуститьПриложение()`).
//
// Желудь, помеченный аннотацией `&Рогатка`, должен реализовать следующий интерфейс:
// * `Процедура ПриЗапускеПриложения() Экспорт`
//
// Каждая `&Рогатка` дополнительно имеет `&Прозвище("Рогатка")`.
//
// `&Рогатка` сама по себе тоже является желудем, то есть может запрашивать прилепление частиц,
// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя желудя, под которым рогатка добавляется в контекст Поделки.
//   ЗапускатьВФоне - Булево - Если Истина, то рогатка будет запущена в фоновом задании.
//                             Если Ложь, то рогатка будет запущена в текущем потоке.
//   ОжидатьЗавершения - Булево - Если Истина и `ЗапускатьВФоне` = Истина,
//                                то после запуска рогатки будет ожидаться её завершение.
// Пример:
// Процедура ПриЗапускеПриложения() Экспорт
// .   Сообщить("Привет из рогатки!");
// КонецПроцедуры
// .
// &Рогатка
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "", ЗапускатьВФоне = Истина, ОжидатьЗавершения = Истина)

ЗапускатьВФоне

bsl
// Флаг необходимости запуска рогатки в фоновом задании.
//
//  Возвращаемое значение:
//   Булево
//
Функция ЗапускатьВФоне()

ОжидатьЗавершения

bsl
// Флаг необходимости ожидания завершения рогатки при ее запуске в фоновом задании.
//
//  Возвращаемое значение:
//   Булево
//
Функция ОжидатьЗавершения()

АннотацияПриемка

ПриСозданииОбъекта

bsl
// Специальный тип желудя для обработки определений желудей.
//
// Аналог &Напильника для `ОпределениеЖелудя`. Срабатывает каждый раз, когда в контекст добавляется новое
// определение желудя. При добавлении самой Приемки в контекст, все ранее добавленные определения желудей
// передаются в Приемку для проверки.
//
// Класс, помеченный аннотацией `&Приемка`, должен реализовать следующий интерфейс:
// * `Процедура ПриДобавленииОпределенияЖелудя(ОпределениеЖелудя) Экспорт`
//
// Каждая `&Приемка` так же имеет `&Характер("Компанейский")`, `&Прозвище("Приемка")` и `&Спецификация("Инициализация")`
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя желудя, под которым приемка добавляется в контекст Поделки.
//
// Пример:
//
// Процедура ПриДобавленииОпределенияЖелудя(ОпределениеЖелудя) Экспорт
// .   Сообщить("Определение желудя: " + ОпределениеЖелудя.Имя());
// КонецПроцедуры
// .
// &Приемка
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "")

АннотацияПрозвище

ПриСозданииОбъекта

bsl
// Добавляет к желудю дополнительный идентификатор, по которому его можно в последствии доставать из Поделки.
// Желудь может иметь несколько прозвищ. Одно и то же прозвище может использоваться для нескольких желудей.
//
// Может быть использовано, например, для группировки желудей и получении их в виде массива.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
//   Значение - Строка - Задаваемое прозвище.
//
// Пример:
//
// &Прозвище("ПодписчикНаСобытие")
// &Прозвище("ПользовательскийЖелудь")
// &Желудь("МойЖелудь")
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение)

АннотацияВерховный

ПриСозданииОбъекта

bsl
// Помечает желудь как имеющий приоритет среди других желудей с таким же именем или `&Прозвищем`.
// В случае конфликта имен при получении желудей или их регистрации, будет использован желудь с аннотацией `&Верховный`.
//
// При наличии нескольких желудей с одним и тем же прозвищем позволяет определить, какой из них следует возвращать
// при поиске конкретного желудя по его прозвищу.
//
// Если несколько желудей с одним и тем же именем/прозвищем имеют аннотацию `&Верховный`, будет вызвано исключение.
//
// Размещается над определением желудя - конструктором или методом &Завязи.
//
// Пример:
// 1.
// &Верховный
// &Желудь("ПереопределяемыйЖелудь")
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
// .
// 2.
// &Верховный
// &Завязь
// Функция ПереопределяемыйЖелудь() Экспорт
// КонецФункции
//
Процедура ПриСозданииОбъекта()

АннотацияПорядок

ПриСозданииОбъекта

bsl
// Управляет порядком инициализации и использования желудя. Не может быть меньше 1 или больше 999998.
//
// Если размещается над обычным `&Желудем` или `&Завязью`, то влияет на порядок сортировки, при получении 
// коллекции желудей по прозвищу.
//
// Если размещается над `&Напильником`, влияет на порядок применения напильников к желудям.
//
// Если размещается над `&Рогаткой`, влияет на порядок запуска рогаток при старте приложения.
//
// Параметры:
//   Значение - Число - Задаваемый порядок.
//
Процедура ПриСозданииОбъекта(Значение = 1)

Значение

bsl
// Порядок, заданный аннотацией.
//
//  Возвращаемое значение:
//   Число
//
Функция Значение() Экспорт

АннотацияХарактер

ПриСозданииОбъекта

bsl
// Задает способ управления жизненным циклом желудя.
//
// ОСень содержит два базовых характера желудя: "Одиночка" и "Компанейский".
//
// По умолчанию все желуди имеют характер "Одиночка", означающий, что желудь
// инициализируется один раз. При каждом запросе желудя будет возвращаться один и тот же
// экземпляр.
//
// Характер "Компанейский" означает, что каждый раз при запросе желудя будет создаваться
// новый экземпляр.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
//   Значение - Строка - Характер желудя.
//
// Пример:
//  &Характер("Компанейский")
//  &Желудь
//  Процедура ПриСозданииОбъекта()
//  КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение)

АннотацияОсобоеОбращение

ПриСозданииОбъекта

bsl
// Маркерная аннотация, показывающая, что желудь требует изменений в процессе своего создания.
//
// Параметры аннотации конфликтуют между собой. Если отключаются все напильники, то нельзя задавать ограничения на
// применение конкретных напильников или отключение конкретных напильников. Если задано ограничение на применение только
// конкретных напильников, то нельзя задавать ограничение на отключение конкретных напильников (и наоборот).
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
//   ОтключитьВсеНапильники - Булево - Не применять на желуде никакие напильники.
//   ПрименятьТолькоНапильник - Строка - Повторяемый параметр. Применять на желуде только напильник с указанным именем.
//   НеПрименятьНапильник - Строка - Повторяемый параметр. Не применять на желуде напильник с указанным именем.
//
Процедура ПриСозданииОбъекта(Повторяемый = НеПрименятьНапильник = Неопределено)

НапильникМожетПрименяться

bsl
// Проверяет, может ли указанный напильник применяться над желудем, помеченным аннотацией `&ОсобоеОбращение`.
//
// Параметры:
//   ИмяНапильника - Строка - Имя напильника для проверки применимости.
//
//  Возвращаемое значение:
//   Булево - Истина, если напильник может применяться на текущем желуде, иначе Ложь.
//
Функция НапильникМожетПрименяться(ИмяНапильника) Экспорт

АннотацияСпецификация

ПриСозданииОбъекта

bsl
// Аннотация для указания жизненного цикла приложения, начиная с которого разрешено создавать желудь.
//
// По умолчанию все желуди имеют спецификацию "Выполнение", означающую, что желудь может быть создан только после вызова
// `Поделка.ЗапуститьПриложение()`.
//
// К желудям со спецификацией "Инициализация" не применяются напильники.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
//   Значение - Строка - Состояние приложения, на котором разрешено создавать желудь. См. СостоянияПриложения.
//
// Пример:
// &Спецификация("Инициализация")
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "Выполнение")

Значение

bsl
// Сохраненное значение спецификации.
//
//  Возвращаемое значение:
//   Строка
//
Функция Значение() Экспорт

INFO

Документация из библиотеки autumn-collections.

АннотацияПрилепляемаяКоллекция

ПриСозданииОбъекта

bsl
// Помечает класс как реализацию прилепляемой коллекции с заданным именем.
//
// Имя используется при запросе коллекции через
// УправляющийПрилепляемымиКоллекциями.ПолучитьПрилепляемуюКоллекцию.
//
// Класс, помеченный аннотацией `&ПрилепляемаяКоллекция`, должен реализовать следующий интерфейс:
// * `Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт`
// * `Функция Получить() Экспорт`
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя регистрируемой прилепляемой коллекции (например, "Массив", "Соответствие").
//
// Пример:
// &ПрилепляемаяКоллекция("МояКоллекция")
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение)

INFO

Документация из библиотеки annotations.

АннотацияАннотация

ПриСозданииОбъекта

bsl
// Базовый объект аннотации.
// Все пользовательские аннотации должны иметь аннотацию &Аннотация с передачей имени аннотации в качестве параметра.
//
// Параметры:
//   Значение - Строка - Имя аннотации.
//
Процедура ПриСозданииОбъекта(Значение)

INFO

Документация из библиотеки annotations.

АннотацияПовторяемый

ПриСозданииОбъекта

bsl
// Аннотация, показывающая что параметр аннотации может быть указан несколько раз.
// 
// Применяется к параметрам конструктора аннотации.
//
// Примеры:
//
// &Аннотация("МояАннотация")
// Процедура ПриСозданииОбъекта(Значение, &Повторяемый Параметр)
// КонецПроцедуры
// .
// &МояАннотация(Значение = "Переданное значение", Параметр = "Первый параметр", Параметр = "Второй параметр")
//
Процедура ПриСозданииОбъекта()

INFO

Документация из библиотеки annotations.

АннотацияПсевдонимДля

ПриСозданииОбъекта

bsl
// Аннотация, объявляющая параметр конструктора аннотации псевдонимом
// для параметра вложенной мета-аннотации.
//
// Применяется к параметрам конструктора аннотации-агрегатора (композитной аннотации).
// При разворачивании композитной аннотации значение помеченного параметра
// переносится в указанный параметр указанной мета-аннотации.
//
// По умолчанию в мета-аннотацию переносится только явно переданное значение параметра.
// Если значение параметра при применении композитной аннотации не указано, его значение
// по умолчанию НЕ переносится — мета-аннотация использует собственное значение по умолчанию.
// Чтобы намеренно переопределить значение по умолчанию мета-аннотации значением по умолчанию
// параметра-псевдонима, укажите ПереноситьЗначениеПоУмолчанию = Истина.
//
// Параметры:
//   Аннотация                      - Строка - Имя мета-аннотации, параметр которой переопределяется.
//   Параметр                       - Строка - Имя параметра мета-аннотации, которому присваивается значение.
//   ПереноситьЗначениеПоУмолчанию - Булево - Признак переноса значения по умолчанию параметра-псевдонима
//                                            в мета-аннотацию, когда значение параметра не было передано явно.
//                                            По умолчанию Ложь — переносятся только явно переданные значения.
//
// Примеры:
//
// &Аннотация("Композит")
// &Цель
// Процедура ПриСозданииОбъекта(&ПсевдонимДля(Аннотация = "Цель", Параметр = "Значение") Значение)
// КонецПроцедуры
// .
// &Композит("переданное значение")
// // развернётся в &Композит("переданное значение") + &Цель(Значение = "переданное значение")
// .
// &Композит
// // развернётся в &Композит + &Цель — значение параметра "Значение" не передано,
// // поэтому мета-аннотация &Цель использует собственное значение по умолчанию.
//
// Чтобы переносить значение по умолчанию параметра-псевдонима, используйте
// ПереноситьЗначениеПоУмолчанию = Истина:
//
// &Аннотация("Композит")
// &Цель
// Процедура ПриСозданииОбъекта(
//     &ПсевдонимДля(Аннотация = "Цель", Параметр = "Значение", ПереноситьЗначениеПоУмолчанию = Истина)
//     Значение = "значение по умолчанию композита"
// )
// КонецПроцедуры
// .
// &Композит
// // развернётся в &Композит + &Цель(Значение = "значение по умолчанию композита")
//
// Параметр-псевдоним может быть одновременно помечен аннотацией &Повторяемый.
// В этом случае при разворачивании в целевую мета-аннотацию переносятся все
// переданные значения параметра.
//
// Примеры:
//
// &Аннотация("Композит")
// &Цель
// Процедура ПриСозданииОбъекта(&Повторяемый &ПсевдонимДля(Аннотация = "Цель", Параметр = "Значение") Значение)
// КонецПроцедуры
// .
// &Композит("первое", "второе")
// // развернётся в &Композит("первое", "второе") + &Цель(Значение = "первое", Значение = "второе")
//
Процедура ПриСозданииОбъекта(Аннотация, Параметр, ПереноситьЗначениеПоУмолчанию = Ложь)

Поделка

ПриСозданииОбъекта

bsl
// Создаёт контекст приложения (поделку): инициализирует фабрику желудей, контейнер аннотаций,
// менеджер параметров и сканирует известные типы.
//
// Параметры:
//   СоветДругогоМастера - СоветДругогоМастера - Настройки создания поделки. По умолчанию Неопределено — используются настройки по умолчанию.
//
Процедура ПриСозданииОбъекта(Знач СоветДругогоМастера = Неопределено)

ПолучитьОпределенияЖелудей

bsl
// Возвращает определения желудей. Если имя не указано — возвращаются все известные определения.
//
// Параметры:
//   Имя - Строка - Имя желудя, определения которого нужно получить. По умолчанию Неопределено — вернутся все определения.
//
//  Возвращаемое значение:
//   ФиксированноеСоответствие:
//    * Ключ     - Строка - имя желудя
//    * Значение - ОпределениеЖелудя - определение желудя
//
Функция ПолучитьОпределенияЖелудей(Имя = Неопределено) Экспорт

ПолучитьОпределенияАннотаций

bsl
// Возвращает определения всех зарегистрированных аннотаций.
//
//  Возвращаемое значение:
//   ФиксированноеСоответствие:
//    * Ключ     - Строка - имя аннотации
//    * Значение - ОпределениеАннотации - определение аннотации
//
Функция ПолучитьОпределенияАннотаций() Экспорт

ПолучитьОпределениеЖелудя

bsl
// Возвращает определение желудя по его имени.
//
// Параметры:
//   Имя - Строка - Имя желудя.
//
//  Возвращаемое значение:
//   ОпределениеЖелудя, Неопределено - определение желудя либо Неопределено, если желудь не найден.
//
Функция ПолучитьОпределениеЖелудя(Имя) Экспорт

ПолучитьОпределениеАннотации

bsl
// Возвращает определение аннотации по её имени.
//
// Параметры:
//   Имя - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   ОпределениеАннотации, Неопределено - определение аннотации либо Неопределено, если аннотация не найдена.
//
Функция ПолучитьОпределениеАннотации(Имя) Экспорт

НайтиЖелудь

bsl
// Находит и возвращает экземпляр желудя по его имени.
//
// Параметры:
//   Имя - Строка - Имя желудя. Имя "Поделка" возвращает сам контекст.
//   ПрилепляемыеЧастицы - Массив из ПрилепляемаяЧастица - Зависимости, передаваемые желудю при создании. По умолчанию Неопределено.
//
//  Возвращаемое значение:
//   Произвольный - экземпляр желудя.
//
Функция НайтиЖелудь(Имя, ПрилепляемыеЧастицы = Неопределено) Экспорт

НайтиЖелуди

bsl
// Находит и возвращает все экземпляры желудей с указанным именем в виде коллекции заданного типа.
//
// Параметры:
//   Имя - Строка - Имя желудей. Имя "Поделка" возвращает сам контекст (только для типа "Массив").
//   ПрилепляемыеЧастицы - Массив из ПрилепляемаяЧастица - Зависимости, передаваемые желудям при создании. По умолчанию Неопределено.
//   ТипЖелудя - Строка - Тип возвращаемой коллекции ("Массив", "Соответствие" и т.п.). По умолчанию "Массив".
//
//  Возвращаемое значение:
//   Произвольный - коллекция найденных экземпляров желудей указанного типа.
//
Функция НайтиЖелуди(Имя, ПрилепляемыеЧастицы = Неопределено, ТипЖелудя = "Массив") Экспорт

НайтиДетальку

bsl
// Возвращает значение детальки (параметра приложения) по её имени.
//
// Параметры:
//   ИмяДетальки - Строка - Имя детальки.
//   ЗначениеПоУмолчанию - Произвольный - Значение, возвращаемое, если деталька не найдена. По умолчанию Неопределено.
//
//  Возвращаемое значение:
//   Произвольный - значение детальки либо значение по умолчанию.
//
Функция НайтиДетальку(ИмяДетальки, ЗначениеПоУмолчанию = Неопределено) Экспорт

ДобавитьЖелудь

bsl
// Устарела. Ничего не делает, типы желудей сканируются автоматически.
//
// Параметры:
//   Тип - Тип - Тип добавляемого желудя.
//   Имя - Строка - Имя желудя. По умолчанию "".
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ДобавитьЖелудь(Тип, Имя = "") Экспорт

ДобавитьДуб

bsl
// Устарела. Ничего не делает, типы желудей сканируются автоматически.
//
// Параметры:
//   Тип - Тип - Тип добавляемого дуба.
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ДобавитьДуб(Тип) Экспорт

ДобавитьНапильник

bsl
// Устарела. Ничего не делает, типы желудей сканируются автоматически.
//
// Параметры:
//   Тип - Тип - Тип добавляемого напильника.
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ДобавитьНапильник(Тип) Экспорт

ДобавитьЗаготовку

bsl
// Устарела. Ничего не делает, типы желудей сканируются автоматически.
//
// Параметры:
//   Тип - Тип - Тип добавляемой заготовки.
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ДобавитьЗаготовку(Тип) Экспорт

ДобавитьРогатку

bsl
// Устарела. Ничего не делает, типы желудей сканируются автоматически.
//
// Параметры:
//   Тип - Тип - Тип добавляемой рогатки.
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ДобавитьРогатку(Тип) Экспорт

ДобавитьАннотацию

bsl
// Устарела. Ничего не делает, типы желудей сканируются автоматически.
//
// Параметры:
//   Тип - Тип - Тип добавляемой аннотации.
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ДобавитьАннотацию(Тип) Экспорт

ПросканироватьКаталог

bsl
// Устарела. Ничего не делает, каталоги сканируются автоматически.
//
// Параметры:
//   Каталог - Строка - Путь к сканируемому каталогу.
//
//  Возвращаемое значение:
//   Поделка - ЭтотОбъект для построения цепочки вызовов.
//
Функция ПросканироватьКаталог(Каталог) Экспорт

ДобавитьЗавязь

bsl
// Регистрирует завязь (метод-фабрику желудя) на основе переданной лямбды.
//
// Параметры:
//   Лямбда - Строка, Действие - Лямбда или делегат, создающий желудь.
//   Контекст - Произвольный - Контекст выполнения лямбды. По умолчанию Неопределено.
//
//  Возвращаемое значение:
//   Завязь - созданная завязь.
//
Функция ДобавитьЗавязь(Лямбда, Контекст = Неопределено) Экспорт

ЗапуститьПриложение

bsl
// Переводит поделку из состояния инициализации в состояние выполнения
// и запускает желудь "ЗапускательПриложения".
//
Процедура ЗапуститьПриложение() Экспорт

INFO

Документация из библиотеки annotations.

РазворачивательАннотаций

ПриСозданииОбъекта

bsl

Процедура ПриСозданииОбъекта(КонтейнерАннотаций)

РазвернутьАннотацииСвойства

bsl
// Развернуть все аннотации переданного свойства рекурсивно.
// Для разворачивания используются данные из определений аннотаций.
//
// Параметры:
//   Свойство - Структура - Описание свойства, метода или параметра метода:
//     * Имя - Строка - Имя свойства.
//     * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
//       ** Имя - Строка - Имя аннотации.
//        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//           *** Имя      - Строка - Имя параметра аннотации.
//           *** Значение - Строка - Значение параметра аннотации.
//   ВладелецСвойства - Тип - Тип владельца свойства.
//                    - Сценарий - Экземпляр владельца свойства.
//
Процедура РазвернутьАннотацииСвойства(Свойство, ВладелецСвойства) Экспорт

РазвернутьАннотацииСвойств

bsl
// Развернуть все аннотации переданного свойства рекурсивно.
// Для разворачивания используются данные из определений аннотаций.
//
// Параметры:
//   Свойства - Массив Из Структура - Описания свойств, методов или параметров метода:
//     * Имя - Строка - Имя свойства.
//     * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
//       ** Имя - Строка - Имя аннотации.
//        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//           *** Имя      - Строка - Имя параметра аннотации.
//           *** Значение - Строка - Значение параметра аннотации.
//   ВладелецСвойства - Тип - Тип владельца свойства.
//                    - Сценарий - Экземпляр владельца свойства.
//
Процедура РазвернутьАннотацииСвойств(Свойства, ВладелецСвойства) Экспорт

INFO

Документация из библиотеки annotations.

КонтейнерАннотаций

ПриСозданииОбъекта

bsl
// Контейнер аннотаций - объект, который хранит все определения аннотаций.
// При создании контейнера аннотаций в него автоматически добавляется базовая аннотация &Аннотация.
//
Процедура ПриСозданииОбъекта()

ПолучитьОпределенияАннотаций

bsl
// Получить все определения аннотаций.
//
//  Возвращаемое значение:
//   ФиксированноеСоответствие - Соответствие, в котором хранятся все определения аннотаций:
//	   * Ключ - Строка - имя аннотации.
//	   * Значение - ОпределениеАннотации - определение аннотации.
//
Функция ПолучитьОпределенияАннотаций() Экспорт

ПолучитьОпределениеАннотации

bsl
// Получить определение аннотации по её имени.
//
// Параметры:
//   Имя - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   ОпределениеАннотации, Неопределено - Найденное определение аннотаций. 
//                                        Неопределено, если аннотация с данным именем не зарегистрирована.
//
Функция ПолучитьОпределениеАннотации(Имя) Экспорт

ПолучитьРазворачивательАннотаций

bsl
// Получить настроенный разворачиватель аннотаций.
//
//  Возвращаемое значение:
//   РазворачивательАннотаций - Разворачиватель аннотаций, связанный с данным контейнером аннотаций.
//
Функция ПолучитьРазворачивательАннотаций() Экспорт

ДобавитьАннотацию

bsl
// Добавить аннотацию в контейнер аннотаций.
//
// Параметры:
//   ТипАннотации - Тип - Тип аннотации.
//   ПереопределитьЕслиСуществует - Булево - Если Истина, то при добавлении уже существующей аннотации 
//                                            она будет переопределена. Если Ложь (по умолчанию), 
//                                            то будет вызвано исключение.
//
//  Возвращаемое значение:
//   ОпределениеАннотации - Определение добавленной аннотации.
//
Функция ДобавитьАннотацию(ТипАннотации, Знач ПереопределитьЕслиСуществует = Ложь) Экспорт

ПрилепляторЧастиц

ПриСозданииОбъекта

bsl
// @internal
Процедура ПриСозданииОбъекта(пПоделка, пУправляющийПрилепляемымиКоллекциями)

ДанныеОПрилепляемойЧастице

bsl

Функция ДанныеОПрилепляемойЧастице(Свойство, Знач ИмяСвойства = Неопределено) Экспорт

НайтиПрилепляемуюЧастицу

bsl

Функция НайтиПрилепляемуюЧастицу(ДанныеОПрилепляемойЧастице, Знач ПрилепляемыеЧастицы = Неопределено) Экспорт

core.ЗапускатьРогатки

Тип

Булево

Описание

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


INFO

Документация из библиотеки autumn-collections.

ПрилепляемаяКоллекцияМассив

ПриСозданииОбъекта

bsl
// Конструктор прилепляемой коллекции на основе массива.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Массив".
//
Процедура ПриСозданииОбъекта()

Добавить

bsl
// Добавляет очередной желудь в коллекцию.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить

bsl
// Возвращает прилеплённые желуди в виде неизменяемого массива.
//
//  Возвращаемое значение:
//   ФиксированныйМассив из Произвольный - желуди в порядке прилепления.
//
Функция Получить() Экспорт

INFO

Документация из библиотеки autumn-collections.

ПрилепляемаяКоллекцияТаблицаЗначений

ПриСозданииОбъекта

bsl
// Конструктор прилепляемой коллекции на основе таблицы значений с колонками
// «Имя», «Желудь», «ОпределениеЖелудя».
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "ТаблицаЗначений".
//
Процедура ПриСозданииОбъекта()

Добавить

bsl
// Добавляет очередной желудь в коллекцию отдельной строкой с именем, экземпляром
// и определением желудя.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить

bsl
// Возвращает прилеплённые желуди в виде копии таблицы значений.
//
//  Возвращаемое значение:
//   ТаблицаЗначений:
//    * Имя               - Строка - имя желудя
//    * Желудь            - Произвольный - экземпляр желудя
//    * ОпределениеЖелудя - ОпределениеЖелудя - определение желудя
//
Функция Получить() Экспорт

INFO

Документация из библиотеки autumn-collections.

ПрилепляемаяКоллекцияСоответствие

ПриСозданииОбъекта

bsl
// Конструктор прилепляемой коллекции на основе соответствия.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Соответствие".
//
Процедура ПриСозданииОбъекта()

Добавить

bsl
// Добавляет очередной желудь в коллекцию. Ключом служит имя желудя.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить

bsl
// Возвращает прилеплённые желуди в виде неизменяемого соответствия.
//
//  Возвращаемое значение:
//   ФиксированноеСоответствие:
//    * Ключ     - Строка - имя желудя
//    * Значение - Произвольный - желудь
//
Функция Получить() Экспорт

INFO

Документация из библиотеки autumn-collections.

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

ПриСозданииОбъекта

bsl
// Конструктор прилепляемой коллекции на основе карты.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Карта".
//
Процедура ПриСозданииОбъекта()

Добавить

bsl
// Добавляет очередной желудь в коллекцию. Ключом служит имя желудя.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить

bsl
// Возвращает прилеплённые желуди в виде неизменяемой карты, где ключом служит имя
// желудя (Строка), а значением — экземпляр желудя (Произвольный).
//
//  Возвращаемое значение:
//   ФиксированнаяКарта - карта прилеплённых желудей.
//
Функция Получить() Экспорт

INFO

Документация из библиотеки autumn-collections.

ПрилепляемаяКоллекцияМножество

ПриСозданииОбъекта

bsl
// Конструктор прилепляемой коллекции на основе множества.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Множество".
//
Процедура ПриСозданииОбъекта()

Добавить

bsl
// Добавляет очередной желудь в коллекцию. Повторное добавление одного и того же
// желудя игнорируется.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить

bsl
// Возвращает прилеплённые желуди в виде неизменяемого множества уникальных элементов.
//
//  Возвращаемое значение:
//   ФиксированноеМножество из Произвольный - уникальные прилеплённые желуди.
//
Функция Получить() Экспорт

INFO

Документация из библиотеки autumn-collections.

ПрилепляемаяКоллекцияСписок

ПриСозданииОбъекта

bsl
// Конструктор прилепляемой коллекции на основе списка.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Список".
//
Процедура ПриСозданииОбъекта()

Добавить

bsl
// Добавляет очередной желудь в коллекцию.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить

bsl
// Возвращает прилеплённые желуди в виде неизменяемого списка в порядке прилепления.
//
//  Возвращаемое значение:
//   ФиксированныйСписок из Произвольный - желуди в порядке прилепления.
//
Функция Получить() Экспорт

СоветДругогоМастера

ПриСозданииОбъекта

bsl
// Советы по созданию поделки, упакованные в объект.
//
Процедура ПриСозданииОбъекта()

ЗначенияДеталек

bsl
// Установить/получить значения деталек.
//
// Параметры:
//   НовоеЗначение - Соответствие - устанавливаемые значения деталек.
//
//  Возвращаемое значение:
//   Соответствие, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ЗначенияДеталек(НовоеЗначение = Неопределено) Экспорт

ПрефиксПеременныхСреды

bsl
// Установить/получить префикс переменных среды, хранящих значения деталек.
//
// Параметры:
//   НовоеЗначение - Строка - устанавливаемый префикс переменных среды.
//
//  Возвращаемое значение:
//   Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ПрефиксПеременныхСреды(НовоеЗначение = Неопределено) Экспорт

ИмяФайлаСоЗначениямиДеталек

bsl
// Установить/получить имя файла (без расширения), в котором хранятся значения деталек.
//
// Параметры:
//   НовоеЗначение - Строка - устанавливаемое имя файла.
//
//  Возвращаемое значение:
//   Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ИмяФайлаСоЗначениямиДеталек(НовоеЗначение = Неопределено) Экспорт

ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек

bsl
// Установить/получить относительный путь к каталогу, где хранятся файл со значениями деталек.
//
// Параметры:
//   НовоеЗначение - Строка - устанавливаемый путь к каталогу.
//
//  Возвращаемое значение:
//   Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек(НовоеЗначение = Неопределено) Экспорт

Табакерка

ПриСозданииОбъекта

bsl
// Конструктор объекта.
//
// Параметры:
//   ПрилепляторЧастиц - ПрилепляторЧастиц - Прилеплятор частиц, который будет использоваться для поиска.
//   БазоваяПрилепляемаяЧастица - ПрилепляемаяЧастица - Прилепляемая частица, в которой описано то, что должно
//      доставаться из Табакерки.
//
Процедура ПриСозданииОбъекта(ПрилепляторЧастиц, БазоваяПрилепляемаяЧастица)

Достать

bsl
// Достать частицу из табакерки
//
// Параметры:
//   ПрилепляемыеЧастицы - Массив - массив прилепляемых частиц, которые передадутся как зависимости доставаемой частицы.
//
//  Возвращаемое значение:
//   Произвольный - Желудь, блестяшка или деталька, хранимая в табакерке.
//
Функция Достать(ПрилепляемыеЧастицы = Неопределено) Экспорт

ОпределениеЖелудя

ПриСозданииОбъекта

bsl
// Описывает желудь (компонент) и способ его создания.
//
// Параметры:
//   РазворачивательАннотаций - РазворачивательАннотаций - Разворачиватель аннотаций для свойств и методов типа.
//   ТипЖелудя - Тип - Тип, экземпляры которого создаёт желудь.
//   Имя - Строка - Имя желудя. Не может быть пустым.
//   Характер - Строка - Характер желудя, одно из значений модуля ХарактерыЖелудей.
//   ПрилепляемыеЧастицы - Массив из ПрилепляемаяЧастица - Зависимости, передаваемые желудю при создании.
//   Завязь - Завязь - Способ создания желудя (метод-фабрика или конструктор).
//   Прозвища - Массив из Строка - Дополнительные имена желудя. Должен содержать хотя бы одно значение.
//   Порядок - Число - Порядок инициализации желудя.
//   Верховный - Булево - Признак верховного (приоритетного) желудя.
//   Спецификация - Строка - Фаза жизненного цикла, одно из значений модуля СостоянияПриложения.
//   КорневаяАннотация - Неопределено, Произвольный - Объект корневой аннотации желудя либо Неопределено.
//
Процедура ПриСозданииОбъекта(РазворачивательАннотаций, ТипЖелудя, Имя, Характер, ПрилепляемыеЧастицы, Завязь, Прозвища, Порядок, Верховный, Спецификация, КорневаяАннотация)

Имя

bsl
// Имя желудя.
//
//  Возвращаемое значение:
//   Строка
//
Функция Имя() Экспорт

ТипЖелудя

bsl
// Тип, экземпляры которого создаёт желудь.
//
//  Возвращаемое значение:
//   Тип
//
Функция ТипЖелудя() Экспорт

Характер

bsl
// Характер желудя, определяющий способ его создания и хранения (одиночка или компанейский).
//
//  Возвращаемое значение:
//   Строка - один из значений модуля ХарактерыЖелудей.
//
Функция Характер() Экспорт

ПрилепляемыеЧастицы

bsl
// Список прилепляемых частиц (зависимостей), которые нужно передать желудю при создании.
//
//  Возвращаемое значение:
//   ФиксированныйМассив из ПрилепляемаяЧастица
//
Функция ПрилепляемыеЧастицы() Экспорт

Завязь

bsl
// Завязь, описывающая способ создания желудя (метод-фабрика или конструктор).
//
//  Возвращаемое значение:
//   Завязь
//
Функция Завязь() Экспорт

Прозвища

bsl
// Прозвища (дополнительные имена), по которым может быть найден желудь.
//
//  Возвращаемое значение:
//   Массив из Строка
//
Функция Прозвища() Экспорт

Порядок

bsl
// Порядок инициализации желудя. Чем меньше число, тем раньше создаётся желудь.
//
//  Возвращаемое значение:
//   Число
//
Функция Порядок() Экспорт

Верховный

bsl
// Признак того, что желудь является верховным (приоритетным) среди желудей с тем же именем.
//
//  Возвращаемое значение:
//   Булево
//
Функция Верховный() Экспорт

Спецификация

bsl
// Спецификация (фаза жизненного цикла приложения), на которой доступен желудь.
//
//  Возвращаемое значение:
//   Строка - один из значений модуля СостоянияПриложения.
//
Функция Спецификация() Экспорт

КорневаяАннотация

bsl
// Объект корневой аннотации типа, на основе которой построено определение желудя
// (например, объект аннотации Дуб, Желудь или Напильник).
//
//  Возвращаемое значение:
//   Неопределено, Произвольный - объект корневой аннотации желудя
//      либо Неопределено, если корневая аннотация отсутствует.
//
Функция КорневаяАннотация() Экспорт

Свойства

bsl
// Таблица свойств типа желудя с развёрнутыми аннотациями.
//
//  Возвращаемое значение:
//   ТаблицаЗначений - таблица свойств типа:
//    * Имя       - Строка - имя свойства
//    * Аннотации - ТаблицаЗначений - аннотации свойства:
//       ** Имя       - Строка - имя аннотации
//       ** Параметры - ТаблицаЗначений - параметры аннотации:
//          *** Имя      - Строка - имя параметра аннотации
//          *** Значение - Строка - значение параметра аннотации
//
Функция Свойства() Экспорт

Методы

bsl
// Таблица методов типа желудя с развёрнутыми аннотациями.
//
//  Возвращаемое значение:
//   ТаблицаЗначений - таблица методов типа:
//    * Имя                  - Строка - имя метода
//    * КоличествоПараметров - Число  - число параметров метода
//    * ЭтоФункция           - Булево - признак, что метод является функцией
//    * Экспорт              - Булево - признак, что метод экспортный
//    * Аннотации            - ТаблицаЗначений - аннотации метода:
//       ** Имя       - Строка - имя аннотации
//       ** Параметры - ТаблицаЗначений - параметры аннотации:
//          *** Имя      - Строка - имя параметра аннотации
//          *** Значение - Строка - значение параметра аннотации
//    * Параметры            - ТаблицаЗначений - параметры метода:
//       ** Имя                     - Строка - имя параметра
//       ** ПоЗначению              - Булево - признак передачи по значению
//       ** ЕстьЗначениеПоУмолчанию - Булево - признак наличия значения по умолчанию
//       ** Аннотации               - ТаблицаЗначений - аннотации параметра:
//          *** Имя       - Строка - имя аннотации
//          *** Параметры - ТаблицаЗначений - параметры аннотации:
//             **** Имя      - Строка - имя параметра аннотации
//             **** Значение - Строка - значение параметра аннотации
//
Функция Методы() Экспорт

РефлекторОбъекта

bsl
// Рефлектор объекта типа желудя, используемый для получения метаданных типа.
//
//  Возвращаемое значение:
//   РефлекторОбъекта
//
Функция РефлекторОбъекта() Экспорт

НайтиМетодыСАннотациями

bsl
// Находит методы типа желудя, помеченные указанной аннотацией. Результат кешируется.
//
// Параметры:
//   АннотацияФильтр - Строка - Имя аннотации, по которой выполняется отбор методов.
//
//  Возвращаемое значение:
//   Массив из СтрокаТаблицыЗначений - найденные методы с указанной аннотацией.
//      Колонки строки соответствуют таблице, возвращаемой методом Методы().
//
Функция НайтиМетодыСАннотациями(АннотацияФильтр) Экспорт

INFO

Документация из библиотеки annotations.

ОпределениеАннотации

ПриСозданииОбъекта

bsl

Процедура ПриСозданииОбъекта(Знач _Имя, Знач _ИмяТипаАннотации, Знач _Параметры, Знач _Аннотации)

Имя

bsl
// Имя аннотации.
//
//  Возвращаемое значение:
//   Строка
//
Функция Имя() Экспорт

ИмяТипаАннотации

bsl
// Имя типа, к которому применяется аннотация.
//
//  Возвращаемое значение:
//   Строка
//
Функция ИмяТипаАннотации() Экспорт

Параметры

bsl
// Параметры аннотации - разобранные параметры конструктора класса аннотации.
// Метод возвращает копию таблицы.
//
//  Возвращаемое значение:
//   ТаблицаЗначений - таблица параметров аннотации:
//     * Имя                     - Строка          - Имя параметра.
//     * ПоЗначению              - Булево          - Признак получения пораметра по значению.
//     * ЕстьЗначениеПоУмолчанию - Булево          - Признак наличия значения по умолчанию.
//     * ЗначениеПоУмолчанию     - Произвольный    - Значение по умолчанию.
//     * Аннотации               - ТаблицаЗначений - Таблица аннотаций со следующими колонками:
//        ** Имя       - Строка          - Имя аннотации.
//        ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//           *** Имя      - Строка - Имя параметра аннотации.
//           *** Значение - Строка - Значение параметра аннотации.
//     * Экспорт                 - Булево          - Признак экспорта параметра.
//
Функция Параметры() Экспорт

Аннотации

bsl
// Подчиненные аннотации - список аннотаций над конструктором класса-аннотации.
// Метот возвращает глубокую копию таблицы.
//
//  Возвращаемое значение:
//   ТаблицаЗначений - Таблица аннотаций:
//     * Имя       - Строка          - Имя аннотации.
//     * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//       ** Имя      - Строка - Имя параметра аннотации.
//       ** Значение - Строка - Значение параметра аннотации.
//
Функция Аннотации() Экспорт

Проверить

bsl
// Выполнить проверку корректности аннотации.
//
// Выбрасывает исключение:
//  * Когда аннотация не содержит параметр, у которого нет значения по умолчанию.
//  * Когда аннотация содержит параметр, которого нет в списке параметров аннотации.
//  * Когда аннотация содержит несколько параметров без имени или с именем "Значение".
//
// Параметры:
//   Аннотация - СтрокаТаблицыЗначений - Данные аннотации:
//     * Имя       - Строка          - Имя аннотации.
//     * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//       ** Имя      - Строка - Имя параметра аннотации.
//       ** Значение - Строка - Значение параметра аннотации.
//   ПредставлениеВладельцаАннотации - Строка - Строковое представление типа или объекта
//                                              к которому применяется аннотация.
//
Процедура Проверить(Аннотация, ПредставлениеВладельцаАннотации) Экспорт

СоздатьОбъектАннотации

bsl
// Создать объект класса аннотации по параметрам аннотации.
//
// Параметры:
//   Аннотация - СтрокаТаблицыЗначений - Данные аннотации:
//     * Имя       - Строка          - Имя аннотации.
//     * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//       ** Имя      - Строка - Имя параметра аннотации.
//       ** Значение - Строка - Значение параметра аннотации.
//
// Возвращаемое значение:
//   Произвольный - Объект аннотации с заданными параметрами.
//
Функция СоздатьОбъектАннотации(Аннотация) Экспорт

Завязь

ПриСозданииОбъекта

bsl
// Дата-класс для хранения данных о способе создания жёлудя.
//
// Параметры:
//   Родитель - Сценарий - Класс, содержащий указанный метод завязи.
//   ИмяМетода - Строка - Имя метода, которым можно создать жёлудь.
//   ДанныеМетода - Структура - Данные метода, как из возвращает рефлектор.
//   Действие - Действие - Делегат, который можно вызвать, чтобы создать жёлудь.
//   ЭтоКонструктор - Булево - Флаг, что делегат ведет на конструктор класса, а не на &Завязь-метод.
//
Процедура ПриСозданииОбъекта(Родитель, ИмяМетода, ДанныеМетода, Действие, ЭтоКонструктор)

Родитель

bsl
// Класс, содержащий указанный метод завязи.
//
//  Возвращаемое значение:
//   Сценарий
//
Функция Родитель() Экспорт

ИмяМетода

bsl
// Имя метода, которым можно создать жёлудь.
//
//  Возвращаемое значение:
//   Строка
//
Функция ИмяМетода() Экспорт

ДанныеМетода

bsl
// Данные метода, как из возвращает рефлектор.
//
//  Возвращаемое значение:
//   Структура
//
Функция ДанныеМетода() Экспорт

Действие

bsl
// Делегат, который можно вызвать, чтобы создать жёлудь.
//
//  Возвращаемое значение:
//   Действие
//
Функция Действие() Экспорт

ЭтоКонструктор

bsl
// Флаг, что делегат ведет на конструктор класса, а не на &Завязь-метод.
//
//  Возвращаемое значение:
//   Булево
//
Функция ЭтоКонструктор() Экспорт

ПрилепляемаяЧастица

ПриСозданииОбъекта

bsl
// Описывает зависимость (частицу), которую нужно прилепить к желудю.
//
// Параметры:
//   ТипЧастицы - Строка - Тип частицы, один из значений модуля ТипыПрилепляемыхЧастиц.
//   ИмяЧастицы - Строка - Имя прилепляемой частицы.
//   Аннотация - СтрокаТаблицыЗначений - Аннотация поля или параметра, описывающая частицу:
//    * Имя       - Строка - имя аннотации
//    * Параметры - ТаблицаЗначений - параметры аннотации:
//       ** Имя      - Строка - имя параметра аннотации
//       ** Значение - Строка - значение параметра аннотации
//   БазоваяПрилепляемаяЧастица - ПрилепляемаяЧастица - Базовая частица для коллекций и табакерок. По умолчанию Неопределено.
//
Процедура ПриСозданииОбъекта(ТипЧастицы, ИмяЧастицы, Аннотация, БазоваяПрилепляемаяЧастица = Неопределено)

ТипЧастицы

bsl
// Тип прилепляемой частицы (желудь, деталька, блестяшка или табакерка).
//
//  Возвращаемое значение:
//   Строка - один из типов модуля ТипыПрилепляемыхЧастиц.
//
Функция ТипЧастицы() Экспорт

ИмяЧастицы

bsl
// Имя прилепляемой частицы.
//
//  Возвращаемое значение:
//   Строка
//
Функция ИмяЧастицы() Экспорт

Аннотация

bsl
// Аннотация поля или параметра, описывающая прилепляемую частицу.
//
//  Возвращаемое значение:
//   СтрокаТаблицыЗначений - строка таблицы аннотаций:
//    * Имя       - Строка - имя аннотации
//    * Параметры - ТаблицаЗначений - параметры аннотации:
//       ** Имя      - Строка - имя параметра аннотации
//       ** Значение - Строка - значение параметра аннотации
//
Функция Аннотация() Экспорт

БазоваяПрилепляемаяЧастица

bsl
// Базовая прилепляемая частица, на основе которой построена текущая.
// Используется при прилеплении коллекций и табакерок.
//
//  Возвращаемое значение:
//   ПрилепляемаяЧастица, Неопределено - базовая частица либо Неопределено, если её нет.
//
Функция БазоваяПрилепляемаяЧастица() Экспорт

INFO

Документация из библиотеки annotations.

РаботаСАннотациями

ПолучитьАннотации

bsl
// Получить все аннотации свойства с указанным именем аннотации.
//
// Параметры:
//   Свойство - СтрокаТабличнойЧасти, Структура - Описание свойства/метода:
//	   * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства/метода:
//		   * Имя - Строка - Имя аннотации.
//   ИмяАннотации - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   Массив из СтрокаТабличнойЧасти - Массив найденных аннотаций.
//
Функция ПолучитьАннотации(Свойство, ИмяАннотации)

ПолучитьАннотацию

bsl
// Получить первую аннотацию свойства с указанным именем аннотации.
//
// Параметры:
//   Свойство - СтрокаТабличнойЧасти, Структура - Описание свойства/метода:
//	   * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства/метода:
//		   * Имя - Строка - Имя аннотации.
//   ИмяАннотации - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   СтрокаТабличнойЧасти - Найденная аннотация.
//
Функция ПолучитьАннотацию(Свойство, ИмяАннотации)

НайтиАннотации

bsl
// Получить все аннотации с указанным именем аннотации.
//
// Параметры:
//   Аннотации - ТаблицаЗначений - Таблица аннотаций:
//	   * Имя - Строка - Имя аннотации.
//   ИмяАннотации - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   Массив из СтрокаТабличнойЧасти - Массив найденных аннотаций.
//
Функция НайтиАннотации(Аннотации, ИмяАннотации)

НайтиАннотацию

bsl
// Получить первую аннотацию с указанным именем аннотации.
//
// Параметры:
//   Аннотации - ТаблицаЗначений - Таблица аннотаций:
//	   * Имя - Строка - Имя аннотации.
//   ИмяАннотации - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   СтрокаТабличнойЧасти - Найденная аннотация.
//
Функция НайтиАннотацию(Аннотации, ИмяАннотации)

НайтиМетодыСАннотацией

bsl
// Получить все методы с указанной аннотацией.
//
// Параметры:
//   Методы - ТаблицаЗначений, Массив - Список методов:
//	   * Аннотации - ТаблицаЗначений - Таблица аннотаций метода:
//		   * Имя - Строка - Имя аннотации.
//   ИмяАннотации - Строка - Имя аннотации.
//
//  Возвращаемое значение:
//   Массив из СтрокаТабличнойЧасти - Массив найденных методов.
//
Функция НайтиМетодыСАннотацией(Методы, ИмяАннотации)

ПолучитьПараметрыАннотации

bsl
// Получить параметры аннотации с указанным именем параметра.
//
// Параметры:
//   Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
//	   * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//		   * Имя - Строка - Имя параметра.
//   ИмяПараметра - Строка - Имя параметра.
//
//  Возвращаемое значение:
//   Массив из СтрокаТабличнойЧасти - Массив найденных параметров.
//
Функция ПолучитьПараметрыАннотации(Аннотация, ИмяПараметра)

ПолучитьПараметрАннотации

bsl
// Получить параметр аннотации с указанным именем параметра.
//
// Параметры:
//   Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
//	   * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//		   * Имя - Строка - Имя параметра.
//   ИмяПараметра - Строка - Имя параметра.
//
//  Возвращаемое значение:
//   СтрокаТабличнойЧасти - Найденный параметр.
//
Функция ПолучитьПараметрАннотации(Аннотация, ИмяПараметра)

ПолучитьЗначенияПараметровАннотации

bsl
// Получить значения параметров аннотации с указанным именем параметра.
//
// Параметры:
//   Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
//	   * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//		   * Имя - Строка - Имя параметра.
//         * Значение - Произвольный - Значение параметра.
//   ИмяПараметра - Строка - Имя параметра.
//
//  Возвращаемое значение:
//   Массив из Произвольный - Массив найденных значений параметров.
//
Функция ПолучитьЗначенияПараметровАннотации(Аннотация, ИмяПараметра)

ПолучитьЗначениеПараметраАннотации

bsl
// Получить значение параметра аннотации с указанным именем параметра.
//
// Параметры:
//   Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
//	   * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//		   * Имя - Строка - Имя параметра.
//         * Значение - Произвольный - Значение параметра.
//   ИмяПараметра - Строка - Имя параметра.
//   ЗначениеПоУмолчанию - Произвольный - Значение параметра по умолчанию.
//   НеопределеноЭтоКорректноеЗначениеПараметра - Булево - Признак того,
//                                                         что Неопределено является корректным значением параметра.
//
//  Возвращаемое значение:
//   Произвольный - Значение параметра.
//
Функция ПолучитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра = "Значение", ЗначениеПоУмолчанию = Неопределено, НеопределеноЭтоКорректноеЗначениеПараметра = Ложь)

УстановитьЗначениеПараметраАннотации

bsl
// Установить значение параметра аннотации с указанным именем параметра.
//
// Параметры:
//   Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
//	   * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//		   * Имя - Строка - Имя параметра.
//         * Значение - Произвольный - Значение параметра.
//   ИмяПараметра - Строка - Имя параметра.
//   ЗначениеПараметра - Произвольный - Значение параметра.
//
Процедура УстановитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра, ЗначениеПараметра)

ДобавитьЗначениеПараметраАннотации

bsl
// Добавить ещё одно значение параметра аннотации с указанным именем параметра.
// В отличие от УстановитьЗначениеПараметраАннотации не перезаписывает существующее
// значение, а добавляет новую строку параметра. Используется для повторяемых параметров.
//
// Параметры:
//   Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
//	   * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
//		   * Имя - Строка - Имя параметра.
//         * Значение - Произвольный - Значение параметра.
//   ИмяПараметра - Строка - Имя параметра.
//   ЗначениеПараметра - Произвольный - Значение параметра.
//
Процедура ДобавитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра, ЗначениеПараметра)

ОбработкаНапильникомПластилинаНаПолях

ПриСозданииОбъекта

bsl

Процедура ПриСозданииОбъекта(&Пластилин ПрилепляторЧастиц)

ОбработатьЖелудь

bsl

Функция ОбработатьЖелудь(Желудь, ОпределениеЖелудя) Экспорт

ОбработкаНапильникомФинальныйШтрих

ПриСозданииОбъекта

bsl

Процедура ПриСозданииОбъекта()

ОбработатьЖелудь

bsl

Функция ОбработатьЖелудь(Желудь, ОпределениеЖелудя) Экспорт




ТипыПрилепляемыхЧастиц

Деталька

bsl
// Тип прилепляемой частицы — деталька (значение параметра приложения).
//
//  Возвращаемое значение:
//   Строка
//
Функция Деталька() Экспорт

Желудь

bsl
// Тип прилепляемой частицы — желудь (компонент).
//
//  Возвращаемое значение:
//   Строка
//
Функция Желудь() Экспорт

Блестяшка

bsl
// Тип прилепляемой частицы — блестяшка (произвольное значение, передаваемое извне
// в момент запроса желудя в качестве параметра).
//
//  Возвращаемое значение:
//   Строка
//
Функция Блестяшка() Экспорт

Табакерка

bsl
// Тип прилепляемой частицы — табакерка (отложенное получение частицы).
//
//  Возвращаемое значение:
//   Строка
//
Функция Табакерка() Экспорт

ХарактерыЖелудей

Компанейский

bsl
// Компанейский характер: новый экземпляр желудя создаётся при каждом обращении.
//
//  Возвращаемое значение:
//   Строка
//
Функция Компанейский() Экспорт

Одиночка

bsl
// Характер одиночки: желудь создаётся один раз и переиспользуется при последующих обращениях.
//
//  Возвращаемое значение:
//   Строка
//
Функция Одиночка() Экспорт

ЭтоХарактерЖелудя

bsl
// Проверяет, является ли переданная строка известным характером желудя.
//
// Параметры:
//   Характер - Строка - Проверяемое значение характера.
//
//  Возвращаемое значение:
//   Булево - Истина, если значение является известным характером желудя.
//
Функция ЭтоХарактерЖелудя(Характер) Экспорт

СостоянияПриложения

Инициализация

bsl
// Состояние инициализации приложения: идёт настройка контекста и регистрация желудей.
//
//  Возвращаемое значение:
//   Строка
//
Функция Инициализация() Экспорт

Выполнение

bsl
// Состояние выполнения приложения: контекст настроен, желуди создаются и используются.
//
//  Возвращаемое значение:
//   Строка
//
Функция Выполнение() Экспорт

Значения

bsl
// Возвращает список всех возможных состояний приложения.
//
//  Возвращаемое значение:
//   ФиксированныйМассив из Строка
//
Функция Значения() Экспорт