sapi-windows-vt100-support.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 426d9a8f156bca7be9cb5475e24ba104ee814bc1 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.sapi-windows-vt100-support" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sapi_windows_vt100_support</refname>
  <refpurpose>Windows コンソールの出力バッファに関連付けられたストリームのVT100サポート状況を取得/設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>sapi_windows_vt100_support</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>enable</parameter> が省略されるか、&null; の場合、
   この関数は <parameter>stream</parameter> の VT100 制御コードが有効になっている場合に &true; を返します。
   無効になっている場合 &false; を返します。
  </para>
  <para>
   <parameter>enable</parameter> が指定され、<type>bool</type> の場合、
   この関数は <parameter>stream</parameter> の VT100 の機能を 有効/無効 にしようとします。
   VT100 の機能が無事有効(または無効)にできた場合、この関数は &true; を返します。
   失敗した場合 &false; を返します。
  </para>
  <para>
   起動時に、PHP は <constant>STDOUT</constant>/<constant>STDERR</constant> の VT100 の機能を有効にしようとします。これらのストリームがファイルにリダイレクトされると、VT100 の機能は有効にならないかもしれません。
  </para>
  <para>
   VT100 のサポートが有効な場合、VT100 のターミナルで有効な制御シーケンスが使えます。
   これによって、ターミナルの出力を変更できます。Windows では、
   これらの制御シーケンスは Console Virtual Terminal Sequence と呼ばれています。
  </para>
  <warning>
   <simpara>
    この関数は、Windows 10 API で実装されている
    <constant>ENABLE_VIRTUAL_TERMINAL_PROCESSING</constant> フラグを使います。
    よって、古いWindowsバージョンでは VT100の機能は有効にならないかもしれません。
   </simpara>
  </warning>
 </refsect1><!-- }}} -->
 
 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>stream</parameter></term>
    <listitem>
     <para>
      この関数で操作するストリーム
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>enable</parameter></term>
    <listitem>
     <para>
      <type>bool</type> を指定すると、
      (&true; の場合) VT100の機能が有効になり、
      (&false; の場合) 無効になります。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->
 
 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   <parameter>enable</parameter> が省略されるか、&null; の場合、
   VT100 の機能が有効になっている場合に &true; を返します。
   無効になっている場合 &false; を返します。
  </para>
  <para>
   <parameter>enable</parameter> に <type>bool</type> を指定すると、
   &return.success;
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>enable</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <example>
   <title><function>sapi_windows_vt100_support</function> でデフォルトの状態を出力する</title>
   <para>
    デフォルトでは、
    <constant>STDOUT</constant> / <constant>STDERR</constant> で VT100 の機能が有効になっています。
   </para>
   <programlisting role="sh">
    php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));"
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
true true
]]>
   </screen>
   <para>
    ストリームがリダイレクトされた場合、
    VT100 の機能は有効になりません。
   </para>
   <programlisting role="sh">
    php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));" 2&gt;NUL
   </programlisting>
   &example.outputs.similar;
   <screen>
    true false
   </screen>
  </example>
  <example>
   <title><function>sapi_windows_vt100_support</function> で状態を変更する</title>
   <para>
    ストリームがリダイレクトされた場合、
    <constant>STDOUT</constant> や <constant>STDERR</constant> のVT100の機能は有効にできません。
   </para>
   <programlisting role="sh">
    php -r "var_export(sapi_windows_vt100_support(STDOUT, true));echo ' ';var_export(sapi_windows_vt100_support(STDERR, true));" 2&gt;NUL
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
true false
]]>
   </screen>
  </example>
  <example>
   <title>VT100 のサポートを有効にする例</title>
   <programlisting role="php">
<![CDATA[
<?php
$out = fopen('php://stdout','w');
fwrite($out, 'Just forgot a lettr.');
// カーソルを2文字分左に移動
fwrite($out, "\033[2D");
// 空白をひとつ分挿入し、既存のテキストを右に移動させる -> Just forgot a lett r.
fwrite($out, "\033[1@");
fwrite($out, 'e');
?>
]]>
   </programlisting>
    &example.outputs;
   <screen>
<![CDATA[
Just forgot a letter.
]]>
   </screen>
  </example>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->