Ref (Clases y structs) (C++/CX)

  • Artículo

C++/CX admite clases ref y structs ref definidos por el usuario, y clases de valor y structs de valor definidos por el usuario. Estas estructuras de datos son los contenedores primarios por los que C++/CX admite el sistema de tipos de Windows Runtime. Su contenido se emite para metadatos de acuerdo con determinadas reglas concretas y esto permite que se pase entre los componente de Windows Runtime y aplicaciones de la Plataforma universal de Windows escritas en C++ u otros lenguajes.

Una clase ref o un struct ref tienen estas características esenciales:

  • Debe declararse dentro de un espacio de nombres, en el ámbito de espacio de nombres, y en ese espacio de nombres puede tener accesibilidad pública o privada. Únicamente los tipos públicos se emiten para metadatos. No se permiten definiciones de clase pública anidada, incluidas las clases de enumeración públicas anidadas. Para obtener más información, consulte Espacios de nombres y visibilidad de tipos.

  • Puede contener como miembros C++/CX incluidas clases de referencia, clases de valor, estructuras de referencia, estructuras de valor o estructuras de valores NULL. También puede contener tipos escalares como float64, bool, etc. También puede contener tipos de C++ estándar como std::vector o una clase personalizada, mientras no sean públicos. Las construcciones de C++/CX pueden tener accesibilidad public, protected, internal, private o protected private. Todos los miembros public o protected se emiten para metadatos. Los tipos de C++ estándar deben tener accesibilidad private, internalo protected private , lo que evita que se emitan para metadatos.

  • Puede implementar una o más clases de interfaz o structs de interfaz.

  • Puede heredar de una clase base, y las propias clases base tienen restricciones adicionales. La herencia en jerarquías de clases ref públicas tienen más restricciones que la herencia en clases ref privadas.

  • Puede no declararse como genérica. Si posee accesibilidad privada, puede ser una plantilla.

  • Su vigencia la administra el recuento de referencias automático.

Declaración

El fragmento de código siguiente declara la clase ref Person . Observe que el tipo std::map de Standard C++ se usa en los miembros privados y la interfaz IMapView de Windows Runtime se usa en la interfaz pública. Observe también que el operador “^” se anexa a las declaraciones de tipos de referencia.

// #include <map>
namespace WFC = Windows::Foundation::Collections;
namespace WFM = Windows::Foundation::Metadata;

[WFM::WebHostHidden]
ref class Person sealed
{
public:
    Person(Platform::String^ name);
    void AddPhoneNumber(Platform::String^ type, Platform::String^ number);
    property WFC::IMapView<Platform::String^, Platform::String^>^ PhoneNumbers
    { 
        WFC::IMapView<Platform::String^, Platform::String^>^ get();
    }
private:
    Platform::String^ m_name;
    std::map<Platform::String^, Platform::String^> m_numbers;
};

Implementación

En este ejemplo de código se muestra una implementación de la clase ref Person .

#include <collection.h>
using namespace Windows::Foundation::Collections;
using namespace Platform;
using namespace Platform::Collections;

Person::Person(String^ name): m_name(name) { }
void Person::AddPhoneNumber(String^ type, String^ number)
{
    m_numbers[type] = number;
}
IMapView< String^, String^>^ Person::PhoneNumbers::get()
{
    // Simple implementation. 
    return ref new MapView< String^, String^>(m_numbers);
}

Uso

En el ejemplo de código siguiente se muestra cómo el código de cliente utiliza la clase ref Person .

using namespace Platform;

Person^ p = ref new Person("Clark Kent");
p->AddPhoneNumber("Home", "425-555-4567");
p->AddPhoneNumber("Work", "206-555-9999");
String^ workphone = p->PhoneNumbers->Lookup("Work");

También puedes usar semántica de pila para declarar una variable de clase ref local. Este tipo de objeto se comporta como una variable basada en la pila aunque la memoria todavía se asigna dinámicamente. Una diferencia importante es que no puedes asignar una referencia de seguimiento (%) a una variable que se declare utilizando semántica de pila; esto garantiza que el recuento de referencias se reduzca a cero cuando finalice la función. En este ejemplo se muestra una clase ref básica Uriy una función que la utiliza con semántica de pila:

