Contando palabras reservadas

Intentando continuar la serie dedicada a las novedades aparecidas en C# 7.0 y versiones posteriores, se me ocurrió escribir un programa que contara las apariciones de las diferentes palabras reservadas (keywords) y palabras reservadas contextuales (contextual keywords) de C# en un fichero de código fuente individual o un conjunto de ficheros de código fuente alojados en una estructura de carpetas anidadas. Como lejana fuente de inspiración me sirvió el recuerdo de un programa para contar las palabras de un fichero incluido en un libro que ha dejado huella, “The C Programming Language“, de Kernighan y Ritchie.

Originalmente pensé que podría utilizar el programa para mostrar las ventajas que puede aportar al rendimiento la utilización de las variables locales y valores de retorno por referencia (ref locals and returns) incorporadas a C# 7.0. Lo cierto es que a lo largo del camino perdí el norte (tal vez me reencuentre con él en una próxima entrega), pero pienso que el viaje ha valido la pena; en particular, por fin he hecho uso (aunque de una manera trivial, lo reconozco) de las posibilidades que ofrece .NET Compiler Platform, la tecnología anteriormente conocida como Roslyn. Espero que el lector también saque algo positivo de la lectura de esta entrada, y para contribuir más a ello pongo a su disposición el código del proyecto, en el que también se utilizan otras novedades de C# 7.0 como las tuplas-valor o las funciones anidadas.

No me extenderé mucho aquí en una introducción al uso de .NET Compiler Platform, porque el lector encontrará múltiples tutoriales de calidad en la web, en particular para el análisis sintáctico; un buen ejemplo es éste. Baste decir que solo es necesario añadir a su proyecto el paquete de NuGet Microsoft.CodeAnalysis.CSharp, y ello le dará acceso a toda la gama de herramientas para la compilación que ofrece Roslyn. Gracias a esa potencia, el método central de nuestro ejemplo, que procesa un fichero de código fuente C#, consiste en unas pocas líneas:

private static void ProcessFile(string fileName)
{
    var tree = CSharpSyntaxTree.ParseText(File.ReadAllText(fileName));
    Traverse(tree.GetRoot());

    void Traverse(SyntaxNode node)
    {
        foreach (var childToken in node.ChildTokens())
        {
            if (childToken.IsKeyword() || childToken.IsContextualKeyword())
            {
                var text = childToken.Text;
                dict[text] = (dict[text].IsContextual, dict[text].Count + 1);
            }
        }

        foreach (var childNode in node.ChildNodes())
            Traverse(childNode);
    }
}

Las listas completas de palabras reservadas y palabras reservadas contextuales de C# las tomé directamente del código fuente de Roslyn en Github; las que intenté tomar de otras fuentes estaban siempre incompletas, como pude comprobar al ejecutar el programa sobre un conjunto de ficheros de la vida real. Las cinco palabras reservadas más utilizadas en ese conjunto son, en orden descendente: using, public, new, return y private.

El futuro atributo CallerArgumentExpression: un deseo que se cumplirá

“… It’s too bad that all these things
Can only happen in my dreams
Only in dreams, in beautiful dreams …”
Roy Orbison, “In Dreams” (1963)

“… We all know / That people are the same wherever you go …”
Paul McCartney & Stevie Wonder, “Ebony and Ivory” (1982)

Hace unos cuantos meses, mi buen amigo Eduard Tomàs publicó en este mismo sitio una entrada con título auto-descriptivo llamada “Hoy he echado en falta poder definir macros en C#“. En la discusión subsiguiente, especulamos sobre un hipotético atributo de .NET que hiciera posible satisfacer su deseo incumplido. Pues bien, ayer revisando las propuestas de características a añadir en las próximas versiones del lenguaje (en el sitio de Github en el que el equipo de C# publica las minutas de sus reuniones, entre otros documentos muy interesantes) me encontré con la descripción del futuro atributo CallerArgumentExpression, que (en el supuesto de que sea implementado, claro), permitirá lograr fácilmente el efecto que Eduard quería obtener aquella vez.

La propuesta de esta nueva característica está siendo considerada por el equipo de C# desde mayo de 2017, unos cuantos meses antes de que nosotros conversáramos sobre el tema; ello me reafirma una vez más en que, como dijeran magistralmente Paul y Stevie, la gente (y en particular, los programadores) tiene las mismas necesidades en todos los lugares. 🙂

using System.Runtime.CompilerServices;

public static class Check
{
    public static void NotNull<TParameter>(TParameter param, 
        [CallerArgumentExpression("param")] string expr = "")
        where TParameter : class
    {
        if (param == null)
        {
            throw new ArgumentNullException(paramName: expr);
        }
    }
}

