== CWEB 시스템 == $$\hbox{CWEB}=\hbox{C programming language}+\hbox{\TeX}$$ from KTUGContrib:3195 (by 작은나무) 문학적 프로그래밍 시스템으로 가장 많이 사용되는 것이 아마 CWEB일 것입니다. 문학적 프로그래밍 시스템은 기본적으로 조판언어와 컴퓨터프로그래밍 언어로 구성되는데, CWEB은 가장 많이 사용되는 조판언어인 TeX과 가장 많이 사용되는 C언어의 조합으로 구성된 시스템입니다. 따라서 CWEB이 가장 많이 사용되는 시스템이라고 해서 이상할 것이 하나도 없겠지요? === CWEB 소개 === 아래의 글은 CWEB 사용자 설명서(cwebman)의 ''Introduction''을 번역한 내용입니다. CWEB의 배경이 되는 철학은, 자신이 작성하고 있는 프로그램에 대해서 가능한 최상의 문서를 제공하고자 하는 프로그래머는 문서 조판을 위해서 TeX과 같은 언어와 프로그래밍을 위해서 C 언어와 같은 두 가지 도구가 동시에 필요하다는 것입니다. 이 두 가지 언어 중 어느 한 가지만 가지고는 최상의 문서를 제공할 수 없습니다. 하지만 이 두 가지 언어를 적절히 조합하면, 각각의 언어가 제공할 수 있는 기능보다 더욱 유용한 기능을 갖춘 시스템을 구성할 수 있습니다. 소프트웨어 프로그램의 구조는 내부적으로 많은 작은 부분들이 서로 긴밀히 연결되어 있는 "웹(web)” 이라고 생각할 수 있습니다. 그러한 프로그램을 문서화하기 하기 위해서 그 웹을 구성하는 각각의 개별적인 부분들을 설명하고, 그 부분들이 그의 이웃들과 어떠한 연관이 있는지를 설명하는 것이 좋은 방법일 것입니다. TeX으로 제공되는 조판 도구는 각 부분을 읽기 좋게 해 줌으로써 그의 구조를 쉽게 파악 할 수 있게 해주고, C 언어로 제공되는 프로그래밍 도구는 알고리즘들을 보다 수학적으로 명확하게 기술할 수 있게 해줍니다. 이러한 두 가지 도구를 조합함 으로서, 소프트웨어의 복잡한 구조를 쉽게 파악 할 수 있도록하는 프로그래밍이 가능합니다. 동시에 그 문서화된 프로그램은 기계적으로 소프트웨어 시스템으로 변환되어 실행 시스템을 만들 수 있습니다. CWEB 시스템은 CWEAVE 와 CTANGLE 이라고 불리는 두 개의 프로그램으로 구성되어 있습니다. CWEB 프로그래밍을 할 때는, CWEB 파일 이라고 불리는 하나의 파일에 C 코드와 문서화를 위한 코드를 동시에 작성하고, 일반적으로 something.w 과 같이 이름 짓습니다. 다음과 같은 명령어 ‘cweave something’는 something.tex 파일을 생성하고, 이 파일은 TEX 을 통하여 something.w을 페이지 레이아웃과 프로그램의 들여쓰기, 그리고 예약어나 변수명 혹은 수학 기호들을 각각 다른 폰트로 표현하는등 우리들이 쉽게 읽을 수 있도록 멋진 출력물로 만들어 냅니다. 이 출력물에는 cweave 명령어가 자 동적으로 만들어 낸 색인도 포함됩니다. 비슷하게, ‘ctangle something’ 이란 명령을 실행하면 something.c란 이름의 C 파일을 얻을 수 있고, 이 파일은 컴파일을 통하여 실행 파일을 얻을 수 있습니다. CWEB은 C 프로그래밍에 단순히 문서화 도구를 제공한다는 것 외에, C 언어를 보다 강화시키는 측면이 있습니다. 즉 보통의 C 프로그래밍에서는 불가능한, 전체 프로그램을 여러 작은 조각들로 나누고 그 조각들을 여기저기 새롭게 배치할 수 있습니다. 이렇게 함으로 프로그램을 순차적으로 설명하는 것이아니라, 알고리즘 혹은 자료 구조적으로 의미적으로 관련있는 부분들을 섹션이라는 이름으로 한 곳에 배치해서 자세히 설명함으로써 각 섹션을 자세히 설명하고, 그러한 섹션들의 연관 관계를 설명함으로 전체 프로그램을 보다 이해하기 쉽게 설명할 수 있습니다. CTANGLE 프로그램은 이처럼 C 문법에 어긋난 방식으로 작성된 CWEB 프로그램을 C 언어 문법에 맞게 다시 재배치 하기 때문에 ctangle 이라는 이름을 얻게 되었습니다. CWEB 으로 프로그래밍하면 얻을 수 있는 잇점은 각 섹션을 개별적으로 설명할 수 있다는 것을 이용해서 프로그램에 사용된 알고리즘들을 이러한 섹션들을 이용하여 묶어서 한 곳에서 “untangle”의 형태로 표현할 수 있다는 점입니다. CWEAVE 프로그램은 CWEB 파일을 입력 받아서 각 섹션을 구성하는 TeX 부분과 C 부분을 서로 엮은 후에 (intertwine) 그러한 section들로 구성된 직물(fabric)로부터 하나의 구조화된 문서를 짜내기(weave) 때문에 cweave 라는 이름을 얻었습니다.(이해가 되십니까?) 영어 단어 “weave”에 해당하는 독일 단어가 ''webe''이고, 그에 해당하는 라틴어가 ''texe'' 라는 것에는 아마도 일종의 깊은 연관을 것입니다. 여러분이 CWEB을 사용하고자 한다면, 반드시 C 프로그래밍 언어에 익숙해야 할 것입니다. 최소한의 TeX에 대한 지식도 있으면 좋겠지만, CWEB 프로그래밍을 하면서 TeX에 대한 지식은 자동적으로 얻게 될 것입니다. 이는 TeX에서 사용되는 단순한 텍스트는 TeX에 대한 지식이 거의 없어도 가능하기 때문입니다. 물론 C 언어와 TeX에 모두 익숙한 독자는 CWEB 을 매우 쉽게 배울 수 있습니다. 아래 첨부파일은 CWEB의 메뉴얼인 cwebman.tex의 초반부의 내용인 문학적 프로그래밍과 CWEB의 개념을 번역한 것입니다. 메뉴얼의 후반부는 컴퓨터 프로그래밍에 관련된 부분이라 생략했습니다. attachment:korean_cwebman.pdf CWEB 시스템 말고도 많은 문학적 프로그래밍 시스템들이 존재합니다. [http://www.literateprogramming.com literateprogramming.com] 웹사이트를 방문해 보시면, 매우 다양한 시스템들을 접할 수 있습니다. 이 사이트는 Knuth의 웹페이지에도 소개된 매우 훌륭한 웹사이트입니다. === CWEB 사용법 === $$\hbox{cweb}=\hbox{ctangle}+\hbox{cweave}$$ * 확장자가 .w인 텍스트 파일, 예를들어 foo.w 이란 파일을 만듭니다. foo.w는 web 혹은 cweb 파일인데, 프로그래밍 소스와 그에 해당하는 도큐먼트를 동시에 가지고 있는 파일입니다. cweb 프로그래밍을 할때는, 이처럼 프로그래밍과 도큐먼트를 동시에 생각해야 합니다. * 아래와 같은 명령어로 cweb 파일 foo.w로부터 프로그래밍 소스 파일 foo.c(혹은 foo.cpp)을 만들어냅니다. {{{ % ctangle foo }}} * ctangle로 부터 생성된 foo.c를 gcc같은 C 컴파일러를 이용해서 실행 파일을 만들어 냅니다. * 다음의 명령어로는 foo.w로 부터 TeX 파일인 foo.tex을 얻습니다. {{{ % cweave foo }}} * cweave로 부터 나온 foo.tex은 PlainTeX을 이용하여 foo.dvi를 만듭니다. {{{ % tex foo }}} 또는, pdf의 기능을 십분 발휘하고 싶으시다면, 다음과 같이 하시면 됩니다. {{{ % tex "\let\pdf+ \input foo" }}} * 원래의 cweb 시스템은 PlainTeX 매크로를 이용합니다만, LaTeX을 이용한 cweb도 있습니다. (LaTeX용 CWEB: attachment:cweb-user.pdf) 위 과정을 그림으로 나타내면 다음과 같습니다. attachment:cweave.jpg === Microsoft Visual C++에서 CWEB 프로그래밍 하기 === CWEB 프로그래밍 작업은 전통적(?)으로 명령행에서 이루어져 왔습니다 (믿거나 말거나). 하지만 시간이 흐름에 따라 더이상은 고리타분하게 보일 수도 있는 명령행에서의 작업을 고집할 수 없는 상황이 되었나봅니다. 개발 환경은 IDE라는 수려하고 편리한 통합 개발 환경으로 대체된지 이미 오래입니다. 이에 cweb 프로그래밍 작업 역시 변화의 흐름에 발 맞추어서 IDE의 대표격이라고 할 수 있는 Microsoft Visual C++와 손을 잡았습니다. attachment:cwebmsvc.pdf 위 문서는 Visual C++에서 cweb 프로그래밍을 하기 위한 세팅 방법과 사용 방법, 여러가지 cweb 팁이 들어있는 유용한 문서라고 생각됩니다. === CWEB 예제 === 저는 C 프로그래밍을 해야할 때면, 언제나 CWEB으로 프로그래밍을 하고 있는데, CWEB 프로그래밍은 정말 재미있습니다. 제 말을 못 믿으시겠다면, Knuth 말은 믿으시겠죠? Knuth는 종종 그의 집 연구실에서 나올 때 이렇게 말한다네요. "''CWEB programming is such fun!''" * Knuth가 손수 작성한 CWEB의 대표적인 예제: attachment:wc.pdf * CWEB 프로그램의 주옥같은 예제들 (http://www.literateprogramming.com/fexamples.html) * Vector rotation CWEB 예제: attachment:vrotate.tar.gz * 존벤틀리의 ''Programming Pearls'' 제1컬럼에 나오는 비트맵 정렬을 cweb으로 작성한 예제: attachment:bitmap.pdf === LaTeX을 이용한 CWEB 프로그래밍 === WEB/CWEB 은 기본적으로 TeX 을 사용하도록 설계되어 있지만 여러가지 방법을 이용해서 LaTeX 에서 사용할 수 있다. 크게 다음의 두가지 방법이 있다. * CWEB을 이용하는 방법 * NOWEB을 이용하는 방법 ==== CWEB 을 이용하는 방법 ==== CWEB으로 작성된 w 파일을 기반으로 한다. cweb.cls 라고 하는 클래스 파일이 있으므로 이를 이용하게 된다. * 장점 : 기존의 w 파일들을 몇가지 변경함으로서 LaTeX 상에서 사용이 가능하다. * 단점 : 클래스 파일만을 제공함으로서 본격적인 확장이 거의 불가능 하다. 예를 들어서 메모아와 같이 사용하기 위해서는 클래스 파일인 cweb.cls 를 .sty 파일로 변경해야 하는데, 이 노력은 거의 무의미 하다고 생각이 된다. ==== [noweb] 을 이용하는 방법 ==== [noweb] 은 LaTeX 을 이용할 수 있도록, 또 여러가지 프로그래밍 언어를 사용할 수 있도록 변경한, WEB 이다. 실제로 LaTeX 을 사용하기 위해서는 [noweb] 을 사용하는 것이 정답이라고 볼 수 있다. * 장점 : 스타일 파일만을 제공함으로서 기존의 클래스들과 혼용하여 사용하는 것이 가능하다. 여러가지 프로그래밍 언어를 제공한다. * 단점 : nawk 등 다른 유틸리티를 사용하여 소스를 컴파일 하게 되므로 직관적이지 않은 설치과정이 필요하다. 기존의 CWEB 언어와는 조금 다르다. ==== 기타 자료 ==== LaTeX에서 CWEB 프로그래밍을 위한 방법이 설명되어 있습니다. * KTUGContrib:3252 (by [smcho]) * KTUGContrib:3236 (by [smcho]) === CWEB의 한글화 === CWEB의 한글화에 최대 걸림돌 이었던 한글 북마크 문제가 김도현님의 수고로 해결 되었습니다. (KTUGContrib:3258) 이제는 CWEB 프로그래밍의 새로운 섹션 그룹을 시작하는 별표섹션(starred section: @*) 및 섹션 제목들(@<...@>)에 한글을 사용할 때, 해당 북마크에 한글이 나오지 않는 현상이 없어졌습니다. 이로 인하여 보다 읽기 쉬운 프로그램 작성이 가능해 졌습니다. 한글이 포함된 CWEB 프로그래밍을 할 때는, 김도현님의 글에 소개되어 있듯이, 작성하는 소스 파일(.w)의 in limbo를 {{{ \input ucsplain \input cwbucsol }}} 로 시작하면 됩니다. * '''참고''': KTUGContrib:3261 (by [작은나무]) CWEB의 한글화를 테스트한 내용입니다. 단순한 영어 문구를 한글로 바꾼 것입니다. 좀 더 세심한 작업이 진행 되어야 합니다. === CWEB 설치 시 한글(UTF-8) 고려사항 === '''주의''': 이 절의 내용은 Hangul-ucs를 이용하여 ucsplain.tex를 사용하는 경우에만 해당하는 것이고, HLaTeX을 이용하여, htex.tex을 사용하시는 분이라면, 관계없는 내용입니다. 먼저, utf-8로 작성된 소스 파일(.w)로 cweb 프로그래밍을 하기위해서는 cweb을 다시 설치해야 합니다. [ftp://ftp.cs.stanford.edu/pub/cweb/cweb.tar.gz cweb.tar.gz]를 다운 받으시고, 아래 내용을 참고 하시면 됩니다. UTF-8로된 한글을 포함하는 cweb의 소스 파일인 .w 파일로부터 ctangle과 cweave 명령어를 이용해서 C 프로그램 파일인 .c 파일과 TeX 파일인 .tex을 만들다보면, 입력이 너무 길다는 경고 메시지가 나옵니다. 이는 위명령어들이 파일을 처리하기 위해서 내부적으로 버퍼(char 배열)를 가지고 있고, 그 버퍼의 끝을 나타내는 buffer_end가 작아서 나오는 경고 메시지입니다. 이 경우는 버퍼의 끝을 나타내는 변수 buffer_end를 충분히 크게해주면 발생하지 않는 경고 메시지입니다. 영어의 경우는 알파벳 한문자가 1바이트이기 때문에 그러한 경고 메시지가 없습니다. (물론 영어의 경우도 한 줄을 너무 길게하면 그런 메시지가 나오겠죠.) utf-8로 된 경우는 한 문자를 1바이트에서 최대 4바이트까지 표현한다고 합니다. 따라서 utf-8로 작성된 소스의 경우를 위해서 buffer_end를 최대 4배가 되게하면 됩니다. ctangle과 cweave의 화일 입출력에 대한 부분이나 공통 부분은 common.w에 있는데, buffer_end에 대한 내용이 바로 이 파일에 있습니다. common.w의 일부 {{{ @d buf_size 100 /* for \.{CWEAVE} and \.{CTANGLE} */ @d longest_name 1000 @d long_buf_size (buf_size+longest_name) /* for \.{CWEAVE} */ ... @= char buffer[long_buf_size]; /* where each line of input goes */ char *buffer_end=buffer+buf_size-2; /* end of |buffer| */ ... }}} 따라서 buf_size를 최대 4배 크게하던가, 아니면, buffer_end를 정의하는 부분에 사용한 buf_size 대신에 long_buf_size를 사용하면 됩니다. 저는 cweb을 설치할때, 두번째 방법을 사용해서 설치해서, utf-8로 된 문서를 컴파일할때도 ctangle이나 cweave가 묵묵히 그저 제 할 일을 합니다. 이것이 utf-8로 된 문서의 근본적인 해결책인지, 임시방편적인 방법인지는 모르겠으나, 적어도 위의 경고 메시지를 없앨 수는 있습니다. '''참고''' cweb에 관련한 프로그램 소스를 고칠 일이 있을 때, 해당 소스를 직접 고치는 일은 올바른 방법이 아닙니다. cweb에는 이러한 경우를 위해서 확장자가 .ch 인 change 파일 기능을 제공합니다. 예를들어 위의 경우 처럼 common.w 파일을 수정할 일이 있으면, comm-utf8.ch 와 같은 파일을 만들어서 common.c 파일을 만들어 낼때, {{{ ctangle common.w comm-utf8.ch }}} 와 같이 하면 됩니다. comm-utf8.ch에 들어가는 내용은 {{{ @x char *buffer_end=buffer+buf_size-2; /* end of |buffer| */ @y char *buffer_end=buffer+long_buf_size-2; /* end of |buffer| */ @z }}} 와 같이 하시면 됩니다. (.ch 파일을 만드는 방법은 cweb 사용자 설명서인 cwebman.pdf를 보시면 잘 나와있습니다.) 원본 .w 파일을 직접 수정하셔도 문제가 될 것은 없습니다만 정석이 아니라는 것이죠.