第十三號艦隊

這是一種常見的code pattern

1
2
3
4
5
6

template <size_t length>
void for_loop_do() {
	for (size_t i = 0; i < length; i++) {
		do(i);
	}
}

不過既然我們在compile-time知道length的值了，自然想要unroll loop body，變成類似這樣

1
2
3
4
5
6

void unroll_do() {
	do(0);
	do(1);
	do(2);
	....
}

直覺的想法就是costexpr for

1
2
3
4
5
6

template <size_t length>
void for_loop_do() {
	constexpr for (size_t i = 0; i < length; i++) {
		do(i);
	}
}

不過自然沒這語法，只好用其他方法繞過，解決的方法也不只一種，提出兩種比較常用的

Version 1: Recursive + if constexpr

學過資料結構的話，知道迴圈可以用遞洄來模擬
加上C++17的if constexpr可以很容易蹶決這問題

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

template <size_t index, size_t boundary, typename Func>

void constexpr_for_impl(Func func)
{
    if constexpr (index == boundary) {
        return;
    } else {
        func(index);
        constexpr_for_impl<index + 1, boundary>(func);
    }
}

template <size_t boundary, typename Func>
void constexpr_for(Func func)
{
    constexpr_for_impl<0, boundary>(func);
}

int main()
{
    constexpr_for<3>([](size_t index) {
        printf("llu\n", index);
    });
}

Version 2: integer_sequence

C++14之後，引進了一個helper class integer_sequence，將常數納入Type當中
這很少直接拿來用，通常只有操作tuple時才會使用，不過要模擬constexpr for這個特色，這功能少不了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

#include <iostream>
#include <utility>

template <typename T, T... ints>
void print_sequence(std::integer_sequence<T, ints...> int_seq)
{
    std::cout << "The sequence of size " << int_seq.size() << ": ";
    ((std::cout << ints << ' '), ...);
    std::cout << '\n';
}

int main()
{
    print_sequence(std::integer_sequence<unsigned, 9, 2, 5, 1, 9, 1, 6>{});
}

我們想要的就是有一個類似std::integer_sequence<size_t, 0, 1, ..., n>這樣的sequence，這時候另外一個helper type make_integer_sequence登場了
以下是上一個範例的修改

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

#include <iostream>
#include <utility>

template <typename T, T... ints>
void print_sequence(std::integer_sequence<T, ints...> int_seq)
{
    std::cout << "The sequence of size " << int_seq.size() << ": ";
    ((std::cout << ints << ' '), ...);
    std::cout << '\n';
}

int main()
{
    print_sequence(std::make_integer_sequence<int, 12>{});
}

這就是constexpr for的核心觀念

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

template <std::size_t... Is, typename Func>
void constexpr_for_impl(std::index_sequence<Is...>, Func func)
{
    (func(Is), ...);
}

template <size_t boundary, typename Func>
void constexpr_for(Func func)
{
    constexpr_for_impl(std::make_index_sequence<boundary>{}, func);
}

int main()
{
    constexpr_for<3>([](size_t index) {
        printf("llu\n", index);
    });
}

C++20之後，有了 Template Lambdas，因此我們可以進一步這樣寫

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

template <size_t boundary, typename Func>
void constexpr_for(Func func)
{
    [&] <size_t... Is> (std::index_sequence<Is...>) {
        ([&] <size_t I> (std::integral_constant<size_t, I>) {
            func(I);
        } (std::integral_constant<size_t, Is>{}), ...);
    } (std::make_index_sequence<boundary>{});
}

int main()
{
    constexpr_for<3>([](size_t index) {
        printf("llu\n", index);
    });
}

Conclusion

模擬只是模擬，當for loop加入了continue，break，return之後，上面的方法就會變得很複雜，只適合簡單的應用

Reflection還沒通過，Contract就先進入下一版的C++標準當中了
如果要簡單講完Contract，大概就是C語言assert的威力加強版吧

Before Contract

打開assert.h你大概可以看到類似這樣的程式碼

1
2
3
4
5
6
7
8
9
10
11

