AutoSplit

СОДЕРЖАНИЕ

• ИМЯ
• СИНОПСИС
• ОПИСАНИЕ
  • Несколько пакетов
• ДИАГНОСТИКА
• АВТОР
• АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИЯ

ИМЯ

AutoSplit — разделение пакета для автозагрузки

СИНОПСИС

autosplit($file, $dir, $keep, $check, $modtime);

autosplit_lib_modules(@modules);

ОПИСАНИЕ

Эта функция разделит вашу программу на файлы, которые может обработать модуль AutoLoader. Она используется как стандартными библиотеками Perl, так и утилитой MakeMaker для автоматической настройки библиотек для автозагрузки.

Интерфейс autosplit разделяет указанный файл на иерархию, укоренённую в каталоге $dir. Он создаёт каталоги по мере необходимости, чтобы отразить иерархию классов, и создаёт файл autosplit.ix. Этот файл служит как предварительной объявлением всех процедур пакета, так и отметкой времени последнего обновления иерархии.

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

$keep

Если третий аргумент, $keep, имеет значение false, то все существующие *.al файлы в каталоге автозагрузки удаляются, если они больше не являются частью модуля (устаревшие функции). Значение $keep по умолчанию равно 0.

$check

Четвертый аргумент, $check, инструктирует autosplit проверить модуль, который в данный момент разделяется, чтобы убедиться, что он включает в себя спецификацию use для модуля AutoLoader, и пропустить модуль, если AutoLoader не обнаружен. Значение $check по умолчанию равно 1.

$modtime

Наконец, аргумент $modtime указывает, что autosplit должен проверить время изменения модуля относительно времени изменения файла autosplit.ix, и разделить модуль только в том случае, если он обновлён. Значение $modtime по умолчанию равно 1.

Типичное использование AutoSplit в утилите Perl MakeMaker осуществляется через командную строку:

perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)'

Определённый как макрос Make, он вызывается с аргументами файла и каталога; autosplit разделит указанный файл в указанном каталоге и удалит устаревшие .al файлы, предварительно убедившись, что модуль использует AutoLoader и что модуль ещё не разделен в текущей форме (тест modtime).

Формат autosplit_lib_modules используется при построении perl. Он принимает на вход список файлов (модулей), которые предполагается находиться в каталоге lib относительно текущего каталога. Каждый файл передаётся авторазделителю по одному, чтобы быть разделенным в каталоге lib/auto.

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

Несколько пакетов

Начиная с версии 1.01 модуля AutoSplit, возможно иметь несколько пакетов в одном файле. Обе следующие ситуации поддерживаются:

package NAME;
__END__
sub AAA { ... }
package NAME::option1;
sub BBB { ... }
package NAME::option2;
sub BBB { ... }

package NAME;
__END__
sub AAA { ... }
sub NAME::option1::BBB { ... }
sub NAME::option2::BBB { ... }

ДИАГНОСТИКА

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

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

Предупреждения выдаются, и файл пропускается, если AutoSplit не может найти маркер __END__ или спецификацию типа "package Name;".

AutoSplit также выведет общую диагностику для невозможности создания каталогов или файлов.

АВТОР

AutoSplit поддерживается 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
     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., 59 Temple Place, Suite 330, Boston, MA 
 02111-1307, 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.