kaitai_struct 下載 - kaitai_struct 原始碼下載

kaitai_struct

Python

1.0.0

下載

凱泰結構

注意：如果您想對專案進行更改，請不要分叉此儲存庫kaitai_struct 。相反，請在上面的文件樹中選擇要修改的元件，然後分叉該單一元件。
這是一個傘式儲存庫，僅包含作為子模組的元件，以便更輕鬆地檢查整個專案。除非您想修改此自述文件，否則它不是您可以進行編輯的儲存庫。

什麼是凱泰結構？

Kaitai Struct是一種聲明性語言，用於描述檔案或記憶體中佈置的各種二進位資料結構：即二進位檔案格式、網路串流資料包格式等。

主要想法是，特定格式僅用 Kaitai Struct 語言描述一次，然後可以使用ksc將其編譯為支援的程式語言之一的原始檔。這些模組將包括為解析器生成的程式碼，該解析器可以從檔案/流中讀取所描述的資料結構，並透過一個漂亮、易於理解的 API 對其進行存取。

它是用來做什麼的？

您是否曾經發現自己正在編寫重複的、容易出錯且難以調試的程式碼，這些程式碼從文件/網路流中讀取二進位資料結構，並以某種方式將它們表示在記憶體中以便於存取？

Kaitai Struct 試圖讓這項工作變得更容易——你只需要描述一次二進位格式，然後每個人都可以透過他們的程式語言使用它——跨語言、跨平台。

Kaitai Struct 包含越來越多的格式描述集合，可在格式子模組儲存庫中找到。

你能給我一個簡單的例子嗎？

當然。考慮這個簡單的.ksy格式描述文件，它描述了 GIF 文件（一種流行的 Web 圖像格式）的標頭：

 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副檔名並使用小端整數編碼。文件本身以兩個區塊開始：首先是header ，然後是logical_screen ：

「標題」由 3 個位元組的「神奇」字串（「GIF」）組成，用於標識它是一個 GIF 檔案開頭，然後還有 3 個位元組用於標識格式版本（ 87a或89a ）。
「邏輯螢幕描述子」是一個整數區塊：
- 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 ) ;

爪哇語

 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 ) ;

在Lua中

 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
Python
紅寶石

下載並安裝

查看整個 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文件