El Analizador Sintáctico de la DokuWiki

Este documento explica los detalles del analizador sintàctico (parser) de la DokuWiki y está destinado a desarrolladores que desean modificar el comportamiento del analizador u obtener un mayor control sobre el documento de salida, modificando el código HTML generado o implementando diferentes formatos de salida.

Información general

El parser¹⁾ descompone en etapas discretas el proceso de transformar un documento DokuWiki crudo en el documento de salida final²⁾.

En términos generales estos elementos son:

Lexer³⁾ explora⁴⁾ un documento DokuWiki y genera una secuencia de tokens⁵⁾, que corresponde a la sintaxis en el documento.
Handler⁶⁾: recibe los tokens del Lexer y los transforma en una secuencia de “instrucciones”⁷⁾. En él se describe cómo debe traducirse el documento, de principio a fin, sin necesidad de que el Render lleve un registro de estado.
Parser⁸⁾: “conecta” el Lexer con el Handler, proporcionando las reglas de sintaxis de la DokuWiki, así como el punto de acceso al sistema (el método Parser::parse())
Renderer⁹⁾: acepta las instrucciones del Handler y “dibuja” el documento listo para su visualización (por ejemplo, como XHTML)

No se proporciona ningún mecanismo para conectar el Handler con el Renderer - es necesaria una codificación para cada caso específico.

Diagrama aproximado de las relaciones entre estos componentes :

                                                               
      +-----------+          +-----------+
      |           |  Input   |  Código   |
      |  Parser   |<---------|  Cliente  |
      |           |  String  |           |
      +-----.-----+          +-----|-----+
    Modes   |                     /|\
      +     |             Renderer |
    Input   |          Instructions|
    String \|/                     |
      +-----'-----+          +-----------+
      |           |          |           |
      |  Lexer    |--------->|  Handler  |
      |           |  Tokens  |           |
      +-----.-----+          +-----------+
            |
            |
       +----+---+
       | Modes  |-+
       +--------+ |-+
         +--------+ |
           +--------+

El “Código Cliente” (código enviado al Parser) invoca al Parser, dándole la cadena de entrada. Recibe, a cambio, la lista de las “Instrucciones de Renderer”, construidas por el Handler. Estas pueden alimentar a algún objeto que implementa el Renderer.

¹⁾

analizador

²⁾

normalmente XHTML

³⁾

Lexer: hace referencia a la clase Doku_Lexer y al contenido del archivo inc/parser/lexer.php

⁴⁾

explora un documento PHP desde el pincipio al final

⁵⁾

el término token (testigo), en este documento, se refiere a las expresiones regulares coincidentes que genera el Lexer y las correspondientes llamadas a métodos en el Handler

⁶⁾

Handler (manejador): hace referencia a la clase Doku_Handler y al contenido del archivo inc/parser/handler.php

⁷⁾

la secuencia de instrucciones se almacena en una matriz llamada $calls, que es una propiedad del Handler. Está diseñada para ser utilizada con call_user_func_array

⁸⁾

Parser (analizador): hace referencia a la clase Doku_Parser y al contenido del archivo inc/parser/parser.php

⁹⁾

Render (procesador): hace referencia a alguna clase que implemente Doku_Renderer - ver inc/renderer/renderer.php y inc/parser/xhtml.php