Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

Resolving Symbolic References in a CodeDOM (Part 7)

, 2 Dec 2012 CDDL
Resolving symbolic references in a CodeDOM.
Nova.0.6.exe.zip
Mono.Cecil.dll
Nova.CLI.exe
Nova.CodeDOM.dll
Nova.Examples.exe
Nova.Studio.exe
Nova.Test.exe
Nova.UI.dll
Nova.0.6.zip
Nova.CLI
Properties
Nova.CodeDOM
CodeDOM
Annotations
Base
Comments
Base
DocComments
CodeRef
Base
List
Name
Base
Other
Simple
CompilerDirectives
Base
Conditionals
Base
Messages
Base
Pragmas
Base
Symbols
Base
Base
Interfaces
Expressions
AnonymousMethods
Base
Operators
Base
Binary
Arithmetic
Base
Assignment
Base
Bitwise
Base
Conditional
Relational
Base
Shift
Base
Other
Base
Unary
Base
Other
References
Base
GotoTargets
Base
Methods
Namespaces
Other
Properties
Types
Base
Variables
Base
Projects
Assemblies
Namespaces
References
Base
Statements
Base
Conditionals
Base
Exceptions
Generics
Constraints
Base
Iterators
Base
Jumps
Loops
Methods
OperatorDecls
Miscellaneous
Namespaces
Properties
Base
Events
Types
Base
Variables
Base
Parsing
Base
Properties
Rendering
Resolving
Utilities
Mono.Cecil
Reflection
Nova.Examples
Properties
Nova.Studio
Images
About.png
Configuration.png
EditCopy.png
EditCut.png
EditDelete.png
EditPaste.png
EditRedo.png
EditUndo.png
Error.png
Exit.png
FileNew.png
FileOpen.png
FileSave.png
FileSaveAll.png
FileSaveAs.png
Find.png
Help.png
Info.png
Logo.png
Options.png
Print.png
PrintPreview.png
Properties.png
Todo.png
Warning.png
Objects.ico
Properties
Settings.settings
Nova.Test
Properties
Nova.UI
CodeDOM
Annotations
Base
Comments
Base
DocComments
CodeRef
Base
List
Name
Base
Other
Simple
CompilerDirectives
Base
Conditionals
Base
Messages
Base
Pragmas
Base
Symbols
Base
Base
Expressions
AnonymousMethods
Base
Operators
Base
Binary
Arithmetic
Base
Assignment
Base
Bitwise
Base
Conditional
Relational
Base
Shift
Base
Other
Base
Unary
Base
Other
References
Base
GotoTargets
Base
Methods
Namespaces
Other
Properties
Types
Base
Variables
Base
Projects
Namespaces
References
Base
Statements
Base
Conditionals
Base
Exceptions
Generics
Constraints
Base
Iterators
Base
Jumps
Loops
Methods
OperatorDecls
Miscellaneous
Namespaces
Properties
Base
Events
Types
Base
Variables
Base
Properties
Resolving
Utilties
// The Nova Project by Ken Beckett.
// Copyright (C) 2007-2012 Inevitable Software, all rights reserved.
// Released under the Common Development and Distribution License, CDDL-1.0: http://opensource.org/licenses/cddl1.php

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Threading;
using System.Windows;
using System.Windows.Threading;

namespace Nova.Utilities
{
    /// <summary>
    /// This is a version of the <see cref="ObservableCollection{T}"/> class that does invokes if necessary 
    /// so that any changes by a background thread are synchronously marshalled to the main UI thread in order
    /// to avoid various threading issues.
    /// </summary>
    public class ObservableCollectionMT<T> : IList<T>, ICollection, INotifyCollectionChanged
    {
        protected IList<T> _collection = new List<T>();
        protected readonly Dispatcher _dispatcher;
        protected ReaderWriterLockSlim _readerWriterLock = new ReaderWriterLockSlim();

        public event NotifyCollectionChangedEventHandler CollectionChanged;

