ελευθερία ϗ ἀλήθεια

Swank (servidor Lisp) y Emacs (como cliente) puede ser altamente configurado, de manera que podemos desde elegir los estilos de comunicacion, comportamiento y hooks entre otras cosas.

Configuracion del grupo SLIME mediante customize

Cliente Emacs

La parte de Emacs de SLIME puede ser configurada con el sistema customize de Emacs, mas concretamente mediante M-x customize-group-slime. Dicho sistema de customizacion se describe a si mismo, por lo que el tutorial de SLIME y tambien aqui, nos centraremos en aquellas partes mas importantes u oscuras que necesitasen clarificaciones, aqui algunas variables que se pueden modificar.

slime-truncate-lines : por defecto es ‘t’, lo cual garantiza que las lineas no sean cortadas en los backtraces, listados de apropos, etc.

slime-complete-symbol-function : Se emplea para completar simbolos lisp, existen 3 posibles estilos: slime-simple-complete-symbol, slime-complete-symbol* y slime-fuzzy-complete-symbol. El valor por defecto es slime-simple-complete-symbol, el cual completa en el estilo usual de emacs.

slime-filename-translations : Controla la traduccion de ficheros entre Emacs  y el sistema Lisp. Esto es util si se ejecuta Emacs y Lisp en maquinas separadas las cuales no comparten un sistema de ficheros en comun o bien si se comparte el sistema de ficheros pero que tienen layouts differentes (como por ejemplo en SMB).

slime-net-coding-system : Para transmitir caracteres unicode entre Emacs y el sistema Lisp, es necesario configurar esta variable, por ejemplo como    (setq slime-net-coding-system ‘utf-8-unix). Ademas, paa mostrar los caracteres unicode dbeemos disponer de fuentes apropiadas.

Hooks:

slime-mode-hook : Este hook se ejecuta cada vez que el buffer entra en slime-mode. Ideal para configurar el buffer local, por ejemplo para activar slime-autodoc-mode.

slime-connected-hook : Este hook se ejecuta cuando SLIME establece conexion con el servidor Lisp.

sldb-hook : Se ejecuta despues de que SLDB sea invocado. Por  ejemplo anadiendo sldb-print-condition a este hook hara que todas las condiciones debuggeadas con SLDB sean registradas en el buffer REPL.

Swank

Por otra parte, existe el lado de Lisp como servidor, conocido como «Swank», que ofrece multiples variables que pueden ser configuradas. El fichero de inicializacion es ~/.swank.lisp el cual es automaticamente evaluado en el arranque y puede ser usado para modificar el valor de estas variables.

Estilo de comunicacion:

La configuracion mas importante se encuentra en SWANK:*COMMUNICATION-STYLE*, el cual especifica el mecanismo por el cual Lisp lee y procesa los mensajes de protocol desde Emacs. La eleccion del estilo de comunicacion tiene una influencia global en las operaciones SLIME. Los diferentes estilos de comunicacion son los siguientes:

NIL : Simplemente hace loop del input de lectura del socket de comunicacion y da servicio a los eventos del protocolo SLIME.

:FD-HANDLER : Utiliza el clasico estilo UNIX select() loop. Swank registra el socket de comunicacion con un framework de evento dispatch (e.g. SERVE-EVENT en CMUCL y SBCL) y recibe un callback cuando los datos estan disponibles.

:SIGIO : Este estilo usa senales I/O con un manejador de senales SIGIO. Lisp recibe peticiones de Emacs con una senal, causando la interrupcion sin importar que se este haciendo para asi dar servicio a la peticion. Esto permite a Emacs lanzar peticiones de manera concurrente.

:SPAWN : Utiliza soporte multiproceso en el sistema Lisp para ejecutar cada peticion en un thread separado, pero en este caso no se emplean senales, ademas las peticiones son procesadas por Emacs y pueden ser ejecutadas de manera paralela.

El estilo para el manejo de peticiones es elegido dependiendo del soporte de nuestro sistema Lisp. El orden general por preferencia es; :SPAWN, :SIGIO, :FD-HANDLER, NIL.

Otras configuraciones:

Las siguientes variables Lisp pueden ser configuradas mediante el fichero ~/.swank.lisp:

SWANK:*CONFIGURE-EMACS-INDENTATION* : Controla el estilo de identacion para los argumentos &body en las macros que son descubiertas y enviadas a Emacs. Esta opcion esta activada por defecto.

