Go to the first, previous, next, last section, table of contents.

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Foundation.

도입과 준비

이번 첫 장에서는 GNU m4가 무엇이고 어디서부터 유래가 되었는지와 이 문서의 활용법, m4 프로그램의 호출법 및 버그 보고 방법에 대해서 설명한다. 아울러 매뉴얼의 나머지 부분을 읽는 방법에 대한 팁을 제공하면서 마무리한다.

이후의 장들은 m4 언어의 모든 특징들을 자세히 설명할 것이다.

`m4`의 개요

m4는 입력에서 읽어서 출력으로 복사하고, 그 과정에서 매크로를 확장하는 매크로 처리기이다. 매크로는 내장되어 있거나 사용자가 정의를 할 수 있다. 또한 넘겨주는 인자의 수에도 제한이 없다. m4는 매크로 확장만을 하는 것이 아니라 파일을 삽입하거나 UNIX 명령을 실행한다든지, 정수 계산, 문서를 처리하는 것을 재귀적인 방법 등 여러가지 방법으로 할 수 있는 내장 함수를 가지고 있다. m4는 컴파일러의 전위-프로그램(front-end)으로 사용되거나 하나의 독립적인 매크로 처리기로 사용될 수 있다.

매크로 처리기 m4는 모든 UNIX에서 폭넓게 사용이 가능하다. 보통, 소수의 사용자만이 m4의 존재를 알고 있다. 그러나 m4에 한번 맛을 들이면 헤어나올 수가 없을 것이다. GNU Autoconf의 인기가 높아질수록 `configure' 스크립트를 만드는 데 미리 요구되는 GNU m4는 m4를 설치하도록 하는 자극제로 되고 있다. 그러한 사람들은 보통 m4로 프로그래밍 하는 데는 익숙치 않을 것이다. GNU m4는 대부분 System V, 릴리즈 3 버전과 몇가지 사소한 것만 빼고는 대부분 호환된다. 더 자세한 내용은 See section m4 의 다른 버전들과의 호환성.

몇몇 사람들은 m4가 중독성이 있음을 발견한다. 처음에 사람들은 m4를 간단한 문제 해결에 사용한다. 그러다가 점점 더 큰 문제에 도전을 하면서 복잡한 일련의 m4 매크로들을 사용하는 방법에 대해서 배운다. 정말 한번 중독되어 버리면 간단한 문제도 매우 복잡하게 m4 어플리케이션을 작성하는 경우가 많다. 그럴때에는 원래 하려던 작업을 하는데 들이는 시간보다 디버깅에 바치는 시간이 더 많아지기도 한다. m4는 강박증 증세가 있는 프로그래머의 건강에 위험하다는 것을 명심해 두자.

역사적인 참고사항들

m4의 역사에 관련된 내용은 여기에 온전하게 싣지 않았고, 믿을만한 내용이 없다. 혹시 이에 대한 내용을 알고 있는 분은 이 부분을 쓸 수 있도록 도움을 주기 바란다.

m4의 중요한 조상은 GPM이다. C. Stratche의 "A General Purpose Macro generator", Computer Journal 8,3 (1965), 255쪽을 보기 바란다. 또한 David Gries가 쓴 고전적인 책 "디지털 컴퓨터용 컴파일러 만들기(Compiler Construction for Digital Computers)"에서 GPM이 살짝 언급된다.

GPM이 순수했다고 친다면, m4는 실제에서 부딪치는 복잡한 많은 문제들을 다루는 것이었다. 미리 선언하는 방식으로 매크로를 인식하고, 공백문자나 라인의 끝(end-of-line)을 쉽게 건너뛸 수 있었으며, 많은 생성자들을 내장하고 있었다.

원래는 m4는 Rational 포트란 전처리기의 엔진이었으며, ratfor에게 있어서 cpp에 해당하는 것이다.

`m4`를 불러내기

m4의 명령 포맷은 다음과 같다.

m4 [option...] [macro-definitions...] [input-file...]

모든 옵션은 `-'로 시작하거나, 긴 옵션이름을 사용할 때에는 `--'으로 시작한다. 긴 옵션이름은 다 쓸 필요는 없다. 이름 앞 부분부터 헷갈리지 않을 정도까지만 쓰면 충분하다. m4는 다음의 옵션을 사용할 수 있다.

