XZException.cs

/*
    Derived from liblzma header files (Public Domain)

    C# Wrapper written by Hajin Jang
    Copyright (C) 2018-2023 Hajin Jang

    MIT License

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;

namespace Joveler.Compression.XZ
{
    [Serializable]
    public class XZException : Exception
    {
        public LzmaRet ReturnCode { get; set; }

        private static readonly Dictionary<LzmaRet, string> ErrorMsgDict = new Dictionary<LzmaRet, string>
        {
            [LzmaRet.NoCheck] = "No integrity check; not verifying file integrity",
            [LzmaRet.UnsupportedCheck] = "Unsupported type of integrity check; not verifying file integrity",
            [LzmaRet.MemError] = "Not enough memory",
            [LzmaRet.MemLimitError] = "Memory usage limit reached",
            [LzmaRet.OptionsError] = "Unsupported options",
            [LzmaRet.DataError] = "Compressed data is corrupt",
            [LzmaRet.BufError] = "Unexpected end of input",
        };

        private static string GetErrorMessage(LzmaRet ret) => ErrorMsgDict.ContainsKey(ret) ? ErrorMsgDict[ret] : ret.ToString();

        public XZException(LzmaRet ret) : base(GetErrorMessage(ret))
        {
            ReturnCode = ret;
        }

        public static void CheckReturnValueNormal(LzmaRet ret)
        {
            switch (ret)
            {
                case LzmaRet.Ok:
                    break;
                default:
                    throw new XZException(ret);
            }
        }

        public static void CheckReturnValueDecompress(LzmaRet ret)
        {
            switch (ret)
            {
                case LzmaRet.Ok:
                case LzmaRet.SeekNeeded:
                    break;
                default:
                    throw new XZException(ret);
            }
        }

        #region Serializable
        protected XZException(SerializationInfo info, StreamingContext ctx)
        {
            ReturnCode = (LzmaRet)info.GetValue(nameof(ReturnCode), typeof(LzmaRet));
        }

        public override void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            if (info == null)
                throw new ArgumentNullException(nameof(info));
            info.AddValue(nameof(ReturnCode), ReturnCode);
            base.GetObjectData(info, context);
        }
        #endregion
    }
}