File: StorageContainer.cs

package info (click to toggle)
monogame 2.5.1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 6,060 kB
  • ctags: 10,325
  • sloc: cs: 65,996; xml: 591; makefile: 22; ansic: 8
file content (445 lines) | stat: -rw-r--r-- 14,965 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
#region License
/*
Microsoft Public License (Ms-PL)
MonoGame - Copyright © 2009 The MonoGame Team

All rights reserved.

This license governs use of the accompanying software. If you use the software, you accept this license. If you do not
accept the license, do not use the software.

1. Definitions
The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under 
U.S. copyright law.

A "contribution" is the original software, or any additions or changes to the software.
A "contributor" is any person that distributes its contribution under this license.
"Licensed patents" are a contributor's patent claims that read directly on its contribution.

2. Grant of Rights
(A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, 
each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create.
(B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, 
each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.

3. Conditions and Limitations
(A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks.
(B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, 
your patent license from such contributor to the software ends automatically.
(C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution 
notices that are present in the software.
(D) If you distribute any portion of the software in source code form, you may do so only under this license by including 
a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object 
code form, you may only do so under a license that complies with this license.
(E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees
or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent
permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular
purpose and non-infringement.
*/
#endregion License

#region Using Statements
//using System;
//using System.IO;
//using System.Reflection;
//using Microsoft.Xna;
//using Microsoft.Xna.Framework;
//using Microsoft.Xna.Framework.Storage;
#endregion


//namespace Microsoft.Xna.Framework.Storage
//{
//    public class StorageContainer : IDisposable
//    {
//		private readonly string _path;
//		private readonly StorageDevice _device;
//		private readonly string _name;
//
//        public StorageContainer(StorageDevice device, string name)
//        {
//			_device = device;
//			_name = name;
//			_path = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments)+System.IO.Path.DirectorySeparatorChar+name;
//			// Creathe the "device" if need
//			if (!Directory.Exists(_path))
//			{
//				Directory.CreateDirectory(_path);
//			}
//        }
//
//        public string Path
//        {
//            get
//            {
//                return _path;
//            }
//        }
//		
//		 public Microsoft.Xna.Framework.Storage.StorageDevice StorageDevice
//        {
//            get
//            {
//				return _device;
//            }
//        }
//
//		public static string TitleLocation 
//		{ 
//			get
//			{
//				return Directory.GetParent(Assembly.GetEntryAssembly().Location).ToString();
//			}
//		}
//		
//        public string TitleName
//        {
//            get
//            {
//				return _name;
//            }
//        }
//
//
//        #region IDisposable Members
//
//        public void Dispose()
//        {
//            
//        }
//
//        #endregion
//    }
//}

#region Assembly Microsoft.Xna.Framework.Storage.dll, v4.0.30319
// C:\Program Files (x86)\Microsoft XNA\XNA Game Studio\v4.0\References\Windows\x86\Microsoft.Xna.Framework.Storage.dll
#endregion
using Microsoft.Xna.Framework;
using System;
using System.IO;

namespace Microsoft.Xna.Framework.Storage
{
	// Summary:
	//     Represents a logical collection of storage files. Reference page contains
	//     links to related conceptual articles.
	
	
	//	What is storage can be found here ->	http://msdn.microsoft.com/en-us/library/bb200105.aspx#ID4EDB
	
	//	Implementation on Windows
	//	
	//	User storage is in the My Documents folder of the user who is currently logged in, in the SavedGames folder. 
	//	A subfolder is created for each game according to the titleName passed to the BeginOpenContainer method. 
	//	When no PlayerIndex is specified, content is saved in the AllPlayers folder. When a PlayerIndex is specified, 
	//	the content is saved in the Player1, Player2, Player3, or Player4 folder, depending on which PlayerIndex 
	//	was passed to BeginShowSelector.

			
	public class StorageContainer : IDisposable
	{
		internal readonly string _storagePath;
		private readonly StorageDevice _device;
		private readonly string _name;
		private readonly PlayerIndex? _playerIndex;
		
