📘14장 The Preprocessor | Study

C Programming, A Modern Approach - K.N.KING으로 C언어를 공부하면서 정리한 내용입니다.
번역본 https://wikidocs.net/book/2494 을 참고하였습니다.

---

14.1 How the Preprocessor Works
14.2 Preprocessing Directives
14.3 Macro Definitions
14.4 Conditional Compilation
14.5 Miscellaneous Directives

---

📍 The Preproccessor

전처리기는 컴파일 이전에 C 프로그램을 수정해주는 소프트웨어이다.

---

📍 How the Preprocessor Works

전처리기의 행동은 전처리 지시자(preprocessing directives)에 의해 제어된다.
(전처리 지시자 : # 문자로 시작되는 명령어
ex. #define, #include)

#define 지시자는 매크로(macro)를 정의한다.
(매크로 : 상수, 자주 사용하는 표현식 등을 의미하는 이름)

#include : 특정 파일을 열고, 그 내용물을 컴파일할 파일에 추가한다.

아래 그림은 컴파일 과정에서 전처리기의 역할을 보여준다.

전처리기는 주석은 띄어쓰기 문자 하나로 대체한다.

대부분의 C 컴파일러는 전처리기의 출력물을 볼 수 있기 때문에 오류를 찾을 때 유용하다.

---

📍 Preprocessing Directives

🔎 전처리 지시자들

1) 매크로 정의(macro definition) : ex. #define으로 매크로 정의
2) 파일 추가(file inclusion) : ex. #include로 파일 추가
3) 조건적 컴파일(conditional compilation) : ex. #if, #ifdef, ifndef, #elif, #else, #endif로 코드의 특정 부분을 추가하거나 제외

🔎 지시자들의 규칙

1) #으로 시작한다.
2) 지시자와 토큰 사이에는 띄어쓰기가 임의의 개수만큼 들어갈 수 있다.

#	define 		N 	(100) (o)

3) 하나의 지시자에서 다음줄로 넘기려면 \로 끝나야 한다.

#define DISK_CAPACITY (SIDES *	\
		       TRACKS_PER_SIDE)

4) 프로그램 어디서든 등장할 수 있다

---

📍 Macro Definitions

매크로에는 단순(simple)매크로 뿐 아니라 매개변수(parameterized)매크로도 존재한다.

📍 Simple Macros

🔎 simple macro (또는 object-like macro)

#define identifier replacement-list

전처리기는 식별자가 대체목록을 의미하게 됨을 표시, 파일에 식별자가 등장하면 전처리기는 대체목록으로 대체한다.

단순 매크로는 고유상수를 정의하기 위해 주로 사용된다.

#define TRUE (1)
#define FALSE (0)
#define PI (3.14159)
#define MEM_ERR ("Error: not enough memory")

🔎 #define의 장점

1) 프로그램의 가독성, 수정성을 높여준다.
2) 일관성 없는 코드나 오타를 방지할 수 있다.

• #define의 추가적인 사용
  조건적 컴파일 제어하기. 아래와 같은 코드로 디버깅 관련 출력을 담당하는 코드도 추가적으로 컴파일 할 수 있게 만들 수 있다.

#define DEBUG 

C에서 매크로를 상수처럼 사용할 땐 이름을 전부 대문자로 작성하는 것이 관습이다.

---

📍 Parameterized Macros

🔎 parameterized macro (또는 function-like macro)

#define identifier( X1, X2, ..., Xn ) replacement-list

🔎 매개변수 매크로(parameterized macro)의 이용

#define MAX(x,y) ((x) > (y) ? (x) : (y))
#define IS_EVEN(n) ((n) % 2 == 0)

i = MAX(j+k, m-n);
if (IS_EVEN(i)) {
	++i;
}

위의 예시처럼 매개변수 매크로는 간단한 함수처럼 작동하기도 한다.

좀 더 예시를 살펴보면,

#define TOUPPER(c) ('a' <= (c) && (c) <= 'Z' ? (c) - 'a' + 'A' : (c)) 

#define getchar() getc(stdin)

🔎 매개변수 매크로(parameterized macro)의 장점

1) 프로그램이 조금 더 빨라진다. 함수 호출은 overhead를 필요로 할 수 있는데, 매크로는 그렇지 않다.
2) 매크로는 일반적(generic)이다. 함수 매개변수와 달리 특정한 형을 가지고 있지 않다.

