부록: Clair 코딩 스타일 가이드

들여쓰기: 탭 대신 2개의 공백을 사용하여 들여쓰기를 합니다.

• 예약어 및 애스펙트: snake_case (전체 소문자)를 사용합니다.
  • 근거: 언어 키워드 및 애스펙트를 사용자가 정의한 식별자와 구별하기 위함입니다.
  • 예시: package, is, begin, end, if, procedure, with, pre, post

프라그마: 프라그마 이름과 해당 컨벤션 식별자에 snake_case (전체 소문자)를 사용합니다.

• 근거: 다른 언어 키워드 및 속성과의 일관성을 위함입니다. 이는 프라그마 자체(예: import)와 표준 컨벤션 식별자(예: c, intrinsic) 모두에 적용됩니다.
• 예시: pragma import (c, my_c_func, "my_c_func"), pragma convention (c, My_Data_Type)

공백:

• 서브프로그램 호출 및 선언: 서브프로그램 이름과 여는 괄호 ( 사이에 단일 공백을 사용합니다.
  • 근거: 서브프로그램 이름을 타입 변환이나 괄호를 사용하는 다른 언어 구조와 시각적으로 구별하여 전체적인 코드 명확성을 향상시키기 위함입니다.
  • 예시 (호출): Clair.Error.get_error_message (errno_code);
  • 예시 (선언): procedure exit_process (status : Integer := EXIT_SUCCESS);
• 범위 연산자 (..): 범위 연산자의 양쪽에 단일 공백을 사용합니다.
  • 근거: 연산자를 범위 경계와 시각적으로 분리하여 혼동을 방지하고, 특히 부동 소수점 또는 고정 소수점 리터럴과 함께 사용할 때 가독성을 향상시키기 위함입니다.
  • 예시 (타입 선언): range 0.0 .. 100.0
  • 예시 (루프): for i in 1 .. 10 loop

변수, 서브프로그램 및 엔트리: snake_case (밑줄이 있는 전체 소문자)를 사용합니다.

• 근거: 모든 사용자가 정의한 실행 가능하거나 데이터를 보유하는 식별자에 대해 일관되고 읽기 쉬운 스타일을 유지하기 위함입니다.
• 예시 (변수 및 서브프로그램): my_variable, get_pid
• 예시 (엔트리): get_item, put_message ada protected body Buffer is entry get_item (item : out Data) when not is_empty is -- ... end get_item; end Buffer;
• 반환값 변수: 서브프로그램의 반환값, 특히 상태 코드(예: 0, -1)를 담는 변수에는 retval 사용을 선호합니다.
  • 근거: 이는 result 식별자와의 잠재적 충돌을 피하는 널리 알려진 관례입니다. 특정 데이터를 나타내는 반환값의 경우 bytes_written, new_fd와 같이 더 설명적인 이름을 사용합니다.
  • 예시: retval := dlfcn_h.dlclose (self.handle);

속성: snake_case (전체 소문자)를 사용합니다.

• 근거: 언어에서 정의한 속성을 사용자가 정의한 타입 및 서브프로그램과 구별하기 위함입니다.
• 예시: errmsg'length, c_path'address

타입, 서브타입, 예외 및 보호 객체:

• 단일 단어 식별자에는 Pascal_Case를 사용합니다.
  • 근거: File과 같은 패키지 내에서 Descriptor와 같은 이름은 File.Descriptor로 사용될 때 자명합니다. File.File_Descriptor와 같이 불필요한 접두사를 추가하면 가독성을 해칠 수 있습니다.
  • 예시: Descriptor, Flags, Object
• 여러 단어로 된 식별자에는 Pascal_Case_With_Underscores를 사용합니다.
  • 근거: 여러 단어로 된 타입 이름 내의 단어들을 명확하게 구별하여 가독성을 향상시키기 위함입니다.
  • 예시: Library_Load_Error, Symbol_Lookup_Error

상수:

• 컴파일 타임 상수: UPPER_CASE_WITH_UNDERSCORES를 사용합니다. 이 규칙은 표준 라이브러리의 상수를 포함한 모든 정적 상수에 적용됩니다.
  • 근거: 정적인 고정 값을 다른 모든 식별자와 명확하게 구별하기 위함입니다.
  • 프로젝트 정의 예시: EXIT_SUCCESS, MAX_BUFFER_SIZE
  • 표준 라이브러리 예시: System.NULL_ADDRESS, Interfaces.C.NUL, Interfaces.C.Strings.NULL_PTR
• 런타임 상수: snake_case (변수처럼)를 사용합니다.
  • 근거: 서브프로그램 내에서 동적 값(예: 매개변수)으로 초기화되는 상수에 사용됩니다. 이를 '읽기 전용 변수'로 취급합니다.
  • 예시: final_message : constant String := "Error: " & message;

패키지: Pascal_Case를 사용합니다.

• 예시: Clair.Process
• 예외: 두 글자로 구성된 Dl의 경우 DL로 표기합니다. (예: Clair.DL, Clair.Dl은 Clair.D1처럼 보일 수 있음).

표준 라이브러리 명명 규칙:

• Interfaces.C: Interfaces.C 패키지 및 그 하위 패키지의 타입과 서브프로그램은 C 표준 라이브러리의 명명 규칙과 일치하도록 snake_case를 사용해야 합니다. 이 패키지의 상수는 컴파일 타임 상수에 대한 전역 UPPER_CASE 규칙을 따릅니다.
  • 근거: Ada와 C 간의 명확하고 일관된 정신적 매핑을 유지하면서 프로젝트의 모든 상수가 균일한 모양을 갖도록 보장하기 위함입니다.
  • 예시 (타입/서브프로그램): Interfaces.C.int, Interfaces.C.char_array, Interfaces.C.Strings.chars_ptr
  • 예시 (상수): Interfaces.C.NUL, Interfaces.C.Strings.NULL_PTR