		/// <summary>
		/// Initializes a new instance of the <see cref="Microsoft.Xna.Framework.Storage.StorageContainer"/> class.
		/// </summary>
		/// <param name='_device'>
		/// _device.
		/// </param>
		/// <param name='_name'>
		/// _name.
		/// </param>
		/// <param name='playerIndex'>
		/// The player index of the player to save the data
		/// </param>
		internal StorageContainer(StorageDevice device, string name, PlayerIndex? playerIndex)
		{

			if (string.IsNullOrEmpty(name))
				throw new ArgumentNullException("A title name has to be provided in parameter name.");			

			_device = device;
			_name = name;
			_playerIndex = playerIndex;
			
			// From the examples the root is based on MyDocuments folder
			var root = StorageDevice.StorageRoot;
			var saved = Path.Combine(root,"SavedGames");
			_storagePath = Path.Combine(saved,name);
			
			var playerSave = string.Empty;
			if (playerIndex.HasValue) {
				playerSave = Path.Combine(root,"Player" + (int)playerIndex.Value);
			}
			
			if (!string.IsNullOrEmpty(playerSave))
				_storagePath = Path.Combine(root,"Player" + (int)playerIndex);
			
				
			// Creathe the "device" if need be
			if (!Directory.Exists(_storagePath))
			{
				Directory.CreateDirectory(_storagePath);
			}
			
		}
		
		// Summary:
		//     Gets the name of the title.
		public string DisplayName { 
			get { return _name; }
		}
		
		//
		// Summary:
		//     Gets a value that indicates whether the object is disposed.
		public bool IsDisposed { get; private set; }
		//
		// Summary:
		//     Gets the StorageDevice that holds the files in this container.
		public StorageDevice StorageDevice { 
			
			get {return _device; }
		}

		// Summary:
		//     Occurs when Dispose is called or when this object is finalized and collected
		//     by the garbage collector of the Microsoft .NET common language runtime.
		//
		// Parameters:
		//   :
		// TODO: Implement the Disposing function.  Find sample first
		public event EventHandler<EventArgs> Disposing;

		// Summary:
		//     Creates a new directory in the StorageContainer scope.
		//
		// Parameters:
		//   directory:
		//     The relative path of the directory to delete within the StorageContainer
		//     scope.
		public void CreateDirectory (string directory)
		{
			if (string.IsNullOrEmpty(directory))
				throw new ArgumentNullException("Parameter directory must contain a value.");
			
			// relative so combine with our path
			var dirPath = Path.Combine(_storagePath, directory);
			
			// Now let's try to create it
			Directory.CreateDirectory(dirPath);
			
		}
		