Referencia musical: Intenté infructuosamente encontrar alguna canción de mi época que dijera que algunos sueños a veces se cumplen; no encontré ninguna, así que he puesto otra que dice más o menos lo contrario. Su autor fue el genial Roy Orbison, a quien mayormente se le recuerda por haber escrito la canción que sirvió de tema a la película “Pretty Woman“. De Paul McCartney y Stevie Wonder no diré nada más aquí – son dos de mis músicos favoritos y seguramente los he mencionado ya en alguna entrada anterior.

Sobre la implementación interna de las tuplas-valor (y 4)

“When the hills of Los Angeles are burning
Palm trees are candles in the murder wind
So many lives are on the breeze
Even the stars are ill at ease
And Los Angeles is burning…”
Bad Religion, Los Angeles is Burning (2004)

Parte 1
Parte 2
Parte 3

Para concluir la serie sobre la implementación interna de las tuplas-valor, hoy presento un pequeño divertimento que vuelve a incidir sobre los detalles de dicha implementación.

Suponga que tiene una tupla-valor con varios elementos, y quiere tratar a dichos elementos como una secuencia, por ejemplo para agregarlos de alguna manera (recuerde que el operador Aggregate de LINQ no está limitado, ni mucho menos,  a secuencias numéricas). Independientemente de que LINQ ya hace tiempo que dejó estar en el centro de atención para convertirse en algo “normal”, estamos en presencia de un caso típico en el que quisiéramos “habilitar para LINQ” un tipo de datos específico, para lo que tan solo hace falta crear un método extensor que reciba una instancia del tipo y produzca a partir de ella un IEnumerable o IEnumerable<T> a recorrer. Es un tema al que dediqué varios artículos en la pasada década, en particular éste. Con un método como el anterior (al que llamaremos, como se recomienda, AsEnumerable), podremos hacer cosas como lo siguiente:

using System;
using System.Linq;
 
namespace ValueTuples
{
    class MainClass
    {
        static void Main()
        {
            var tuple = (12345678910);
            var sum = (from int x in tuple.AsEnumerable()
                       where x % 2 == 0
                       select x).Sum();              
            Console.WriteLine(sum); // Imprime 30
        }
    }
}

La implementación del método extensor que se me ha ocurrido (teniendo en cuenta las cosas que hemos venido hablando sobre la implementación interna de las tuplas-valor) es la que sigue a continuación; se aceptan sugerencias para su mejora.

using System;
using System.Collections;
using System.Linq;
using System.Reflection;
using SC = System.StringComparison;
 
namespace ValueTuples
{
    public static class ValueTupleExtensions
    {
        public static IEnumerable AsEnumerable(this object valueTuple)
        {
            Type type = valueTuple.GetType();
            if (!type.FullName.StartsWith("System.ValueTuple"                                          SC.InvariantCulture))
                throw new InvalidOperationException("Invalid type");
            foreach (FieldInfo fi in type.GetFields().OrderBy(fi => fi.Name))
            {
                if (fi.Name == "Rest"// "El octavo pasajero"
                {
                    foreach (object o in AsEnumerable(fi.GetValue(valueTuple)))
                        yield return o;
                }
                else
                {
                    yield return fi.GetValue(valueTuple);
                }
            }
        }
    }
}

Referencia musical: Como el tiempo para concebir y escribir este post se presentó debido a un incendio forestal que amenazó nuestra empresa hoy hasta el punto de que nos evacuaron a casa, lo menos que pude hacer fue buscar una canción alusiva al tema, y creo que encontré una bastante buena. Bad Religion es una banda de punk-rock formada en Los Ángeles en 1980 (ya yo me estaba haciendo viejo por esa época) y que aún se mantiene activa. No soy un experto en su obra, pero suenan bien y tienen letras inteligentes.

Sobre la implementación interna de las tuplas-valor (3)

En la entrada anterior mostramos cómo el compilador de C# 7.0 y posteriores genera atributos TupleElementNames (espacio de nombres System.Runtime.CompilerServices) para los parámetros de entrada y valores de retorno de métodos que sean tuplas, y cómo estos atributos son luego utilizados por el propio compilador para permitirnos utilizar nombres menos áridos que Item1, Item2, etc. para referirnos a los elementos de cada una de esas tuplas. Esta generación de atributos TupleElementNames no se limita únicamente a los argumentos y valores de retorno de funciones. Por ejemplo, el siguiente programa compila y ejecuta correctamente de C# 7.0 en adelante:

01 using System;
02 class MainClass
03 {
04     static readonly (string Name, int Age) tuple = ("Denis"31);
05
06     static void Main()
07     {
08         (double Re, double Im) i = (01);
09         // Imprime '(0, 1)'
10         Console.WriteLine($"({i.Re}{i.Im})");
11         // Imprime 'Denis is 31'
12         Console.WriteLine($"{tuple.Name} is {tuple.Age}");
13     }
14 }

Si se compila y luego desensambla el código, se verá algo como lo siguiente:

internal class MainClass
{
    // Static Fields
    [TupleElementNames(new string[] { "Name", "Age" })]
    private static readonly ValueTuple<stringint> tuple = 
        new ValueTuple<stringint> ("Denis"31);

