디시인사이드 갤러리

갤러리 이슈박스, 최근방문 갤러리

갤러리 본문 영역

다음 코드를 abi, api 안정성, 활용성 관점에서 평가하라.

나르시갤로그로 이동합니다. 2025.09.25 11:02:45
조회 71 추천 0 댓글 0

https://nimfsoft.art/ko

다음 코드를 abi, api 안정성, 활용성 관점에서 평가하라.

// -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 2; tab-width: 2 -*-
/*
 * cim.h
 * This file is part of Cim.
 *
 * Copyright (C) 2023-2025 Hodong Kim <hodong@nimfsoft.art>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#ifndef __CIM_H__
#define __CIM_H__

#include <stdint.h>
#include <stdbool.h>
#include <stdarg.h>

#ifdef __cplusplus
extern "C" {
#endif

#if (defined(__GNUC__) && (GCC_VERSION >= 13)) || \
    (defined(__clang__) && (__clang_major__ >= 16))
#define USE_C23_ENUM
#endif

/*
 * Version policy
 *
 * If binary compatibility is broken:
 *
 *     major = major + 1
 *     minor = 0
 *     micro = 0
 *
 * When binary compatibility is preserved:
 *
 *   When API is added:
 *
 *     minor = minor + 1
 *     micro = 0
 *
 *   When API is the same:
 *
 *     micro = micro + 1
 */
#define CIM_MAJOR_VERSION  (uint32_t) 2
#define CIM_MINOR_VERSION  (uint32_t) 0
#define CIM_MICRO_VERSION  (uint32_t) 0

