perlintern

СОДЕРЖАНИЕ

• ИМЯ
• ОПИСАНИЕ
• Обработка AV
• Функции обратного вызова
• Приведение типов
• Изменение регистра символов
• Классификация символов
• Информация о компиляторе и препроцессоре
• Директивы компилятора
• Временные крючки области видимости
• Конкурентность
• COPs и хэши подсказок
• Пользовательские операторы
• Обработка CV
• Отладка
• Функции отображения
• Встраивание, потоки и клонирование интерпретатора
• Errno
• Макросы обработки исключений (простые)
• Значения конфигурации файловой системы
• Числа с плавающей точкой
• Общая конфигурация
• Глобальные переменные
• Обработка GV и стеки
• Управление крючками
• Обработка HV
• Вход/выход
• Целые числа
• Форматы В/Вы
• Интерфейс лексического анализатора
• Локали
• Магия
• Управление памятью
• MRO
• Функции multicall
• Числовые функции
• Optrees
• Упаковка и распаковка
• Структуры данных Pad
• Доступ к паролям и группам
• Пути к системным командам
• Информация о прототипах
• Функции REGEXP
• Отчёты и форматы
• Сигналы
• Конфигурация сайта
• Значения конфигурации сокетов
• Фильтры исходного кода
• Макросы манипулирования стеком
• Обработка строк
• Флаги SV
• Обработка SV
• Очистка
• Время
• Имена typedef
• Поддержка Юникода
• Вспомогательные функции
• Версионирование
• Предупреждения и завершение работы
• XS
• Недокументированные элементы
• АВТОРЫ
• СМОТРИТЕ ТАКЖЕ

ИМЯ

perlintern - сгенерированная документация чисто внутренних функций Perl

ОПИСАНИЕ

Этот файл содержит сгенерированную документацию функций интерпретатора Perl, которые документированы с использованием внутреннего формата документации Perl, но не помечены как часть API Perl. Другими словами, они не предназначены для использования в расширениях!

Он содержит те же разделы, что и perlapi, хотя некоторые могут быть пустыми.

Обработка AV

av_fetch_simple

Это сокращенная версия av_fetch, которая предполагает, что массив очень прост - без магии, без только для чтения, и AvREAL - и что key не отрицательно. Эту функцию НЕЛЬЗЯ использовать в ситуациях, где любое из этих предположений может не выполняться.

Возвращает SV по указанному индексу в массиве. key — это индекс. Если lval истинно, вам гарантированно будет возвращен реальный SV (в случае, если он не был реальным ранее), который вы можете затем изменить. Убедитесь, что возвращаемое значение не null, перед обращением к SV*.

Приблизительный эквивалент в Perl: $myarray[$key].

SV**  av_fetch_simple(AV *av, SSize_t key, I32 lval)

AvFILLp

Если массив av пуст, возвращает -1; в противном случае возвращает максимальное значение индексов всех элементов массива, которые в настоящее время определены в av. Он не обрабатывает магию, поэтому в названии есть p.

SSize_t  AvFILLp(AV* av)

av_new_alloc

Это реализация "newAV_alloc_x" в perlapi и "newAV_alloc_xz" в perlapi, которые являются общедоступным API для этой функциональности.

Создаёт новый AV и выделяет его массив SV*.

Это аналогично, но более эффективно, чем:

AV *av = newAV();
av_extend(av, key);

Параметр size используется для предварительного выделения массива SV*, достаточно большого, чтобы вместить как минимум 0..(size-1) элементов. size должно быть не менее 1.

Параметр zeroflag управляет тем, инициализируется ли массив нулевыми значениями.

AV*  av_new_alloc(SSize_t size, bool zeroflag)

av_store_simple

Это сокращенная версия av_store, которая предполагает, что массив очень прост - без магии, без только для чтения, и AvREAL - и что key не отрицательно. Эту функцию НЕЛЬЗЯ использовать в ситуациях, где любое из этих предположений может не выполняться.

Сохраняет SV в массиве. Индекс массива указан как key. Он может быть обращен к получению сохранённого SV*, т.е. (= val)).

Обратите внимание, что вызывающая сторона несёт ответственность за надлежащее увеличение счётчика ссылок val до вызова.

Приблизительный эквивалент в Perl: splice(@myarray, $key, 1, $val).

SV**  av_store_simple(AV *av, SSize_t key, SV *val)

Функции обратного вызова

dowantarray

Реализует устаревшую "GIMME" в perlapi.

U8  dowantarray()

leave_scope

Реализует LEAVE_SCOPE, которую следует использовать вместо неё.

void  leave_scope(I32 base)

pop_scope

Реализует "LEAVE" в perlapi

void  pop_scope()

push_scope

Реализует "ENTER" в perlapi

void  push_scope()

save_adelete

Реализует SAVEADELETE.

void  save_adelete(AV *av, SSize_t key)

save_generic_pvref

Реализует SAVEGENERICPV.

Подобно save_pptr(), но также выполняет Safefree() нового значения, если оно отличается от старого. Может использоваться для восстановления глобального char* до его предыдущего содержимого, освобождая новое значение.

void  save_generic_pvref(char** str)

save_generic_svref

Реализует SAVEGENERICSV.

Подобно save_sptr(), но также выполняет SvREFCNT_dec() нового значения. Может использоваться для восстановления глобального SV до его предыдущего содержимого, освобождая новое значение.

void  save_generic_svref(SV** sptr)

save_hdelete

Реализует SAVEHDELETE.

void  save_hdelete(HV *hv, SV *keysv)

save_hints

Реализует SAVEHINTS.

void  save_hints()

save_op

Реализует SAVEOP.

void  save_op()

save_padsv_and_mortalize

Реализует SAVEPADSVANDMORTALIZE.

void  save_padsv_and_mortalize(PADOFFSET off)

save_set_svflags

Реализует SAVESETSVFLAGS.

Устанавливает указанные в маске SvFLAGS в значениях val.

void  save_set_svflags(SV *sv, U32 mask, U32 val)

save_shared_pvref

Реализует SAVESHAREDPV.

Подобно save_generic_pvref(), но использует PerlMemShared_free() вместо Safefree(). Может использоваться для восстановления глобального char* поделенного доступа до его предыдущего содержимого, освобождая новое значение.

void  save_shared_pvref(char** str)

save_vptr

Реализует SAVEVPTR.

void  save_vptr(void *ptr)

Приведение типов

В настоящее время в Приведении типов есть только общедоступные элементы API.

Изменение регистра символов

В настоящее время в разделе «Изменение регистра символов» есть только общедоступные элементы API.

Классификация символов

В настоящее время в разделе «Классификация символов» есть только общедоступные элементы API.

Информация о компиляторе и препроцессоре

В настоящее время в разделе «Информация о компиляторе и препроцессоре» есть только общедоступные элементы API.

Директивы компилятора

В настоящее время в разделе «Директивы компилятора» есть только общедоступные элементы API.

Временные метки области видимости во время компиляции

BhkENTRY

ПРИМЕЧАНИЕ: BhkENTRY является экспериментальным и может быть изменён или удалён без предварительного уведомления.

Возвращает запись из структуры BHK. which — это препроцессорный токен, указывающий, какую запись вернуть. Если соответствующий флаг не установлен, возвращается NULL. Тип возвращаемого значения зависит от запрашиваемой записи.

void *  BhkENTRY(BHK *hk, which)

BhkFLAGS

ПРИМЕЧАНИЕ: BhkFLAGS является экспериментальным и может быть изменён или удалён без предварительного уведомления.

Возвращает флаги BHK.

U32  BhkFLAGS(BHK *hk)

CALL_BLOCK_HOOKS

ПРИМЕЧАНИЕ: CALL_BLOCK_HOOKS является экспериментальным и может быть изменён или удалён без предварительного уведомления.

Вызывает все зарегистрированные крючки блока для типа which. which — это препроцессорный токен; тип arg зависит от which.

void  CALL_BLOCK_HOOKS(which, arg)

Конкурентность

CVf_SLABBED

CvROOT

CvSTART

Описание в perlguts.

CX_CUR

Описание в perlguts.

CX_CUR()

CXINC

Описание в perlguts.

CX_LEAVE_SCOPE

Описание в perlguts.

void  CX_LEAVE_SCOPE(PERL_CONTEXT* cx)

CX_POP

Описание в perlguts.

void  CX_POP(PERL_CONTEXT* cx)

cxstack

Описание в perlguts.

cxstack_ix

Описание в perlguts.

CXt_BLOCK

CXt_EVAL

CXt_FORMAT

CXt_GIVEN

CXt_LOOP_ARY

CXt_LOOP_LAZYIV

CXt_LOOP_LAZYSV

CXt_LOOP_LIST

CXt_LOOP_PLAIN

CXt_NULL

CXt_SUB

CXt_SUBST

CXt_WHEN

Описание в perlguts.

cx_type

Описание в perlguts.

dounwind

Описание в perlguts.

void  dounwind(I32 cxix)

my_fork

Это для использования PerlProc_fork в качестве оболочки для функции C-библиотеки fork(2) на некоторых платформах, чтобы скрыть некоторые особенности платформ. Не следует использовать иначе, чем через PerlProc_fork.

Pid_t  my_fork()

PERL_CONTEXT

Описание в perlguts.

COP-ы и хэши подсказок

В настоящее время в COP-ах и хэшах подсказок есть только элементы публичного API.

Пользовательские операторы

core_prototype

Эта функция назначает прототип указанной ядра функции sv, или новому смертному SV, если sv является NULL. Она возвращает изменённый sv, или NULL, если у ядра функции нет прототипа. code — это код, возвращённый keyword(). Он не должен быть равен 0.

SV *  core_prototype(SV *sv, const char *name, const int code,
                     int * const opnum)

Обработка CV

CvWEAKOUTSIDE

Каждый CV имеет указатель CvOUTSIDE() на свой лексически окружающий CV (если таковой имеется). Поскольку указатели на прототипы анонимных подпрограмм хранятся в падах слотов &, возможно возникновение циклической ссылки, где родитель указывает на ребёнка, а ребёнок — на родителя. Для предотвращения утечки памяти мы не увеличиваем счётчик ссылок CV, на который указывает CvOUTSIDE в конкретном случае, когда родитель имеет паду слот & пада, указывающий на нас. В этом случае мы устанавливаем флаг CvWEAKOUTSIDE в ребёнке. Это позволяет определить, в каких условиях следует уменьшить счётчик ссылок родителя при освобождении ребёнка.

Существует дополнительная проблема с анонимными подпрограммами, которые не являются замыканиями (т.е. которые не ссылаются на какие-либо лексические переменные вне этой подпрограммы). В этом случае анонимный прототип разделяются, а не клонируются. Это означает, что родитель может быть освобождён, в то время как активны дочерние элементы, например,

BEGIN { $a = sub { eval '$x' } }

В этом случае BEGIN освобождается сразу после выполнения, поскольку активных ссылок на него нет: анонимный прототип имеет CvWEAKOUTSIDE установленным, поскольку он не является замыканием, и $a указывает на тот же CV, поэтому он тоже не влияет на счётчик ссылок BEGIN. Когда выполняется $a, eval '$x' вызывает следование цепочки CvOUTSIDE, и освобождённый BEGIN доступен.

Чтобы избежать этого, всякий раз, когда CV и его связанный пада освобождаются, все элементы & в паде явно удаляются из пада, и если счётчик ссылок указанного анонимного подпрограммы всё ещё положителен, то CvOUTSIDE ребёнка устанавливается так, чтобы указывать на его прародителя. Это произойдёт только в единственном случае с анонимным прототипом, не являющимся замыканием, который имеет одну или несколько активных ссылок (например, $a выше).

Ещё одна вещь, которую следует учитывать, заключается в том, что CV может быть просто не определён, а не освобождён, например undef &foo. В этом случае его счётчик ссылок может не достичь нуля, но мы всё равно удаляем его пада и CvROOT и т.д. Поскольку у различных детей могут остаться CvOUTSIDE, указывающие на этот неопределённый CV, мы сохраняем его CvOUTSIDE на время, чтобы цепочка лексических областей видимости оставалась неразрывной. Например, следующее должно вывести 123:

