ライブラリのサブディレクトリにあるヘッダーファイルをインクルードできるようにする

ライブラリ開発者向けの内容です。

Arduino のライブラリの仕様上、ユーザーが作成したライブラリのサブディレクトリにあるヘッダーファイルをインクルードすることができません ¹ 。

#include <MyLibrary/Algorithm/Math.hpp>  // ERROR!

また、ヘッダーファイル (.h .hpp .hh) 以外の拡張子を持つファイルも不可です ^{2 3}。ボードにデフォルトで組み込まれているライブラリは例外です。

#include <iostream>  // ERROR!

しかし、巷の C++ ライブラリはこれらの方式を取っているものが多いです。そこで Arduino のライブラリでも同じようにインクルードできるようにする裏技(?)を紹介します。

~/Documents/Arduino/libraries
│
└─ MyLibrary
   ├─ src
   │  ├─ MyLibrary
   │  │  └─ Algorithm
   │  │     └─ Math.hpp
   │  └─ MyLibrary.hpp ## < これ
   └─ library.properties

name=MyLibrary
version=1.0.0
author=HogeHoge
maintainer=HogeHoge
sentence=HogeHoge
paragraph=HogeHoge
category=Other
url=http://example.com/
architectures=*

// ~~.ino
#include <MyLibrary.hpp>
#include <MyLibrary/Algorithm/Math.hpp>

ヘッダーファイル以外のファイルをインクルードしてみる

MyLibrary.hpp をインクルードすると、ヘッダーファイル以外のファイルもインクルードできるようになります。実用的なものですと C++ STL の拡張子なしファイルでしょうか。

~/Documents/Arduino/libraries
│
└─ MyLibrary
   ├─ src
   │  ├─ iostream ## < これ
   │  └─ MyLibrary.hpp
   └─ library.properties

#include <MyLibrary.hpp>
#include <iostream>

おわり・なぜ直接インクルード出来ないのか (想像)

あくまで想像ですが、コンパイル時間短縮のためだと思います。全てのライブラリのサブディレクトリまで検索するとなると、かなり時間がかかると思います。

そこで初期状態では、インクルードディレクトリ直下のヘッダーのみを検索し、直下のヘッダーファイルがインクルードされると、このライブラリは使用中 とマークされ、サブディレクトリ下も検索されるのではないでしょうか。

最後までご覧頂き有難うございました。