分享一个嵌入式代码生成器设计思路!

原创 嵌入式大杂烩 2024-09-14 11:38

大家好,我是杂烩君。

在之前转载的文章:嵌入式中,我们如何面对单调重复的任务?中,李先静前辈提到一点:让电脑去做单调重复的工作。

这点让我很受启发,在工作中需要这类重复性的工作时,我也会编写代码生成器来帮我处理。最近,又完成了一个代码生成器的开发,一键生成大部分原本需要靠体力输出的相似代码,极大地提高了开发效率。

业内知名的代码生成器有很多,如:STM32CubeMX生成STM32基础库代码、project_generator生成器生成基础工程、protoc生成protobuf协数据格式代码等。

project_generator相关文章:嵌入式项目生成器,了解一下!

protoc工具会解析xxx.proto文件并生成对应的xxx.pb-.c及xxx.pb-c.h:

protobuf相关:一种更轻量的数据格式——protobuf、干货 | protobuf-c之嵌入式平台使用

AI时代,各种AI辅助编程工具也很多,可以用来快速生成一些工具代码。比如:

  • MarsCode:豆包旗下的智能编程助手,提供智能代码补全等核心能力。支持主流编程语言及IDE,能在编码过程中提供单行或整个函数的建议,同时支持代码解释、单测生成、问题修复、技术问答等辅助功能。
  • GitHub Copilot:一款广为人知的代码编程辅助AI工具,由GitHub和OpenAI合作开发。基于OpenAI Codex模型,能够在各种编程环境中提供代码建议,支持多种编程语言。通过学习大量代码库,帮助开发者提高编码效率和质量。
  • CodeGeeX:CodeGeeX是一款基于智谱AI大模型GLM的强大智能编程助手,提供代码生成/完成、注释生成、代码翻译和基于人工智能的聊天等功能。支持多种编程语言,如Python、C++、Java、JavaScript等,并且适配多种主流IDE。

但是,在我们实际项目中,有些相似性比较高、重复性比较高、更新迭代过程需要频繁新增的一些需要复制、粘贴、然后再进行修改的代码。

以上这些代码生成的手段对我们的帮助可能比较有限。这时候我们可以自己根据自己的项目代码,定制化地写个代码自动生成的小软件/小脚本。

写代码生成工具之前,需要自己评估一下,这个事情是否值得做。因为如果你花了很大力气写了一个辅助工具,结果使用的频次很少,也不是很有必要。或者在某个文件生成几行代码,这手动适配也花不了多少时间,收益不是很大。

我觉得,需要频繁地修改到若干个文件的多处代码,这才比较有必要去写个代码生成工具。比如协议数据新增方面,就是个更新迭代可能会频繁修改的东西吧?

只要一条数据通了,后续新增是不是都会复制粘贴然后修改?

而且有些项目代码分层会比较细,数据传输链路可能会经过多层代码的多个文件,都需要做对应的修改。这手动适配起来费时费力,还容易搞错,复制粘贴,结果某一处忘记修改了没检查到,跑不通又得来回调试。

废话不多说,如果大家也遇到这种情况,那就自己写个代码生成工具吧,然后之后就可以快乐的摸鱼了。

思路很简单,在哪个位置,生成什么代码。我们可以根据需要自己评估是否有必要开发带图形界面的代码生成器,如果是自己使用,那就无所谓,怎么省时怎么来。

下面看看使用shell脚本来生成的例子。

例子

首先我们需要思考两个点:

"生成怎么样的代码?"

脚本处理的优势就是处理一些重复性的、相似性的事情。所以要想脚本生成代码,就得在写代码时有意识地构造脚本能找到一些共性的代码。

”在哪个位置插入代码?“

这个条件从原有的代码里可能不太好确定,为了脚本能简单点,这个条件我们可以自己构造:以注释的形式在想要插入代码的地方做个标记

脚本去匹配代码里的这些标记,然后插入想要插入的代码即可。

废话不多说,直接看例子:

假如我们有这么一份代码:读取命令行的测试指令并执行对应的测试代码。

