# CommunicationToolGUI

**Repository Path**: lewque/communication-tool-gui

## Basic Information

- **Project Name**: CommunicationToolGUI
- **Description**: 这是一个基于MFC的Windows图形界面应用程序，用于为ModemFileTransferTool控制台程序提供友好的用户界面。该项目实现了文件传输的可视化操作，支持Ymodem和Zmodem协议，以及TCP和串口通信。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-12-14
- **Last Updated**: 2025-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 通信工具GUI - 中文说明文档

## 项目概述

这是一个基于MFC的Windows图形界面应用程序，用于为ModemFileTransferTool控制台程序提供友好的用户界面。该项目实现了文件传输的可视化操作，支持Ymodem和Zmodem协议，以及TCP和串口通信。

## 系统架构

### 设计理念
- **双应用程序架构**: GUI程序和控制台程序完全分离
- **进程间通信**: GUI通过子进程调用控制台程序
- **实时监控**: 捕获控制台程序的输出并实时显示
- **用户友好**: 提供直观的图形界面替代命令行操作

### 核心组件

#### 1. 主窗口类 (CSimpleMainWindow)
- **文件位置**: `Inc/SimpleMainWindow.h`, `Src/SimpleMainWindow.cpp`
- **继承关系**: 继承自MFC的`CFrameWnd`类
- **职责**:
  - 创建和管理所有UI控件
  - 处理用户交互事件
  - 协调文件传输操作
  - 显示实时输出信息

#### 2. 控制台包装器类 (CConsoleWrapper)
- **文件位置**: `Inc/ConsoleWrapper.h`, `Src/ConsoleWrapper.cpp`
- **职责**:
  - 创建和管理子进程
  - 捕获控制台程序的stdout和stderr输出
  - 提供进程终止功能
  - 处理进程退出事件

## UI控件详细说明

### 文件选择区域
- **文件路径编辑框** (`m_pEditFilePath`): 显示选中的文件路径（只读）
- **浏览文件按钮** (`m_pBtnBrowse`): 打开文件选择对话框

### 协议配置区域
- **协议下拉框** (`m_pComboProtocol`): 选择传输协议
  - Ymodem: 适合单文件传输
  - Zmodem: 支持批量文件传输，自动错误恢复
- **通信类型下拉框** (`m_pComboCommType`): 选择通信方式
  - TCP: 网络传输，需要IP地址和端口
  - Serial: 串口传输，需要串口名和波特率

### 连接配置区域
- **地址编辑框** (`m_pEditAddress`): 输入IP地址或串口名称
  - TCP模式: 输入目标IP地址 (如: 192.168.1.100)
  - Serial模式: 输入串口名称 (如: COM1)
- **端口编辑框** (`m_pEditPort`): 输入端口号或波特率
  - TCP模式: 输入端口号 (如: 8080)
  - Serial模式: 输入波特率 (如: 115200)

### 操作按钮区域
- **执行传输按钮** (`m_pBtnExecute`): 启动/停止文件传输
  - 功能1: 启动传输（按钮文字: "Execute Transfer"）
  - 功能2: 停止传输（按钮文字: "Stop Transfer"）
- **关于按钮** (`m_pBtnAbout`): 显示程序信息

### 信息显示区域
- **输出显示框** (`m_pEditOutput`): 多行文本框，显示：
  - 程序运行日志
  - 控制台程序的实时输出
  - 错误信息和状态更新
- **状态栏** (`m_pStaticStatus`): 显示当前操作状态

## 关键功能实现

### 1. 文件传输流程

```cpp
// 参数验证 -> 构建命令行 -> 执行程序 -> 监控输出 -> 处理结果
bool CSimpleMainWindow::ExecuteFileTransfer()
{
    // 1. 验证文件存在性
    // 2. 验证工具可用性
    // 3. 获取用户配置
    // 4. 构建命令行参数
    // 5. 设置回调函数
    // 6. 启动子进程
}
```

### 2. 实时输出处理

```cpp
// 输出回调 - 处理控制台程序的标准输出和错误输出
void CSimpleMainWindow::OnToolOutput(const std::string& output, bool isError)
{
    // 转换字符串格式
    // 添加时间戳
    // 显示在输出框中
}

// 退出回调 - 处理程序退出事件
void CSimpleMainWindow::OnToolExit(int exitCode)
{
    // 检查退出码
    // 显示结果状态
    // 重置界面状态
}
```

### 3. UI控件动态创建

所有UI控件都通过代码动态创建，无需资源文件：

```cpp
void CSimpleMainWindow::CreateControls()
{
    // 创建各种控件
    m_pEditFilePath = new CEdit();
    m_pEditFilePath->Create(WS_CHILD | WS_VISIBLE | WS_BORDER, rect, this, ID);
    
    // 设置控件属性
    // 添加初始数据
}
```

## 消息映射机制

MFC使用消息映射将Windows消息和用户操作映射到处理函数：