SWANK:*GLOBALLY-REDIRECT-IO* : Cuando esta activada, causa que los streams standars (*standard-output*, etc) sean globalmente redireccionados al REPL en Emacs. Si el valor es NIL (que es por defecto) estos streams son solo redireccionados de manera temporal a Emacs usando bindings dinamicos mientras se manejan las peticiones. *standard-input* nunca es redireccionado a Emacs, debido a que puede interactuar de manera erronea con el REPL nativo de Lisp.

SWANK:*GLOBAL-DEBUGGER* : Cuando es true (opcion por defecto) causa que *DEBUGGER-HOOK*  sea globalmente configurado a SWANK:SWANK-DEBUGGER-HOOK y por lo tanto SLIME manejara todo el debugging en una imagen Lisp. Se utiliza para debugging en multithread y aplicaciones callback-driven.

SWANK:*SLDB-QUIT-RESTART* : Nombra el reinicio que es invocado cuando se pulsa q (para sldb-quit) en SLDB. Para la evaluacion de peticiones SLIME esto es usado de manera incondicional para reiniciar y volver a un punto seguro. Ejemplo:  (setf swank:*sldb-quit-restart* ‘sb-thread:terminate-thread)

SWANK:*BACKTRACE-PRINTER-BINDINGS*, SWANK:*MACROEXPAND-PRINTER-BINDINGS*, SWANK:*SLDB-PRINTER-BINDINGS*, SWANK:*SWANK-PPRINT-BINDINGS* : Estas variables se emplean para configurar el printer en distintas situaciones. Por ejemplo para activar el pretty printer para el formato de los backtraces en SLDB podemos emplear:  (push ‘(*print-pretty* . t) swank:*sldb-printer-bindings*).

SWANK:*USE-DEDICATED-OUTPUT-STREAM* : Esta variable controla el uso para hackear una eficiencia insegura cuando enviamos a la salida para impresion desde Lisp a Emacs. El valor por defecto es nil. Se recomienda no cambiar el valor de esta variable, ya que cuando es t, un socket separado se establece desde Lisp para enviar a la salida de impresion para Emacs, el cual es mas rapido que enviar la salida en los mensajes de protocolo a Emacs. Sin embargo, no esta garantizado el tiempo entre la salida de stream dedicada y la salida de mensajes de protocolo, por lo que la salida de un comando Lisp puede llegare antes o despues de los correspondientes resultados de REPL, o bien llegar en orden incorrecto, e incluso interferidos en el buffer REPL.

SWANK:*DEDICATED-OUTPUT-STREAM-PORT* : Cuando *USE-DEDICATED-OUTPUT-STREAM* es t, el stream sera abierto en este puerto. El valor por defecto es 0, lo que significa que el stream sera abierto en un puerto aleatorio.

SWANK:*LOG-EVENTS* : Configurando esta variable t causara que todos los mensajes de protocolos intercambiados con Emacs seran mostrados en *TERMINAL-IO*. Esto es util para debugging a bajo nivel y para observar como SLIME trabaja ‘on the wire’. La salida de *TERMINAL-IO* puede ser mostrada en nuestro propio listener de nuestro sistema Lisp, usualmente en el buffer *inferior-lisp*.

Ejemplo de configuracion del puerto para el servidor de Swank.

Algunas funcionalidades y usos de SLIME no es tan basico como las opciones que comentabamos en posts anteriores. Ademas de SLDB que comentabamos en el post anterior, existen muchas otras opciones que hacen de SLIME un gran modo para trabajar en nuestro entorno GNU/emacs.

SLIME Selector

El comando slime-selector es empleado para cambiar de forma rapida entre buffers importantes: REPL, SLDB, el codigo fuente Lisp donde hackeamos, etc. Una vez invocado el prompt, nos permite usar una letra especifica para indicar que buffer queremos mostrar:

? : Muestra ayuda sobre los buffers disponibles de slime-selectors.

r : El buffer REPL para la conexion SLIME actual.

d : El buffer SLDB empleado mas recientemente activado para la conexion actual.

l : El buffer de codigo empleando lisp-mode usado mas recientemente.

s : Buffer *slime-scratch*.

c : Buffer de conexion Lisp.

n : Ciclo hacia la siguiente conexion Lisp.

t : SLIME threads buffer.

SLIME Macroexpansion

Con los buffers de SLIME existen comandos extra empleados especificamente para la expansion de macros.

C-c C-m : ‘slime-macroexpand-1-inplace‘ ; Como slime-macroexpand-1 pero en la forma original es reemplazado con la expansion.

g : ‘slime-macroexpand-1-inplace‘ : La ultima expansion de macros es realizada de nuevo, los contenidos actuales del buffer de la expansion de macros son reemplazados con la nueva expansion.