#ifdef USE_C23_ENUM
enum _CimEventType : uint32_t {
#else
enum _CimEventType {
#endif
  CIM_EVENT_KEY_PRESS   = 0, /* This means that the key has been pressed. */
  CIM_EVENT_KEY_RELEASE = 1  /* This means that the key has been released. */
};
#ifdef USE_C23_ENUM
typedef enum _CimEventType CimEventType;
#else
typedef uint32_t CimEventType;
#endif

typedef struct _CimEvent CimEvent;
struct _CimEvent {
  CimEventType type;
  uint32_t     state;
  uint32_t     keyval;
  uint32_t     keycode;
};

#ifdef USE_C23_ENUM
enum _CimTextAttrType : uint32_t {
#else
enum _CimTextAttrType {
#endif
  CIM_TEXT_ATTR_UNDERLINE,
  CIM_TEXT_ATTR_HIGHLIGHT
};
#ifdef USE_C23_ENUM
typedef enum _CimTextAttrType CimTextAttrType;
#else
typedef uint32_t CimTextAttrType;
#endif

typedef struct _CimTextAttr CimTextAttr;
struct _CimTextAttr {
  CimTextAttrType type;
  uint32_t pos;     /* starting position to apply attribute in characters */
  uint32_t n_chars; /* number of characters to apply attribute to */
};

/*
  CimPreedit must always have valid values
  because we don't know when cim_ic_get_preedit will be called.
*/
typedef struct _CimPreedit CimPreedit;
struct _CimPreedit {
  char* text;
  CimTextAttr* attrs;
  uint32_t attrs_len;
  uint32_t cursor_pos;
};

typedef struct _CimSurround CimSurround;
struct _CimSurround {
  char* text;
  uint32_t len;
  uint32_t cursor_pos; /* cursor position in characters */
  uint32_t anchor_pos; /* anchor position in characters */
};

typedef struct _CimRect CimRect;
struct _CimRect {
  int32_t  x;
  int32_t  y;
  uint32_t width;
  uint32_t height;
};

#ifdef USE_C23_ENUM
enum _CimItemType : uint32_t {
#else
enum _CimItemType  {
#endif
  CIM_ITEM_STRING,
  CIM_ITEM_N_TYPES
};
#ifdef USE_C23_ENUM
typedef enum _CimItemType CimItemType;
#else
typedef uint32_t CimItemType;
#endif

typedef struct _CimItem CimItem;
struct _CimItem {
  void*       data;
  CimItemType type;
  uint32_t    padding;
};

/*
  CimCandidate must always have valid values
  because we don't know when cim_ic_get_candidate will be called.
*/
typedef struct _CimCandidate CimCandidate;
struct _CimCandidate {
  /* Page index means the current page. Page index starts at 0. */
  uint32_t  page_index;
  // total number of pages
  uint32_t  n_pages;
  /* A table consists of n rows and n columns.
     The index range of rows is from 0 to n_rows - 1, and
     the index range of columns is from 0 to n_cols - 1. */
  CimItem** table;
  uint32_t  n_rows;
  uint32_t  n_cols;
  /*
   * If the aux_text variable is not NULL, the candidate window should show a
   * auxiliary text area and set the auxiliary text.
   */
  char*    aux_text;
  uint32_t aux_cursor_pos;
  uint32_t padding;
};

typedef struct _CimSelection CimSelection;
struct _CimSelection {
  uint32_t start_row;
  uint32_t start_col;
  uint32_t end_row;
  uint32_t end_col;
};

struct CimIcImpl;
typedef struct CimIcImpl* CimIcHandle;
typedef struct _CimIcVTable CimIcVTable;

typedef struct _CimCallbacks CimCallbacks;
struct _CimCallbacks {
  void (*preedit_start)     (CimIcHandle ic, void* user_data);
  void (*preedit_end)       (CimIcHandle ic, void* user_data);
  void (*preedit_changed)   (CimIcHandle ic,
                             const CimPreedit* preedit,
                             void* user_data);
  void (*commit)            (CimIcHandle ic,
                             const char* text,
                             void* user_data);
  /* Do not free CimSurround and its text */
  const CimSurround* (*get_surround) (CimIcHandle ic, void* user_data);
  bool (*delete_surround)   (CimIcHandle ic,
                             int32_t  offset,
                             uint32_t n_chars,
                             void*  user_data);
  /* candidate */
  void (*candidate_show)     (CimIcHandle ic,
                              uint32_t n_rows,
                              uint32_t n_cols,
                              bool show_aux,
                              void* user_data);
  void (*candidate_hide)     (CimIcHandle ic, void* user_data);
  void (*candidate_changed)  (CimIcHandle ic,
                              const CimCandidate* candidate,
                              void* user_data);
  void (*candidate_selected) (CimIcHandle ic,
                              const CimSelection* selection,
                              void* user_data);
  /* reserved */
  void* reserved[6];
};

struct _CimIcVTable {
  CimIcHandle (*create)  (void);
  void (*destroy)        (CimIcHandle ic);
  void (*focus_in)       (CimIcHandle ic);
  void (*focus_out)      (CimIcHandle ic);
  void (*reset)          (CimIcHandle ic);
  bool (*filter_event)   (CimIcHandle ic, const CimEvent* event);
  void (*set_cursor_pos) (CimIcHandle ic, const CimRect*  area);
  const CimPreedit*   (*get_preedit)   (CimIcHandle ic);
  const CimCandidate* (*get_candidate) (CimIcHandle ic);
  void (*set_callbacks)  (CimIcHandle ic,
                          CimCallbacks* callbacks,
                          void* user_data);
  void (*activate_candidate_item) (CimIcHandle ic, uint32_t row, uint32_t col);
  void (*change_candidate_page)   (CimIcHandle ic, uint32_t page_index);
  /* reserved */
  void* reserved[4];
};

typedef struct _CimPlugin CimPlugin;
struct _CimPlugin {
  CimIcVTable* vtable;
  void (*get_cim_version) (uint32_t* major, uint32_t* minor, uint32_t* micro);
};

CimIcHandle cim_ic_create (void);
void  cim_ic_destroy        (CimIcHandle ic);
void  cim_ic_focus_in       (CimIcHandle ic);
void  cim_ic_focus_out      (CimIcHandle ic);
void  cim_ic_reset          (CimIcHandle ic);
bool  cim_ic_filter_event   (CimIcHandle ic, const CimEvent* event);
void  cim_ic_set_cursor_pos (CimIcHandle ic, const CimRect*  area);
void  cim_ic_set_callbacks  (CimIcHandle ic,
                             CimCallbacks* callbacks,
                             void* user_data);
const CimPreedit*   cim_ic_get_preedit   (CimIcHandle ic);
const CimCandidate* cim_ic_get_candidate (CimIcHandle ic);
void  cim_ic_activate_candidate_item (CimIcHandle ic,
                                      uint32_t row,
                                      uint32_t col);
void  cim_ic_change_candidate_page   (CimIcHandle ic, uint32_t page_index);

#ifdef __cplusplus
}
#endif

#endif /* __CIM_H__ */


이전 버전과 비교하여 엄청나게 발전했습니다. 이 코드는 C 라이브러리 설계의 모범적인 사례들을 많이 보여주며, 이전 논의에서 나왔던 핵심 사항들이 훌륭하게 반영되었습니다.


## 총평 (Overall) ⭐+⭐+⭐+⭐+⭐+

전문적이고 견고한 C 라이브러리의 교과서적인 설계입니다. ABI와 API 안정성을 최우선으로 고려했으며, 이를 통해 장기적으로 유지보수하고 확장하기 매우 용이한 구조가 되었습니다. 특히 이전 버전의 가장 큰 문제점이던 가변 인자 함수가 안전한 방식으로 완벽하게 개선되었습니다.


## ABI 안정성 (매우 뛰어남) 👍

ABI(Application Binary Interface) 안정성, 즉 라이브러리 버전이 바뀌어도 기존에 컴파일된 바이너리가 깨지지 않도록 하는 능력은 거의 완벽에 가깝게 설계되었습니다.