    // Static Methods
    private static void Main ()
    {
        ValueTuple<doubledouble> valueTuple = 
            new ValueTuple<doubledouble> (0.01.0);
        Console.WriteLine (string.Format ("({0}, {1})", 
            valueTuple.Item1, valueTuple.Item2));
        Console.WriteLine (string.Format ("{0} is {1}", 
            MainClass.tuple.Item1, MainClass.tuple.Item2));
    }
}

En este caso, el atributo TupleElementNames se aplica a un campo estático, que podría ser público y con ello accesible desde otros ensamblados. Observe, por otra parte, que no se ha generado el atributo para la variable local i; el análisis de flujo del compilador detecta que ésta no podrá ser accedida desde fuera del ámbito en el que ha sido definida, y por lo tanto el atributo sería superfluo.

Personalmente, creo que preferiré siempre que se pueda utilizar un estilo similar al usado en la declaración del campo tuple en el código anterior (línea 04), asignando tipos y nombres explícitos a los elementos de las tuplas del lado izquierdo de la igualdad. Asimismo, utilizaré notación Pascal para esos nombres (como en Name y Age), lo que no solo me gusta más, sino además es lo que recomienda Microsoft para campos públicos en los convenios de nombres de .NET. Ahora bien, ¿qué otras alternativas tenemos a nuestro alcance a la hora de declarar e inicializar un campo o variable de tipo de tupla? Pues podríamos enumerar las siguientes:

a) Tanto para campos como para variables locales, simplemente escribir: (stringint) tupla = (Denis31);

Obviamente, el código cliente tendrá que referirse a los elementos de la dupla utilizando los nombres Item1 e Item2.

b) Para variables locales, utilizar var: var i = (01);

Tal como está escrito el código, también habría que utilizar Item1 e Item2 ; pero ¡siga leyendo!

c) Resulta que la sintaxis para constantes de tuplas permite (por ortogonalidad con los tipos anónimos) establecer nombres para los elementos como parte del literal de tupla; por lo tanto, se obtendría el mismo efecto de la línea 08 del ejemplo al escribir1: var i = (Re: 0.0, Im: 1.0);

Esto sólo funciona para variables locales declaradas mediante var; en otro caso, se produce la advertencia “The tuple element name ‘X‘ is ignored, because a different name or no name is specified for the target type“.

d) Por último, debemos mencionar que C# 7.1 ha añadido un pequeño detalle adicional a lo planteado en el inciso anterior, permitiendo que los nombres de los elementos de las tuplas se infieran a partir de los nombres de las variables utilizadas para inicializar dichos elementos. Por ejemplo, considere el siguiente pequeño programa:

01 using System;
02 class MainClass
03 {
04     static void Main()
05     {
06         double re = 0.0, im = 1.0;
07         var i = (re, im);
08
09         // Imprime '(0, 1)' (en C# 7.1) 
10         Console.WriteLine($"({i.re}{i.im})");
11     }
12 }

Compilado con C# 7.1, el programa anterior ejecuta correctamente, porque los nombres re e im se infieren para los elementos de i. Pero si se compila con C# 7.0, esos elementos no tienen nombre explícito y el compilador se queja en la línea 10 de que i no tiene ningún miembro llamado re, aunque lo hace de una manera muy simpática, como aludiendo al futuro: “Tuple element name ‘re‘ is inferred. Please use version 7.1 or higher to access an element by its inferred name“. Obviamente, este mensaje se modificó cuando C# 7.1 salió a la luz.

La versión del compilador a utilizar se selecciona en las opciones del proyecto:


1 Pero note que deberá incluir el “.0” para las constantes – en caso contrario, sería una dupla con dos elementos enteros.

Sobre la implementación interna de las tuplas-valor (2)

Al final de la entrada anterior mostramos cómo el compilador de C# 7.0 y posteriores sintetiza un atributo TupleElementNames (espacio de nombres System.Runtime.CompilerServices) cada vez que una función devuelve una tupla. Lo mismo ocurre en el caso de que uno o más parámetros de entrada sean tuplas. Por ejemplo, para la siguiente función, que recibe dos parámetros de tipos de tuplas y retorna una tercera:

