nunit24/ClientUtilities/util/Services/RecentFilesService.cs

   1 // ****************************************************************
   2 // Copyright 2007, Charlie Poole
   3 // This is free software licensed under the NUnit license. You may
   4 // obtain a copy of the license at http://nunit.org/?p=license&r=2.4
   5 // ****************************************************************
   6
   7 using System;
   8
   9 namespace NUnit.Util
  10 {
  11         /// <summary>
  12         /// Summary description for RecentFilesService.
  13         /// </summary>
  14         public class RecentFilesService : RecentFiles, NUnit.Core.IService
  15         {
  16                 private RecentFilesCollection fileEntries = new RecentFilesCollection();
  17
  18                 private ISettings settings;
  19
  20                 public static readonly int MinSize = 1;
  21
  22                 public static readonly int MaxSize = 24;
  23
  24                 public static readonly int DefaultSize = 5;
  25
  26                 #region Constructor
  27                 public RecentFilesService()
  28                         : this( Services.UserSettings ) { }
  29
  30                 public RecentFilesService( ISettings settings )
  31                 {
  32                         this.settings = settings;
  33                 }
  34                 #endregion
  35
  36                 #region Properties
  37                 public int Count
  38                 {
  39                         get { return fileEntries.Count; }
  40                 }
  41
  42                 public int MaxFiles
  43                 {
  44                         get
  45                         {
  46                                 int size = settings.GetSetting( "RecentProjects.MaxFiles", DefaultSize );
  47
  48                                 if ( size < MinSize ) size = MinSize;
  49                                 if ( size > MaxSize ) size = MaxSize;
  50
  51                                 return size;
  52                         }
  53                         set
  54                         {
  55                                 int oldSize = MaxFiles;
  56                                 int newSize = value;
  57
  58                                 if ( newSize < MinSize ) newSize = MinSize;
  59                                 if ( newSize > MaxSize ) newSize = MaxSize;
  60
  61                                 settings.SaveSetting( "RecentProjects.MaxFiles", newSize );
  62                                 if ( newSize < oldSize ) SaveEntriesToSettings( this. settings );
  63                         }
  64                 }
  65                 #endregion
  66
  67                 #region Public Methods
  68                 public RecentFilesCollection Entries
  69                 {
  70                         get
  71                         {
  72                                 return fileEntries;
  73                         }
  74                 }
  75
  76                 public void Remove( string fileName )
  77                 {
  78                         fileEntries.Remove( fileName );
  79                 }
  80
  81                 public void SetMostRecent( string fileName )
  82                 {
  83                         SetMostRecent( new RecentFileEntry( fileName ) );
  84                 }
  85
  86                 public void SetMostRecent( RecentFileEntry entry )
  87                 {
  88                         int index = fileEntries.IndexOf(entry.Path);
  89
  90                         if(index != -1)
  91                                 fileEntries.RemoveAt(index);
  92
  93                         fileEntries.Insert( 0, entry );
  94                         if( fileEntries.Count > MaxFiles )
  95                                 fileEntries.RemoveAt( MaxFiles );
  96                 }
  97                 #endregion
  98
  99                 #region Helper Methods for saving and restoring the settings
 100                 private void LoadEntriesFromSettings( ISettings settings )
 101                 {
 102                         fileEntries.Clear();
 103
 104                         string prefix = Environment.Version.Major >= 2
 105                                 ? "RecentProjects.V2"
 106                                 : "RecentProjects.V1";
 107
 108                         for ( int index = 1; index <= MaxFiles; index++ )
 109                         {
 110                                 string fileSpec = settings.GetSetting( GetRecentFileKey( prefix, index ) ) as string;
 111                                 if ( fileSpec != null ) fileEntries.Add( new RecentFileEntry( fileSpec ) );
 112                         }
 113
 114                         // Try legacy entries if nothing was found
 115                         if ( fileEntries.Count == 0 )
 116                         {
 117                                 for ( int index = 1; index <= MaxFiles; index++ )
 118                                 {
 119                                         string fileSpec = settings.GetSetting( GetRecentFileKey( "RecentProjects", index ) ) as string;
 120                                         if ( fileSpec != null )
 121                                         {
 122                                                 RecentFileEntry entry = RecentFileEntry.Parse( fileSpec );
 123                                                 if ( entry.CLRVersion.Major <= Environment.Version.Major )
 124                                                         fileEntries.Add( entry );
 125                                         }
 126                                 }
 127                         };
 128                 }
 129
 130                 private void SaveEntriesToSettings( ISettings settings )
 131                 {
 132                         string prefix = Environment.Version.Major >= 2
 133                                 ? "RecentProjects.V2"
 134                                 : "RecentProjects.V1";
 135
 136                         while( fileEntries.Count > MaxFiles )
 137                                 fileEntries.RemoveAt( fileEntries.Count - 1 );
 138
 139                         for( int index = 0; index < MaxSize; index++ )
 140                         {
 141                                 string keyName = GetRecentFileKey( prefix, index + 1 );
 142                                 if ( index < fileEntries.Count )
 143                                         settings.SaveSetting( keyName, fileEntries[index].Path );
 144                                 else
 145                                         settings.RemoveSetting( keyName );
 146                         }
 147                 }
 148
 149                 private string GetRecentFileKey( string prefix, int index )
 150                 {
 151                         return string.Format( "{0}.File{1}", prefix, index );
 152                 }
 153                 #endregion
 154
 155                 #region IService Members
 156
 157                 public void UnloadService()
 158                 {
 159                         SaveEntriesToSettings( this.settings );
 160                 }
 161
 162                 public void InitializeService()
 163                 {
 164                         LoadEntriesFromSettings( this.settings );
 165                 }
 166
 167                 #endregion
 168         }
 169 }