--version: 프로그램의 버전 번호를 표준 출력에 출력한 후 바로 종료하며 어떤 input-files도 읽지 않는다.
--help: 도움말의 요약을 표준 출력에 출력한 후 바로 종료하며 어떤 input-files도 읽지 않는다.
-G
--traditional: System V와 비교하여 확장된 모든 기능을 억제한다. 이 기능들의 목록을 보려면 See section m4 의 다른 버전들과의 호환성.
-E
--fatal-warnings: 경고가 한번이라도 나오면 치명적인 것으로 간주하고, 즉각 실행을 멈추고 종료한다.
-dflags
-debug=flags: 디버깅 수준 플래그를 flags로 세팅한다. 디버깅 수준은 디버깅 기능에 의해 제공되는 정보의 양과 형식을 제어한다. flags의 형식과 뜻에 대해서 See section 디버깅 출력을 제어하기.
-lnum
--arglength=num: 매크로 추적에 의해 생성되는 출력의 크기를 제한한다. See section 디버깅 출력을 제어하기.
-ofile
--error-output=file: 디버깅과 추적시의 출력을 지정된 이름의 파일로 보내도록 한다. 에러메시지는 그대로 표준 에러 출력에 찍힌다. See section 디버깅 출력을 저장하기.
-Idir
--include=dir: 삽입할 파일이 현재의 작업 디렉토리에서 보이지 않을 경우에 검색할 경로를 dir로 지정한다. See section 삽입할 파일 검색하기.
-e
--interactive: m4를 대화식으로 호출한다. 이것이 뜻하는 것은 모든 출력은 버퍼링되지 않고, 인터럽트는 무시된다는 것이다.
-s
--synclines: 동기화(synchronisation) 라인을 생성한다. 이것은 C 전처리기나 다른 비슷한 툴에 의해 사용된다. 이것은, 예를 들어, m4가 컴파일러의 전위-프로그램(front-end)으로 사용될 때 쓸모 있다. 소스 파일 이름과 라인 번호 정보는 `#line linenum "filename"' 형식인 지시자에 의해 전달된다. 이것은 필요에 따라 입력의 중간에 끼워 넣어진다. 그러한 지시자가 뜻하는 것은 뒤 따라 오는 라인이 입력 파일 filename의 줄 번호가 linenum인 곳의 내용으로부터 비롯되었거나 확장되었다는 것이다. `"filename"' 부분은 이전의 지시자로부터의 파일이름이 바뀌지 않았을 때 종종 생략된다. 동기화(Synchronisation) 지시자는 언제나 지시자 각각마다 한 줄 전체에 하나씩만 주어진다. 동기화의 불일치가 어떤 한 출력 라인의 중간에서 발생한다면 그와 관련된(associated) 동기화 지시자는 그 다음 생성되는 라인이 시작될 때까지 지연된다.
-P
--prefix-builtins: 내부적으로 모든 내장 매크로의 명칭을 앞에 `m4_'로 시작하도록 변경한다. 예를 들면, 이 옵션을 사용한다면, `define' 대신 `m4_define' 으로 사용해야 한다. 그리고 `__file__' 대신 `m4___file__'로 사용해야 한다.
-WREGEXP
--word-regexp=REGEXP: 매크로 이름으로 사용하는 문법을 변경한다. 이 시험적인 옵션은 모든 GNU m4에서 다 지원하는 것은 아니다. (see section 단어의 어휘 구조 바꾸기).
-Hn
--hashsize=n: 내부적으로 심볼을 찾기위한 해쉬(hash) 테이블의 개수를 n개 entry 크기로 만든다. 이 숫자는 솟수(prime number; 수학용어)이어야 한다. 기본값은 509 엔트리이다. 이 정도면 여러분들이 과도한 숫자의 매크로를 정의하지 않는다면 충분한 크기이다.
-Ln
--nesting-limit=n: 중첩된(nesting) 매크로 호출을 n 레벨로 인위적으로 제한한다. 만일 이 제한이 넘어갔을 때에는 프로그램 실행을 중지한다. 특별히 명시되지 않으면 중첩 제한은 250 레벨이다. 이 옵션의 정확한 효과는 동적인 재귀보다는 문자 그대로의 중첩과 좀 더 관련이 깊을 것이다. 이것은 기계적인 수단에 의해 생성된 어떤 복잡한 m4 입력이 있을 때 유용할 것이다. 대부분의 사용자에게는 별로 의미 없는 옵션이 될 것이다. 거추장스러운 것으로 판명된다면 (아직 실험적인) 이 옵션은 없어질 지도 모른다. 이 옵션은 끝없는 재검색 루프들을 멈추게 하는 능력은 없지만, 반면에 그것들이 기억장치와 스택 공간을 과도하게 소비하지 않는 것이어야 하게 할 수는 있다. 재검색하는 루프를 영리하게 사용해서, 어떤 이는 복잡하고 시간이 걸리는 계산을 m4에게 시켜서 유용한 결과를 얻어낼 수 있다. 이런 면에서 한계를 두는 것은 m4의 능력을 막는 일이다. 이런 경우는 많이 있는 데 `define(`a', `a')a'는 간단한 예일 뿐이다 (그러나 see section m4 의 다른 버전들과의 호환성). GNU m4 가 이러한 무한 루프를 감지하기를 바라는 것은 한낱 컴파일러 시스템이 무한루프를 감지하고 치료하기를 바라는 것과 다를 바 없다. 이것은 불가능하지는 않더라도, 일반적으로 매우 어려운 문제이다.
-Q
--quiet
--silent: 매크로 호출에서 호출인자를 빠뜨리거나 너무 많이 넣은 것에 대한 경고를 출력하지 않는다.
-B
-S
-T: 이들 옵션은 System V m4와의 호환성을 위해서 제공한다. 그러나 여기에서는 아무일도 하지 않는다.
-Nn
--diversions=n: 이들 옵션은 이전의 GNU m4 버전과의 호환성을 위해서 제공할 뿐이다. 그리고 이것은 동시에 사용 가능한 전환 개수를 제어하는 것이었다. 이제는 어떤 정해진 제한이 없기 때문에 이 옵션들은 아무런 일도 하지 않는다.

