C++ on 終於明白 | tsungyi knows.

C++ - User-defined literals

Wed, 01 Mar 2023 03:10:00 +0800

C++ 11 新增 User-defined literals 可以經由程式定義的字面常量後綴，讓我們寫出可讀性更加的程式碼。

簡單的說，我們可以透過有意義的字面常量後綴將常數或是字串轉換自訂的型別來提高可讀性。

User-defined literals

目前 User-defined literals 支援以下 8 種語法格式：

decimal-literal ud-suffix
octal-literal ud-suffix
hex-literal ud-suffix
binary-literal ud-suffix
fractional-constant exponent-part (optional) ud-suffix
digit-sequence exponent-part ud-suffix
character-literal ud-suffix
string-literal ud-suffix

1-4 支援不同進位的整數格式
5, 6 支援不同格式的浮點數
7 支援字元格式
8 支援字串格式
使用者定義的 ud-suffix 需要以底線 _ 開頭，標準函式庫中定義的則不會以底線開頭。

編譯器在遇到 User-defined literals 的時候會依據 ud-suffix 前面的文字的型別推導適當的函式進行轉換。

首先會透過 unqualified name lookup 找到所有名稱符合的函式集合。

如果是整數格式：
- 如果符合的函式集合有參數型別為 unsigned long long 時，會選擇此函式並呼叫 operator ""X(nULL)。
- 否則，如果有參數型別為 raw literal operators (const char*)時，會選擇此函式並呼叫 operator ""X("n")。
- 否則，如果有參數型別為 numeric literal operator template (template<char ...> X operator ""X()) 時會選擇此函式並呼叫 operator ""X<'C1', 'C2', ..., 'CK'>()。
如果是浮點數格式：
- 如果符合的函式集合有參數型別為 long double 時，會選擇此函式並呼叫 operator ""X(fL)。
- 否則，如果有參數型別為 raw literal operators (const char*)時，會選擇此函式並呼叫 operator ""X("f")。
- 否則，如果有參數型別為 numeric literal operator template (template<char ...> X operator ""X()) 時會選擇此函式並呼叫 operator ""X<'C1', 'C2', ..., 'CK'>()。
如果是字串格式：
- (C++ 20) 如果有符合的 non-type template parameter of class type (string literal operator template)時，會選擇此函式並呼叫 operator ""X<str>()。
- 否則會選擇此函式並呼叫 operator ""X (str, len)。
如果是字元格式：
- 會選擇此函式並呼叫 operator ""X(ch)。

Literal operators / Literal operators template

Literal operators 需要符合以下格式：

C++ - 宣告 vs. 定義

Mon, 29 Jun 2020 17:23:06 +0800

Declare 宣告

宣告是指程式中使用到某個類別或是變數之前，先讓編譯器知道該類別的名稱或是變數的類別與名稱。
必須要在實際使用之前宣告。因此在標頭檔以及原始檔之中需要使用 #include 這個預處理器命令將用到的類別介紹給編譯器。
- #include 這個預處理器命令實際上是將引入的檔案內容取代掉 #include 所在的位置，因此大量的 #include 會大幅增加編譯的時間。
- 如果只用到指標或是參考時，在標頭檔可以使用前置宣告 (Forward Declare) 的技巧來優化。（細節在 前置宣告 小節中說明）
  - 不呼叫該指標的方法或是使用它的成員時，編譯器不需要知道該類別的形狀，只需要當成該類型的指標變數來處理。因為指標的大小是固定的，所以不需要引入該類別也可以通過編譯。
相同的宣告可以在專案中重複出現。

Define 定義

定義是編譯器提供類型實作細節的地方，以及配置變數記憶體的語句。
- 因為定義變數時需要配置記憶體在 stack 上，因此編譯器在此時必須要知道此類別的記憶體佈局（成員的順序與類型、記憶體對齊方式等…）。
與宣告不同的是，定義在程式中只能出現一次。重複定義會造成錯誤。
- 同一個轉換單元（Translation Unit）之中只能定義一次，否則會有編譯錯誤。
- 同專案中不同轉換單元之中也只能定義一次，否則會有連結錯誤。
所有程式中有用到的實體（變數、函式…）都必須也只能在其中一個轉換單元中定義，否則會有連結錯誤。

`extern` 關鍵字

在多個轉換單元之間，如果要使用同一個變數的實例可以將變數宣告為外部引用（extern），讓編譯器在連結期再把實際的變數實例連結到使用的程式碼。

Forward Declare 前置宣告

需要使用前置宣告通常有兩種原因
1. 因為編譯器必須先看到類別、函式的宣告才能在接下來的程式中使用，一但出現互相引用的狀況編譯器就無法處理。例如底下兩個程式碼就無法編譯：

void TestFunction()
{
 TestClass test; // error: unknown type name 'TestClass'
}

class TestClass
{
public:
 void Test()
 {
 TestFunction();
 }
};

class TestClass
{
public:
 void Test()
 {
 TestFunction(); // error: use of undeclared identifier 'TestFunction'
 }
};

void TestFunction()
{
 TestClass test;
}