void DoSomething()
{
    Windows::Foundation::Uri docs("http://docs.microsoft.com");
    Windows::Foundation::Uri^ devCenter = docs.CombineUri("/windows/");
    // ... 
} // both variables cleaned up here.

Administración de memoria

Puedes asignar una clase ref en memoria dinámica mediante la palabra clave ref new .

MyRefClass^ myClass = ref new MyRefClass();

El operador de tipo manipulador a objeto ^ se conoce como sombrero y es fundamentalmente un puntero inteligente de C++. La memoria a la que apunta se destruye automáticamente cuando el último "hat" sale del ámbito o se establece explícitamente en nullptr.

Por definición, una clase ref tiene semántica de referencia. Al asignar una variable de clase ref, se copia el identificador y no el propio objeto. En el ejemplo siguiente, después de la asignación, tanto myClass como myClass2 apuntan a la misma ubicación de memoria.

MyRefClass^ myClass = ref new MyRefClass();
MyRefClass^ myClass2 = myClass;

Cuando se crea una instancia de una clase ref de C++/CX , su memoria se inicializa a cero antes de que se llame a su constructor; por tanto, no es necesario inicializar a cero miembros individuales, incluidas las propiedades. Si la clase de C++/CX deriva de una clase de Biblioteca C++ de Windows en tiempo de ejecución (WRL), solo se inicializa a cero la parte de la clase derivada de C++/CX.

Miembros

Una clase ref puede contener miembros de función public, protectedy private ; solo los miembros public y protected se emiten en metadatos. Las clases anidadas y las clases ref se permiten pero no pueden ser public. Los campos públicos no se permiten; los miembros de datos públicos deben declararse como propiedades. Los miembros de datos internos privados o protegidos pueden ser campos. De forma predeterminada, en una clase ref la accesibilidad de todos los miembros es private.

Un struct ref es lo mismo que una clase ref, salvo que, de forma predeterminada, sus miembros tienen accesibilidad public .

Una clase ref o estructura ref public se emiten en metadatos, pero para que otras aplicaciones de la Plataforma universal de Windows y otros componentes de Windows Runtime puedan usarlos deben tener al menos un constructor público o protegido. Una clase ref pública que tenga un constructor público también se debe declarar como sealed para evitar la derivación adicional mediante la interfaz binaria de aplicación (ABI).

Los miembros públicos no pueden declararse como const porque el sistema de tipos de Windows Runtime no admite tipos const. Puedes utilizar una propiedad estática para declarar un miembro de datos público con un valor constante.

Cuando defines una clase ref pública o un struct ref público, el compilador aplica los atributos necesarios a la clase y almacena la información en el archivo .winmd de la aplicación. Sin embargo, cuando se define una clase ref pública no sellada, se tiene que aplicar manualmente el atributo Windows::Foundation::Metadata::WebHostHidden para asegurarse de que la clase no esté visible para las aplicaciones de la Plataforma universal de Windows escritas en JavaScript.

Una clase ref puede tener tipos de C++ estándar, incluidos los tipos const , en cualquier miembro private, internalo protected private .

Las clases ref públicas que tienen parámetros de tipo no se permiten. No se permiten clases ref genéricas definidas por el usuario. Una clase ref privada, interna o privada protegida puede ser una plantilla.

Destructores

En C++/CX, la llamada a delete en un destructor público invoca el destructor cualquiera que sea el recuento de referencias del objeto. Este comportamiento permite definir un destructor que realiza la limpieza personalizada de recursos no RAII de una manera determinista. Sin embargo, incluso en este caso, el propio objeto no se elimina de la memoria. La memoria del objeto solo se libera cuando el recuento de referencias llega a cero.

Si el destructor de una clase no es público, solo se invoca cuando el recuento de referencias llega a cero. Si se llama a delete en un objeto que tiene un destructor privado, el compilador genera una advertencia C4493, que indica que "la expresión eliminar no tiene efecto porque el destructor de <nombre de tipo> no tiene accesibilidad 'pública'".

Los destructores de clase ref solo pueden declararse del siguiente modo:

  • público y virtual (se permite en tipos sellados o no sellados)

  • privado protegido y no virtual (solo se permite en tipos no sellados)

  • privado y no virtual (solo se permite en tipos sellados)

