#if #ifdef #if defined 等几种常用的预处理指令的区别

在写shader时经常会出现一些预编译指令比如 #if #ifdef #if defined 等,有的时候会感到困惑,所以决定仔细查一下具体的使用方法,并做一个简单的测试。

#define

#define 指令用于定义一个宏或者常量
#define 有两种常用的格式:

  1. #define identifier token-string 定义一个宏,在预编译时会把所有identifier替换成token-string,可以用更容易理解的名称去代替一个常量,例如:#define PI 3.1415926
  2. #define identifier( argument0, …, argumentN-1 ) token-string 定义一个类似函数一样的宏,例如:#define AREA(area, w, h) (area = w*h);
// #define 的使用 //
#define SOME_MACRO
#define PI 3.141593

定义宏时使用第一种方式,当没有指定 token-string 时,需要注意的两点是:

  1. 这个identifier依然是被定义了的,且可以使用#if defined 或 #ifdef 检测到的
  2. 所有identifier字符都会被移除,或者理解为所有identifier的地方都被替换成空字符串。

详细信息可以参考 #define文档

#if

#if 是一个预处理指令,用来控制源文件中哪一部分会被编译。
格式是: #if condition
简单来说就是 #if 后面的条件语句(condition)如果执行结果不为0,则该#if语句块内的代码会被编译,否则就不会被编译。
#elif 和 #else 可以类比为常规的用于判断条件的关键字 else if 和 else,区别是前面加了个#符号,用以表明该指令是在预处理阶段执行,而不是运行时执行。最后,在所有判断结束后需要用 #endif 来作为结尾,用于确定预处理语句的作用范围。

// #if 的使用 //
#define SOME_MACRO 0
#if SOME_MACRO
    return float4(1,1,1,1);
#else
    return float4(0,0,0,1);
#endif

以上代码结果返回黑色


// #if 的使用 //
#define SOME_MACRO
#if SOME_MACRO
    return float4(1,1,1,1);
#else
    return float4(0,0,0,1);
#endif

以上代码会报错: invalid or unsupported integer constant expression

详细信息可以参考 #if文档


#ifdef

#ifdef 用于判断一个常量或者宏是否被定义
格式是: #ifdef identifier
identifier是一个宏或者常量,可以通过#define指令来定义,如果identifier被定义过,则#ifdef 语句块内的代码会被编译,否则不会被编译。
#ifdef 只是判断一个常量或者宏是否被定义,不可以用于表达式判断,但是#if可以,例如:

#define CONST_VALUE 3
#if CONST_VALUE > 1
    return float4(1,1,1,1);
#else 
    return float4(0,0,0,1);
#endif

#ifdef CONST_VALUE > 1      // 这样写会报错 //

hlsl文档上的说法是#ifdef这种写法只是为了兼容以往版本,建议使用defined来判断,即使用 #if defined(MACRO) 这种形式,接下来就会说到。

These directives are provided only for compatibility with previous versions of the language. The use of the defined operator with the #if directive is preferred.

详细信息可以参考 #ifdef文档


#if defined

这是文档里更推荐的一种写法
#if defined 和 #ifdef 都可以用来判断一个宏是否被定义,#if !defined 等同于 #ifndef。

#define SOME_MACRO

// #if defined 的使用 //
#if defined(SOME_MACRO)
    // do something //
#elif defined(OTHER_MACRO)
    // do something else //
#endif

// #ifdef 的使用 //
#ifdef SOME_MACRO
    // do something //
#endif

#ifdef OTHER_MACRO
    // do something else //
#endif


总结

  1. 如果是根据一个宏是否被定义来决定一段代码要不要执行,建议使用 #if defined(MACRO) 方式
  2. 如果是根据一个表达式的值是否为0来决定一段代码要不要执行,建议使用 #if condition 方式
  3. #ifdef 用于判断宏或者常量是否被定义,不用于判断表达式,#if 可以用于判断表达式


参考链接:

https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl-appendix-preprocessor

https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl-appendix-pre-define

https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl-appendix-pre-if

https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl-appendix-pre-ifdef

https://stackoverflow.com/questions/3802988/difference-between-preprocessor-directives-if-and-ifdef


测试工程地址:

https://github.com/JasonTheCoderMichael/Preprocessor-Directives

预处理指令是在源代码被编译之前由预处理器处理的一组特殊命令。它们通常以井号(`#`)开头,位于代码行的第一列,并且不以分号结尾。预处理指令的主要作用是对源代码进行初步修改或添加内容,以便更好地支持编译过程。以下是几种常见的预处理指令类型及其功能介绍: ### 1. 文件包含 (`#include`) 用于将另一个文件的内容插入到当前文件中。这通常是用来引用标准库或其他自定义头文件中的函数声明、宏定义等内容。 - 示例:`#include <stdio.h>` 或者 `#include "myheader.h"` ### 2. 宏定义 (`#define`) 允许用户定义常量或者简单的替换规则,在编译前会自动替换成相应的文本。 - 带参宏示例:`#define MAX(a,b) ((a) > (b) ? (a) : (b))` - 不带参宏示例:`#define PI 3.14159` ### 3. 条件编译 (`#if`, `#ifdef`, `#ifndef`, `#elif`, `#else`, `#endif`) 可以根据特定条件选择是否编译某段代码。这对于平台依赖性的代码编写非常有用。 - 示例: ```c #ifdef DEBUG printf("Debug mode enabled\n"); #endif ``` ### 4. 行控制 (`#line`) 改变编译器对后续输入行的编号方式。它主要用于调试信息记录和错误报告准确度提升等方面。 - 示例:`#line 100 "newfile.c"` ### 5. 错误生成 (`#error`) 当满足某些条件时强制停止编译并输出一条指定的消息。有助于防止不符合预期的情况进入生产环境。 - 示例:`#if SIZEOF_INT != 4 && !defined(__LP64__) #error Unexpected integer size for architecture. #endif` ### 6. 抑制警告 (`#pragma`) 向编译器发出各种指示信息,包括但不限于优化选项设置、诊断消息级别调整等。它的实际效果取决于具体的编译器实现。 - 示例:`#pragma pack(1)` // 设置结构体字节对其 以上就是一些常见预处理指令的基本概述,掌握这些可以帮助我们更高效地组织和维护代码。 --
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值