12.2.1 Выдача предупреждений

Выдать предупреждение можно из любого кода, используя функцию warning. В самом простом виде, функция warning принимает в качестве входного аргумента строку, описывающую предупреждение. Например, следующий код проверяет, является ли переменная «a» неотрицательной, и если нет, выдает предупреждение и устанавливает «a» в ноль.

a = -1;
if (a < 0)
  warning ("'a' must be non-negative.  Setting 'a' to zero.");
  a = 0;
endif
     -| 'a' must be non-negative.  Setting 'a' to zero.

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

Также можно присвоить строку идентификатора предупреждению. Если у предупреждения есть такой идентификатор, пользователь может включить или выключить это предупреждение, как будет описано в следующем разделе. Чтобы присвоить идентификатор предупреждению, просто вызовите warning с двумя строковыми аргументами, где первый — строка идентификатора, а второй — само предупреждение. Обратите внимание, что идентификаторы предупреждений имеют формат "NAMESPACE:WARNING-NAME". Пространство имен "Octave" используется для собственных предупреждений Octave. Любая другая строка может быть использована как пространство имен для пользовательских предупреждений.

: warning (шаблон, …)

: warning (id, шаблон, …)

: warning ("вкл", id)

: warning ("выкл", id)

: warning ("ошибка", id)

: warning ("запрос", id)

: warning (состояние, id, "локально")

: warning (структура_предупреждения)

: структура_предупреждения = warning (…)

: warning (состояние, режим)

Отображает сообщение об ошибке или контролирует поведение системы предупреждений Octave.

Первый способ использования использует шаблон шаблон и дополнительные аргументы для отображения сообщения в потоке stderr. Сообщение форматируется по тем же правилам, что и функции семейства printf (см. Форматированный вывод) и предваряется строкой «предупреждение: ». Вы должны использовать эту функцию, когда хотите сообщить пользователю о необычном состоянии, но только тогда, когда для вашей программы имеет смысл продолжать работу. Например:

warning ("foo: maybe something wrong here");

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

Необязательный идентификатор предупреждения id позволяет пользователям включать или выключать предупреждения, помеченные этим идентификатором. Идентификатор сообщения — это строка вида "NAMESPACE:WARNING-NAME". Собственные предупреждения Octave используют пространство имен "Octave" (см. warning_ids). Например:

warning ("MyNameSpace:check-something",
         "foo: maybe something wrong here");

Второй способ предназначен для изменения и/или запроса состояния предупреждений. Первый входной аргумент должен быть строкой состояние ("on", "off", "error", или "query") за которой необязательно следует идентификатор предупреждения id или "all" (значение по умолчанию).

Необязательный выходной аргумент структура_предупреждения — это структура или массив структур с полями "state" и "identifier". Аргумент состояние может иметь следующие значения:

"on"|"off":

Включить или выключить отображение предупреждений, идентифицированных по id, и необязательно вернуть их предыдущее состояние stout.

"error":

Преобразовать предупреждения, идентифицированные по id, в ошибки и необязательно вернуть их предыдущее состояние stout.

"query":

Вернуть текущее состояние предупреждений, идентифицированных по id.

Структура или массив структур структура_предупреждения с полями "state" и "identifier" может быть предоставлена в качестве входных данных для достижения эквивалентных результатов. Следующий пример показывает, как временно отключить предупреждение и затем восстановить его первоначальное состояние:

loglog (-1:10);
## Disable the previous warning and save its original state
[~, id] = lastwarn ();
warnstate = warning ("off", id);
loglog (-1:10);
## Restore its original state
warning (warnstate);

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

Без входных аргументов warning () эквивалентно warning ("query", "all"), за исключением того, что при отсутствии выходного аргумента состояние предупреждений отображается в stderr.

Уровень подробности системы предупреждений также может быть контролируется двумя режимами режим:

"backtrace":

включить/выключить отображение стека вызовов после сообщения о предупреждении

"verbose":

включить/выключить отображение дополнительной информации после сообщения о предупреждении

В этом случае аргумент состояние может быть только "on" или "off".

Примечание по реализации: для совместимости с MATLAB, управляющие последовательности в шаблоне (например, "\n" => новая строка) обрабатываются независимо от того, определен ли шаблон с одинарными кавычками, до тех пор, пока существует два или более входных аргумента. Чтобы отключить обработку управляющих последовательностей, используйте двойной обратный слэш перед последовательностью (например, "\\n") или используйте функцию regexptranslate.

