新建项目

2023-04-29 09:09:12 +08:00
1 parent 5e2e890cfc
commit 633d9b872b
@@ -0,0 +1,17 @@
+# cpp suport
+
+![standard](https://img.shields.io/badge/standard-c99-brightgreen.svg)
+![build](https://img.shields.io/badge/build-2021.01.17-brightgreen.svg)
+![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)
+
+`letter shell`cpp支持
+
+## 简介
+
+`cpp support`是用于扩展`letter shell`，使其可以在cpp环境中生效的组件，`cpp support`仅仅包含一个头文件
+
+## 使用
+
+`cpp support`仅仅提供了一个`shell_cpp.h`的头文件，用于在cpp文件中使用`letter shell`的命令导出，在使用时，需要在`.cpp`文件中包含`shell_cpp.h`，而不是`shell.h`，如果一个工程同时包含`.c`和`.cpp`文件，只需要分别包含对应的头文件即可
+
+注意，对于cpp，`letter shell`也仅支持函数的导出，不适用于类的成员函数
@@ -0,0 +1,155 @@
+/**
+ * @file shell_cpp.h
+ * @author Letter (nevermindzzt@gmail.com)
+ * @brief shell cpp support
+ * @version 1.0.0
+ * @date 2021-01-09
+ * 
+ * @copyright (c) 2021 Letter
+ * 
+ */
+#ifndef __SHELL_CPP_H__
+#define __SHELL_CPP_H__
+
+#ifdef __cplusplus
+extern "C" {
+
+#include "shell.h"
+
+/**
+ * @brief shell command cpp 支持 cmd 定义
+ */
+typedef struct shell_command_cpp_cmd
+{
+    int attr;                                                   /**< 属性 */
+    const char *name;                                           /**< 命令名 */
+    int (*function)();                                          /**< 命令执行函数 */
+    const char *desc;                                           /**< 命令描述 */
+} ShellCommandCppCmd;
+
+/**
+ * @brief shell command cpp 支持 var 定义
+ */
+typedef struct shell_command_cpp_var
+{
+    int attr;                                                   /**< 属性 */
+    const char *name;                                           /**< 变量名 */
+    void *value;                                                /**< 变量值 */
+    const char *desc;                                           /**< 变量描述 */
+} ShellCommandCppVar;
+
+/**
+ * @brief shell command cpp 支持 user 定义
+ */
+typedef struct shell_command_cpp_user
+{
+    int attr;                                                   /**< 属性 */
+    const char *name;                                           /**< 用户名 */
+    const char *password;                                       /**< 用户密码 */
+    const char *desc;                                           /**< 用户描述 */
+} ShellCommandCppUser;
+
+/**
+ * @brief shell command cpp 支持 key 定义
+ */
+typedef struct shell_command_cpp_key
+{
+    int attr;                                                   /**< 属性 */
+    int value;                                                  /**< 按键键值 */
+    void (*function)(Shell *);                                  /**< 按键执行函数 */
+    const char *desc;                                           /**< 按键描述 */
+} ShellCommandCppKey;
+
+#if SHELL_USING_CMD_EXPORT == 1
+
+    #undef SHELL_EXPORT_CMD
+    /**
+     * @brief shell 命令定义
+     * 
+     * @param _attr 命令属性
+     * @param _name 命令名
+     * @param _func 命令函数
+     * @param _desc 命令描述
+     */
+    #define SHELL_EXPORT_CMD(_attr, _name, _func, _desc) \
+            const char shellCmd##_name[] = #_name; \
+            const char shellDesc##_name[] = #_desc; \
+            extern "C" SHELL_USED const ShellCommandCppCmd \
+            shellCommand##_name SHELL_SECTION("shellCommand") =  \
+            { \
+                _attr, \
+                shellCmd##_name, \
+                (int (*)())_func, \
+                shellDesc##_name \
+            }
+
+    #undef SHELL_EXPORT_VAR
+    /**
+     * @brief shell 变量定义
+     * 
+     * @param _attr 变量属性
+     * @param _name 变量名
+     * @param _value 变量值
+     * @param _desc 变量描述
+     */
+    #define SHELL_EXPORT_VAR(_attr, _name, _value, _desc) \
+            const char shellCmd##_name[] = #_name; \
+            const char shellDesc##_name[] = #_desc; \
+            extern "C" SHELL_USED const ShellCommandCppVar \
+            shellVar##_name SHELL_SECTION("shellCommand") =  \
+            { \
+                _attr, \
+                shellCmd##_name, \
+                (void *)_value, \
+                shellDesc##_name \
+            }
+
+    #undef SHELL_EXPORT_USER
+    /**
+     * @brief shell 用户定义
+     * 
+     * @param _attr 用户属性
+     * @param _name 用户名
+     * @param _password 用户密码
+     * @param _desc 用户描述
+     */
+    #define SHELL_EXPORT_USER(_attr, _name, _password, _desc) \
+            const char shellCmd##_name[] = #_name; \
+            const char shellPassword##_name[] = #_password; \
+            const char shellDesc##_name[] = #_desc; \
+            extern "C" SHELL_USED const ShellCommandCppUser \
+            shellUser##_name SHELL_SECTION("shellCommand") =  \
+            { \
+                _attr|SHELL_CMD_TYPE(SHELL_TYPE_USER), \
+                shellCmd##_name, \
+                shellPassword##_name, \
+                shellDesc##_name \
+            }
+
+    #undef SHELL_EXPORT_KEY
+    /**
+     * @brief shell 按键定义
+     * 
+     * @param _attr 按键属性
+     * @param _value 按键键值
+     * @param _func 按键函数
+     * @param _desc 按键描述
+     */
+    #define SHELL_EXPORT_KEY(_attr, _value, _func, _desc) \
+            const char shellDesc##_value[] = #_desc; \
+            extern "C" SHELL_USED const ShellCommandCppKey \
+            shellKey##_value SHELL_SECTION("shellCommand") =  \
+            { \
+                _attr|SHELL_CMD_TYPE(SHELL_TYPE_KEY), \
+                _value, \
+                (void (*)(Shell *))_func, \
+                shellDesc##_value \
+            }
+#endif /** SHELL_USING_CMD_EXPORT == 1 */
+
+}
+#endif /**< defined __cplusplus */
+
+#endif /**< __SHELL_CPP_H__ */
+
+