【CSharp】IniHelper

/*
 * INI文件说明:
 * INI是Initialization头三个字母的缩写；其后缀名也不一定是".ini"也可以是".cfg"，".conf ”或者是".txt"
 * 
 * INI文件由节、键、值组成
 * 节
 *      [section]
 * 参数（键=值）
 *      name=value
 * 注解
 *      注解使用分号表示（;）。在分号后面的文字，直到该行结尾都全部为注解。
 *
 * NI文件的格式很简单，最基本的三个要素是：parameters，sections和comments。
 * 
 * 什么是parameters？
 *      INI所包含的最基本的“元素”就是parameter；每一个parameter都有一个name和一个value，
 *      name和value是由等号“=”隔开。name在等号的左边。
 *      如：
 *          name = value
 * 
 * 什么是sections？
 *      所有的parameters都是以sections为单位结合在一起的。所有的section名称都是独占一行，
 *      并且sections名字都被方括号包围着。在section声明后的所有parameters都是属于该section。
 *      对于一个section没有明显的结束标志符，一个section的开始就是上一个section的结束，
 *      或者是end of the file。Sections一般情况下不能被nested，当然特殊情况下也可以实现sections的嵌套。
 *      section如下所示：
 *          [section]
 * 
 * 什么是comments？
 *      在INI文件中注释语句是以分号“;”开始的。所有的所有的注释语句不管多长都是独占一行直到结束的。
 *      在分号和行结束符之间的所有内容都是被忽略的。
 *      注释实例如下：
 *          ;comments text
 */
namespace Steven
{
    public class IniHelper
    {
        #region Fields

        private string  m_FullName       = null;
        private int     m_ReadBufferSize =  512;

        #endregion

        #region Properties

        public string FullName
        {
            get { return this.m_FullName; }
        }

        public int ReadBufferSize
        {
            get
            {
                return this.m_ReadBufferSize;
            }
            set
            {
                this.m_ReadBufferSize = value;
            }
        }
        #endregion

        #region Constructors

        public IniHelper(string fullName = ".\\config.ini")
        {
            this.m_FullName = fullName;
        }

        #endregion

        #region Fuction Declare

        /// <summary>
        /// 写入INI文件
        /// </summary>
        /// <param name="section">节点名称,这个字串不区分大小写[如[TypeName]]</param>
        /// <param name="key">键,不区分大小写</param>
        /// <param name="val">值</param>
        /// <param name="filepath">INI文件的完整路径和文件名</param>
        /// <returns>非零表示成功，零表示失败</returns>
        [System.Runtime.InteropServices.DllImport("kernel32")]
        private static extern long WritePrivateProfileString(string section, string key, string val, string filepath);


        /// <summary>
        /// 读取INI文件
        /// </summary>
        /// <param name="section">节点名称</param>
        /// <param name="key">键</param>
        /// <param name="defValue">读取异常的情况下的缺省值</param>
        /// <param name="retval">stringbulider对象</param>
        /// <param name="size">字节大小</param>
        /// <param name="filePath">INI文件的完整路径和文件名</param>
        /// <returns>复制到缓冲区的字节数量，其中不包括那些NULL中止字符。
        ///          若缓冲区size不够大，不能容下全部信息，就返回nSize-1
        ///          若section或key为NULL，则返回nSize-2</returns>
        [System.Runtime.InteropServices.DllImport("kernel32")]
        private static extern int GetPrivateProfileString(string section, string key, string defValue,
                                                          System.Text.StringBuilder retval, int size, string filePath);

        #endregion

        #region Public Functions

        #region Write
        /// <summary>
        /// 向Ini文件中写入字符串
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="KeyValue">参数值</param>
        public void WriteIni(string Section, string KeyName, string KeyValue)
        {
            long size = WritePrivateProfileString(Section, KeyName, KeyValue, this.m_FullName);
            if (size == 0)
            {
                throw new System.Exception("Writting data to ini file is fail" + System.Environment.NewLine + this.m_FullName);
            }
        }

        /// <summary>
        /// 向Ini文件中写入INT
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="KeyValue">参数值</param>
        public void WriteIni(string Section, string KeyName, int KeyValue)
        {
            try
            {
                this.WriteIni(Section, KeyName, KeyValue.ToString());
            }
            catch
            {
                throw;
            }
        }