#ifdef  NDEBUG
# define assert(expr)           (__ASSERT_VOID_CAST (0))
#else
#  define assert(expr)                                                  \
  ((void) sizeof ((expr) ? 1 : 0), __extension__ ({                     \
      if (expr)                                                         \
        ; /* empty */                                                   \
      else                                                              \
        __assert_fail (#expr, __FILE__, __LINE__, __ASSERT_FUNCTION);   \
    }))
#endif

甚至知名的Open Source Project，也會搞自己的一套assert機制

1
2
3
4
5
6
7
8
9
10
11
12

#if SLANG_ASSERT_ENABLED
# define SLANG_ASSERT(cond) \
    do { \
      if (!(cond)) \
        assertFailed(...); \
    } while (false)
#else
# define SLANG_ASSERT(cond) \
    do { \
      (void)sizeof(cond); \
    } while (false)
#endif

或是l
由於這個機制基於Macro，所以Macro Pollution是繞不開的問題
將Contract列如標準之後，有以下好處

• 避免Macro Pollution
• 更靈活的處理策略
• 由於是Language本身的一部分，之後有更好的工具可供分析使用

How to Use

最簡單的方法就是將assert置換成`contract_assert

1
2
3

auto w = getWidget(); 
contract_assert(w.isValid());
processWidget(w);

基本行為就跟assert一致，不過可以透過Compiler控制Contract Semantics

Evaluation semantics

關於Contract，有四種不同的Evaluation方式

• Ignore
• Enforce
• Observe
• Quick-Enforce
  這邊就不喜說了，需要的話參考Reference的連結

Pre and Post

這個也跟以前function用assert檢查Input跟Output Result差不多

1
2
3
4
5
6

int f(const int x)  {
    assert(x != 0 && x != -1);
    int r = x + 1;
    assert(r > x);
    return r;
}

基本上沒什麼問題，只不過不能從FUnction signature中檢查，要深入Function body才知道問題出在哪
有了Contract之後，可以在函數宣告的地方加上pre和post表示前置和後置條件

1
2
3
4
5
6
7

int f(const int x) 
    pre(x != 0 && x != -1)
    post(r : r > x);

int f(const int x) {
    return x + 1;
}

就是把assert的使用情境細分

handle_contract_violation

有些時候，除了Compiler 內定的行為，我們需要自行對Contract做處理
這時候就是Global function handle_contract_violation發揮的時刻

1
2
3
4
5
6
7
8
9
10
11
12

// Try overriding the violation handler
void handle_contract_violation(std::contracts::contract_violation const& violation) {
    if (violation.semantic() == std::contracts::evaluation_semantic::observe) {
        std::cerr << violation.location().function_name() << ":"
            << violation.location().line()
            << ": observing violation my way: "
            << violation.comment()
            << std::endl;
        return;
    }
    std::contracts::invoke_default_contract_violation_handler(violation);
}

最後一行表示回到內建的處理方式了

Status

目前MSVC還未實作，省略不計
gcc和clang的用法略有不同
目前gcc的使用方式：

1

-fcontracts  -fcontracts-nonattr -fcontract-evaluation-semantic=enforce

而clang則是：

1

$ -fcontracts -fcontract-evaluation-semantic=enforce

Reference

Contracts for C++ explained in 5 minutes
C++26启航：Safe C++的破晓时刻

在開發自己的Toy Project時，做了許多大膽的舉動，其中之一就是使用了C++20 Module，不過夜路走多了總是會碰到鬼，列下目前遇到的血淚史

NVCC doesn’t support C++20 Module

一開始沒打算使用CUDA，等到引進CUDA時才發現這是個超級大坑

Because it requires complex interaction between the CUDA device compiler and the host compiler, modules are not supported in CUDA C++
山不轉路轉，原先的程式碼大概長這樣

1
2
3
4
5
6
7

export module A;

export {
	enum Flag {
		// blabla
	};
}

退化成C++17能接受的語法

1
2
3
4

#prgram once
enum Flag {
	// blabla
};

和

1
2
3
4
5
6
7
8

module;
#inlcude "header.h"

export module A;

export {
	using Flag;
}

以及CUDA的Header file

1
2
3

#pragma  once
#include "header.h"
void doSomething(Flag);

至少是我目前想到最好的解法
乍看之下問題解決了，不過事情沒這麼簡單，假設有個Implementation unit

1
2
3
4
5
6
7
8
9

module;
#include "header.h"

module A;

void work()
{
	doSomething(Flag{});
}

會發現Compiler會告訴你Flag被重複定義，於是乎想到一個解決方案，forward references，改寫Cuda Header的部分

1
2
3

#pragma  once
enum Flag : int;
void doSomething(Flag);

然後將獨立出Cuda Implementation Unit

1
2

#include "header.h"
void doSomething(Flag) {}

雖然很難看，不過現在跑起來沒啥問題

location on extern function

上面的方式是將cuda function拆成兩個檔案，header和implementation
如果我們要省略header該怎麼做

1
2
3
4
5
6
7

module A;
extern void funcFromCuda();

void work()
{
	funcFromCuda();
}

在MSVC上編譯沒問題，不過在Linux Clang下編譯就會出錯了
修正方式也很簡單，將extern function移到Global module fragment就好了

1
2
3
4
5
6
7
8
9

module;
extern void funcFromCuda();

module A;

void work()
{
	funcFromCuda();
}

One more thing

這其實跟C++20 Module無關，只是因為現階段Clang支持Module，而GCC還沒準備好，所以開發就以Clang為主，因此遇到了這麼一個問題

1
2
3
4
5
6
7
8
9
10

module;
#include <string>
extern void funcFromCuda(std::string);

module A;

void work()
{
	funcFromCuda("Hello World");
}

NVCC會告訴你找不到funcFromCuda function，因為我們外部的Compiler是使用clang，使用的是libc++，而NVCC使用的是libstdc++，兩者並不相容
於是乎只好退回舊方法，直接傳指標了

1
2
3
4
5
6
7
8
9
10

module;
#include <string>
extern void funcFromCuda(const char*);

module A;

void work()
{
	funcFromCuda("Hello World");
}

Conclusion

目前看來，NVCC支援C++20 Moudle遙遙無期，不然問題一和問題二應該都能解決
問題三比較麻煩，就算支援Module還是不行，只能使用老方法

為了搞懂Rust Pin在做什麼，耗費了很多精力，還真是有夠難懂的

About Self-Reference Type

有個資料結構， 其中有個指標指向結構自己或是結構中的某個欄位
例如

1
2
3
4
5
6
7
8
9

struct Test {
protected:
        std::string a_;
        const std::string* b_;
public:
        Test(std::string text) : a_(std::move(text)), b_(&a_) {}
        const std::string& a() const { return a_; }
        const std::string& b() const { return *b_; }
};

這裡的b_指向a_的地址， 同樣的事情在Rust寫成這樣

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

struct Test {
    a: String,
    b: *const String,
}

impl Test {
    fn new(txt: &str) -> Self {
        Test {
            a: String::from(txt),
            b: std::ptr::null(),
        }
    }

    fn init(&mut self) {
        let self_ref: *const String = &self.a;
        self.b = self_ref;
    }

    fn a(&self) -> &str {
        &self.a
    }

    fn b(&self) -> &String {
        unsafe {&*(self.b)}
    }
}

不看Rust的safe機制造成的不同，原理是相同的
現在的問題是，假設物件被移動了，指向結構中某部分的指標該怎麼辦
例如

1

std::swap(test1, test2);

先從我比較熟悉的C++來說好了

Solution1: Keep invariant

雖然達成目標的方法有很多，不過原則都是一樣：維持不變量就好了

1
2
3
4

void swap(Test& lhs, Test& rhs) {
    std::swap(lhs.a_, rhs.a_);
}
swap(test1, test2);

很顯然，這個方法不適用於Rust

Solution2: Don’t move the object

所謂的Pin也就是這麼一回事，當物件停留在記憶體的某個位置之後，就不會再移動了，所以Self-Reference Type的物件，在生命週期結束之前，所有的pointer和reference都會有效
在C++禁止的方法也不只一種，這是方法之一

1
2
3
4
5
6
7
8
9
10
11
12

template <typename T>
void swap(T&, T&) {}
struct Test {
protected:
        std::string a_;
        const std::string* b_;
public:
        Test(std::string text) : a_(std::move(text)), b_(&a_) {}
        friend void swap(Test&, Test&) = delete;
        const std::string& a() const { return a_; }
        const std::string& b() const { return *b_; }
};

不過由於Rust講究Safety，所以訂了一堆規則

About Pin in Rust

在Rust中對Self-Reference Type的處理，我們要禁止的只有這件事

1
2
3
4
5
6
7

pub fn swap<T>(x: &mut T, y: &mut T) {
    // SAFETY: the raw pointers have been created from safe mutable references satisfying all the
    // constraints on `ptr::swap_nonoverlapping_one`
    unsafe {
        ptr::swap_nonoverlapping_one(x, y);
    }
}

禁止Rust拿到&mut T的Reference，&mut Tˊ自然是不行，Box<T>也做不到這件事，所以就是Pin<T>登場的時候

Rust的Type分成兩類：

• Default Type：可以安全在Rust Move的類型
  • Default Type都實作了auto Unpin trait，也就是什麼都不用做
• Self-Reference Type：也就是上面提到的部分
  • 必須實作!Unpin的部分
  • 使用PhantomPinned就可以了

以下是個範例程式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

use std::pin::Pin;
use std::marker::PhantomPinned;

#[derive(Debug)]
struct Test {
    _marker: PhantomPinned,
}

impl Test {
    fn new() -> Self {
        Test {
             _marker: PhantomPinned
        }
    }
}
pub fn main() {
    let mut test1 = Box::pin(Test::new());
    let mut test2 = Box::pin(Test::new());
    // compile failed
    std::mem::swap(test1.as_mut().get_mut(), test2.as_mut().get_mut());
}

你把上面的PhantomPinned註解掉，程式就能正常運作了
Pin還有很多細節，等我真的變成全職Rust工程師在研究吧

Reference

• Rust 的 Pin 与 Unpin

最近被吵得很兇的Safe C/C++，主要討論的是沒有Undefined Behavior這件事

What’s Undefined Behavior

基本上就是一個逃生艙口，Compiler可以跳過某些邏輯的推理，正確的邏輯永遠不會引發UB，不正確的邏輯(可能)會引發UB

舉個例子：

1
2
3
4
5
6
7
8

int f(bool init) {
    int a;
    if (init) {
        a = 6;
    }
    return a / 2;

}

觸犯了UB，所以gcc/clang開啟Optimization時會產生

1
2
3

f(bool):
        mov     eax, 3
        ret

不過Undefined Behavior是Runtime Concept，所以以下的程式碼只有在Runtime才會發生UB

1
2
3
4
5
6
7
8
9
10
11
12
13

int nervous(bool is_scary, int n)
{
    if (is_scary) {
        return 100 / n;
    } else {
        return 0;
    }
}

int main()
{
    return nervous(false, 0);
}

所以Undefined Behavior Sanitizer只能在Runtime下使用t，也不能保證抓到所有UB，只要UB Code沒被執行到，整個程式行為還是受到標準限制的

How to archive safety

基本上分成兩個流派

• 程式語言中本身就沒有Undefined operations，如Java，Python，不過也是犧牲了一部分的速度和超能力，沒有十全十美的
• 將程式語言切分為Safe跟Unsafe的部分，如Rust
  • Safe的地方由Compiler保證，不會有任何UB發生
  • Unsafe的地方也沒有什麼特異功能，只是相信Unsafe的地方不會有任何問題

Future of safety C++

老實說，我不知道
Safecpp提供了一套類似於Rust的機制，不過那已經不算是C++了
Profile機制只打算完成80%的Safety，如果能達到這目標，我覺得夠用了，不過要說服NSA和美國政府是另一回事了

Reference

• The difference between undefined behavior and ill-formed C++ programs

找不到適合的工作，只好多方嘗試，看有沒有寫書的才華
寫了一本有關C/C++生態系的書
C/C++編譯器與它的快樂夥伴

由於打算寫本電子書，所以重新審視了C++20 Moudle的部分
語法的不是這篇的重點，這篇講的是

• 如何跟CMake搭配使用
• 測試環境是Linux + Clang20 + CMake 3.28

Prerequisites

首先先clone git repo，所有的變化都由範例legacy開始，這是沒有Module之前的做法

CMake

CMake已經是事實上的標準

Case1 Normal case

詳細內容請觀看 module_1目錄，這邊只講我覺得重要的地方
這個Case就是legacy直接翻譯成Module版本
首先看MathFunctions的CMakeLists.txt的部分

1
2
3
4
5
6
7
8
9
10
11
12
13
14

target_sources(MathFunctions
  PUBLIC
    FILE_SET primary_interface
    TYPE CXX_MODULES
    FILES
      MathFunctions.cppm
  PRIVATE
    FILE_SET implementaion_units
    TYPE CXX_MODULES
    FILES
      src/mysqrt.cppm
  PRIVATE
    src/MathFunctions.cxx
)

這邊有兩個FILE_SET

• primary_interface：也就是我們要對外提供的Primary module interface unit
• implementaion_units:內部的partion unit，不對外輸出
  所以在安裝的時候，只會將MathFunctions.cppm複製到安裝的目錄下

  Case2: Multiple Primary Module Interface Units

  接著我們稍微修改MathFunctions.cppm的內容

  1 2 3 4 5 6 7 8 9

  module; export module Math; export import :detail; export namespace mathfunctions { double sqrt(double); }

  我們也將detail的內容也輸出了，因此我們需要做以下的修改
• detail module和namespace需要標記成 export

  1 2 3 4 5 6 7 8 9 10

  module; #include <math.h> export module Math:detail; export namespace mathfunctions::detail { double sqrt(double x) { return ::sqrt(x); } }

  修改我們的CMakeLists.txt的部分

  1 2 3 4 5 6 7 8 9 10

  target_sources(MathFunctions PUBLIC FILE_SET primary_interface TYPE CXX_MODULES FILES MathFunctions.cppm src/mysqrt.cppm PRIVATE src/MathFunctions.cxx )

  現在我們有了兩個Primary Module Interface Units，在安裝的時候也要同時複製兩個檔案
  Math.detail和Math:detail的情況類似，所以就不說了

接著來研究Mitgrate的部分，這是參考clang Transitioning to modules的部分

Case3: Mitgrate legacy to module (Part1)

看一下transform_1的目錄
這邊主要的差別在於CMakeLists.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

target_sources(MathFunctions
  PUBLIC
    FILE_SET export_headers
    TYPE HEADERS
    BASE_DIRS include/
    FILES include/MathFunctions.h
  PUBLIC
    FILE_SET primary_interface
    TYPE CXX_MODULES
    FILES
      MathFunctions.cppm
  PRIVATE
    src/MathFunctions.cxx
    src/mysqrt.h
    src/mysqrt.cxx
)
install(TARGETS MathFunctions
  EXPORT MathFunctionsTargets
  ARCHIVE
  FILE_SET export_headers
  FILE_SET primary_interface
    DESTINATION lib/cmake/MathFunctions/src
)

既保留原有的leagcy code，更新增了一個Primary Module Interface Units
而MathFunctions.cppm的內容則是

1
2
3
4
5
6
7
8

module;
#include "MathFunctions.h"

export module Math;

export namespace mathfunctions {
        using mathfunctions::sqrt;
}

將Global Module Fragment中的內容導出到Module中
這種方法不會破壞原有leagcy code，殺傷力最小

Case4: Mitgrate legacy to module (Part2)

看一下transform_21的目錄，CMakeLists.txt跟上面一樣不變
改變的是MathFunctions.cppm和MathFunctions.h
此時的MathFunctions.cppm長這樣

1
2
3
4
5
6
7
8
9

module;

export module Math;

#define IN_MODULE_INTERFACE

extern "C++" {
        #include "MathFunctions.h"
}

而MathFunctions.h的內容則是

1
2
3
4
5
6
7
8
9
10
11

#pragma once

#ifdef IN_MODULE_INTERFACE
#define EXPORT export
#else
#define EXPORT
#endif

namespace mathfunctions {
        EXPORT double sqrt(double x);
}

由於只有在Module狀態下，IN_MODULE_INTERFACE才會發揮作用，因此leagcy code的情況下會維持不變
這個方法雖然比上面麻煩，不過可以順利遷移到下一個階段

Case5: Mitgrate legacy to module (Part3)

所有方案中最麻煩的一種
主要思想是在implemtation unit當中切開legacy和module的實作，強迫Consumer只能使用其中一種，例如原先的Header可能要加上export

1
2
3
4
5
6
7
8
9
10
11

#pragma once

#ifdef IN_MODULE_INTERFACE
#define EXPORT export
#else
#define EXPORT
#endif

namespace mathfunctions {
        EXPORT double sqrt(double x);
}

以及Implementation的部分也要隔開

1
2
3
4
5
6
7
8
9
10
11
12

#ifndef IN_MODULE_INTERFACE
#include "MathFunctions.h"
#include "mysqrt.h"
#else
module Math;
#endif

namespace mathfunctions {
        double sqrt(double x) {
                return detail::sqrt(x);
        }
}

在這裡我選擇對CMakeLists.txt動手腳

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

if (ENABLE_MODULE_BUILD)
target_sources(MathFunctions
  PUBLIC
    FILE_SET export_headers
    TYPE HEADERS
    BASE_DIRS include/
    FILES
      include/MathFunctions.h
      include/mysqrt.h
  PUBLIC
    FILE_SET primary_interface
    TYPE CXX_MODULES
    FILES
      MathFunctions.cppm
  PRIVATE
    src/MathFunctions.cxx
    src/mysqrt.cxx
)
else()
target_sources(MathFunctions
  PUBLIC
    FILE_SET export_headers
    TYPE HEADERS
    BASE_DIRS include/
    FILES
      include/MathFunctions.h
  PRIVATE
    include/mysqrt.h
    src/MathFunctions.cxx
    src/mysqrt.cxx
)
endif()

target_compile_definitions(MathFunctions
  PRIVATE
    $<$<BOOL:${ENABLE_MODULE_BUILD}>:IN_MODULE_INTERFACE>
)

if (ENABLE_MODULE_BUILD)
install(TARGETS MathFunctions
  EXPORT MathFunctionsTargets
  ARCHIVE
  FILE_SET export_headers
  FILE_SET primary_interface
    DESTINATION lib/cmake/MathFunctions/src
)
else()
install(TARGETS MathFunctions
  EXPORT MathFunctionsTargets
  ARCHIVE
  FILE_SET export_headers
)
endif()

當我們指定ENABLE_MODULE_BUILD的時候，會自動處理細節的部分
不過這邊也遇到了clang文件中的問題

Minor issue

由於我們之前的mysqrt.h是經由src/MathFunctions.cxx所include的，改成Module之後，這個相依性被切斷了
因此我們需要在MathFunctions.cppm強迫加入

1
2
3
4
5
6
7

module;

export module Math;
#include "MathFunctions.h"

module: private;
#include "mysqrt.h"

這樣沒有問題，不過

• 原來的mysqrt.h不需要公開，現在變成強迫要公開了
• 更好的方法是直接使用Module Partition Unit，也就是要改寫

問題說來很簡單，結果我花了好久才搞懂，字字血淚
我想要的只有這樣的效果

1
2
3
4
5
6
7
8

template <std::size_t i>
void inner() {}

tempplate <std::size_t N>
void outer() {
    for (std::size_t i = 0; i < N; i++)
        inner<i>();
}

結果這樣是無法編譯的，只好找其他方法繞過

Solution 1: Template specialization

一樣是從別人的Code上學來的

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

template <std::size_t i>
void inner() {}

template <std::size_t N>
struct helper {
    template <typename Indices = std::make_index_sequence<N>>
    struct _helper;

    template <std::size_t... Idx>
    struct _helper<std::index_sequence<Idx...>> {
        static void unroll() {
            (inner<Idx>(), ...);
        }
    };
};

template <std::size_t N>
void outer()
{
        helper<N>::template _helper<>::unroll();
}

在這邊

• _helper會有兩個Template definition，而由於_helper<std::index_sequence<Idx...>>的契合度比primary template好，所以會選擇這個definition
• 然後就用fold expression展開了
• 不過實在是太醜了，思考有無其他的方案

  Fail attempt:

  在求助於AI之下，嘗試了其他方案

  std::apply and std::make_integer_sequence

  這個是Claude提供的

  1 2 3 4 5

  template <size_t i> void inner() {} template <size_t N> void outer() { std::apply([](auto... indices) { (inner<indices>(), ...); }, std::make_index_sequence<N>{}); }

  結果是不能用，std::apply需要接受一個tuple like的參數，很可惜這不是
  於是先擱置在一旁，不過這個方案接近我最後的方案，還是感激一下AI

  Custom apply function

  這個是GPT4-o提供的

  1 2 3 4 5 6 7 8 9 10

  template <typename F, size_t... Indices> void apply_impl(F&& f, std::index_sequence<Indices...>) { (f(std::integral_constant<size_t, Indices>{}), ...); } struct outer { template <std::size_t N> void test() { apply_impl([](auto index) { inner<index>(); }, std::make_index_sequence<N>{}); } };

  將fold expression隱藏於實作中，雖然不錯，不過這方法也是有其缺點
  無法表示這樣的Pseudo code

  1 2 3 4 5 6 7 8 9 10 11 12

  template <std::size_t i> bool inner() { if (i == 1) return false; else return true; } tempplate <std::size_t N> bool outer() { for (std::size_t i = 0; i < N; i++) if (!inner<i>()) return false; return true; }

  萬能的CharGPT也給了一個思路，拓展apply_impl

  1 2 3 4 5 6 7 8 9 10 11 12

  template <typename F, size_t First, size_t... Rest> bool apply_impl(F&& f, std::index_sequence<First, Rest...>) { if (!f(std::integral_constant<size_t, First>{})) { return false; } return apply_impl(f, std::index_sequence<Rest...>{}); } template <typename F> bool apply_impl(F&&, std::index_sequence<>) { return true; }

  看起來可行，不過也是有自己的問題
• 當你邏輯改變，例如將all_true或城anyone_true的時候，上面的apply_impl就要改了
• 當Callback function有無回傳值的情況，就要考慮很多地方，整個邏輯也會變得支離破碎，不好維護
  因此，想出了自己的方案

  Solution2: make_index_sequence_tuple

  查了一下資料std::apply接受的是tuple like的類型，那麼就自己做出一個tuple like 的index_sequqence就好了

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

  template <std::size_t... Idx> constexpr auto _make_index_sequence_tuple(std::index_sequence<Idx...>) { return std::make_tuple(std::integral_constant<std::size_t, Idx>()...); } template <std::size_t N> constexpr auto make_index_sequence_tuple() { return _make_index_sequence_tuple(std::make_index_sequence<N>{}); } struct outer { template <std::size_t N> void test() { std::apply([](auto... indices) { (inner<indices>(), ...); }, make_index_sequence_tuple<N>() ); } };

  這樣就沒啥問題了

  Conclusion

  AI生成的Source Code還是不能照單全收，不過提供個思路總是好的
  不過更好的方法應該是template for，不過不知會部會進標準

API Design

看了lexy的程式碼之後，對其API Design很有興趣
其中有一個設計

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

template <typename Fn>
struct _parse_state : _detail::placeholder_base {
    LEXY_EMPTY_MEMBER Fn _fn;
    template <typename State, typename... Args>
    constexpr decltype(auto) operator()(State& state, const _detail::tuple<Args...>&) const
    {
        static_assert(!std::is_same_v<State, _detail::no_bind_state>,
                      "lexy::parse_state requires that a state is passed to lexy::parse()");
        return _detail::invoke(_fn, state);
    }
}

template <>
struct _parse_state<void> : _detail::placeholder_base
{
    template <typename State, typename... Args>
    constexpr decltype(auto) operator()(State& state, const _detail::tuple<Args...>&) const
    {
        static_assert(!std::is_same_v<State, _detail::no_bind_state>,
                      "lexy::parse_state requires that a state is passed to lexy::parse()");
        return state;
    }

    template <typename Fn>
    constexpr auto map(Fn&& fn) const
    {
        return _parse_state<std::decay_t<Fn>>{{}, LEXY_FWD(fn)};
    }
};

constexpr auto parse_state = _parse_state<void>{};

這API的重點

• 我們只希望有一個Root parse_state
• 只能透過 Util function map，可以創建另一個placeholder_base的subclass
  lexy採用的是Partial template specialization方案來應對這個設計，不過這方案有個缺點，大量重複的程式碼
  以上面的例子來看，operator()的內容幾乎一樣，如果功能更多的話，可能會有更多類似但卻不相同的函數出現，可能增加維護的難度

  deduce this

  deduce this的教學文章很多了，拾人牙慧也沒什麼意思
  雖然不確定是否是最佳解，不過可以試試看設計這樣的API

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

  struct Base { template <typename Self> decltype(auto) operator()(this Self&& self) { // Shared common logic if constexpr (std::is_same_v<std::decay_t<Self>, Base>) { } else { } } template <typename Self> requires std::is_same_v<std::decay_t<Self>, Base> void test1(this Self&& self) { } }; struct Derived : public Base {}; constexpr auto parse_state = Base{};

  這邊的map跟lexy上面的map差不多
• 只能透過parse_state來使用util function map
  而operator()就能共用大部分的邏輯了
  不過這方法也是有缺點，對邊義氣版本的要求很高
• gcc目前要14才有支援
• clang目前也是到18才支持
• MSVC至少要17.2

CRTP

在寫完後不久，才想起CRTP也可以解決這問題

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

template <typename Derived = void>
struct Base {
    decltype(auto) operator()() const {
        if constexpr (std::is_void_v<Derived>) {
            static_assert(false);
        } else {
        }
    }

    void map() const
    requires std::is_void_v<Derived> {
    }
};

struct Derived {};

不過比起deduce this，可以要麻煩一點

Reference

• C++23’s Deducing this: what it is, why it is, how to use it
• C++23 成員函式明確的 this：deducing this

其實這也不是什麼新玩意，不過由於AI和其他方面的需求加持，這東西越來越重要
先分析一下問題

Problem

假設我們想在程式裡面直接嵌入icon或是wave，該怎麼做

1

uint8_t icon[];

現在的問題，嵌入的content是Binary的，如何跟程式綁在一起

Solution 1: String Literal

使用類似xxd, objcopy或是類似的工具，將Binary轉成String Literal，然後跟原先的程式做聯結就行了
不過可能遇到的問題

• xxd 或是其他的工具，該作業系統可能不能用或是要額外安裝，增加額外的複雜性
• 增加編譯的複雜度，必須先處理String literal，才能編譯相依的程式碼

Solution 2: Linker

直接從Linker動手腳

1

$ ld -r -b binary -o binary.o foo.bar  # then link in binary.o

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

#include <stdio.h>

extern char _binary_foo_bar_start[];
extern char _binary_foo_bar_end[];

int main(void)
{
    printf( "address of start: %p\n", &_binary_foo_bar_start);
    printf( "address of end: %p\n", &_binary_foo_bar_end);

    for (char* p = _binary_foo_bar_start; p != _binary_foo_bar_end; ++p) {
        putchar( *p);
    }

    return 0;
}

這遇到的問題跟上面差不多

• Windows 不支持這種做法
• 一樣多了複雜性

  Solution 3: CMake script

  雖然原理可能不同，不過最後的結果大同小異
• Embedding Binary Data in Executable with CMake
• battery-embed
• CMake embed

唯一解決的問題是跨平台，複雜度還是無法解決
有沒有更簡單的方法

golang

看看golang的例子，簡單明瞭

1
2
3
4
5
6

import (
	_ "embed"
)

//go:embed hello.txt
var s string

embed in C23

終於講到主題了，在C23中可以這麼做

1
2
3
4
5
6
7
8
9
10
11

#include <stddef.h>

void show_icon(const unsigned char *, size_t);

int main (int, char*[]) {
    static const unsigned char icon_data[] = {
#embed "black_sheep.ico"
    };
    show_icon(icon_data, sizeof(icon_data));
    return 0;
}

這解決了編譯相依性的問題，不過沒有實質性的改進，C++目前沒有對應的東西
如果你以前的方式跑得好好的，不會因為編譯速度還煩惱的話，沒有必要一定要使用

Reference

• How to Embed Binary Data in Program Code
• C/C++: 70x faster file embeds using string literals
• Embedding resources in executable using GCC
• What is the purpose of the new C23 #embed directive?