使用IDEA進行Lua代碼調試、自動提示、代碼跳轉、智能重命名

本文轉載自查看原文 2018-07-30 16:51 6635

試了幾個Lua IDE后，Lua Studio、Lua Glider、VS+babelua插件、Sublime都不是特別滿意。直到發現了國人自創的另一個神奇工具：基於IDEA的EmmyLua插件。該插件功能非常完整：斷點調試、自動提示、代碼跳轉、智能重命名等，可以極大地提高Lua編程的速度。界面也比較舒服。

安裝步驟

下載、安裝並破解IntelliJ IDEA（我的版本是目前最新的2017.3.4）
安裝EmmyLua插件
建議直接在IDEA工具內搜索插件安裝（當然也可以下載插件到硬盤安裝）。
(1)在啟動界面點擊Configure-Plugins：

(2)搜索EmmyLua，然后點Search in repositories：

(3)點擊右邊的Install綠色按鈕。安裝完需要重啟IDEA。
配置SDK，默認是Path路徑需要有一個Lua解釋器（lua.exe）。你可以在創建項目時指定其他目錄。
配置其他事項。
(1)將*.txt識別成lua文件：

(2)忽略代碼提示大小寫差別：

創建項目

創建普通Lua項目（不依賴其他程序，如游戲引擎）：
New-Project，然后next，填項目名、路徑，點擊finish。
在項目視圖的src文件夾New一個Lua文件，可以自己print()一下，Run一下，看看有沒有輸出，有的話，說明SDK配置正確。
創建Unity引擎Lua項目
New-Modules from existing sources（注意不要選錯，這里創建的是Modules，不是Project，否則等下導入不了api自動提示的library）。【這里有一個IDE Bug：第一次創建Modules，會在文件夾里生成一個.iml文件。但是如果文件夾里本來就有.iml文件，以后再點Modules from existing sources就會無法生成Modules，也就無法導入library。這個Bug我折騰了一晚上才發現的！必須刪掉.iml文件，才可以重新創建Modules】
然后選擇Unity文件夾的Lua訪問根目錄，我選的是Resources文件夾，因為可以從Resources作為根目錄搜索lua文件。
然后我們測試一下斷點調試功能。打開其中一個Lua文件，設置斷點：

然后Run-Attach To Local Process：

選擇Unity進程，觸發斷點，說明能斷點調試：

Unity API代碼提示

現在Unity API代碼提示是沒有的，因為我們還沒導入API描述的library。這個library根據你選擇的Lua中間件不同而不同，所以建議是自己導出。我的Lua中間件是SLua。這里以SLua為例。
1.打開SLua官方自帶的Unity項目，在Slua-Editor下面，新建一個SLuaApiExporter.cs腳本：
這里寫圖片描述
2.輸入如下代碼：

