[ новости /+++ | форум | теги | ]

Каталог документации / Раздел "Программирование, языки" / Оглавление документа

  Http

Клиентская часть реализации протокола HTTP/1.0.
 

Синтаксис

Описание

Команды

Массив состояния транзакции

 

СИНТАКСИС

package require http?2.0?

::http::config ?options?

::http::geturl url ?options?

::http::formatQuery list

::http::resetk token

::http::wait token 

::http::status token

::http::size token 

::http::code token 

::http::data token 
 

ОПИСАНИЕ

 
Пакет http обеспечивает клиентскую часть протокола HTTP/1.0 и реализует операции GET, POST и HEAD. Он позволяет конфигурировать сервер-представитель (proxy) для выхода через межсетевые экраны. Пакет совместим с политикой безопасности Safesock.

Процедура ::http::geturlвыполняет HTTP транзакцию. В зависимости от заданной опции это может быть GET, POST или HEAD транзакция. Величина, возвращаемая процедурой ::http::geturl, является признаком (token) выполнения транзакции. Кроме того, ее значение совпадает с именем массива в пространстве имен ::http, который содержит информацию о выполнении транзакции. Элементы массива описаны ниже, см. ⌠Массив состояния транзакции■.

Если процедура вызвана с опцией -command, операция выполняется в фоновом режиме. Процедура ::http::geturl завершается сразу после формирования HTTP запроса, а результаты запроса обрабатываются после их получения. Для успешной работы в таком режиме необходимо, чтобы был запущен обработчик событий. Это всегда так для Tk-приложений. В чисто Tcl ≈ приложениях можно использовать процедуру ::http::wait для запуска обработчика событий.
 

КОМАНДЫ

 
::http::config ?options?

Команда ::http::config используется, чтобы установить или запросить имя proxy-сервера, порта и пользовательского приложения (User-Agent), используемые в HTTP запросах. Если никакие опции не заданы, возвращается текущая конфигурация. Если задан единственный аргумент, тогда, он должен быть именем одной из опций, описанных ниже. В этом случае возвращается текущая величина указанной опции. В противном случае аргументы состоят из пар: имя опции ≈ присваиваемое значение.

-accept mimetypes