        /// <summary>
        /// Create a new instance, making certain that it's created on the UI thread.
        /// </summary>
        /// <param name="_collection">An existing _collection to be copied into the new one.</param>
        /// <returns>The new <see cref="ObservableCollectionMT{T}"/>.</returns>
        public static ObservableCollectionMT<T> Create(IEnumerable _collection)
        {
            Dispatcher _dispatcher = (Application.Current != null ? Application.Current.Dispatcher : Dispatcher.CurrentDispatcher);
            if (_dispatcher == null || _dispatcher.CheckAccess())
                return new ObservableCollectionMT<T>(_collection);
            return (ObservableCollectionMT<T>)_dispatcher.Invoke(DispatcherPriority.Send, new Func<ObservableCollectionMT<T>>(delegate { return new ObservableCollectionMT<T>(_collection); }));
        }

        /// <summary>
        /// Create a new instance, making certain that it's created on the UI thread.
        /// </summary>
        /// <returns>The new <see cref="ObservableCollectionMT{T}"/>.</returns>
        public static ObservableCollectionMT<T> Create()
        {
            return Create((IEnumerable)null);
        }

        /// <summary>
        /// Create a new instance, as a thread-safe UI-bindable wrapper around the specified <see cref="ObservableCollection{T}"/>.
        /// </summary>
        /// <param name="_collection">The existing <see cref="ObservableCollection{T}"/> to be wrapped.</param>
        /// <returns>The new <see cref="ObservableCollectionMT{T}"/>.</returns>
        public static ObservableCollectionMT<T> Create(ObservableCollection<T> _collection)
        {
            Dispatcher _dispatcher = (Application.Current != null ? Application.Current.Dispatcher : Dispatcher.CurrentDispatcher);
            if (_dispatcher == null || _dispatcher.CheckAccess())
                return new ObservableCollectionMT<T>(_collection);
            return (ObservableCollectionMT<T>)_dispatcher.Invoke(DispatcherPriority.Send, new Func<ObservableCollectionMT<T>>(delegate { return new ObservableCollectionMT<T>(_collection); }));
        }

        /// <summary>
        /// Create a new instance - this method is protected for internal use, to force the use of <see cref="Create(IEnumerable)"/> instead.
        /// </summary>
        protected ObservableCollectionMT(IEnumerable _collection)
        {
            _dispatcher = (Application.Current != null ? Application.Current.Dispatcher : null);
            if (_collection != null)
            {
                foreach (T item in _collection)
                    Add(item);
            }
        }

        /// <summary>
        /// Create a new instance - this method is protected for internal use, to force the use of <see cref="Create(IEnumerable)"/> instead.
        /// </summary>
        protected ObservableCollectionMT()
            : this(null)
        { }

        /// <summary>
        /// Create a new wrapper instance - this method is protected for internal use, to force the use of <see cref="Create(ObservableCollection{T})"/> instead.
        /// </summary>
        protected ObservableCollectionMT(ObservableCollection<T> _collection)
        {
            _dispatcher = (Application.Current != null ? Application.Current.Dispatcher : null);
            _collection.CollectionChanged += WrappedCollection_Changed;
        }

        /// <summary>
        /// Handle any items added or removed from the wrapped <see cref="ObservableCollection{T}"/> _collection.
        /// </summary>
        protected void WrappedCollection_Changed(object obj, NotifyCollectionChangedEventArgs args)
        {
            switch (args.Action)
            {
                case NotifyCollectionChangedAction.Add:
                    foreach (object item in args.NewItems)
                        Add((T)item);
                    break;
                case NotifyCollectionChangedAction.Remove:
                    foreach (object item in args.OldItems)
                        Remove((T)item);
                    break;
            }
        }

        public void Add(T item)
        {
            if (_dispatcher.CheckAccess())
                AddInternal(item);
            else
                _dispatcher.BeginInvoke((Action)(delegate { AddInternal(item); }));
        }

        private void AddInternal(T item)
        {
            _readerWriterLock.EnterWriteLock();
            _collection.Add(item);
            if (CollectionChanged != null)
                CollectionChanged(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Add, item));
            _readerWriterLock.ExitWriteLock();
        }

        public void Clear()
        {
            if (_dispatcher.CheckAccess())
                ClearInternal();
            else
                _dispatcher.BeginInvoke((Action)(ClearInternal));
        }