my $x = 123;
sub tmp { sub { eval '$x' } }
my $a = tmp();
undef &tmp;
print  $a->();

bool  CvWEAKOUTSIDE(CV *cv)

docatch

Проверяет случаи 0 или 3 cur_env.je_ret, используется только внутри контекста eval.

0 используется как продолжение внутри eval,

3 используется для отлова ошибки, пойманной внутренним eval — продолжить внутренний цикл

См. cop.h: je_mustcatch, когда в любом уровне выполнения установлено в TRUE, означает, что операции eval должны установить локальный jmpenv для обработки ловушек исключений.

OP*  docatch(Perl_ppaddr_t firstpp)

Отладка

_aDEPTH

Некоторые функции при компиляции с отладкой принимают дополнительный заключительный аргумент с именем depth, указывающий глубину стека C. Этот аргумент опускается в противном случае. Этот макрос расширяется либо до , depth при отладке, либо до пустого значения, если отладка не включена, уменьшая количество #ifdef в коде.

Программа отвечает за поддержание правильного значения для depth.

_aDEPTH

debop

Реализует опцию командной строки perl -Dt на OP o.

I32  debop(const OP* o)

debprof

Вызывается, чтобы указать, что o было выполнено в целях профилирования в соответствии с параметром командной строки -DP.

void  debprof(const OP *o)

debprofdump

Выводит содержимое данных, собранных с помощью параметра командной строки perl -DP.

void  debprofdump()

free_c_backtrace

Освобождает стек вызовов, полученный из get_c_backtrace.

void  free_c_backtrace(Perl_c_backtrace* bt)

get_c_backtrace

Собирает стек вызовов (также известный как «стек») в единый линейный буфер, выделенный с помощью malloc, который вызывающая сторона должна Perl_free_c_backtrace().

Сканирует кадры назад на depth + skip, затем отбрасывает skip самый внутренний, возвращая не более depth кадров.

Perl_c_backtrace*  get_c_backtrace(int max_depth, int skip)

_pDEPTH

Используется в объявлениях прототипов функций, которые принимают заключительный параметр "_aDEPTH", аналогично тому, как pTHX_ используется в функциях, которые принимают начальный параметр контекста потока.

PL_DBsingle

Когда Perl запускается в режиме отладки с ключом -d, этот SV представляет собой булево значение, указывающее, выполняются ли подпрограммы пошагово. Пошаговое выполнение автоматически включается после каждой итерации. Это переменная C, соответствующая переменной Perl $DB::single. См. "PL_DBsub".

В многопоточных Perl-интерпретаторах каждый поток имеет независимую копию этой переменной; каждая инициализируется при создании значением из копии создающего потока.

SV *  PL_DBsingle

PL_DBsub

Когда Perl запускается в режиме отладки с ключом -d, этот GV содержит SV, который содержит имя подпрограммы, отлаживаемой в настоящее время. Это переменная C, соответствующая переменной Perl $DB::sub. См. "PL_DBsingle".

В многопоточных Perl-интерпретаторах каждый поток имеет независимую копию этой переменной; каждая инициализируется при создании значением из копии создающего потока.

GV *  PL_DBsub

PL_DBtrace

Переменная трассировки, используемая, когда Perl запускается в режиме отладки с ключом -d. Это переменная C, соответствующая переменной Perl $DB::trace. См. "PL_DBsingle".

В многопоточных Perl-интерпретаторах каждый поток имеет независимую копию этой переменной; каждая инициализируется при создании значением из копии создающего потока.

SV *  PL_DBtrace

runops_debug

Описание в perlguts.

int  runops_debug()

runops_standard

Описание в perlguts.

int  runops_standard()

Функции отображения

sv_peek

Реализует SvPEEK

char*  sv_peek(SV* sv)

Встраивание, потоки и клонирование интерпретатора

cv_dump

Вывести содержимое CV

void  cv_dump(const CV *cv, const char *title)

cv_forget_slab

Когда CV имеет счётчик ссылок на своём блоке (CvSLABBED), он отвечает за его освобождение. (Следовательно, два CV не должны иметь счётчик ссылок на один и тот же блок). CV должен ссылаться на блок только во время компиляции. После компиляции и прикрепления CvROOT, его задача завершена, поэтому он может забыть блок.

void  cv_forget_slab(CV *cv)

do_dump_pad

Вывести содержимое списка подузлов

void  do_dump_pad(I32 level, PerlIO *file, PADLIST *padlist,
                  int full)

get_context

Реализует "PERL_GET_CONTEXT" в perlapi, который следует использовать вместо него.

void*  get_context()

pad_alloc_name

Выделяет место в текущем компилируемом подузле (через "pad_alloc" в perlapi) и затем сохраняет имя для этой записи. name принимается и становится именем записи; он должен уже содержать строку имени. typestash и ourstash и флаг padadd_STATE добавляются к name. Никакая другая обработка "pad_add_name_pvn" в perlapi не выполняется. Возвращает смещение выделенного слота подузла.

PADOFFSET  pad_alloc_name(PADNAME *name, U32 flags, HV *typestash,
                          HV *ourstash)

pad_block_start

Обновить переменные состояния компиляции подузла при входе в новый блок.

void  pad_block_start(int full)

pad_check_dup

Проверка на дубликаты объявлений: сообщает о любом из следующих:

* a 'my' in the current scope with the same name;
* an 'our' (anywhere in the pad) with the same name and the
  same stash as 'ourstash'

is_our указывает, что проверяемое имя является объявлением "our".

void  pad_check_dup(PADNAME *name, U32 flags, const HV *ourstash)

pad_findlex

Найти именованный лексический элемент где-либо в цепочке вложенных подузлов. Добавить фейковые записи во внутренние подузлы, если он найден во внешнем.

Возвращает смещение в нижнем подузле lex или фейкового lex. cv — CV, в котором следует начать поиск, а seq — текущий cop_seq для сопоставления. Если warn истинно, вывести соответствующие предупреждения. Переменные out_* возвращают значения и, следовательно, являются указателями на место, где должны храниться возвращаемые значения. out_capture, если не равен нулю, запрашивает захват внутреннего экземпляра лексического элемента; out_name устанавливается во имя внутреннего сопоставленного подузла или фейкового имени подузла; out_flags возвращает флаги, обычно связанные с полем PARENT_FAKELEX_FLAGS фейкового имени подузла.

Обратите внимание, что pad_findlex() рекурсивный; он рекурсивно проходит вверх по цепочке CV, затем возвращается вниз, добавляя фейковые записи по ходу. Это необходимо, потому что фейковые имена в анонимных прототипах должны хранить в xpadn_low индекс в родительском подузле.

PADOFFSET  pad_findlex(const char *namepv, STRLEN namelen,
                       U32 flags, const CV* cv, U32 seq, int warn,
                       SV** out_capture, PADNAME** out_name,
                       int *out_flags)

pad_fixup_inner_anons

Для любых анонимных CV в подузле изменить CvOUTSIDE этого CV с old_cv на new_cv при необходимости. Необходимо, когда новый скомпилированный CV должен быть перемещен в существующую структуру CV.

void  pad_fixup_inner_anons(PADLIST *padlist, CV *old_cv,
                            CV *new_cv)

pad_free

Освободить SV по смещению po в текущем подузле.

void  pad_free(PADOFFSET po)

pad_leavemy

Очистка в конце области видимости во время компиляции: установить максимальное значение seq для лексических элементов в этом объеме и вывести предупреждение о любых лексических элементах, которые никогда не были введены.

OP *  pad_leavemy()

padlist_dup

Создать дубликат подузла.

PADLIST *  padlist_dup(PADLIST *srcpad, CLONE_PARAMS *param)

padname_dup

Создать дубликат имени подузла.

PADNAME *  padname_dup(PADNAME *src, CLONE_PARAMS *param)

padnamelist_dup

Создать дубликат списка имён подузлов.

PADNAMELIST *  padnamelist_dup(PADNAMELIST *srcpad,
                               CLONE_PARAMS *param)

pad_push

Добавить новую рамку подузла в список подузлов, если в этом уровне глубины уже есть подузел, не создавайте новый. Затем присвойте новому подузлу @_ в слот ноль.

void  pad_push(PADLIST *padlist, int depth)

pad_reset

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

void  pad_reset()

pad_setsv

Установить значение по смещению po в текущем (компилируемом или выполняемом) подузле. Используйте макрос PAD_SETSV(), а не вызов этой функции напрямую.

void  pad_setsv(PADOFFSET po, SV* sv)

pad_sv

Получить значение по смещению po в текущем (компилируемом или выполняемом) подузле. Используйте макрос PAD_SV вместо прямого вызова этой функции.

SV*  pad_sv(PADOFFSET po)

pad_swipe

Отказаться от временной переменной в текущем подузле по смещению po и заменить её новой.

void  pad_swipe(PADOFFSET po, bool refadjust)

set_context

Реализует "PERL_SET_CONTEXT" в perlapi, который следует использовать вместо него.

void  set_context(void *t)

Errno

dSAVEDERRNO

Объявить переменные, необходимые для сохранения errno и любого операционной системы ошибки.

void  dSAVEDERRNO

dSAVE_ERRNO

Объявить переменные, необходимые для сохранения errno и любой ошибки операционной системы, и сохранить их для возможного последующего восстановления функцией RESTORE_ERRNO.

void  dSAVE_ERRNO

RESTORE_ERRNO

Восстановить errno и любую ошибку операционной системы, сохранённую функциями dSAVE_ERRNO или RESTORE_ERRNO.

void  RESTORE_ERRNO

SAVE_ERRNO

Сохранить errno и любую ошибку операционной системы для возможного последующего восстановления функцией RESTORE_ERRNO. Требует наличия dSAVEDERRNO или dSAVE_ERRNO в области видимости.

void  SAVE_ERRNO

SETERRNO

Установить errno, и на VMS установить vaxc$errno.

void  SETERRNO(int errcode, int vmserrcode)

Обработка исключений (простые) макросы

В данный момент в Обработке исключений (простые) макросы есть только элементы публичного API.

Значения конфигурации файловой системы

В данный момент в Значения конфигурации файловой системы есть только элементы публичного API.

Числа с плавающей точкой

В данный момент в Числа с плавающей точкой есть только элементы публичного API.

Общая конфигурация

В данный момент в Общей конфигурации есть только элементы публичного API.

Глобальные переменные

В данный момент в Глобальных переменных есть только элементы публичного API.

Обработка GV и стеки

gp_dup

Создать дубликат typeglob, вернув указатель на скопированный объект.

GP*  gp_dup(GP *const gp, CLONE_PARAMS *const param)

gv_handler

Реализует StashHANDLER, который следует использовать вместо него.

CV*  gv_handler(HV* stash, I32 id)

gv_stashsvpvn_cached

Возвращает указатель на стеки для указанного пакета, возможно, из кеша. Реализует как "gv_stashpvn" в perlapi, так и "gv_stashsv" в perlapi.

Требуется, чтобы один из namesv или namepv не был равен нулю.

Если флаг GV_CACHE_ONLY установлен, вернуть стеки только если они найдены в кеше; см. "gv_stashpvn" в perlapi для подробностей об остальных flags.

Обратите внимание, что для повышения производительности рекомендуется, чтобы namesv не был равен нулю.

HV*  gv_stashsvpvn_cached(SV *namesv, const char* name,
                          U32 namelen, I32 flags)

gv_try_downgrade

ПРИМЕЧАНИЕ: gv_try_downgrade является экспериментальным и может быть изменён или удалён без предварительного уведомления.

Если typeglob gv может быть выражен более лаконично, с чем-то другим, кроме реального GV, на его месте в стеке, заменить его оптимизированной формой. Основные требования к этому — gv это реальный typeglob, достаточно обычный и упоминается только из своего пакета. Эта функция предназначена для использования, когда GV был просмотрен частично, чтобы посмотреть, что там было, вызывая апгрейд, но по результатам оказалось, что реальный GV всё же не нужен.

