El blog del burgués

19 marzo 2010

Funciones variadic

Filed under: C# — elburgues @ 8:21 AM
Tags:

La primera vez que escribí una entrada en un blog, no lo hice en  el mío, sino en el de un compañero de trabajo, que fue quien realmente me introdujo en este divertido mundo del posteo. Él me ofreció la posibilidad de replicar de nuevo aquél artículo en mi blog y así lo he hecho. Gracias compañero. En C y C++ se permite definir funciones con un número indefinido de argumentos. Son las llamadas funciones variadic, las cuales se declaran igual que las demás, salvo que en su lista de argumentos aparece, siempre en último lugar, el símbolo de elipsis (tres puntos). Un ejemplo de función variadic es wsprintf, que se declara como:

int cdecl wsprintf(LPTSTR lpOut, LPCTSTR lpFmt, …);

La función wsprintf da formato y almacena una serie de caracteres y valores en un búfer. Cualquier argumento se convierte y copia al búfer de salida de acuerdo al formato correspondiente especificado en la cadena de formato.
En esta declaración observamos que la función necesita al menos dos argumentos fijos y luego un número variable de argumentos, es decir, en diferentes invocaciones a la función, no tiene por que pasarse necesariamente el mismo número de parámetros.

Uso de funciones variadic no administradas desde .NET

En ocasiones tenemos que invocar desde código que se ejecuta bajo el control de la Common Language Runtime (código manejado), funciones que se ejecutan fuera de CLR, como por ejemplo las funciones de la API de Win32 (código no administrado). Si además de eso, la función que queremos usar es variadic, dos son las posibilidades que tenemos para hacerlo. Supongamos que queremos hacer uso de la función wsprintf desde un proyecto de consola en Visual C#.NET.

La 1ª opción:

Digamos que es la “forma oficial”, la recomendada por Microsoft. Se trata ni más ni menos de sobrecargar la función abarcando todas las posibilidades de uso que vamos a necesitar. Esta no es para nada una solución flexible:

using System;
using System.Text;
using System.Runtime.InteropServices;
namespace Interop.UnmanagedCode.VariadicsFunctions
{
    class wsprintfUse
    {
        // 1ª sobrecarga
        [DllImport("user32.dll", CallingConvention=CallingConvention.Cdecl)]
        static extern int wsprintf([Out] StringBuilder buffer, string format, int arg);
        // 2ª sobrecarga - varargs
        [DllImport("user32.dll", CallingConvention=CallingConvention.Cdecl)]
        static extern int wsprintf([Out] StringBuilder buffer, string format, int arg1, string arg2);

        static void Main(string[] args)
        {
            StringBuilder buffer = new StringBuilder();
            int result = wsprintf(buffer, "%d + %s", 2, "posibilidades.");
            Console.WriteLine("result: {0}\n{1}", result, buffer);
        }
    }
}

Ejecutar este código arrojaría el siguiente resultado:

Realizamos la llamada a través del atributo DllImport. Este atributo se puede aplicar a métodos y proporciona la información necesaria para importar una función exportada desde un archivo DLL no administrado. Como requisito mínimo, debe suministrarse el nombre del archivo DLL que contiene el punto de entrada. Señalar que la convención de llamada necesaria para llamar a métodos implementados en código no administrado es Cdecl, en la que el llamador limpia la pila. Esto permite llamar a funciones con varargs, que resulta apropiado para funciones que aceptan un número variable de parámetros como la que nos ocupa.

La 2ª opción:

Si está dispuesto a basarse en características indocumentadas (= no deberían usarse), también puede utilizar la palabra clave __arglist para definir un método “varargs”. No es conveniente utilizar la convención de llamada “varargs” o elipsis (…) ya que no es compatible con la Common Language Specification (CLS). Además, no es accesible para todos los lenguajes. Visual Basic no admite la convención de llamada VarArgs. El beneficio es que, de esta forma, se puede utilizar un método único para todo tipo de parámetros sin necesidad de la sobrecarga:

using System;
using System.Text;
using System.Runtime.InteropServices;

namespace Interop.UnmanagedCode.VariadicsFunctions
{
    class wsprintfUse
    {
        // 1ª sobrecarga
        [DllImport("user32.dll", CallingConvention=CallingConvention.Cdecl)]
        static extern int wsprintf([Out] StringBuilder buffer, string format, __arglist);

        static void Main(string[] args)
        {
            StringBuilder buffer = new StringBuilder();
            int result = wsprintf(buffer, "%d + %s", __arglist(2, "posibilidades"));
            Console.WriteLine("result: {0}\n{1}", result, buffer);
        }
    }
}

En este caso, la salida quedaría:

__arglist se utiliza tanto en el método de declaración como en la llamada (adjuntando entre paréntesis, separados por comas, los parámetros a pasar).

Por último añadir que para bibliotecas de clases administradas, no hay necesidad de utilizar esa convención de llamada. Es mejor utilizar la palabra clave params (ParamArray en Visual Basic):

public void VariableArguments(params string[] wordList)
{
    for (int i = 0; i < wordList.Length; i++)
    {
        Console.WriteLine(wordList[i]);
    }
}

Usando __arglist, habría que marcar al método con el siguiente atributo:

[CLSCompliant(false)]
public void VariableArguments(__arglist)
{
    ArgIterator argumentIterator = new ArgIterator(__arglist);
    for (int i = 0; i < argumentIterator.GetRemainingCount(); i++)
    {
        Console.WriteLine(
        __refvalue(argumentIterator.GetNextArg(), string));
    }
}
Anuncios

Dejar un comentario »

Aún no hay comentarios.

RSS feed for comments on this post.

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

Crea un blog o un sitio web gratuitos con WordPress.com.

A %d blogueros les gusta esto: