【为宏正名】99%人都不知道的"##"里用法

鱼鹰谈单片机 2020-09-17 00:00

这周看来是鸽定了,最近上班费脑,下班没有精神,USB 系列又太难写,只能向想看 USB 笔记的道友说声抱歉了,不过周末休息的话还是会更新一篇的,尽管 USB 笔记阅读量低,但两天时间怎么也得憋出一篇来才行


这篇是傻孩子大佬的干货,值得一看~



【说在前面的话】


有人说C语言中最臭名昭著的两兄弟就是指针和宏了。对于前者,很多有经验的老鸟会告诉你:用好了指针你就掌握了C语言的内功心法——如同原力一样,无论是追随光明还是堕入黑暗都离不开它。宏就没这么幸运了,不光年年受到邪恶的混乱C语言大赛的肆意霸凌(https://www.ioccc.org/),更是让“让代码爹妈都不认识”的身份标签贴到了骨头上——怎一个惨字了得。



这个系列将 本着实用的原则介绍一些宏在模块封装中“点石成金”的用法,让大家正确认识到宏真实的作用和使用规则——真真正正还“宏”一个公道。


【"##"的“表”用法】


想必很多人都知道"##"的用法——它本质上是一个“胶水运算”,用于把参数宏中的“形参”与 其它没有天然分割的内容粘连在一起,例如:
#define def_u32_array(__name, __size)     uint32_t array_##__name[__size];

实际中,我们可以这样使用:

def_u32_array(sample_buffer, 64)

宏展开的效果是:

uint32_t array_sample_buffer[64];

可以看到,"array__"与形参“__name”是没有天然分割的,因此要想将"array_"与"__name"所代表的内容(而不是__name本身)粘连在一起,就需要“##”运算的帮助。另一方面,"__name"与"["是具有天然分隔的——编译器不会认为"__name"与"["是连接在一起的,因此这里并不需要画蛇添足的使用"##"运算——如果你这么做了,预编译器会毫不犹豫的告诉你语法错误。——这是"##"运算的普通用法,在过去转载的文章《C语言#和##连接符在项目中的应用(漂亮)》中也有详细介绍,这里就不再赘述。


【"##"的官方“里”用法】


“##”还有一个很少为人所知的“里”用法,在介绍它之前,不得不首先说说由ANSI-C99标准引入的另外一个参数宏扩展——可变参数宏。举个例子:
#define safe_atom_code(...) \        { \            uint32_t int_flag = __disable_irq(); \            __VA_ARGS__ \            __set_PRIMASK(int_flag); \        }

这里定义了一个宏"safe_atom_code()",在括号内,无论你填写任何内容,都会被无条件的放置到“__VA_ARGS__”所在的位置,你可以认为括号里的“...”实际上就是对应"__VA_ARGS__"。比如,我们可以写下这样的代码:

/** \fn void wr_dat (uint16_t dat) \brief Write data to the LCD controller \param[in] dat Data to write*/static __inline void wr_dat (uint_fast16_t dat) {    safe_atom_code(     LCD_CS(0); GLCD_PORT->DAT = (dat >> 8); /* Write D8..D15 */     GLCD_PORT->DAT = (dat & 0xFF);   /* Write D0..D7 */ LCD_CS(1); )}

这个代码确保在向寄存器GCLD_PORT->DAT写入数据时不会被其它中断打断。

聪明的你也许很快就会提出这样的问题,上述宏跟下面的写法有什么区别呢?
#define safe_atom_code(__CODE) \        { \            uint32_t int_flag = __disable_irq(); \            __CODE \            __set_PRIMASK(int_flag); \        }

你不仅提出了问题,甚至还实际测试了下,似乎完全等效,“根本没差别嘛!”——你惊呼道。然而,事实上并没有那么简单:

  • 参数宏是通过“,”来作为分隔符来计算用户实际产传入了几个参数的,或者换句话说,在使用参数宏的时候,预编译器是看不懂C语法的——在它眼中,除了它所认识的少数符号外,其它东西都是无意义的字符串——由于在处理括号内部的内容时,它只认识","和"...",因此当括号中的内容每增加一个",",与编译器就认为多了一个参数。

  • 当你使用参数宏的时候,传入参数的个数(已“,”分开)必须与定义参数宏时候形参的数量完全一致;当不一致的时候,预编译器可能不会报错,而是直接无视了你的参数宏——把它传递到编译的下一阶段,因而往往会被认作是一个函数——事实上这个函数是不存在的,因此在链接阶段会报告某某函数未定义的错误。这时候你就会纳闷了,为啥我明明定义的是一个宏,编译器却把它当作函数呢?


可变参数宏的引入就解决了这个问题:

  • "..."只能放在参数宏形参列表的最后;

  • 当用户的参数个数超过了规定的参数个数时,所有多出来的内容会一股脑的由“__VA_ARGS__”所背负;

  • 当用户的参数个数正好等于形参的个数时,"__VA_ARGS__"就等效于一个空字符串


回头再来看前面的问题,

#define safe_atom_code(...)

与 

#define safe_atom_code(__CODE)

的差别在于,前者括号里可以放包括","在内的几乎任意内容;而后者则完全不能容忍逗号的存在——比如你调用了一个函数,函数的参数要用到都好隔开吧?再比如,你用到了逗号表达式……——想想都很酸爽。


其实,可变参数列表最初诞生的原因之一是为了解决与C函数的可变参数(va_args)配合使用的问题,例如:
#define log_info(__STRING, ...)    printf(__STRING, __VA_ARGS__)

因此,使用的时候,我们可以这样写:

log_info("------------------------------------\r\n");log_info(" Cycle Count : %d", total_cycle_cnt);

宏展开后实际上对应于:

printf("------------------------------------\r\n",);printf(" Cycle Count : %d", total_cycle_cnt);

看似没有问题,注意到一个细节没有?在第一个printf()的最后多了一个","。虽然有些编译器,例如GCC并不会计较(也许就是一个warning),但对于广大洁癖严重的处女座程序员来说,这怎么能忍,于是在ANSI-C99标准引入可变参数宏的时候,又贴心了加了一个不那么起眼的语法:当下面的组合出现时 ",##__VA_ARGS__",如果__VA_ARGS__是一个空字符串,则前面的","会一并被删除掉。因此,上面的宏可以改写为:

#define log_info(__STRING, ...)    printf(__STRING,##__VA_ARGS__)

此时,前面的代码会被展开为:

printf("------------------------------------\r\n");printf(" Cycle Count : %d", total_cycle_cnt);

处女座表示,这次可以安心睡觉了。


如果说这就是99%的C程序员都不知道的"##"隐藏用法,未免太对不起观众了,实际上本文的正片才刚刚开始。

【正文:"##"的骚操作】


逗号表达式,一直关注公众号的朋友们想必都很熟悉——之前转载的文章 《【C进阶】听说用 “ 逗号表达式 ” 仅仅为了秀技?》已经说的非常详细了,这里就不再赘述。简单说,就是逗号表达式中,逗号的最右边将作为表达式真正的返回值。 
结合前面关于",##__VA_ARGS__"用法的介绍,你们有没有意识到,其实这里的逗号不光可以是参数列表的分隔符,还可以是逗号表达式的运算符。结合__VA_ARGS__的特性,我们可以写出类似这样的宏:
#define EXAMPLE(...)     ( 默认值 ,##__VA_ARGS__)
它有两种使用情况情况:
  • 当我们使用参数宏的时候在括号里不填写任何内容,最终会展开为仅有默认值的情况:

EXAMPLE();

被展开为:

( 默认值 )
  • 当我们提供了任意的有效值时,则会被展开成逗号表达式:

EXAMPLE(我们提供的值);

被展开为:

( 默认值, 我们提供的值 )

根据逗号表达式的特性,此时,默认值会被丢弃掉( 有些编译器会报告表达式无效的warning,这是正常的,因为编译器注意到“默认值”所代表的表达式实际上被丢弃了,它觉得我们写了一个无用的表达式)。

这个技巧其实对API的封装特别有效:它允许我们简化函数API的使用,比如在用户忽略的情况下,自动给函数填充某些默认值,而在用户主动提供参数的情况下,替代那些默认值。这里我举两个现实中的例子:


  • 为函数提供默认的参数

假设我们有一个初始化函数,初始化函数允许用户通过结构体来配置一些参数:

typedef struct xxxx_cfg_t { ...xxxx_cfg_t;
int xxxx_init(xxxx_cfg_t *cfg_ptr);

为了简化用户的配置过程,初始化函数会检查指针cfg_ptr是否为NULL,如果为NULL则自动使用默认配置,反之将使用用户定义的配置。此时,我们可以通过宏来提供默认值NULL:

#define XXXX_INIT(...) xxxx_init((NULL,##__VA_ARGS__))

  • 为消息处理提供默认的掩码配置

有些消息处理函数可以批量的处理某一类消息,而具体选中了哪些消息类别,则通常由二进制掩码来表示,例如:

typedef struct msg_t msg_t;struct { uint16_t msg;    uint16_t mask;    int (*handler)(msg_t *msg_ptr);msg_t;
此时我们完全可以借助宏来构建一套语法糖:
#define def_msg_map(__name, ...) \    const msg_t __name[] = {__VA_ARGS__};    #define add_msg(__msg, __handler, ...) \    {                                                       \     .msg = (__msg), \        .handler = &(__handler),                            \        .msk = (0xFFFF##__VA_ARGS__),                     \ }
通过宏 add_msg 我们注意到,当用户刻意省略设置msk时,我们就给出默认值 0xFFFF——这很可能表示,在进行消息处理的时候,消息必须严格匹配才能交给对应的处理函数;当用户指定 msk 时,则可能表示某一类消息都交给同一个消息处理函数来处理。例如:
/*! \note 高字节表示操作的类别: 比如0x00表示控制类,0x01表示WRITE,0x02表示READ */enum {    SIGN_UP     = 0x0001, WRITE_MEM = 0x0100,    WRITE_SRAM = 0x0101,    WRITE_FLASH = 0x0102, WRITE_EEPROM = 0x0103,  READ_MEM = 0x0200, READ_SRAM = 0x0201, READ_FLASH = 0x0202, READ_EEPROM = 0x0203,};
extern int iap_sign_up_handler(msg_t *msg_ptr);extern int iap_write_mem(msg_t *msg_ptr);extern int iap_read_mem(msg_t *msg_ptr);
def_msg_map( iap_message_map    /* 严格的将 SIGN_UP 映射到 对应的处理函数中 */    add_msg( SIGN_UP,  iap_sign_up_handler ),    /* 批量处理所有的WRITE操作,使用掩码进行过滤*/    add_msg( WRITE_MEM, iap_write_mem,       0xFF00 ),     /* 批量处理所有的READ操作,使用掩码进行过滤 */    add_msg( READ_MEM,  iap_read_mem,    0xFF00 ),)



【结语】


宏不是阻碍代码开发和可读性的魔鬼,对自己不熟悉知识的傲慢才是。

鱼鹰谈单片机 面向软件开发进阶读者,分享包括但不限于 C 语言、KEIL、STM32、51 等知识!
评论
  • HDMI 2.2 规格将至,开启视听新境界2025年1月6日,HDMI Forum, Inc. 宣布即将发布HDMI规范2.2版本。新HDMI规范为规模庞大的 HDMI 生态系统带来更多选择,为创建、分发和体验理想的终端用户效果提供更先进的解决方案。新技术为电视、电影和游戏工作室等内容制作商在当前和未来提供更高质量的选择,同时实现多种分发平台。96Gbps的更高带宽和新一代 HDMI 固定比率速率传输(Fixed Rate Link)技术为各种设备应用提供更优质的音频和视频。终端用户显示器能以最
    百佳泰测试实验室 2025-01-09 17:33 114浏览
  • 一个真正的质量工程师(QE)必须将一件产品设计的“意图”与系统的可制造性、可服务性以及资源在现实中实现设计和产品的能力结合起来。所以,可以说,这确实是一种工程学科。我们常开玩笑说,质量工程师是工程领域里的「侦探」、「警察」或「律师」,守护神是"墨菲”,信奉的哲学就是「墨菲定律」。(注:墨菲定律是一种启发性原则,常被表述为:任何可能出错的事情最终都会出错。)做质量工程师的,有时会不受欢迎,也会被忽视,甚至可能遭遇主动或被动的阻碍,而一旦出了问题,责任往往就落在质量工程师的头上。虽然质量工程师并不负
    优思学院 2025-01-09 11:48 114浏览
  • Snyk 是一家为开发人员提供安全平台的公司,致力于协助他们构建安全的应用程序,并为安全团队提供应对数字世界挑战的工具。以下为 Snyk 如何通过 CircleCI 实现其“交付”使命的案例分析。一、Snyk 的挑战随着客户对安全工具需求的不断增长,Snyk 的开发团队面临多重挑战:加速交付的需求:Snyk 的核心目标是为开发者提供更快、更可靠的安全解决方案,但他们的现有 CI/CD 工具(TravisCI)运行缓慢,无法满足快速开发和部署的要求。扩展能力不足:随着团队规模和代码库的不断扩大,S
    艾体宝IT 2025-01-10 15:52 38浏览
  • 职场是人生的重要战场,既是谋生之地,也是实现个人价值的平台。然而,有些思维方式却会悄无声息地拖住你的后腿,让你原地踏步甚至退步。今天,我们就来聊聊职场中最忌讳的五种思维方式,看看自己有没有中招。1. 固步自封的思维在职场中,最可怕的事情莫过于自满于现状,拒绝学习和改变。世界在不断变化,行业的趋势、技术的革新都在要求我们与时俱进。如果你总觉得自己的方法最优,或者害怕尝试新事物,那就很容易被淘汰。与其等待机会找上门,不如主动出击,保持学习和探索的心态。加入优思学院,可以帮助你快速提升自己,与行业前沿
    优思学院 2025-01-09 15:48 102浏览
  • 在智能网联汽车中,各种通信技术如2G/3G/4G/5G、GNSS(全球导航卫星系统)、V2X(车联网通信)等在行业内被广泛使用。这些技术让汽车能够实现紧急呼叫、在线娱乐、导航等多种功能。EMC测试就是为了确保在复杂电磁环境下,汽车的通信系统仍然可以正常工作,保护驾乘者的安全。参考《QCT-基于LTE-V2X直连通信的车载信息交互系统技术要求及试验方法-1》标准10.5电磁兼容试验方法,下面将会从整车功能层面为大家解读V2X整车电磁兼容试验的过程。测试过程揭秘1. 设备准备为了进行电磁兼容试验,技
    北汇信息 2025-01-09 11:24 97浏览
  • 在当前人工智能(AI)与物联网(IoT)的快速发展趋势下,各行各业的数字转型与自动化进程正以惊人的速度持续进行。如今企业在设计与营运技术系统时所面临的挑战不仅是技术本身,更包含硬件设施、第三方软件及配件等复杂的外部因素。然而这些系统往往讲究更精密的设计与高稳定性,哪怕是任何一个小小的问题,都可能对整体业务运作造成严重影响。 POS应用环境与客户需求以本次分享的客户个案为例,该客户是一家全球领先的信息技术服务与数字解决方案提供商,遭遇到一个由他们所开发的POS机(Point of Sal
    百佳泰测试实验室 2025-01-09 17:35 108浏览
  • 车机导航有看没有懂?智能汽车语系在地化不可轻忽!随着智能汽车市场全球化的蓬勃发展,近年来不同国家地区的「Automotive Localization」(汽车在地化)布局成为兵家必争之地,同时也是车厂在各国当地市场非常关键的营销利器。汽车在地化过程中举足轻重的「汽车语系在地化」,则是透过智能汽车产品文字与服务内容的设计订制,以对应不同国家地区用户的使用习惯偏好,除了让当地车主更能清楚理解车辆功能,也能进一步提高品牌满意度。客户问题与难处某车厂客户预计在台湾市场推出新一代车款,却由于车机导航开发人
    百佳泰测试实验室 2025-01-09 17:47 16浏览
  • 根据环洋市场咨询(Global Info Research)项目团队最新调研,预计2030年全球中空长航时无人机产值达到9009百万美元,2024-2030年期间年复合增长率CAGR为8.0%。 环洋市场咨询机构出版了的【全球中空长航时无人机行业总体规模、主要厂商及IPO上市调研报告,2025-2031】研究全球中空长航时无人机总体规模,包括产量、产值、消费量、主要生产地区、主要生产商及市场份额,同时分析中空长航时无人机市场主要驱动因素、阻碍因素、市场机遇、挑战、新产品发布等。报告从中空长航时
    GIRtina 2025-01-09 10:35 99浏览
  • 在过去十年中,自动驾驶和高级驾驶辅助系统(AD/ADAS)软件与硬件的快速发展对多传感器数据采集的设计需求提出了更高的要求。然而,目前仍缺乏能够高质量集成多传感器数据采集的解决方案。康谋ADTF正是应运而生,它提供了一个广受认可和广泛引用的软件框架,包含模块化的标准化应用程序和工具,旨在为ADAS功能的开发提供一站式体验。一、ADTF的关键之处!无论是奥迪、大众、宝马还是梅赛德斯-奔驰:他们都依赖我们不断发展的ADTF来开发智能驾驶辅助解决方案,直至实现自动驾驶的目标。从新功能的最初构思到批量生
    康谋 2025-01-09 10:04 97浏览
  • 1月9日,在2025国际消费电子展览会(CES)期间,广和通发布集智能语音交互及翻译、4G/5G全球漫游、随身热点、智能娱乐、充电续航等功能于一体的AI Buddy(AI陪伴)产品及解决方案,创新AI智能终端新品类。AI Buddy是一款信用卡尺寸的掌中轻薄智能设备,为用户带来实时翻译、个性化AI语音交互助手、AI影像识别、多模型账户服务、漫游资费服务、快速入网注册等高品质体验。为丰富用户视觉、听觉的智能化体验,AI Buddy通过蓝牙、Wi-Fi可配套OWS耳机、智能眼镜、智能音箱、智能手环遥
    物吾悟小通 2025-01-09 18:21 19浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