Если gv полностью пустой typeglob, он удаляется из стека.

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

void  gv_try_downgrade(GV* gv)

Управление хуками

В данный момент в Управлении хуками есть только элементы публичного API.

Обработка HV

hv_eiter_p

Реализует HvEITER, который следует использовать вместо него.

ПРИМЕЧАНИЕ: hv_eiter_p должен быть явно вызван как Perl_hv_eiter_p с параметром aTHX_.

HE**  Perl_hv_eiter_p(pTHX_ HV *hv)

hv_eiter_set

Реализует HvEITER_set, который следует использовать вместо него.

ПРИМЕЧАНИЕ: hv_eiter_set должен быть явно вызван как Perl_hv_eiter_set с параметром aTHX_.

void  Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter)

hv_ename_add

Добавляет имя во внутренний список эффективных имён стека. См. "hv_ename_delete".

Вызывается, когда стеку присваивается новое место в таблице символов.

void  hv_ename_add(HV *hv, const char *name, U32 len, U32 flags)

hv_ename_delete

Удаляет имя из внутреннего списка эффективных имён стека. Если это имя, возвращённое HvENAME, то другое имя в списке займет его место (HvENAME будет его использовать).

Вызывается при удалении стека из таблицы символов.

void  hv_ename_delete(HV *hv, const char *name, U32 len,
                      U32 flags)

hv_fill

Возвращает количество используемых в настоящий момент корзин хеш-таблицы.

Эта функция реализует макрос HvFILL, который следует использовать вместо неё.

Начиная с Perl 5.25, эта функция используется только для отладки, и количество используемых корзин хеш-таблицы никак не кэшируется, поэтому выполнение этой функции может быть дорогостоящим, поскольку она должна перебрать все корзины в хеше.

ПРИМЕЧАНИЕ: hv_fill должен быть явно вызван как Perl_hv_fill с параметром aTHX_.

STRLEN  Perl_hv_fill(pTHX_ HV *const hv)

hv_placeholders_get

Реализует HvPLACEHOLDERS_get, который следует использовать вместо него.

ПРИМЕЧАНИЕ: hv_placeholders_get должен быть явно вызван как Perl_hv_placeholders_get с параметром aTHX_.

I32  Perl_hv_placeholders_get(pTHX_ const HV *hv)

hv_placeholders_set

Реализует HvPLACEHOLDERS_set, который следует использовать вместо него.

ПРИМЕЧАНИЕ: hv_placeholders_set должен быть явно вызван как Perl_hv_placeholders_set с параметром aTHX_.

void  Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)

hv_riter_p

Реализует HvRITER, который следует использовать вместо него.

ПРИМЕЧАНИЕ: hv_riter_p должен быть явно вызван как Perl_hv_riter_p с параметром aTHX_.

I32*  Perl_hv_riter_p(pTHX_ HV *hv)

hv_riter_set

Реализует HvRITER_set, которую следует использовать вместо неё.

ПРИМЕЧАНИЕ: hv_riter_set необходимо явно вызвать как Perl_hv_riter_set с параметром aTHX_.

void  Perl_hv_riter_set(pTHX_ HV *hv, I32 riter)

refcounted_he_chain_2hv

Генерирует и возвращает HV *, представляющий содержимое цепочки refcounted_he. flags в настоящее время не используется и должно быть равно нулю.

HV *  refcounted_he_chain_2hv(const struct refcounted_he *c,
                              U32 flags)

refcounted_he_fetch_pv

Аналогично "refcounted_he_fetch_pvn", но принимает строку с завершением нулём вместо пары строка/длина.

SV *  refcounted_he_fetch_pv(const struct refcounted_he *chain,
                             const char *key, U32 hash, U32 flags)

refcounted_he_fetch_pvn

Ищет в цепочке refcounted_he элемент с ключом, заданным keypv и keylen. Если у flags установлен бит REFCOUNTED_HE_KEY_UTF8, байты ключа интерпретируются как UTF-8, в противном случае — как Latin-1. hash — предварительно вычисленный хэш строки ключа, или ноль, если он не был предварительно вычислен. Возвращает смертный скаляр, представляющий значение, связанное с ключом, или &PL_sv_placeholder, если значение для ключа не найдено.

SV *  refcounted_he_fetch_pvn(const struct refcounted_he *chain,
                              const char *keypv, STRLEN keylen,
                              U32 hash, U32 flags)

refcounted_he_fetch_pvs

Аналогично "refcounted_he_fetch_pvn", но принимает строку напрямую, а не пару строка/длина, и не использует предварительно вычисленный хэш.

SV *  refcounted_he_fetch_pvs(const struct refcounted_he *chain,
                              "key", U32 flags)

refcounted_he_fetch_sv

Аналогично "refcounted_he_fetch_pvn", но принимает Perl-скаляр вместо пары строка/длина.

SV *  refcounted_he_fetch_sv(const struct refcounted_he *chain,
                             SV *key, U32 hash, U32 flags)

refcounted_he_free

Уменьшает счётчик ссылок на refcounted_he на единицу. Если счётчик ссылок достигнет нуля, память структуры освобождается, что (рекурсивно) приводит к уменьшению счётчика ссылок родительской refcounted_he. Безопасно передавать нулевой указатель в эту функцию: в этом случае никаких действий не происходит.

void  refcounted_he_free(struct refcounted_he *he)

refcounted_he_inc

Увеличивает счётчик ссылок на refcounted_he. Указатель на refcounted_he также возвращается. Безопасно передавать нулевой указатель в эту функцию: никаких действий не происходит и возвращается нулевой указатель.

struct refcounted_he *  refcounted_he_inc(
                                         struct refcounted_he *he)

refcounted_he_new_pv

Аналогично "refcounted_he_new_pvn", но принимает строку с завершением нулём вместо пары строка/длина.

struct refcounted_he *  refcounted_he_new_pv(
                                     struct refcounted_he *parent,
                                     const char *key, U32 hash,
                                     SV *value, U32 flags)

refcounted_he_new_pvn

Создаёт новую refcounted_he. Она состоит из одной пары ключ/значение и ссылки на существующую цепочку refcounted_he (которая может быть пустой) и, таким образом, образует более длинную цепочку. При использовании более длинной цепочки новая пара ключ/значение имеет приоритет над любой записью для того же ключа, которая находится далее в цепочке.

Новый ключ задаётся keypv и keylen. Если у flags установлен бит REFCOUNTED_HE_KEY_UTF8, байты ключа интерпретируются как UTF-8, в противном случае — как Latin-1. hash — предварительно вычисленный хэш строки ключа, или ноль, если он не был предварительно вычислен.

value — скалярное значение, которое нужно сохранить для этого ключа. value копируется этой функцией, которая, таким образом, не берёт на себя владение ссылкой на него, и последующие изменения скаляра не будут отражены в значении, видимом в refcounted_he. Сложные типы скаляров не будут храниться с целостностью ссылок, а будут преобразованы в строки. value может быть либо нулём, либо &PL_sv_placeholder, чтобы указать, что с ключом не должно быть связано никакого значения; это, как и любое ненулевое значение, имеет приоритет над существованием значения для ключа, расположенного далее в цепочке.

parent указывает на остальную часть цепочки refcounted_he, которая должна быть присоединена к новой refcounted_he. Функция берёт на себя владение одной ссылкой на parent, и возвращает одну ссылку на новую refcounted_he.

struct refcounted_he *  refcounted_he_new_pvn(
                                     struct refcounted_he *parent,
                                     const char *keypv,
                                     STRLEN keylen, U32 hash,
                                     SV *value, U32 flags)

refcounted_he_new_pvs

Аналогично "refcounted_he_new_pvn", но принимает строку напрямую, а не пару строка/длина, и не использует предварительно вычисленный хэш.

struct refcounted_he *  refcounted_he_new_pvs(
                                     struct refcounted_he *parent,
                                     "key", SV *value, U32 flags)

refcounted_he_new_sv

Аналогично "refcounted_he_new_pvn", но принимает Perl-скаляр вместо пары строка/длина.

struct refcounted_he *  refcounted_he_new_sv(
                                     struct refcounted_he *parent,
                                     SV *key, U32 hash, SV *value,
                                     U32 flags)

unsharepvn

Если никто не имеет доступа к общей строке str длиной len, освободить её.

len и hash должны быть действительными для str.

void  unsharepvn(const char* sv, I32 len, U32 hash)

Ввод/Вывод

dirp_dup

Дублирует дескриптор каталога, возвращая указатель на клонированный объект.

DIR*  dirp_dup(DIR *const dp, CLONE_PARAMS *const param)

fp_dup

Дублирует дескриптор файла, возвращая указатель на клонированный объект.

PerlIO*  fp_dup(PerlIO *const fp, const char type,
                CLONE_PARAMS *const param)

my_fflush_all

Реализует PERL_FLUSHALL_FOR_CHILD на некоторых платформах.

I32  my_fflush_all()

my_mkostemp

Функция C-библиотеки mkostemp(3), если доступна, или Perl-реализация.

ПРИМЕЧАНИЕ: my_mkostemp необходимо явно вызвать как Perl_my_mkostemp.

int  Perl_my_mkostemp(char *templte, int flags)

my_mkstemp

Функция C-библиотеки mkstemp(3), если доступна, или Perl-реализация.

ПРИМЕЧАНИЕ: my_mkstemp необходимо явно вызвать как Perl_my_mkstemp.

int  Perl_my_mkstemp(char *templte)

PL_last_in_gv

GV, который был последним использован для операции ввода из файла. (<FH>)

В многопоточных Perl, каждый поток имеет независимую копию этой переменной; каждая инициализируется при создании текущим значением копии переменной создающего потока.

GV*  PL_last_in_gv

PL_ofsgv

Глобальная переменная, содержащая разделитель выходного поля — *, в пространстве Perl.

В многопоточных Perl, каждый поток имеет независимую копию этой переменной; каждая инициализируется при создании текущим значением копии переменной создающего потока.

GV*  PL_ofsgv

PL_rs

Разделитель записей ввода — $/ в пространстве Perl.

В многопоточных Perl, каждый поток имеет независимую копию этой переменной; каждая инициализируется при создании текущим значением копии переменной создающего потока.

SV*  PL_rs

start_glob

ПРИМЕЧАНИЕ: start_glob — экспериментальная функция и может быть изменена или удалена без предварительного уведомления.

Функция, вызываемая do_readline для создания глобального объекта (или выполнения глобального поиска внутри Perl на VMS). Этот код раньше был встроенным, но теперь Perl использует File::Glob. Этот инициализатор глобального объекта используется только miniperl во время процесса сборки или когда определён PERL_EXTERNAL_GLOB. Перенос его уменьшает размер pp_hot.c, что помогает ускорить Perl.

ПРИМЕЧАНИЕ: start_glob необходимо явно вызвать как Perl_start_glob с параметром aTHX_.

PerlIO*  Perl_start_glob(pTHX_ SV *tmpglob, IO *io)

Целые числа

В настоящее время в разделе Целые числа нет элементов публичного API.

Форматы ввода/вывода

В настоящее время в разделе Форматы ввода/вывода нет элементов публичного API.

Интерфейс лексического анализатора

validate_proto

ПРИМЕЧАНИЕ: validate_proto — экспериментальная функция и может быть изменена или удалена без предварительного уведомления.

Эта функция выполняет синтаксическую проверку прототипа proto. Если warn истинно, любые недопустимые символы или несовпадающие скобки приведут к предупреждению illegalproto, объявляя, что они были обнаружены в прототипе для name.

Значение возврата — true если это действительный прототип, и false если нет, независимо от того, было ли warn true или false.

Обратите внимание, что NULL является корректным proto и всегда возвращает true.

bool  validate_proto(SV *name, SV *proto, bool warn,
                     bool curstash)

Локали

В настоящее время в разделе Локали нет элементов публичного API.

Магия

magic_clearhint

Вызывается при удалении из %^H, записывает ключ в PL_compiling.cop_hints_hash.

int  magic_clearhint(SV* sv, MAGIC* mg)