test.c:

// 公众号:嵌入式大杂烩
#include 
#include 
#include 
#include 
#include 

#define int8   char
#define uint8  unsigned char
#define uint16 unsigned short int

typedef enum cmd_id_e
{
    CMD_ID_TEST_RAND,
    CMD_ID_TEST_MAX,
}cmd_id_t;

#define TO_CMD_ID_STR(cmd_id) #cmd_id

typedef int (*cmd_func_t)(void);  

typedef struct cmd_s
{

    cmd_id_t cmd_id;
    cmd_func_t cmd_func;
}cmd_t;


static int rand_test_func(void)
{
 printf("--------------------%s start!--------------------\n",__FUNCTION__);
 int a = 0;
 srand((unsigned)time(NULL));
 a = rand() % 10;  
 printf("%d\n", a);
 printf("--------------------%s end!--------------------\n",__FUNCTION__);
 printf("\n");
}

static cmd_t s_cmd_table[CMD_ID_TEST_MAX] = 
{  
    {CMD_ID_TEST_RAND, rand_test_func},  
};  

static void execute_cmd(cmd_id_t cmd_id) 
{  
    if (cmd_id > CMD_ID_TEST_MAX)
    {
        printf("[%s]Invalid param\n", __FUNCTION__);  
        return
    }

    for (int i = 0; i < CMD_ID_TEST_MAX; i++) 
    {  
        if (s_cmd_table[i].cmd_id == cmd_id) 
        {  
            s_cmd_table[i].cmd_func();  
            return;  
        }  
    }  


cmd_id_t menu_select(void)
{
 cmd_id_t cmd_id = CMD_ID_TEST_MAX;
 char str[64] = {0};
 
    printf("=============================================================================\n");
 printf("[%.3d] Test: %s\n", CMD_ID_TEST_RAND, TO_CMD_ID_STR(CMD_ID_TEST_RAND));
    printf("=============================================================================\n");

 do
 {
  printf("Enter your choice: ");
  scanf("%s", str);
  cmd_id = atoi(str);
 }while(cmd_id < 0 || cmd_id > CMD_ID_TEST_MAX);
 
 return cmd_id;
}

int main(void)
{
 cmd_id_t cmd_id = CMD_ID_TEST_MAX;
 
 while(1)  
 {
  cmd_id = menu_select();
        execute_cmd(cmd_id);
        usleep(1000 * 1000);
 }
 
 return 0;
}

这个测试代码,目前只有一个测试函数,之后每次新增测试函数,需要新增如下代码:

  • 命令id枚举,新增枚举值。
  • 新增测试函数函数体。
  • 补充命令表。
  • 补充菜单函数。

按照上面说的思路,我们在这四个地方以注释的形式插入代码插入点标签:

// code_insertion_point__cmd_id
// code_insertion_point__cmd_func
// code_insertion_point__cmd_table
// code_insertion_point__cmd_description

插入的代码?

提取公共部分,补充差异。这个例子中,为了脚本能简单点,我们可以依赖于CMD_ID_TEST_RAND,因为这里的信息可以区分不同的命令,比如新的命令就是CMD_ID_XXX格式的。

其它几个插入点的代码都可依赖这个生成。假如我们的脚本名称为code_generator.sh,我们期望最终的使用方式如:

./code_generator.sh CMD_ID_XXX

shell基本知识:Shell编程必备简明基础知识!

编写shell脚本:code_generator.sh

#!/bin/bash

code_generate__cmd_id()
{
    APPEND_STR=$1
    DST_FILE_PATH=$2
    sed -i "/\/\/ code_insertion_point__cmd_id/i \\$APPEND_STR" $DST_FILE_PATH
}

code_generate__cmd_func()
{
    APPEND_STR=$1
    DST_FILE_PATH=$2
    sed -i "/\/\/ code_insertion_point__cmd_func/i \\$APPEND_STR" $DST_FILE_PATH
}

code_generate__cmd_table()
{
    APPEND_STR=$1
    DST_FILE_PATH=$2
    sed -i "/\/\/ code_insertion_point__cmd_table/i \\$APPEND_STR" $DST_FILE_PATH
}

code_generate__cmd_description()
{
    APPEND_STR=$1
    DST_FILE_PATH=$2
    sed -i "/\/\/ code_insertion_point__cmd_description/i \\$APPEND_STR" $DST_FILE_PATH
}

code_generate()
{
    CMD_ID_STR=$1

    DST_FILE_PATH="./test.c"
    TAB_SPACE="    "

    # code_insertion_point__cmd_id
    echo "CMD_ID_STR = ${CMD_ID_STR}"
    CMD_ID_APPEND_STR="${TAB_SPACE}${CMD_ID_STR},"
    echo "CMD_ID_APPEND_STR = ${CMD_ID_APPEND_STR}"

    code_generate__cmd_id "${CMD_ID_APPEND_STR}" "${DST_FILE_PATH}"

    # code_insertion_point__cmd_table
    CMD_FLAG="${CMD_ID_STR##*_}" 
    echo "CMD_FLAG = ${CMD_FLAG}"
    CMD_FUNC_STR="${CMD_FLAG,,}_test_func"
    echo "CMD_FUNC_STR = ${CMD_FUNC_STR}"

    CMD_TABLE_APPEND_STR="${TAB_SPACE}{${CMD_ID_STR}${CMD_FUNC_STR}},"
    code_generate__cmd_table "${CMD_TABLE_APPEND_STR}" "${DST_FILE_PATH}"

    # code_insertion_point__cmd_description
    CMD_DSCRIPTION_APPEND_STR="${TAB_SPACE}printf(\"[%.3d] Test: %s\\\n\", ${CMD_ID_STR}, TO_CMD_ID_STR(${CMD_ID_STR}));"
    echo "CMD_DSCRIPTION_APPEND_STR = ${CMD_DSCRIPTION_APPEND_STR}"
    code_generate__cmd_description "${CMD_DSCRIPTION_APPEND_STR}" "${DST_FILE_PATH}"

    # code_insertion_point__cmd_func
    CMD_FUNC_STR_PART1="static int ${CMD_FUNC_STR}(void)\n{\n"
    CMD_FUNC_STR_PART2="${TAB_SPACE}printf(\"--------------------%s start!--------------------\\\n\",__FUNCTION__);\n"
    CMD_FUNC_STR_PART3="${TAB_SPACE}\/\/ todo: add your code\n"
    CMD_FUNC_STR_PART4="${TAB_SPACE}printf(\"--------------------%s end!--------------------\\\n\",__FUNCTION__);\n"
    CMD_FUNC_STR_PART5="${TAB_SPACE}printf(\"\\\n\");\n}"
    CMD_FUNC_APPEND_STR=${CMD_FUNC_STR_PART1}${CMD_FUNC_STR_PART2}${CMD_FUNC_STR_PART3}${CMD_FUNC_STR_PART4}${CMD_FUNC_STR_PART5}
    echo "CMD_FUNC_APPEND_STR = ${CMD_FUNC_APPEND_STR}"
    code_generate__cmd_func "${CMD_FUNC_APPEND_STR}" "${DST_FILE_PATH}"
}

code_generate $1

测试:

生成的代码:

一些代码细节,代码生成脚本不能事先知道,生成时可以统一备注:

// todo: add your code

方便后续填充代码。

编译、执行:

可见,我们写的代码生成脚本帮我们生成的代码,执行也是符合预期的。

以上只是提供了一个简单的代码生成脚本的思路及很理想情况下的demo,实现方式可能有多种,大家可以自己思考挖掘。

并且实际项目中的情况会复杂得多。

特别是处理代码格式,如果需要脚本做,脚本就会比较复杂了,比如:

  • 代码中间的不定空格数?

  • 代码增加注释?

  • ......

需要下很大的功夫。有时候需要做一些取舍,比如,假如上面的命令表代码为:

此时中间的空格长度根据命令的长度不一而是一个变化的值,脚本要去处理这个事情就需要做不少逻辑,这会增加一些脚本的开发时间。

最后,再说一下:

写代码生成工具之前,需要自己评估一下,这个事情是否值得做。因为如果你花了很大力气写了一个辅助工具,结果使用的频次很少,也不是很有必要。或者在某个文件生成几行代码,这手动适配也花不了多少时间,收益不是很大。

本文的c_test及脚本,可在【嵌入式大杂烩】公众号回复关键词:代码生成脚本 ,即可获取。


猜你喜欢:

WiFi6+蓝牙+星闪,三合一开发板,真香!

Github上热门 C 语言项目汇总!

嵌入式,可测试性软件设计!

一些低功耗软件设计的要点!

嵌入式 C 保护结构体的方式

实用 | 10分钟教你通过网页点灯

谈谈嵌入式软件的兼容性!

点击阅读原文,查看更多分享。

嵌入式大杂烩 专注于嵌入式技术,包括但不限于C/C++、嵌入式、物联网、Linux等编程学习笔记,同时,内包含大量的学习资源。欢迎关注,一同交流学习,共同进步!
评论
  • 在海洋监测领域,基于无人艇能够实现高效、实时、自动化的海洋数据采集,从而为海洋环境保护、资源开发等提供有力支持。其中,无人艇的控制算法训练往往需要大量高质量的数据支持。然而,海洋数据采集也面临数据噪声和误差、数据融合与协同和复杂海洋环境适应等诸多挑战,制约着无人艇技术的发展。针对这些挑战,我们探索并推出一套基于多传感器融合的海洋数据采集系统,能够高效地采集和处理海洋环境中的多维度数据,为无人艇的自主航行和控制算法训练提供高质量的数据支持。一、方案架构无人艇要在复杂海上环境中实现自主导航,尤其是完
    康谋 2025-03-13 09:53 44浏览
  • 一、行业背景与需求痛点智能电子指纹锁作为智能家居的核心入口,近年来市场规模持续增长,用户对产品的功能性、安全性和设计紧凑性提出更高要求:极致空间利用率:锁体内部PCB空间有限,需高度集成化设计。语音交互需求:操作引导(如指纹识别状态、低电量提醒)、安全告警(防撬、试错报警)等语音反馈。智能化扩展能力:集成传感器以增强安全性(如温度监测、防撬检测)和用户体验。成本与可靠性平衡:在复杂环境下确保低功耗、高稳定性,同时控制硬件成本。WTV380-P(QFN32)语音芯片凭借4mm×4mm超小封装、多传
    广州唯创电子 2025-03-13 09:24 41浏览
  •        随着人工智能算力集群的爆发式增长,以及5.5G/6G通信技术的演进,网络数据传输速率的需求正以每年30%的速度递增。万兆以太网(10G Base-T)作为支撑下一代数据中心、高端交换机的核心组件,其性能直接决定了网络设备的稳定性与效率。然而,万兆网络变压器的技术门槛极高:回波损耗需低于-20dB(比千兆产品严格30%),耐压值需突破1500V(传统产品仅为1000V),且需在高频信号下抑制电磁干扰。全球仅有6家企业具备规模化量产能力,而美信科
    中科领创 2025-03-13 11:24 40浏览
  • 北京时间3月11日,国内领先的二手消费电子产品交易和服务平台万物新生(爱回收)集团(纽交所股票代码:RERE)发布2024财年第四季度和全年业绩报告。财报显示,2024年第四季度万物新生集团总收入48.5亿元,超出业绩指引,同比增长25.2%。单季non-GAAP经营利润1.3亿元(non-GAAP口径,即经调整口径,均不含员工股权激励费用、无形资产摊销及因收购产生的递延成本,下同),并汇报创历史新高的GAAP净利润7742万元,同比增长近27倍。总览全年,万物新生总收入同比增长25.9%达到1
    华尔街科技眼 2025-03-13 12:23 47浏览
  • 本文介绍OpenHarmony4.1系统开发板,出现打不开WiFi和蓝牙的问题排查和解决方法。触觉智能Purple Pi OH鸿蒙开发板演示,搭载了瑞芯微RK3566四核处理器,1TOPS算力NPU;Laval鸿蒙社区推荐并通过了开源鸿蒙XTS认证,成功适配OpenHarmony3.2、4.0、4.1、5.0 Release系统,SDK源码全开放!WiFi打不开缺少WiFi固件在WiFi打不开时我们可以通过使用串口工具查看WiFi打印信息:这条log主要说明了打开固件文件失败,说明了在/vend
    Industio_触觉智能 2025-03-12 14:32 51浏览
  • 文/杜杰编辑/cc孙聪颖‍主打影像功能的小米15 Ultra手机,成为2025开年的第一款旗舰机型。从发布节奏上来看,小米历代Ultra机型,几乎都选择在开年发布,远远早于其他厂商秋季主力机型的发布时间。这毫无疑问会掀起“Ultra旗舰大战”,今年影像手机将再次被卷上新高度。无意臆断小米是否有意“领跑”一场“军备竞赛”,但各种复杂的情绪难以掩盖。岁岁年年机不同,但将2-3年内记忆中那些关于旗舰机的发布会拼凑起来,会发现,包括小米在内,旗舰机的革新点,除了摄影参数的不同,似乎没什么明显变化。贵为旗
    华尔街科技眼 2025-03-13 12:30 60浏览
  • DeepSeek自成立之初就散发着大胆创新的气息。明明核心开发团队只有一百多人,却能以惊人的效率实现许多大厂望尘莫及的技术成果,原因不仅在于资金或硬件,而是在于扁平架构携手塑造的蜂窝创新生态。创办人梁文锋多次强调,与其与大厂竞争一时的人才风潮,不如全力培养自家的优质员工,形成不可替代的内部生态。正因这样,他对DeepSeek内部人才体系有着一套别具一格的见解。他十分重视中式教育价值,因而DeepSeek团队几乎清一色都是中国式学霸。许多人来自北大清华,或者在各种数据比赛中多次获奖,可谓百里挑一。
    优思学院 2025-03-13 12:15 47浏览
  • 本文介绍Android系统主板应用配置默认获取管理所有文件权限方法,基于触觉智能SBC3588行业主板演示,搭载了瑞芯微RK3588芯片,八核处理器,6T高算力NPU;音视频接口、通信接口等各类接口一应俱全,支持安卓Android、Linux、开源鸿蒙OpenHarmony、银河麒麟Kylin等操作系统。配置前提在配置前,建议先将应用配置成系统应用,不然配置后系统每次重启后都会弹窗提示是否获取权限。应用配置成系统应用,可参考以下链接方法:瑞芯微开发板/主板Android系统APK签名文件使用方法
    Industio_触觉智能 2025-03-12 14:34 54浏览
  • 文/Leon编辑/cc孙聪颖作为全球AI领域的黑马,DeepSeek成功搅乱了中国AI大模型市场的格局。科技大厂们选择合作,接入其模型疯抢用户;而AI独角兽们则陷入两难境地,上演了“Do Or Die”的抉择。其中,有着“大模型六小虎”之称的六家AI独角兽公司(智谱AI、百川智能、月之暗面、MiniMax、阶跃星辰及零一万物),纷纷开始转型:2025年伊始,李开复的零一万物宣布转型,不再追逐超大模型,而是聚焦AI商业化应用;紧接着,消息称百川智能放弃B端金融市场,聚焦AI医疗;月之暗面开始削减K
    华尔街科技眼 2025-03-12 17:37 145浏览
  • 在追求更快、更稳的无线通信路上,传统射频架构深陷带宽-功耗-成本的“不可能三角”:带宽每翻倍,系统复杂度与功耗增幅远超线性增长。传统方案通过“分立式功放+多级变频链路+JESD204B 接口”的组合试图平衡性能与成本,却难以满足实时性严苛的超大规模 MIMO 通信等场景需求。在此背景下,AXW49 射频开发板以“直采+异构”重构射频范式:基于 AMD Zynq UltraScale+™ RFSoC Gen3XCZU49DR 芯片的 16 通道 14 位 2.5GSPS ADC 与 16
    ALINX 2025-03-13 09:27 32浏览
  • 曾经听过一个“隐形经理”的故事:有家公司,新人进来后,会惊讶地发现老板几乎从不在办公室。可大家依旧各司其职,还能在关键时刻自发协作,把项目完成得滴水不漏。新员工起初以为老板是“放羊式”管理,结果去茶水间和老员工聊过才发现,这位看似“隐形”的管理者其实“无处不在”,他提前铺好了企业文化、制度和激励机制,让一切运行自如。我的观点很简单:管理者的最高境界就是——“无为而治”。也就是说,你的存在感不需要每天都凸显,但你的思路、愿景、机制早已渗透到组织血液里。为什么呢?因为真正高明的管理,不在于事必躬亲,
    优思学院 2025-03-12 18:24 81浏览
  • 2025年,科技浪潮汹涌澎湃的当下,智能数字化变革正进行得如火如荼,从去年二季度开始,触觉智能RK3562核心板上市以来,受到了火爆的关注,上百家客户选用了此方案,也获得了众多的好评与认可,为客户的降本增效提供了广阔的空间。随着原厂的更新,功能也迎来了一波重大的更新,无论是商业级(RK3562)还是工业级(RK3562J),都可支持NPU和2×CAN,不再二选一。我们触觉智能做了一个艰难又大胆的决定,为大家带来两大重磅福利,请继续往下看~福利一:RK3562核心板149元特惠再续,支持2×CAN
    Industio_触觉智能 2025-03-12 14:45 26浏览
  • 前言在快速迭代的科技浪潮中,汽车电子技术的飞速发展不仅重塑了行业的面貌,也对测试工具提出了更高的挑战与要求。作为汽车电子测试领域的先锋,TPT软件始终致力于为用户提供高效、精准、可靠的测试解决方案。新思科技出品的TPT软件迎来了又一次重大更新,最新版本TPT 2024.12将进一步满足汽车行业日益增长的测试需求,推动汽车电子技术的持续革新。基于当前汽车客户的实际需求与痛点,结合最新的技术趋势,对TPT软件进行了全面的优化与升级。从模型故障注入测试到服务器函数替代C代码函数,从更准确的需求链接到P
    北汇信息 2025-03-13 14:43 21浏览
  • 一、行业背景与用户需求随着健康消费升级,智能眼部按摩仪逐渐成为缓解眼疲劳、改善睡眠的热门产品。用户对这类设备的需求不再局限于基础按摩功能,而是追求更智能化、人性化的体验,例如:语音交互:实时反馈按摩模式、操作提示、安全提醒。环境感知:通过传感器检测佩戴状态、温度、压力等,提升安全性与舒适度。低功耗长续航:适应便携场景,延长设备使用时间。高性价比方案:在控制成本的同时实现功能多样化。针对这些需求,WTV380-8S语音芯片凭借其高性能、多传感器扩展能力及超高性价比,成为眼部按摩仪智能化升级的理想选
    广州唯创电子 2025-03-13 09:26 31浏览
  • 引言汽车行业正经历一场巨变。随着电动汽车、高级驾驶辅助系统(ADAS)和自动驾驶技术的普及,电子元件面临的要求从未如此严格。在这些复杂系统的核心,存在着一个看似简单却至关重要的元件——精密电阻。贞光科技代理品牌光颉科技的电阻选型过程,特别是在精度要求高达 0.01% 的薄膜和厚膜技术之间的选择,已成为全球汽车工程师的关键决策点。当几毫欧姆的差异可能影响传感器的灵敏度或控制系统的精确性时,选择正确的电阻不仅仅是满足规格的问题——它关系到车辆在极端条件下的安全性、可靠性和性能。在这份全面指南中,我们
    贞光科技 2025-03-12 17:25 92浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