diff --git a/Battleship/Battleship/Battleship.csproj b/Battleship/Battleship/Battleship.csproj index 7eb1706..df6579a 100644 --- a/Battleship/Battleship/Battleship.csproj +++ b/Battleship/Battleship/Battleship.csproj @@ -10,6 +10,7 @@ + diff --git a/Battleship/Battleship/CollectionGenericObjects/ListGenericObjects.cs b/Battleship/Battleship/CollectionGenericObjects/ListGenericObjects.cs index 64d3622..e59adfd 100644 --- a/Battleship/Battleship/CollectionGenericObjects/ListGenericObjects.cs +++ b/Battleship/Battleship/CollectionGenericObjects/ListGenericObjects.cs @@ -1,11 +1,7 @@ -using Battleship.Exception; +using Battleship.Exceptions; namespace Battleship.CollectionGenericObjects; -/// -/// Конструктор -/// -/// public class ListGenericObjects : ICollectionGenericObjects where T : class { @@ -13,7 +9,6 @@ public class ListGenericObjects : ICollectionGenericObjects /// Список объектов, которые храним /// private readonly List _collection; - public CollectionType GetCollectionType => CollectionType.List; /// /// Максимально допустимое число объектов в списке @@ -21,20 +16,10 @@ public class ListGenericObjects : ICollectionGenericObjects private int _maxCount; public int Count => _collection.Count; - public int MaxCount - { - get - { - return Count; - } - set - { - if (value > 0) - { - _maxCount = value; - } - } - } + + public int MaxCount { get { return _collection.Count; } set { if (value > 0) { _maxCount = value; } } } + + public CollectionType GetCollectionType => CollectionType.List; /// /// Конструктор @@ -46,53 +31,53 @@ public class ListGenericObjects : ICollectionGenericObjects public T? Get(int position) { - // TODO проверка позиции - if (position >= Count || position < 0) - return null; + // проверка позиции + // выброс ошибки, если выход за границы списка + if (position < 0 || position > _maxCount) throw new PositionOutOfCollectionException(position); + return _collection[position]; } public int Insert(T obj) { - // TODO проверка, что не превышено максимальное количество элементов - // TODO проверка позиции - // TODO вставка по позиции - if (Count == _maxCount) throw new CollectionOverflowException(_maxCount); + // проверка, что не превышено максимальное количество элементов + if (_collection.Count >= _maxCount) + { + throw new CollectionOverflowException(_maxCount); + } + // вставка в конец набора _collection.Add(obj); - return Count; + return _maxCount; } public int Insert(T obj, int position) { - // TODO проверка, что не превышено максимальное количество элементов - // TODO проверка позиции - // TODO вставка по позиции - if (position >= Count || position < 0) - { - return -1; - } - if (Count == _maxCount) - { - return -1; - } + // проверка, что не превышено максимальное количество элементов + if (Count >= _maxCount) + throw new CollectionOverflowException(_maxCount); + + // проверка позиции + if (position < 0 || position >= _maxCount) + throw new PositionOutOfCollectionException(position); + + // вставка по позиции _collection.Insert(position, obj); return position; } - public T Remove(int position) + public T? Remove(int position) { - // TODO проверка позиции - // TODO удаление объекта из списка - if (position >= Count || position < 0) - return null; - T obj = _collection[position]; - _collection.RemoveAt(position); - return obj; + // проверка позиции + if (position < 0 || position > _maxCount) throw new PositionOutOfCollectionException(position); + // удаление объекта из списка + T temp = _collection[position]; + _collection[position] = null; + return temp; } public IEnumerable GetItems() { - for (int i = 0; i < Count; ++i) + for (int i = 0; i < _collection.Count; i++) { yield return _collection[i]; } diff --git a/Battleship/Battleship/CollectionGenericObjects/MassiveGenericObjects.cs b/Battleship/Battleship/CollectionGenericObjects/MassiveGenericObjects.cs index 3b05b33..f258dfa 100644 --- a/Battleship/Battleship/CollectionGenericObjects/MassiveGenericObjects.cs +++ b/Battleship/Battleship/CollectionGenericObjects/MassiveGenericObjects.cs @@ -1,5 +1,5 @@ - -using Battleship.Exception; +using Battleship.CollectionGenericObjects; +using Battleship.Exceptions; namespace Battleship.CollectionGenericObjects; @@ -14,21 +14,21 @@ public class MassiveGenericObjects : ICollectionGenericObjects /// Массив объектов, которые храним /// private T?[] _collection; - private int _maxCount; public int Count => _collection.Length; - public int MaxCount + public int MaxCount { get { return _collection.Length; } + set { if (value > 0) { - if (Count > 0) + if (_collection.Length > 0) { Array.Resize(ref _collection, value); } @@ -50,19 +50,19 @@ public class MassiveGenericObjects : ICollectionGenericObjects _collection = Array.Empty(); } - public T Get(int position) + public T? Get(int position) { - // TODO проверка позиции + // проверка позиции if (position >= _collection.Length || position < 0) { - return null; + throw new PositionOutOfCollectionException(position); } return _collection[position]; } public int Insert(T obj) { - // TODO вставка в свободное место набора + // вставка в свободное место набора int index = 0; while (index < _collection.Length) { @@ -71,62 +71,69 @@ public class MassiveGenericObjects : ICollectionGenericObjects _collection[index] = obj; return index; } - ++index; + index++; } - throw new CollectionOverflowException(_maxCount); + throw new CollectionOverflowException(Count); } public int Insert(T obj, int position) { - // TODO проверка позиции - // TODO проверка, что элемент массива по этой позиции пустой, если нет, то - // ищется свободное место после этой позиции и идет вставка туда - // если нет после, ищем до - // TODO вставка + // проверка позиции if (position >= _collection.Length || position < 0) - return -1; + throw new PositionOutOfCollectionException(position); + + // проверка, что элемент массива по этой позиции пустой, если нет, то + if (_collection[position] != null) + { + // проверка, что после вставляемого элемента в массиве есть пустой элемент + int nullIndex = -1; + for (int i = position + 1; i < Count; i++) + { + if (_collection[i] == null) + { + nullIndex = i; + break; + } + } + // Если пустого элемента нет, то выходим + if (nullIndex < 0) + { + return -1; + } + // сдвиг всех объектов, находящихся справа от позиции до первого пустого элемента + int j = nullIndex - 1; + while (j >= position) + { + _collection[j + 1] = _collection[j]; + j--; + } + throw new CollectionOverflowException(Count); + } + // вставка по позиции + _collection[position] = obj; + return position; + } + + public T? Remove(int position) + { + // проверка позиции + // удаление объекта из массива, присвоив элементу массива значение null + if (position >= _collection.Length || position < 0) + { + throw new PositionOutOfCollectionException(position); + } if (_collection[position] == null) { - _collection[position] = obj; - return position; + throw new ObjectNotFoundException(position); } - int index = position + 1; - while (index < _collection.Length) - { - if (_collection[index] == null) - { - _collection[index] = obj; - return index; - } - ++index; - } - index = position - 1; - while (index >= 0) - { - if (_collection[index] == null) - { - _collection[index] = obj; - return index; - } - --index; - } - return -1; - } - - public T Remove(int position) - { - // TODO проверка позиции - // TODO удаление объекта из массива, присвоив элементу массива значение null - if (position >= _collection.Length || position < 0) - return null; - T obj = _collection[position]; + T temp = _collection[position]; _collection[position] = null; - return obj; + return temp; } - public IEnumerable GetItems() + public IEnumerable GetItems() { - for (int i = 0; i < _collection.Length; ++i) + for (int i = 0; i < _collection.Length; i++) { yield return _collection[i]; } diff --git a/Battleship/Battleship/CollectionGenericObjects/StorageCollection.cs b/Battleship/Battleship/CollectionGenericObjects/StorageCollection.cs index 38894e9..e9444ca 100644 --- a/Battleship/Battleship/CollectionGenericObjects/StorageCollection.cs +++ b/Battleship/Battleship/CollectionGenericObjects/StorageCollection.cs @@ -1,23 +1,23 @@ -using Battleship.Drawings; -using System.Text; -using Battleship.Exception; +using Battleship.CollectionGenericObjects; +using Battleship.Drawings; +using Battleship.Exceptions; namespace Battleship.CollectionGenericObjects; /// -/// Класс-хранилище коллекций +/// Класс - хранилище коллекций /// /// public class StorageCollection where T : DrawingWarship { /// - /// Словарь (хранилище) с коллекциями + /// Словарь (хранилище) с коллекциями /// - private Dictionary> _storages; + readonly Dictionary> _storages; /// - /// Возвращение списка названий коллекции + /// Возвращение списка названий коллекций /// public List Keys => _storages.Keys.ToList(); @@ -26,6 +26,16 @@ public class StorageCollection /// private readonly string _collectionKey = "CollectionStorage"; + /// + /// Разделитель для записи ключа и значения элемента словаря + /// + private readonly string _separatorForKeyValue = "|"; + + /// + /// Разделитель для записей коллекции данных в файл + /// + private readonly string _separatorItems = ";"; + /// /// Конструктор /// @@ -41,12 +51,12 @@ public class StorageCollection /// Тип коллекции public void AddCollection(string name, CollectionType collectionType) { - // TODO проверка, что name не пустой и нет в словаре записи с таким ключом + // проверка, что name не пустой и нет в словаре записи с таким ключом if (string.IsNullOrEmpty(name) || _storages.ContainsKey(name)) { return; } - // TODO Прописать логику для добавления + // прописать логику для добавления if (collectionType == CollectionType.List) { _storages.Add(name, new ListGenericObjects()); @@ -60,25 +70,24 @@ public class StorageCollection /// /// Удаление коллекции /// - /// + /// Название коллекции public void DelCollection(string name) { - // TODO Прописать логику для удаления коллекции - if (!_storages.ContainsKey(name)) - return; + // прописать логику для удаления коллекции + if (!_storages.ContainsKey(name)) return; _storages.Remove(name); } /// - /// Доступ к коллекции + /// Доступ к коллекции /// - /// + /// Название коллекции /// - public ICollectionGenericObjects this[string name] + public ICollectionGenericObjects? this[string name] { get { - // TODO Продумать логику получения объекта + // продумать логику получения объекта if (_storages.ContainsKey((string)name)) { return _storages[name]; @@ -88,78 +97,60 @@ public class StorageCollection } /// - /// Ключевое слово, с которого должен начинаться файл + /// Сохранение информации по автомобилям в хранилище в файл /// - private readonly string _collectionKey = "CollectionsStorage"; - - private readonly string _separatorForKeyValue = "|"; - - private readonly string _separatorItems = ";"; - - /// - /// Сохранение информации по кораблям в хранилище в файл - /// - /// - /// - public void SaveData(string filname) + /// Путь и имя файла + public void SaveData(string filename) { if (_storages.Count == 0) { throw new Exception("В хранилище отсутствуют коллекции для сохранения"); } - if (File.Exists(filname)) + if (File.Exists(filename)) { - File.Delete(filname); + File.Delete(filename); } - if (File.Exists(filname)) + using (StreamWriter writer = new StreamWriter(filename)) { - File.Delete(filname); - } - - StringBuilder sb = new(); - - sb.Append(_collectionKey); - foreach (KeyValuePair> value in _storages) - { - sb.Append(Environment.NewLine); - // не сохраняем пустые коллекции - if (value.Value.Count == 0) + writer.Write(_collectionKey); + foreach (KeyValuePair> value in _storages) { - throw new Exception("В хранилище отсутствуют коллекции для сохранения"); - } - - sb.Append(value.Key); - sb.Append(_separatorForKeyValue); - sb.Append(value.Value.GetCollectionType); - sb.Append(_separatorForKeyValue); - sb.Append(value.Value.MaxCount); - sb.Append(_separatorForKeyValue); - - foreach (T? item in value.Value.GetItems()) - { - string data = item?.GetDataForSave() ?? string.Empty; - if (string.IsNullOrEmpty(data)) + writer.Write(Environment.NewLine); + // не сохраняем пустые коллекции + if (value.Value.Count == 0) { continue; } - sb.Append(data); - sb.Append(_separatorItems); + writer.Write(value.Key); + writer.Write(_separatorForKeyValue); + writer.Write(value.Value.GetCollectionType); + writer.Write(_separatorForKeyValue); + writer.Write(value.Value.MaxCount); + writer.Write(_separatorForKeyValue); + + foreach (T? item in value.Value.GetItems()) + { + string data = item?.GetDataForSave() ?? string.Empty; + if (string.IsNullOrEmpty(data)) + { + continue; + } + + writer.Write(data); + writer.Write(_separatorItems); + } } } - - using FileStream fs = new(filname, FileMode.Create); - byte[] info = new UTF8Encoding(true).GetBytes(sb.ToString()); - fs.Write(info, 0, info.Length); } /// - /// Загрузка информации по кораблям в хранилище из файла + /// Загрузка информации по автомобилям в хранилище из файла /// - /// - /// + /// Путь и имя файла + /// true - загрузка прошла успешно, false - ошибка при загрузке данных public void LoadData(string filename) { if (!File.Exists(filename)) @@ -167,67 +158,68 @@ public class StorageCollection throw new Exception("Файл не существует"); } - string bufferTextFromFile = ""; - using (FileStream fs = new(filename, FileMode.Open)) + using (StreamReader reader = File.OpenText(filename)) { - byte[] b = new byte[fs.Length]; - UTF8Encoding temp = new(true); - while (fs.Read(b, 0, b.Length) > 0) - { - bufferTextFromFile += temp.GetString(b); - } - } + string str = reader.ReadLine(); - string[] strs = bufferTextFromFile.Split(new char[] { '\n', '\r' }, StringSplitOptions.RemoveEmptyEntries); - if (strs == null || strs.Length == 0) - { - throw new Exception("В файле нет данных"); - } - if (!strs[0].Equals(_collectionKey)) - { - throw new Exception("В файле неверные данные"); - } - - _storages.Clear(); - foreach (string data in strs) - { - string[] record = data.Split(_separatorForKeyValue, StringSplitOptions.RemoveEmptyEntries); - if (record.Length != 4) + if (str == null || str.Length == 0) { - continue; + throw new Exception("В файле нет данных"); } - CollectionType collectionType = (CollectionType)Enum.Parse(typeof(CollectionType), record[1]); - ICollectionGenericObjects collection = StorageCollection.CreateCollection(collectionType); - if (collection == null) + if (!str.StartsWith(_collectionKey)) { - throw new Exception("Не удалось создать коллекцию"); + throw new Exception("В файле неверные данные"); } - collection.MaxCount = Convert.ToInt32(record[2]); - string[] set = record[3].Split(_separatorItems, StringSplitOptions.RemoveEmptyEntries); - foreach (string elem in set) + _storages.Clear(); + string strs = ""; + while ((strs = reader.ReadLine()) != null) { - if (elem?.CreateDrawingWarship() is T warship) + string[] record = strs.Split(_separatorForKeyValue, StringSplitOptions.RemoveEmptyEntries); + if (record.Length != 4) { - try + continue; + } + + CollectionType collectionType = (CollectionType)Enum.Parse(typeof(CollectionType), record[1]); + ICollectionGenericObjects? collection = StorageCollection.CreateCollection(collectionType); + if (collection == null) + { + throw new Exception("Не удалось создать коллекцию"); + } + + collection.MaxCount = Convert.ToInt32(record[2]); + + string[] set = record[3].Split(_separatorItems, StringSplitOptions.RemoveEmptyEntries); + foreach (string elem in set) + { + if (elem?.CreateDrawingWarship() is T bulldozer) { - if (collection.Insert(warship) == -1) + try { - throw new Exception("Не удалось создать коллекцию"); + if (collection.Insert(bulldozer) == -1) + { + throw new Exception("Объект не удалось добавить в коллекцию: " + record[3]); + } + } + catch (CollectionOverflowException ex) + { + throw new Exception("Коллекция переполнена", ex); } } - catch (CollectionOverflowException ex) - { - throw new Exception("Коллекция переполнена", ex); - } } - } - _storages.Add(record[0], collection); + _storages.Add(record[0], collection); + } } } + /// + /// Создание коллекции по типу + /// + /// + /// private static ICollectionGenericObjects? CreateCollection(CollectionType collectionType) { return collectionType switch @@ -237,4 +229,4 @@ public class StorageCollection _ => null, }; } -} +} \ No newline at end of file diff --git a/Battleship/Battleship/Exception/CollectionOverflowException.cs b/Battleship/Battleship/Exception/CollectionOverflowException.cs index 11d8cd5..4fc5979 100644 --- a/Battleship/Battleship/Exception/CollectionOverflowException.cs +++ b/Battleship/Battleship/Exception/CollectionOverflowException.cs @@ -1,6 +1,6 @@ using System.Runtime.Serialization; -namespace Battleship.Exception; +namespace Battleship.Exceptions; /// /// Класс, описывающий ошибку переполнения коллекции @@ -8,13 +8,9 @@ namespace Battleship.Exception; [Serializable] internal class CollectionOverflowException : ApplicationException { - public CollectionOverflowException(int count) : base("В коллекции превышено допустимое количество count" + count) { } - + public CollectionOverflowException(int count) : base("В коллекции превышено допустимое количество: " + count) { } public CollectionOverflowException() : base() { } - public CollectionOverflowException(string message) : base(message) { } - public CollectionOverflowException(string message, Exception exception) : base(message, exception) { } - - protected CollectionOverflowException(SerializationInfo info, StreamingContext contex) : base(info, contex) { } -} + protected CollectionOverflowException(SerializationInfo info, StreamingContext context) : base(info, context) { } +} \ No newline at end of file diff --git a/Battleship/Battleship/Exception/ObjectNotFoundException.cs b/Battleship/Battleship/Exception/ObjectNotFoundException.cs index fcf6819..0816de6 100644 --- a/Battleship/Battleship/Exception/ObjectNotFoundException.cs +++ b/Battleship/Battleship/Exception/ObjectNotFoundException.cs @@ -1,19 +1,16 @@ using System.Runtime.Serialization; -namespace Battleship.Exception; +namespace Battleship.Exceptions; + /// /// Класс, описывающий ошибку, что по указанной позиции нет элемента /// [Serializable] internal class ObjectNotFoundException : ApplicationException { - public ObjectNotFoundException(int count) : base("В коллекции превышено допустимое количество count" + count) { } - + public ObjectNotFoundException(int i) : base("Не найден объект по позиции " + i) { } public ObjectNotFoundException() : base() { } - public ObjectNotFoundException(string message) : base(message) { } - public ObjectNotFoundException(string message, Exception exception) : base(message, exception) { } - - protected ObjectNotFoundException(SerializationInfo info, StreamingContext contex) : base(info, contex) { } -} \ No newline at end of file + protected ObjectNotFoundException(SerializationInfo info, StreamingContext context) : base(info, context) { } +} diff --git a/Battleship/Battleship/Exception/PositionOutOfCollectionException.cs b/Battleship/Battleship/Exception/PositionOutOfCollectionException.cs index 0dae22f..37ed4b9 100644 --- a/Battleship/Battleship/Exception/PositionOutOfCollectionException.cs +++ b/Battleship/Battleship/Exception/PositionOutOfCollectionException.cs @@ -1,20 +1,13 @@ using System.Runtime.Serialization; -namespace Battleship.Exception; +namespace Battleship.Exceptions; -/// -/// Класс, описывающий ошибку выхода за границы коллекции -/// [Serializable] internal class PositionOutOfCollectionException : ApplicationException { - public PositionOutOfCollectionException(int count) : base("В коллекции превышено допустимое количество count" + count) { } - + public PositionOutOfCollectionException(int i) : base("Выход за границы коллекции. Позиция " + i) { } public PositionOutOfCollectionException() : base() { } - public PositionOutOfCollectionException(string message) : base(message) { } - public PositionOutOfCollectionException(string message, Exception exception) : base(message, exception) { } - - protected PositionOutOfCollectionException(SerializationInfo info, StreamingContext contex) : base(info, contex) { } + protected PositionOutOfCollectionException(SerializationInfo info, StreamingContext context) : base(info, context) { } } diff --git a/Battleship/Battleship/FormWarshipCollection.cs b/Battleship/Battleship/FormWarshipCollection.cs index 444e556..6438b25 100644 --- a/Battleship/Battleship/FormWarshipCollection.cs +++ b/Battleship/Battleship/FormWarshipCollection.cs @@ -283,14 +283,17 @@ public partial class FormWarshipCollection : Form { if (openFileDialog1.ShowDialog() == DialogResult.OK) { - if (_storageCollection.LoadData(openFileDialog1.FileName)) + try { + _storageCollection.LoadData(openFileDialog1.FileName); MessageBox.Show("Загрузка прошла успешно", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Information); RerfreshListBoxItems(); + _logger.LogInformation("Загрузка из файла: {filename}", openFileDialog1.FileName); } - else + catch (Exception ex) { - MessageBox.Show("Не сохранилось", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Error); + MessageBox.Show(ex.Message, "Результат", MessageBoxButtons.OK, MessageBoxIcon.Error); + _logger.LogError("Ошибка: {Message}", ex.Message); } } } diff --git a/Battleship/Battleship/Program.cs b/Battleship/Battleship/Program.cs index 7fa6b89..e682443 100644 --- a/Battleship/Battleship/Program.cs +++ b/Battleship/Battleship/Program.cs @@ -1,5 +1,6 @@ using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; +using NLog.Extensions.Logging; namespace Battleship { @@ -26,12 +27,11 @@ namespace Battleship /// private static void ConfigureServices(ServiceCollection services) { - services.AddSingleton() - .AddLogging(option => - { - optinon.SetMinimumLevel(LogLevel.Information); - option.AddNLog("nlog.config"); - }); + services.AddSingleton().AddLogging(option => + { + option.SetMinimumLevel(LogLevel.Information); + option.AddNLog("nlog.config"); + }); }