🔎 매개변수 매크로(parameterized macro)의 단점
1) 컴파일된 코드가 길어진다.
2) 입력변수의 형을 확인해주지 않는다.
3) 매크로를 가리키는 포인터를 가질 수 없다. (함수는 함수 포인터가 존재)
4) 매크로가 입력변수를 한 번 이상 평가할 수 있다. (함수는 한 번만 평가)

---

📍 The # Operator

#연산자는 매크로 입력변수를 문자열 리터럴로 치환한다.

🔎 # 연산자 사용

#define PRINT_INT(n) printf(#n " = %d\n", n)

에서 n 대신 문자열 리터럴을 넣어준다.

PRINT_INT(i/j);

따라서 위 코드는 아래와 같다.

printf("i/j=%d\n", i/j);

---

📍 The ## Operator

##연산자는 두 토큰을 하나의 토큰으로 붙여 준다.

🔎 ## 연산자 사용

#define MK_ID(n) i##n
int MK_ID(1);
int MK_ID(2);

와 같이 작성해주면 전처리 이후에는

int i1; 
int i2;

가 된다.

max 함수의 정의를 갖는 매크로를 작성하면, 일일이 만들지 않고 여러 형을 받도록 할 수 있다.

매크로로 두 개 이상의 max함수를 만들 수 없는데, ##연산자로 각 max마다 서로 다른 이름을 만들어 해결해줄 수 있다.

#define GENERIC_MAX(type) type type##_max(type x, type y) { return x > y ? x : y; }

만약 float형 변수를 사용한 max함수가 필요하면 아래와 같이 정의할 수 있다.

GENERIC_MAX(float)

그럼 전처리기에 의해 아래와 같이 바뀐다

float float_max(float x, float y)
{
	return x > y ? x : y;
}

---

📍 Generic Properties of Macro

🔎 매크로에 적용되는 규칙

1) 매크로 대체 목록이 다른 매크로의 발동을 갖고 있을 수 있다.

#define PI (3.14159)
#define TWO_PI (2 * PI)

2) 전처리기는 식별자, 문자형 상수, 문자열 리터럴의 일부인 매크로 이름을 무시한다.

#define SIZE (256)
int BUFFER_SIZE;

위 코드의 경우 BUFFER_SIZE는 전처리의 영향을 받지 않는다.

3) 매크로의 정의는 보통 정의된 해당 파일 전체에 적용된다.

4) 똑같게 재정의를 하지 않는 이상 재정의는 불가능하다.

5) #undef 지시자에 의해 미정의 될 수도 있다.
아래코드는 현재 정의된 매크로 N을 삭제한다.

#undef N

---

📍 Parentheses in Macro Definitions

매크로에는 소괄호를 많이 써주는것이 좋다.

1) 대체목록에 연산자가 포함되어 있으면 반드시 대체목록을 소괄호로 감싸주어야 한다.

#define TWO_PI (2 * 3.14159)

2) 매크로가 매개변수가 있을 경우 매개변수를 모두 괄호로 감싸주어야 한다.

#define SCALE(x) ((x)) * 10)

---

📍 Creating Longer Macros

쉼표를 이용해 대체목록을 표현식의 연속체로 만들 수 있다.

🔎 문자열을 읽은 다음 출력을 해주는 매크로 - (1)

#define ECHO(s) (gets(s), puts(s))

이렇게 해서 ECHO를 마치 함수인 것처럼 사용할 수 있다.

ECHO(str); /* (gets(str), puts(str)); 이 된다 */

그러나 쉼표로는 표현식이 아니라 구문을 연결시킬 수는 없다. 구문을 연결시키려면 do 루프를 이용해야 한다.

🔎 문자열을 읽은 다음 출력을 해주는 매크로 - (2)

#define ECHO(s)				\
			do{		\
			gets(s);	\
			puts(s);	\
			} while (0)

세미콜론이 없다는 점을 눈여겨 보자.

ECHO를 사용할 땐 반드시 세미콜론을 이용해 do문을 완성시켜주어야 한다.

ECHO(str); /* do { gets(str); puts(str); } while (0); 이 된다*/

---

📍 Predefined Macros

🔎 C에서 사전정의된 매크로들

이름	설명
__LINE__	컴파일하는 파일의 줄 번호
__FILE__	컴파일하는 파일 이름
__DATE__	컴파일 날짜 ("Mmm dd yyyy"의 형식)
__TIME__	컴파일 시간 ("hh:mm:ss"의 형식)
__STDC__	만약 컴파일러가 C표준(C89 혹은 C99)일시 1임

