goldendict-ng / doc.txt
fasdfsa's picture
add wpfmdict
cffd9d0
// 连接主界面 Dock 面板上的输入框回车信号
connect( ui.translateLine, &QLineEdit::returnPressed, this, [ this ]() {
translateInputFinished( true );
} );
// 连接工具栏上的输入框回车信号
connect( translateBox, &TranslateBox::returnPressed, this, [ this ]() {
translateInputFinished( true );
} );
# 点击查询按钮触发
void MainWindow::translateInputFinished( bool checkModifiers )
{
QString word = Folding::unescapeWildcardSymbols( translateLine->text() );
respondToTranslationRequest( word, checkModifiers );
}
void MainWindow::respondToTranslationRequest( const QString & word, ... )
{
// ...
showTranslationFor( word, 0, scrollTo );
// ...
}
# 实际查询逻辑
首次设置词典路径时,GoldenDict-ng 会对 MDX 词典进行扫描并建立索引。这个过程主要涉及 **读取和解压 Key Blocks(关键字块)** 以获取词条列表,但通常 **不会解压 Record Blocks(记录块/正文内容)**。
以下是该逻辑的详细分析:
### 1. 入口与流程概览
当首次添加 MDX 文件时,系统会调用 `MdxDictionary::makeDictionaries` 函数来创建词典对象并构建索引。
* **文件位置**: `e:\huggingface\goldendict-ng\src\dict\mdx.cc`
* **核心函数**: `makeDictionaries`
该函数会遍历 MDX 文件,使用 `MdictParser` 解析器逐块读取数据。
### 2. 解压逻辑的核心:Key Blocks
MDX 文件的关键字(Headwords)存储在压缩的 Key Blocks 中。建立索引时,必须解压这些块才能获取单词列表。
* **调用链**: `makeDictionaries` -> `parser.readNextHeadWordIndex` -> `parseCompressedBlock`
* **文件位置**: `e:\huggingface\goldendict-ng\src\dict\mdictparser.cc`
#### 关键步骤:
1. **读取块信息**: `readNextHeadWordIndex` (第 131 行) 读取下一个 Key Block 的压缩大小和解压后大小。
2. **映射内存**: 使用 `ScopedMemMap` 将压缩数据映射到内存。
3. **解压块**: 调用 `parseCompressedBlock` (第 198 行) 进行解压。
* **支持格式**: MDX 支持 **LZO** (0x01000000) 和 **Zlib** (0x02000000) 两种压缩算法。
* **校验**: 解压后会校验 Adler32 或其他 Checksum。
4. **拆分词条**: 解压后的数据通过 `splitHeadWordBlock` 拆分成一个个独立的单词(Headwords)。
### 3. 正文数据处理(不解压)
在建立索引阶段,词典的正文内容(Record Blocks)通常 **不会被解压**。
* **处理类**: `ArticleHandler` (在 `mdx.cc` 中定义)
* **逻辑**: `makeDictionaries` 调用 `parser.readRecordBlock`,进而触发 `ArticleHandler::handleRecord`。
* **行为**: `handleRecord` 仅将词条的 **偏移量 (Offset)** 和 **压缩块信息 (RecordInfo)** 存储到 GoldenDict 的内部索引文件 (`.index`) 中,而不会去解压实际的释义内容。
### 4. 代码片段佐证
**`src/dict/mdictparser.cc` (解压逻辑):**
```cpp
bool MdictParser::parseCompressedBlock( qint64 compressedBlockSize, ... )
{
// ... 读取压缩类型 type ...
switch ( type ) {
case 0x01000000: // LZO compression
lzo1x_decompress_safe( ... );
break;
case 0x02000000: // zlib compression
zlibDecompress( ... );
break;
}
// ...
}
```
**`src/dict/mdx.cc` (索引构建循环):**
```cpp
// 遍历所有 HeadWord 块
while ( parser.readNextHeadWordIndex( headWordIndex ) ) {
// 这里会触发解压 Key Block
parser.readRecordBlock( headWordIndex, articleHandler );
}
```
### 总结
首次设置路径时:
1. **会解压**: 所有的 **Key Blocks** (为了拿到单词列表建立查找索引)。
2. **不会解压**: **Record Blocks** (正文数据保持压缩状态,仅记录其在文件中的位置,直到用户真正查询该词时才会在 `loadArticle` 中解压)。
这种设计保证了即使是巨大的 MDX 词典,首次索引的速度也相对较快,且索引文件体积较小。
创建的索引会被保存到磁盘文件中
在 e:\huggingface\goldendict-ng\src\dict\mdx.cc 的 MdxDictionary::makeDictionaries 函数中,可以明确看到索引被写入磁盘的逻辑。
### 索引保存机制
1. 保存位置 :
索引文件会保存在 indicesDir 指定的目录下。通常这个目录是用户配置文件夹下的 index 文件夹(例如在 Windows 上可能是 C:\Users\用户名\AppData\Roaming\GoldenDict\index ,或者便携版目录下的 index )。
2. 文件名生成 :
文件名并不是随机的,而是通过 Dictionary::makeDictionaryId 函数生成的。
- 生成规则 : 对词典文件的路径(如果是多个文件则包含所有文件)进行排序,然后计算其 MD5 哈希值 。
- 结果 : 这个哈希值(一串十六进制字符)就是索引文件的文件名。
- 代码位置 : e:\huggingface\goldendict-ng\src\dict\dictionary.cc 中的 makeDictionaryId 。
3. 写入过程 :
代码中使用 File::Index 类以 QIODevice::WriteOnly 模式打开该路径,并将构建好的 B-tree 索引数据写入其中。
```
// src/dict/mdx.cc
string dictId    = Dictionary::makeDictionaryId( dictFiles );
string indexFile = indicesDir + dictId; // 拼接目录和哈希ID
// ...
File::Index idx( indexFile, QIODevice::WriteOnly ); // 打开文件准备写入
// ...
BtreeIndexing::buildIndex( indexedWords, idx ); // 构建并写入索引
```
### 为什么保存到磁盘?
保存索引的主要目的是为了 加速启动和查询 。
- 首次加载 : 需要解压 Key Blocks 并扫描所有词条,这是一个耗时的过程。
- 后续加载 : 既然索引已经保存为磁盘文件,下次启动 GoldenDict 时,只需检查词典文件和索引文件的时间戳。如果词典没更新,就直接加载磁盘上的索引文件,瞬间完成初始化,无需再次扫描 MDX 文件。
### 总结
- 会保存吗? : 是。
- 保存在哪? : 配置目录下的 index 文件夹。
- 文件名是什么? : 词典文件路径的 MD5 哈希值。
代码位于 e:\huggingface\goldendict-ng\src\dict\dictionary.cc 文件中的 needToRebuildIndex 函数。
这个函数实现了检查词典文件和索引文件的时间戳逻辑,以决定是否需要重新建立索引。
### 代码位置
文件 : e:\huggingface\goldendict-ng\src\dict\dictionary.cc 函数 : Dictionary::needToRebuildIndex (第 667 行)
### 核心逻辑分析
该函数接收词典文件列表 ( dictionaryFiles ) 和索引文件路径 ( indexFile ),通过比较它们的最后修改时间来判断是否需要重建索引。
1. 检查强制重构标记 (第 669-684 行):
- 首先检查配置中是否有该词典 ID 的强制重构标记 ( dictionariesToReindex )。如果有,则返回 true 并清除标记。
2. 获取词典文件的最新修改时间 (第 686-715 行):
- 遍历所有词典源文件。
- 对于每个文件,获取其最后修改时间 ( lastModified )。
- 记录所有源文件中 最新 的那个时间戳。
3. 比较索引文件时间戳 (第 718-724 行):
- 检查索引文件是否存在。如果不存在,返回 true (需要构建)。
- 获取索引文件的最后修改时间。
- 判断条件 : 如果 索引文件时间 < 词典文件最新时间 ,则返回 true (说明词典更新了,索引过时);否则返回 false (直接使用旧索引)。
```
// 核心比较代码 (src/dict/dictionary.cc:724)
return fileInfo.lastModified().toSecsSinceEpoch() < lastModified;
```
### 如何“直接加载”?
当 needToRebuildIndex 返回 false 时,调用它的上层代码(如 MdxDictionary::makeDictionaries )会跳过构建索引的步骤,直接读取已存在的索引文件。
例如在 src/dict/mdx.cc :
```
if ( Dictionary::needToRebuildIndex( dictFiles, indexFile ) || indexIsOldOrBad( 
dictFiles, indexFile ) ) {
    // ... 构建索引的代码 ...
}
// 如果不满足上面的条件,代码继续执行,后续会直接使用 indexFile 加载词典对象
```