#ifdef...#endif와 Boost::Any

코딩을 하다 보면 #ifdef...#endif등의 preprocesor를 사용하게 되는 경우들이 있습니다. 주로 portable한 코드를 작성하기 위해 사용하곤 하지요.

이번 XMLCPP 라이브러리 구현중에 이와 유사한 필요가 생겼습니다. Unicode encoding, decoding을 위해 libiconv 라이브러리 를 사용하던 것을 libiconv없이도 사용할 수 있는 옵션을 만들기 위해서입니다. libiconv 라이브러리가 많은 encoding을 지원하여 좋긴 하지만 GNU license라 사용에 제약이 많은 편입니다. 제가 만드는 XMLCPP는 이런 제약 없이 모든 곳에서 사용할 수 있게 하고 싶어 자체적으로 encoding, decoding을 하는 코드를 집어 넣었습니다. ((물론 지원하는 encoding이 libiconv보다 적습니다. 현재 자체 코드에서 지원하는 encoding은 다음과 같습니다.

1. char, wchar_t


2. UTF-8


3. UCS-2, UCS-2BE, UCS-2LE


4. UTF-16, UTF-16BE, UTF-16LE


5. UCS-4, UCS-4BE, UCS4-LE


6. UTF-32, UTF-32BE, UTF-32LE

))

기본으로 libiconv를 사용하지 않도록 Makefile이 만들어져 있으며 libiconv를 사용하고 싶다면 Makefile에서 USE_ICONV 변수를 YES로 셋팅해 주면 됩니다.

먼저 자체 encoding, decoding 버전을 구현하기 전의 CodeConvImpl 클래스는 대략 다음과 같았습니다. ((여기서 CodeConvImpl 클래스는 CodeConv 클래스의 Pimpl Idiom을 위한 구현입니다.))

#include 

class CodeConvImpl
{
public:
  // ...
private:
  iconv_t desc_; // iconv.h에서 정의된 타입
};

이제 이를 컴파일러 옵션에 따라 iconv를 사용하지 않거나 혹은 사용하게 하려면 다음과 같이 할 수 있습니다.

#ifdef XMLCPP_USE_ICONV
#  include 
#endif

class CodeConvImpl
{
public:
  // ...
private:
#ifdef XMLCPP_USE_ICONV
  iconv_t desc_;
#else
  // ??
#endif
};

하지만 코드가 지저분해지고 따라서 읽기도 어려워집니다. 사실 private의 변수는 .cpp 파일에서만 알면 되는 것인데 말이죠.

사실 잘 만들어진 구조의 portable한 코드는 #ifdef등의 preprocessor를 거의 사용하지 않아도 되게 구성될 수 있습니다. 마치 잘 만들어진 exception safe란 코드가 catch 문이 거의 없는 것과 비슷한 원리라고 할까요? :-)

XMLCPP 라이브러리의 CodeConvImpl 클래스는 이를 위해 boost::any 라이브러리를 사용하여 다음과 같이 구성하였습니다.

class CodeConvImpl
{
public:
  // ...
private:
  boost::any desc_;
};

이제 cpp는 두개의 파일로 나누어집니다. 하나는 iconv를 사용하는 버전이고 다른 하나는 자체적으로 encoding, decoding을 하는 버전입니다. 파일 이름은 CodeConvImpl_iconv.cpp와 CodeConvImpl_noiconv.cpp입니다. ((만약 iconv 버전과 noiconv 버전간에 공통으로 사용할 코드들이 있었다면 CodeConvImpl.cpp에 같이 사용할 수 있도록 구현할 수 있었습니다만 현재 두 버전간에 같이 사용할 수 있는 코드가 없으므로 CodeConvImpl.cpp 파일은 없습니다.))

CodeConvImpl_iconv.cpp에서 desc_는 iconv_t 타입으로 사용되면 CodeConvImpl_noiconv.cpp에서는 이 cpp 파일안에 선언된 detail::codeconv_t 라는 타입으로 사용됩니다.

각 cpp 파일에서 any 타입의 desc_을 자신이 사용하는 타입으로 변환하기 위해서는 any_cast를 사용합니다.

마지막으로 Makefile에 다음과 같이 셋팅합니다.

USE_ICONV    := NO

OBJS         := Serializer.o ... Exception.o

ifeq (YES, $(USE_ICONV))
  BASE_CFLAGS  := $(BASE_CFLAGS) -DXMLCPP_USE_ICONV
  OBJS         := $(OBJS) CodeConvImpl_iconv.o
else
  BASE_CFLAGS  := $(BASE_CFLAGS)
  OBJS         := $(OBJS) CodeConvImpl_noiconv.o
endif

USE_ICONV가 YES이면 CodeConvImpl_iconv.o를 사용하여 .a 를 생성하고 NO이면 CodeConvImpl_noiconv.o를 사용하는 것이죠.

이런 방식으로 실제 코드에서는 #ifdef가 전혀 사용되지 않고도 두 버전을 구현될 수 있었습니다. :-)

이제 Roadmap에 따라 VC++ 포팅을 할 차례인데 VC++ build시에 이 사항을 어떻게 적용해야 할지 고민해 봐야 겠네요. :-|

추가로, 이런 방법은 boost와 같이 헤더 파일로 이루어진 template library에는 적용하기 어렵습니다. 이런 경우에는 되도록이면 #ifdef 문들을 하나의 config.h와 같은 헤더 파일에 모으는 방법을 사용할 수 있습니다.