Changeset 19406 for lang/csharp

Timestamp:

09/17/08 01:02:16 (2 months ago)

Author:

topia

Message:

fix Signature of ITunesApp.ConvertTracks?.
* Add more XML documentation comments.
* split ITunesApp interface as IITunesApp.
* This is ABI breakage, bump major version.

Location:

lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap

Files:

• Application.cs (modified) (8 diffs)
• Enums.cs (modified) (2 diffs)
• Interfaces/IApplication.cs (added)
• Sources.cs (modified) (2 diffs)
• Utils.cs (modified) (2 diffs)
• iTunesCOMWrap.csproj (modified) (1 diff)

lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap/Application.cs

@@ -12 +12 @@
 namespace Clovery.iTunesHelper.COMWrap
 {
-    public class ITunesApp : IITFactory
+    /// <summary>
+    /// iTunes Application Main Class
+    /// </summary>
+    public class ITunesApp : IITunesApp
     {
         private readonly IITunesWrappedObjectFactory _objectFactory;
         protected internal object _internal;
-        public IIndexedCollection<IPlaylist, bool> CanSetShuffle = new CanSetShufflePlaylistCollection();
-        public IIndexedCollection<IPlaylist, bool> CanSetSongRepeat = new CanSetSongRepeatPlaylistCollection();
+        private readonly IIndexedCollection<IPlaylist, bool> _canSetShuffle = new PlaylistCanSetShuffleCollection();
+        private readonly IIndexedCollection<IPlaylist, bool> _canSetSongRepeat = new PlaylistCanSetSongRepeatCollection();
 
         internal ITunesApp(iTunes.iTunesApp _internal, bool useCache)
@@ -38 +41 @@
         }
 
+        /// <summary>
+        /// construct iTunesApp.
+        /// </summary>
+        /// <param name="useCache">cache iTunes Object if true, otherwise not.</param>
         public ITunesApp(bool useCache)
             : this(new iTunes.iTunesAppClass(), useCache)
@@ -43 +50 @@
         }
 
+        /// <summary>
+        /// construct iTunesApp with default options.
+        /// </summary>
+        /// <remarks>Cache is disabled.</remarks>
         public ITunesApp() : this(false)
         {
@@ -273 +284 @@
         {
             get { return this._objectFactory; }
+        }
+
+        public IIndexedCollection<IPlaylist, bool> CanSetShuffle
+        {
+            get { return this._canSetShuffle; }
+        }
+
+        public IIndexedCollection<IPlaylist, bool> CanSetSongRepeat
+        {
+            get { return this._canSetSongRepeat; }
         }
 
@@ -363 +384 @@
         }
 
-        static private object _convertToITObjects(IITInternalObject track)
-        {
-            return track.__internalObject;
-        }
-
         public event EventHandler<DatabaseChangedEventArgs> DatabaseChangedEvent;
         public event EventHandler<TrackEventArgs> PlayerPlayEvent;
@@ -447 +463 @@
         public IConvertOperationStatusWithEvents ConvertTrack(ITrack iTrackToConvert)
         {
-            object real = _convertToITObjects(iTrackToConvert);
+            object real = Utils.ConvertObjectToITObject(iTrackToConvert);
             return this.factory.CreateConvertOperationStatus(this._asIiTunes.ConvertTrack2(ref real));
         }
 
-        public IConvertOperationStatusWithEvents ConvertTracks(ITrack[] iTracksToConvert)
-        {
-            object real =
-                iTracksToConvert.ToList().ConvertAll(
-                    new Converter<ITrack, object>(_convertToITObjects)).ToArray();
+        public IConvertOperationStatusWithEvents ConvertTracks(ITrackCollection iTracksToConvert)
+        {
+            object real = Utils.ConvertObjectToITObject(iTracksToConvert);
             return this.factory.CreateConvertOperationStatus(this._asIiTunes.ConvertTracks2(ref real));
         }
@@ -557 +571 @@
     namespace Internal
     {
-        internal class CanSetShufflePlaylistCollection : IIndexedCollection<IPlaylist, bool>
+        internal class PlaylistCanSetShuffleCollection : IIndexedCollection<IPlaylist, bool>
         {
             public bool this[IPlaylist Playlist]
@@ -565 +579 @@
         }
 
-        internal class CanSetSongRepeatPlaylistCollection : IIndexedCollection<IPlaylist, bool>
+        internal class PlaylistCanSetSongRepeatCollection : IIndexedCollection<IPlaylist, bool>
         {
             public bool this[IPlaylist Playlist]

lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap/Enums.cs

@@ -527 +527 @@
     /// <summary>
     /// currently supported minimum iTunes type library version
+    /// </summary>
+    /// <remarks>
     /// <list type="table">
     ///     <listheader>
@@ -545 +547 @@
     ///     <item><term>1.11</term><description>iTunes 7.7</description></item>
     /// </list>
-    /// </summary>
+    /// </remarks>
     public enum SupportedVersion
     {

lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap/Sources.cs

@@ -61 +61 @@
             IPlaylist playlist = this.Children[playlistName];
             if (playlist != null)
-            {
                 return playlist;
-            }
             return this.CreatePlaylist(playlistName);
         }
@@ -71 +69 @@
             IPlaylist playlist = this.Children[folderName];
             if (playlist != null)
-            {
                 return playlist;
-            }
             return this.CreateFolder(folderName);
         }

lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap/Utils.cs

@@ -1 +1 @@
 // $Id$
+
+using Clovery.iTunesHelper.COMWrap.Interfaces;
 
 namespace Clovery.iTunesHelper.COMWrap.Internal
@@ -17 +19 @@
             return (long) high << 32 | (uint) low;
         }
+
+        protected internal static object ConvertObjectToITObject(IITInternalObject obj)
+        {
+            return obj.__internalObject;
+        }
     }
 }

lang/csharp/iTunesCOMWrap/trunk/iTunesCOMWrap/iTunesCOMWrap.csproj

@@ -54 +54 @@
     <Compile Include="Enums.cs" />
     <Compile Include="EQPresets.cs" />
+    <Compile Include="Interfaces\IApplication.cs" />
     <Compile Include="Interfaces\IEQPresets.cs" />
     <Compile Include="Interfaces\IEncoders.cs" />