См. также: warning_ids, lastwarn, error.

: [сообщение, идентификатор] = lastwarn ()

: lastwarn (сообщение)

: lastwarn (сообщение, идентификатор)

Запрос или установка последнего сообщения о предупреждении.

Когда вызывается без входных аргументов, возвращает последнее сообщение о предупреждении и идентификатор сообщения.

С одним аргументом устанавливает последнее сообщение о предупреждении в сообщение.

С двумя аргументами также устанавливает идентификатор последнего сообщения.

См. также: warning, lasterror, lasterr.

Функции, распространяемые с Octave, могут выдавать следующие предупреждения.

Octave:abbreviated-property-match

По умолчанию предупреждение Octave:abbreviated-property-match включено.

Octave:addpath-pkg

Если предупреждение Octave:addpath-pkg включено, Octave будет предупреждать, когда директория пакета (т.е., +имя_пакета) добавляется в path. Как правило, в путь загрузки следует добавлять только родительскую директорию, содержащую директорию пакета. По умолчанию предупреждение Octave:addpath-pkg включено.

Octave:array-as-logical

Если предупреждение Octave:array-as-logical включено, Octave будет предупреждать, когда массив размером больше 1x1 используется в качестве значения истинности в операторе if, while или until. По умолчанию предупреждение Octave:array-as-logical отключено.

Octave:array-to-scalar

Если предупреждение Octave:array-to-scalar включено, Octave будет предупреждать, когда происходит неявное преобразование массива в скалярное значение. По умолчанию предупреждение Octave:array-to-scalar отключено.

Octave:array-to-vector

Если предупреждение Octave:array-to-vector включено, Octave будет предупреждать, когда происходит неявное преобразование массива в векторное значение. По умолчанию предупреждение Octave:array-to-vector отключено.

Octave:assign-as-truth-value

Если предупреждение Octave:assign-as-truth-value включено, выводится предупреждение для операторов, подобных

if (s = t)
  …

поскольку такие операторы не являются распространёнными, и скорее всего, предполагалось написать

if (s == t)
  …

вместо этого.

В некоторых случаях полезно писать код, содержащий присваивания внутри условия оператора while или if. Например, операторы, подобные

while (c = getc ())
  …

распространены в программировании на языке C.

Можно избежать всех предупреждений о таких операторах, отключив предупреждение Octave:assign-as-truth-value, но это может также привести к пропуску реальных ошибок, например,

if (x = 1)  # intended to test (x == 1)!
  …

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

while ((c = getc ()))
  …

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

По умолчанию предупреждение Octave:assign-as-truth-value включено.

Octave:autoload-relative-file-name

Если предупреждение Octave:autoload-relative-file-name включено, Octave будет предупреждать при разборе вызовов функции autoload() с относительными путями к файлам функций. Это обычно происходит при использовании вызовов autoload() в файлах PKG_ADD, когда файл PKG_ADD не находится в той же директории, что и файл .oct, на который ссылается команда autoload(). По умолчанию предупреждение Octave:autoload-relative-file-name включено.

Octave:built-in-variable-assignment

По умолчанию предупреждение Octave:built-in-variable-assignment включено.

Octave:classdef-to-struct

Если предупреждение Octave:classdef-to-struct включено, выводится предупреждение, когда объект classdef принудительно преобразуется в структуру с помощью struct (CLASSDEF_OBJ). Преобразование удаляет ограничения доступа к объекту и делает видимыми частные и защищённые свойства. По умолчанию предупреждение Octave:classdef-to-struct включено.

Octave:colon-complex-argument

Если предупреждение Octave:colon-complex-argument включено, выводится предупреждение, когда один из трёх аргументов оператора двоеточия (основание, приращение, предел) является комплексным значением. Например, 1:3*i вызовет вывод предупреждения. По умолчанию предупреждение Octave:colon-complex-argument включено.

Octave:colon-nonscalar-argument

Если предупреждение Octave:colon-nonscalar-argument включено, выводится предупреждение, когда один из трёх аргументов оператора двоеточия (основание, приращение, предел) не является скаляром. Например, 1:[3, 5] вызовет вывод предупреждения. По умолчанию предупреждение Octave:colon-nonscalar-argument включено.

Octave:data-file-in-path