(string Name, int Age) Transform(
    (string FirstName, string LastName) name, 
    (int Year, int Month, int Day) birthDate)
{
    var fullName = $"{name.FirstName} {name.LastName}";
    var age = Years(
        new DateTime(birthDate.Year, birthDate.Month, birthDate.Day), 
        DateTime.Now);
    return (fullName, age);
}

se genera el siguiente código:

[return: TupleElementNames(new string[] { "Name", "Age" })]
private ValueTuple<stringint> Transform (
    [TupleElementNames(new string[] { "FirstName", "LastName" })]
    ValueTuple<stringstring> name, 
    [TupleElementNames(new string[] { "Year", "Month", "Day" })]
    ValueTuple<intintint> birthDate)
{
    string fullName = string.Format("{0} {1}", name.Item1, name.Item2);
    int age = MainClass.Years(
        new DateTime (birthDate.Item1, birthDate.Item2, birthDate.Item3), 
        DateTime.Now);
    return new ValueTuple<stringint> (fullName, age);
}

Recordando cuál es el objetivo central para el que fueron diseñados los atributos de C#, el de asociar información adicional de metadatos a tipos o miembros de un tipo para que posteriormente pueda ser consumida por herramientas externas1, queda claro por qué razón se asocian estos atributos a las tuplas: para que el propio compilador de C# los lea al procesar tanto un fichero de código fuente como un ensamblado compilado del que no dispongamos del código fuente, y de esta forma se haga posible que se nos permita escribir x.Name o x.Age en lugar de la notación más críptica x.Item1 o x.Item2 (que, en cualquier caso, sigue estando disponible) para acceder a los miembros de la dupla devuelta por Transform.

Observe, sin embargo, que esta implementación mediante atributos de los nombres de elementos nos podría obligar en ciertos casos a escribir código adicional. En el fondo, los verdaderos nombres de los campos son Item1, Item2, etc., y tendremos que personalizar a medida, por ejemplo, el código que hace reflexión o serialización si quisiéramos aprovechar los nombres mnemotécnicos en esos escenarios. Por ejemplo, la serialización directa a JSON de un objeto devuelto por la función anterior utilizando el método JsonConvert.SerializeObject de la librería JSON.NET producirá simplemente:

{"Item1":"Denis","Item2":31}

En nuestra próxima entrega continuaremos hablando un poco más sobre este mismo tema, que ha dado bastante de sí.


1 Generalmente prefiero los términos que se utilizan en C# con respecto a los usados para conceptos similares o equivalentes de Java, pero creo aquí Java se llevó las palmas: allí se habla de anotaciones (annotations) en lugar de atributos.

Sobre la implementación interna de las tuplas-valor

“… ¡Azúcar!”
Exclamación que popularizó la cantante cubana Celia Cruz (la Reina de la Salsa)

Algunas entradas atrás prometimos hablar sobre los mecanismos en los que se apoyan C# 7.0 y posteriores (note el lector que ya está disponible C# 7.2) para dar soporte al nuevo “azúcar sintáctico” que permite hacer uso de las tuplas-valor, y eso es precisamente sobre lo que trataremos hoy aquí.

Ya en aquella ocasión indicábamos que la base fundamental para la característica lo aporta el tipo (o familia de tipos) System.ValueTuple, que se diferencia de la ahora cuasi-obsoleta System.Tuple introducida en .NET Framework 4.0 en varias aspectos fundamentales:

  • ValueTuple es una estructura en vez de una clase, lo que lo hace en principio más ligero y eficiente. En particular, esto hace posible que el compilador aloje las variables locales de ese tipo, así como las tuplas-valor que sean argumentos de entrada y valores de retorno, en la pila (stack) en vez de la memoria dinámica.
  •  Los miembros de una estructura ValueTuple son campos públicos en vez de propiedades de solo lectura, lo que nuevamente permite generar un código más rápido para el acceso a ellos.
  • Como consecuencia de lo anterior, a diferencia de lo que ocurría en el caso de Tuple, los elementos de las tuplas-valor pueden ser modificados (son mutables).
  • Si bien por defecto el convenio de nombres para los elementos de una tupla es el mismo que utiliza Tuple (Item1, Item2, etc.), para las tuplas-valor el lenguaje soporta el uso de nombres alternativos para los campos.

Cuando hablamos de ValueTuple, en realidad nos estamos refiriendo a una familia de ocho estructuras genéricas ValueTuple<T1>, ValueTuple<T1, T2>, ValueTuple<T1, T2, T3>, etc. que se utilizan para trabajar con tuplas-valor de 1, 2, 3, etc. componentes. Para el remoto caso en que se necesite definir tuplas de 8 o más elementos, el “octavo pasajero” en el tipo con ocho parámetros es en realidad otra tupla, lo que nos permitiría extendernos hasta 14 componentes (o más, si se aplicara nuevamente el truco). Por simplicidad, en el código a continuación nos ceñiremos a duplas (o sea, tuplas con dos componentes).  Existe además una versión no genérica de ValueTuple, que ofrece algunos métodos auxiliares de propósito general, y en particular métodos fábrica estáticos Create<T1>, Create<T1, T2>, etc. para la creación de tuplas-valor de los tipos genéricos.