```cpp
BEGIN_MESSAGE_MAP(CSimpleMainWindow, CFrameWnd)
    ON_WM_CREATE()                                    // 窗口创建
    ON_WM_CLOSE()                                     // 窗口关闭
    ON_WM_SIZE()                                      // 窗口大小改变
    ON_BN_CLICKED(ID_BTN_BROWSE, OnBtnBrowseFile)     // 按钮点击
    ON_BN_CLICKED(ID_BTN_EXECUTE, OnBtnExecute)       // 按钮点击
END_MESSAGE_MAP()
```

## 编译和构建

### 构建系统
- **CMake**: 现代C++构建系统
- **Visual Studio 2022**: 推荐的IDE环境
- **MFC库**: Microsoft Foundation Classes

### 构建步骤

```bash
# 1. 创建构建目录
mkdir build && cd build

# 2. 生成项目文件
cmake .. -G "Visual Studio 17 2022"

# 3. 编译项目
cmake --build . --config Release
```

### 依赖要求
- Windows SDK
- Visual Studio C++ 工具集
- MFC开发库
- CMake 3.16+

## 目录结构

```
CommunicationToolGUI/
├── Inc/                          # 头文件目录
│   ├── SimpleMainWindow.h        # 主窗口类定义
│   ├── ConsoleWrapper.h          # 控制台包装器定义
│   └── CommunicationToolApp.h    # 应用程序类定义
├── Src/                          # 源文件目录
│   ├── SimpleMainWindow.cpp      # 主窗口实现
│   ├── ConsoleWrapper.cpp        # 控制台包装器实现
│   └── CommunicationToolApp.cpp  # 应用程序入口
├── build/                        # 构建输出目录
│   └── bin/Release/              # 可执行文件目录
├── CMakeLists.txt               # CMake配置文件
└── README_CN.md                 # 中文说明文档
```

## 使用方法

### 基本操作流程

1. **启动程序**: 运行`CommunicationToolGUI.exe`
2. **选择文件**: 点击"Browse File..."选择要传输的文件
3. **配置协议**: 选择Ymodem或Zmodem协议
4. **设置通信**: 选择TCP或Serial，并配置相应参数
5. **开始传输**: 点击"Execute Transfer"开始传输
6. **监控进度**: 在输出区域查看传输状态
7. **完成传输**: 传输完成后查看结果

### 常见配置示例

#### TCP网络传输
- 协议: Ymodem
- 通信类型: TCP
- 地址: 192.168.1.100
- 端口: 8080

#### 串口传输
- 协议: Zmodem
- 通信类型: Serial  
- 地址: COM3
- 端口: 115200

## 错误处理

### 常见错误及解决方案

1. **"No File Selected"**: 请先选择要传输的文件
2. **"File Not Found"**: 所选文件不存在，请重新选择
3. **"Tool Not Found"**: ModemFileTransferTool.exe未找到，请确保已正确构建
4. **"Invalid Settings"**: 地址或端口配置无效，请检查输入

### 调试信息

程序在输出区域提供详细的调试信息：
- 文件选择确认
- 参数配置信息  
- 命令行构建结果
- 执行过程输出
- 错误信息显示

## 扩展功能建议

### 可添加的功能
1. **配置保存**: 保存用户的常用配置
2. **传输历史**: 记录传输历史和统计信息
3. **多文件传输**: 支持批量文件选择
4. **进度条**: 可视化传输进度显示
5. **日志导出**: 将输出信息保存到文件

### 代码扩展点
- `CreateControls()`: 添加新的UI控件
- `ExecuteFileTransfer()`: 扩展传输逻辑
- `OnToolOutput()`: 增强输出处理
- `ConsoleWrapper`: 添加更多进程管理功能

## 技术特点

### MFC框架优势
- **原生Windows体验**: 完全符合Windows界面标准
- **资源效率高**: 编译后体积小，运行速度快
- **兼容性好**: 支持Windows 7及以上版本
- **开发效率高**: 丰富的控件库和框架支持

### 设计模式应用
- **观察者模式**: 回调函数处理进程输出
- **工厂模式**: 动态创建UI控件
- **包装器模式**: ConsoleWrapper封装进程操作
- **单例模式**: 应用程序实例管理

## 维护说明

### 代码修改注意事项
1. **内存管理**: MFC会自动销毁子控件，但要注意智能指针的使用
2. **字符串处理**: 注意Unicode和ANSI字符串的转换
3. **消息映射**: 添加新按钮时记得更新消息映射表
4. **错误处理**: 所有用户操作都应该有适当的错误检查

### 性能优化建议
1. **输出缓冲**: 限制输出文本长度，避免内存过度占用
2. **界面响应**: 长时间操作时考虑使用多线程
3. **资源释放**: 及时关闭文件句柄和进程句柄

## 版本历史

- **v1.0.0**: 初始版本，实现基本的GUI功能
  - 文件选择和传输界面
  - Ymodem/Zmodem协议支持
  - TCP/串口通信配置
  - 实时输出显示

## 联系信息

如有问题或建议，请参考源代码注释或联系开发团队。

---

*本文档最后更新时间: 2024年*