Автозагрузчик

СОДЕРЖАНИЕ

• ИМЯ
• СИНТАКСИС
• ОПИСАНИЕ
  • Плечи подпрограмм
  • Использование подпрограммы AUTOLOAD автозагрузчика
  • Переопределение подпрограммы AUTOLOAD автозагрузчика
  • Лексические переменные пакета
  • Отключение автозагрузчика
  • Автозагрузчик против Самозагрузчика
  • Принудительная загрузка функции автозагрузчиком
• ОСОБЕННОСТИ
• СМОТРИТЕ ТАКЖЕ
• АВТОР
• АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИЯ

ИМЯ

AutoLoader - загружать подпрограммы только по требованию

СИНТАКСИС

package Foo;
use AutoLoader 'AUTOLOAD';   # import the default AUTOLOAD subroutine

package Bar;
use AutoLoader;              # don't import AUTOLOAD, define our own
sub AUTOLOAD {
    ...
    $AutoLoader::AUTOLOAD = "...";
    goto &AutoLoader::AUTOLOAD;
}

ОПИСАНИЕ

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

Чтобы использовать AutoLoader, автору модуля нужно поместить определения подпрограмм, которые нужно загрузить автоматически, после маркера __END__. (См. perldata.) Модуль AutoSplit затем может быть запущен вручную, чтобы извлечь определения в отдельные файлы auto/funcname.al.

