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 Имя;».

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

АВТОР

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

Автор и основной разработчик: The 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.