luban/src/Luban.Job.Common/Source/Defs/CommonDefLoader.cs

using Luban.Common.Utils;
using Luban.Job.Common.RawDefs;
using Luban.Server.Common;
using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using System.Threading.Tasks;
using System.Xml.Linq;

namespace Luban.Job.Common.Defs
{
    public class LoadDefException : Exception
    {
        public LoadDefException()
        {
        }

        public LoadDefException(string message) : base(message)
        {
        }

        public LoadDefException(string message, Exception innerException) : base(message, innerException)
        {
        }

        protected LoadDefException(SerializationInfo info, StreamingContext context) : base(info, context)
        {
        }
    }

    public abstract class CommonDefLoader
    {
        private static readonly NLog.Logger s_logger = NLog.LogManager.GetCurrentClassLogger();

        protected RemoteAgent Agent { get; }

        public string RootDir { get; private set; }

        public bool IsBeanDefaultCompatible { get; protected set; }

        public bool IsBeanFieldMustDefineId { get; protected set; }

        private readonly Dictionary<string, Action<XElement>> _rootDefineHandlers = new Dictionary<string, Action<XElement>>();
        private readonly Dictionary<string, Action<XElement>> _moduleDefineHandlers = new Dictionary<string, Action<XElement>>();

        protected readonly Stack<string> _namespaceStack = new Stack<string>();
        protected readonly Stack<string> _importFileStack = new Stack<string>();
        protected readonly Stack<XElement> _defineStack = new Stack<XElement>();

        protected string TopModule { get; private set; }

        protected readonly List<Const> _consts = new List<Const>();
        protected readonly List<PEnum> _enums = new List<PEnum>();
        protected readonly List<Bean> _beans = new List<Bean>();

        protected CommonDefLoader(RemoteAgent agent)
        {
            Agent = agent;

            _rootDefineHandlers.Add("topmodule", SetTopModule);

            _moduleDefineHandlers.Add("module", AddModule);
            _moduleDefineHandlers.Add("const", AddConst);
            _moduleDefineHandlers.Add("enum", AddEnum);
            _moduleDefineHandlers.Add("bean", AddBean);
        }

        private string _rootXml;

        public async Task LoadAsync(string rootXml)
        {
            _rootXml = rootXml;

            RootDir = FileUtil.GetParent(rootXml);

            XElement doc = await Agent.OpenXmlAsync(rootXml);

            foreach (XElement e in doc.Elements())
            {
                var tagName = e.Name.LocalName;
                if (tagName == "import")
                {
                    await AddImportAsync(XmlUtil.GetRequiredAttribute(e, "name"));
                    continue;
                }
                if (_rootDefineHandlers.TryGetValue(tagName, out var handler))
                {
                    handler(e);
                }
                else
                {
                    throw new LoadDefException($"定义文件:{rootXml} 非法 tag:{tagName}");
                }
            }
        }

        protected void RegisterRootDefineHandler(string name, Action<XElement> handler)
        {
            _rootDefineHandlers.Add(name, handler);
        }

        protected void RegisterModuleDefineHandler(string name, Action<XElement> handler)
        {
            _moduleDefineHandlers.Add(name, handler);
        }

        protected string CurNamespace => _namespaceStack.Peek();

        protected string CurImportFile => _importFileStack.Peek();

        protected XElement CurDefine => _defineStack.Peek();

        #region root handler

        private void SetTopModule(XElement e)
        {
            this.TopModule = XmlUtil.GetRequiredAttribute(e, "name");
        }