		//
		// Summary:
		//     Creates a file at a specified path in the StorageContainer.
		//
		// Parameters:
		//   file:
		//     The relative path of the file to be created in the StorageContainer.
		public Stream CreateFile (string file)
		{
			if (string.IsNullOrEmpty(file))
				throw new ArgumentNullException("Parameter file must contain a value.");
			
			// relative so combine with our path
			var filePath= Path.Combine(_storagePath, file);
			
			// return A new file with read/write access.
			return File.Create(filePath);				
			
		}				
		//
		// Summary:
		//     Deletes a directory in the StorageContainer scope.
		//
		// Parameters:
		//   directory:
		//     The relative path of the directory to delete within the StorageContainer
		//     scope.
		public void DeleteDirectory (string directory)
		{
			if (string.IsNullOrEmpty(directory))
				throw new ArgumentNullException("Parameter directory must contain a value.");
			
			// relative so combine with our path
			var dirPath = Path.Combine(_storagePath, directory);
			
			// Now let's try to delete it
			Directory.Delete(dirPath);
		}				
		//
		// Summary:
		//     Deletes a file in the StorageContainer.
		//
		// Parameters:
		//   file:
		//     The relative path of the file to delete within the StorageContainer.
		public void DeleteFile (string file)
		{
			if (string.IsNullOrEmpty(file))
				throw new ArgumentNullException("Parameter file must contain a value.");
			
			// relative so combine with our path
			var filePath= Path.Combine(_storagePath, file);
			
			// Now let's try to delete it
			File.Delete(filePath);		
		}				
		//
		// Summary:
		//     Determines whether the specified path refers to an existing directory in
		//     the StorageContainer.
		//
		// Parameters:
		//   directory:
		//     The path to test.
		public bool DirectoryExists (string directory)
		{
			if (string.IsNullOrEmpty(directory))
				throw new ArgumentNullException("Parameter directory must contain a value.");
			
			// relative so combine with our path
			var dirPath = Path.Combine(_storagePath, directory);
			
			return Directory.Exists(dirPath);
		}				
		//
		// Summary:
		//     Immediately releases the unmanaged resources used by this object.
		public void Dispose ()
		{

			// Fill this in when we figure out what we should be disposing
			IsDisposed = true;
		}				
		//
		// Summary:
		//     Determines whether the specified path refers to an existing file in the StorageContainer.
		//
		// Parameters:
		//   file:
		//     The path and file name to test.
		public bool FileExists (string file)
		{
			if (string.IsNullOrEmpty(file))
				throw new ArgumentNullException("Parameter file must contain a value.");
			
			// relative so combine with our path
			var filePath= Path.Combine(_storagePath, file);
			
			// return A new file with read/write access.
			return File.Exists(filePath);		
		}				
		//
		// Summary:
		//     Enumerates the directories in the root of a StorageContainer.
		public string[] GetDirectoryNames ()
		{
			return Directory.GetDirectories(_storagePath);
		}				
		//
		// Summary:
		//     Enumerates the directories in the root of a StorageContainer that conform
		//     to a search pattern.
		//
		// Parameters:
		//   searchPattern:
		//     A search pattern. Both single-character ("?") and multicharacter ("*") wildcards
		//     are supported.
		public string[] GetDirectoryNames (string searchPattern)
		{
			throw new NotImplementedException ();
		}
		//
		// Summary:
		//     Enumerates files in the root directory of a StorageContainer.
		public string[] GetFileNames ()
		{
			return Directory.GetFiles(_storagePath);		
		}				
		//
		// Summary:
		//     Enumerates files in the root directory of a StorageContainer that match a
		//     given pattern.
		//
		// Parameters:
		//   searchPattern:
		//     A search pattern. Both single-character ("?") and multicharacter ("*") wildcards
		//     are supported.
		public string[] GetFileNames (string searchPattern)
		{
			if (string.IsNullOrEmpty(searchPattern))
				throw new ArgumentNullException("Parameter searchPattern must contain a value.");
			
			return Directory.GetFiles(_storagePath, searchPattern);
		}				
		//
		// Summary:
		//     Opens a file in the StorageContainer.
		//
		// Parameters:
		//   file:
		//     Relative path of the file within the StorageContainer.
		//
		//   fileMode:
		//     One of the enumeration values that specifies how to open the file.
		public Stream OpenFile (string file, FileMode fileMode)
		{
			return OpenFile(file, fileMode, FileAccess.ReadWrite, FileShare.ReadWrite);
		}				
		//
		// Summary:
		//     Opens a file in the StorageContainer in the designated mode with the specified
		//     read/write access.
		//
		// Parameters:
		//   file:
		//     Relative path of the file within the StorageContainer.
		//
		//   fileMode:
		//     One of the enumeration values that specifies how to open the file.
		//
		//   fileAccess:
		//     One of the enumeration values that specifies whether the file is opened with
		//     read, write, or read/write access.
		public Stream OpenFile (string file, FileMode fileMode, FileAccess fileAccess)
		{
			return OpenFile(file, fileMode, fileAccess, FileShare.ReadWrite);
		}				
		//
		// Summary:
		//     Opens a file in the StorageContainer in the designated mode with the specified
		//     read/write access and sharing permission.
		//
		// Parameters:
		//   file:
		//     Relative path of the file within the StorageContainer.
		//
		//   fileMode:
		//     One of the enumeration values that specifies how to open the file.
		//
		//   fileAccess:
		//     One of the enumeration values that specifies whether the file is opened with
		//     read, write, or read/write access.
		//
		//   fileShare:
		//     A bitwise combination of enumeration values that specify the type of access
		//     other Stream objects have to this file.
		public Stream OpenFile (string file, FileMode fileMode, FileAccess fileAccess, FileShare fileShare)
		{
			if (string.IsNullOrEmpty(file))
				throw new ArgumentNullException("Parameter file must contain a value.");
		
			// relative so combine with our path
			var filePath= Path.Combine(_storagePath, file);
			
			return File.Open(filePath, fileMode, fileAccess, fileShare);
		}				
	}
}