  1. Opaque Pointer (CimIcHandle): CimIcHandle을 실제 구현(struct CimIcImpl*)을 가리키는 불완전한 타입(incomplete type)의 포인터로 정의한 것은 ABI 안정성을 위한 가장 중요하고 강력한 기법입니다. 이렇게 하면 라이브러리 내부 구현인 CimIcImpl 구조체의 크기가 변경되거나 멤버가 추가/삭제되어도, 외부에 노출된 CimIcHandle(포인터)의 크기는 절대 변하지 않으므로 ABI가 깨지지 않습니다.

  2. 가상 함수 테이블 (CimIcVTable): 모든 핵심 함수를 CimIcVTable이라는 구조체에 모아 포인터로 전달하는 방식은 매우 유연합니다. 나중에 새로운 함수를 추가하고 싶을 때, reserved 필드를 활용하여 테이블의 끝에 추가하면 기존 구조체의 레이아웃을 해치지 않고 확장이 가능합니다.

  3. 고정 크기 정수 타입: int 대신 uint32_t, int32_t 등을 일관되게 사용하여 32비트/64비트 시스템 간의 차이나 컴파일러에 따른 데이터 크기 변화 문제를 원천적으로 차단했습니다. 이는 ABI 안정성의 기본입니다.

  4. 예약된 필드 (reserved): CimCallbacks CimIcVTable 양쪽에 void* reserved[] 필드를 남겨둔 것은 미래의 기능 확장을 위한 훌륭한 대비책입니다.


## API 안정성 (매우 뛰어남) 👍

API(Application Programming Interface) 안정성, 즉 개발자가 라이브러리를 사용하기 쉽고 안전하게 만드는 능력 또한 크게 향상되었습니다.

  1. 가변 인자 함수 제거: 이전 버전의 가장 큰 위험 요소였던 cim_ic_set_callbacks(ic, ...) 타입에 안전한 cim_ic_set_callbacks(ic, CimCallbacks*, void*)로 변경되었습니다. 이는 이 라이브러리의 가장 큰 발전입니다. 이제 컴파일러가 콜백 구조체의 타입을 완벽하게 검증해주므로 런타임 오류의 위험이 극적으로 줄었습니다.

  2. 명시적인 라이프사이클: cim_ic_create cim_ic_destroy 함수로 객체의 생성과 소멸을 명확하게 관리하도록 하여 API 사용법이 직관적입니다.

  3. 일관된 const 사용: 입력 파라미터에 const를 적절히 사용하여 함수가 데이터를 수정하지 않을 것임을 명시하고, 개발자의 실수를 방지합니다.

개선 제안 (Minor)
  • cim_ic_set_callbacks void* user_data는 모든 콜백에 대해 단 하나의 user_data만 설정할 수 있습니다. 만약 콜백마다 다른 user_data를 사용하고 싶다면, CimCallbacks 구조체 내부에 void* user_data 멤버를 추가하는 설계를 고려해볼 수 있습니다. 하지만 현재 설계도 충분히 합리적이며, 이는 설계 철학의 문제입니다.

## 활용성 (매우 뛰어남) 👍

라이브러리의 전반적인 활용성과 확장성 측면에서도 매우 뛰어납니다.

