源码阅读的一些想法

见识，见识，有见才有识。行万里路，才能见天地之广阔。读天下代码，见识自己的卑微。

我读代码的经历
- 刚接触计算机还是在高一上学期，学校申评省重点，于是有了机房，有了几台有模有样的386还是486，对学生们来说也仅仅限于观赏和打打字母，后来网吧逐渐兴起，实际也不是网吧，有电脑但是没有网，电脑上有仙剑，我最早玩的游戏，包了几宿也没通关【汗！】。
- 上大学刚开始，中关村卖盘卖电脑如火如荼，一年后隔壁北理工的同学领着我用打工，家里资助，省吃俭用的钱买了一台性能不怎么强，软驱还有点问题的台式机，再后来无数光盘涌来，游戏盘，电影盘，电脑报附赠盘等等。影响最大的还是电影盘“黑客帝国”，太震撼了，于是决定投身于电脑编程了，第一个程序就是j2me老虎机，第二个则是黑客帝国片头，就是那个很酷的，背景绿色文字滚动的效果。
- 第一本有源代码的书是“Java编程”，现在看来是最普通甚至会有些错误的书，我把书里所有代码用一个学期的时间全部用记事本输入到了电脑里，看看怎么执行的。我的想法是先有感官上的认识，再去做理性思考。当时的电脑报还是各种电脑大杂烩，介绍各种电脑知识，维修技巧，也有些编程技术介绍，无意中看到介绍了j2me编程（实际最初是日本的doja），然后开始花钱用56K的猫上网，访问sun公司的官网以及台湾一位医生办的网站，他用来介绍他如何给医用设备编程，我则用在了游戏编程。
- 很幸运，我用J2me的知识在找工作上所向披靡，但是受制于见识的原因，很容易就满足了，没有更高的目标，甚至不知道什么是目标。我去了Gameloft做游戏，用现在的话来说每天都很卷，没时间读代码。后来去了GluMobile,这个时候开始读代码了。我把我想读的代码全部打印出来，地铁回家就会读一读，无法做批注，无法分享，无法跟其他人交流，无法积累。在GluMobile一共移植了60多款游戏，见识了大量的手机游戏源代码和编辑器，这为我后来的游戏编辑器提供了大量的思路，不过仅剩的也只是脑子里的不多的印象很深刻的部分。移植call of duty到阿拉伯语言就是我的得意之作。
- 从GluMobile来到腾讯之后，同事们都非常优秀，我有种很强的被驱动的力量，我定下了很宏大的阅读源代码的目标，比如linux，mysql，redis，nginx，Orge游戏引擎，天龙八部源代码，等等等等，随着时间的推移，这个目标根本就是好高骛远，基本上一个都没完成，甚至都不算开始。
- 从腾讯离开创业散伙之后，年龄也到了网传的35岁临界值，心灰意冷，人生低谷，直到马斯克炸火箭搞火箭回收，后来产能地狱睡工厂，咦，这个可以作偶像。我的心态很快又恢复过来，开始追求进步。
- 18年我开始用ipad看代码，当时github也被微软收购，这个阶段涌现的各种阅读工具虽然不是我理想的状态，但是已经比打印代码在纸上看已经好了非常多。但是对于代码庞大的经典项目来说还是会有很多障碍，最大的问题是流行的各种读代码的app都不能实现像IDE一样的代码阅读方式。于是我开始萌生了自己写一个能够满足自己代码阅读需求的源码阅读器。第一个版本使用我的游戏引擎开发，理由是可以跨平台，进入状态还比较顺利，token分词，关键词跳转，部分顶级的定义跳转都支持得很好，从一个类跳转另一个类也还比较方便，不过最后始终无法取得更大的突破，离现实还是很遥远。
- 接下来我开始思考官方的IDE是如何做到，于是开始打开思路，于是了解到编译原理的重要，于是买了龙书，于是深入了llvm/clang的前端处理，于是了解到熟悉AbstractSyntaxTree，一发而不可收拾，至少有两年时间我非常热衷于这方面，我认识到编译原理是计算机科学非常重要的基石。经过主页里展示的那些源代码是我做源码阅读器之前需要深入了解的，clang代码我在3年前就在读了，go和java的代码是这两个月开始读的。
- 目前C++，GO，JAVA的源码阅读器的变量，类，方法等声明和引用已经基本解析完，虽然还有badcase以及界面操作上需要优化，但是做到跟IDE一样只是时间和精力的问题。当然，移动端的使用体验会是一个非常大的挑战，目前没有参考，但是我也已经有了一些思路

