[[TableOfContents]] == 문학적 프로그래밍 이란? == '''문학적 프로그래밍'''(literate programming)은 프로그래밍 방법론의 한 가지로, 프로그래밍을 할 때 컴퓨터로 컴파일 가능한 코드를 만드는 것보다 사람이 이해하기 쉬운 코드를 만드는 것에 중점을 두는 방법이다. 즉, 사람이 보고 이해할 수 있도록 문서를 만들듯이 프로그래밍을 하는 것이 목적이다. '마치 문학작품을 읽는 것처럼 프로그래밍을 읽을 수 있도록 만드는 것'이 목표이므로 '문학적 프로그래밍'이라는 이름을 지었다. (출처: ''위키백과-문학적 프로그래밍'') === 기원 및 소개 === 문학적 프로그래밍(''Literate programming'')은 우리에게 TeX의 저자로 알려진 Knuth가 만들어낸 프로그래밍의 새로운 패러다임입니다. Knuth가 이에 대한 개념을 구체화하기 시작한 것이 1980년대 초반이니까 2006년 현재로써는 '새로운'이란 단어가 좀 무색해 집니다. 하지만 현재까지도 그리 널리 이용되고 있지는 않으듯 싶습니다. 전산학에는 전산학의 노벨상이라 불리는 튜링상(A. M. Turing Award: http://awards.acm.org/turing/) 이 있습니다. 1974년 튜링상 수상자는 알고리즘의 분석과 프로그래밍 언어의 디자인 그리고, ''The art of computer programming'' 이라는 저서로 그 분야에 많은 공헌을 한 Knuth 였습니다. 관례(?)로써 그 해 튜링상을 받은 사람은 ACM Turing Award Lecture라는 이름으로 강의를 하게 되어 있는데, 1974년 그 강의의 제목은 ''Computer Programming as an Art''(attachment:knuth-turingaward.pdf)였습니다. Knuth는 여기서 컴퓨터 프로그래밍을 단순한 기술이 아닌 음악, 미술, 문학과 같은 종류의 하나의 예술 활동이라고 강조하고 있습니다. 그리고 결론부에는 컴퓨터 프로그래머 자신이 예술가라는 인식을 가지고 프로그래밍 작업에 임하면, 프로그래밍이 더욱 즐겁고, 그 결과 또한 더욱 좋을 것이라고 말합니다. To summarize: We have seen that computer programming is an art, because it applies accumulated knowledge to the world, because it requires skill and ingenuity, and especially because it produces objects of beauty. A programmer who subconsciously views himself as an artist will enjoy what he does and will do it better. Therefore we can be glad that people who lecture at computer conferences speak about the state of the Art. 문학적 프로그래밍은 이렇게 시작했나봅니다. 컴퓨터 프로그래밍을 예술로 보는 대가로 부터 말입니다. 위의 강의를 시작으로 눈에 보이는 본격적인 문학적 프로그래밍의 시작 또한 Knuth의 논문 Literate Programming (attachment:knuthweb.pdf) 에서 시작합니다. 이 논문에서 Knuth는 더이상 컴퓨터를 위해 프로그래밍을 하는 시대는 지났다고 말합니다. 사람을 위한 프로그래밍을 하자고 합니다. 물론 프로그래밍이라는 것이 컴퓨터에 일을 시키기 위한 명령들의 집합이지만, 이것에 연연하여 너무 컴퓨터에만 초점을 맞추지 말고, 사람들에게 눈을 돌리자는 것이지요. 컴퓨터 프로그래밍의 르네상스 시대가 온 것이지요. 이 논문에서 역시 일관되게 컴퓨터 프로그래밍을 문학 작품(''works of literature'') 으로 간주하고, 재미있는 말인 ''Literate Programming'' 이란 말을만들어 냈습니다. Knuth는 문학적 프로그래밍을 단순한 말장난에 그치는 것을 싫어해서 WEB이라는 시스템을 만들어 냈습니다. TeX이 WEB 시스템으로 만들어졌다는 것은 잘 알려진 사실이지요. I believe that the time is ripe for significantly better documentation of programs, and that we can best achieve this by considering programs to be works of literature. Hence, my title: ''Literate Programming.'' Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do. * WEB 으로 작성된 TeX 소스: http://ftp.ktug.or.kr/tex-archive/systems/knuth/tex/tex.web 컴퓨터 프로그래밍을 본격적으로 익히고자 하는 사람들은 반드시 읽어봐야 한다고 합니다. TeX에 익숙해지면 한번 도전해 보고자 합니다. * 관심있는 분을 위하여: pdf 파일을 만들어내는 과정을 다음과 같습니다. 위의 tex.web을 다운받으시고, {{{ % weave tex.web <-- tex.web 파일에서 tex.tex 파일을 얻습니다. % tex tex.tex <-- tex이 세번이나 쓰였네요. :) 이하 과정은 설명 안해도 잘 아시리라 믿습니다. % dvipdfmx tex.dvi }}} 위처럼 하여 만들어 진 책이 바로 Knuth의 저서 ''Computers & Typesetting'' 시리즈의 Volume B인 ''TeX: The Program'' 입니다. Volume D인 ''METAFONT: The Program''은 http://ftp.ktug.or.kr/tex-archive/systems/knuth/mf/mf.web 을 다운받으셔서 위와 같이 pdf를 만들어 내시면 됩니다. 여러분 돈 절약하신 겁니다. === Knuth의 문학적 프로그래밍 강의 비디오 === Knuth는 1987년 10~12월에 스탠포드대학에서 ''Mathematical Writing''이란 제목으로 강의를 하였습니다. 그 중 일부가 문학적 프로그래밍에 관한 내용입니다. 영어가 짧아서 다 알아듣지는 못하는데, 한가지 다행인 점은 강의 제목과 동일한 Mathematical Writing 이란 책이 있는데, 그 책은 이 강의를 수강한 학생들과 Knuth가 만든 책으로 "강의 노트"적인 성격이 짙습니다. 이에 그 책에서 해당 강의 부분을 올립니다. 비디오 시청에 많은 도움이 되리라 봅니다. * Presenting algorithm (강의 요약본: attachment:pa.pdf) http://proedvid.stanford.edu/seminars/knuth/871019-cs209/871019-cs209-100.wmv * Literate Programming(1) (강의 요약본: attachment:lp1.pdf) http://proedvid.stanford.edu/seminars/knuth/871021-cs209/871021-cs209-100.wmv * Literate Programming(2) (강의 요약본: attachment:lp2.pdf) http://proedvid.stanford.edu/seminars/knuth/871023-cs209/871023-cs209-100.wmv == CWEB 시스템 == === CWEB 소개 === $$\hbox{CWEB}=\hbox{C programming language}+\hbox{\TeX}$$ from KTUGContrib:3195 (by 작은나무) 문학적 프로그래밍 시스템으로 가장 많이 사용되는 것이 아마 CWEB일 것입니다. 문학적 프로그래밍 시스템은 기본적으로 조판언어와 컴퓨터프로그래밍 언어로 구성되는데, CWEB은 가장 많이 사용되는 조판언어인 TeX과 가장 많이 사용되는 C언어의 조합으로 구성된 시스템입니다. 따라서 CWEB이 가장 많이 사용되는 시스템이라고 해서 이상할 것이 하나도 없겠지요? CWEB은 TeX 프로그램을 만드는데 사용된 WEB 시스템보다 한층 나은 시스템입니다.WEB은 TeX과 Pacal 프로그래밍 언어로 이루어져있는데, C언어가 Pascal보다는 나은(?) 프로그래밍 언어이기 때문이랍니다. 아래 첨부파일은 CWEB의 메뉴얼인 cwebman.tex의 초반부의 내용인 문학적 프로그래밍과 CWEB의 개념을 번역한 것입니다. 메뉴얼의 후반부는 컴퓨터 프로그래밍에 관련된 부분이라 생략했습니다. attachment:korean_cwebman.pdf CWEB 시스템 말고도 많은 문학적 프로그래밍 시스템들이 존재합니다. http://www.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 * 꽤오래전에 재미삼아 작성한 것으로 하노이탑을 재귀적 루틴을 사용하지 않고 구현한 예제입니다. 하노이탑에 대한 설명 부분은 mathworld (http://mathworld.wolfram.com/TowerofHanoi.html)에서 인용하였습니다. plain TeX에서 한글을 쓰는 방법을 모르던 시절에 했던 것이라 영어로 되어 있고, 그래서 설명이 많이 부족합니다. attachment:hanoi.pdf == LaTeX을 이용한 CWEB 프로그래밍 == * KTUGContrib:3252 by [smcho] * KTUGContrib:3236 by [smcho] == CWEB 설치 시 한글(UTF-8) 고려사항 == '''주의''': 이 절의 내용은 Hangul-ucs를 이용하여 ucsplain.tex를 사용하는 경우에만 해당하는 것이고, HLaTeX을 이용하여, htex.tex을 사용하시는 분이라면, 관계없는 내용입니다. 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 파일을 직접 수정하셔도 문제가 될 것은 없습니다만 정석이 아니라는 것이죠.