PLOOC 项目使用教程

1. 项目目录结构及介绍

PLOOC 项目的目录结构如下：

PLOOC/
├── cmsis-pack/
│   └── GorgonMeducer_PLOOC_4.6.0.pack
├── example/
│   ├── byte_queue/
│   └── enhanced_byte_queue/
├── template/
│   ├── plooc.h
│   ├── plooc_class.h
│   ├── plooc_class_black_box.h
│   ├── plooc_class_simple.h
│   └── plooc_class_simple_c90.h
├── .gitignore
├── LICENSE
├── README.md
├── _config.yml
├── gen_pack.sh
└── plooc.h

目录介绍

• cmsis-pack/: 包含 PLOOC 的 CMSIS-Pack 文件，用于在 MDK 中快速集成 PLOOC 模板。
• example/: 包含 PLOOC 的使用示例，如 byte_queue 和 enhanced_byte_queue，展示了如何定义类、访问受保护成员等。
• template/: 包含 PLOOC 的核心模板文件，如 plooc.h、plooc_class.h 等，提供了面向对象编程的宏模板。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件，采用 Apache 2.0 许可证。
• README.md: 项目介绍和使用说明。
• _config.yml: 项目配置文件，用于 GitHub Pages 等。
• gen_pack.sh: 用于生成 CMSIS-Pack 的脚本。
• plooc.h: PLOOC 的核心头文件，包含了面向对象编程的宏定义。

2. 项目启动文件介绍

PLOOC 项目没有传统意义上的“启动文件”，因为它是一个库项目，主要提供宏模板和示例代码。开发者在使用 PLOOC 时，通常会根据需要引入相应的头文件，并参考示例代码进行开发。

核心启动文件

• plooc.h: 这是 PLOOC 的核心头文件，包含了面向对象编程所需的所有宏定义。开发者在使用 PLOOC 时，首先需要包含这个头文件。

#include "plooc.h"

3. 项目的配置文件介绍

PLOOC 项目的配置主要通过宏定义和模板文件来实现。以下是一些关键的配置文件和配置项：

配置文件

• plooc.h: 包含了 PLOOC 的核心配置宏，如 __OOC_DEBUG__ 用于调试时禁用私有成员保护。

#define __OOC_DEBUG__

• plooc_class.h: 提供了类的定义模板，开发者可以通过这个文件定义自己的类。

#include "plooc_class.h"

配置项

• OOC_DEBUG: 用于在调试时禁用私有成员保护，方便调试。
• PLOOC_CLASS_IMPLEMENT: 用于标识当前文件是类的实现文件。
• PLOOC_CLASS_INHERIT: 用于标识当前文件是类的继承文件。

示例配置

以下是一个简单的配置示例，展示了如何在项目中使用 PLOOC 进行面向对象编程：

#include "plooc.h"
#include "plooc_class.h"

// 定义一个类
declare_class(MyClass)
def_class(MyClass,
    public_member(
        // 公共成员
    )
    private_member(
        // 私有成员
    )
    protected_member(
        // 受保护成员
    )
)
end_def_class(MyClass)

// 类的构造函数
MyClass * MyClass_init(MyClass *ptObj, MyClass_cfg_t *ptCFG) {
    class_internal(ptObj, ptThis, MyClass)
    // 初始化代码
    return ptObj;
}

// 类的析构函数
void MyClass_depose(MyClass *ptObj) {
    class_internal(ptObj, ptThis, MyClass)
    // 析构代码
}

通过以上配置和示例，开发者可以快速上手使用 PLOOC 进行面向对象编程。