Si se desensamblan los tipos ValueTuple<T1, T2> y ValueTuple utilizando una herramienta adecuada (yo estoy utilizando el Assembly Browser de Visual Studio for Mac, que me ha sorprendido muy favorablemente) se verá algo similar al código a continuación, en el que se muestra prácticamente todo lo que es necesario conocer sobre la implementación interna de las tuplas-valor. Nótese que las tuplas-valor implementan las interfaces de comparación estructural, que hacen posible la comparación y ordenación de entidades de esos tipos basadas en los valores de sus campos.

namespace System
{
    [Serializable]
    [StructLayout (LayoutKind.Auto)]
    public struct ValueTuple<T1, T2> : IValueTupleInternal, ITuple,
        IEquatable<ValueTuple<T1, T2>>, 
        IComparable, IComparable<ValueTuple<T1, T2>>,
        IStructuralEquatable, IStructuralComparable
    {
        // Campos
        public T1 Item1;
        public T2 Item2;
 
        // Constructor
        public ValueTuple (T1 item1, T2 item2) { Item1 = item1; Item2 = item2; }
 
        // Implementación de las interfaces, Equals y GetHashCode
    }

    public struct ValueTuple
    {
        // Fábrica de tuplas de dos elementos
        public static ValueTuple<T1, T2> Create<T1, T2> (T1 item1, T2 item2)
        {
            return new ValueTuple<T1, T2> (item1, item2);
        }

        // ...
    }
}

El código de ejemplo que he preparado para hoy se apoya en la clase Person que hemos venido utilizando anteriormente, y es el siguiente:

01    using System;
02    class MainClass
03    {
04        static Person dh = new Person("Denis"new DateTime(19851227));
05 
06        static void Main()
07        {
08            var d = GetPersonData();
09            // Imprime 'Denis is 31'
10            Console.WriteLine($"{d.Name} is {d.Age}");
11        }
12 
13        static (string Name, int Age) GetPersonData()
14        {
15            int years = Years(dh.BirthDate, DateTime.Now);
16            return (dh.Name, years);
17        }
18 
19        static int Years(DateTime d1, DateTime d2)
20        {
21            return (d2.Year - d1.Year - 1) +
22                (((d2.Month > d1.Month) ||
23                 ((d2.Month == d1.Month) && (d2.Day >= d1.Day))) ? 1 : 0);
24         }
25     }

El siguiente es el código que muestra el desensamblador para dicha clase (solo se presentan las porciones relevantes):

01        private static void Main()
02        {
03            ValueTuple<stringint> d = GetPersonData();
04            Console.WriteLine(string.Format ("{0} is {1}", d.Item1, d.Item2));
05        }
06
07        [return: TupleElementNames (new string[] { "Name", "Age" })]
08        private static ValueTuple<stringint> GetPersonData()
09        {
10            int years = Years(dh.BirthDate, DateTime.Now);
11            return new ValueTuple<stringint>(dh.Name, years);
12        }

Observe cómo el compilador transforma las líneas 08, 10, 13 y 16 del código original en las líneas 03, 04, 08 y 11 del código compilado utilizando los conceptos explicados anteriormente. ¡Azúcar! La única duda que podría quedar es de qué va el atributo generado para el método GetPersonData en la línea 07, pero el propio texto de esa línea y el de la línea 04 seguramente le habrán dado una buena pista. Con ello continuaremos en la próxima entrega, porque ésta ya se ha hecho demasiado larga.


Referencia musical: Celia Cruz fue una excelsa cantante que llevó la música cubana y su amor por Cuba a todos los rincones del planeta y que tuve la gran suerte de conocer personalmente. Su extensa obra ha quedado ampliamente plasmada en múltiples fuentes audiovisuales disponibles. Ahora bien, hace un tiempo que está en Netflix una serie sobre su vida que a mi modo de ver no le hace ninguna justicia: además de incorporar muy pocas de sus canciones (¡y son 80 capítulos!), se basa en un guión verdaderamente atroz que exhuma cursilería, maniqueísmo y frecuentes faltas a la verdad e incorrecciones históricas, entre otros defectos. Yo sólo me la “fumé” por motivos nostálgicos: oír hablar a los personajes interpretados por actores cubanos (especialmente los femeninos, que tanto me recordaban a mi madre). Si usted no se encuentra en mi situación, le recomiendo que se abstenga de verla y aproveche su tiempo de una mejor manera.

