# eel-ctools

**Repository Path**: ytablebear/eel-ctools

## Basic Information

- **Project Name**: eel-ctools
- **Description**: 代码辅助工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2023-12-07
- **Last Updated**: 2023-12-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# 1. 脚本说明

| script           | function                                    |
| :--------------- | :------------------------------------------ |
| formatspace.sh   | 删除多余空格，dos2unix                      |
| linux-as.sh      | astyle代码格式化脚本，Linux代码风格       |
| code-as.sh       | astyle代码格式化脚本，修改过的Linux代码风格 |
| code-indent.sh   | indent代码格式化脚本，基于linux scripts/Lindent修改，修改过的Linux代码风格 |
| keepdep_patch.sh | 修改编译脚本，保留编译过程中的.o.d文件      |
| depfilelist.sh   | 根本编译生成的.o.d文件生成依赖文件列表      |

linxu-as.sh和code-as.sh需要安装astyle。
code-indent.sh需安装indent。

# 2. cgraph说明
| script           | function                                                            |
| :--------------- | :------------------------------------------------------------------ |
| traildb.py       | sqlite3数据库转SourceTrailDB                                        |
| sourcetraildb.py | SourceTrailDB的python接口，内部是对_sourcetraildb.so的封装          |
| provider.py      | 对sqlite3、ciparser等的封装，也包含用于判断是否忽略函数的正则表达式 |
| dbserver.py      | sqlite3的封装                                                       |
| ciparser.py      | 解析.ci文件的脚本                                                   |
| filechk.py       | 用于判断文件是否更新                                                |
| gvcolor.py       | Graphviz颜色集合                                                    |
| gvrender.py      | 对.gv文件的node、edge、subgraph染色                                 |

gvrender.py需要安装python3和graphviz相关环境
```shell
apt install python3 graphviz libgraphviz-dev
apt install python3-pygraphviz
# python3 -m pip install pygraphviz
```


`sourcetraildb.py`和`_sourcetraildb.so`是基于`Debian 11`编译的，如果不能使用，可以参考《sourcetraildb编译》编译替换。

## 2.1. sourcetraildb编译

我这里使用的是v4.db25.p1的release，SourceTrailDB的官方说明有点问题，可以按如下步骤编译，最后在`SourcetrailDB/build/bindings_python/`目录下会生成`sourcetraildb.py`和`_sourcetraildb.so`，将其复制到cgraph目录即可。

```shell
git clone https://github.com/CoatiSoftware/SourcetrailDB.git

cd ./SourcetrailDB
mkdir build

cd build
cmake -DBUILD_BINDINGS_PYTHON=ON ../
make _bindings_python
```