        private async Task AddImportAsync(string xmlFile)
        {
            var rootFileName = FileUtil.GetFileName(_rootXml);

            var xmlFullPath = FileUtil.Combine(RootDir, xmlFile);
            s_logger.Trace("import {file} {full_path}", xmlFile, xmlFullPath);

            var fileOrDirContent = await Agent.GetFileOrDirectoryAsync(xmlFullPath);

            if (fileOrDirContent.IsFile)
            {
                s_logger.Trace("== file:{file}", xmlFullPath);
                _importFileStack.Push(xmlFullPath);
                AddModule(XmlUtil.Open(xmlFullPath, await Agent.GetFromCacheOrReadAllBytesAsync(xmlFullPath, fileOrDirContent.Md5)));
                _importFileStack.Pop();
            }
            else
            {
                // 如果是目录,则递归导入目录下的所有 .xml 定义文件
                foreach (var subFile in fileOrDirContent.SubFiles)
                {
                    var subFileName = subFile.FilePath;
                    s_logger.Trace("sub import xmlfile:{file} root file:{root}", subFileName, rootFileName);
                    // 有时候 root 定义文件会跟 module定义文件放在一个目录. 当以目录形式导入子module时，不希望导入它
                    if (FileUtil.GetFileName(subFileName) == rootFileName)
                    {
                        s_logger.Trace("ignore import root file:{root}", subFileName);
                        continue;
                    }
                    string subFullPath = subFileName;
                    _importFileStack.Push(subFullPath);
                    AddModule(XmlUtil.Open(subFullPath, await Agent.GetFromCacheOrReadAllBytesAsync(subFullPath, subFile.MD5)));
                    _importFileStack.Pop();
                }
            }
        }

        #endregion


        #region module handler

        private void AddModule(XElement me)
        {
            var name = XmlUtil.GetOptionalAttribute(me, "name");
            //if (string.IsNullOrEmpty(name))
            //{
            //    throw new LoadDefException($"xml:{CurImportFile} contains module which's name is empty");
            //}

            _namespaceStack.Push(_namespaceStack.Count > 0 ? TypeUtil.MakeFullName(_namespaceStack.Peek(), name) : name);

            // 加载所有module定义,允许嵌套
            foreach (XElement e in me.Elements())
            {
                var tagName = e.Name.LocalName;
                if (_moduleDefineHandlers.TryGetValue(tagName, out var handler))
                {
                    if (tagName != "module")
                    {
                        _defineStack.Push(e);
                        handler(e);
                        _defineStack.Pop();
                    }
                    else
                    {
                        handler(e);
                    }
                }
                else
                {
                    throw new LoadDefException($"定义文件:{CurImportFile} module:{CurNamespace} 不支持 tag:{tagName}");
                }
            }
            _namespaceStack.Pop();
        }

        private static readonly List<string> _fieldRequireAttrs = new List<string> { "name", "type", };
        private static readonly List<string> _fieldOptionalAttrs = new List<string> { "id", };

        protected virtual Field CreateField(XElement e)
        {
            ValidAttrKeys(e, _fieldOptionalAttrs, _fieldRequireAttrs);
            var f = new Field()
            {
                Id = XmlUtil.GetOptionIntAttribute(e, "id"),
                Name = XmlUtil.GetRequiredAttribute(e, "name"),
                Type = CreateType(e, "type"),
            };
            return f;
        }

        protected void AddBean(XElement e)
        {
            AddBean(e, "");
        }

        private static readonly List<string> _beanOptinsAttrs1 = new List<string> { "compatible", "value_type" };
        private static readonly List<string> _beanRequireAttrs1 = new List<string> { "id", "name" };

        private static readonly List<string> _beanOptinsAttrs2 = new List<string> { "id", "compatible", "value_type" };
        private static readonly List<string> _beanRequireAttrs2 = new List<string> { "name" };

