使用 Irony 分析 C# 源代码

Question

这就是我和我的团队选择为我们的学校项目做的事情。嗯，实际上我们还没有决定如何解析 C# 源文件。

我们的目标是对 C# 源文件进行全面分析，并生成报告。 其中报告将包含代码中发生的事情。

该报告只需包含：

• 字符串文字、
• 方法名称、
• 变量名称、
• 字段名称
• 等，

我负责研究这个 Irony 库。老实说，我不知道将数据整理成干净可读的报告的最佳方法。我正在使用用 zip 打包的 C# 语法类。

有什么步骤可以正确识别每个节点子节点吗？ （例如：using 指令、命名空间声明、类声明等、方法体）

任何帮助或建议将非常感激。谢谢。

编辑：抱歉，我忘了说我们也需要分析方法调用。

Answer 1

您的主要目标是掌握形式语言的基础知识。 这里可能会找到一个好的初创公司。本文介绍了如何在一个简单的数字计算器的语法示例中使用 Irony。

假设您想要解析包含 C# 代码的某个文件以及您知道的路径：

private void ParseForLongMethods(string path)
    {
        _parser = new Parser(new CSharpGrammar());
        if (_parser == null || !_parser.Language.CanParse()) return;
        _parseTree = null;
        GC.Collect(); //to avoid disruption of perf times with occasional collections
        _parser.Context.SetOption(ParseOptions.TraceParser, true);
        try
        {
            string contents = File.ReadAllText(path);
            _parser.Parse(contents);//, "<source>");
        }
        catch (Exception ex)
        {
        }
        finally
        {
            _parseTree = _parser.Context.CurrentParseTree;
            TraverseParseTree();
        }
    }

这里是遍历方法本身，并计算节点中的一些信息。实际上，这段代码计算了类的每个方法中的语句数量。如果您有任何疑问，欢迎随时来问我

 private void TraverseParseTree()
        {
            if (_parseTree == null) return;
            ParseNodeRec(_parseTree.Root);
        }
        private void ParseNodeRec(ParseTreeNode node)
        {
            if (node == null) return;
            string functionName = "";
            if (node.ToString().CompareTo("class_declaration") == 0)
            {
                ParseTreeNode tmpNode = node.ChildNodes[2];
                currentClass = tmpNode.AstNode.ToString();
            }
            if (node.ToString().CompareTo("method_declaration") == 0)
            {
                foreach (var child in node.ChildNodes)
                {
                    if (child.ToString().CompareTo("qual_name_with_targs") == 0)
                    {
                        ParseTreeNode tmpNode = child.ChildNodes[0];
                        while (tmpNode.ChildNodes.Count != 0)
                        { tmpNode = tmpNode.ChildNodes[0]; }
                        functionName = tmpNode.AstNode.ToString();
                    }
                    if (child.ToString().CompareTo("method_body") == 0)  //method_declaration
                    {
                        int statementsCount = FindStatements(child);
                        //Register bad smell
                        if (statementsCount>(((LongMethodsOptions)this.Options).MaxMethodLength))
                        {
                            //function.StartPoint.Line
                            int functionLine = GetLine(functionName);
                            foundSmells.Add(new BadSmellRegistry(name, functionLine,currentFile,currentProject,currentSolution,false));
                        }
                    }
                }
            }
            foreach (var child in node.ChildNodes)
            { ParseNodeRec(child); }
        }

Answer 2

我不确定这是否是您所需要的，但您可以使用 CodeDom 和 CodeDom.Compiler 命名空间来编译 C# 代码，然后使用反射分析结果，例如：

        // Create assamblly in Memory
        CodeSnippetCompileUnit code = new CodeSnippetCompileUnit(classCode);
        CSharpCodeProvider provider = new CSharpCodeProvider();
        CompilerResults results = provider.CompileAssemblyFromDom(compileParams, code);
        foreach(var type in results.CompiledAssembly)
        {
              // Your analysis go here
        }

更新： 在 VS2015 中，您可以使用新的 C# 编译器（又名 Roslyn）来执行相同的操作，对于 示例：

var root = (CompilationUnitSyntax)tree.GetRoot();
var compilation = CSharpCompilation.Create("HelloTDN")
            .AddReferences(references: new[] { MetadataReference.CreateFromAssembly(typeof(object).Assembly) })
            .AddSyntaxTrees(tree);
var model = compilation.GetSemanticModel(tree);
var nameInfo = model.GetSymbolInfo(root.Usings[0].Name);
var systemSymbol = (INamespaceSymbol)nameInfo.Symbol;
foreach (var ns in systemSymbol.GetNamespaceMembers())
{
   Console.WriteLine(ns.Name);
}