AutoLoader реализует подпрограмму AUTOLOAD. При вызове неопределенной подпрограммы в клиентском модуле AutoLoader, подпрограмма AUTOLOAD AutoLoader пытается найти подпрограмму в файле, имя которого связано с расположением файла, из которого был прочитан клиентский модуль. Например, если POSIX.pm находится в /usr/local/lib/perl5/POSIX.pm, AutoLoader будет искать perl-подпрограммы POSIX в /usr/local/lib/perl5/auto/POSIX/*.al, где файл .al имеет то же имя, что и подпрограмма, без имени пакета. Если такой файл существует, AUTOLOAD прочитает и выполнит его, тем самым (предположительно) определив необходимую подпрограмму. AUTOLOAD затем goto вновь определенную подпрограмму.

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

Плечи подпрограмм

Для правильной работы поиска методов объектов и проверки прототипов даже в том случае, когда методы еще не определены, необходимо «запредельное объявление» каждой подпрограммы (как в sub NAME;). См. "SYNOPSIS" в perlsub. Такое предварительное объявление создаёт «плечи подпрограмм», которые являются заглушками без кода.

Модули AutoSplit и AutoLoader автоматизируют создание предварительных объявлений. Модуль AutoSplit создаёт файл «индекс», содержащий предварительные объявления всех подпрограмм AutoSplit. При «использовании» модуля AutoLoader он загружает эти объявления в пакет своего вызывающего модуля.

Из-за этого механизма важно, чтобы AutoLoader всегда use и не require.

Использование подпрограммы AUTOLOAD автозагрузчика

Для использования подпрограммы AUTOLOAD AutoLoader вы обязательно должны явно импортировать её:

use AutoLoader 'AUTOLOAD';

Переопределение подпрограммы AUTOLOAD автозагрузчика

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

Эти модули не должны импортировать подпрограмму AUTOLOAD AutoLoader. Вместо этого они должны определять свои собственные подпрограммы AUTOLOAD по такому образцу:

use AutoLoader;
use Carp;

sub AUTOLOAD {
    my $sub = $AUTOLOAD;
    (my $constname = $sub) =~ s/.*:://;
    my $val = constant($constname, @_ ? $_[0] : 0);
    if ($! != 0) {
        if ($! =~ /Invalid/ || $!{EINVAL}) {
            $AutoLoader::AUTOLOAD = $sub;
            goto &AutoLoader::AUTOLOAD;
        }
        else {
            croak "Your vendor has not defined constant $constname";
        }
    }
    *$sub = sub { $val }; # same as: eval "sub $sub { $val }";
    goto &$sub;
}

Если собственная подпрограмма AUTOLOAD любого модуля не нуждается в обращении к подпрограмме AUTOLOAD автозагрузчика (потому что у него нет подпрограмм AutoSplit), то этот модуль вообще не должен использовать AutoLoader.

Лексические переменные пакета

Лексические переменные пакета, объявленные с my в основном блоке пакета, использующего AutoLoader, не будут видны загружаемым автоматически подпрограммам из-за того, что данный область видимости заканчивается на метке __END__. Модуль, использующий такие переменные как глобальные переменные пакета, не будет работать должным образом с AutoLoader.

Предикат vars (см. "vars" в perlmod) можно использовать в таких ситуациях в качестве альтернативы явному квалификации всех глобальных переменных с именем пространства имён пакета. Переменные, предварительно объявленные с помощью этого предиката, будут видны любым автоматически загруженным процедурам (но они не будут скрыты вне пакета, к сожалению).

Отключение автозагрузчика

Вы можете прекратить использование AutoLoader, просто

no AutoLoader;

Автозагрузчик против Самозагрузчика

AutoLoader аналогичен по назначению SelfLoader: оба откладывают загрузку подпрограмм.

SelfLoader использует маркер __DATA__ вместо __END__. Хотя это позволяет избежать использования иерархии файлов на диске и связанного с этим открытия/закрытия для каждой загруженной функции, SelfLoader имеет недостаток в скорости запуска из-за одноразового анализа строк после __DATA__, после чего функции кэшируются. SelfLoader также может обрабатывать несколько пакетов в одном файле.

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

Принудительная загрузка функции автозагрузчиком

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

Начиная с AutoLoader 5.73, вы можете вызвать функцию AutoLoader::autoload_sub с полным квалифицированным именем функции, которую нужно загрузить из файла .al. Поведение точно такое же, как если бы вы вызвали функцию, вызвав обычный механизм AUTOLOAD, но фактически не выполняет загруженную автоматически функцию.

ОСОБЕННОСТИ

Автозагрузчики до Perl 5.002 имели немного другой интерфейс. Любые старые модули, использующие AutoLoader, должны быть изменены на новый стиль вызова. Обычно это означает изменение require на use, добавление явного 'AUTOLOAD' импорта, если необходимо, и удаление AutoLoader из @ISA.

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

AutoLoader может не найти файлы autosplit (или даже найти не те файлы) в случаях, когда @INC содержит относительные пути, и программа chdir.

СМОТРИТЕ ТАКЖЕ

Самозагрузчик - автозагрузчик, который не использует внешние файлы.

АВТОР

AutoLoader поддерживается perl5-porters. Пожалуйста, направляйте все вопросы на соответствующий список рассылки. Однако всё, что относится к выпуску CPAN, можно отправлять его основному разработчику.

Автор и разработчик: Perl5-Porters <perl5-porters@perl.org>

Разработчик выпуска CPAN: Steffen Mueller <smueller@cpan.org>

АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИЯ

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

У этого пакета те же авторские права и лицензия, что и у ядра perl:

          Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
     2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
     2011, 2012, 2013
     by Larry Wall and others
 
                         All rights reserved.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of either:
 
     a) the GNU General Public License as published by the Free
     Software Foundation; either version 1, or (at your option) any
     later version, or
 
     b) the "Artistic License" which comes with this Kit.
 
 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 either
 the GNU General Public License or the Artistic License for more details.
 
 You should have received a copy of the Artistic License with this
 Kit, in the file named "Artistic".  If not, I'll be glad to provide one.
 
 You should also have received a copy of the GNU General Public License
 along with this program in the file named "Copying". If not, write to the 
 Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
 MA 02110-1301, USA or visit their web page on the internet at
 http://www.gnu.org/copyleft/gpl.html.
 
 For those of you that choose to use the GNU General Public License,
 my interpretation of the GNU General Public License is that no Perl
 script falls under the terms of the GPL unless you explicitly put
 said script under the terms of the GPL yourself.  Furthermore, any
 object code linked with perl does not automatically fall under the
 terms of the GPL, provided such object code only adds definitions
 of subroutines and variables, and does not otherwise impair the
 resulting interpreter from executing any standard Perl script.  I
 consider linking in C subroutines in this manner to be the moral
 equivalent of defining subroutines in the Perl language itself.  You
 may sell such an object file as proprietary provided that you provide
 or offer to provide the Perl source, as specified by the GNU General
 Public License.  (This is merely an alternate way of specifying input
 to the program.)  You may also sell a binary produced by the dumping of
 a running Perl script that belongs to you, provided that you provide or
 offer to provide the Perl source as specified by the GPL.  (The
 fact that a Perl interpreter and your code are in the same binary file
 is, in this case, a form of mere aggregation.)  This is my interpretation
 of the GPL.  If you still have concerns or difficulties understanding
 my intent, feel free to contact me.  Of course, the Artistic License
 spells all this out for your protection, so you may prefer to use that.