Если предупреждение Octave:data-file-in-path включено, выводится предупреждение, когда Octave не находит целевого объекта для файловой операции, например load или fopen, но может найти файл в списке поиска path Octave. Предупреждение может указывать на использование целевого файла, отличного от задуманного программистом. По умолчанию предупреждение Octave:data-file-in-path включено.

Octave:deprecated-function

Если предупреждение Octave:deprecated-function включено, выводится предупреждение, когда Octave сталкивается с устаревшей функцией, запланированной на удаление из Octave. По умолчанию предупреждение Octave:deprecated-function включено.

Octave:deprecated-keyword

Если предупреждение Octave:deprecated-keyword включено, выводится предупреждение, когда Octave сталкивается с устаревшим ключевым словом, запланированным на удаление из Octave. По умолчанию предупреждение Octave:deprecated-keyword включено.

Octave:deprecated-property

Если предупреждение Octave:deprecated-property включено, выводится предупреждение, когда Octave сталкивается с устаревшим свойством графики, запланированным на удаление из Octave. По умолчанию предупреждение Octave:deprecated-property включено.

Octave:eigs:UnconvergedEigenvalues

Если предупреждение Octave:eigs:UnconvergedEigenvalues включено, функция eigs выведет предупреждение, если количество вычисленных собственных значений меньше количества запрошенных собственных значений. По умолчанию предупреждение Octave:eigs:UnconvergedEigenvalues включено.

Octave:empty-index

Если предупреждение Octave:empty-index включено, Octave будет выдавать предупреждение всякий раз, когда операторы индексирования используются без индекса, например, x(). По умолчанию предупреждение Octave:empty-index включено.

Octave:erase:chararray

Если предупреждение Octave:erase:chararray включено, функция erase выведет предупреждение, если входной шаблон является символьной строкой, а не строкой или массивом ячеек строк. По умолчанию предупреждение Octave:erase:chararray включено.

Octave:function-name-clash

Если предупреждение Octave:function-name-clash включено, выводится предупреждение, когда Octave обнаруживает, что имя функции, определённой в файле функции, отличается от имени файла. (Если имена не совпадают, имя, объявленное внутри файла, игнорируется.) По умолчанию предупреждение Octave:function-name-clash включено.

Octave:future-time-stamp

Если предупреждение Octave:future-time-stamp включено, Octave выведет предупреждение, если обнаружит файл функции с отметкой времени, которая находится в будущем. По умолчанию предупреждение Octave:future-time-stamp включено.

Octave:glyph-render

Если предупреждение Octave:glyph-render включено, Octave выведет предупреждение, если глиф для символа не может быть отображён текущим шрифтом. По умолчанию предупреждение Octave:glyph-render включено.

Octave:imag-to-real

Если предупреждение Octave:imag-to-real включено, выводится предупреждение о неявных преобразованиях комплексных чисел в вещественные числа. По умолчанию предупреждение Octave:imag-to-real отключено.

Octave:language-extension

Вывод предупреждений при использовании функций, уникальных для языка Octave и, возможно, отсутствующих в MATLAB. По умолчанию предупреждение Octave:language-extension отключено. Также могут быть полезны параметры запуска Octave --traditional или --braindead, см. Параметры командной строки.

Octave:legacy-function

Если предупреждение Octave:legacy-function включено, выводится предупреждение, когда Octave сталкивается с функцией, которая, по мнению MATLAB, должна быть избегнута. Функция может стать устаревшей в будущем и быть удалена, в этом случае предупреждение изменится на Octave:deprecated-function, а функция будет существовать ещё две версии Octave, прежде чем быть удалена. По умолчанию предупреждение Octave:legacy-function включено.

Octave:logical-conversion

По умолчанию предупреждение Octave:logical-conversion включено.

Octave:lu:sparse_input

Если предупреждение Octave:lu:sparse_input включено, Octave будет предупреждать, когда функция lu вызывается со разреженным входом и менее четырьмя выходными аргументами. В этом случае не будут выполняться сохраняющие разреженность перестановки столбцов, и результат может быть неточным. По умолчанию предупреждение Octave:lu:sparse_input включено.

Octave:missing-glyph

Если предупреждение Octave:glyph-render включено, Octave выведет предупреждение, если текущий шрифт не содержит глифа для используемого символа. По умолчанию предупреждение Octave:missing-glyph включено.

Octave:missing-semicolon

