GObject programming

GLib, GObject ...

IBus open source project에 참여하다가 GLib을 알게 되었습니다. IBus는 linux 계열의 OS에 다국어 입력을 지원하는 Input method framework을 제공합니다. IBus 는 많은 다른 open source 기술들로 구현되어 있는데, 그 중 대표적인 것이 GLib 이었습니다. 

이 GLib에 대한 이야기를 하고 싶어 처음으로 저도 블로그를 시작하게 되었네요. ^^;

GLib은 단순한 library가 아닙니다. C 언어로 OOP style로 programming 할 수 있게 해주며, 다른 high level scripting 언어와의 연결을 지원합니다. 게다가 program에 필수적인 자료구조들과 signal, object property, event loop 같은 유용한 기능들도 지원해서 마치 programmer를 위한 종합 선물세트 같은 녀석이 GLib 입니다. 게다가 대부분의 open source들이 이녀석을 기본적으로 사용하고 있어서, 알아두면 두고두고 좋을 녀석입니다. 예를 들면 clutter, webkitGTK, GTK+, GStreamer 등이 있고 그외에도 많습니다.

그런데 안타깝게도 이 녀석에 대한 소개글이 영문으로 된 공식 홈페이지 이 외에는 찾기가 어렵다는 점입니다. 이마저도 처음에 접하기에는 상당히 어렵게 기술되어 있어서 우리나라 programmer들이 이 훌륭한 녀석을 사용하기가 어렵다는 점이 단점입니다.

그래서 제가 알고 있는 지식을 공유하고 도움을 주고자 이 블로그를 시작하게 되었습니다.

그럼 이제 본론으로 들어가겠습니다. 다음과 같은 내용들을 다룰 예정입니다.

1. GObject 서브 클래스로 type 정의하기.
2. class의 property 정의 및 사용
3. Inheritance example
4. Interface 설명

이 중에서 이글을 1번을 다룹니다. 차후에 이어지는 글에서 나머지도 다루겠습니다. 이 내용을 이해하기 위해서 필요한 지식은 C언어를 알아야 하고, OOP에 대한 기본적인 개념을 알고 있어야 합니다. 

GObject : object-oriented C-based APIs

GLib에서는 새로운 object type을 정의하기 위해서 GType library를 사용합니다. gtype.h에는 다음과 같은 구조체가 정의되어 있습니다.

typedef struct _GTypeInfo               GTypeInfo;
struct _GTypeInfo
{
  /* interface types, classed types, instantiated types */
  guint16                class_size;
  
  GBaseInitFunc          base_init;
  GBaseFinalizeFunc      base_finalize;
  
  /* classed types, instantiated types */
  GClassInitFunc         class_init;
  GClassFinalizeFunc     class_finalize;
  gconstpointer          class_data;
  
  /* instantiated types */
  guint16                instance_size;
  guint16                n_preallocs;
  GInstanceInitFunc      instance_init;
  
  /* value handling */
  const GTypeValueTable *value_table;
}; // Figure 1. GTypeInfo structure

위 구조체 필드에 정보를 채우고 g_type_register_static 함수를 호출해서 새로운 type을 등록합니다. 구조체 필드가 복잡해 보이는데, 써보면 별 것 아닙니다. ^^;

각 필드에 대해서는 차차  설명하기로 하고, 여기서는 위 구초체를 정의하고 g_type_register_static 계열의 함수로 type을 등록한다 정도만 알아두면 됩니다.

Figure 2

위 코드는 StudentInfo 객체를 정의하기 위해 필요한 구조체들을 선언한 것입니다. 먼저 StudentInfo 구조체를 보면, 여기에는 class의 멤버 변수(member variable)를 선언합니다. StudentInfoPrivate 구조체는 멤버 변수 중에서 이 클래스에서만 사용가능한 변수를 선언해 놓은 것으로, 자바의 private 변수와 개념적으로 같습니다.

StudentInfoClass는 class의 멤버 함수 (member function)을 정의하는 곳입니다. 위에는 학생 정보를 출력하는 함수를 담을 "함수 포인터" 변수를 선언했습니다.

이 정의에서 살펴볼 점은 구조체를 선언할 때 _StudentInfo 와 StudentInfo를 이용했다는 점입니다. _를 이용한 정의는 실제 구조체 내용을 볼 수 있는 부분이고, StudentInfo 라고 typedef 한 부분은 실제 코드에서 사용할 type 이름이 됩니다. 이렇게 하면 StudentInfo의 정의를 참조할 때 쉽게 찾을 수 있다는 장점이 있습니다. _StudentInfo만 검색하면 되니까요.

이제 이 StudentInfo를 GLib type 시스템에 등록하는 방법을 살펴보겠습니다.

Figure 3

Figure 1에서 보았던 GTypeInfo 구조체에 정보를 채우고, 이를 g_type_register_static 함수에 넘겨주는 방식으로 object type을 등록합니다. GTypeInfo 구조체의 각 필드를 보면 다음과 같습니다.