Deconstrucción en C# 7.0: cuidado con las sobrecargas!

“… You’re the reason I’m travelin’ on / Don’t think twice, it’s all right”
Bob Dylan, “Don’t think twice, it’s all right” (1963)

En nuestra entrega anterior presentamos la deconstrucción, un nuevo mecanismo que ofrece C# 7.0 para permitir desintegrar un objeto de cualquier tipo en las partes que lo componen, asignando los valores de esas partes a nuevas variables o a variables ya existentes utilizando la sintaxis incorporada al lenguaje para expresar tipos de tuplas-valor:

    var dh = new Person("Denis", new DateTime(1985, 12, 27));
    // ...
    (string name, int year, int month, int day) = dh;  // declaración
    string s;
    int y, m, d;
    (s, y, m, d) = dh;  // asignación
}

El tipo que ofrece la deconstrucción debe suministrar uno o más métodos Deconstruct con los parámetros de salida adecuados. Alternativamente, Deconstruct puede ser un método extensor (extension method), lo que hace posible utilizar el mecanismo para tipos de los cuales no disponemos del código fuente. Para que el código anterior funcione, la clase Person debe haberse definido así:

using System;
namespace ValueTuples
{
    public class Person
    {
        public string Name { get; }
        public DateTime BirthDate { get; }

        public Person(string name, DateTime birthDate)
        {
            Name = name;
            BirthDate = birthDate;
        }

        public void Deconstruct(out string name,
            out int year, out int month, out int day)
        {
            name = Name;
            year = BirthDate.Year; month = BirthDate.Month; day = BirthDate.Day;
        }
    }
}

Cuando empecé a probar esta característica, hasta aquí todo iba de maravilla. Pero entonces pensé que me gustaría poder devolver además del número del día el día de la semana, y claro, envolver toda la información sobre el día en una tupla, para poder hacer algo así:

    // Deconstrucción a varios niveles???
    (string name, _, _, (_, DayOfWeek dayOfWeek)) = dh;
    // Esto imprime: Denis was born a Friday.
    Console.WriteLine($"{name} was born a {dayOfWeek}.");
}

Cuando se me ocurrió hacer esto, probablemente estaría pensando en la unificación recursiva de Prolog (craso error :-)). La sobrecarga de Deconstruct con cuatro parámetros que permitiría una sintaxis como la anterior podría ser ésta:

    public void Deconstruct(out string name,
        out int year, out int month, 
        out (int DayNumber, DayOfWeek DayOfWeek) day)
    {
        name = Name;
        year = BirthDate.Year; month = BirthDate.Month; 
        day = (BirthDate.Day, BirthDate.DayOfWeek);
    }

Si se comenta la primera sobrecarga de Deconstruct y se incorpora ésta, todo funciona de maravilla. Pero si se activan los dos mecanismos simultáneamente, la clase Person compila correctamente (y por qué no), pero el código cliente que intenta utilizar la segunda sobrecarga es rechazado por el compilador:

The call is ambiguous between the following methods and properties:
    Person.Deconstruct(out string, out int, out int, out int) and
    Person.Deconstruct(out string, out int, out int, 
        out (int DayNumber, DayOfWeek DayOfWeek))

En este momento me quedé un poco desilusionado; esperaba que el compilador sería capaz de detectar que el patrón del lado izquierdo de la asignación utiliza una tupla en la cuarta posición, y por lo tanto la segunda sobrecarga es la única aceptable en ese caso. Buscando una respuesta rápida, planteé la pregunta en StackOverflow, y David Arno gentilmente me la respondió; en su propia respuesta me indica que ha enviado una sugerencia al equipo de desarrollo de C# porque piensa que la resolución de sobrecargas durante la deconstrucción no funciona tan finamente como podría.

Problemas como éste me hacen dudar de si las últimas novedades no se estarán añadiendo al lenguaje a un ritmo demasiado apresurado y sin tiempo para pensar dos veces (think twice) y estudiar todos los posibles casos extremos; de hecho, la especificación formal de C# 7.0 todavía se está escribiendo… ¡y ya salió C# 7.1! Pero tales son los tiempos ágiles que corren, y la mejor documentación de las características del lenguaje es, cada vez más, el código fuente de Roslyn en GitHub.

En cualquier caso, me ha quedado claro que es una mala idea dotar a un tipo de dos o más sobrecargas de Deconstruct con la misma cantidad de parámetros. ¡Queda advertido, estimado lector!