magic_clearhints

Вызывается при очистке %^H, сбрасывает PL_compiling.cop_hints_hash.

int  magic_clearhints(SV* sv, MAGIC* mg)

magic_methcall

Вызывает магический метод (например, FETCH).

sv и mg — связанный объект и магические свойства связи.

meth — имя метода для вызова.

argc — количество аргументов (кроме $self) для передачи методу.

flags может быть:

G_DISCARD     invoke method with G_DISCARD flag and don't
              return a value
G_UNDEF_FILL  fill the stack with argc pointers to
              PL_sv_undef

Аргументы сами по себе — любые значения после аргумента flags.

Возвращает SV (если есть) возвращённый методом или NULL в случае ошибки.

ПРИМЕЧАНИЕ: magic_methcall необходимо явно вызвать как Perl_magic_methcall с параметром aTHX_.

SV*  Perl_magic_methcall(pTHX_ SV *sv, const MAGIC *mg, SV *meth,
                         U32 flags, U32 argc, ...)

magic_sethint

Вызывается при записи в %^H, записывает пару ключ/значение в PL_compiling.cop_hints_hash. Предполагается, что значения подсказок не хранят ничего, что требовало бы глубокой копии. Возможно, стоит выводить предупреждение, если обнаружим ссылку.

int  magic_sethint(SV* sv, MAGIC* mg)

mg_dup

Дублирует цепочку магических свойств, возвращая указатель на клонированный объект.

MAGIC*  mg_dup(MAGIC *mg, CLONE_PARAMS *const param)

mg_localize

Копирует некоторые магические свойства из существующего SV в новую локализованную версию этого SV. Магия контейнеров (например, %ENV, $1, tie) копируется, а магия значения — нет (например, taint, pos).

Если setmagic ложно, то никакие магические свойства установки не будут вызваны на новом (пустом) SV. Это обычно означает, что вскоре последует присвоение (например, 'local $x = $y'), и оно обработает магические свойства.

void  mg_localize(SV* sv, SV* nsv, bool setmagic)

si_dup

Дублирует структуру информации стека, возвращая указатель на клонированный объект.

PERL_SI*  si_dup(PERL_SI* si, CLONE_PARAMS* param)

ss_dup

Дублирует стек сохранения, возвращая указатель на клонированный объект.

ANY*  ss_dup(PerlInterpreter* proto_perl, CLONE_PARAMS* param)

Управление памятью

calloc

Реализует "Newxz" в perlapi, который следует использовать вместо него.

ПРИМЕЧАНИЕ: calloc необходимо явно вызвать как Perl_calloc .

Malloc_t  Perl_calloc(MEM_SIZE elements, MEM_SIZE size)

malloc

Реализует "Newx" в perlapi, который следует использовать вместо него.

ПРИМЕЧАНИЕ: malloc необходимо явно вызвать как Perl_malloc .

Malloc_t  Perl_malloc(MEM_SIZE nbytes)

mfree

Реализует "Safefree" в perlapi, который следует использовать вместо него.

ПРИМЕЧАНИЕ: mfree необходимо явно вызвать как Perl_mfree .

Free_t  Perl_mfree(Malloc_t where)

realloc

Реализует "Renew" в perlapi, который следует использовать вместо него.

ПРИМЕЧАНИЕ: realloc необходимо явно вызвать как Perl_realloc .

Malloc_t  Perl_realloc(Malloc_t where, MEM_SIZE nbytes)

MRO

mro_get_linear_isa_dfs

Возвращает линейную итерацию по всем прямым предкам @ISA данного хранилища. Результат - неизменяемый AV*. level должно быть 0 (используется во внутренней рекурсии этой функции).

Вы несете ответственность за SvREFCNT_inc() возвращаемого значения, если планируете сохранить его где-либо (иначе оно может быть удалено при следующем обновлении кэша).

AV*  mro_get_linear_isa_dfs(HV* stash, U32 level)

mro_isa_changed_in

Выполняет необходимые действия (преимущественно, обновления кэша) при изменении @ISA заданного пакета. Вызывается магией setisa, напрямую вызывать не требуется.

void  mro_isa_changed_in(HV* stash)

mro_package_moved

Вызовите эту функцию, чтобы указать хранилищу, что оно было перемещено в другое место в иерархии. stash - это хранилище, которое было перемещено. oldstash - это хранилище, которое оно заменяет (если таковое имеется). gv - это глоб, к которому действительно происходит присвоение.

Также можно вызвать с нулевым первым аргументом, чтобы указать, что oldstash было удалено.

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

Также устанавливает эффективные имена (HvENAME) для всех хранилищ.

Если gv присутствует, но отсутствует в таблице символов, функция просто возвращает значение. Проверка пропускается, если flags & 1.

void  mro_package_moved(HV * const stash, HV * const oldstash,
                        const GV * const gv, U32 flags)

Функции Multicall

В данный момент в Функциях Multicall присутствуют только элементы публичного API.

Числовые функции

isinfnansv

Проверяет, является ли аргумент бесконечностью или NaN при использовании в качестве числа, но при этом не вызывает предупреждений о нечисловых значениях или неинициализированных переменных. Предполагается, что вызывающий код уже выполнил SvGETMAGIC(sv).

Обратите внимание, что функция всегда принимает конечные незначащие символы (аналогично grok_number_flags с PERL_SCAN_TRAILING), поэтому "inferior" и "NAND gates" вернут true.

bool  isinfnansv(SV *sv)

Optrees

finalize_optree

Эта функция завершает построение optree. Необходимо вызывать её сразу после завершения построения optree. Она выполняет дополнительную проверку, которую невозможно выполнить в обычных функциях ck_xxx, и делает дерево потокобезопасным.

void  finalize_optree(OP* o)

newATTRSUB_x

Создаёт подпрограмму Perl, также выполняя некоторые вспомогательные задачи.

Ожидается, что эта функция будет вызываться в контексте компиляции Perl, и некоторые аспекты подпрограммы берутся из глобальных переменных, связанных с компиляцией. В частности, PL_compcv представляет подпрограмму, которая в данный момент компилируется. Она не должна быть нулевой при вызове этой функции, и некоторые аспекты создаваемой подпрограммы берутся из неё. Создаваемая подпрограмма может быть фактически повторным использованием объекта PL_compcv, но необязательно.

Если block равно null, подпрограмма не будет иметь тела, и на данный момент её вызов будет ошибкой. Это соответствует объявлению подпрограммы вперёд, например, sub foo ($$);. Если block не равно null, оно предоставляет код Perl для тела подпрограммы, который будет выполняться при её вызове. Это тело включает в себя любой код разворачивания аргументов, полученный из подписи подпрограммы или аналогичного. Использование стека в коде должно соответствовать стеку, прикреплённому к PL_compcv. Не ожидается, что код будет содержать оператор leavesub или leavesublv; эта функция добавит такой оператор. block используется этой функцией и станет частью созданной подпрограммы.

proto указывает прототип подпрограммы, если он не задан как атрибут (см. ниже). Если proto равно null, подпрограмма не будет иметь прототипа. Если proto не равно null, оно должно указывать на оператор const, значение которого является строкой, и подпрограмма будет иметь эту строку в качестве прототипа. Если прототип задан как атрибут, атрибут имеет приоритет над proto, но в этом случае proto предпочтительно должно быть null. В любом случае, proto используется этой функцией.

attrs предоставляет атрибуты, которые должны быть применены к подпрограмме. Несколько атрибутов вступают в силу благодаря встроенным средствам, применяясь к PL_compcv непосредственно при их обнаружении. Другие атрибуты собираются и прикрепляются к подпрограмме этим путём. attrs может быть null, чтобы не передавать атрибуты, указывать на оператор const для одного атрибута или указывать на оператор list для одного или нескольких атрибутов, чьи дочерние элементы, кроме pushmark, являются операторами const . Каждый оператор const должен быть строкой, содержащей имя атрибута, необязательно за которым следуют скобки с аргументами, в соответствии с тем, как атрибуты отображаются в исходном коде Perl. Атрибуты будут применены к подпрограмме этой функцией. attrs используется этой функцией.

Если o_is_gv ложно и o равно null, подпрограмма будет анонимной. Если o_is_gv ложно и o не равно null, o должно указывать на оператор const, который будет использован этой функцией, а его строковое значение предоставляет имя подпрограммы. Имя может быть квалифицированным или нет, и если оно не квалифицировано, будет выбран стандартный стек каким-либо образом. Если o_is_gv истинно, o вообще не указывает на OP, а вместо этого является указателем на GV, который будет использоваться для именования подпрограммы.

Если уже существует подпрограмма с заданным именем, новая подпрограмма либо заменит существующую в глобе, либо будет объединена с существующей. Может быть выведено предупреждение о переопределении.

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

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

CV*  newATTRSUB_x(I32 floor, OP *o, OP *proto, OP *attrs,
                  OP *block, bool o_is_gv)

newXS_len_flags

Создать подпрограмму XS, выполнив также некоторые сопутствующие задачи.

Подпрограмма будет иметь точку входа subaddr. Она будет иметь прототип, указанный нуль-терминированной строкой proto, или без прототипа, если proto равно null. Строка прототипа копируется; вызывающая сторона может изменить предоставленную строку после этого. Если filename не равно null, оно должно быть нуль-терминированным именем файла, и у подпрограммы будет установлено соответствующее значение CvFILE. По умолчанию CvFILE устанавливается в указанную строку, которая должна быть статической. Если flags имеет установленный бит XS_DYNAMIC_FILENAME, вместо этого будет создана копия строки.

Другие аспекты подпрограммы останутся в их состоянии по умолчанию. Если для корректной работы подпрограммы необходимо что-либо еще, вызывающая сторона должна сделать это после завершения работы этой функции. Однако будьте осторожны, поскольку подпрограмма может быть уничтожена до возврата этой функции, как описано ниже.

Если name равно null, подпрограмма будет анонимной, с ее CvGV ссылающимся на __ANON__ glob. Если name не равно null, подпрограмма будет именоваться соответствующим образом, ссылаться на соответствующий glob. name — строка длиной len байт, содержащая имя символа без сигнатуры в UTF-8, если flags имеет установленный бит SVf_UTF8, и в Latin-1 в противном случае. Имя может быть квалифицированным или неквалифицированным, причём хранилище по умолчанию будет таким же, как и для gv_fetchpvn_flags. flags может содержать биты флагов, понятные для gv_fetchpvn_flags, с тем же значением, что и там, например, GV_ADDWARN. Символ всегда добавляется в хранилище при необходимости, с семантикой GV_ADDMULTI.

Если уже существует подпрограмма с указанным именем, новая подпрограмма заменит существующую в glob. Может быть выведено предупреждение о переопределении. Если старая подпрограмма была CvCONST, решение о том, выводить ли предупреждение, зависит от ожиданий относительно того, станет ли новая подпрограмма константой с аналогичным значением. Это ожидание определяется по const_svp. (Обратите внимание, что вызов этой функции не делает новую подпрограмму CvCONST в любом случае; это оставляется на усмотрение вызывающей стороны.) Если const_svp равно null, это означает, что новая подпрограмма не станет константой. Если const_svp не равно null, это означает, что новая подпрограмма станет константой, и оно указывает на SV*, который предоставляет постоянное значение, которое будет у подпрограммы.

Если подпрограмма имеет одно из нескольких специальных имён, таких как BEGIN или END, она будет затребована соответствующей очередью для автоматического запуска подпрограмм, связанных с этапом. В этом случае соответствующий glob останется пустым, даже если раньше содержал подпрограмму. В случае BEGIN, подпрограмма будет выполнена, и ссылка на неё будет удалена до возврата этой функции, а также до установки её прототипа. Если подпрограмма BEGIN не будет достаточно построена этой функцией, чтобы быть готовой к выполнению, вызывающая сторона должна предотвратить это, присвоив подпрограмме другое имя.

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

CV *  newXS_len_flags(const char *name, STRLEN len,
                      XSUBADDR_t subaddr,
                      const char *const filename,
                      const char *const proto, SV **const_svp,
                      U32 flags)

