make_methodp - Online en la nube

PROGRAMA:

NOMBRE

make_method - Convierte el código Perl en una descripción XML para RPC :: XML :: Server

SINOPSIS

make_method --name = system.identification --helptext = 'Cadena de ID del sistema'
--signature = string --code = ident.pl --output = ident.xpl

make_method --base = métodos / identificación

DESCRIPCIÓN

Esta es una herramienta simple para crear archivos descriptivos XML para especificar métodos
publicado por un RPC :: XML :: Servidorservidor basado en.

Si un servidor está escrito de manera que los métodos que exporta (o publica) son parte de la
ejecutando código, entonces no hay necesidad de esta herramienta. Sin embargo, en los casos en que el servidor
estar separado y distinto del código (como un servidor RPC basado en Apache), especificando
las rutinas y completar la información de apoyo puede ser engorroso.

Una solución que el RPC :: XML :: Servidor ofertas de paquetes es el medio para cargar publicables
código de un archivo externo. El archivo está en un dialecto XML simple que delimita claramente el
nombre visible desde el exterior, las firmas del método, el texto de ayuda y el código en sí. Estas
Los archivos se pueden crear manualmente o esta herramienta se puede utilizar como ayuda.

REQUERIDO ARGUMENTOS

No hay argumentos obligatorios, pero si no hay suficientes opciones aprobadas,
ser informado por un mensaje de error.

CAMPUS

La herramienta reconoce las siguientes opciones:

--ayuda
Imprime un breve resumen de las opciones.

--name = STRING
Especifica el nombre publicado del método que se codifica. Este es el nombre con el que
será visible para los clientes del servidor.

--namespace = STRING
Especifica un espacio de nombres en el que se evaluará el código del método, cuando el XPL
El archivo es cargado por una instancia de servidor.

--type = STRING
Especifique el tipo del archivo resultante. "Tipo" aquí se refiere a si el contenedor
La etiqueta utilizada en el XML resultante especificará un procedimientos o un Método. El valor predeterminado es
Método. La cadena se trata independientemente de mayúsculas y minúsculas, y solo el primer carácter ("m" o
"p") en realidad se considera.

--version = STRING
Especifique un sello de versión para la rutina de código.

--oculto
Si esto pasa, el archivo resultante incluirá una etiqueta que le dice al demonio del servidor
para no hacer visible la rutina a través de interfaces de introspección.

--signature = STRING [--signature = STRING ...]
Especifique una o más firmas para el método. Las firmas deben ser los nombres de tipo como
establecidos en la documentación en RPC :: XML, con los elementos separados por dos puntos. usted
también puede separarlos con espacios, si cita el argumento. Esta opción puede ser
especificado más de una vez, ya que algunos métodos pueden tener varias firmas.

--helptext = STRING
Especifique el texto de ayuda del método como una cadena simple en la línea de comando. No
adecuado para cuerdas de ayuda terriblemente largas.

--helpfile = ARCHIVO
Lea el texto de ayuda del método en el archivo especificado.

--code = ARCHIVO
Lea el código real de la rutina del archivo especificado. Si esta opción no es
dado, el código se lee desde el descriptor de archivo de entrada estándar.

--output = ARCHIVO
Escriba la representación XML resultante en el archivo especificado. Si esta opción no es
dado, la salida va al descriptor de archivo de salida estándar.

--base = NOMBRE
Esta es una opción especial "todo en uno". Si se aprueba, se ignoran todas las demás opciones.

El valor se utiliza como elemento base para leer información de un archivo llamado
MASA.base. Este archivo contendrá la especificación del nombre, versión, estado oculto,
firmas y otra información del método. Cada línea del archivo debe verse como una de
el seguimiento:

Nombre: CADENA
Especifique el nombre de la rutina que se publica. Si esta línea no aparece,
entonces el valor de la --base argumento con todos los elementos del directorio eliminados será
usado.

Versión: CADENA
Proporcione un sello de versión para la función. Si no hay ninguna línea que coincida con este patrón
presente, no se escribirá ninguna etiqueta de versión.

Oculto: CADENA
Si está presente, CADENA debe ser "sí" o "no" (el caso no es importante). Si esto es
"sí", el método está marcado para ocultarse de cualquier API de introspección.

Firma: CADENA
Esta línea puede aparecer más de una vez y se trata de forma acumulativa. Otras opciones
anula los valores anteriores si aparecen más de una vez. La porción que sigue al
La parte "Firma:" se considera una firma publicada para el método, con
elementos separados por espacios en blanco. Cada método debe tener al menos una firma, por lo que
la falta de alguno provocará un error.