我是怎么做源码阅读的

通过读Clang,Gopls,JavaParser，EclipseJDT 基本上都是通过AST（AbstractSyntaxTree）来实现相关的操作的，不过有了AST之后并不能很容易做到IDE一样的功能，还需要进一步加工

目标：
1. 所有常量，变量，类，结构体，方法的定义都必须找到，主要是三个关键参数：文件，行，列
2. 所有对常量，变量，类，结构体，方法的引用都必须找到，主要是四个关键参数：文件，行，列，目标位置（文件，行，列）

考虑点：
1. 通过阅读代码，从AST到实现目标，每种语言实现的方式是不一样的
2. 我虽然读了Clang,GoPls，JavaParser和EclipseJDT，但是因为我要做的使用一个统一的方式解决所有语言的类似的功能，因此我目前了解到是无法使用其中任何一个语言的做法去统一其他语言，因此我选择了自己在AST的基础上做一个统一的思路，这个思路是可以使用到任何一种语言的。或许我是错的，但是我目前发现不了错误，望大家看后指出致命的问题
3. 我还要考虑处理性能，AST遍历一次能搞定，我绝不遍历两次，目前AST仅仅遍历的一次，不过还会对AST遍历之后的结果进行有限的遍历，实际还是有优化空间的。
4. 从获取AST的角度，实际有一个更好的解决方案那就是ANTLR，这个工程思路非常赞，也是用统一的思路来解决源代码解析到AST的方案，基本原理适用于任何语言。但是我了解不深，因为时间关系，我还是采用原生的方式处理，因为在后续将功能延伸到编译器后端时不用从头开始，而且会较大优势。
5. 以上观点是基于我目前的知识得出的认知，后续我会用这个源码阅读器详细阅读相关代码，搞懂比较底层的原理之后，再回过头来看看我的判断对不对。

我的实现方式：

获取AST分别用各语言的原生工具，如C++用clang（gcc不清楚能不能用，源码浏览器好用之后，打算尝试下），go用go自带的go/ast， java用javaparser或者eclipse jdt（我最终使用的eclipse jdt）
在Visit AST的时候，在重要层级挂载scope树，每个树下的常量，变量，类，结构体，方法的声明都挂在该级别树下。
在Visit AST的时候，对每个引用生成use_path，后续在引用跳转到定义时需要根据这个use_path来查找

use_path的规则，这个是我所做的源码阅读的最重要的部分，这个use_path要统一所有的语言查找方式：

以下面的代码为例：

177	testresult := abc.SayGood2("").SayGoodTest("").Sub.SayGood("")
178	fmt.Printf("test%s", testresult)

testresult的定义在177行
查找178行的时候需要根据“abc(0).SayGood2(1).SayGoodTest(1).Sub(0).SayGood(1)[0]”来查找
abc(0)：0表示这是abc是变量引用
SayGood2(1)：1表示这是一个方法使用
SayGood(1)[0]：[]里的0表示SayGood方法的第一个返回结果（go语言里方法是会返回多个结果的）

94	var testStructSubMethodMap map[string]*TestStructSubMethod
95	for index, item := range testStructSubMethodMap {
96	fmt.Printf("%d, %s", index, item.methodTest)
97	}

map的path定义{string,TestStructSubMethod},格式为{key,value}
95行的testStructSubMethodMap的use_path为："ts(0).TestStructSubMethodMapMap(0)<1>"
<>里的1表示是map的value, 如果是0则表示是<key>
通过[数字],[.],[<>],[[]],[{}]的使用，再配合case by case的搜索逻辑，基本实现所有引用的定义查找，目前工作良好

一些收获（因为还未完全理解三种语言的底层设计，可能存在理解错误，不过代码读够了，后续会逐步清晰和纠正）
- AST获取java的信息最完备，最方便，但是性能我觉得要慢不少，可能是遍历了多次的原因，很多年前我就认为java语言的设计是最优秀的，api的使用非常直接，构建也非常合理, 以至于我在做C++ SDK时都会参考JAVA的设计模式
- C/C++的编译速度慢的原因是因为include文件的ast不是共享的，每次cpp引用header都要重新解析一遍AST。如果header的AST能够共享就好了，不过这也会给分布式编译带来一些难题
- 综合来讲go语言的语法规则比较多，某些地方还比较反人类，java的语法规则感觉最为工整，c/c++则感觉有些乱，有很多地方完全可以借鉴java

飞书文档是一项伟大的发明，原因我会在后续功能开发过程的记录中逐步展开，先卖个关子。

先写这些，后续会抓紧深入优化