CODEWITHSUNDEEP
c#generics
zfedoran
zfedoran

Reputation: 3046

What does the following C# code do?

I ran across the following class in a C# XNA graphics api and I am not sure what it does or that it needs to be so obscure. (T is constrained to be a struct in a parent class)

    static class Ident
    {
        static object sync = new object();
        static volatile int index = 0;
        static int Index
        {
            get
            {
                lock (sync)
                    return index++;
            }
        }
        class Type<T>
        {
            public static int id = Index;
        }
        public static int TypeIndex<T>()
        {
            return Type<T>.id;
        }
    }

The API makes only on call to this static class: int index = Ident.TypeIndex<T>();

Upvotes: 4

Views: 250

Answers (3)

Reed Copsey
Reed Copsey

Reputation: 564413

This creates a unique integer identifier for each Type, based on the order that it's accessed, in a thread-safe manner.

For example, if you do:

int myClassId = Ident.TypeIndex<MyClass>();
int mySecondClssId = Ident.TypeIndex<MySecondClass>();

You'll get 2 "TypeIndex" numbers (with mySecondClassId being at least 1 more than myClassId, but potentially greater, due to threading). Later, if you call this again with the same class, it will return the same TypeIndex for that class.

For example, if I run this, using:

Console.WriteLine(Ident.TypeIndex<Program>());
Console.WriteLine(Ident.TypeIndex<Test>());
Console.WriteLine(Ident.TypeIndex<Program>());
Console.WriteLine(Ident.TypeIndex<Test>());

It will print:

0
1
0
1

However, this could be done more effectively using Interlocked.Increment, which would avoid the need for the lock and the synchronization object completely. The following gives exactly the same answer, with no locking required:

static class Ident
{
    static int index = -1;
    static int Index
    {
        get
        {

            return Interlocked.Increment(ref index);
        }
    }
    private static class Type<T>
    {
        public static int id = Index;
    }

    public static int TypeIndex<T>()
    {
        return Type<T>.id;
    }
}

Upvotes: 8

Diadistis
Diadistis

Reputation: 12174

It assigns an application-wide (static) and thread-safe(locking sync object + volatile index) unique identifier for each different type T.

example :

Console.WriteLine(Ident.TypeIndex<int>()); // 0
Console.WriteLine(Ident.TypeIndex<string>()); // 1
Console.WriteLine(Ident.TypeIndex<long>()); // 2
Console.WriteLine(Ident.TypeIndex<int>()); // 0

Volatile is being used to ensure that the current thread doesn't cache the index value and locking prevents more than one thread to access it.

Upvotes: 8

Jonathan Allen
Jonathan Allen

Reputation: 70307

It returns the number of times Ident.TypeIndex was called, probably to assign a unique number to each object.

Because of the way they are using generics, there should be a different sequence of numbers for every type T. So you could have a #1 circle, a #2 circle, and a #1 square.

Upvotes: 2

Related Questions