kaitai_struct ダウンロード - kaitai_struct ソースコードのダウンロード

kaitai_struct

パイソン

1.0.0

ダウンロード

解体構造体

注:プロジェクトに変更を加えたい場合は、このリポジトリkaitai_struct をフォークしないでください。代わりに、上記のファイルツリーで変更するコンポーネントを選択し、その個別のコンポーネントをフォークします。
これは包括的なリポジトリであり、プロジェクト全体を簡単にチェックアウトできるようにコンポーネントをサブモジュールとしてのみ含んでいます。この README を変更しない限り、編集できるリポジトリはありません。

解体構造とは何ですか？

Kaitai Struct は、ファイルまたはメモリ内に配置されたさまざまなバイナリデータ構造 (つまり、バイナリファイル形式、ネットワークストリームパケット形式など) を記述するために使用される宣言型言語です。

主なアイデアは、特定の形式を Kaitai Struct 言語で 1 回だけ記述し、その後、サポートされているプログラミング言語の 1 つでkscを使用してソースファイルにコンパイルできるということです。これらのモジュールには、記述されたデータ構造をファイル/ストリームから読み取り、理解しやすい優れた API でアクセスできるパーサー用に生成されたコードが含まれます。

何に使われるのですか？

ファイルやネットワークストリームからバイナリデータ構造を読み取り、それらを何らかの方法でメモリ内に表現して簡単にアクセスできるようにする、繰り返しが多く、エラーが発生しやすく、デバッグが難しいコードを作成していることに気付いたことがありますか?

Kaitai Struct は、この作業を簡単にしようとしています。バイナリ形式を一度記述するだけで、誰もが自分のプログラミング言語から、クロス言語、クロスプラットフォームでそれを使用できるようになります。

Kaitai Struct には、フォーマットサブモジュールリポジトリで利用できるフォーマット記述の増大するコレクションが含まれています。

簡単な例を教えていただけますか?

もちろん。 GIF ファイル (一般的な Web 画像形式) のヘッダーを説明する、次の単純な.ksy形式記述ファイルについて考えてみましょう。

 meta :
  id : gif
  file-extension : gif
  endian : le
seq :
  - id : header
    type : header
  - id : logical_screen
    type : logical_screen
types :
  header :
    seq :
      - id : magic
        contents : ' GIF '
      - id : version
        size : 3
  logical_screen :
    seq :
      - id : image_width
        type : u2
      - id : image_height
        type : u2
      - id : flags
        type : u1
      - id : bg_color_index
        type : u1
      - id : pixel_aspect_ratio
        type : u1

これは、GIF ファイルは通常.gif拡張子を持ち、リトルエンディアン整数エンコーディングを使用することを宣言します。ファイル自体は 2 つのブロックで始まります。最初にheaderが来て、次にlogical_screenが来ます。

「ヘッダー」は、先頭が GIF ファイルであることを識別する 3 バイトの「マジック」文字列 (「GIF」) で構成され、その後、形式のバージョン ( 87aまたは89a ) を識別するさらに 3 バイトがあります。
「論理画面記述子」は整数のブロックです。
- image_widthとimage_height 2 バイトの符号なし整数です
- flags 、 bg_color_index 、 pixel_aspect_ratioそれぞれ 1 バイトの unsigned int を受け取ります

この.ksyファイルは、 Gif.cs / Gif.java / Gif.js / Gif.php / gif.py / gif.rbにコンパイルでき、すぐに .gif ファイルをロードして、たとえば幅やサイズなどにアクセスできます。身長。

C# の場合

 Gif g = Gif . FromFile ( "path/to/some.gif" ) ;
Console . WriteLine ( "width = " + g . LogicalScreen . ImageWidth ) ;
Console . WriteLine ( "height = " + g . LogicalScreen . ImageHeight ) ;

Javaでは

 Gif g = Gif . fromFile ( "path/to/some.gif" );
System . out . println ( "width = " + g . logicalScreen (). imageWidth ());
System . out . println ( "height = " + g . logicalScreen (). imageHeight ());