매크로 정의와 삭제는 명령행 라인에서 행할 수 있다. `-D' 옵션과 `-U' 옵션이 그것이다. 이것들은 다음과 같은 형식을 가지고 있다.

-Dname
-Dname=value
--define=name
--define=name=value: 어떤 입력 파일도 읽어 들이기 전에 심볼 테이블로 name을 집어넣는다. `=value'가 빠졌다면 그 값은 빈 문자열로 된다. 그리고 마치 입력 파일의 내부에서 이것이 정의되는 것처럼 value는 어떠한 문자열이라도 될 수 있으며, 매크로는 인자를 가지도록 정의될 수 있다.
-Uname
--undefine=name: 이미 정의된 name을 삭제한다. 당연히 이미 정의된 매크로만 이 방법으로 없앨 수 있다.
-tname
--trace=name: name을 심볼테이블에, 미정의되었지만 추적되는 것이라고, 집어넣는다. 그러므로 그 매크로는 정의되는 지점부터 추적되기 시작할 것이다.
-Ffile
--freeze-state=file: 한 번의 실행이 끝났을 때, 명시된 file에 frozen 상태 정보를 기록한다. (see section Frozen 상태를 빨리 적재(load)하기).
-Rfile
--reload-state=file: 실행을 개시하기 전에, 명시된 frozen file로부터 내부 상태를 가져온다. (see section Frozen 상태를 빨리 적재(load)하기).

이제 명령행 라인에서 남은 인자는 입력 파일의 이름이다. 이름이 지정되지 않는다면, 표준 입력이 대신 읽힌다. 파일 이름 `-'은 표준 입력을 뜻한다.

