Индикатор ошибки после вызова Far.Cfg.Get: =0 - нет ошибок, =1 - ошибка.

Значение константы необходимо проверять сразу после вызова функции Far.Cfg.Get, в других случаях значение константы не имеет смысла.

Состояние клавиш мыши.

Младший бит соответствует самой левой кнопке, следующий - самой правой, cледующий бит - следующая за левой клавиша. Далее биты соответствуют клавишам слева направо.

Если бит установлен - клавиша нажата.

Определены следующие константы для первых пяти клавиш мыши:

Если подстрока S2 содержится в строке S1, то возвращается её позиция, иначе -1.

Необязательный параметр CaseSensitive задаёт режим сравнения: 0 (по умолчанию) - без учёта регистра, 1 - с учётом регистра.

Если подстрока S2 содержится в строке S1, то возвращается её позиция, иначе -1.

Поиск ведётся от конца строки S1.

Необязательный параметр CaseSensitive задаёт режим сравнения: 0 (по умолчанию) - без учёта регистра, 1 - с учётом регистра.

В строке Str заменить подстроку Find на подстроку Replace Cnt раз.

Если параметр Cnt меньше или равен 0, либо опущен, то будут заменены все вхождения Find.

Возвращается результат замены.

Необязательный параметр CaseSensitive задаёт режим сравнения: 0 (по умолчанию) - без учёта регистра, 1 - с учётом регистра.

Замечания:

• если Find - пустая строка, то возвращается Str без преобразований;
• если Replace - пустая строка, то возвращается копия Str, в которой удалены все подстроки Find;

Конвертирует целое число N в строку.

Значение Radix определяет основание, которое должно использоваться при преобразовании числа N. Допустимые значения Radix от 2 до 36.

Если параметр Radix не указан, то подразумевается основание 10.

Конвертирует строку S в число.

Значение Radix определяет основание, которое будет использоваться при преобразовании строки S. Допустимые значения Radix от 2 до 36.

Если параметр Radix не указан или равен 0, то функция попытается сама определить, в каком виде представлено строковое представление числа.

Возвращает подстроку из выражения V начиная с позиции start длиной length.

Если start >= 0, то вернётся подстрока, начиная с позиции start от начала строки.

Если start < 0, то вернётся подстрока, начиная с позиции start от конца строки.

Если length > 0, то возвращаемая подстрока будет состоять максимум из length символов исходной строки начиная с позиции start.

Если length < 0, то в возвращаемой подстроке будет отсутствовать length символов от конца исходной строки, при том, что она будет начинаться с позиции start.

Если length = 0 или не указан, то возвращается подстрока от start до конца строки.

Примеры

Функция форматирует число Size (например, размера файла) по заданным условиям, указанным в Flags, шириной Width.

Параметр Flags может быть комбинацией следующих значений:

Если Width не указан или равен 0, то подразумевается - "сколько получится". Отрицательное значение ширины позволяет выравнивать слева:

Форматирует (с выравниваением влево) исходный текст Text по заданной ширине Width, используя разделительную строку Break.

Если Flags равен 0x1, то строка всегда сворачивается по заданной ширине, даже если есть слово, которое больше заданной ширины (в этом случае то оно будет разрезано на части). Если флаг не указан или не равен 0x1 и есть длинное слово, то такое слово не будет разрезано и займет ширину больше чем указано в Width.

Примеры

 +-------+
 |Пример
 |строки,
 |которая
 |будет
 |разбита
 |на
>|несколько
 |строк
 |по
 |ширине
 |в 7
>|символов.
 +-------+

  1234567
 +-------+
 |Пример
 |строки,
 |которая
 |будет
 |разбита
 |на
 |несколь
 |ко
 |строк
 |по
 |ширине
 |в 7
 |символо
 |в.
 +-------+

  123456789
 +---------+
 |Эта
 |строка
 |содержит
 |ооооооооо
 |ооооччччч
 |чччеееень
 |длиное
 |слово
 +---------+

Триггер, переключающий язык названий месяцев и дней недели - английский/локальный.

Far Manager запрашивает у системы 2 набора наименований:

1) английские наименования месяцев и дней недели

2) наименования, соответствующие настройкам текущего пользователя (LOCALE_USER_DEFAULT)

По умолчанию выставляются английские наименования.