---

📍 Additional Predefined Macros in C99

🔎 C에서 사전정의된 매크로들

이름	설명
__STDC_HOSTED__	호스트 시행이라면 1, 독립적이라면 0
__STDC_VERSION__	지원하는 C의 표준 버전
__STDC__	IEC 60559 고정소수점 산술을 지원할 시 1
__TIME__	IEC 60559 복소수 산술을 지원할 시 1
__STDC__	wchar_t의 값이 특정 년도와 월이 ISO 10646 표준을 만족할 시 yyyymmL

---

📍 Empty Macro Arguments

C99에서는 매크로의 모든 입력변수가 비어있을 수 있다. 이 경우 쉼표를 이용하여 어떤 입력변수가 생략되었는지 표시한다.

#define ADD(x,y) (x+y)

위와 같이 선언한 경우

i = ADD(, k); 

위의 구문은 다음과 같다

i = ( + k); 

빈 입력변수가 #의 피연산자의 경우에는 ""(빈 문자열)이 된다.

#define MK_STR(x) #x
...
char empty_string[] = MK_STR();

위의 구문은 전처리기에 의해 아래와 같이 바뀐다.

char empty_string[] = "";

빈 입력변수가 ##의 피연산자의 경우에는 위치 표시자 토큰으로 대체되어 존재하는 입력변수와 만나면 사라진다.

#define JOIN(x, y, z) x##y##z
...
int JOIN(a, b, c);
int JOIN(a, b, );
int JOIN(a, , c);
int JOIN(, , c);

위의 구문은 전처리기에 의해 아래와 같이 바뀐다.

int abc;
int ab;
int ac;
int c;

---

📍 Macris with a Variable Number of Arguments (가변 길이 입력변수 매크로)

C99에서는 무제한의 입력변수를 받을 수 있다. 이 기능의 주된 목적은 printf나 scanf와 같이 가변 길이 입력변수들을 받는 함수에 사용해주기 위해서 이다.

#define TEST(condition, ...) ((condition) ? \
	printf("Passed test: %s\n", #condition) : \
	printf(__VA_ARGS__))

... (생략부호(ellipsis)) : 매크로의 매개변수 목록에서 마지막에 위치하며, 일반적인 매개변수가 존재할 시 생략 부호 이전에 나온다

__VA_ARGS__ : 가변 길이 입력변수를 갖는 매크로의 대체목록에서만 나올 수 있는 특수한 식별자이다. 생략부호에 해당하는 모든 입력변수를 의미한다

TEST : 최소한 두 개의 입력변수를 필요로 한다.
첫번재 입력변수는 condition 매개변수에 대응하고, 나머지 입력변수들은 생략 부호에 대응한다.

🔎 TEST 매크로의 실제 용법

TEST(voltage <= max_voltage, "Voltage %d exceeds %d\n", voltage, max_voltage);

만약 voltage <= max_voltage라면
Passed test : voltage <= max_voltage를 출력,
voltage > max_voltage 라면
Voltage 125 exceeds 120 을 출력할 것이다.

---

📍 The __func__ Identifier

__func__ 식별자는 현재 실행되는 함수의 이름을 저장하고 있는 문자열 변수처럼 행동한다.

static const char \__func__[] = "function-name";

이러한 식별자가 존재하기 때문에 다음과 같은 디버깅 매크로를 작성해줄 수 있다.

#define FUNCTION_CALLED() printf("%s가 호출됨\n", __func__);
#define FUNCTION_RETURNS() printf("%s가 반환함\n", __func__);

void f(void)
{
	FUNCTION_CALLED(); /* "f가 호출됨"을 출력함 */
	FUNCTION_RETURNS(); /* "f가 반환함"을 출력함 */
}

---

📍 Conditional Compilation

📍 The #if and #endif Directives

#if - #endif 짝을 이용하면 코드상에서는 남아있더라도 상황에 따라 컴파일 하지 않을 수 있다.

아래 코드의 경우 DEBUG 값이 1이므로 실행되며, DEBUG값을 0으로 바꾸면 컴파일되지 않는다.

#define DEBUG 1

#if DEBUG
printf("i의 값 : %d\n", i);
printf("j의 값 : %d\n", j);
#endif 

---