不論是先定義 TestFunction 還是先定義 TestClass，都會在使用到對方的程式碼的時候發生編譯錯誤。
前置宣告的作法就是把其中一個的定義語法改成宣告語法，先讓編譯器知道名稱、型別資訊來避免編譯錯誤。

void TestFunction(); // NOTE: Forward declare

class TestClass
{
public:
 void Test()
 {
 TestFunction();
 }
};

void TestFunction()
{
 TestClass test;
}

更常見的原因是為了提升編譯速度。當某個類別的方法參數、成員變數需要其他型別時，我們就需要在標頭檔之中引用其他標頭檔。因為 #include 是將引用的檔案展開到 #include 的位置，當引入的數量很多的時候會有大量的 IO 發生。通常標頭檔還會被其他檔案引用，造成倍數的成長。
- 如果是方法的參數或是成員變數用到指標或是參考時，編譯器要知道保留多少空間來儲存這個參數。幸運的是指標或是參考的大小都是固定的，因此編譯器並不需要知道整個類別的記憶體佈局。所以使用前置宣告可以減少需要引入的標頭檔數量。
- 減少需要引入的標頭檔數量還可以減少因為修改檔案時需要重新編譯的檔案數量。

前置宣告的缺點

根據 Google C++ Style Guide 並不建議使用前置宣告。
使用前置宣告可能造成對 incomplete type 的操作，這在 C++ 標準是未定義行為(Undefine Behaviour)，因此無法保證程式是否能更正確運行。
- 在 #include 該型別的定義之前絕對不要對該型別做操作。
  - 大部分的情況部會有問題，而且誤用時也會有編譯錯誤。但是像是 delete 指標、將指標當成參數是可以通過編譯的（會有警告）。

Ref: https://docs.microsoft.com/zh-tw/cpp/cpp/declarations-and-definitions-cpp?view=vs-2019

C++ - 命名規則

Mon, 29 Jun 2020 14:13:50 +0800

General Rule

程式中的所有類別、變數、函式…的命名請務必使用讓人看到名稱就可以了解他的用途。
- 使用註解來解釋是不得已的作法，請盡量避免。
名稱的長度沒有限制，但是請以人類容易閱讀、記憶的原則命名，過長或過短的名稱都不適當。
- 避免無法發音的名稱或是外語的羅馬拼音，除非這是所有成員都理解的專有名稱或是 領域用語。
- 不要使用自創的縮寫。
- 使用縮寫請確保團隊成員都清楚縮寫的意義。
命名時請考慮使用共同的 領域用語，降低與其他成員溝通的成本。
- 團隊應該建立自己的 字彙表 提供團隊成員查詢專案使用的 領域用語。

引用防護（include guard）命名

使用 ALL_CAPS （全大寫命名法）命名。命名規則使用檔案完整路徑並且加上 __ 前綴。（Ex. __BATTLE_FLElD_H）
- 建議改用 #pragma once 取代引用防護，編譯器能對 #pragma once 做較好的最佳化。

全域變數命名

使用 lower camel case （小駝峰式命名法）命名，並且加上 g_ 前綴。（Ex. bool g_battleField）
- 請避免使用全域變數。

區域變數命名

使用 lower camel case （小駝峰式命名法）命名。（Ex. bool battleField）

常數命名

使用 ALL_CAPS （全大寫命名法）命名。（Ex. const bool BATTLE_FLAG）

命名空間命名

使用 upper camel case （大駝峰式命名法）命名。（Ex. namespace BattleField）

函式命名

函式使用 lower camel case （小駝峰式命名法）命名。（Ex. void battleFunction()）
參數使用 lower camel case （小駝峰式命名法）命名。（Ex. void battleFunction(bool battleFlag)）

列舉命名

使用 upper camel case （大駝峰式命名法）命名。（Ex. enum BattleField）

列舉值命名

使用 upper camel case （大駝峰式命名法）命名。（Ex. Empty = 0）
- 盡量給所有列舉值初始值，避免程式改動後數值錯亂。
命名時請不要重複列舉的名稱。
- GOOD: enum BattleField { Empty = 0, Full = 1, };
- BAD: enum BattleField { BattleFieldEmpty, BattleFieldFull, };

類別命名

使用 upper camel case （大駝峰式命名法）命名。（Ex. class BattleField）

類別成員命名

public 成員使用 lower camel case （小駝峰式命名法）命名（Ex. bool battleFlag）。
- 請只在 struct 中使用 public 成員。
protected 、 private 成員使用 lower camel case （小駝峰式命名法）命名，並且加上 _ 前綴。（Ex. bool _battleFlag）。

類別方法/類別靜態方法命名

函式使用 lower camel case （小駝峰式命名法）命名（Ex. void battleFunction()）
參數使用 lower camel case （小駝峰式命名法）命名（Ex. void battleFunction(bool battleFlag)）

類別靜態成員命名

使用 lower camel case （小駝峰式命名法）命名，並且加上 s_ 前綴。（Ex. static bool s_battleFlag）。

類別成員常數/類別靜態成員常數命名

使用 ALL_CAPS （全大寫命名法）命名。（Ex. static const bool BATTLE_FLAG）。