colfer
Version 1.8.1
Colfer adalah format serialisasi biner yang dioptimalkan untuk kecepatan dan ukuran.
Kompiler proyek colf(1) menghasilkan kode sumber dari definisi skema hingga struktur data marshal dan unmarshall.
Ini adalah perangkat lunak gratis dan tidak terbebani yang dirilis ke domain publik. Formatnya terinspirasi oleh Proto col Buf fer s.
Unduh kompiler bawaan atau jalankan go get -u github.com/pascaldekloe/colfer/cmd/colf untuk membuatnya sendiri. Pengguna homebrew juga dapat brew install colfer .
Perintah tersebut mencetak manualnya sendiri ketika dipanggil tanpa argumen.
NAME
colf — compile Colfer schemas
SYNOPSIS
colf [-h]
colf [-vf] [-b directory] [-p package]
[-s expression] [-l expression] C [file ...]
colf [-vf] [-b directory] [-p package] [-t files]
[-s expression] [-l expression] Go [file ...]
colf [-vf] [-b directory] [-p package] [-t files]
[-x class] [-i interfaces] [-c file]
[-s expression] [-l expression] Java [file ...]
colf [-vf] [-b directory] [-p package]
[-s expression] [-l expression] JavaScript [file ...]
DESCRIPTION
The output is source code for either C, Go, Java or JavaScript.
For each operand that names a file of a type other than
directory, colf reads the content as schema input. For each
named directory, colf reads all files with a .colf extension
within that directory. If no operands are given, the contents of
the current directory are used.
A package definition may be spread over several schema files.
The directory hierarchy of the input is not relevant to the
generated code.
OPTIONS
-b directory
Use a base directory for the generated code. (default ".")
-c file
Insert a code snippet from a file.
-f Normalize the format of all schema input on the fly.
-h Prints the manual to standard error.
-i interfaces
Make all generated classes implement one or more interfaces.
Use commas as a list separator.
-l expression
Set the default upper limit for the number of elements in a
list. The expression is applied to the target language under
the name ColferListMax. (default "64 * 1024")
-p package
Compile to a package prefix.
-s expression
Set the default upper limit for serial byte sizes. The
expression is applied to the target language under the name
ColferSizeMax. (default "16 * 1024 * 1024")
-t files
Supply custom tags with one or more files. Use commas as a list
separator. See the TAGS section for details.
-v Enable verbose reporting to standard error.
-x class
Make all generated classes extend a super class.
TAGS
Tags, a.k.a. annotations, are source code additions for structs
and/or fields. Input for the compiler can be specified with the
-t option. The data format is line-oriented.
<line> :≡ <qual> <space> <code> ;
<qual> :≡ <package> '.' <dest> ;
<dest> :≡ <struct> | <struct> '.' <field> ;
Lines starting with a '#' are ignored (as comments). Java output
can take multiple tag lines for the same struct or field. Each
code line is applied in order of appearance.
EXIT STATUS
The command exits 0 on success, 1 on error and 2 when invoked
without arguments.
EXAMPLES
Compile ./io.colf with compact limits as C:
colf -b src -s 2048 -l 96 C io.colf
Compile ./*.colf with a common parent as Java:
colf -p com.example.model -x com.example.io.IOBean Java
BUGS
Report bugs at <https://github.com/pascaldekloe/colfer/issues>.
Text validation is not part of the marshalling and unmarshalling
process. C and Go just pass any malformed UTF-8 characters. Java
and JavaScript replace unmappable content with the '?' character
(ASCII 63).
SEE ALSO
protoc(1), flatc(1)
Disarankan untuk memasukkan kode sumber yang dihasilkan ke dalam kontrol versi masing-masing untuk menjaga konsistensi build dan meminimalkan kebutuhan instalasi compiler. Alternatifnya, Anda dapat menggunakan plugin Maven.
< plugin >
< groupId >net.quies.colfer</ groupId >
< artifactId >colfer-maven-plugin</ artifactId >
< version >1.11.2</ version >
< configuration >
< packagePrefix >com/example</ packagePrefix >
</ configuration >
</ plugin > Struktur data ditentukan dalam file .colf . Formatnya cukup jelas.
// Package demo offers a demonstration.
// These comment lines will end up in the generated code.
package demo
// Course is the grounds where the game of golf is played.
type course struct {
ID uint64
name text
holes []hole
image binary
tags []text
}
type hole struct {
// Lat is the latitude of the cup.
lat float64
// Lon is the longitude of the cup.
lon float64
// Par is the difficulty index.
par uint8
// Water marks the presence of water.
water bool
// Sand marks the presence of sand.
sand bool
}
Lihat seperti apa kode yang dihasilkan di C, Go, Java, atau JavaScript.
Tabel berikut memperlihatkan bagaimana tipe data Colfer diterapkan per bahasa.
| Colfer | C | Pergi | Jawa | JavaScript |
|---|---|---|---|---|
| bodoh | arang | bodoh | boolean | Boolean |
| uint8 | uint8_t | uint8 | byte † | Nomor |
| uint16 | uint16_t | uint16 | pendek † | Nomor |
| uint32 | uint32_t | uint32 | ke dalam † | Nomor |
| uint64 | uint64_t | uint64 | panjang † | Nomor ‡ |
| int32 | int32_t | int32 | ke dalam | Nomor |
| int64 | int64_t | int64 | panjang | Nomor ‡ |
| float32 | mengambang | float32 | mengambang | Nomor |
| float64 | dobel | float64 | dobel | Nomor |
| stempel waktu | spesifikasi waktu | waktu.Waktu †† | waktu. Instan | Tanggal + Nomor |
| teks | const char* + ukuran_t | rangkaian | Rangkaian | Rangkaian |
| biner | uint8_t* + ukuran_t | []bita | byte[] | Uint8Array |
| daftar | * + ukuran_t | mengiris | susunan | Himpunan |
Daftar mungkin berisi floating point, teks, biner, atau struktur data.
Colfer cocok untuk sumber data yang tidak tepercaya seperti I/O jaringan atau aliran massal. Marshalling dan unmarshalling hadir dengan perlindungan ukuran bawaan untuk memastikan konsumsi memori yang dapat diprediksi. Format ini sengaja mencegah bom memori.
Marshaller tidak boleh menghasilkan keluaran yang salah, apa pun masukan datanya. Dalam keadaan apa pun, unmarshaller tidak boleh membaca di luar batas-batas sebuah serial. Pengujian fuzz belum menunjukkan adanya volnurabilitas. Kekuatan komputasi diterima.
Perubahan nama tidak mempengaruhi format serialisasi. Bidang yang tidak digunakan lagi harus diganti namanya untuk mencegah penggunaannya. Untuk kompatibilitas mundur, bidang baru harus ditambahkan ke akhir struct colfer. Dengan demikian jumlah field dapat dilihat sebagai versi skema.
Colfer bertujuan untuk menjadi format tercepat dan terkecil tanpa mengurangi keandalan. Lihat wiki benchmark untuk perbandingan. Performa suboptimal diperlakukan seperti bug.