#### 📍 The defined Operator

해당 식별자가 정의된 매크로일 경우 defined는 값 1을 내보내고, 아니라면 0을 내보낸다.
즉 해당 식별자가 매크로로서 정의되었는지를 판단하는 연산자이다.

#if define(DEBUG)
…
#endif

만약 DEBUG가 매크로로서 정의가 되어있다면 #if ~ #endif 사이 문이 실행된다.

---

📍 The #ifdef and #ifndef Directives

#ifdef 지시자는 식별자가 현재 매크로로 정의되어있는지 여부를 확인한다.

#ifdef identifier
...
#endif

식별자가 정의되어 있다면 #ifdef ~ #endif 사이 문이 실행된다. 이는 앞서 본 #if와 defined 연산자를 이용해서도 할 수 있다.

#ifndef는 #ifdef와는 반대로 식별자가 현재 매크로에 정의되어있지 않았는지의 여부를 확인한다.

---

📍 The #elif and #else Directives

#if, #ifdef, #ifndef 등과 더불어 #elif, #else를 사용하여 여러 조건들을 판별해줄 수 있다.

---

📍 Use of Conditional Compilation

🔎 여러 기계나 운영체제와 호환이 되는 프로그램을 작성할 때

#if defined(WIN32)
…
#elif defined(MAC_OS)
…
#elif defined(LINUX)
…
#endif

이를 이용해서 어느 운영체제에서 돌아가는지 표시를 해줄 수 있다.

🔎 다양한 컴파일러에서 컴파일할 수 있는 프로그램을 작성할 때

서로 다른 컴파일러들은 서로 다른 C버전을 인식할수 있기 때문에 오래된 컴파일을 사용해야 할 때는 __STDC__ 매크로 등을 이용해야 한다.

#if __STDC__
Function prototypes
#else
Old-style function declarations
#endif

🔎 매크로에 기본 정의를 내려줄 때

조건부 컴파일은 매크로가 현재 정의되었는지를 판단하고 그에 따른 행동을 해줄 수 있다. 아래 코드는 BUFFER_SIZE가 정의되지 않았다면 정의를 한다.

#ifndef BUFFER_SIZE
#define BUFFER_SIZE 256
#endif

🔎 일시적으로 주석을 포함한 코드를 없앨 때

#if 0
Lines containing comments 
#endif

---

📍 Miscellaneous Directives

#error, #line, #pragma 지시자

📍 The #error Directive

#error message

전처리기는 #error 지시자를 만나면 message를 반드시 포함하는 오류 문구를 출력한다. 오류 문구의 정확한 서식은 컴파일러마다 다르다.

🔎 #error 사용 예시

#if defined(WIN32)
…
#elif defined(MAC_OS)
…
#elif defined(LINUX)
…
#else
#error 특정된 운영체제가 없습니다
#endif

---

📍 The #line Directive

#line 지시자는 프로그램의 줄에 번호를 부여하는 법을 바꿀 때 사용한다. 또한 컴파일러가 다른 이름의 파일을 읽고 있도록 착각하게 만들 수 있다.

#line은 두 가지 서식을 갖는다.

1) #line 지시자 (1번 서식)
#line n

이 지시자는 프로그램에서 다음 줄들이 n, n+1, n+2 순으로 번호가 변하게 만든다.

2) #line 지시자 (2번 서식)
#line n "file"

지시자 이후에 나온 줄들은 "file"(파일명)을 갖는 파일에서 온 것으로 취급한다.

🔎 #line 사용 예시

#line 10 "bar.c"

컴파일러가 foo.c의 5번 줄에서 오류를 탐지한 경우 오류 문구는 foo.c파일의 5번째 줄이 아닌 bar.c 파일의 13번째 줄에서 오류가 났다고 인식한다.

13번째 줄인 이유는 지시자가 foo.c의 1번 줄을 차지하여 foo.c가 2번 줄부터 시작하기 때문이다.

#line 지시자는 주로 C 코드를 출력해주는 프로그램에서 사용한다. 제일 대표적인 예시로는 yacc(컴파일러의 컴파일러)가 있다.

---

📍 The #pragma Directive

#pragma 지시자는 컴파일러가 특정 행동을 하도록 부탁하게 만드는 방법이다.

📍 The _Pragma Directive

C99는 #pragma 지시자와 섞어 쓸 수 있는 _Pragma 연산자를 제공한다.

---