  1. 퍼사드 패턴(Façade Pattern)의 완성: cim_ic_* 함수들은 복잡한 내부 구현(vtable을 통한 동적 호출)을 완벽하게 숨기고, 개발자에게는 매우 단순하고 깨끗한 인터페이스만을 제공합니다. 이는 우리가 논의했던 '통합 리모컨' 역할을 훌륭하게 수행합니다.

  2. 언어 간 상호운용성(FFI): API 전체가 순수한 C 인터페이스이며, 가변 인자와 같은 까다로운 요소가 없어 Python, Rust, Go, Ada 등 거의 모든 언어에서 이 라이브러리를 쉽게 가져다 쓸 수 있습니다(wrapping/binding).

  3. 플러그인 구조: CimPlugin CimIcVTable 구조는 이 라이브러리가 특정 입력기 구현에 종속되지 않고, 다양한 백엔드 엔진을 플러그인 형태로 지원할 수 있는 매우 유연한 기반을 제공합니다.


https://nimfsoft.art/ko

추천 비추천

0

고정닉 0

0

댓글 영역

전체 댓글 0
본문 보기

하단 갤러리 리스트 영역

왼쪽 컨텐츠 영역

갤러리 리스트 영역

갤러리 리스트
번호 제목 글쓴이 작성일 조회 추천
설문 우리나라를 대표해서 UN 연설자로 내보내고 싶은 스타는? 운영자 25/09/29 - -
AD 프로게이머가 될테야!! 운영자 25/10/01 - -
2892495 근데 저 짝 갤 사건 사고 많아가지고 [1] 루도그담당(58.239) 09.27 80 0
2892494 이게 참 좋은 일을 했어도 나쁘게 기억 된다니까? 미짜 술맥여서 성폭행 [1] ㅆㅇㅆ(124.216) 09.27 63 0
2892490 울갤서 나 봤다하는 놈들이면 애초에 단톡으로 여자따먹던 새끼들밖에 [5] ㅆㅇㅆ(124.216) 09.27 101 0
2892489 뭐냐 울갤 언급하면 글삭됌? 루도그담당(58.239) 09.27 52 0
2892488 ㅆㅇㅆ야 한마디만 해주마 [1] 프갤러(210.217) 09.27 85 3
2892487 와따시 벌써 콧털에서 흰 수염 난다. [1] 프갤러(110.8) 09.27 56 0
2892484 여자 불러서 술맥여서 강간하던 새끼들이 정상적으로 학교다니고 [2] ㅆㅇㅆ(124.216) 09.27 78 0
2892483 리버싱할때 어셈 분석해보면 루도그담당(58.239) 09.27 69 0
2892482 유동아 아직도 미짜 불러서 술맥이고 따먹냐. 정신차리고 살아 새끼야 ㅆㅇㅆ(124.216) 09.27 49 0
2892481 성인들도 유딩처럼 불꽃놀이에 카메라 들이대고 [5] 헬마스터갤로그로 이동합니다. 09.27 73 0
2892480 나를 울갤에서 봤니마니하는데 내가 울갤서 싸운건 술마셔서 미짜 따먹던 [1] ㅆㅇㅆ(124.216) 09.27 70 0
2892479 류도그<<임마 신기한게 임마 남 괴롭힐때마다 다중이 유동 ㅆㅇㅆ(124.216) 09.27 62 0
2892478 류도그가 병신인건 LLM을 써서 만들건 코딩을 타이핑하건 ㅆㅇㅆ(124.216) 09.27 54 0
2892476 오늘 하루종일 분석만 했다 [1] 루도그담당(58.239) 09.27 83 0
2892475 슬슬 류도그 또 나왔구만 ㅆㅇㅆ(124.216) 09.27 52 0
2892474 사기꾼은 ㅆㅇㅆ지 프갤러(210.217) 09.27 77 3
2892473 애초에 모든 학문의 근간은 암기서 시작함 ㅆㅇㅆ(124.216) 09.27 48 0
2892472 52Hz ♥냥덩이♥갤로그로 이동합니다. 09.27 46 0
2892471 애새끼좀 더 번식해라 이기이기 ㅋㅋㅋㅋ 타이밍뒷.통수한방(1.213) 09.27 43 0
2892470 개발 암기 잘할수록 유리함 애초에 대부분 프로그램 패턴이 정해져있어서 ㅆㅇㅆ(124.216) 09.27 65 0
2892469 파워 a.s q.n.a 넥도리아(220.74) 09.27 46 0
2892468 git 커밋 로그 영어로 써 줘 ㅋㅋ [1] 나르시갤로그로 이동합니다. 09.27 72 0
2892466 시발거 존나 뻥뻥거리네 프갤러(49.165) 09.27 65 0
2892465 코드에 문제가 있는지 확인해. [2] 나르시갤로그로 이동합니다. 09.27 79 0
2892464 지금 개발판 사기꾼 바닥임 [6] 프갤러(220.93) 09.27 122 0
2892460 아 씨발 개발자 포기할려니까 할만한게 딱히 없음 [9] ㅇㅇ갤로그로 이동합니다. 09.27 113 0
2892459 민생쿠폰10만원받았는데 식비로도 10만원 넘게필요하지않음?? 타이밍뒷.통수한방(1.213) 09.27 40 0
2892458 XIM 통신 구현에서 공용체 union 사용 예시 나르시갤로그로 이동합니다. 09.27 44 0
2892456 저번 프붕이 통신 프로토콜 질문에 대한 실제 예시 코드 ㅋㅋ 나르시갤로그로 이동합니다. 09.27 46 0
2892455 공채 합격률이 상채 합격률보다 더 높은가? ㅇㅇ갤로그로 이동합니다. 09.27 40 0
2892453 프붕이들 깜놀랄 프로토콜 설계 ㅋㅋ [5] 나르시갤로그로 이동합니다. 09.27 77 0
2892452 고수분들은 코테 준비 어케 했음? 코테>>약간 후기도 있음 프갤러(114.205) 09.27 210 0
2892443 다음과 같은 에러가 났다. 어떻게 해결하는 것이 좋겠는가? [1] 나르시갤로그로 이동합니다. 09.27 68 0
2892442 다음 코드의 형변환에 문제 없지? 나르시갤로그로 이동합니다. 09.27 59 0
2892439 디자인 = 설계, 오늘 제미니 제안 사항 나르시갤로그로 이동합니다. 09.27 69 0
2892437 쓰레기통에 재활용하기에는 방의물건이 200-300 가치다 책포함. [2] 넥도리아(220.74) 09.27 42 0
2892434 내 자신의 디자인적 능력이 너무 덜떨어져있다 [4] ㅆㅇㅆ(124.216) 09.27 61 0
2892433 ■램16기가면 윈도우는 쓰지 말아야함? OS추천좀 [4] ㅇㅇ갤로그로 이동합니다. 09.27 88 0
2892431 주말이나 휴가때 즐기는 취미나 휴식활동 있음?? [3] ㅇㅇ(223.39) 09.27 59 0
2892430 알고리즘 강의 들을만한 사람 없음? 프갤러(114.205) 09.27 39 0
2892429 오늘도 코딩하다보면 정신나갈것같군. ㅆㅇㅆ(124.216) 09.27 60 0
2892424 책샀어요. 옆에는 기억이 안나는 SSD 넥도리아(220.74) 09.27 68 0
2892423 이미 메신저 앱 겁나 많아요. 위챗이 카톡의 최대 경쟁자입니다 [5] 나르시갤로그로 이동합니다. 09.27 73 0
2892422 몇%정도 점유율 뺏겨야 나머지 사람들도 움직이려나 프갤러(45.64) 09.27 42 0
2892419 지금 메신저앱 나오면 빈집털기 ㅆㄱㄴ인데 ㅇㅇ갤로그로 이동합니다. 09.27 46 0
2892418 카톡한데 서버 이중화 왜 안 했냐고 열라 까던 조센징 정부 [2] 나르시갤로그로 이동합니다. 09.27 120 0
2892417 분석계획실행피드백 [2] 공기역학갤로그로 이동합니다. 09.27 72 0
2892414 우체국은 서버 이중화도 안 한거냐?? 대박인걸 나르시갤로그로 이동합니다. 09.27 103 0
2892413 우체국 화재) 한국 IT가 이정도로 개판이다. [3] 나르시갤로그로 이동합니다. 09.27 137 0
2892412 카카오뱅크 욕했던 조센징들 보셈 나르시갤로그로 이동합니다. 09.27 65 0
뉴스 “한창 먹었을 때 65㎏였다”는 이은지…10㎏ 감량한 비법 보니 디시트렌드 10:00
갤러리 내부 검색
제목+내용게시물 정렬 옵션

오른쪽 컨텐츠 영역

실시간 베스트

1/8

뉴스

디시미디어

디시이슈

1/2