Referencia musical: Durante mi adolescencia, la vía casi exclusiva que tenía para escuchar pop y rock norteamericano eran las emisoras comerciales de la Florida, y Bob Dylan nunca fue especialmente popular por esos lares. Así que realmente solo empecé a conocer su obra bien pasados los treinta, gracias a mis queridos amigos de El Puerto de Santa María. “Don’t think twice…” es, sin dudas, uno de sus temas más reconocibles.

Deconstrucción en C# 7.0

En nuestra entrega anterior, dedicada a las tuplas-valor (value tuples) añadidas recientemente a C# 7.0, mencionamos brevemente el mecanismo de deconstrucción (deconstruction), al que dedicaremos aquí algo más de espacio. La deconstrucción es un nuevo mecanismo sintáctico que aprovecha la sintaxis incorporada al lenguaje para representar tipos de tuplas-valor para permitir, de una manera sencilla y conveniente, descomponer un objeto de cualquier tipo en las partes que lo componen, asignando los valores de esas partes a nuevas variables (en cuyo caso estamos en presencia de una declaración de deconstrucción, deconstructing declaration) o a variables ya existentes (asignación de deconstrucción, deconstructing assignment):

    var dh = new Person("Denis"new DateTime(19851227));
    // ...
    (string name, int year, int month, int day) = dh;  // declaración
    string s;
    int y, m, d;
    (s, y, m, d) = dh;  // asignación
}

Como se habrá dado cuenta el lector, en el fondo se trata de simple azúcar sintáctico que evita tener que hacer uso de múltiples asignaciones y/o llamadas con incómodos parámetros out. Para satisfacer al compilador, es necesario que el tipo a descomponer ofrezca un método Deconstruct con los parámetros adecuados (en él es donde precisamente se encapsulan esos parámetros out). Deconstruct puede incluso ser un método extensor (extension method) que esté en ámbito, lo que hace posible utilizar el mecanismo para tipos de los cuales no disponemos del código fuente. Además, se puede implementar varias sobrecargas para ofrecer varias maneras de deconstruir un objeto. Por ejemplo, el código mostrado anteriormente funciona porque las siguientes definiciones están en vigor:

using System;
namespace ValueTuples
{
    public class Person
    {
        public string Name { get; }
        public DateTime BirthDate { get; }

        public Person(string name, DateTime birthDate)
        {
            Name = name;
            BirthDate = birthDate;
        }

        public void Deconstruct(out string name,
            out int year, out int month, out int day)
        {
            name = Name;
            BirthDate.Deconstruct(out year, out month, out day);
        }
    }

    public static class Extensions
    {
        public static void Deconstruct(this DateTime dateTime,
            out int year, out int month, out int day)
        {
            year  = dateTime.Year;
            month = dateTime.Month;
            day   = dateTime.Day;
        }
    }
}

Visto todo lo anterior, solo resta mencionar algunos detalles adicionales:

  • Las tuplas-valor soportan de manera predefinida la deconstrucción en sus componentes originales sin que tengamos que hacer absolutamente nada; veremos más detalles al respecto en una próxima entrega, que ya estaba prometida :-).
  • Los descartes, que ya presentamos hace algún tiempo, pueden ser útiles en caso de que solo estemos interesados en algunos de los elementos resultantes de la deconstrucción, como se muestra en el siguiente ejemplo:
using System;
namespace ValueTuples
{
    class MainClass
    {
        public static void Main(string[] args)
        {
            var dh = new Person("Denis"new DateTime(19851227));
            // ...
            (string name, int year, _, _) = dh;
            Console.WriteLine($"Name: {name}");
            Console.WriteLine($"Year: {year}");
        }
    }
}

Es precisamente esta aplicación conjunta de la deconstrucción y los descartes lo que tanto me recuerda al lenguaje de programación lógica Prolog. Aunque hay que reconocer que, incluso con todas las novedades añadidas a C# 7.0 y 7.1, C# aún se queda bastante corto: la unificación de Prolog es bidireccional, y las variables (y los descartes) pueden situarse a cualquiera de los dos lados del símbolo de unificación (que no asignación); más aún, el mecanismo de unificación de Prolog se basa en un algoritmo de emparejamiento de patrones (pattern matching) mucho más general, y que no depende para su funcionamiento de que se definan de antemano métodos especializados o se restrinjan en modo alguno las estructuras de las tuplas a unificar.


Agradecimientos: Lo poco que sé sobre Programación Lógica y sus aplicaciones lo aprendí de un MAESTRO con mayúsculas, Don Luciano García Garrido, a quien envío desde aquí un afectuoso saludo.

Tuplas-valor en C# 7.0

“… Pero lo nuestro es pasar / Pasar haciendo caminos / Caminos sobre la mar …”
Joan Manuel Serrat, “Cantares” (1969), basada en  un poema de Antonio Machado