입력 파일들은 주어진 순서대로 읽혀진다. 표준 입력은 단지 한 번만 읽혀질 수 있다. 따라서 파일 이름 `-'는 명령행 라인에서 한 번만 나타날 수 있다.

문제점과 버그

GNU m4 를 사용하면서 어떤 문제점이 있거나 버그를 발견한 점이 있다면, 보고해 주기 바란다. 버그 보고서를 작성하기 전에, 그게 진짜 버그인지 확인해보기 바란다. 이 문서를 다시 주의 깊게 읽어보고 여러분이 하려는 바로 그것을 할 수 있다고 나와 있는가를 살펴보라. 여러분이 하려는 그것을 처리할 수 있는지 없는지 불명확하게 나와 있다면 그것도 보고해 달라. 그것은 문서의 버그인 것이다.

버그보고서를 작성하거나 여러분 스스로 고쳐보기 전에, 그것을 분리시켜서 문제점을 다시 일으킬 수 있는 가능한 한 작은 입력파일을 만들어 보라. 그리고 나서 그 입력파일과 m4가 정확히 어떠한 결과를 여러분에게 내놓았는지를 보내 달라. 또한 여러분이 바라던 결과는 어떤 것이었는지도 말해달라. 이것은 그 문제가 정말로 문서에서의 버그인지 아닌지를 우리가 결정하는 데 도움이 될 것이다.

일단 정확하게 문제점을 집어냈다면 e-mail을 (인터넷) `bug-gnu-utils@prep.ai.mit.edu'나 (UUCP) `mit-eddie!prep.ai.mit.edu!bug-gnu-utils'로 보내달라. 여러분들이 사용하고 있는 m4의 버전 정보도 같이 포함시키면 좋을 것이다. 버전 정보는 `m4 --version'으로 얻을 수 있다.

버그가 아닌 제안도 항상 환영한다. 이 문서에서 명확하지 못한 점이나 단지 모호한 특징에 관한 질문도 보내주면 좋다.

이 매뉴얼의 사용

이 매뉴얼은 m4에서의 입력과 출력의 예제를 사용하고 있다. 그리고 입력과 출력, 에러출력에 간단한 규칙을 적용하고 있다. 예제는 일반적인 텍스트(고정크기의 폰트)로 표시한다. 다음과 같이..

This is an example of an example!

출력과 입력을 구별하기 위해서 모든 m4의 출력은 `=>'이 앞에 붙는다. 그리고 에러 메시지나 에러 출력으로 나오는 것은 `error-->'로 표시한다. 따라서,

Example of input line
=>Output line from m4
error-->and an error message

m4에서 미리 정의된 매크로를 설명할 때에는, 그 매크로의 원형(prototype) 호출을 보여 줄 것이며 그 호출 인자에는 묘사적인 이름을 부여할 것인데, 예를 들면 다음과 같다.

regexp(string, regexp, opt replacement)

m4에서 모든 인자는 문자열이다. 그러나 어떤 것은 특별하게 해석한다. 숫자나, 파일이름, 정규표현식 등등..

위에서 세 번째 인자 앞의 `opt'는 선택사항이라는 것을 가리킨다. (생략된다면, 빈문자열이 될 것이다.) 인자 목록 중 생략부호(`...')는 어떠한 개수의 인자도 올 수 있음을 가리키는 것이다.

이 문서는 일관되게 builtin을 하나의 영어 단어인 것처럼 하이픈 없이 쓰고 사용한다. 이것은 m4 내에서 builtin primitive (역자주: 미리 내장된 기초 요소)가 표기되는 방법이다.

( -------------------- 역자 주 ------------------------------------------- * `builtin' 은 "내장 매크로"나 "내장"으로 번역하였다.

* 아울러 원래 영문 매뉴얼의 모든 예문들은 디버깅 레벨이 여러분들의 GNU m4 와는 조금 다르게 세팅이 되어 있는 것으로 보이는 데 debugmode 옵션을 조금 조정해주면 똑같은 결과를 볼 수 있다.

* 아래에 나오겠지만 예문으로 나오는 forloop는 내장 매크로가 아닌 사용자 정의 매크로로서 따로 정의하여 사용하여야 한다. 그 방법은 해당 예문에서 따로 표시하였다.

-------------------------------------------------------------------------)