Определяет типы документов, которые могут быть приняты по запросу. Значение по умолчанию ▒*/*▓ означает, что могут быть приняты документы любого типа. Чтобы ограничить список допустимых документов, можно использовать список (через запятую) шаблонов документов следующего вида: ⌠image/gif, image/jpeg, text/*■.

-proxyhost hostname

Имя proxy-сервера, через который осуществляется связь. Если не указано, связь осуществляется напрямую.

-proxyport number

Имя proxy-порта.

-proxyfilter command

Определяет команду, которая возвращает имена proxy-сервера и proxy-порта, необходимые для данной связи. В противном случае возвращает пустое значение. В качестве аргумента при вызове команды используется имя сервера (host). Если команда не задана, используются значения опций -proxyhost и -proxyport.

-useragent string

Определяет имя пользовательского приложения (User-Agent). Значение по умолчанию ⌠Tcl http client package 2.0.■

::http::geturl url ?options?

Команда ::http::geturl ≈ основная команда пакета. Если задана опция -query, выполняется операция POST, если задана опция -validate, выполняется операция HEAD. В противном случае выполняется операция GET. Команда возвращает признак ≈ имя массива, который может быть использован для получения дополнительной информации о состоянии транзакции. Подробности см. ⌠Массив состояния транзакции■. Команда завершается после завершения соответствующей операции, если она вызвана без опции -command. В противном случае команда ::http::geturl завершается немедленно, а по завершении операции вызывается соответствующая команда для обработки ее результатов. Команда ::http::geturl может использоваться с различными опциями:

-blocksize size
 

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

-channel name

Перенаправляет полученную информация в соответствующий канал вместо того, чтобы сохранять ее в переменной state(body).

-command callback

Обеспечивает вызов команды callback после завершения транзакции. При использовании этой опции команда ::http::geturl завершается сразу. Команда callback вызывается с аргументом token, который содержит имя массива, описанного ниже, см. ⌠Массив состояния транзакции■. Ниже приведен шаблон типовой процедуры для использования в данной опции:

proc httpCallback {token} {

upvar #0 $token state
# Далее возможна работа со state как с обычным Tcl-массивом

}

-handler callback

Опция обеспечивает вызов команды callback как только HTTP данные получены. Команда получает два дополнительных аргумента: HTTP socket и имя массива token, возвращенное командой ::http::geturl (см. ⌠Массив состояния транзакции■). Команда должна возвращать число байтов, прочитанных из socket. Ниже приведен шаблон подобной процедуры:

proc httpHandlerCallback {socket token} {

upvar #0 $token state
# Получен доступ к socket и Tcl-массиву state
...
(например: set data [read $socket 1000];set nbytes [string length $data])
...
return nbytes

}

-headers keyvaluelist

Опция используется для включения в заголовок HTTP запроса дополнительных полей. Аргумент должен быть правильным списком с четным числом элементов, состоящим попеременно из ключей и их значений. Ключи используются как имена полей заголовка. Из значений удаляются символы перехода на новую строку, чтобы избежать формирования неправильного заголовка. Например, если keyvaluelist содержит список {Pragma no-cache} будет сформирован следующий заголовок запроса:

Pragma: no-cache

-progress callback

Опция обеспечивает вызов команды callback для обработки очередной порции данных. Команда callback получает три аргумента: значение token, возвращенное командой ::http::geturl, предполагаемый полный размер данных из мета-данных и текущее количество поступивших данных в байтах. Если  едполагаемый полный размер неизвестен, вместо него подставляется 0. Ниже приведен шаблон для процедуры, вызываемой по опции -progress:

proc httpProgress {token total current} {

upvar #0 $token state

}

-query query

Если указана данная опция, ::http::geturl формирует запрос POST и передает его на сервер. Запрос должен быть сформатирован. Для выполнения форматирования может использоваться процедура ::http::formatQuery.

-timeout milliseconds

Если значение milliseconds не равно нулю, устанавливается соответствующее время задержки. Задержка выполняется перед вызовом команды ::http::reset и команды, заданной опцией -command. Во время задержки команда ::http::status возвращает значение timeout.

-validate boolean
 

Если значение boolean не равно нулю, ::http::geturl выполняет HTTP HEAD запрос. Такой запрос возвращает мета информацию об источнике данных (URL), а не его содержание. Мета информация содержится в переменной state(meta) (см. ⌠Массив состояния транзакции■).

::http::formatQuery key value?key value...?

Команда выполняет перекодирование запроса. Команда использует четное число аргументов, являющихся соответственно ключами запроса и их значениями. Она преобразует ключи и значения и возвращает одну строку, в которой расставлены необходимые ⌠&■ и ⌠=■ разделители. Результат можно использовать в качестве значения для опции -query команды ::http::geturl.

::http::reset token?why?

Команда перезапускает HTTP транзакцию token, если такая исполняется. Значение переменной state(status) при этом переустанавливается в why (по умолчанию ≈ reset) и вызывается команда, заданная опцией -command.

::http::wait token

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

::http::data token

Эта команда возвращает значение переменной state(body).

::http::status token

Эта команда возвращает значение переменной state(status).

::http::code token

Эта команда возвращает значение переменной state(http).

::http::size token
 

Эта команда возвращает значение переменной state(currentsize).

МАССИВ СОСТОЯНИЯ ТРАНЗАКЦИИ

 
Команда ::http::geturl возвращает token ≈ имя Tcl-массива, содержащего информацию о HTTP транзакции. Для упрощения доступа к массиву можно использовать следующую конструкцию:
 

upvar #0 $token state

Массив содержит следующие элементы:
 

body

Содержание документа, заданного с помощью URL. Пусто, если указана опция -channel. Значение переменной можно получить также с помощью команды ::http::data.

сurrentsize

Текущий объем информации в байтах, полученный от источника. Значение переменной можно получить с помощью команды ::http::size.

error

Если элемент определен, он содержит строку с сообщением об ошибке, полученную при прерывании HTTP транзакции.

http

Элемент содержит значение HTTP статуса, полученное от сервера. Значение переменной можно получить также с помощью команды ::http::code. Статус представляет собой строку из трех цифр, значения которой соответствуют HTTP стандарту. Код 200 соответствует успешному выполнению транзакции. Коды, начинающиеся с ▒4▓ или ▒5▓, указывают на ошибку. Коды, начинающиеся с ▒3▓, соответствуют ошибкам перенаправления. В этом случае мета данные Location определяют новый источник информации, который содержит запрошенные данные.

meta

Мета данные, описывающие содержание документа. Данный элемент массива содержит список ключей и их значений. Чтобы облегчить доступ к данным можно использовать следующую конструкцию:

array set meta $state(meta)

Некоторые ключи мета данных перечислены ниже, но в HTTP стандарте их перечислено больше, кроме того, сервер может добавлять собственные.

Content-Type

Тип документа. Например, text/html, image/gif, application/postscript или application/x-tcl.

Content-Length

 

Объявленный размер документа. Реальный объем информации, полученной с помощью команды ::http::geturl, содержится в переменной state(size).

Location

Измененный адрес документа.

status

Возможные значения ok, reset или error. Во время транзакции значение пустое.

totalsize

Копия значения мета данных Content-Length.

type

Копия значения мета данных Content-Type.

url

Запрошенный адрес.

Пример:
 

# Копирование источника в файл и печать мета данных
proc ::http::copy { url file {chunk 4096} } {

set out [open $file w]
set token [geturl $url -channel $out -progress ::http::Progress \
  -blocksize $chunk]
close $out
# Следующая команда завершает строку, начатую процедурой http::Progress
puts stderr ⌠■
upvar #0 $token state
set max 0
foreach {name value} $state(meta) {
  if {[string length $name] > $max} {

  set max [string length $name]
  }

  if {[regexp -nocase ^location$ $name]} {

  # Обработка перенаправления адреса
  puts stderr ⌠Location:$value■
  return [copy [string trim $value] $file $chunk]
 }

}

incr max
foreach {name value} $state(meta) {

 puts [format ⌠%-*s %s■ $max $name: $value]
}

return $token

}
proc ::http::Progress {args} {
puts -nonewline stderr. ; flush stderr
}

Механизм создания и управления безопасными интерпретаторами.
 

Синтаксис

Описание

Синонимы

Команды

Опции

Безопасность

СИНТАКСИС

 
 

::safe::interpCreate?slave??options...?

::safe::interpInit slave?options...?

::safe::interpConfigure slave?options...?

::safe::interpDelete slave

::safe::interpAddToAccessPath slave directory

::safe::interpFindInAccessPath slave directory

::safe::setLogCmd?cmd arg...?
 
 

ОПИСАНИЕ

 
 

Safe Tcl ≈ это механизм безопасного исполнения ненадежных Tcl скриптов и предоставления этим скриптам опосредованного доступа к потенциально опасным функциям.

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

Safe Tcl позволяет интерпретатору-предку создавать безопасные интерпретаторы с ограниченными возможностями, в которых содержится набор предопределенных синонимов для команд source, load, file и exit и сохраняются возможности автозагрузки команд и пакетов.

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

Все команды для работыс безопасными интерпретаторами содержатся в пространстве имен safe. Команда ::safe::interpCreate создает безопасный интерпретатор. Возможные опции команды описаны ниже, см. ⌠Опции■.
Команда возвращает имя созданного интерпретатора. Команда ::safe::interpInit аналогична, но ее первым аргументом должно быть имя интерпретатора, созданного с помощью команды interp. Команда ::safe::interpDelete удаляет интерпретатор, имя которого использовано в качестве аргумента. Команда ::safe::interpConfigure позволяет задать опции для безопасного интерпретатора или получить информацию об заданных ранее опциях. Подробно опции описаны ниже (см.  ⌠Опции■).

Для каждого безопасного интерпретатора, созданного с помощью команды ::safe::interpCreate или инициированного с помощью команды ::safe::interpInit в родительском интерпретаторе создается список доступных каталогов ≈ виртуальный путь. Каждый каталог в пути связывается с реальным каталогом локальной файловой системы и с меткой, доступной в безопасном интерпретаторе. В результате надежный интерпретатор обходится без сведений о реальной файловой системе на машине, на которой исполняется интерпретатор. Когда в надежном интерпретаторе используется метка для доступа к конкретному файлу (например, для выполнения команды source или load), метка заменяется в родительском интерпретаторе на настоящее имя каталога и необходимый файл ищется в файловой системе. Надежный интерпретатор не получает сведений о реальном имени файла в файловой системе. Для работы с виртуальными именами файлов предусмотрены специальные команды. Команда::safe::interpConfigure позволяет задавать новый виртуальный путь для интерпретатора. Команда ::safe::interpAddToAccessPath позволяет добавлять каталоги к виртуальному пути указанного безопасного интерпретатора. Команда ::safe::interpFindInAccessPath позволяет найти каталог в виртуальном пути для безопасного интерпретатора и получить его метку. Если каталог не найден, выдается сообщение об ошибке.

Команда ::safe::setLogCommand позволяет задать скрипт, который выполняется при каждом событии в безопасном интерпретаторе. Этот скрипт вызывается с одним аргументом ≈ строкой, содержащей описание события.
 

СИНОНИМЫ

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

source fileName

Аналогична команде source, однако позволяет работать только с файлами в виртуальном пути безопасного интерпретатора. Имя файла fileName должно содержать одну из меток, определенных для каталогов в виртуальном пути. Допустимые имена файлов более подробно описаны ниже (см. ⌠Безопасность■). load fileName
  Требуемый файл (обычно, объектный файл из разделяемой библиотеки) загружается в безопасный интерпретатор, если его удается найти. Имя файла должно содержать одну из меток для каталогов виртуального пути. Кроме того, разделяемый объектный файл должен содержать безопасную точку входа. Подробности приведены в описании команды load.

file?options?

Синоним команды file содержит только безопасные подкоманды обычной команды file, а именно: dirname, join, extension, root, tail, pathname и split. Назначение подкоманд приведено в описании команды file. exit При выполнении команды безопасный интерпретатор удаляется, вычисления в нем прерываются, но родительский интерпретатор продолжает существовать.

КОМАНДЫ

 
В родительском интерпретаторе для работы с безопасными интерпретаторами предусмотрены следующие команды:

::safe::interpCreate?slave??options...?

Создает безопасный интерпретатор, инициализирует в нем команды ≈ синонимы, описанные выше, и механизмы автозагрузки команд и пакетов в соответствии с заданными опциями (см. ⌠Опции■). Если аргумент slave отсутствует, имя интерпретатора формируется автоматически. Команда всегда возвращает имя созданного интерпретатора. ::safe::interpInit  slave?options...? Команда аналогична предыдущей, однако интерпретатор должен быть уже создан каким-либо иным способом, например с помощью команды ::interp create-safe. ::safe::interpConfigure  slave?options...? Если опции не заданы, возвращает значения всех опций для указанного безопасного интерпретатора. В противном случае устанавливает указанные значения опций (подробнее см. ⌠Опции■). ::safe::interpDeleteslave
  Удаляет безопасный интерпретатор и вычищает в родительском интерпретаторе информацию о нем. Перед удалением выполняется скрипт, заданный с помощью опции -deletehook, если он был задан. К скрипту добавляется дополнительный аргумент ≈ имя удаляемого интерпретатора.

::safe::interpFindInAccessPathslave directory

Команда возвращает метку, которую можно использовать в безопасном интерпретаторе для каталога directory. Если в виртуальном пути нет такого каталога, возвращается сообщение об ошибке.

Пример использования команды:

###Создание безопасного интерпретатора
::safe::interpCreate qqq
###Присваивание переменной tk_library метки соответствующего каталога
qqq eval [list set tk_library [::safe::interpFindInAccessPath qqq $tk_library]]
###Выполнение команды source в безопасном интерпретаторе
qqq eval source \$tk_library/msgbox.tcl

::safe::interpAddToAccessPathslave directory Команда позволяет добавить к виртуальному пути указанного безопасного интерпретатора каталог directory. Команда возвращает значение метки для каталога directory. Если каталог уже содержался в виртуальном пути, команда только возвращает его метку и не добавляет его в виртуальный путь. Пример использования команды (см. пример к предыдущей команде):
  ::safe::interpAddToAccessPath qqq $my_lib
qqq eval source \$my_lib/\$my_file ::safe::setLogCmd?cmd arg...? Эта команда позволяет задать скрипт, который будет выполняться при различных событиях, связанных с безопасными интерпретаторами. Если команда вызвана без аргументов, то она возвращает установленный ранее скрипт. Вызванная с одним аргументом ≈ пустой строкой ≈ команда удаляет установленный ранее скрипт и отменяет процесс журнализации. Установленный скрипт выполняется с одним дополнительным аргументом ≈ строкой, описывающей событие. Основное назначение команды ≈ использование при отладке скриптов, выполняемых в безопасных интерпретаторах. Используя ее, вы сможете получить полную информацию об ошибке, в то время как безопасный интерпретатор возвращает только обобщенное сообщение об ошибке (это позволяет избежать разглашения в сообщении об ошибке конфиденциальной информации, например, о реальных именах файлов). Пример использования:

::safe::setLogCmd puts stderr
 

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

NOTICE for slave interp10 : Created
NOTICE for slave interp10 : Setting accessPath=(/foo/bar) staticsok=1 nestedok=0 deletehook=()
NOTICE for slave interp10 : auto_path in interp10 has been set to {$p(:0:)}
ERROR for slave interp10 : /foo/bar/init.tcl: no such file or directory
 

ОПЦИИ

 
Для команд ::safe::interpCreate, ::safe::interpInit, и :safe::interpConfigure определены перечисленные ниже опции. Имена опций могут быть сокращены до минимальных однозначных имен. Имена опций не чувствительны к регистру, в котором они набраны.

-accessPath?directoryList?

Опция задает список каталогов, к которым может иметь доступ безопасный интерпретатор, и возвращает метки соответствующих каталогов. Если список не задан или если он пуст, безопасный интерпретатор получает доступ к каталогам, используемым для автозагрузки в родительском интерпретаторе. Подробнее см. ⌠Безопасность■. -noStatics Если эта опция задана, то не допускается загрузка статически связанных пакетов (как load {} Tk). По умолчанию загрузка таких пакетов разрешена. -nestedLoadOk Если эта опция задана, безопасный интерпретатор может загружать пакеты в собственные подинтерпретаторы. По умолчанию загрузка пакетов в подинтерпретаторы запрещена. -deleteHook?script? Если скрипт задан, он выполняется в родительском интерпретаторе (с дополнительным аргументом ≈ именем безопасного интерпретатора) перед удалением безопасного интерпретатора. Если скрипт не задан, то удаляется заданный ранее скрипт (если такой был) и никаких дополнительных действий перед удалением безопасного интерпретатора не производится. По умолчанию скрипт не задан.

БЕЗОПАСНОСТЬ

 
Save Tcl не дает полной гарантии безопасности. В частности, он не защищает от атак на сервер, когда поглощаются все ресурсы процессора и пользователь не может использовать компьютер для полезной работы. Однако такие атаки считаются, как правило, менее опасными, чем несанкционированный доступ к информации и нарушение целостности, от которых безопасный интерпретатор защищает. В безопасном интерпретаторе, помимо безопасного набора команд, который описан в описании команды interp, имеются синонимы для команд source, load, exit и безопасное подмножество подкоманд команды file. В безопасном интерпретаторе возможна автозагрузка библиотек и пакетов. Поскольку эти команды имеют дело с локальной файловой системой, существует потенциальная опасность использования их для доступа к конфиденциальной информации. Чтобы предотвратить эту возможность, в безопасном интерпретаторе используются не настоящие имена каталогов, а специальные метки. Эти метки транслируются в реальные имена файлов только в родительском интерпретаторе.

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

По умолчанию в Tcl переменной auto_path содержатся метки для каталогов, содержащихся в аналогичной переменной в родительском интерпретаторе и их непосредственных подкаталогов. Первая метка в списке присваивается также Tcl переменной tcl_library безопасного интерпретатора. Вы можете сократить этот список, в явном виде задав доступные каталоги для безопасного интерпретатора с помощью опции -accessPath.
 
 

Safe Tcl ≈ это механизм безопасного исполнения ненадежных Tcl скриптов и предоставления этим скриптам опосредованного доступа к потенциально опасным функциям.

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

Safe Tcl позволяет интерпретатору-предку создавать безопасные интерпретаторы с ограниченными возможностями, в которых содержится набор предопределенных синонимов для команд source, load, file и exit и сохраняются возможности автозагрузки команд и пакетов.

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

Все команды для работыс безопасными интерпретаторами содержатся в пространстве имен safe. Команда ::safe::interpCreate создает безопасный интерпретатор. Возможные опции команды описаны ниже, см. ⌠Опции■.
Команда возвращает имя созданного интерпретатора. Команда ::safe::interpInit аналогична, но ее первым аргументом должно быть имя интерпретатора, созданного с помощью команды interp. Команда ::safe::interpDelete удаляет интерпретатор, имя которого использовано в качестве аргумента. Команда ::safe::interpConfigure позволяет задать опции для безопасного интерпретатора или получить информацию об заданных ранее опциях. Подробноопции описаны ниже (см. ⌠Опции■).

Для каждого безопасного интерпретатора, созданного с помощью команды ::safe::interpCreate или инициированного с помощью команды ::safe::interpInit в родительском интерпретаторе создается список доступных каталогов ≈ виртуальный путь. Каждый каталог в пути связывается с реальным каталогом локальной файловой системы и с меткой, доступной в безопасном интерпретаторе. В результате надежный интерпретатор обходится без сведений о реальной файловой системе на машине, на которой исполняется интерпретатор. Когда в надежном интерпретаторе используется метка для доступа к конкретному файлу (например, для выполнения команды source или load), метка заменяется в родительском интерпретаторе на настоящее имя каталога и необходимый файл ищется в файловой системе. Надежный интерпретатор не получает сведений о реальном имени файла в файловой системе. Для работы с виртуальными именами файлов предусмотрены специальные команды. Команда ::safe::interpConfigure позволяет задавать новый виртуальный путь для интерпретатора. Команда ::safe::interpAddToAccessPath позволяет добавлять каталоги к виртуальному пути указанного безопасного интерпретатора. Команда ::safe::interpFindInAccessPath позволяет найти каталог в виртуальном пути для безопасного интерпретатора и получить его метку. Если каталог не найден, выдается сообщение об ошибке.

Команда ::safe::setLogCommand позволяет задать скрипт, который выполняется при каждом событии в безопасном интерпретаторе. Этот скрипт вызывается с одним аргументом ≈ строкой, содержащей описание события.
 
 
 

 

Tcl

Основные правила синтаксиса команд.

Синтаксис и семантика языка Tcl определены описанным  ниже образом.

Скрипт на Tcl представляет собой одну или более команд. Символы точки с запятой (;) и новой строки служат разделителями команд, если не находятся между символами кавычек. Закрывающие скобки служат окончанием тела команды при подстановках команд, если не находятся между символами кавычек.

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

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

Если первый символ слова есть двойные кавычки (■), то слово должно заканчиваться также на двойные кавычки. Если в промежутке между знаками кавычек находятся точка с запятой, закрывающая скобка или пробельные символы (включая символ новой строки), то они будут поняты как обычные символы в составе слова. Подстановки команд, переменных и подстановки с обратным слешем в таком слове описаны ниже. Двойные кавычки не являются частью слова.

Если слово начинается с открывающей фигурной скобки ({), то оно должно заканчиваться на парную ей закрывающую скобку (}). Внутри фигурных скобок могут также содержаться слова в фигурных скобках. При этом каждая открывающая фигурная скобка должна иметь парную ей закрывающую фигурную скобку. Однако, если открывающая или закрывающая фигурная скобка отмечена обратным слешем, то она не учитывается при поиске парной скобки. Для символов между фигурными скобками не выполняется никаких подстановок, за исключением описанной ниже подстановки ⌠обратный слеш ≈ новая строка⌠. Также не приписывается никакого специального смысла символам точки с запятой, новой строки, закрывающей скобки и пробела. Слово будет состоять из символов между скобками, за исключением самих скобок.

Если слово содержит открывающую квадратную скобку ([), то Tcl выполняет подстановку команды. Для этого он рекурсивно вызывает интерпретатор Tcl, который обрабатывает символы, следующие за скобкой, как скрипт Tcl. Скрипт может иметь любое количество команд и должен оканчиваться закрывающей квадратной скобкой (]). Результат выполнения скрипта (т.е., результат его последней команды) подставляется в слово на место скобок и всех символов между ними. В слове может быть любое количество подстановок команд. Подстановки команд не выполняются в словах, заключенных в фигурные скобки.

Если слово содержит символ доллара ($), тогда Tcl выполняет подстановку переменной: символ доллара и последующие символы заменяются в слове на значение этой переменной. Существует три способа подстановки переменной:

$name

Здесь name ≈ имя скалярной переменной, оно заканчивается любым символом, за исключением буквы, цифры или символа подчеркивания.

$name(index)

Здесь name есть имя массива данных, а index ≈ имя элемента внутри этого массива. Name должен состоять только из букв, цифр и символов подчеркивания. Все виды подстановок выполняются по отношению к символам index.

${name}

Здесь name ≈ имя скалярной переменной, оно может состоять из каких угодно символов, кроме закрывающей фигурной скобки.
В слове может быть любое количество подстановок переменных. Подстановки переменных не выполняются для слов, заключенных в фигурные скобки.

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

 
 

\a	Звуковой сигнал (гудок) (0х7).
\b	Сдвиг на одну позицию влево (0х8).
\f	Прогон листа (0хс).
\n	Новая строка, newline (0ха).
\r	Возврат каретки (0хd).
\t	Табуляция (0х9).
\v	Вертикальная табуляция (0xb).
\<newline>пробел	Обратный слеш, символ новой строки и все пробелы и табуляции после этого символа заменяются на одиночный пробел. Данная последовательность уникальна в том смысле, что она замещается в отдельном суб-проходе перед тем, как начинается непосредственно анализ команды. Поэтому эта последовательность будет замещена, даже если она стоит между фигурными скобками, и результирующий пробел будет интерпретироваться как разделитель слов, если только он не будет стоять между фигурными скобками или кавычками.
\\	Обратный слеш (\).
\ooo	Цифры ooo (одна, две или все три) дают восьмеричное значение символа.
\xhh	Шестнадцатеричное число ▒hh▓ дает шестнадцатеричное значение символа. Может присутствовать любое количество цифр.

Подстановки с обратным слешем не выполняются в словах, заключенных в фигурные скобки, кроме подстановки ⌠обратный слеш ≈ новая строка■.

Если символ ▒#▓ будет стоять в том месте, где Tcl предполагает первый символ первого слова команды, то этот символ и все последующие символы до следующего символа новой строки включительно истолковываются как комментарии и игнорируются. Символ комментария действителен только тогда, когда он стоит в начале команды.

При воссоздании слов команды каждый символ обрабатывается интерпретатором Tcl только один раз. Например, если выполнялась подстановка переменной, то в значении переменной никаких подстановок не производится; значение вставляется в слово без изменений. Если выполнялась подстановка команды, то вставленная команда обрабатывается целиком посредством рекурсивного вызова интерпретатора Tcl; не делается никаких подстановок перед рекурсивным вызовом и не делается никаких дополнительных подстановок в результат исполнения вставленного скрипта.

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

 

 
 

after

 
Команда after указывает, что некоторая команда должна быть выполнена с задержкой по времени.

after ms

after ms?script script script...?

after cancel id

 after cancel script script script...

after idle?script script script...?

after info?id?

 
 

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

afterms 

Ms ≈ целое число, задающее задержку в миллисекундах. Команда обеспечивает задержку на соответствующее число миллисекунд до своего завершения. Во время задержки приложение не реагирует на события.
after ms?script script script...?
В этой форме команда завершается немедленно, но при этом она обеспечивает выполнение Tcl-команды script script script через соответствующее время. Команда выполняется ровно один раз в установленный момент времени. Команда формируется объединением всех перечисленных аргументов script таким же образом, как при выполнении команды concat. Команда выполняется на глобальном уровне (вне контекста какой-либо Tcl-процедуры). Ошибки во время выполнения команды (если они происходят) обрабатываются с помощью процедуры bgerror. Команда after в этой форме возвращает идентификатор, который может быть использован для отмены отложенной команды с помощью команды after cancel.
after cancel id
Отменяет исполнение ранее заявленной отложенной команды. Id определяет, какая именно команда будет отменена. Значение id должно совпадать со значением, возвращенным предыдущей командой after. Если соответствующая команда уже выполнена, команда after cancel игнорируется.
after cancel script script...
Эта команда также отменяет выполнение ранее заявленной отложенной команды. Все перечисленные скрипты script объединяются через пробел таким же образом, как при выполнении команды concat. После чего ищется отложенная команда с аналогичным скриптом. Если такая команда будет найдена, ее исполнение будет отменено. В противном случае команда after cancel игнорируется.
 
after idle script?script script...?
Все перечисленные скрипты объединяются через пробел таким же образом, как при выполнении команды concat. Сформированная таким образом Tcl команда выполняется позже. Она выполняется ровно один раз в первом цикле обработчика событий, в котором не будет других необработанных событий. Команда after idle возвращает идентификатор, который может быть использован для отмены отложенной команды. Ошибки во время выполнения команды (если они происходят) обрабатываются с помощью процедуры bgerror.
after info?id?
Эта команда используется для получения информации об отложенных командах. Если аргумент id отсутствует , то возвращает список идентификаторов отложенных команд. Если аргумент id указан и соответствует идентификатору отложенной команды, которая не отменена и еще не выполнена, возвращается список из двух элементов. Первый элемент списка √ Tcl-скрипт соответствующей команды, второй ≈ idle или timer в зависимости от того, по какому событию предполагается вызов команды.  
Команды after ms и after idle предполагают, что приложение управляется событиями. Отложенные команды не выполняются, если в приложении не активизирован цикл обработки событий. В приложениях, в которых он обычно не активизирован, таких как tclsh, цикл обработки событий может быть активизирован с помощью команд vwait и update.

Команда дописывает значения аргументов к значению переменной.

СИНТАКСИС
 

append varName?value value value...?

Команда append добавляет все аргументы value к значению переменной varName. Если такой переменной не было, она будет создана, и ее значение будет равно соединению значений аргументов value. Эта команда предоставляет удобный способ постепенного наращивания длинных переменных. сЕли переменная a содержит длинное значение, то  команда ⌠append a $b" выполняется значительно быстрее, чем ⌠set a $a$b" .

 

array option arrayName?arg arg...?

array anymore arrayName searchId

array donesearch arrayName searchId

array exists arrayName

array get arrayName?pattern?

array names arrayName?pattern?

array nextelement arrayName searchId

array set arrayName list

array size arrayName

array startsearch arrayName
 

 

 

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

 

array anymore arrayName searchId

Возвращает ▒1▓ если при выполнении команды поиска (см. ниже) остались невыбранные элементы массива, и ▒0▓ в противном случае. SearchId указывает операцию поиска, информация о которой запрашивается (величина searchId возвращается при выполнении команды array startsearch). Эта опция особенно удобна, если массив содержит элемент с пустым именем, поскольку команда array nextelement не позволяет в таком случае определить, закончен ли поиск.

array donesearch arrayName searchId

Команда прерывает поиск элементов массива и удаляет всю связанную с поиском информацию. SearchId указывает операцию поиска, информация о которой удаляется (величина searchId возвращается при выполнении команды array startsearch). Команда возвращает пустую строку.

array exists arrayName

Возвращает ▒1▓, если arrayName есть имя массива, и ▒0▓, если такой переменной не существует или она является скалярной переменной.

array get arrayName?pattern?

Возвращает список, содержащий пары элементов. Первый элемент пары ≈ имя элемента массива arrayName, второй элемент пары ≈ значение этого элемента. Порядок пар не определен. Если шаблон не задан, то все элементы массива будут включены в результат. Если шаблон задан, то в результат будут включены только те элементы, чьи имена соответствуют шаблону (используя те же правила, что и в команде glob). Если arrayName не является переменной массива или массив не содержит элементов, то возвращается пустой список.

array names arrayName?pattern?

Возвращает список, содержащий имена всех элементов массива, соответствующих шаблону (используя те же правила, что и в команде glob). Если шаблона нет, то команда возвращает имена всех элементов массива. Если в массиве нет элементов, соответствующих шаблону или arrayName не является именем переменной массива, то возвращается пустая строка.

array nextelement arrayName searchId

Возвращает имя следующего элемента массива arrayName, или пустую строку, если все элементы массива уже возвращены. SearchId указывает операцию поиска, (величина searchId возвращается при выполнении команды array startsearch). Предупреждение: если в массив внесен новый элемент или из массива удален один из элементов, то все операции поиска в этом массиве автоматически заканчиваются, как если бы была выполнена команда array donesearch. Соответственно, попытка выполнить после этого команду array nextelement приведет к ошибке.

array set arrayName list

Устанавливает значение одного или нескольких элементов массива arrayName. Список list должен иметь такую же структуру, как список, возвращаемый командой array get, то есть состоять из четного числа элементов. Все нечетные элементы списка рассматриваются как имена элементов массива arrayName, а следующие за ними четные элементы ≈ как новые значения соответствующих элементов.

array size arrayName

Возвращает строку, содержащую десятичное число, равное количеству элементов указанного массива. Если arrayName не является именем массива, возвращается ▒0▓.

array startsearch arrayName

Эта команда инициализирует процесс поиска элементов указанного массива. После этого имя каждого следующего элемента массива можно получить с помощью команды array nextelement. По завершении поиска необходимо выполнить команду array donesearch. Команда array startsearch возвращает идентификатор процесса поиска, который должен использоваться в командах array nextelement и array donesearch. Благодаря этому механизму возможно проведение нескольких процессов поиска элементов одного и того же массива одновременно.

bgerror

Команда bgerror предназначена для обработки фоновых ошибок 
(background errors).

СИНТАКСИС

 


binary

Команда вставляет и извлекает поля из двоичных строк.

 

 
binary format   formatString?arg arg...?

binary scan string formatString?varName varName...?
 

  Команда binary предоставляет средства для манипулирования двоичными данными. Первая из форм команды конвертирует обычные Tcl-значения arg в двоичное число. Например, вызванная с аргументами ▒16▓ и ▒22▓, она вернет 8-байтовое двоичную строку, состоящую из двух 4-байтовых чисел, представляющих соответственно ▒16▓ и ▒22▓. Вторая форма команды выполняет обратное действие, она извлекает из двоичной строки данные и возвращает их как обычные Tcl строки.

binary format

Команда binary format создает двоичную строку по правилам, заданным с помощью шаблона formatString. Содержание этой строки задается дополнительными аргументами arg. Команда возвращает сформированную двоичную строку.

Шаблон formatString содержит последовательность из нуля или более спецификаторов преобразования, разделенных одним или более пробелами. Каждый спецификатор преобразования состоит из буквы, за которой может следовать число count. Как правило, спецификатор использует один из аргументов arg чтобы получить величину для форматирования. Буква в спецификаторе указывает тип преобразования (форматирования). Число count обычно указывает сколько объектов для форматирования выбирается из значения arg. Соответственно, count должно быть неотрицательным десятичным числом. Если значение count равно ▒*▓, это обычно указывает, что надо использовать все значение аргумента. Если число аргументов arg не соответствует числу спецификаторов, требующих для себя дополнительного аргумента, выдается ошибка.

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

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

  a?count? Передает в выходную строку count символов из соответствующего аргумента arg. Если в arg содержится меньше count байт, добавляются нулевые байты. Если в arg содержится больше count байт, ⌠лишние■ байты игнорируются. Если count равно ▒*▓, используются все байты из arg. Если count отсутствует, используется один байт. Например, команда

binary format a7a*a alpha bravo charlie

вернет строку, эквивалентную alpha\000\000bravoc.

A?count? То же, что и a, за исключением того, что для заполнения используются не нулевые байты, а пробелы. Например, команда

binary format A6A*A alpha bravo charlie

вернет alpha bravoc.

b?count? Передает в выходную строку count бит в порядке от младших к старшим в каждом байте. Аргумент arg должен состоять из последовательности нулей и единиц. Порядок байтов в выходной строке тот же, что и во входной информации. Лишние биты отсекаются, недостающие дополняются нулями. По умолчанию форматируется один бит. Если число форматируемых битов не соответствует целому числу байтов, недостающие биты дополняются нулями. Например, команда

binary format b5b* 11100 111000011010

вернет строку, эквивалентную \x07\x87\x05.
 

B?count? Тоже, что и b, но биты выдаются в порядке от старших к младшим. Например, команда

binary format B5B* 11100 111000011010

вернет строку, эквивалентную \xe0\xe1\xa0.

h?count? Передает в выходную строку count шестнадцатеричных чисел в порядке от младших к старшим в каждом байте. Аргумент arg должен состоять из последовательности символов, содержащихся в множестве: ⌠0123456789abcdefABCDEF■. Порядок байтов в выходной строке тот же, что и во входной информации. Лишние символы отсекаются, недостающие дополняются нулями. По умолчанию форматируется одно шестнадцатеричное число. Если число форматируемых чисел не соответствует целому числу байтов, недостающие биты дополняются нулями.

Например, команда
 

binary format h3h* AB def


вернет строку, эквивалентную \xba\xed\x0f.

H?count? Тоже, что и b, но биты выдаются в порядке от старших к младшим. Например, команда
  binary format H3H* ab DEF


вернет строку, эквивалентную \xab\xde\xf0.
 

c?count? Передает в выходную строку одно или несколько восьмибитных чисел. Если count не указан, аргумент argдолжен состоять из одного целого числа. В противном случае он должен состоять из списка, содержащего не менее count целых чисел. Последние 8 бит каждого числа сохраняются как один байт в выходной строке. Если count равно ▒*▓, форматируются все числа в списке. Если в списке меньше чисел, чем count, выдается ошибка. Лишние числа в списке игнорируются.

Например, команда
 

binary format c3cc* {3 -3 128 1} 257 {2 5}


вернет строку, эквивалентную \x03\xfd\x80\x01\x02\x05,
тогда как команда
 

binary format c {2 5}


вернет ошибку.

s?count? Эта форма аналогична c, за исключением того, что она сохраняет 16-тибитовые числа. Последние шестнадцать бит числа сохраняются как два байта, последний байт первым. Например, команда
  binary format s3 {3 -3 258 1}


вернет строку, эквивалентную \x03\x00\xfd\xff\x02\x01.

S?count? Эта форма аналогична s, за исключением того, что порядок байтов противоположный. Например, команда
binary format S3 {3 -3 258 1}


вернет строку, эквивалентную \x00\x03\xff\xfd\x01\x02.

i?count? Эта форма аналогична c, за исключением того, что она сохраняет 32-хразрядные числа. Например, команда
  binary format i3 {3 -3 65536 1}


вернет строку, эквивалентную \x03\x00\x00\x00\xfd\xff\xff\xff\x00\x00\x10\x00

I?count? Эта форма отличается от i порядком байтов в числе. Например, команда
  binary format I3 {3 -3 65536 1}


вернет строку, эквивалентную
\x00\x00\x00\x03\xff\xff\xff\xfd\x00\x10\x00\x00

f?count? Эта форма аналогична c, за исключением того, что она сохраняет числа с плавающей запятой в машинном представлении (используемом для конкретной платформы). Например, на Windows платформе с процессором Pentium команда
  binary format f2 {1.6 3.4}


вернет строку, эквивалентную
\xcd\xcc\xcc\x3f\x9a\x99\x59\x40.

d?count? Эта форма аналогична f, за исключением того, что используется представление для десятичных чисел с двойной точностью. Например, на Windows платформе с процессором Pentium команда
  binary format d1 {1.6}


вернет строку, эквивалентную
\x9a\x99\x99\x99\x99\x99\xf9\x3f.

x?count? Записывает в выходную строку count нулевых байтов. Если count не задан, записывает один нулевой байт. Если count равно ▒*▓, выдает ошибку. Ни один из аргументов arg при форматировании не используется. Например, команда binary format a3xa3x2a3 abc def ghi


вернет строку, эквивалентную abc\000def\000\000ghi.

X?count? Передвигает место будущей вставки в выходную строку (курсор) на count байтов назад. Если аргумент count равен ▒*▓ или больше текущей позиции, передвигает курсор на начало строки. Если count не указан, передвигает его на один байт. Ни один из аргументов arg при форматировании не используется. Например, команда binary format a3X*a3X2a3 abc def ghi

вернет dghi.

@ ?count? Передвигает место будущей вставки в выходную строку (курсор) на абсолютную позицию count. Позиция 0 соответствует первому байту в строке. Если count больше текущей длины строки, она дополняется до необходимой позиции нулевыми байтами. ▒*▓ указывает на конец строки. Если аргумент count не указан, команда возвращает ошибку.. Ни один из аргументов arg при форматировании не используется. Например, команда
binary format a5@2a1@*a3@10a1 abcde f ghi j   вернет 
abfdeghi\000\000j. binary scan Команда binary scan просматривает двоичную строку string, возвращая число выполненных преобразований. Строка formatString содержит последовательность спецификаторов преобразования. Каждый из аргументов varName содержит имя переменной, в которую записывается результат очередного преобразования.   Поскольку спецификаторы преобразований строятся по тем же правилам, что и для binary format, ниже приведены примеры их использования с минимальными пояснениями. Принципиальным моментом при исполнении команды binary scan является то, что если для очередного преобразования, указанного в formatString, требуется больше байтов, чем осталось до конца строки, то команда немедленно завершается, а соответствующая переменная (в которую должен был записываться результат преобразования) остается неизмененной. Если для записи результата очередного преобразования не осталось переменной, команда возвращает ошибку.   a?count? Команда binary scan abcde\000fghi a6a10 var1 var2   вернет значение 1. В переменной var1 будет записана строка abcde\000, а переменная var2 не изменится. A?count? Команда   binary scan "abc efghi\000" a* var1   вернет ▒1▓. В переменной var1 будет записана строка ⌠abc efghi". b?count? Команда
binary scan\x07\x87\x05 b5b* var1 var2   вернет 2. В переменной var1 будет записано   ▒11100▓, в переменной var2 будет записано ▒1110000110100000▓. B?count? Команда
  binary scan\x70\x87\x05 b5b* var1 var2


вернет ▒2▓. В переменной var1 будет записано ▒01110▓. В переменной var2 ≈ ▒1000011100000101▓.

h?count? Команда
  binary scan\x07\x86\x05 h3h* var1 var2


вернет `2▓. В переменной var1 будет записано 706. В переменной var2 ≈ ▒50`.

H?count? Команда
  binary scan\x07\x86\x05 H3H* var1 var2


вернет ▒2.▓. В переменной var1 будет записано ⌠078.■. В переменной var2 ≈ ▒05▓.

c?count? Команда
  binary scan\x07\x86\x05 c2c* var1 var2


вернет ▒2▓. В переменной var1 будет записана строка ⌠7 -122". В переменной var2 ≈ ▒5▓. Обратите внимание, что команда возвращает числа со знаком. Чтобы преобразовать их в числа без знака можно использовать выражение:
 

expr ( $num + 0x100 ) % 0x100 s?count? Команда
binary scan\x05\x00\x07\x00\xf0\xff s2s* var1 var2

вернет ▒2▓. В переменной var1 будет записана строка '5 7'. В переменной var2 ≈ ▒-16▓. Обратите внимание, что команда возвращает числа со знаком. Чтобы преобразовать их в числа без знака можно использовать выражение:
 

expr ( $num + 0x10000 ) % 0x10000 S?count? Команда
  binary scan\x00\x05\x00\x07\xff\xf0 S2S* var1 var2


вернет ▒2▓. В переменной var1 будет записана строка '5 7'. В переменной var2 ≈ ▒-16▓.

i?count? Команда binary can\x05\x00\x00\x00\x07\x00\x00\x00\xf0\xff\xff\xff i2i* var1 var2  
вернет ▒2▓. В переменной var1 будет записана строка ⌠5 7". В переменной var2 ≈ ▒-16▓. Обратите внимание, что команда возвращает числа со знаком. В Tcl нет возможности перевести его в число без знака. I?count? Команда

binary\x00\x00\x00\x05\x00\x00\x00\x07\xff\xff\xff\xf0 I2I* var1 var2

вернет ▒2▓. В переменной var1 будет записана строка ⌠5 7". В переменной var2 ≈ ▒-16▓.

f?count? На Windows платформе с процессором Pentium команда
  binary scan\x3f\xcc\xcc\xcd f var1


вернет ▒1▓. В переменной var1 будет записано ▒1.6000000238418579▓.

d?count? На Windows платформе с процессором Pentium команда

binary scan\x9a\x99\x99\x99\x99\x99\xf9\x3f d var1

вернет ▒1▓. В переменной var1 будет записано ▒1.6000000000000001▓.

x?count? Команда
  binary scan\x01\x02\x03\x04 x2H* var1


вернет ▒1▓. В переменной var1 будет ▒0304▓. Преобразование не требует дополнительной переменной varName.

X?count? Команда
  binary scan\x01\x02\x03\x04 c2XH* var1 var2


вернет ▒2▓. В переменной var1 будет ▒1 2▓. В переменной var2≈ ▒020304▓.. Преобразование не требует дополнительной переменной varName.

@?count? Команда
  binary scan\x01\x02\x03\x04 c2@1H* var1 var2


вернет ▒2▓. В переменной var1 будет ▒1 2▓. В переменной var2 ≈ ▒020304▓. Преобразование не требует дополнительной переменной varName.

catch

close channelId

Команда close закрывает канал, идентификатор которого задан аргументом channelId. Идентификатор channelId возвращается командами open и socket при открытии канала.

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

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

Если канал в блокирующем режиме открыт для конвейера, команда close завершается после завершения порожденного процесса.

Если канал совместно используется несколькими интерпретаторами, то команда делает канал channelId недоступным в вызвавшем команду интерпретаторе, но не оказывает никакого другого действия на канал, пока все использующие канал интерпретаторы не закроют его. При выполнении команды в последнем из интерпретаторов, использовавших его, выполняются описанные выше действия. Подробности совместного использования канала несколькими интерпретаторами приведены в описании команды interp.

Команда close возвращает пустую строку. Она может порождать ошибку, если при выводе данных произошла ошибка.

Команда соединяет списки в один общий список.

concat?arg arg...?

Аргументы arg считаются списками, команда concat объединяет их в один общий список. При этом она удаляет пробелы в начале и конце arg, и вставляет по одному пробелу между ними. Команда допускает произвольное число аргументов. Например, команда

concat a b {c d e} {f {g h}} возвращает список

a b c d e f {g h}

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

continue Команда continue прекращает выполнение текущего шага цикла.

continue

Обычно данная команда помещается внутрь цикла, например, созданного командами for, foreach или while. Команда возвращает код TCL_CONTINUE, который вызывает завершение текущей итерации наименьшего охватывающего ее цикла. Управление возвращается команде цикла, которая начинает следующий шаг цикла. Код TCL_CONTINUE обрабатывается также в некоторых других ситуациях ≈ при исполнении команды catch и в скрипте самого верхнего уровня.

eof Команда проверяет в канале условие конца файла.

eof channelId

Команда eof возвращает ▒1▓, если во время последней операции ввода в канале channelId произошло условие конца файла, и 0 ≈ в противном случае.

error Команда генерирует ошибку.

error message?info??code?

Команда возвращает код TCL_ERROR, прерывающий интерпретацию команды. Строка message возвращается приложению, чтобы указать, что именно произошло.

Если задан непустой аргумент info, его значение присваивается глобальной переменной errorInfo.

Переменная errorInfo обычно используется для формирования сведений о вложениях команды, в которой произошла ошибка. Другими словами, как только оказывается, что невыполненная команда была вложена в другую команду, информацию об этой команде добавляется к errorInfo. Если же аргумент info был задан, этого не происходит. Эта особенность позволяет при использовании команды error совместно с командой catch выдать информацию о реальном месте ошибки (а не о месте вызова команды error). Дляэтого можно использовать следующую конструкцию:

catch {...} errMsg
set savedInfo $errorInfo
...
error $errMsg $savedInfo

Если задан аргумент code, то его значение будет присвоено глобальной переменной errorCode. Эта переменная предназначена для хранения машинного описания ошибки в тех случаях, когда такое описание возможно. Форматы различных сообщений приведены в разделе tell. Если аргумент не задан, переменной errorCode в процессе обработки Tcl-интерпретатором ошибки, порожденной командой, присваивается значение ``NONE''.

Команда запускает подпроцессы.

• числовым значением ≈ целым или с плавающей запятой;
• переменной Tcl, используя обычную нотацию со знаком ▒$▓. В качестве операнда будет использовано значение переменной;
• строкой символов, заключенной в двойные кавычки. Анализатор выражения выполнит подстановки переменных, подстановки команд и подстановки с обратным слешем; полученное значение будет использовано в качестве операнда;
• строкой, заключенной в фигурные скобки. Все символы между открывающей и закрывающей скобками будут считаться операндом без каких-либо подстановок;
• командой Tcl, заключенной в угловые скобки. Команда будет выполнена, и ее результат будет использован в качестве операнда;
• как вызов математической функции, аргумент которой может иметь любую из перечисленных выше форм, например sin($x). Список допустимых математических функций приведен ниже.

ОПЕРАТОРЫ

Проверяет, что предыдущая операция ввода исчерпала всю информацию для ввода.

Копирует данные из одного канала в другой.

СИНТАКСИС

Команда для работы с файлами и их именами.

Исполняет скрипт, когда канал открывается на чтение или запись.

fileevent channelId readable?script?

fileevent channelId writable?script?

Эта команда используется для создания обработчиков файловых событий. Обработчик файловых событий связывает канал и скрипт таким образом, что скрипт исполняется, когда канал открывается на чтение или запись. Обработчики файловых событий используются, чтобы получение данных от другого процесса управлялось событиями. При этом получающий процесс, ожидая поступление данных, сможет продолжать взаимодействовать с пользователем. Если приложение выполняет команду get или read из блокирующего канала, оно не способно обслуживать другие события, поэтому оно кажется пользователю ⌠замороженным■. С использованием файловых событий процесс обратится к команде get или read только когда информация поступит в канал.

Аргумент channelId должен быть идентификатором открытого канала, который вернула предыдущая команда open или socket. Если в команде присутствует аргумент script, команда создает новый обработчик событий: скрипт script будет выполнен, когда канал channelId откроется на чтение или запись (в зависимости от второго аргумента команды). В такой форме команда возвращает пустую строку. Обработчики для обработки открытия файла на чтение или запись соответственно независимы и могут создаваться и удаляться по одному, независимо один от другого. Однако для каждого из событий может быть только один обработчик, так что если команда fileevent выполняется, когда соответствующий обработчик (в текущем интерпретаторе) уже задан, новый скрипт заменит старый.

Если аргумент script не задан, команда fileevent возвратит скрипт, заданный для данного события для канала channelId, или пустую строку, если скрипт не задан. Обработчик событий удаляется автоматически при закрытии канала или удалении интерпретатора.

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

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

Событийно управляемый ввод ≈ вывод лучше всего работает с каналами, переведенными в неблокирующий режим с помощью команды fconfigure. В блокирующем режиме команды puts, get  или read могут заблокировать процесс, если они не могут быть выполнены сразу (например, при попытке прочитать больше данных, чем доступно в настоящий момент). При этом никакой обработки событий не происходит. В неблокирующем режиме команды puts, get  или read никогда не блокируют процесс. Детальное описание работы команд с блокирующими и неблокирующими каналами приведено в описаниях соответствующих команд.

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

Правила именования файлов в Tcl.

 

Введение

Типы путей

Синтаксис путей

"Тильда"-подстановки

Вопросы перносимости

Все имена файлов поделены на три типа, в зависимости от начальной точки для отсчета пути: абсолютные, относительные и имена внутри тома (volume-relative).

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

Для определения типа указанного пути можно использовать команду file pathtype.

Пути формируются различным образом для различных платформ. Текущая платформа определяется по значению переменной tcl_platform(platform):

mac

В дополнение к правилам, описанным выше, Tcl позволяет использовать ⌠тильда■ -подстановки в стиле cshell. Если имя файла начинается с ▒~▓, за которой сразу следует сепаратор, она заменяется на значение переменной окружения $HOME. В противном случае символы от ⌠тильды■ до следующего разделителя интерпретируются как имя пользователя и заменяются на имя домашнего каталога пользователя.

На Macintosh- и Windows-платформах ⌠тильда■-подстановки с именем пользователя не поддерживаются. При попытке использовать такое имя файла выдается ошибка. Однако ⌠тильда■ без имени пользователя заменяется, как и на Unix-платформах, на значение переменной окружения $HOME.

Команда организует немедленную выдачу выходных данных в канал.

Команда for организует цикл.

Команда for является командой цикла. По структуре команда for похожа на аналогичную команду языка С. Здесь аргументы start, next и body должны быть командными строками Tcl, а test ≈ строкой выражения. Сначала команда for запускает интерпретатор Tcl для выполнения start. Затем она вычисляет значение выражения test; если оно не равно нулю, то запускает Tcl-интерпретатор для выполнения body, затем next. Цикл повторяется до тех пор, пока test не станет равно 0. Если при выполнении body будет выполнена команда continue, то последующие команды в body пропускаются и начинает выполняться next, затем test и т.д. Если при исполнении body или next встретится команда break, исполнение команды for немедленно прекращается. Команда for возвращает пустую строку.

Замечание. Строку test почти всегда следует помещать в фигурные скобки. В противном случае подстановки переменных будут выполнены до выполнения команды. Из-за этого измененное в ходе цикла значение переменной может перестать передаваться в выражение, что может породить бесконечный цикл. Если же строка test заключена в фигурные скобки, подстановка значения переменных выполняется в каждом цикле. Для примера можно выполнить следующий скрипт со скобками и без скобок вокруг выражения $x<10:

Команда цикла по элементам одного или нескольких списков.
 

 

 Синтаксис

 Описание

 Примеры

В общем случае в команде может быть указано несколько списков значений (например, list1 и list2), и каждый из них может быть связан с одной переменной или со списком переменных цикла (например, varlist1 и varlist2). Во время каждой итерации переменные каждого списка переменных принимают значения последовательных элементов соответствующего списка значений. Значения из списков значений используются последовательно от первого до последнего, и каждое значение используется только один раз. Общее число итераций выбирается таким, чтобы использовать все значения из всех списков значений. Если список значений не содержит достаточного числа значений для всех связанных с ним переменных цикла, вместо недостающих элементов используются пустые значения.

Внутри скрипта body можно использовать команды break и continue, аналогично команде for.

Команда foreachвозвращает пустую строку.

В цикле используются переменные цикла i и j для цикла по элементам одного списка

В цикле переменные цикла i и j используются для различных списков значений.

При вычислении цикла используются три итерации.

Команда форматирует строку в стиле процедуры sprintf.

  Синтаксиc

  Введение

  Процесс формирования

  Указатель позиции

  Флаги преобразования

  Минимальная  ширина поля

  Точность

  Преобразователь длины

  Тип преобразования

  Отличия от ANSI SPRINTF

format formatString?arg arg...?

Команда немного отличается от sprintf в части отдельных спецификаторов и ключей.

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

Если за символом ▒%▓ следуют целое число и знак ▒$▓, как например в ▒%2$d▓, то величина для преобразования берется не из следующего аргумента, а из аргумента, занимающего соответствующую позицию в списке (▒1▓ соответствует первому аргументу arg). Если спецификатор преобразования требует нескольких аргументов (когда он содержит символ ▒*▓), то используются последовательные аргументы, начиная с указанного. Если один из спецификаторов содержит указание позиции аргумента, то и все остальные спецификаторы должны его содержать.

Четвертая часть спецификатора определяет точность представления чисел. Она состоит из точки и последующего числа. Число имеет различный смысл при различных преобразованиях. Для ▒e▓, ▒E▓ и ▒f▓ преобразования оно определяет число цифр справа от десятичной точки. Для ▒g▓ и ▒G▓ ≈ общее число чисел слева и справа от десятичной точки (однако, конечные нули будут обрезаться, если не указан флаг ▒#▓). Для целочисленных преобразований оно определяет минимальное число символов (при необходимости будут добавляться лидирующие нули). Для ▒s▓ преобразований определяет максимальное число символов, которое будет выводиться. Если строка длиннее, конечные символы будут отброшены. Если точность указана как ▒*▓, а не как число, то в качестве числового значения используется значение следующего аргумента в команде.

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

 

d	Преобразует целое число в десятичную строку со знаком.
u	Преобразует целое число в десятичную строку без знака.
i	Преобразует целое число в десятичную строку со знаком. Целое может быть десятичным, восьмеричным (с 0 вначале) или шестнадцатеричным (с 0x вначале).
o	Преобразует целое число в восьмеричную строку без знака.
x or X	Преобразует целое число в шестнадцатеричную строку без знака. Используются символы `0123456789abcdef'' для x и ``0123456789ABCDEF'' для X.
c	Преобразует целое число в восьмибитный символ, который оно представляет.
s	Не преобразует, но просто вставляет строку
f	Преобразует число с плавающей точкой в десятичное со знаком в форме xx.yyy, где число символов после запятой определяется точностью.
e or E	Преобразует число с плавающей точкой в число в экспоненциальной форме x.yyye╠zz, где число символов после запятой определяется точностью (по умолчанию 6). Для E в записи числа используется Eвместо e.
g or G	Если порядок числа меньше √4 или больше, чем точность, или равен точности, преобразует число с плавающей точкой как ▒%e▓ или ▒%E▓. В противном случае преобразует как ▒%f▓.
%	Просто подставляет символ ▒%▓.

 

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

Поведение команды format отличается от процедуры sprintf в следующих моментах:

▒%p▓ и ▒%n▓ типы не поддерживаются

Для ▒%c▓ аргумент должен быть десятичным числом.

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

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

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

Если указана переменная varName и возвращается пустая строка из-за конца файла или из-за неполноты полученной строки, команда возвращает √1.

Обратите внимание, что если аргумент varName не задан, конец файла и неполная строка приведут к тому же результату, что и строка, состоящая из символа конца строки. Команды eof и fblocked позволяют различить эти ситуации.

См. также  eof и fblocked .

Команда возвращает имена файлов, удовлетворяющих шаблону.

Команда glob выполняет поиск имен файлов подобно тому, как это делает оболочка csh, и возвращает список имен, удовлетворяющих шаблону pattern. Аргументы, начинающиеся со знака ▒-▓, являются управляющими ключами switches.

В отличие от другихTcl-команд команда glob может работать с именами файлов только в нотации, поддерживаемой на той платформе, на которой она исполняется. Кроме того, на Windows-платформах специальные символы не допустимы в сетевых именах.
 

Команда для объявления глобальных переменных.

Данная команда выполняется только при выполнении процедуры, а в остальных случаях игнорируется. Команда объявляет переменныеvarname глобальными. Глобальные переменные ≈ это переменные глобальной области имен.

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

См. также namespace(n), variable(n) 
 
 
 

history addcommand?exec?

history info?count?

До версии 8.0 Tcl имел весьма сложный механизм переформирования журнала. Новый механизм несколько сокращен за счет старых опций substitute и words. (Взамен добавлена новая опция clear)

Опция redo позволяет переформировывать журнал значительно проще. При ее выполнении последнее событие изменяется таким образом, что удаляется ⌠служебная■ команда history, которая реально выполнялась, а вместо нее записывается та команда, которая необходима.

Если вы хотите повторить прежнюю команду, не модифицируя журнал, выполните сначала команду history event, чтобы извлечь описание команды, а затем history add, чтобы выполнить ее.

Команда if проверяет соблюдение условия в ходе выполнения скрипта.

Команда сообщает сведения о состоянии интерпретатора Tcl.

info option?arg arg...?

Эта команда обеспечивает доступ к внутренней информации Tcl-интерпретатора. Ниже перечислены поддерживаемые опции (имена которых могут быть сокращены).

info argsprocname

Аргумент procname должен быть именем Tcl-процедуры, а аргумент arg ≈ именем одного из аргументов этой процедуры. Если указанный аргумент не имеет значения по умолчанию, команда возвращает ▒0▓. В противном случае команда возвращает ▒1▓ и помещает значение по умолчанию в переменную varname.

info exists varName

Если аргумент pattern не задан, возвращает список имен всех видимых в текущий момент переменных, включая локальные и видимые глобальные. Если аргумент pattern задан, возвращается список только тех имен, которые удовлетворяют шаблону pattern. Правила использования шаблонов такие же, как в команде string match. Шаблон может быть полным именем, например Foo::option*. То есть он может задавать определенное пространство имен и шаблон в нем. В этом случае каждая команда в возвращаемом списке будет представлена полным именем с указанием пространства имен.

Команда создает и управляет Tcl-интерпретаторами.

interp option?arg arg...?

Эта команда позволяет создавать один или несколько новых Tcl-интерпретаторов, которые сосуществуют в одном приложении с создавшим их интерпретатором. Создавший интерпретатор называется мастер-интерпретатором, а созданные интерпретаторы называются подчиненными (slave) интерпретаторами. Мастер-интерпретатор может создавать произвольное число подчиненных интерпретаторов, а каждый из подчиненных может в свою очередь создавать подчиненные интерпретаторы, для которых он сам является мастер-интерпретатором. В результате в приложении может создаваться иерархия интерпретаторов.

Каждый интерпретатор независим от остальных. Он имеет собственное пространство имен для команд, процедур и глобальных переменных. Мастер-интерпретатор может создавать связи между подчиненными интерпретаторами и собой, используя механизм алиасов. Алиас ≈ это команда в подчиненном интерпретаторе, которая, при ее вызове, вызывает другую команду в мастер-интерпретаторе или в другом подчиненном интерпретаторе. Кроме механизма алиасов, связь между интерпретаторами поддерживается только через переменные окружения. Массив envобычно является общим для всех интерпретаторов в приложении. Необходимо заметить, что идентификаторы каналов (например, идентификатор, возвращаемый командой open) больше не разделяются между интерпретаторами, как это было в предыдущих версиях Tcl. Чтобы обеспечить совместный доступ к каналам, необходимо использовать явные команды для передачи идентификаторов каналов из интерпретатора в интерпретатор.

Команда interp позволяет также создавать надежные интерпретаторы. Надежный интерпретатор ≈ это интерпретатор с существенно урезанной функциональностью, поэтому он может исполнять ненадежные скрипты без риска нарушить работу вызывающего их приложения. Например, из безопасных интерпретаторов недоступны команды создания каналов и подпроцессов. Более подробно см. ⌠Безопасные интерпретаторы■. Опасная функциональность не удалена из безопасных интерпретаторов, но скрыта таким образом, что только надежные интерпретаторы могут получить к ней доступ. Более подробно см. ⌠Скрытые команды■. Механизм алиасов может быть использован для безопасного взаимодействия между подчиненным интерпретатором и его мастер-интерпретатором. Более подробно этот вопрос обсуждается в разделе "Использованиеалиасов".

Полное имя интерпретатора представляет собой список, содержащий имена его предков в иерархии интерпретаторов и заканчивающийся именем интерпретатора в его непосредственном предке. Имена интерпретаторов в списке ≈ это их относительные имена в их непосредственных мастер-интерпретаторах. Например, если a есть подчиненный интерпретатор текущего интерпретатора и, в свою очередь, имеет подчиненный интерпретатор a1, а тот, в свою очередь, имеет подчиненный интерпретатор a11, то полное имя a11 в a есть список {a1 a11}.

В качестве аргумента описанной ниже команды interp используется полное имя интерпретатора. Интерпретатор, в котором исполняется команда, всегда обозначается как {} (пустая строка). Обратите внимание, что в подчиненном интерпретаторе невозможно сослаться на мастер-интерпретатор кроме как через алиасы. Также нет никакого имени, под которому можно было бы сослаться на мастер-интерпретатор, первым созданный в приложении. Оба ограничения вызваны соображениями безопасности.

Команда interp используется для создания, удаления и выполнения команд в подчиненном интерпретаторе, а также для разделения или передачи каналов между интерпретаторами. Она может иметь одну из перечисленных ниже форм в зависимости от значения аргумента option.

interp alias srcPath srcCmd

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

slave command?arg arg...?

где slave ≈ имя подчиненного интерпретатора, а аргументы command и arg arg... определяют конкретное назначение команды. Ниже перечислены возможные формы команды.

slave aliases

Возвращает список всех алиасов в подчиненном интерпретаторе slave. Возвращаемые имена ≈ это имена, использовавшиеся при создании соответствующих алиасов. Они могут не совпадать с текущими именами команд, если те были переименованы. slave alias srcCmd Возвращает список, состоящий из имени реальной команды и ее аргументов, ассоциированных с алиасом srcCmd. Возвращаются те же значения, что и в команде создания алиаса. Если созданный алиас был переименован, то в команде надо указывать имя srcCmd, которое использовалось при создании алиаса. slave alias srcCmd {} Удаляет алиас srcCmd в подчиненном интерпретаторе. Аргумент srcCmd указывает имя алиаса в момент создания. Если после этого он был переименован, удалится переименованная команда. slave alias srcCmd targetCmd?arg..? Эта команда создает команду ≈ алиас в подчиненном интерпретаторе. Каждый раз, когда в подчиненном интерпретаторе будет вызываться команда srcCmd, реально выполняться будет команда targetCmd в мастер-интерпретаторе. Аргументы arg, если они есть, определяют дополнительные аргументы для команды targetCmd, которые будут вставлены перед аргументами, заданными при вызове srcCmd. Подробнее см. ⌠Использование алиасов■. slave eval arg?arg..? Эта команда объединяет все свои аргументы так же, как команда concat, и выполняет сформированный таким образом скрипт в подчиненном интерпретаторе. Результат выполнения (включая информацию об ошибках в переменных errorInfoи errorCode, если произошла ошибка) возвращается в вызывающий интерпретатор. slave expose hiddenName?exposedCmdName? Разрешает использование в подчиненном интерпретаторе скрытой команды hiddenName под новым именем exposedCmdName (в настоящее время поддерживаются только имена в глобальном пространстве имен, не содержащие ⌠::■). Если обычная (не скрытая) команда exposedCmdName уже существует, генерируется сообщение об ошибке. Скрытые команды обсуждаются ниже (см. ■Скрытые команды ■). slave hide exposedCmdName?hiddenCmdName? Запрещает использование в подчиненном интерпретаторе обычной команды exposedCmdName и переименовывает ее в скрытую команду hiddenCmdName (или в скрытую команду под старым именем, если новое не было задано). Если скрытая команда с заданным именем уже существует, команда возвращает ошибку. В настоящее время exposedCmdName и hiddenCmdName не могут содержать ⌠::■. Команды, которые должны быть скрыты с помощью interp hide, ищутся только в глобальном пространстве имен, даже если текущее пространство имен не глобальное. Скрытые команды обсуждаются ниже (см. ■Скрытые команды ■). slave hidden Возвращает список скрытых команд в подчиненном интерпретаторе. slave invokehidden?-global hiddenName?arg..? Вызывает в подчиненном интерпретаторе скрытую команду hiddenCmdName с перечисленными аргументами. Никаких подстановок или вычислений в аргументах не производится. Если указана опция -global, скрытая команда выполняется на глобальном уровне в подчиненном интерпретаторе. В противном случае она выполняется в текущем контексте и может использовать значения локальных переменных и переменных из вышестоящих стеков. Скрытые команды обсуждаются подробно в соответствующем разделе ниже. slave issafe Возвращает ▒1▓, если подчиненный интерпретатор безопасный, и ▒0▓ в противном случае. slave marktrusted Отмечает подчиненный интерпретатор как надежный. Не раскрывает скрытые команды. Команда может выполняться только из надежного интерпретатора. Если подчиненный интерпретатор уже надежный, команда не оказывает никакого воздействия.

Безопасный интерпретатор ≈ это интерпретатор с ограниченной функциональностью. Поэтому в нем можно без опасений выполнять произвольные скрипты, даже написанные вашим злейшим врагом, не опасаясь нарушить выполнение вашего приложения или испортить содержимое дисков вашего компьютера. Чтобы обеспечить безопасность, из таких интерпретаторов удалены определенные команды и переменные. Например, команда создания файлов на диске и команда запуска подпроцессов. Тем не менее, в безопасном интерпретаторе можно обеспечить ограниченный доступ к подобным командам с помощью механизма алиасов. В результате при выполнении потенциально опасных команд будут вызываться специально написанные процедуры в мастер-интерпретаторе, которые могут тщательно проверять заданные аргументы и позволять использовать только ограниченный набор средств. Например, создание файлов может быть разрешено только в ограниченном наборе подкаталогов, а запуск подпроцессов разрешен только для ограниченного (и фиксированного) набора хорошо проверенных программ.

Чтобы создаваемый интерпретатор был безопасным, необходимо при его создании указать опцию -safe. Кроме того, любой интерпретатор, созданный из безопасного интерпретатора, также будет безопасным.

Безопасный интерпретатор создается со следующим набором команд:
 
 

after	append	array	break	case
catch	clock	concat	continue	eof
error	eval	expr	fblocked	fileevent
flush	for	foreach	format	gets
global	history	if	incr	info
interp	join	lappend	lindex	linsert
list	llength	lower	lrange	lreplace
lsearch	lsort	package	pid	proc
puts	read	rename	return	scan
seek	set	split	string	subst
switch	tell	trace	unset	update
uplevel	upvar	vwait	while

Следующие команды в безопасном интерпретаторе скрыты:

 
 

cd	exec	exit	fconfigure
file	glob	load	open
pwd	socket	source

Эти команды могут быть созданы заново как Tcl-процедуры или алиасы или разрешены к использованию с помощью команды interp expose.

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

Расширения, загружаемые в безопасный интерпретатор, также обладают ограниченной функциональностью. Более подробно эти вопросы обсуждаются в пп. Safe-Tcl и load .

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

Когда в подчиненном интерпретаторе вызывается команда-алиас, необходимые Tcl-подстановки в аргументах выполняются там же, как для обычной Tcl-команды. После этого аргументы объединяются с целевой командой и ее аргументами, определенными при создании алиаса. Так, если команда вызова алиаса имела вид ``srcCmd arg1 arg2... argN'', то сформируется команда `targetCmd arg arg... arg arg1 arg2... argN'', где arg arg... arg √ аргументы, указанные при создании алиаса. После этого сформированная команда выполняется в целевом интерпретаторе (со сформированным набором аргументов). Если в целевом интерпретаторе нет команды targetCmd, будет сгенерирована ошибка. Перед выполнением команды в целевом интерпретаторе больше никаких подстановок в аргументах произведено не будет. Команда будет вызвана напрямую, а не через обычный механизм выполнения. Таким образом, подстановки в каждом слове команды оказываются выполненными ровно один раз: в targetCmd и arg... arg √ при выполнении команды, с помощью которой был создан алиас, а в arg1 ≈ argN ≈ при анализе команды алиаса в соответствующем интерпретаторе.

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

Безопасные интерпретаторы существенно ограничивают функциональные возможности выполняемых в них Tcl-скриптов. С одной стороны, это позволяет избежать нежелательных последствий при их исполнении, но, с другой стороны, рано или поздно возникает насущная необходимость выполнить потенциально опасную команду в безопасном интерпретаторе. Например, прочитать дополнительный скрипт с помощью команды source. Или выполнить в Tk-приложении некоторые команды управления окнами.

Команда interp обеспечивает решение этой проблемы с помощью механизма скрытых команд. Потенциально опасные команды не удаляются из безопасного интерпретатора, а становятся скрытыми. При этом их невозможно выполнить из скрипта, выполняемого ⌠внутри■ интерпретатора. Но их можно выполнить ⌠извне■ из любого надежного предка интерпретатора с помощью команды interp invoke. Скрытые и обычные (не скрытые) команды размещаются в различных пространствах имен. Это позволяет иметь в одном интерпретаторе скрытую и обычную команды с одним и тем же именем.

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

Из мастер-интерпретатора возможен вызов скрытых команд подчиненного интерпретатора через механизм алиасов. Поэтому в теле процедур, предназначенных для создания алиаса, необходимо избегать подстановок и команд исполнения для аргументов. См. ⌠Использование алиасов■ .

Безопасные интерпретаторы не могут ⌠изнутри■ вызвать скрытую команду в себе или своих потомках.

Множество скрытых команд может быть изменено из надежного интерпретатора с помощью команд interp expose и interp hide. Безопасный интерпретатор не может изменить набор скрытых команд в себе или своих потомках.

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

ОПИСАНИЕ

СИНТАКСИС
 

package forget  package

package ifneeded package version?script?

package names

package provide package?version?

package require? -exact? package?version?

package unknown? command?

package vcompare version1 version2

package versions package

package vsatisfies version1 version2

ОПИСАНИЕ

Команда поддерживает простую базу данных со сведениями о том, какие пакеты библиотечных функций доступны для использования в данном интерпретаторе, и как их загрузить в интерпретатор. Она поддерживает многоверсионность пакетов и гарантирует загрузку в приложение необходимой версии пакета. При этом она обеспечивает контроль непротиворечивости версий. Обычно в Tcl-скриптах достаточно использовать команды package require и package provide. Остальные команды предназначены в первую очередь для системных скриптов, которые поддерживают базу данных пакетов.

Поведение команды package определяется ее первым аргументом. Ниже описаны возможные формы команды.
 

package forget package

Рекомендованный способ работы с пакетами в Tcl состоит в том, чтобы включать в скрипты команды package require и package provide, и использовать процедуру pkg_mkIndex (см. соответствующие пункты) для создания индексных файлов для пакетов. Это обеспечивает автоматическую загрузку необходимых пакетов.

См.также close(n), filename(n), gets(n), read(n), puts(n), exec(n)