Archivo de ayuda: CADENA
Especifica el archivo desde el que leer el texto de ayuda. No es un error si no hay ayuda
se especifica el texto.

Archivo de código: CADENA
Especifica el archivo desde el que leer el código. Se supone que el código es Perl y
se etiquetará como tal en el archivo resultante.

Archivo de código [lang]: cadena
Especifica el archivo desde el que leer el código, al tiempo que identifica el idioma
en el que está el código. Esto permite la creación de un XPL archivo que incluye
implementaciones de múltiples lenguajes del método o procedimiento dado.

Cualquier otra línea que no sea los patrones anteriores se ignora.

Si no se ha leído ningún código, la herramienta se cerrará con un mensaje de error.

La salida se escribe en MASA.xpl, conservando la información de la ruta para que el
El archivo resultante está junto a los archivos de origen. Esto permite construcciones como:

make_method --base = métodos / introspección

ARCHIVO FORMATO Y DTD

El formato de archivo para estas rutinas publicadas es un dialecto XML muy simple. Esto es menos
debido a que XML es un formato ideal que la disponibilidad del analizador, dado que el
RPC :: XML :: Servidor class ya tendrá el código del analizador en core. Escribiendo un completamente nuevo
formato no habría ganado nada.

La Declaración de tipo de documento para el formato se puede resumir de la siguiente manera:

<!ELEMENT proceduredef (name, namespace?, version?, hidden?,
firma +, ayuda ?, código)>
<!ELEMENT methoddef (name, namespace?, version?, hidden?,
firma +, ayuda ?, código)>
<!ELEMENT functiondef (name, namespace?, version?, hidden?,
firma +, ayuda ?, código)>









El archivo "rpc-method.dtd" que viene con la distribución tiene algunos comentarios además
a la especificación real.

Un archivo está (por ahora) limitado a una definición. Esto lo inicia el de la apertura.
etiquetas " "," " o " ". A esto le sigue exactamente una
" "contenedor que especifica el nombre del método, un sello de versión opcional, un
bandera de esconderse de la introspección, una o más " "contenedores que especifican firmas,
un opcional " "contenedor con el texto de ayuda, luego el" " container with the
código de programa actual. Todo el texto debe usar codificación de entidad para los símbolos:

& C <&> (ampersand)
mi C <<> (menor que)
mi C <>> (mayor que)

El proceso de análisis dentro de la clase de servidor decodificará las entidades. Para hacer cosas
más fácil, la herramienta escanea todos los elementos de texto y codifica las entidades anteriores antes de escribir el
archivo.

El Especificaciones of Código
Esto no es "Programación 101"ni tampoco "Perl para las Algo Oscuro". El código que es
pasado a través de uno de los archivos "* .xpl" se pasa a "eval" sin casi ninguna modificación
(vea abajo). Por lo tanto, un código malicioso o mal escrito puede causar estragos en su
servidor. Esto no es culpa del código del servidor. El precio de la flexibilidad de este sistema
ofrece es responsabilidad del desarrollador asegurarse de que el código sea
probado y seguro.

El código en sí se trata lo más literalmente posible. Algunas ediciones pueden ocurrir en el lado del servidor,
ya que hace que el código sea adecuado para crear una subrutina anónima a partir de. los hacer_método
La herramienta intentará utilizar una sección "CDATA" para incrustar el código en el documento XML, por lo que
que no hay necesidad de codificar entidades ni nada por el estilo. Esto permite el resultado * .xpl
archivos para que se pueda comprobar la sintaxis con "perl -cx". Puede ayudar a esto asegurándose de que el código
no contiene ninguna de las dos siguientes secuencias de caracteres:

]]>

__DATOS__

El primero es el terminador "CDATA". Si ocurre de forma natural en el código, desencadenaría
el final de la sección en el analizador. El segundo es el conocido token de Perl, que se inserta
para que el resto del documento XML no abarrote el analizador de Perl.

EJEMPLOS

El RPC :: XML La distribución viene con varios métodos predeterminados en un subdirectorio llamado
(bastante crípticamente) "métodos". Cada uno de estos se expresa como un conjunto de ("* .base",
archivos "* .code", "* .help"). El archivo Makefile.PL configura el Makefile resultante como
que estos se utilizan para crear archivos "* .xpl" con esta herramienta y luego instalarlos.

La diagnostica

La mayoría de los problemas surgen en forma de mensajes de error seguidos de una salida abrupta.

SALIR ESTADO

La herramienta sale con un estado de 0 en caso de éxito y 255 en caso contrario.

AVISOS

No me gusta mucho este enfoque para especificar los métodos, pero me gustaron mis otras ideas incluso
Menos.

Utilice make_methodp en línea utilizando los servicios de onworks.net