Show HN: 静的型付け、クロスプラットフォーム、容易にブートストラップ可能なビルドシステム
Show HN: A statically typed, cross-platform, easily bootstrappable build system (github.com)
要約
BUSYは、GCC、Clang、MSVCツールチェーン向けの軽量でクロスプラットフォームなビルドシステムです。静的型付けされたビルド仕様言語と、ホストシステムにほとんど依存せず容易にブートストラップできる点が特徴です。CMakeやMesonなどの既存システムと比較して、よりシンプルで柔軟な開発を目指しています。
全文翻訳
BUSYビルドシステムへようこそ
BUSY(BUild SYstemの略)は、GCC、Clang、MSVCツールチェーン向けの軽量でクロスプラットフォームなビルドシステムで、システム要件が非常に少なく、容易にブートストラップできます。
CMake、QMake、Meson、GNなどの他のビルドシステムと比較して、BUSYは静的型付けされたビルド仕様言語と、ホストシステムにそれ以上の要件なしでプロジェクトを直接ゼロからビルドできる可能性を特徴としています。BUSYは非常に軽量であるため、プロジェクトのソースツリーに直接統合するのにも適しています。
BUSYを使用したサンプルプロジェクトはこちらです:https://github.com/rochus-keller/nappgui/。NAppGUIは、Francisco GarcíaによってC89(一部C++98およびObjective-C)で書かれた包括的なクロスプラットフォームGUIライブラリです。プロジェクトのビルド方法についてはREADMEを参照し、ルートディレクトリおよびsrcディレクトリ(およびサブディレクトリ)内のBUSYファイルを確認してください。仕様言語に関する詳細については、以下およびsyntaxディレクトリを参照してください。GNを知っている人は、BUSYに様々な概念が認識できるでしょう。
利便性のために、いくつか抜粋します:
# トップレベルのBUSYファイルから
submod src
let shared_lib* = src.shared_lib
let static_lib* = src.static_lib
let all! : Group {
.deps = [ shared_lib static_lib ]
# 'let'が使用されているため、'deps'フィールドはここでのみ'.'プレフィックスを使用して設定できます
# 代わりに'var'が使用された場合、それはどこかで'all.deps += xyz'で変更される可能性があります
}
# src BUSYファイルから
let main_config - : Config {
.include_dirs += [ ./geom2d ./osbs ./sewer /* いくつかのみ表示 */ ]
.defines += [ "NAPPGUI_LIBRARY"
"NAPPGUI_BUILD_DIR=\"" + tostring(root_build_dir) + "\""
"NAPPGUI_BUILD=\"" + readstring('../prj/build.txt') + "\"" ]
}
submod core
submod draw2d
# その他多数
let all_lib_sources : Group { # このBUSYファイルでのみ可視
.deps = [
core.sources
draw2d.sources
# その他多数
]
}
let static_lib* : Library {
.name = "NAppGUI" # そうしないとバイナリ名は "static_lib" になります
.lib_type = `static
.deps = [ all_lib_sources ]
}
# draw2d BUSYファイルから
submod gtk3
let sources * : SourceSet {
.sources = [
./draw2d.cpp
./drawg.cpp
./btext.c
# その他多数
]
.configs += ^main_config # これはsrcのBUSYファイル内のConfigを参照します
if target_os == `linux {
.deps += gtk3.sources
}else if target_os == `win32 {
# 延々と続く
}else {
error("target os not supported")
}
}
以下のような構文も有効です(Pascalスタイルを好む方のために):
let sources * : SourceSet
begin
.sources := [
./draw2d.cpp
./drawg.cpp
./btext.c
]
if target_os == `linux then
.deps += gtk3.sources
elsif target_os == `win32 then
# 延々と続く
else
error("target os not supported")
end
end
もう一つ、より複雑なBUSYの例はOberon+コンパイラとIDEです。ビルドの実行方法については、https://github.com/rochus-keller/LeanQt/blob/main/Readme.mdを参照してください。また、Qtのmocおよびrccツールに対するBUSYの特別なサポートも実証しています。
BUSYはLua仮想マシンに基づいており、それに統合されています(ただし、LuaではなくC89で書かれています)。Luaは、すべてのプラットフォームで最もビルドしやすいコードベースの1つです。唯一の要件はC89コンパイラです。BUSYはこの伝統に従い、Luaの作者たちの素晴らしい仕事から恩恵を受けています。
BUSYと完全に統合され、マルチコアビルドをサポートする強力なC/C++ IDEをお探しなら、LeanCreatorをチェックしてください。
なぜまた別のビルドシステムなのか?
私は長年ビルドシステムを使用し、研究してきました。QMakeは過去20年間で最も多くの時間を費やしたビルドシステムですが、Qtを必要とし、大規模プロジェクトではGNほど柔軟ではありません。私もいくつかのプロジェクトでCMakeを使用しており、20年前にVisualization Toolkitに関わった当初からその開発を追ってきました。また、MesonやGNのような新しいプロジェクトも追跡しています。後者はDart VMのソースツリーを探索中に見つけ、それ用の分析ツール(https://github.com/rochus-keller/GnToolsを参照)まで開発しました。その発見は、いくつかの記事の材料になるでしょう。ここでは簡単な概要のみを示します。
CMakeは完全に装備された、そして残念ながらやや時代遅れのスクリプト言語です。「モダンCMake」は現在、個々のビルドステップがどのように進行すべきかの命令的な詳細仕様ではなく、ターゲットとプロパティ(GNに似ています)にも焦点を当てています。これは正しい方向ですが、依然としてこの文字列型の動的スクリプト言語の限界を探求するもう一つのレイヤーに過ぎず、他のすべてのレイヤーがまだ透けて見えています。CMake自体は、一人の開発者がもはや完全に理解するのが難しいほど巨大で複雑なシステムになっています。また、私が通常それを使ってビルドしたいほとんどのプロジェクトよりも大きく、複雑です。
Mesonは興味深いアプローチをもたらし、明示的にチューリング完全なプログラミング言語を避けていますが、これは私の見解からは正しい道です。抽象オブジェクトへの参照を通じて結果にアクセスし、ファイルシステムのパスを抽象化するというアイデアも気に入っています。しかし残念ながら、その言語はPythonに触発されたようで、やや独特であり、依然として動的型付けです(文字列型以上の型があるにもかかわらず)。
ビルドシステムは常に、ソフトウェア開発者が可能な限り時間をかけたくないもののように思えます。それらは実際のソフトウェアエンジニアリングの芸術の焦点ではなく、副産物と見なされているようです。このことによってのみ、モジュール化、構造化プログラミング、オブジェクト指向プログラミング、静的型チェックといった過去50年間のソフトウェアエンジニアリングの成果が、なぜこれほど影響が少なかったのかを説明できます。ソフトウェアシステムが大きくなり、プラットフォームの独立性が必須となるにつれて、これは代償を払っています。Chromiumは印象的な例であり、長年にわたって信じられないほど巨大なシステムに成長し、現在では4000万行近くのコードがあります。開発者はいくつかのビルドシステムを導入し、破棄してきました。数年前からGNが使用されており、これはChromiumのニーズに合わせて特別に開発されたものです。GNは非常に強力ですが、かなり複雑でもあります。Chromiumよりもはるかに小さいDart VMのビルドプロセスを理解することさえ、簡単からは程遠いです。私のツール(https://github.com/rochus-keller/GnTools)はこの点で役立ちましたが、静的解析に関して動的型付け言語が提供できるものの限界に本質的に達しています。したがって、大規模なソフトウェアシステムのビルドシステムを開発、分析、保守することは、動的言語で知られているのと同じような欠点を抱えており、最終的にTypeScriptやDartのような開発につながりました。私の見解では、ビルドシステムが静的型付けと効果的なモジュール化手段を持つことは、とっくに必要とされていました。
しかし、私の見解では、以前のビルドシステムであまり考慮されてこなかった他の側面もあります。まず、ビルドシステム自体がどのように構築され、そのコストと複雑さがどれほどであるかという問題提起が必要です。ビルドシステムが既存のシステムとプリインストールされたコンポーネントに要求するものは最小限であるべきです。GN、Meson、QMakeはこの点ではあまり良くありません。なぜなら、コンパイラと最近のバージョンのC++および/またはPythonのためのかなり大きなライブラリが必要だからです。私はかつて、最小限の、最小限に削減されたQtクラスセットを持つQMakeのスタンドアロンバージョンを作成しました。しかし、それは依然として200近くのソースコードファイルで構成されており、g++ *.cppのようなものでコンパイルしようとすると、利用可能なメモリをすべて消費し、数秒でクラッシュします。GNとMesonはどちらもNinjaも必要とします。これはさらに別のC++コードベースであり、ビルドする必要があります。
では、C89互換コンパイラのみを必要とし、数百キロバイトの単一バイナリを生成するLuaのようなものはどうでしょうか?そして、gcc *.cはLuaで完全にうまく機能します。C89で静的型付け言語のパーサーを書くことも可能です。
これが、私が自分で運を試して、この分野に参入するきっかけとなりました。
BUSYの実行
BUSYは通常、build.luaスクリプトを使用して起動され、追加の引数が続きます。build.luaは、必要に応じてLuaスクリプトを使用してビルドシステムを拡張または変更できるようにする、Cで実装されたLua関数の単なるファサードです。
BUSYはデフォルトで、BUSY実行可能ファイルがビルドされたツールチェーンを使用します。
デフォルトのコマンドラインバージョンlua build.luaは次のように動作します。ソースツリーのルートは..、ビルドディレクトリツリーのルートは./outputにあると想定されます。したがって、BUSYを実行する最も簡単な方法は、ソースツリーのトップレベルにビルドサブディレクトリを作成し、そこにBUSYソースコードを配置してコンパイルすることです。ただし、そうする必要はありません(以下の他のオプションを参照)。デフォルトでは、ルートBUSYファイル内のすべての製品(つまり、ビルドが直接実行されるもの)がビルドされます。これらはデフォルトとしてマークされています(名前の後に!を付けて)。
-Sオプションを使用すると、ソースディレクトリツリーのルートへのパスを明示的に設定できます。ショートカットとして、-Sプレフィックスなしでパスを直接入力することもできます。
-Bオプションを使用すると、ビルドディレクトリツリーのルートへのパスを明示的に設定できます。
-Tオプションを使用すると、ビルドする製品を明示的に選択できます。例:-T my_libは、ルートBUSYファイル内のProductサブタイプ名「my_lib」の公開変数宣言を探します。複数の製品を選択することも、ソースツリーのさらに下にあるBUSYファイルから製品を選択することも可能です。後者の場合、設計者の変数およびサブモジュール宣言が公開されている必要があります。
-Pオプションを使用すると、パラメータ値を設定できます。構文は-P x.y=valueで、valueは有効なBUSY基本型リテラル構文です。文字列やシンボルの構文では、コマンドラインエスケープを使用する必要がある場合が多いです。例えば、-P "string_param=\"this is a string\""や-P symbol_param=\`abc. です。ここでも、ソースツリーのさらに下にあるBUSYファイルのパラメータを設定できますが、設計者のサブモジュール宣言が公開されている場合に限ります。
-Mオプションを使用すると、optimized、nonoptimized、またはdebugのビルドモードのいずれかを選択できます。例:-M debug。デフォルトのビルドモードはoptimizedです。BUSYは短縮オプション-opt(optimized用)、-nopt(nonoptimized用)、または-dgb(debug用)もサポートしています。
-cオプションを使用すると、パーサー/アナライザーのみを実行してBUSYファイルをチェックします。ビルドは実行されず、ファイルやディレクトリも生成されません。
-Gオプションを使用すると、BUSYに別のビルドシステム用のコードを生成させることができます。現在、-G qmakeオプションがサポートされており、プロジェクトで使用するQtCreatorに必要なプロジェクトファイルを生成します。将来のBUSYバージョンでは、-G ninjaのような他のバックエンドもサポートされる予定です。-Gオプションが提供されない場合、BUSYはビルドを直接実行します。
ビルドの指定
ビルドは、BUSY仕様言語で書かれたコードを含むBUSYファイルを使用して指定されます。BUSYの使用方法については、The BUSY Build System - User's Guideを参照し、仕様言語の詳細については、The BUSY Build System - Language and Built-ins Specificationを参照してください。
BUSYファイルは、ファイル名が「BUSY」または代替として「BUSY.busy」のファイルです。ディレクトリに両方のファイルが存在する場合、「BUSY」という名前のファイルが優先されます。
ソースツリーのルートと、ビルドに関連するファイルまたは他のサブディレクトリを含む任意のサブディレクトリにBUSYファイルがあります。
BUSYファイルは、仕様言語の「モジュール」です。宣言は、公開(*、外部およびネストされたモジュールに可視)または保護(-、ネストされたモジュールにのみ可視)として宣言されない限り、モジュール内でのみ可視です。サブモジュールは明示的に宣言され、submodキーワードを使用して対応するディレクトリに関連付けられる必要があります。
仕様は、事前宣言された型、プロシージャ、および変数を使用します。事前宣言された型は、基本型bool、int、real、string、path、symbol、列挙型(例:type LibraryType* = (`static, `shared, `framework))、およびクラス型です。
type Config* = class {
cflags : string[]
defines: string[]
include_dirs: path[]
/* その他 */
configs: Config[]
}
クラス階層もあります。例えば、Executable、Library、SourceSetクラスはすべてProductのサブクラスであり、製品間のビルド時間依存関係(つまりターゲット)を表すdeps: Product[]フィールドを持っています。これはすべて、任意のBUSYファイルで使用できる通常の構文であり、魔法のクラス(例えばMesonのように)が別の言語で裏で定義されているわけではないことに注意してください。
let root_build_dir: path、let host_os: OsType、let host_toolchain: CompilerType、let host_toolchain_ver: intのような事前宣言されたグローバル変数は、BUSYによって設定され、ビルドを異なるオペレーティングシステムやツールチェーンに適応させるために使用できます。tostring()のような事前宣言された「プロシージャ」(実際には実際のプロシージャではなく、コンパイラへのヒントにすぎません)は、例えば数値を直接文字列変数に代入するとコンパイラエラーになるため、型変換を行うために使用できます。
BUSYは概念的に3つのフェーズで実行されます(BAZELに似ています):ロードフェーズ(すべてのBUSYファイルを解析)、分析フェーズ(ステートメントを実行し、ワークツリーを作成)、実行フェーズ(ワークツリーを深さ優先で実行)。すべての宣言が考慮され、異なるワークツリーが作成される場合でも、デフォルトとして選択されたもの(識別子に!が付いている)または-Tオプションによって選択されたもののみが実際に実行されることに注意することが重要です。
計画中または作業中の機能
現在のBUSYバージョンは、LeanQt、Oberon+ OBXMCツール、およびNAppGUIフレームワークとの使用のために機能が完成しており、Linux x86、x86_64、ARMv7(GCC)、Windows 10 x86およびAMD64(MSVC)、Windows 7 x86(MSVC)、macOS 10.11 x86_64および12.2 M1(CLANG)で正常にテストされています。
- 静的型付けされたビルド仕様言語、「可能な限りシンプルに」
- 文字列、シンボル、パス、コメント、識別子でのUnicode(UTF-8)サポート
- CおよびPascal風の構文バージョンの両方をサポート
- 直接ビルドを実行できる(つまり、Make、NMake、またはNinjaから独立して)
- 言語仕様
- BUSYを使用して軽量なQtソースツリーバージョンを作成する(LeanQtを参照)
- QMakeバックエンド(Linux、Windows、MacでQtCreator 3および4を使用したLeanQtでテスト済み)
- チュートリアル
- Ninjaバックエンドの実装
- CMakeバックエンドの実装
注記:
LinuxからARM Cortex-A7(Allwinner H3)へのクロスコンパイルは、次のコマンドで正常に機能しました:
lua build.lua ../LeanQt -P target_toolchain_path=//home/me/toolchain/bin -P HAVE_OBJECT -P target_toolchain_prefix=\"arm-linux-gnueabihf-\"
非目標
- BUSYは完全なプログラミング言語ではなく、そうなるつもりもありません。
- BUSYはパッケージジェネレータまたはマネージャーではありません。
- BUSYはGitクライアントではありません。
- BUSYはライブラリやツールチェーンを検索せず、何もダウンロードしません。与えられたものを使用します。
- BUSYはCプリプロセッサではなく、
#includeディレクティブをチェックしません。 - BUSYはテストフレームワーク、ジェネレータ、またはマネージャーではありません。外部スクリプトを実行することはできます。
- BUSYはNinjaの代替ではありません。ビルド可能なコードベースのデプロイを容易にするために直接ビルドを実行できます。高速な編集-コンパイル-実行サイクルには、Ninjaファイルを生成できます。
ビルド手順
BUSYのビルドは非常に簡単です。
- ターミナルを開き、現在のディレクトリをBUSYソースコードディレクトリに設定します。
- UnixマシンかWindowsマシンかに応じて、
cc *.c -O2 -lm -o luaまたはcl /O2 /MD /Fe:lua.exe *.cを実行します。 - 数秒待ちます。結果はBUSYが統合されたLua実行可能ファイルです。
追加クレジット
BUSYは、PUC-Rio、ブラジル(http://www.lua.org)のLuiz Henrique de Figueiredo、Roberto Ierusalimschy、およびWaldemar CelesによってMITライセンスの下で利用可能になったLua 5.1.5仮想マシンを使用しています。
BUSYは、LGPLまたはGPLライセンスの下で公開されているQtソースコードから派生したUnicodeテーブルとOS/CPU/ツールチェーン検出ロジックの一部を使用しています(https://www.qt.ioを参照)。
BUSYは、BSDスタイルのライセンスの下で利用可能になっているBrett WilsonらによるGNメタビルドシステムで実装され、文書化されている概念を使用しています(https://gn.googlesource.com/gn/を参照)。
サポート
サポートが必要な場合、または問題や機能リクエストを投稿したい場合は、https://github.com/rochus-keller/BUSY/issuesのGithubイシューリストを使用するか、著者にメールを送信してください。