Подобно переводу строки `\\n'

Внимание! В редакторе автоотступ не работает.

Проверяет существование файла/папки S (возвращает 0 или 1).

В параметр S допускается использование символов '*' и '?'. В этом случае функция проверяет только первое вхождение файла/папки.

В отличие от panel.fexist(), функция не работает с панелями.

Тестирует папку S.

Возвращает:

Если > 0 - существует и доступна

Если = 0 - не существует, но можно попробовать создать

Если < 0 - ничего обнадеживающего функция не сообщает

Возвращает файловые атрибуты файла/папки S:

Если файловый объект не существует, функция возвращает -1.

В параметре S допускается использование символов масок '*' и '?'. В этом случае функция возвращает атрибуты только для первого найденного файла/папки.

В отличие от panel.fattr(), функция не работает с панелями.

Тестирует строку S на соответствие маске Mask.

Mask может быть:

- маской

- списком масок (разделённых запятой или точкой с запятой)

- маской исключения - одной или несколькими масками файлов, которой не должна соответствовать строка S. Маска исключения отделяется от основной маски символом |

- регулярным выражением. Текст регулярного выражения должен быть окружён символами /

Возвращает:

Примеры

Показывает сообщение Text с заголовком Title.

В параметре Text строки разбиваются символом '\n'.

Flags может быть набором следующих значений:

Если параметр Flags равен 0 (или не указан), то выводится стандартный диалог с кнопкой <Ok>

Функция возвращает номер выбранной кнопки (начиная с 1), или 0, если пользователь отменил сообщение

Функция позволяет ввести одну строку текста.

Параметры: Title - заголовок диалога, Prompt - приглашения для ввода, Src - начальное значение строки ввода, History - имя истории ввода.

Flags может быть набором следующих значений (аналогичных константам FIB_*):

Функция возвращает строку (введённое пользователем значение) или число 0, если пользователь нажал Esc.

Например, запросить пароль и вывести его:

%s=prompt("Password","Input password:",0x02); print(%s)

Функция предназначена для вставки произвольного текста Str в редактор, командную строку, элементы ввода в диалогах, etc.

Допускается применение следующих escape-последовательностей:

Функция возвращает 1.

Например, создание папки с именем, равным текущей дате:

%Folder=date("%d.%m0.%Y");
$If (!panel.fexist(0,%Folder))
  F7
  print(%Folder)
  Enter
$End

Ожидает любую клавишу и возвращает её название (T=0) или значение (T=1).

Если время ожидания N (миллисекунды) истекло, функция возвращает пустую строку (T=0) или 0 (T=1).

Если параметр N не указан или равен 0, то функция будет бесконечно ждать нажатия клавиши.

Преобразует параметр V в строковый эквивалент названия клавиши.

Если V - строка, то проверяется правильность написания клавиши и она же возвращается.

Если V - число, то происходит попытка преобразовать значение в текстовый эквивалент названия клавиши.

В случае ошибок - возвращается пустая строка.

Позволяет работать с переменной среды Name. Если Mode не указан или равен 0, то функция возвращает значение переменной среды (Value в этом случае игнорируется). Если Mode указан и отличен от 0, то функция устанавливает значение или удаляет переменную среды.

Для варианта установки/удаления функция возвращает предыдущее значение (или пустую строку, если переменная была не определена).

Напримеры.

Получить значение переменной среды Foo

Env("Foo")
Env("Foo",0)
Env("Foo",0,любое_значение)
Env("Foo",,любое_значение)

Установить значение переменной среды Foo в "bar"

Env("Foo",1,"Bar")

Удалить переменную среды Foo

Env("Foo",1)
Env("Foo",1,"")

Установить значение переменной среды Foo в "0"

Env("Foo",1,"0")
Env("Foo",1,0)

Если выбран английский язык интерфейса Far Manager, то что-то делаем

$if (Env("FARLANG") == "English") что-то делаем $end

сlip(1,"Name;Size\r\n")
Home
$While(!APanel.Eof)
  $If(!APanel.Folder && panel.item(0,0,8))
     clip(2,panel.item(0,0,0)+";"+panel.item(0,0,6)+"\r\n")
  $End
  Down
$End

Позволяет переключить состояние Lock-клавиш (NumLock, CapsLock и ScrollLock).

Клавиша Lkey:

Функция в младшем бите возвращает предыдущее значение выбранной клавиши (или текущее, если Action=-1).

Функция капризная (возможно зависание компьютера), поэтому пользоваться ей надо осторожно.

Например, макрос, повешенный на Ctrl+CapsLock (переключение между окнами) должен иметь некую обвязку:

CtrlShiftTab
%a=flock(1,-1)&1;
$while((flock(1,-1)&1)==%a)
  sleep(50)
  flock(1,2)
$end

Управление раскладкой клавиатуры.

Параметр V:

Функция возвращает предыдущее значение раскладки или 0 в случае ошибки (не удалось определить имя текущей раскладки для консоли или не удалось получить описатель консольного окна).

Например:

print(itoa(kbdLayout(0x421),16))

при текущей русской раскладке просто вернёт 4190419

print(itoa(kbdLayout(),16))

при текущей русской раскладке вернёт 4190419

print(itoa(kbdLayout(0x409),16))

при текущей русской раскладке вернёт 4190419 и переключит рaскладку на английскую

print(itoa(kbdLayout(1),16))

при текущей русской раскладке вернёт 4190419 и переключит на следующую рaскладку (по кругу)

Функция, позволяет получить основные текущие настройки Far Manager.

Состояние ошибки (нет такого Key или Name или внутренняя ошибка) можно проверить с помощью макроконстанты Far.Cfg.Err.

Например,

Far.Cfg.Get("System.KnownIDs","Network")

Far.Cfg.Get("KeyMacros","DateFormat")

Far.Cfg.Get("KeyMacros","TimeFormat")

Внимание!

• В процессе разработки Far Manager настройки (имена ключей и имена значений) могут меняться, добавляться и удаляться, поэтому Вы используете функцию на свой страх и риск. Поддержка функционала (имена ключей и имена значений) со стороны разработчиков не гарантирована.

Сохраняет в базу значение глобальной переменной с именем S в область Vars.

В случае неудачи возвращает 0.

Считать из базы значение глобальной переменной с именем S (область Vars).

Функция вернёт 1 - есть такая переменная и она успешно считана в память, 0 - неудача, нет такой переменной в базе (в этом случае переменная не создаётся). Если переменная была в памяти, а из базы запись удалили, то значение в памяти не изменяется.

Возвращает название или код клавиши, вызвавшей макропоследовательность.

Mode = 0 - возвращается код клавиши, Mode = 1 - возвращается наименование клавиши.

Type = 0 - возвращает реально нажатое сочетание, которым вызывался макрос, Type = 1 - возвращает клавишу, на которую назначен макрос.

Пример см. в описании $AKey.

Для всех режимов, кроме Mode=3, функция возвращает 0 в случае успешной компиляции последовательности S или код ошибки:

Локальные переменные - общие для текущего исполняемого макроса и макропоследовательности, исполняемой функцией eval.

Пример см. в разделе Примеры.

Управление параметрами текущего макроса.

Параметр Action:

mmode(3,1)
plugin.call("C941E865-9C29-485C-99B3-0C710940F2D8",
  "ShiftRight ShiftRight ShiftDown ShiftDown ShiftLeft ShiftLeft ShiftUp ShiftUp ShiftRight Esc") 

plugin.call("C941E865-9C29-485C-99B3-0C710940F2D8")
  ShiftRight ShiftRight ShiftDown ShiftDown ShiftLeft ShiftLeft ShiftUp ShiftUp ShiftRight Esc 

Параметр Value:

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

Необязательный параметр State:

Если соответствующий бит выставлен, то история блокируется.

Если параметр не указан, то просто возвращает текущую маску.

Функция возвращает предыдущее значение.

При старте макроса разрешено добавление во все истории.

Примеры

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

Необязательный параметр Mode:

Функция возвращает предыдущее состояние видимости линейки:

Например, Esc при погашенных панелях гасить и кейбар:

CtrlO $if (APanel.Visible && PPanel.Visible) KeyBar.Show(1) $else KeyBar.Show(2) $end

Вызвать плагин, имеющий идентификатор Guid с параметром param.

Plugin.call вызывает экспортируемую функцию OpenW требуемого плагина.

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

Аналог вызова плагина из меню "Параметры плагинов" без необходимости задавать горячие клавиши или искать плагин в списке. Работает только в панелях.

Guid и MenuGuid можно посмотреть в диалоге "Plugin information" (F3 в списке): поля "Plugin GUID" и "Plugin item GUID" соответственно.

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

Если плагин отсутствует в списке "Параметры плагинов" или при вызове не из панелей - функция вернет ошибку.

Функция возвращает 1 - плагин/пункт найден или 0 - в случае ошибки.

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

Функция возвращает 1 - есть такой плагин или 0 - в случае ошибки.

Загрузить плагин с именем dll-модуля DllPath. Если указан ForceLoad, отличный от 0, то плагин загружается сразу в память.

Функция возвращает 1 - плагин загружен или 0 - в случае ошибки.

Аналог вызова плагина из меню плагинов по F11 без необходимости задавать горячие клавиши или искать плагин в списке.

Guid и MenuGuid можно посмотреть в диалоге "Plugin information" (F3 в списке): поля "Plugin GUID" и "Plugin item GUID" соответственно.

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

Если плагин отсутствует в списке F11 для текущей макрообласти - функция вернет ошибку.

Функция возвращает 1 - плагин/пункт найден или 0 - в случае ошибки.

Пример использования - открыть FarColorer\Outliner list:

%I = plugin.menu("D2F36B62-A470-418D-83A3-ED7A3710E5B5","45453CAC-499D-4B37-82B8-0A77F7BD087C");
$If (%I==1) 5 $End

Аналог вызова плагина по префиксу из панелей без необходимости запоминать/очищать/восстанавливать текущее содержимое командной строки.

Guid можно посмотреть в диалоге "Plugin information" (F3 в списке F11 или AltShiftF9): поле "Plugin GUID".

Если плагин с таким Guid не поддерживает вызов по префиксу или при вызове не из панелей - функция вернет ошибку.

Функция возвращает 1 - плагин/пункт найден или 0 - в случае ошибки.

Выгрузить плагин с именем dll-модуля DllPath.

Функция возвращает 1 - плагин выгружен или 0 - в случае ошибки.

Создаёт и отображает на экране меню.

Параметр Items: пункты меню, разделённые Lf ("\n") или CrLf ("\r\n")

Могут начинаться (возможны некоторые комбинации) со специальных символов:

Необязательный параметр TitleAndFooter: заголовок и футер меню, разделённые Lf ("\n") или CrLf ("\r\n"). Один или оба могут отсутствовать.

Необязательный параметр Flags - набор битов, управляющих поведением и отображением меню:

Необязательный параметр SelectOrFilter - на какой пункт меню позиционировать курсор, либо фильтрация пунктов.
Может быть:

Необязательные параметры X и Y - координаты левого верхнего угла меню. Если одна (или обе) равны -1 (по умолчанию), то производится центрирование меню по этой координате.

Возвращаемый результат функции:

В меню доступны следующие сочетания клавиш: (пометка возможна только при установленном бите 4)

%I = 1;
%S = "";
$While (%I <= Bm.Stat(0))
  Bm.Goto(%I);
  %S = %S + Editor.Value + "\n";
  %I = %I + 1;
$End

%I = 1;
$While (%I!=0)
  %I=Menu.Show(%S, "Стековые закладки\nНавигация - Up/Down, Выход - Esc, F10", 0x600, abs(%I),80,FAR.Height-Bm.Stat(0)-5);
  $If (%I > 0)
    Bm.Goto(%I);
    $SelWord;
  $Else
    %I=0;
  $End
$End

Возвращает информацию о функции с индексом Index (начинается с 1). Если Index=0, то возвращается количество зарегистрированных макрофункций (число).

Необязательный параметр Type может быть одним из следующих значений:

Функция вернет пустую строку, если функция с индексом Index отсутствует.

Возвращает ключевое слово с индексом Index (начинается с 1). Если Index=0, то возвращается количество слов (число).

Необязательный параметр Type может быть одним из следующих значений:

Функция вернет пустую строку, если ключевое слово с индексом Index отсутствует.

Возвращает информацию о константе с индексом Index (начинается с 1). Если Index=0, то возвращается количество констант (число).

Необязательный параметр Type может быть одним из следующих значений:

Типы и значения констант могут быть:

Функция вернет 0, если константа с индексом Index отсутствует. В этом случае тип возвращаемого значения будет "unknown".

Тип возвращаемого значения для Type=1 зависит от типа константы.

Возвращает информацию о глобальной переменной с индексом Index (начинается с 1). Если Index=0, то возвращается количество глобальной переменных (число).

Необязательный параметр Type может быть одним из следующих значений:

Типы и значения переменных могут быть:

Функция вернет 0, если глобальной переменная с индексом Index отсутствует. В этом случае тип возвращаемого значения будет "unknown".

Тип возвращаемого значения для Type=1 зависит от типа перменной.