CVI. Readline (GNU)

Introduction

Les fonctions readline implémentent une interface avec la bibliothèque GNU Readline. Ces fonctions fournissent une ligne de commande éditable, un peu comme lorsque Bash vous permet d'utiliser les flèches de déplacement pour insérer un caractère ou passer en revue l'historique. A cause de l'interactivité de ces commande, elles ne seront que rarement utiles pour les applications Web, mais peuvent se révéler utiles lorsqu'un script est exécuté depuis une ligne de commande.

Note : Cette extension n'est pas disponible sur les plates-formes Windows.

Pré-requis

Pour utiliser les fonctions readline, vous devez installer la bibliothèque libreadline. Vous pouvez la trouver sur la page du projet GNU, à http://cnswww.cns.cwru.edu/~chet/readline/rltop.html. Elle est maintenue par Chet Ramey, qui est l'auteur de Bash.

Vous pouvez aussi utiliser ces fonctions avec la bibliothèque libedit, un remplacement de la bibliothèque readline, qui n'est pas GPL. La bibliothèque libedit est sous license BSD, et elle est disponible depuis http://sourceforge.net/projects/libedit/.

Installation

Pour utiliser ces fonctions, vous devez compiler PHP, en version CGI ou CLI. Vous devez aussi utiliser l'option de compilation --with-readline[=DIR]. Si vous souhaitez utiliser la bibliothèque libedit readline, en remplacement, compilez PHP avec l'option --with-libedit[=DIR].

Configuration à l'exécution

Cette extension ne définit aucune directive de configuration.

Types de ressources

Cette extension ne définit aucune ressource.

Constantes pré-définies

Cette extension ne définit aucune constante.

Table des matières
readline_add_history -- Ajoute une ligne à l'historique
readline_callback_handler_install -- Initialise l'interface et le terminal de callback de readline, affiche le prompt et retourne immédiatement
readline_callback_handler_remove -- Efface un gestionnaire de callback installé précédemment et restore les paramètres du terminal
readline_callback_read_char -- Lit un caractère et informe l'interface de callback readline lorsqu'une ligne est reçue
readline_clear_history -- Efface l'historique
readline_completion_function -- Enregistre une fonction de complétion
readline_info -- Lit/modifie diverses variables internes
readline_list_history -- Liste l'historique
readline_on_new_line --  Informe readline que le curseur est passé à une nouvelle ligne
readline_read_history -- Lit l'historique
readline_redisplay --  Demande à readline de refaire l'affichage
readline_write_history -- Ecrit dans l'historique
readline -- Lit une ligne