op_refcnt_lock

Реализует макрос OP_REFCNT_LOCK, который следует использовать вместо него.

void  op_refcnt_lock()

op_refcnt_unlock

Реализует макрос OP_REFCNT_UNLOCK, который следует использовать вместо него.

void  op_refcnt_unlock()

optimize_optree

Эта функция применяет некоторые оптимизации к дереву optree сверху вниз. Она вызывается перед оптимизатором peephole, который обрабатывает операции в порядке выполнения. Обратите внимание, что finalize_optree() также выполняет сканирование сверху вниз, но вызывается *после* оптимизатора peephole.

void  optimize_optree(OP* o)

traverse_op_tree

Возвращает следующую операцию в обходе дерева op в порядке глубины, возвращая NULL, когда обход завершен.

Инициальный вызов должен предоставить корень дерева как top, так и o.

Пока это статический метод, но в будущем он может быть доступен через API.

OP*  traverse_op_tree(OP* top, OP* o)

Упаковывание и распаковывание

В данный момент в разделе «Упаковывание и распаковывание» находятся только элементы публичного API.

Структуры данных PAD

CX_CURPAD_SAVE

Сохранить текущий PAD в структуре блока контекста.

void  CX_CURPAD_SAVE(struct context)

CX_CURPAD_SV

Получить SV по смещению po в сохраненном текущем PAD в структуре блока контекста (можно использовать как lvalue).

SV *  CX_CURPAD_SV(struct context, PADOFFSET po)

PAD_BASE_SV

Получить значение из слота po в базовом (DEPTH=1) PAD списка PAD.

SV *  PAD_BASE_SV(PADLIST padlist, PADOFFSET po)

PAD_CLONE_VARS

Клонировать переменные состояния, связанные с выполнением и компиляцией PAD.

void  PAD_CLONE_VARS(PerlInterpreter *proto_perl,
                     CLONE_PARAMS* param)

PAD_COMPNAME_FLAGS

Возвращает флаги текущего имени компилируемого PAD по смещению po. Предполагает наличие действительной записи слота.

U32  PAD_COMPNAME_FLAGS(PADOFFSET po)

PAD_COMPNAME_GEN

Номер поколения имени по смещению po в текущем компилируемом PAD (lvalue).

STRLEN  PAD_COMPNAME_GEN(PADOFFSET po)

PAD_COMPNAME_GEN_set

Устанавливает номер поколения имени по смещению po в текущем компилируемом PAD (lvalue) на значение gen.

STRLEN  PAD_COMPNAME_GEN_set(PADOFFSET po, int gen)

PAD_COMPNAME_OURSTASH

Возвращает хранилище, связанное с переменной our. Предполагает, что запись слота является действительным лексическим элементом our.

HV *  PAD_COMPNAME_OURSTASH(PADOFFSET po)

PAD_COMPNAME_PV

Возвращает имя текущего компилируемого PAD по смещению po. Предполагает наличие действительной записи слота.

char *  PAD_COMPNAME_PV(PADOFFSET po)

PAD_COMPNAME_TYPE

Возвращает тип (хранилище) текущего имени компилируемого PAD по смещению po. Должно быть действительное имя. Возвращает null, если тип не задан.

HV *  PAD_COMPNAME_TYPE(PADOFFSET po)

PadnameIsOUR

Является ли это переменной "our".

bool  PadnameIsOUR(PADNAME * pn)

PadnameIsSTATE

Является ли это переменной "state".

bool  PadnameIsSTATE(PADNAME * pn)

PadnameOURSTASH

Хранилище, в котором была объявлена эта переменная "our".

HV *  PadnameOURSTASH(PADNAME * pn)

PadnameOUTER

Принадлежит ли эта запись внешнему PAD. Записи, для которых это верно, часто называют «фиктивными».

bool  PadnameOUTER(PADNAME * pn)

PadnameTYPE

Хранилище, связанное с типизированным лексическим элементом. Это возвращает хеш %Foo:: для my Foo $bar.

HV *  PadnameTYPE(PADNAME * pn)

PAD_RESTORE_LOCAL

Восстановить старый PAD, сохраненный в локальной переменной opad, функцией PAD_SAVE_LOCAL().

void  PAD_RESTORE_LOCAL(PAD *opad)

PAD_SAVE_LOCAL

Сохранить текущий PAD в локальную переменную opad, затем сделать текущим PAD npad.

void  PAD_SAVE_LOCAL(PAD *opad, PAD *npad)

PAD_SAVE_SETNULLPAD

Сохранить текущий PAD, затем установить его в null.

void  PAD_SAVE_SETNULLPAD()

PAD_SETSV

Установить значение в слоте со смещением po в текущем PAD на значение sv.

SV *  PAD_SETSV(PADOFFSET po, SV* sv)

PAD_SET_CUR

Установить текущим PAD PAD n в списке PAD, сохранив предыдущий текущий PAD. NB в настоящее время этот макрос расширяется до слишком длинной для некоторых компиляторов строки, поэтому лучше заменить его

SAVECOMPPAD();
PAD_SET_CUR_NOSAVE(padlist,n);

void  PAD_SET_CUR(PADLIST padlist, I32 n)

PAD_SET_CUR_NOSAVE

Как PAD_SET_CUR, но без сохранения

void  PAD_SET_CUR_NOSAVE(PADLIST padlist, I32 n)

PAD_SV

Получить значение по смещению po в текущем PAD.

SV *  PAD_SV(PADOFFSET po)

PAD_SVl

Легковесная и lvalue версия PAD_SV. Получить или установить значение по смещению po в текущем PAD. В отличие от PAD_SV, не выводит диагностические сообщения при использовании -DX. Только для внутреннего использования.

SV *  PAD_SVl(PADOFFSET po)

SAVECLEARSV

Очистить значение PAD, на который указывает указатель, при выходе из области видимости. (т.е. действие runtime my).

void  SAVECLEARSV(SV **svp)

SAVECOMPPAD

Сохранить PL_comppad и PL_curpad.

void  SAVECOMPPAD()

SAVEPADSV

Сохранить слот PAD (используется для восстановления после итерации).

void  SAVEPADSV(PADOFFSET po)

Доступ к паролям и группам

В данный момент в разделе «Доступ к паролям и группам» находятся только элементы публичного API.

Пути к системным командам

В данный момент в разделе «Пути к системным командам» находятся только элементы публичного API.

Информация о прототипах

В данный момент в разделе «Информация о прототипах» находятся только элементы публичного API.

Функции REGEXP

regnode

Описание см. в perlreguts.

Отчеты и форматы

В данный момент в разделе «Отчеты и форматы» находятся только элементы публичного API.

Сигналы

В данный момент в разделе «Сигналы» находятся только элементы публичного API.

Настройка сайта

В данный момент в разделе «Настройка сайта» находятся только элементы публичного API.

Значения конфигурации сокетов

В данный момент в разделе «Значения конфигурации сокетов» находятся только элементы публичного API.

Фильтры исходного кода

В данный момент в разделе «Фильтры исходного кода» находятся только элементы публичного API.

Обработка стека (макросы)

djSP

Объявить только SP. Это фактически идентично dSP, и объявляет локальную копию указателя стека Perl, доступную через макрос SP. См. "SP" in perlapi. (Доступно для обратной совместимости с устарелой моделью потоков (Perl 5.005)).

djSP();

LVRET

Истинно, если этот оператор будет возвращаемым значением подпрограммы lvalue

save_alloc

Реализует "SSNEW" в perlapi и аналогичные функции, которые следует использовать вместо этой функции.

I32  save_alloc(I32 size, I32 pad)

Обработка строк

delimcpy_no_escape

Копирует буфер источника в буфер назначения, останавливаясь на (но не включая) первом вхождении в исходном буфере разделителя байт delim. Источник — это байты между from и from_end - 1. Аналогично, назначение — to до to_end.

Количество скопированных байт записывается в *retlen.

Возвращает позицию delim в буфере from, но если такое вхождение не найдено до from_end, то возвращается from_end, и весь буфер from .. from_end - 1 копируется.

Если в буфере назначения после копирования есть место, добавляется дополнительный завершающий проверочный NUL байт (не включён в возвращаемую длину).

Случай ошибки — если буфер назначения недостаточно велик, чтобы вместить всё, что должно быть скопировано. В этой ситуации значение, большее, чем to_end - to, записывается в *retlen, и как можно больше из исходного буфера записывается в буфер назначения. Нехватка места для проверочного NUL байта не считается ошибкой.

char*  delimcpy_no_escape(char* to, const char* to_end,
                          const char* from, const char* from_end,
                          const int delim, I32* retlen)

my_cxt_init

Реализует макрос "MY_CXT_INIT" в perlxs, который следует использовать вместо него.

В первый раз, когда модуль загружается, глобальная переменная PL_my_cxt_index увеличивается, и это значение присваивается статической переменной модуля my_cxt_index (адрес которой передаётся в качестве аргумента). Затем для каждого интерпретатора, для которого вызывается эта функция, гарантируется доступность слота void* для размещения статических данных путём выделения или расширения массива интерпретатора PL_my_cxt_list

ПРИМЕЧАНИЕ: my_cxt_init должен быть явным образом вызван как Perl_my_cxt_init с параметром aTHX_.

void*  Perl_my_cxt_init(pTHX_ int *indexp, size_t size)

quadmath_format_needed

quadmath_format_needed() возвращает true, если строка format, кажется, содержит по крайней мере один спецификатор формата %[efgaEFGA], не имеющий префикса Q, и false в противном случае.

Определение спецификатора формата не является полным обнаружением синтаксиса printf, но оно должно находить большинство распространённых случаев.

Если возвращается true, то эти аргументы должны в теории быть обработаны с помощью quadmath_snprintf(), но в случае, если имеется более одного такого спецификатора формата (см. "quadmath_format_valid"), и если есть что-либо ещё, кроме этого (даже просто один байт), они не могут быть обработаны, потому что quadmath_snprintf() очень жёсткий, принимая только один спецификатор формата и ничего больше. В этом случае код, вероятно, должен завершиться ошибкой.

bool  quadmath_format_needed(const char* format)

quadmath_format_valid

quadmath_snprintf() очень строго относится к строке format формата и завершается ошибкой, возвращая -1, если формат неверен. Он принимает ровно один спецификатор формата.

quadmath_format_valid() проверяет, что предполагаемый одиночный спецификатор выглядит осмысленно: начинается с %, содержит только один %, заканчивается на [efgaEFGA], и имеет Q перед ним. Это не полная проверка синтаксиса printf, а только основы.

Возвращает true, если формат корректный, и false — если нет.

См. также "quadmath_format_needed".

bool  quadmath_format_valid(const char* format)

Флаги SV

SVt_INVLIST

Флаг типа для скаляров. См. "svtype" в perlapi.

Обработка SV

PL_Sv

Временный SV для любых ваших временных нужд. В основном используется в качестве резервного варианта макросами на платформах, где "PERL_USE_GCC_BRACE_GROUPS" в perlapi> недоступен и которые в противном случае вычисляют свой параметр SV более одного раза.

PL_Sv

sv_2bool

Этот макрос используется только sv_true() или его макро-эквивалентом, и только если аргумент последнего не SvPOK, SvIOK или SvNOK. Он вызывает sv_2bool_flags со флагом SV_GMAGIC.

bool  sv_2bool(SV *const sv)

sv_2bool_flags

Эта функция используется только sv_true() и аналогичными функциями, и только если аргумент последней не SvPOK, SvIOK или SvNOK. Если флаги содержат SV_GMAGIC, то сначала выполняется mg_get().

bool  sv_2bool_flags(SV *sv, I32 flags)

sv_2num

ПРИМЕЧАНИЕ: sv_2num является экспериментальным и может быть изменён или удалён без предварительного уведомления.

Возвращает SV с числовым значением исходного SV, выполняя необходимые преобразования ссылок или перегрузки. Ожидается, что вызов уже выполнил get-magic.

SV*  sv_2num(SV *const sv)

sv_2pvbyte_nolen