JavaScriptの場合

より完全なクイックスタートガイドについては、ドキュメントの JavaScript のメモを参照してください。

 var g = new Gif ( new KaitaiStream ( someArrayBuffer ) ) ;
console . log ( "width = " + g . logicalScreen . imageWidth ) ;
console . log ( "height = " + g . logicalScreen . imageHeight ) ;

ルアで

 local g = Gif : from_file ( " path/to/some.gif " )
print ( " width = " .. g . logical_screen . image_width )
print ( " height = " .. g . logical_screen . image_height )

ニムで

 let g = Gif . fromFile ( " path/to/some.gif " )
echo " width = " & $ g.logicalScreen.imageWidth
echo " height = " & $ g.logicalScreen.imageHeight

PHPの場合

logicalScreen()->imageWidth()); printf("height = %dn", $g->logicalScreen()->imageHeight());">

 $ g = Gif:: fromFile ( ' path/to/some.gif ' );
printf ( " width = %d n" , $ g -> logicalScreen ()-> imageWidth ());
printf ( " height = %d n" , $ g -> logicalScreen ()-> imageHeight ());

Pythonで

 g = Gif . from_file ( "path/to/some.gif" )
print "width = %d" % ( g . logical_screen . image_width )
print "height = %d" % ( g . logical_screen . image_height )

ルビーでは

 g = Gif . from_file ( "path/to/some.gif" )
puts "width = #{ g . logical_screen . image_width } "
puts "height = #{ g . logical_screen . image_height } "

もちろん、この例は、Kaitai Struct で実行できることの非常に限られたサブセットのみを示しています。詳細については、チュートリアルとドキュメントを参照してください。

サポートされている言語

公式 Kaitai Struct コンパイラは、次の言語のソースモジュールへの.ksyのコンパイルをサポートするようになりました。

C#
ジャワ
JavaScript
ルア
ニム
PHP
パイソン
ルビー

ダウンロードとインストール

Kaitai Struct プロジェクト全体をチェックアウトする最も簡単な方法は、他のすべての部分がすでにサブモジュールとしてインポートされているメインプロジェクトリポジトリをダウンロードすることです。使用：

 git clone --recursive https://github.com/kaitai-io/kaitai_struct.git

--recursiveオプションに注意してください。

あるいは、Kaitai Struct スイートを構成する個々のサブプロジェクトをチェックアウトすることもできます。彼らです：

kaitai_struct_compiler — .ksyターゲットプログラミング言語で書かれたパーサーソースコードに変換するコンパイラー
kaitai_struct_tests — コンパイラーが計画どおりに動作することを確認するためのテストと仕様
ランタイムライブラリ
- kaitai_struct_cpp_stl_runtime — C++/STL 用
- kaitai_struct_csharp_runtime — C# 用
- kaitai_struct_java_runtime — Java 用
- kaitai_struct_javascript_runtime — JavaScript 用
- kaitai_struct_nim_runtime — Nim 用
- kaitai_struct_lua_runtime — Lua 用
- kaitai_struct_python_runtime — Python 用
- kaitai_struct_ruby_runtime — Ruby 用
- kaitai_struct_swift_runtime — Swift 用
kaitai_struct_formats — 広く使用されている形式と.ksyファイルとして記述されたバイナリ構造のライブラリ

プロジェクトでの KS の使用

通常、KS で説明されている形式をプロジェクトで使用するには、次の手順が必要です。

形式を説明します。つまり、 .ksyファイルを作成します。
.ksyファイルをターゲット言語ソースファイルにコンパイルし、そのファイルをプロジェクトに含めます
特定の言語の KS ランタイムライブラリをプロジェクトに追加します (心配しないでください。サイズは小さく、主に生成されたコードの可読性を確保するために存在します)。
生成されたクラスを使用してバイナリファイル/ストリームを解析し、そのコンポーネントにアクセスします

詳細については、チュートリアルとドキュメントを参照してください。