        protected virtual void AddBean(XElement e, string parent)
        {
            if (IsBeanFieldMustDefineId)
            {
                ValidAttrKeys(e, _beanOptinsAttrs1, _beanRequireAttrs1);
            }
            else
            {
                ValidAttrKeys(e, _beanOptinsAttrs2, _beanRequireAttrs2);
            }
            var b = new Bean()
            {
                Name = XmlUtil.GetRequiredAttribute(e, "name"),
                Namespace = CurNamespace,
                Parent = parent.Length > 0 ? parent : "",
                TypeId = XmlUtil.GetOptionIntAttribute(e, "id"),
                IsSerializeCompatible = XmlUtil.GetOptionBoolAttribute(e, "compatible", IsBeanDefaultCompatible),
                IsValueType = XmlUtil.GetOptionBoolAttribute(e, "value_type"),
            };
            var childBeans = new List<XElement>();

            bool defineAnyChildBean = false;
            foreach (XElement fe in e.Elements())
            {
                switch (fe.Name.LocalName)
                {
                    case "var":
                    {
                        if (defineAnyChildBean)
                        {
                            throw new LoadDefException($"定义文件:{CurImportFile} 类型:{b.FullName} 的多态子bean必须在所有成员字段 <var> 之前定义");
                        }
                        b.Fields.Add(CreateField(fe)); ;
                        break;
                    }
                    case "bean":
                    {
                        defineAnyChildBean = true;
                        childBeans.Add(fe);
                        break;
                    }
                    default:
                    {
                        throw new LoadDefException($"定义文件:{CurImportFile} 类型:{b.FullName} 不支持 tag:{fe.Name}");
                    }
                }
            }
            s_logger.Trace("add bean:{@bean}", b);
            _beans.Add(b);

            var fullname = b.FullName;
            foreach (var cb in childBeans)
            {
                AddBean(cb, fullname);
            }
        }

        protected static string CreateType(XElement e, string key)
        {
            return XmlUtil.GetRequiredAttribute(e, key);
        }

        protected void ValidAttrKeys(XElement e, List<string> optionKeys, List<string> requireKeys)
        {
            foreach (var k in e.Attributes())
            {
                var name = k.Name.LocalName;
                if (!requireKeys.Contains(name) && (optionKeys != null && !optionKeys.Contains(name)))
                {
                    throw new LoadDefException($"定义文件:{CurImportFile} module:{CurNamespace} 定义:{e} 包含未知属性 attr:{name}");
                }
            }
            foreach (var k in requireKeys)
            {
                if (e.Attribute(k) == null)
                {
                    throw new LoadDefException($"定义文件:{CurImportFile} module:{CurNamespace} 定义:{e} 缺失属性 attr:{k}");
                }
            }
        }


        private static readonly List<string> _constRequiredAttrs = new List<string> { "name" };
        private static readonly List<string> _constOptionalItemAttrs = new List<string> { "value" };
        private static readonly List<string> _constItemRequiredAttrs = new List<string> { "name", "type" };

        protected void AddConst(XElement e)
        {
            ValidAttrKeys(e, null, _constRequiredAttrs);
            var c = new Const()
            {
                Name = XmlUtil.GetRequiredAttribute(e, "name"),
                Namespace = CurNamespace,
            };
            foreach (XElement item in e.Elements())
            {
                ValidAttrKeys(item, _constOptionalItemAttrs, _constItemRequiredAttrs);
                c.Items.Add(new ConstItem()
                {
                    Name = XmlUtil.GetRequiredAttribute(item, "name"),
                    Type = CreateType(item, "type"),
                    Value = XmlUtil.GetRequiredAttribute(item, "value"),
                });
            }
            s_logger.Trace("add const {@const}", c);
            _consts.Add(c);
        }

        private static readonly List<string> _enumOptionalAttrs = new List<string> { "flags" };
        private static readonly List<string> _enumRequiredAttrs = new List<string> { "name" };
        private static readonly List<string> _enumOptionalItemAttrs = new List<string> { "value", "alias" };
        private static readonly List<string> _enumItemRequiredAttrs = new List<string> { "name" };

        protected void AddEnum(XElement e)
        {
            ValidAttrKeys(e, _enumOptionalAttrs, _enumRequiredAttrs);
            var en = new PEnum()
            {
                Name = XmlUtil.GetRequiredAttribute(e, "name"),
                Namespace = CurNamespace,
                IsFlags = XmlUtil.GetOptionBoolAttribute(e, "flags"),
            };

            foreach (XElement item in e.Elements())
            {
                ValidAttrKeys(item, _enumOptionalItemAttrs, _enumItemRequiredAttrs);
                en.Items.Add(new EnumItem()
                {
                    Name = XmlUtil.GetRequiredAttribute(item, "name"),
                    Alias = XmlUtil.GetOptionalAttribute(item, "alias"),
                    Value = XmlUtil.GetOptionalAttribute(item, "value"),
                });
            }
            s_logger.Trace("add enum:{@enum}", en);
            _enums.Add(en);
        }
        #endregion
    }
}