La idea de escribir una entrada relacionada con las tuplas-valor (value tuples) añadidas recientemente a C# 7.0 me trajo a la mente el artículo que escribí una vez para la revista dotNetManía con mi maestro y amigo Miguel Katrib cuando aparecieron las tuplas-referencia, aquellas que se sintetizan a través del uso de la clase genérica Tuple<> que fue incorporada a .NET Framework en la versión 4.0. Las nuevas tuplas-valor se introducen casi que con la idea de hacer obsoletas (“todo pasa y todo queda…“) las tuplas-referencia, resolviendo la mayor parte de los inconvenientes que éstas presentan, y algunas ideas en ese sentido ya las proponíamos en aquel lejano artículo (que el lector interesado puede encontrar, gracias a la generosidad de nuestro gran amigo Paco Marín, aquí).

El primer elemento a destacar es que para poder hacer uso de las tuplas-valor es necesario instalar el paquete de NuGet System.ValueTuple, a menos que esté usted desarrollando un proyecto basado en .NET Framework 4.7 o superior, o en .NET Core 2.0 o superior. Como tipo de datos, una diferencia crucial entre ValueTuple y System.Tuple es que el nuevo tipo es una estructura en vez de una clase y sus miembros son campos en vez de propiedades, lo que lo hace en principio más ligero y eficiente con relación a Tuple. Aparte de eso, un somero análisis de los ensamblados correspondientes le convencerá de que ambos tipos utilizan patrones de desarrollo parecidos (incluyendo el truco del “octavo pasajero” al que aludíamos en el artículo antes mencionado) y ofrecen posibilidades similares. Algunas de ellas pueden verse en la parte inicial del ejemplo que se muestra más abajo, aunque también varias diferencias:

  • Si bien por defecto el convenio de nombres para los elementos de una tupla es el mismo (Item1, Item2, etc.), para las tuplas-valor el compilador soporta el uso de nombres alternativos para los campos.
  • Como los elementos de las tuplas-valor son campos públicos, sus valores pueden ser modificados (son mutables).

Pero sin duda alguna lo más útil e interesante en relación con las tuplas-valor es que el compilador de C# las utiliza al transformar el nuevo “azúcar sintáctico” que ahora está soportado en C# 7.0. Dejaré para una próxima entrada un análisis de los “actos de magia” que utiliza el compilador para generar código basado en ValueTuple (que por supuesto no se basa en la herencia, dado que las estructuras no la soportan).

La segunda parte del código a continuación muestra un ejemplo de la que tal vez sea la aplicación más popular para las tuplas-valor: una función que devuelve varios valores. En este caso, el método FibonacciInterval determina simultáneamente el menor número de Fibonacci que es mayor o igual que el valor recibido como parámetro y el siguiente número de la secuencia. Note como se puede también utilizar nombres explícitos para hacer más legible el código que llame a la función:

using System;

namespace ValueTuples
{
    class MainClass
    {
        static void Main(string[] args)
        {
            var t1 = ValueTuple.Create("DH"ValueTuple.Create(27121985));
            var t2 = ("DH", (27121985)); // equivalente "endulzado"
            t1.Item2.Item2 = 10;
            Console.WriteLine(t1.Item2);

            var t3 = (Nombre: "Diana", Nacimiento: (Día: 2, Mes: 4, Año: 1998));
            Console.WriteLine(t3.Nacimiento.Día);

            for (uint i = 0; i < 50; i++)
                Console.WriteLine($"Fibonacci interval for {i} = " +
                    FibonacciInterval(i));
        }

        public static (uint Min, uint Max) FibonacciInterval(uint number)
        {
            (uint min, uint max) = (01);
            while (true)
            {
                if (number < max)
                    return (min, max);
                uint sum = min + max;
                min = max;
                max = sum;
            }
        }
    }
}

Observe también la simpática asignación (uint min, uint max) = (01) al inicio del método. Se trata de un ejemplo de deconstrucción (del inglés deconstruction) o desmontaje de una tupla-valor en sus componentes individuales. Esta característica de deconstrucción (que es más general y puede aplicarse a tipos que no sean tuplas-valor) me recuerda, como ya he dicho antes, al mecanismo de unificación utilizado en el lenguaje Prolog; la abordaré con más detalle en otra futura entrega.


Referencia musical: Tendría yo unos doce años cuando Joan Manuel Serrat fue a cantar a nuestra escuela en las afueras de La Habana, y desde ese entonces lo cuento entre mis favoritos. Adicionalmente, el hecho de que las letras de sus temas más populares de aquellos tiempos estuvieran basadas en poemas de Antonio Machado y Miguel Hernández me incitó a estudiar la vida y obra de esos poetas, sin saber que un día el destino me llevaría a España. ¡Gracias, Maestro!