q : ‘slime-temp-buffer-quit‘ ; Cierra el buffer de expansion.

C-_ : ‘slime-macroexpand-undo‘ ; Deshace la ultima operacion de expansion de macros.

SLDB es el debugger incluido en SLIME, aunque por supuesto se puede especificar otro; aunque este esta optimizado para CL y bien integrado en emacs.

Ciertas condiciones en el sistema Lisp invocaran a SLDB en emacs mediante *DEBUGGER-HOOK*. SLDB mostrara un buffer con la condicion que ha lanzado la senal. Es a partir de este momento cuando se nos da la posibilidad de debuggear mediante SLDB.

Para examinar frames tenemos los siguientes keybindings:

t : ‘sldb-toggle-details‘ ; Hace toggle para mostrar las variables locales y los tags CATCH.

v : ‘sldb-show-source‘ ; Visualiza las expresiones de codigo del frame actual.

e : ‘sldb-eval-in-frame‘ ; Evalua una expresion en el frame. La expresion puede referirse a las variables locales disponibles del frame.

d : ‘sldb-pprint-eval-in-frame‘ ; Evalua una expresion en el frame e imprime el resultado en un buffer temporal.

D : ‘sldb-disassemble‘ ; Desensambla la funcion de un frame. Incluye informacion como punteros a instrucciones en el frame.

i : ‘sldb-inspect-in-frame‘ ; Inspecciona el resultado de evaluar una expresion en el frame.

C-c C-c : ‘sldb-recompile-frame-source‘ ; Recompila un frame. Mediante el argumento con C-u C-c C-c recompila el frame con las opciones de debugging maximas posibles.

Para reiniciar la invocacion:

a : ‘sldb-abort‘ ; Invoca el reinicio ABORT.

q : ‘sldb-quit‘ ; Sale. Para peticiones de evaluacion SLIME, invoca el reinicio el cual restaura el estado conocido de un programa. Para errores en otros threads, es necesario indagar en [SWANK:*SLDB-QUIT-RESTART*].

c : ‘sldb-continue‘ ; invoca el reinicio CONTINUE

0…9 : invoca el reinicio por numero

Los reinicios pueden ser tambien invocados pulsando RET en el buffer.

Para navegar entre frames:

n : ‘sldb-down‘ ; Se mueve frame abajo.

p : ‘sldb-up‘ ; Se mueve frame arriba.

M-n : ‘sldb-details-down‘ ; Se mueve frame abajo «con azucar»: oculta los detalles del frame original y muestra detalles y codigo fuente del siguiente. El movimiento entre frames con azucarado muesta los detalles del codigo fuente del frame actual solamente.

M-p : ‘sldb-details-up‘ ; Se mueve frame arriba «con azucar»: oculta los detalles del frame original y muestra detalles y codigo fuente del anterior. El movimiento entre frames con azucarado muesta los detalles del codigo fuente del frame actual solamente.

> : ‘sldb-end-of-backtrace‘ ; Captura el backtrace entero y salta al ultimo frame.

< : ‘sldb-beginning-of-backtrace‘ ; Salta al primer frame.

Para realizar pasos con el debugger empleamos los siguientes keybidings:

s : ‘sldb-step‘ ; Da un paso hacia la siguiente expresion en el frame. Para CMUCL esto significa que hace set para un breakpoint para todas aquellas partes de codigo del bloque actual de codigo el cual es alcanzable desde el codigo en la localizacion actual.

x : ‘sldb-next‘ ; Da un paso hacia adelante en la funcion actual.

o : ‘sldb-out‘ ; Para el paso-simple de forma temporal, pero lo continua una vez se vuelva de la funcion actual.

Otros keybidings empleandos en el debugger y de utilidad son:

r : ‘sldb-restart-frame‘ ; Reinicia la ejecucion de un frame con los mismos argumentos que fueron originalmente usados en la llamada.

R : ‘sldb-return-from-frame‘ ; Vuelve desde el frame con el valor introducido en el minibuffer.

B : ‘sldb-break-with-default-debugger‘ ; Sale de SLDB y debuggea la condicion usando el debugger por defecto del sistema Lisp.

C : ‘sldb-inspect-condition‘ ; Inspecciona la condicion actual a ser debuggeada.

: : ‘slime-interactive-eval‘ ; Evalua una expresion introducida en el minibuffer.

A : ‘sldb-break-with-system-debugger‘ ; Adjunta el debugger al proceso actual lisp.

Captura de pantalla de SLDB