1. class_size : 첫번째 필드는 StudentInfoClass 구조체의 크기를 나타냅니다.
2. base_init : 두번째 필드는 class를 초기화하는 함수 중 하나인 base_init 함수를 등록하는데, 사실 이 함수는 거의 쓰이지 않습니다. 대부분을 이 값을 NULL로 설정하지만, 여기서는 차후 간단 설명을 위해서 student_info_base_init 함수를 등록했습니다.
3. base_finalize : 세번째 필드는 base_finalize 함수를 등록하는데, 이 역시 거의 쓰이지 않으므로 사용하지 않습니다.
4. class_init : 네번째 필드는 진정으로 class를 초기화하는 함수인 class_init 함수를 등록합니다. 이 함수는 class member function을 정의하고, class property를 설정하고 private 구조체를 등록합니다. 
5. class_finalize : class가 destroy 될 때 호출되는 함수를 정의합니다. 해당 클래스의 마지막 instance가 사라질 때 class가 destroy되는데, 이때 필요한 작업을 정의하는 함수가 class_finalize 함수입니다.
6. class_data : class 전체에서 사용할 필요가 있는 데이터를 선언합니다. C++의 정적 멤버와 비슷한 역할을 합니다.
7. instance_size : StudentInfo의 크기를 설정합니다. 즉, instance 구조체의 크기를 설정합니다.
8. n_preallocs : GLib 2.10 이전에 사용되던 필드입니다. GLib 2.10 이후부터는 무시되는 필드이기 때문에 0으로 설정합니다.
9. instance_init : class_init 함수 호출 이후, instance를 초기화할 때 호출되는 함수입니다. 

각 필드에 대한 설명을 간략히 했습니다만, 사실 이는 object를 직접 선언하고 사용해보면 더 명확해질 것입니다. 

StudentInfo object를 사용하기 위해서 남은 것은 위에 선언한 함수들을 구현하는 작업입니다.

Figure 4

student_info_base_init 함수는 거의 사용되지 않는 함수이고, 이 함수는 나중에 inheritance 설명할 때 나올 것이므로 일단 넘어갑니다. student_info_class_init은 중요한 함수입니다. class에 관한 다양한 설정을 할 수 있는 곳이죠. 이 함수는 class 가 생성될 때 GLib에 의해 자동으로 호출됩니다. 

123 줄은 StudentInfoClass 타입 포인터를 GObjectClass 타입 포인터로 cast 하는 것입니다. 여기서 G_OBJECT_CLASS macro가 사용되었는데, 이는 superclass와 subclass간 cast 연산을 수행하기 위해서 GLib에서 제공하는 macro 입니다. StudentInfo class에 대해서도 비슷한 macro를 정의할 수 있습니다. 

Figure 5

STUDENT_TYPE_INFO는 StudentInfo class의 type 정보를 얻기 위한 macro 입니다. 위에서 우리가 student_info_get_type() 함수는 구현했었죠? 


STUDENT_INFO와 STUDENT_INFO_CLASS는 GObject와 GObjectClass 구조체를 StudentInfo와 StudentInfoClass로 각각 cast 하기 위한 macro 입니다. 그리고 STUDENT_IS_INFO는 obj가 StudentInfo type인지 알아보는 macro 이며, STUDENT_IS_INFO_CLASS는 klass가 StudentInfoClass인지 알아보는 macro 입니다.

마지막으로 STUDENT_INFO_GET_CLASS는 obj의 class 구조체 포인터를 얻는 macro 입니다. 이런 macro들의 사용 예는 후에 설명하겠습니다. 어쨌든 이런 macro들은 모두 GLib에서 제공하는 G_TYPE_ 계열의 함수를 사용해서 정의하게 됩니다. 이에 대해 자세히 알아보려면 Type information API를 정의한 공식 문서를 참고하기 바랍니다. 

다시 위 코드(figure 4)로 돌아와서, 125줄은 StudentInfoClass의 부모 클래스 구조체 포인터를 얻기 위한 문장입니다. StudentInfoClass의 부모 클래스 구조체는 figure 3, 31줄의 g_type_register_static 함수의 첫번째 인자로 넘겨준 type입니다. 바로 G_TYPE_OBJECT 즉, GObjectClass가 StudentInfoClass의 부모 클래스 구조체라고 할 수 있습니다. 