Возвращает указатель на байтовое представление SV. Может привести к понижению SV с UTF-8 как побочному эффекту.

Обычно вызывается через макрос SvPVbyte_nolen.

char*  sv_2pvbyte_nolen(SV* sv)

sv_2pvutf8_nolen

Возвращает указатель на UTF-8-представление SV. Может привести к повышению SV до UTF-8 как побочному эффекту.

Обычно вызывается через макрос SvPVutf8_nolen.

char*  sv_2pvutf8_nolen(SV* sv)

sv_2pv_nolen

Аналогично sv_2pv(), но не возвращает длину. Следует обычно использовать макрос-обёртку SvPV_nolen(sv).

char*  sv_2pv_nolen(SV* sv)

sv_add_arena

Принимая кусок памяти, связывает его с началом списка арена и разбивает его на список свободных SV.

void  sv_add_arena(char *const ptr, const U32 size,
                   const U32 flags)

sv_clean_all

Уменьшает счётчик ссылок каждого оставшегося SV, возможно, вызывая очистку. Возможно, эту функцию нужно вызвать несколько раз, чтобы освободить SV, находящиеся в сложных взаимосвязанных иерархиях.

I32  sv_clean_all()

sv_clean_objs

Попытка уничтожить все объекты, ещё не освобождённые.

void  sv_clean_objs()

sv_free_arenas

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

void  sv_free_arenas()

sv_grow

Расширяет буфер символов в SV. При необходимости использует sv_unref и повышает SV до типа SVt_PV. Возвращает указатель на буфер символов. Используйте макрос-обёртку SvGROW.

char*  sv_grow(SV *const sv, STRLEN newlen)

sv_grow_fresh

Упрощённая версия sv_grow, предназначенная только для случаев, когда sv является только что созданным SVt_PV, SVt_PVIV, SVt_PVNV или SVt_PVMG. То есть sv имеет стандартные флаги, никогда не был другого типа и не имеет существующей строки. По сути, просто назначает буфер символов и возвращает указатель на него.

char*  sv_grow_fresh(SV *const sv, STRLEN newlen)

sv_iv

DEPRECATED! Планируется удалить sv_iv из будущих релизов Perl. Не используйте для нового кода; удалите из существующего кода.

Приватная реализация макроса SvIVx для компиляторов, которые не могут обрабатывать сложные макро-выражения. Всегда используйте макрос.

IV  sv_iv(SV* sv)

sv_newref

Увеличивает счётчик ссылок SV. Используйте макрос-обёртку SvREFCNT_inc().

SV*  sv_newref(SV *const sv)

sv_nv

DEPRECATED! Планируется удалить sv_nv из будущих релизов Perl. Не используйте для нового кода; удалите из существующего кода.

Приватная реализация макроса SvNVx для компиляторов, которые не могут обрабатывать сложные макро-выражения. Всегда используйте макрос.

NV  sv_nv(SV* sv)

sv_pv

Используйте макрос SvPV_nolen.

char*  sv_pv(SV *sv)

sv_pvbyte

Используйте SvPVbyte_nolen.

char*  sv_pvbyte(SV *sv)

sv_pvbyten

DEPRECATED! Планируется удалить sv_pvbyten из будущих релизов Perl. Не используйте для нового кода; удалите из существующего кода.

Приватная реализация макроса SvPVbyte для компиляторов, которые не могут обрабатывать сложные макро-выражения. Всегда используйте макрос.

char*  sv_pvbyten(SV *sv, STRLEN *lp)

sv_pvbyten_force

Реализация макроса SvPVbytex_force. Всегда используйте макрос. Если SV нельзя понизить до UTF-8, происходит ошибка.

char*  sv_pvbyten_force(SV *const sv, STRLEN *const lp)

sv_pvn

DEPRECATED! Планируется удалить sv_pvn из будущих релизов Perl. Не используйте для нового кода; удалите из существующего кода.

Приватная реализация макроса SvPV для компиляторов, которые не могут обрабатывать сложные макро-выражения. Всегда используйте макрос.

char*  sv_pvn(SV *sv, STRLEN *lp)

sv_pvn_force

Получить осмысленную строку из SV каким-либо способом. Приватная реализация макроса SvPV_force для компиляторов, которые не могут обрабатывать сложные макро-выражения. Всегда используйте макрос.

char*  sv_pvn_force(SV* sv, STRLEN* lp)

sv_pvutf8

Используйте макрос SvPVutf8_nolen.

char*  sv_pvutf8(SV *sv)

sv_pvutf8n

DEPRECATED! Планируется удалить sv_pvutf8n из будущих релизов Perl. Не используйте для нового кода; удалите из существующего кода.

Приватная реализация макроса SvPVutf8 для компиляторов, которые не могут обрабатывать сложные макро-выражения. Всегда используйте макрос.

char*  sv_pvutf8n(SV *sv, STRLEN *lp)

sv_pvutf8n_force

Бэкенд для макроса SvPVutf8x_force. Всегда используйте макрос.

char*  sv_pvutf8n_force(SV *const sv, STRLEN *const lp)

sv_tainted

Проверка SV на заражённость. Используйте SvTAINTED вместо этого.

bool  sv_tainted(SV *const sv)

SvTHINKFIRST

Быстрая проверка флага, чтобы определить, нужно ли передавать sv в sv_force_normal, чтобы выполнить "понижение" перед прямым изменением SvIVX или SvPVX.

Например, если ваш скаляр — ссылка, и вы хотите изменить SvIVX слот, вы не можете просто сделать SvROK_off, так как это приведёт к утечке референта.

Это используется во внутренних функциях модификации SV, таких как sv_setsv, sv_setiv и sv_pvn_force.

Один случай, который не обрабатывается, — gv без установленного SvFAKE. После

if (SvTHINKFIRST(gv)) sv_force_normal(gv);

он по-прежнему будет gv.

SvTHINKFIRST иногда даёт ложноположительные результаты. В таких случаях sv_force_normal ничего не делает.

U32  SvTHINKFIRST(SV *sv)

sv_true

Возвращает true, если SV имеет истинное значение по правилам Perl. Используйте вместо этого макрос SvTRUE, который может вызвать sv_true() или использовать встроенную версию.

I32  sv_true(SV *const sv)

sv_untaint

Убрать заражённость из SV. Используйте SvTAINTED_off вместо этого.

void  sv_untaint(SV *const sv)

sv_uv

DEPRECATED! Планируется удалить sv_uv из будущих релизов Perl. Не используйте его в новом коде; удалите его из существующего кода.

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

UV  sv_uv(SV* sv)

Заражённость

sv_taint

Заразить SV. Используйте SvTAINTED_on вместо этого.

void  sv_taint(SV* sv)

TAINT

Если режим проверки заражённости выключен, ничего не делать; в противном случае указать "TAINT_set" и "TAINT_PROPER", что какой-то неопределённый элемент заражён.

void  TAINT()

TAINT_ENV

Проверяет несколько компонентов %ENV на заражённость и вызывает "taint_proper", если какой-либо из них заражён. Проверяемые компоненты — это, например, $PATH.

void  TAINT_ENV

taint_env

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

void  taint_env()

TAINT_get

Возвращает булево значение, указывающее, заражён ли какой-либо элемент.

bool  TAINT_get()

TAINT_IF

Если c оценивается как true, вызывается "TAINT" для обозначения заражения; в противном случае ничего не делается.

void  TAINT_IF(bool c)

TAINTING_get

Возвращает булево значение, указывающее, включена ли проверка заражённости.

bool  TAINTING_get()

TAINTING_set

Включает/выключает режим проверки заражённости

void  TAINTING_set(bool s)

TAINT_NOT

Удаляет ранее установленную заражённость, например, с помощью TAINT.

void  TAINT_NOT()

TAINT_PROPER

Если ни один элемент не заражён, ничего не делать; в противном случае вывести сообщение (содержащее s) о нарушении заражённости. Если такие нарушения фатальны, вызывается croak.

void  TAINT_PROPER(const char * s)

taint_proper

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

void  taint_proper(const char* f, const char *const s)

TAINT_set

Если s истинно, "TAINT_get" возвращает true; Если s ложно, "TAINT_get" возвращает false;

void  TAINT_set(bool s)

TAINT_WARN_get

Возвращает false, если нарушения заражённости фатальны; Возвращает true, если они являются предупреждениями

bool  TAINT_WARN_get()

TAINT_WARN_set

s быть истинным указывает, что "TAINT_WARN_get" должно вернуть, что нарушения заражённости — просто предупреждения

s быть ложным указывает, что "TAINT_WARN_get" должно вернуть, что нарушения заражённости фатальны.

void  TAINT_WARN_set(bool s)

Время

В данный момент в Time есть только элементы публичного API.

Имена typedef

В данный момент в Typedef names есть только элементы публичного API.

Поддержка Unicode

bytes_from_utf8_loc

ПРИМЕЧАНИЕ: bytes_from_utf8_loc — экспериментальная функция и может быть изменена или удалена без предварительного уведомления.

Аналогично "bytes_from_utf8" in perlapi(), но принимает дополнительный параметр — указатель на местоположение первого символа в "s", который не может быть преобразован в не-UTF8.

Если этот параметр — NULL, эта функция ведет себя так же, как bytes_from_utf8.

В противном случае, если *is_utf8p равно 0 на входе, функция ведет себя так же, как bytes_from_utf8, за исключением того, что также устанавливает *first_non_downgradable в NULL.

В противном случае функция возвращает новую строку, завершенную NUL, содержащую эквивалент первой преобразуемой части "s" в не-UTF8. *lenp устанавливается на её длину, не включая завершающий NUL. Если вся входная строка была преобразована, *is_utf8p устанавливается в ложь, а *first_non_downgradable устанавливается в NULL.

В противном случае, *first_non_downgradable устанавливается на первый байт первого символа в исходной строке, который не был преобразован. *is_utf8p не изменяется. Обратите внимание, что длина новой строки может быть равна 0.

Другой способ взглянуть на это: если *first_non_downgradable не равно NULL и *is_utf8p равно ИСТИНЕ, функция начинает с начала "s" и преобразует как можно больше символов в ней, останавливаясь на первом символе, который не может быть преобразован в не-UTF-8. *first_non_downgradable устанавливается на этот символ. Функция возвращает преобразованную часть в новой строке, завершенной NUL, и *lenp устанавливается на её длину, не включая завершающий NUL. Если первый символ исходной строки не мог быть преобразован, *lenp будет 0, а новая строка будет содержать только один NUL. Если вся входная строка была преобразована, *is_utf8p устанавливается в ложь, а *first_non_downgradable устанавливается в NULL.

После успешного возврата количество вариантов в преобразованной части строки можно вычислить, сохранив значение *lenp перед вызовом и вычитав значение *lenp после вызова.

U8*  bytes_from_utf8_loc(const U8 *s, STRLEN *lenp,
                         bool *is_utf8p,
                         const U8 ** first_unconverted)

find_uninit_var

ПРИМЕЧАНИЕ: find_uninit_var — экспериментальная функция и может быть изменена или удалена без предварительного уведомления.

Находит имя неопределённой переменной (если таковая имеется), которая вызвала предупреждение "Использование неинициализированного значения" у оператора. Если match — true, возвращает имя только если его значение совпадает с uninit_sv. Грубо говоря, если унарный оператор (например, OP_COS) генерирует предупреждение, то последующий прямой дочерний элемент оператора может содержать OP_PADSV или OP_GV, которые дают имя неопределённой переменной. С другой стороны, с OP_ADD есть два ответвления, поэтому мы выводим имя переменной только если получаем точное совпадение. desc_p указывает на указатель строки, содержащий описание оператора. Он может быть обновлён по мере необходимости.

Имя возвращается как временный SV.

Предполагается, что PL_op — это оператор, изначально вызвавший ошибку, а PL_comppad/PL_curpad указывают на текущий исполняемый блок.

SV*  find_uninit_var(const OP *const obase,
                     const SV *const uninit_sv, bool match,
                     const char **desc_p)

isSCRIPT_RUN