No se permite ninguna otra combinación de accesibilidad, virtualidad y capacidad de sellado. Si no declaras explícitamente un destructor, el compilador genera un destructor virtual público si la clase base o cualquier miembro del tipo tienen un destructor público. De lo contrario, el compilador genera un destructor no virtual privado protegido para los tipos no sellados o un destructor no virtual privado para los tipos sellados.

El comportamiento no está definido (undefined) si intentas tener acceso a los miembros de una clase en que ya se haya ejecutado su destructor; lo más probable es que el programa se bloquee. La llamada a delete t en un tipo que no tenga un destructor público no tiene ningún efecto. La llamada a delete this en un tipo o una clase base que tenga un destructor private o protected private conocido desde su jerarquía de tipos tampoco tiene ningún efecto.

Al declarar un destructor público, el compilador genera el código para que la clase ref implemente Platform::IDisposable y el destructor implemente el método Dispose . Platform::IDisposable es la proyección de C++/CX de Windows::Foundation::IClosable. Nunca debes implementar explícitamente estas interfaces.

Herencia

Platform::Object es la clase base universal para todas las clases ref. Todas las clases ref se pueden convertir implícitamente en Platform::Object y pueden invalidar Object::ToString. Sin embargo, el modelo de herencia de Windows Runtime no está diseñado como modelo de herencia general; en C++/CX esto significa que una clase ref pública definida por el usuario no puede actuar como clase base.

Si vas a crear un control de usuario de XAML y el objeto participa en el sistema de propiedades de dependencia, puedes usar Windows::UI::Xaml::DependencyObject como clase base.

Después de que hayas definido una clase no sellada MyBase que herede de DependencyObject, otras clases ref públicas o privadas de tu componente o aplicación pueden heredar de MyBase. La herencia de clases ref públicas solo debe realizarse para admitir reemplazos de métodos virtuales, identidad polimórfica y encapsulación.

No es necesario que una clase ref base privada derive de una clase no sellada existente. Si necesitas una jerarquía de objetos para modelar tu propia estructura de programa o para habilitar la reutilización de código, utiliza clases ref privadas o internas, o todavía mejor, clases de C++ estándar. Puedes exponer la funcionalidad de la jerarquía de objetos privados a través de un contenedor de clases ref públicas o privadas.

Una clase ref que tenga un constructor público o protegido en C++/CX se debe declarar como sellada. Esta restricción significa que no hay ningún medio para que las clases que se escriben en otros lenguajes como C# o Visual Basic hereden de los tipos que se declaren en un componente de Windows Runtime escrito en C++/CX.

Estas son las reglas básicas para la herencia en C++/CX:

  • Las clases ref pueden heredar directamente de a lo sumo una clase ref base, pero pueden implementar cualquier número de interfaces.

  • Si una clase tiene un constructor público, se debe declarar como sellada para evitar la derivación adicional.

  • Puedes crear clases base no selladas públicas que tengan constructores privados protegidos o internos, siempre que la clase base derive directa o indirectamente de una clase base no sellada existente como Windows::UI::Xaml::DependencyObject. La herencia de las clases ref definidas por el usuario a través de archivos .winmd no se admite; sin embargo, una clase ref puede heredar de una interfaz que esté definida en otro archivo .winmd. Se pueden crear clases derivadas a partir de una clase base ref definida por el usuario solo en el mismo componente de Windows Runtime o en la aplicación de la Plataforma universal de Windows.

  • Para las clases ref solo se admite la herencia pública.

    ref class C{};
public ref class D : private C //Error C3628
{};

En el ejemplo siguiente se muestra cómo exponer una clase ref pública que derive de otras clases ref en una jerarquía de herencia.

namespace InheritanceTest2 
{
    namespace WFM = Windows::Foundation::Metadata;

    // Base class. No public constructor.
    [WFM::WebHostHidden]
    public ref class Base : Windows::UI::Xaml::DependencyObject
    {
    internal:
        Base(){}
    protected:
        virtual void DoSomething (){}
        property Windows::UI::Xaml::DependencyProperty^ WidthProperty;
    };

    // Class intended for use by client code across ABI.
    // Declared as sealed with public constructor.
    public ref class MyPublicClass sealed : Base
    {
    public:
        MyPublicClass(){}
        //...
    };
}

Consulte también

Sistema de tipos
Clases y structs de valor
Referencia del lenguaje C++/CX
Referencia de espacios de nombres