125줄의 g_type_class_peek_parent는 인자로 받은 class의 부모 클래스 구조체 포인터를 얻을 수 있는 함수입니다. StudentInfoClass가 처음으로 메모리에 생성될 때, 그 부모 클래스인 GObjectClass가 먼저 생성되게 됩니다. StudentInfoClass 구조체는 첫번째 멤버로 GObjectClass를 포함하고 있는데, 이 GObjectClass의 내용은 앞서 생성된 GObjectClass의 내용을 copy해서 채워지게 됩니다. 즉, 메모리에는 GObjectClass가 어딘가에 생성되어 있고, 이것의 내용을 copy해서 StudentInfoClass의 첫번째 멤버인 GObjectClass 구조체를 채우게 되는 것입니다. 따라서 g_type_class_peek_parent로 얻어지는 포인터는 메모리에 어딘가에 생성되어 있는 GObjectClass의 포인터를 얻어오는 것이며, StudentInfoClass 안의 첫번째 멤버의 포인터를 얻어오는 함수는 아닙니다. (사실 StudentInfoClass의 첫번째 멤버에 대한 포인터를 얻으려고 함수를 호출할 필요도 없습니다. StudentInfoClass의 주소가 첫번째 멤버에 대한 포인터가 될 테니까요.) 이것을 이렇게 자세히 설명하는데에는 이유가 있습니다. 이 내용이 C로 Inheritance 및 Polymorphism 을 구현하는 핵심적인 내용이기 때문입니다. 

127번부터 129번까지의 줄은 GObject의 멤버 함수들을 override 하고 있습니다. GObject 포인터가 StudentInfo 객체를 가리키고 있을 때, 그 포인터로 호출된 get_property 함수는 student_info_get_property 함수를 호출하게 됩니다.

131번 줄은 StudentInfo 객체의 멤버 함수를 정의하고 있습니다. 여기서는 print 함수 하나만 정의하고 있네요. 

133번 줄은 StudentInfo의 멤버 변수들을 등록하고 있습니다. 이렇게 등록된 멤버 변수들은 나중에 정의할 STUDENT_INFO_GET_PRIVATE 마크로를 통해서 access 하게 됩니다.

135번부터 151번 줄까지는 객체의 속성(property)들을 정의하고 있습니다. 이렇게 속성을 정의하고 멤버 변수와 연관시켜서 동작하게 되는데, 이는 차후에 살펴볼 예정입니다.

Figure 6

Figure 3 에서 gtype_info에 등록한 함수 중에 마지막 함수입니다. 객체의 instance를 초기화하는 함수인 student_info_init 함수입니다. 157줄에 STUDENT_INFO_GET_PRIVATE가 보이는데요. 이는 다음처럼 정의합니다.

student_info_init 함수에서 StudentInfo의 priv 멤버를 이 마크로로 초기화하고, priv가 가리키는 변수들을 access 함으로써 instance의 초기화를 수행합니다. 여기서는 그냥 NULL로 멤버 변수를 초기화했는데, NULL값 초기화는 자동으로 이루어지므로 사실 필요없습니다. 멤버 변수를 동적으로 메모리를 할당한다거나 그외 초기값을 줄 필요가 있을 때에는 여기서 초기화를 하면 됩니다.

이제 StudentInfo 객체를 만들기 위한 기본적인 함수들이 정의되었습니다. 남은 함수는 멤버함수인 student_info_print 함수와 객체가 파괴될 때 호출되는 student_info_finalize 함수, 그리고 property 관련 set/get 함수들이 있습니다. 

Figure 7

student_info_print 함수부터 살펴봅시다. 108줄과 109줄은 인수로 받은 포인터가 StudentInfo type인지를 check합니다. g_return_if_fail 함수는 인수로 받은 식이 거짓이면 함수를 return하는 GLib의 Debugging 함수입니다. 이런 종류의 또다른 debugging 함수가 보고 싶다면 여기를 참고하세요. 109줄에서 GObject 포인터가 StudentInfo 객체를 가리키고 있는지 검사하는 macro가 사용되었습니다. 이 macro는 figure 5에 정의되어 있습니다. 

111줄에서 GObject 포인터를 StudentInfo 포인터로 cast합니다. 109줄에서 인수로 들어온 ob가 StudentInfo를 가르킨다는 사실을 알았으므로 이는 유효한 cast가 됩니다. 

113 ~ 114줄은 cast한 StudentInfo 포인터를 이용해서 멤버 변수를 출력하고 있습니다.

student_info_finalize 함수는 객체가 파괴될 때 GLib에 의해서 자동으로 호출되는 함수입니다. 이 함수를 우리는 figure 4에서 등록했습니다. 객체가 파괴될 때 호출되는 함수이므로, 여기서는 메모리 누수가 발생되지 않도록 정리하는 코드가 들어가야 합니다. 따라서 프로그램 실행 중에 동적으로 할당되었던 멤버 변수를 해제합니다. StudentInfo의 해제 코드를 모두 수행한 후, 102줄에서 부모 클래스의 finalize 함수를 호출합니다. 이렇게 해야 상위 클래스의 해제까지 가능하기 때문입니다.

여기까지 기본적인 객체의 생성 코드를 살펴봤습니다. 다음 글에는 property 관련 설명과 실제로 StudentInfo를 사용하는 예제를 보여드릴 예정입니다.