Возвращает булево значение, указывающее, образует ли последовательность байтов от s до, но не включая send, "сценарий выполнения". utf8_target истинно, если последовательность, начинающаяся с s, должна обрабатываться как UTF-8. Точнее, за исключением двух вырожденных случаев, приведённых ниже, эта функция возвращает true, если все кодовые точки в ней берутся из любого сочетания трёх "скриптов", заданных свойством "Расширения скриптов" Юникода: Common, Inherited и, возможно, ещё один. Кроме того, все десятичные цифры должны быть из той же последовательной группы по 10.

Например, если все символы в последовательности являются греческими, или Common, или Inherited, эта функция вернёт true, при условии, что любые десятичные цифры в ней находятся в той же группе цифр Common. (Это цифры ASCII "0".."9" и, дополнительно, группа для полноширинных форм этих цифр и ещё некоторых, используемых в математической нотации.) Для скриптов (в отличие от греческого), которые имеют свои собственные наборы цифр, это будет принимать либо цифры из этого набора, либо из одного из наборов цифр Common, но не комбинацию обоих. Некоторые скрипты, такие как арабский, имеют более одного набора цифр. Все цифры должны быть из одного набора, чтобы эта функция вернула true.

*ret_script, если ret_script не равен NULL, после возвращения true будет содержать найденный скрипт, используя тип данных SCX_enum. Его значение будет SCX_INVALID, если функция вернёт false.

Если последовательность пуста, возвращается true, но *ret_script (если запрашивается) будет SCX_INVALID.

Если последовательность содержит одну кодовую точку, не присвоенную символу в используемой версии Юникода, функция вернёт true, а скрипт будет SCX_Unknown. Любая другая комбинация неназначенных кодовых точек в входной последовательности приведёт к тому, что функция будет обрабатывать вход как не являющийся сценарием выполнения.

Возвращаемый скрипт будет SCX_Inherited тогда и только тогда, когда все кодовые точки в нём находятся в скрипте Inherited.

В противном случае, возвращаемый скрипт будет SCX_Common тогда и только тогда, когда все кодовые точки в нём находятся в скриптах Inherited или Common.

bool  isSCRIPT_RUN(const U8 *s, const U8 *send,
                   const bool utf8_target)

is_utf8_non_invariant_string

Возвращает TRUE, если "is_utf8_invariant_string" в perlapi возвращает FALSE для первых len байтов строки s, но они тем не менее являются допустимым расширенным UTF-8 Perl; в противном случае возвращает FALSE.

Возвращаемое значение TRUE означает, что по крайней мере один код, представленный последовательностью, либо является широким символом, не представимым одним байтом, или его представление отличается в зависимости от того, закодирована ли последовательность в UTF-8 или нет.

См. также "is_utf8_invariant_string" in perlapi, "is_utf8_string" in perlapi

bool  is_utf8_non_invariant_string(const U8* const s, STRLEN len)

report_uninit

Выводит соответствующее предупреждение «Использование неинициализированной переменной».

void  report_uninit(const SV *uninit_sv)

utf8n_to_uvuni

DEPRECATED! Планируется удалить utf8n_to_uvuni из будущей версии Perl. Не используйте его для нового кода; удалите его из существующего кода.

Вместо этого используйте "utf8_to_uvchr_buf" в perlapi или, в редких случаях, "utf8n_to_uvchr" в perlapi.

Эта функция была полезна для кода, который хотел обрабатывать как платформы EBCDIC, так и ASCII с свойствами Юникода, но начиная с Perl v5.20, различия между платформами в основном стали незаметны для большинства кода, поэтому эта функция вряд ли будет вам нужна. Если вам нужна именно эта функциональность, используйте вместо этого NATIVE_TO_UNI(utf8_to_uvchr_buf(...)) или NATIVE_TO_UNI(utf8n_to_uvchr(...)).

UV  utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen,
                   U32 flags)

utf8_to_uvuni

DEPRECATED! Планируется удалить utf8_to_uvuni из будущей версии Perl. Не используйте его для нового кода; удалите его из существующего кода.

Возвращает код Юникода первого символа в строке s, которая предполагается закодированной в UTF-8; retlen будет установлен в длину этого символа в байтах.

Некоторые, но не все, искажения UTF-8 обнаруживаются, и, фактически, некоторые поврежденные данные могут привести к чтению за пределы буфера входных данных, что является одной из причин устаревания этой функции. Другая причина заключается в том, что только в чрезвычайно ограниченных случаях вам может потребоваться Юникод против кода символа в родной системе. См. "utf8_to_uvuni_buf" для альтернатив.

Если s указывает на одно из обнаруженных искажений, а предупреждения UTF8 включены, возвращается ноль, и *retlen устанавливается (если retlen не указывает на NULL) в -1. Если эти предупреждения отключены, вычисленное значение, если оно определено (или ЗАМЕЩАЮЩИЙ СИМВОЛ ЮНИКОДА, если нет), молча возвращается, и *retlen устанавливается (если retlen не является NULL), чтобы (s + *retlen) была следующей возможной позицией в s, которая могла бы начинаться с неискажённого символа. См. "utf8n_to_uvchr" в perlapi для получения подробной информации о том, когда возвращается ЗАМЕЩАЮЩИЙ СИМВОЛ ЮНИКОДА.

UV  utf8_to_uvuni(const U8 *s, STRLEN *retlen)

utf8_to_uvuni_buf

DEPRECATED! Планируется удалить utf8_to_uvuni_buf из будущей версии Perl. Не используйте его для нового кода; удалите его из существующего кода.

Только в очень редких случаях код должен иметь дело с кодами символов Юникода (в отличие от кодов родной системы). В этих немногих случаях используйте NATIVE_TO_UNI(utf8_to_uvchr_buf(...)) вместо этого. Если вы не уверены, что это один из таких случаев, считайте, что это не так, и используйте обычный utf8_to_uvchr_buf вместо этого.

Возвращает код символа Юникода (не родной) первого символа в строке s, которая предполагается закодированной в UTF-8; send указывает на позицию на 1 за концом s. retlen будет установлен в длину этого символа в байтах.

Если s не указывает на правильно сформированный символ UTF-8, и предупреждения UTF8 включены, возвращается ноль, и *retlen устанавливается (если retlen не указывает на NULL) в -1. Если эти предупреждения отключены, вычисленное значение, если оно определено (или ЗАМЕЩАЮЩИЙ СИМВОЛ ЮНИКОДА, если нет), молча возвращается, и *retlen устанавливается (если retlen не указывает на NULL) таким образом, что (s + *retlen) является следующей возможной позицией в s, которая может начинаться с неискажённого символа. См. "utf8n_to_uvchr" в perlapi для получения подробной информации о том, когда возвращается ЗАМЕЩАЮЩИЙ СИМВОЛ ЮНИКОДА.

UV  utf8_to_uvuni_buf(const U8 *s, const U8 *send, STRLEN *retlen)

uvoffuni_to_utf8_flags

ЭТУ ФУНКЦИЮ НУЖНО ИСПОЛЬЗОВАТЬ ТОЛЬКО В ОЧЕНЬ СПЕЦИАЛИЗИРОВАННЫХ СЛУЧАЯХ. Вместо этого почти весь код должен использовать "uvchr_to_utf8" в perlapi или "uvchr_to_utf8_flags" в perlapi.

Эта функция похожа на них, но входной параметр — строгий код символа Юникода (в отличие от кода родной системы). Только в очень редких случаях код не должен использовать код родной системы.

Для получения подробной информации см. описание "uvchr_to_utf8_flags" в perlapi.

U8*  uvoffuni_to_utf8_flags(U8 *d, UV uv, UV flags)

uvuni_to_utf8_flags

DEPRECATED! Планируется удалить uvuni_to_utf8_flags из будущей версии Perl. Не используйте его для нового кода; удалите его из существующего кода.

Вместо этого вы почти наверняка захотите использовать "uvchr_to_utf8" в perlapi или "uvchr_to_utf8_flags" в perlapi.

Эта функция — устаревший синоним "uvoffuni_to_utf8_flags", которая сама по себе, хотя и не устаревшая, должна использоваться только в отдельных случаях. Эти функции были полезны для кода, который хотел обрабатывать как платформы EBCDIC, так и ASCII с свойствами Юникода, но начиная с Perl v5.20, различия между платформами в основном стали незаметны для большинства кода, поэтому эта функция вряд ли будет вам нужна.

U8*  uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)

valid_utf8_to_uvchr