using System; using System.Reflection; using System.Collections.Generic; using System.Linq; using System.Text; using UnityEditor; using SLua; using System.IO; using UnityEngine; namespace Slua { public static class EmmyLuaApiExporter { [MenuItem("SLua/導出EmmyLuaApi", false, 14)] static void Gen() { string path = "./EmmyApi/"; if (Directory.Exists(path)) { Directory.Delete(path, true); } Directory.CreateDirectory(path); //UnityEngine GenAssembly("UnityEngine", path); //GenAssembly("UnityEngine.UI", path); GenCustom(path); } public static void GenAssembly(string name, string path) { List<string> excludeList; List<string> includeList; CustomExport.OnGetNoUseList(out excludeList); CustomExport.OnGetUseList(out includeList); Type[] types = Assembly.Load(name).GetTypes(); foreach (Type t in types) { if (LuaCodeGen.filterType(t, excludeList, includeList)) { GenType(t, false, path); } } } public static void GenCustom(string path) { Type[] types = Assembly.Load("Assembly-CSharp-firstpass").GetTypes(); foreach (Type t in types) { if (t.IsDefined(typeof(CustomLuaClassAttribute), false)) { GenType(t, true, path); } } types = Assembly.Load("Assembly-CSharp").GetTypes(); foreach (Type t in types) { if (t.IsDefined(typeof(CustomLuaClassAttribute), false)) { GenType(t, true, path); } } } public static void GenType(Type t, bool custom, string path) { if (!CheckType(t, custom)) return; //TODO System.MulticastDelegate var sb = new StringBuilder(); if (!CheckType(t.BaseType, custom)) sb.AppendFormat("---@class {0}\n", t.Name); else sb.AppendFormat("---@class {0} : {1}\n", t.Name, t.BaseType.Name); GenTypeField(t, sb); sb.AppendFormat("local {0}={{ }}\n", t.Name); GenTypeMehod(t, sb); sb.AppendFormat("{0}.{1} = {2}", t.Namespace, t.Name, t.Name); File.WriteAllText(path + t.FullName + ".lua", sb.ToString(), Encoding.UTF8); } static bool CheckType(Type t, bool custom) { if (t == null) return false; if (t == typeof(System.Object)) return false; if (t.IsGenericTypeDefinition) return false; if (t.IsDefined(typeof(ObsoleteAttribute), false)) return false; if (t == typeof(YieldInstruction)) return false; if (t == typeof(Coroutine)) return false; if (t.IsNested) return false; if (custom && !t.IsDefined(typeof(CustomLuaClassAttribute), false)) return false; return true; } public static void GenTypeField(Type t, StringBuilder sb) { FieldInfo[] fields = t.GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.Instance | BindingFlags.DeclaredOnly); foreach(var field in fields) { if (field.IsDefined(typeof(DoNotToLuaAttribute), false)) continue; sb.AppendFormat("---@field public {0} {1}\n", field.Name, GetLuaType(field.FieldType)); } PropertyInfo[] properties = t.GetProperties(BindingFlags.Public | BindingFlags.Static | BindingFlags.Instance | BindingFlags.DeclaredOnly); foreach (var pro in properties) { if (pro.IsDefined(typeof(DoNotToLuaAttribute), false)) continue; sb.AppendFormat("---@field public {0} {1}\n", pro.Name, GetLuaType(pro.PropertyType)); } } public static void GenTypeMehod(Type t, StringBuilder sb) { MethodInfo[] methods = t.GetMethods(BindingFlags.Public | BindingFlags.Static | BindingFlags.Instance | BindingFlags.DeclaredOnly); foreach (var method in methods) { if (method.IsGenericMethod) continue; if (method.IsDefined(typeof(DoNotToLuaAttribute), false)) continue; if(method.Name.StartsWith("get_") || method.Name.StartsWith("set_")) continue; sb.AppendLine("---@public"); var paramstr = new StringBuilder(); foreach (var param in method.GetParameters()) { sb.AppendFormat("---@param {0} {1}\n", param.Name, GetLuaType(param.ParameterType)); if (paramstr.Length != 0) { paramstr.Append(", "); } paramstr.Append(param.Name); } sb.AppendFormat("---@return {0}\n", method.ReturnType == null ? "void" : GetLuaType(method.ReturnType)); if( method.IsStatic) { sb.AppendFormat("function {0}.{1}({2}) end\n", t.Name, method.Name, paramstr); } else { sb.AppendFormat("function {0}:{1}({2}) end\n", t.Name, method.Name, paramstr); } } } static string GetLuaType(Type t) { if (t.IsEnum //|| t == typeof(ulong) //|| t == typeof(long) //|| t == typeof(int) //|| t == typeof(uint) //|| t == typeof(float) || t == typeof(double) //|| t == typeof(byte) //|| t == typeof(ushort) //|| t == typeof(short) ) return "number"; if (t == typeof(bool)) return "bool"; if (t == typeof(string)) return "string"; if (t == typeof(void)) return "void"; return t.Name; } } }