        /// <summary>
        /// 向Ini文件中写入USHORT
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="KeyValue">参数值</param>
        public void WriteIni(string Section, string KeyName, ushort KeyValue)
        {
            try
            {
                this.WriteIni(Section, KeyName, KeyValue.ToString());
            }
            catch
            {
                throw;
            }
        }

        /// <summary>
        /// 向Ini文件中写入DOUBLE
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="KeyValue">参数值</param>
        public void WriteIni(string Section, string KeyName, double KeyValue)
        {
            try
            {
                this.WriteIni(Section, KeyName, KeyValue.ToString());
            }
            catch
            {
                throw;
            }
        }

        /// <summary>
        /// 向Ini文件中写入BOOL
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="KeyValue">参数值</param>
        public void WriteIni(string Section, string KeyName, bool KeyValue)
        {
            try
            {
                this.WriteIni(Section, KeyName, KeyValue.ToString());
            }
            catch
            {
                throw;
            }
        }
        #endregion

        #region Read
        /// <summary>
        /// 从Ini文件中读取字符串
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="DefaultValue">默认值</param>
        /// <returns>读取值</returns>
        public string ReadIni(string Section, string KeyName, string DefaultValue)
        {
            var stringBulder = new System.Text.StringBuilder(this.m_ReadBufferSize);
            long size = GetPrivateProfileString(Section, KeyName, DefaultValue, stringBulder, this.m_ReadBufferSize, this.m_FullName);
            if (size == this.m_ReadBufferSize - 1)
            {
                throw new System.Exception("The read buffer is small, please change the buffer size");
            }
            else if (size == this.m_ReadBufferSize - 2)
            {
                throw new System.Exception("The section or key is not found, please check it");
            }
            
            return stringBulder.ToString();
        }

        /// <summary>
        /// 从Ini文件中读取INT
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="DefaultValue">默认值</param>
        /// <returns>读取值</returns>
        public int ReadIni(string Section, string KeyName, int DefaultValue)
        {
            int ret;
            try
            {
                string str = this.ReadIni(Section, KeyName, DefaultValue.ToString());
                ret = int.TryParse(str, out ret) ? ret : DefaultValue;
            }
            catch
            {
                throw;
            }

            return ret;
        }

        /// <summary>
        /// 从Ini文件中读取USHORT
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="DefaultValue">默认值</param>
        /// <returns>读取值</returns>
        public ushort ReadIni(string Section, string KeyName, ushort DefaultValue)
        {
            ushort ret;
            try
            {
                string str = this.ReadIni(Section, KeyName, DefaultValue.ToString());
                ret = ushort.TryParse(str, out ret) ? ret : DefaultValue;
            }
            catch
            {
                throw;
            }

            return ret;
        }

        /// <summary>
        /// 从Ini文件中读取DOUBLE
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="DefaultValue">默认值</param>
        /// <returns>读取值</returns>
        public double ReadIni(string Section, string KeyName, double DefaultValue)
        {
            double ret;
            try
            {
                string str = this.ReadIni(Section, KeyName, DefaultValue.ToString());
                ret = double.TryParse(str, out ret) ? ret : DefaultValue;
            }
            catch
            {
                throw;
            }

            return ret;
        }

        /// <summary>
        /// 从Ini文件中读取BOOL
        /// </summary>
        /// <param name="Section">节点名称</param>
        /// <param name="KeyName">参数名称</param>
        /// <param name="DefaultValue">默认值</param>
        /// <returns>读取值</returns>
        public bool ReadIni(string Section, string KeyName, bool DefaultValue)
        {
            bool ret;
            try
            {
                string str = this.ReadIni(Section, KeyName, DefaultValue.ToString());
                ret = bool.TryParse(str, out ret) ? ret : DefaultValue;
            }
            catch
            {
                throw;
            }

            return ret;
        }
        #endregion

        #region Delete
        public void DeleteKey(string section, string key)
        {
            try
            {
                this.WriteIni(section, key, null);
            }
            catch
            {
                throw;
            }
        }

        public void DeleteSection(string section)
        {
            try
            {
                this.WriteIni(section, null, null);
            }
            catch
            {
                throw;
            }
        }

        public void DeleteAllSection()
        {
            try
            {
                this.WriteIni(null, null, null);
            }
            catch
            {
                throw;
            }
        }
        #endregion

        #endregion
    }
}