Подобно "utf8_to_uvchr_buf" in perlapi, но должна вызываться только тогда, когда известно, что следующий символ в строке входных данных UTF-8 s правильно сформирован (например, он проходит "isUTF8_CHAR" in perlapi. Разделители, несимвольные коды символов и несимвольные коды символов допускаются.

UV  valid_utf8_to_uvchr(const U8 *s, STRLEN *retlen)

variant_under_utf8_count

Эта функция анализирует последовательность байтов между s и e, которые предполагаются закодированными в ASCII/Latin1, и возвращает, сколько из них изменится при преобразовании строки в UTF-8. Из-за особенностей UTF-8 каждый из них займет два байта вместо одного в исходной строке. Таким образом, эта функция возвращает точное количество байтов, на которое расширится строка при переводе в UTF-8.

В отличие от большинства других функций с utf8 в своём имени, входной параметр этой функции НЕ является строкой, закодированной в UTF-8. Имя функции немного необычное, чтобы подчеркнуть это.

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

См. также "is_utf8_invariant_string" in perlapi и "is_utf8_invariant_string_loc" in perlapi,

Size_t  variant_under_utf8_count(const U8* const s,
                                 const U8* const e)

Функции-утилиты

my_popen_list

Реализация функции на некоторых системах для PerlProc_popen_list()

PerlIO*  my_popen_list(const char* mode, int n, SV ** args)

my_socketpair

Эмулирует socketpair(2) на системах, которые не имеют её, но имеют достаточную функциональность для эмуляции.

int  my_socketpair(int family, int type, int protocol, int fd[2])

Версионирование

В настоящий момент элементы публичного API находятся в разделе Версионирование

Предупреждения и завершение работы

PL_dowarn

Переменная C, которая примерно соответствует переменной предупреждения Perl $^W. Однако $^W обрабатывается как булево значение, в то время как PL_dowarn — это набор битовых флагов.

В многопоточных Perl'ях каждый поток имеет независимую копию этой переменной; каждая инициализируется во время создания текущим значением копии переменной создающего потока.

U8  PL_dowarn

XS

В настоящий момент элементы публичного API находятся в разделе XS

Недокументированные элементы

Следующие функции в настоящее время не документированы. Если вы используете одну из них, вы можете рассмотреть возможность создания и отправки документации для неё.

abort_execution
add_cp_to_invlist
_add_range_to_invlist
alloc_LOGOP
allocmy
amagic_cmp
amagic_cmp_desc
amagic_cmp_locale
amagic_cmp_locale_desc
amagic_is_enabled
amagic_i_ncmp
amagic_i_ncmp_desc
amagic_ncmp
amagic_ncmp_desc
any_dup
append_utf8_from_native_byte
apply
ASCII_TO_NEED
atfork_lock
atfork_unlock
av_arylen_p
av_extend_guts
av_iter_p
av_nonelem
av_reify
bind_match
block_gimme
boot_core_builtin
boot_core_mro
boot_core_PerlIO
boot_core_UNIVERSAL
_byte_dump_string
call_list
cando
cast_i32
cast_iv
cast_ulong
cast_uv
check_utf8_print
ck_anoncode
ck_backtick
ck_bitop
ck_cmp
ck_concat
ck_defined
ck_delete
ck_each
ck_entersub_args_core
ck_eof
ck_eval
ck_exec
ck_exists
ck_ftst
ck_fun
ck_glob
ck_grep
ck_index
ck_isa
ck_join
ck_length
ck_lfun
ck_listiob
ck_match
ck_method
ck_null
ck_open
ck_prototype
ck_readline
ck_refassign
ck_repeat
ck_require
ck_return
ck_rfun
ck_rvconst
ck_sassign
ck_select
ck_shift
ck_smartmatch
ck_sort
ck_spair
ck_split
ck_stringify
ck_subr
ck_substr
ck_svconst
ck_tell
ck_trunc
ck_trycatch
ckwarn
ckwarn_d
clear_defarray
closest_cop
cmpchain_extend
cmpchain_finish
cmpchain_start
cmp_desc
cmp_locale_desc
cntrl_to_mnemonic
cop_file_avn
coresub_op
create_eval_scope
croak_caller
croak_memory_wrap
croak_no_mem
croak_popstack
csighandler
csighandler1
csighandler3
current_re_engine
custom_op_get_field
cv_ckproto_len_flags
cv_clone_into
cv_const_sv_or_av
cvgv_from_hek
cvgv_set
cvstash_set
cv_undef_flags
cx_dump
cx_dup
cxinc
cx_popblock
cx_popeval
cx_popformat
cx_popgiven
cx_poploop
cx_popsub
cx_popsub_args
cx_popsub_common
cx_popwhen
cx_pushblock
cx_pusheval
cx_pushformat
cx_pushgiven
cx_pushloop_for
cx_pushloop_plain
cx_pushsub
cx_pushtry
cx_pushwhen
cx_topblock
debstackptrs
deb_stack_all
debug_hash_seed
defelem_target
delete_eval_scope
despatch_signals
die_unwind
do_aexec
do_aexec5
do_aspawn
do_eof
does_utf8_overflow
do_exec
do_exec3
dofile
do_gvgv_dump
do_gv_dump
do_hv_dump
doing_taint
do_ipcctl
do_ipcget
do_magic_dump
do_msgrcv
do_msgsnd
do_ncmp
do_open6
do_open_raw
do_op_dump
do_pmop_dump
do_print
do_readline
doref
do_seek
do_semop
do_shmio
do_spawn
do_spawn_nowait
do_sv_dump
do_sysseek
do_tell
do_trans
do_uniprop_match
do_vecget
do_vecset
do_vop
drand48_init_r
drand48_r
dtrace_probe_call
dtrace_probe_load
dtrace_probe_op
dtrace_probe_phase
dump_all_perl
dump_indent
dump_packsubs_perl
dump_sub_perl
dump_sv_child
dump_vindent
dup_warnings
emulate_cop_io
find_first_differing_byte_pos
find_lexical_cv
find_runcv_where
find_script
foldEQ_latin1
foldEQ_latin1_s2_folded
foldEQ_utf8_flags
_force_out_malformed_utf8_message
form_alien_digit_msg
form_cp_too_large_msg
free_tied_hv_pool
free_tmps
get_and_check_backslash_N_name
get_db_sub
get_debug_opts
get_deprecated_property_msg
getenv_len
get_hash_seed
get_invlist_iter_addr
get_invlist_offset_addr
get_invlist_previous_index_addr
get_mstats
get_no_modify
get_opargs
get_ppaddr
get_prop_definition
get_prop_values
get_regclass_nonbitmap_data
get_regex_charset_name
get_re_arg
get_re_gclass_nonbitmap_data
get_vtbl
gimme_V
gp_free
gp_ref
grok_bin_oct_hex
grok_bslash_c
grok_bslash_o
grok_bslash_x
gv_check
gv_fetchmeth_internal
gv_override
gv_setref
gv_stashpvn_internal
he_dup
hek_dup
hfree_next_entry
hv_auxalloc
hv_backreferences_p
hv_common
hv_common_key_len
hv_delayfree_ent
hv_kill_backrefs
hv_placeholders_p
hv_pushkv
hv_rand_set
hv_undef_flags
init_argv_symbols
init_constants
init_dbargs
init_debugger
init_i18nl10n
init_i18nl14n
init_named_cv
init_stacks
init_tm
init_uniprops
_inverse_folds
invert
invlist_array
invlist_clear
invlist_clone
invlist_contents
_invlistEQ
invlist_extend
invlist_highest
invlist_is_iterating
invlist_iterfinish
invlist_iterinit
invlist_iternext
invlist_lowest
invlist_max
invlist_previous_index
invlist_set_len
invlist_set_previous_index
invlist_trim
_invlist_array_init
_invlist_contains_cp
_invlist_dump
_invlist_intersection
_invlist_intersection_maybe_complement_2nd
_invlist_invert
_invlist_len
_invlist_search
_invlist_subtract
_invlist_union
_invlist_union_maybe_complement_2nd
invmap_dump
io_close
isFF_overlong
is_grapheme
is_invlist
is_utf8_char_helper_
is_utf8_common
is_utf8_FF_helper_
is_utf8_overlong
_is_cur_LC_category_utf8
_is_in_locale_category
_is_uni_FOO
_is_uni_perl_idcont
_is_uni_perl_idstart
_is_utf8_FOO
_is_utf8_perl_idcont
_is_utf8_perl_idstart
jmaybe
keyword
keyword_plugin_standard
list
load_charnames
localize
lossless_NV_to_IV
lsbit_pos32
lsbit_pos64
magic_cleararylen_p
magic_clearenv
magic_clearisa
magic_clearpack
magic_clearsig
magic_clear_all_env
magic_copycallchecker
magic_existspack
magic_freearylen_p
magic_freecollxfrm
magic_freemglob
magic_freeovrld
magic_freeutf8
magic_get
magic_getarylen
magic_getdebugvar
magic_getdefelem
magic_getnkeys
magic_getpack
magic_getpos
magic_getsig
magic_getsubstr
magic_gettaint
magic_getuvar
magic_getvec
magic_killbackrefs
magic_nextpack
magic_regdata_cnt
magic_regdatum_get
magic_regdatum_set
magic_scalarpack
magic_set
magic_setarylen
magic_setcollxfrm
magic_setdbline
magic_setdebugvar
magic_setdefelem
magic_setenv
magic_setisa
magic_setlvref
magic_setmglob
magic_setnkeys
magic_setnonelem
magic_setpack
magic_setpos
magic_setregexp
magic_setsig
magic_setsigall
magic_setsubstr
magic_settaint
magic_setutf8
magic_setuvar
magic_setvec
magic_set_all_env
magic_sizepack
magic_wipepack
malloced_size
malloc_good_size
markstack_grow
mem_collxfrm
mem_log_alloc
mem_log_free
mem_log_realloc
_mem_collxfrm
mg_find_mglob
mg_size
mode_from_discipline
more_bodies
more_sv
moreswitches
mortal_getenv
mro_get_private_data
mro_meta_dup
mro_meta_init
msbit_pos32
msbit_pos64
multiconcat_stringify
multideref_stringify
my_atof2
my_atof3
my_attrs
my_clearenv
my_lstat
my_lstat_flags
my_memrchr
my_mkostemp_cloexec
my_mkstemp_cloexec
my_stat
my_stat_flags
my_strerror
my_unexec
NATIVE_TO_NEED
newFORM
newGP
newMETHOP_internal
newMYSUB
newPROG
new_stackinfo
newSTUB
newSVavdefelem
new_warnings_bitfield
newXS_deffile
_new_invlist
_new_invlist_C_array
nextargv
no_bareword_filehandle
noperl_die
notify_parser_that_changed_to_utf8
oopsAV
oopsHV
op_clear
op_integerize
op_lvalue_flags
opmethod_stash
op_refcnt_dec
op_refcnt_inc
op_relocate_sv
opslab_force_free
opslab_free
opslab_free_nopad
op_std_init
op_unscope
package
package_version
pad_add_weakref
padlist_store
padname_free
PadnameIN_SCOPE
padnamelist_free
parser_dup
parser_free
parser_free_nexttoke_ops
parse_unicode_opts
path_is_searchable
peep
perl_alloc_using
perl_clone_using
PerlIO_context_layers
PerlIO_restore_errno
PerlIO_save_errno
PerlLIO_dup2_cloexec
PerlLIO_dup_cloexec
PerlLIO_open3_cloexec
PerlLIO_open_cloexec
PerlProc_pipe_cloexec
PerlSock_accept_cloexec
PerlSock_socketpair_cloexec
PerlSock_socket_cloexec
perly_sighandler
pmruntime
POPMARK
populate_isa
pregfree
pregfree2
qerror
ReANY
reentrant_free
reentrant_init
reentrant_retry
reentrant_size
re_exec_indentf
ref
regcurly
regdump
regdupe_internal
regexec_flags
regfree_internal
reginitcolors
reg_named_buff
reg_named_buff_all
reg_named_buff_exists
reg_named_buff_fetch
reg_named_buff_firstkey
reg_named_buff_iter
reg_named_buff_nextkey
reg_named_buff_scalar
regnext
reg_numbered_buff_fetch
reg_numbered_buff_length
reg_numbered_buff_store
regprop
reg_qr_package
reg_skipcomment
reg_temp_copy
re_indentf
re_intuit_start
re_intuit_string
re_op_compile
report_evil_fh
report_redefined_cv
report_wrongway_fh
re_printf
rpeep
rsignal_restore
rsignal_save
rvpv_dup
rxres_save
same_dirent
save_bool
save_clearsv
save_delete
save_destructor
save_destructor_x
save_freeop
save_freepv
save_freesv
save_I16
save_I32
save_I8
save_int
save_iv
save_long
save_mortalizesv
save_pptr
save_re_context
save_sptr
savestack_grow
savestack_grow_cnt
save_strlen
save_to_buffer
sawparens
scalar
scalarvoid
scan_num
scan_str
scan_word
seed
set_caret_X
setfd_cloexec
setfd_cloexec_for_nonsysfd
setfd_cloexec_or_inhexec_by_sysfdness
setfd_inhexec
setfd_inhexec_for_sysfd
set_numeric_standard
set_numeric_underlying
set_padlist
_setup_canned_invlist
share_hek
should_warn_nl
should_we_output_Debug_r
sighandler
sighandler1
sighandler3
single_1bit_pos32
single_1bit_pos64
skipspace_flags
Slab_Alloc
Slab_Free
Slab_to_ro
Slab_to_rw
softref2xv
sortsv_flags_impl
stack_grow
str_to_version
sub_crush_depth
sv_2iv
sv_2uv
sv_add_backref
sv_buf_to_ro
sv_del_backref
sv_free2
sv_i_ncmp
sv_i_ncmp_desc
sv_kill_backrefs
sv_magicext_mglob
sv_ncmp
sv_ncmp_desc
sv_only_taint_gmagic
sv_or_pv_pos_u2b
sv_resetpvn
sv_sethek
sv_setsv_cow
SvTRUE_common
sv_unglob
sys_init
sys_init3
sys_intern_clear
sys_intern_dup
sys_intern_init
sys_term
tied_method
tmps_grow_p
TOPMARK
to_uni_fold
to_uni_lower
to_uni_title
to_uni_upper
_to_fold_latin1
_to_uni_fold_flags
_to_upper_title_latin1
_to_utf8_fold_flags
_to_utf8_lower_flags
_to_utf8_title_flags
_to_utf8_upper_flags
translate_substr_offsets
try_amagic_bin
try_amagic_un
uiv_2buf
unlnk
unshare_hek
utf16_to_utf8
utf16_to_utf8_base
utf16_to_utf8_reversed
_utf8n_to_uvchr_msgs_helper
utf8_to_utf16_base
utf8_to_uvchr_buf_helper
utilize
uvoffuni_to_utf8_flags_msgs
uvuni_to_utf8
valid_utf8_to_uvuni
variant_byte_number
varname
vivify_defelem
vivify_ref
wait4pid
_warn_problematic_locale
was_lvalue_sub
watch
win32_croak_not_implemented
write_to_stderr
xs_boot_epilog
xs_handshake
yyerror
yyerror_pv
yyerror_pvn
yylex
yyparse
yyquit
yyunlex

АВТОРЫ

Система автодокументации была первоначально добавлена в ядро Perl Бенджамином Штулем. Документацию создаёт тот, кто любезно позаботился о документировании своих функций.

См. также

config.h, perlapi, perlapio, perlcall, perlclib, perlembed, perlfilter, perlguts, perlhacktips, perlinterp, perliol, perlmroapi, perlreapi, perlreguts, perlxs