Если предупреждение Octave:missing-semicolon включено, Octave будет предупреждать, когда операторы в определениях функций не заканчиваются точкой с запятой. По умолчанию предупреждение Octave:missing-semicolon отключено.

Octave:mixed-string-concat

Если предупреждение Octave:mixed-string-concat включено, выводится предупреждение при конкатенации смешанных строковых литералов в одинарных и двойных кавычках. По умолчанию предупреждение Octave:mixed-string-concat отключено.

Octave:nearly-singular-matrix

Octave:singular-matrix

Эти предупреждения выводятся, если обратная матрица (почти) вырожденной матрицы. По умолчанию предупреждения Octave:nearly-singular-matrix и Octave:singular-matrix включены.

Octave:neg-dim-as-zero

Если предупреждение Octave:neg-dim-as-zero включено, выводится предупреждение для выражений, подобных

eye (-1)

По умолчанию предупреждение Octave:neg-dim-as-zero отключено.

Octave:noninteger-range-as-index

По умолчанию предупреждение Octave:noninteger-range-as-index включено.

Octave:num-to-str

Если предупреждение Octave:num-to-str включено, выводится предупреждение при неявном преобразовании чисел в их эквиваленты в кодировке UTF-8, когда строки строятся с использованием смешанных строк и чисел в матричной записи. Например,

[ "f", 111, 111 ]
⇒ "foo"

вызовет предупреждение, если предупреждение Octave:num-to-str включено. По умолчанию предупреждение Octave:num-to-str включено.

Octave:possible-matlab-short-circuit-operator

Если предупреждение Octave:possible-matlab-short-circuit-operator включено, Octave будет предупреждать об использовании некороткозамыкающихся операторов & и | внутри if или while условий. Они обычно не короткозамыкаются, но короткозамыкаются при использовании в условии. По умолчанию предупреждение Octave:possible-matlab-short-circuit-operator включено.

Octave:recursive-path-search

Если предупреждение Octave:recursive-path-search включено, Octave выведет предупреждение, если addpath используется с двойными обратными слешами. По умолчанию предупреждение Octave:recursive-path-search включено.

Octave:remove-init-dir

Функция path изменяет путь поиска, используемый Octave для нахождения функций. Возможно задать путь, исключающий встроенные функции Octave. Если включено предупреждение Octave:remove-init-dir, Octave выдаст предупреждение, когда функция path использована таким образом, что это может сделать Octave неработоспособным. По умолчанию предупреждение Octave:remove-init-dir включено.

Octave:reload-forces-clear

Если несколько функций загружены из одного файла, Octave должна очистить все функции, прежде чем любая из них сможет быть перезагружена. Если включено предупреждение Octave:reload-forces-clear, Octave выдаст вам предупреждение, когда это произойдёт, и выведет список дополнительных функций, которые ей необходимо очистить. По умолчанию предупреждение Octave:reload-forces-clear включено.

Octave:separator-insert

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

Octave:shadowed-function

Если включено предупреждение Octave:shadowed-function, Octave выведет предупреждение, если в путь поиска добавлен путь, содержащий функции, которые скрывают ядровые функции. По умолчанию предупреждение Octave:shadowed-function включено.

Octave:single-quote-string

Вывести предупреждение, если символ одинарной кавычки используется для ввода строковой константы. По умолчанию предупреждение Octave:single-quote-string отключено.

Octave:sqrtm:SingularMatrix

По умолчанию предупреждение Octave:sqrtm:SingularMatrix включено.

Octave:str-to-num

Если включено предупреждение Octave:str-to-num, выводится предупреждение об неявном преобразовании строк в их числовые последовательности байтов UTF-8. Например,

"abc" + 0
⇒ 97 98 99

вызывает предупреждение, если включено предупреждение Octave:str-to-num. По умолчанию предупреждение Octave:str-to-num отключено.

Octave:text_interpreter

Если включено предупреждение Octave:text_interpreter, выводится предупреждение, когда свойство "interpreter" объекта текстовой графики устанавливается в недопустимое значение "latex". Даже при включении, сообщение о предупреждении выводится только один раз за сеанс Octave. По умолчанию предупреждение Octave:glyph-render включено.

Octave:variable-switch-label

Если включено предупреждение Octave:variable-switch-label, Octave выведет предупреждение, если метка переключения не является константой или выражением константы. По умолчанию предупреждение Octave:variable-switch-label отключено.