        private void ClearInternal()
        {
            _readerWriterLock.EnterWriteLock();
            _collection.Clear();
            if (CollectionChanged != null)
                CollectionChanged(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Reset));
            _readerWriterLock.ExitWriteLock();
        }

        public bool Contains(T item)
        {
            _readerWriterLock.EnterReadLock();
            bool result = _collection.Contains(item);
            _readerWriterLock.ExitReadLock();
            return result;
        }

        public void CopyTo(T[] array, int index)
        {
            _readerWriterLock.EnterReadLock();
            _collection.CopyTo(array, index);
            _readerWriterLock.ExitReadLock();
        }

        public void CopyTo(Array array, int index)
        {
            _readerWriterLock.EnterReadLock();
            ((ICollection)_collection).CopyTo(array, index);
            _readerWriterLock.ExitReadLock();
        }

        public int Count
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                int count = _collection.Count;
                _readerWriterLock.ExitReadLock();
                return count;
            }
        }

        public bool IsSynchronized
        {
            get { return true; }
        }

        public object SyncRoot
        {
            get { return _readerWriterLock; }
        }

        public bool IsReadOnly
        {
            get { return _collection.IsReadOnly; }
        }

        public bool Remove(T item)
        {
            if (_dispatcher.CheckAccess())
                return RemoveInternal(item);
            DispatcherOperation operation = _dispatcher.BeginInvoke(new Func<T, bool>(RemoveInternal), item);
            return (operation.Result != null && (bool)operation.Result);
        }

        private bool RemoveInternal(T item)
        {
            bool successful = false;
            _readerWriterLock.EnterWriteLock();
            int index = _collection.IndexOf(item);
            if (index >= 0)
            {
                successful = _collection.Remove(item);
                if (successful && CollectionChanged != null)
                    CollectionChanged(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Remove, item, index));
            }
            _readerWriterLock.ExitWriteLock();
            return successful;
        }

        public IEnumerator<T> GetEnumerator()
        {
            return _collection.GetEnumerator();
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return _collection.GetEnumerator();
        }

        public int IndexOf(T item)
        {
            _readerWriterLock.EnterReadLock();
            int index = _collection.IndexOf(item);
            _readerWriterLock.ExitReadLock();
            return index;
        }

        public void Insert(int index, T item)
        {
            if (_dispatcher.CheckAccess())
                InsertInternal(index, item);
            else
                _dispatcher.BeginInvoke((Action)(delegate { InsertInternal(index, item); }));
        }

        private void InsertInternal(int index, T item)
        {
            _readerWriterLock.EnterWriteLock();
            _collection.Insert(index, item);
            if (CollectionChanged != null)
                CollectionChanged(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Add, item, index));
            _readerWriterLock.ExitWriteLock();
        }

        public void RemoveAt(int index)
        {
            if (_dispatcher.CheckAccess())
                RemoveAtInternal(index);
            else
                _dispatcher.BeginInvoke((Action)(delegate { RemoveAtInternal(index); }));
        }

        private void RemoveAtInternal(int index)
        {
            _readerWriterLock.EnterWriteLock();
            if (index < _collection.Count)
            {
                _collection.RemoveAt(index);
                if (CollectionChanged != null)
                    CollectionChanged(this, new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Remove, null, index));
            }
            _readerWriterLock.ExitWriteLock();
        }

        public T this[int index]
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                T result = _collection[index];
                _readerWriterLock.ExitReadLock();
                return result;
            }
            set
            {
                _readerWriterLock.EnterWriteLock();
                if (index < _collection.Count)
                    _collection[index] = value;
                _readerWriterLock.ExitWriteLock();
            }
        }

        protected void ExecuteOrBeginInvoke(Action action)
        {
            if (_dispatcher == null || _dispatcher.CheckAccess())
                action();
            else
                _dispatcher.Invoke(action);
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Common Development and Distribution License (CDDL)

Share

About the Author

KenBeckett
Software Developer (Senior)
United States United States
I've been writing software since the late 70's, currently focusing mainly on C#.NET. I also like to travel around the world, and I own a Chocolate Factory (sadly, none of my employees are oompa loompas).

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150129.1 | Last Updated 2 Dec 2012
Article Copyright 2012 by KenBeckett
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid