colfer
Version 1.8.1
Colfer هو تنسيق تسلسل ثنائي مُحسّن للسرعة والحجم.
يقوم المترجم colf(1) الخاص بالمشروع بإنشاء كود المصدر من تعريفات المخطط إلى تنظيم وإلغاء تنظيم هياكل البيانات.
هذا برنامج مجاني وغير مرتبط تم طرحه في المجال العام. التنسيق مستوحى من Proto col Buf Fer s.
قم بتنزيل مترجم تم إنشاؤه مسبقًا أو قم بتشغيل go get -u github.com/pascaldekloe/colfer/cmd/colf لإنشاء واحد بنفسك. يمكن لمستخدمي البيرة أيضًا brew install colfer .
يطبع الأمر الدليل الخاص به عند استدعائه بدون وسيطات.
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)
من المستحسن الالتزام بالكود المصدري الذي تم إنشاؤه في التحكم في الإصدار المعني للحفاظ على اتساق البناء وتقليل الحاجة إلى عمليات تثبيت المترجم. وبدلاً من ذلك، يمكنك استخدام البرنامج المساعد Maven.
< plugin >
< groupId >net.quies.colfer</ groupId >
< artifactId >colfer-maven-plugin</ artifactId >
< version >1.11.2</ version >
< configuration >
< packagePrefix >com/example</ packagePrefix >
</ configuration >
</ plugin > يتم تعريف بنيات البيانات في ملفات .colf . التنسيق واضح تمامًا.
// 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
}
تعرف على الشكل الذي تبدو عليه التعليمات البرمجية التي تم إنشاؤها في لغة C أو Go أو Java أو JavaScript.
يوضح الجدول التالي كيفية تطبيق أنواع بيانات Colfer لكل لغة.
| كولفر | ج | يذهب | جافا | جافا سكريبت |
|---|---|---|---|---|
| منطقي | شار | منطقي | منطقية | منطقية |
| uint8 | uint8_t | uint8 | بايت † | رقم |
| uint16 | uint16_t | uint16 | قصير † | رقم |
| uint32 | uint32_t | uint32 | كثافة العمليات † | رقم |
| uint64 | uint64_t | uint64 | طويل † | رقم ‡ |
| int32 | int32_t | int32 | كثافة العمليات | رقم |
| int64 | int64_t | int64 | طويل | رقم ‡ |
| float32 | يطفو | float32 | يطفو | رقم |
| float64 | مزدوج | float64 | مزدوج | رقم |
| الطابع الزمني | com.timespec | الوقت.الوقت †† | الوقت.فوري | التاريخ + الرقم |
| نص | const char* + size_t | خيط | خيط | خيط |
| ثنائي | uint8_t* + size_t | [] بايت | بايت[] | Uint8Array |
| قائمة | * + حجم_ر | شريحة | صفيف | صفيف |
قد تحتوي القوائم على نقاط عائمة أو نص أو ثنائيات أو هياكل بيانات.
يعد Colfer مناسبًا لمصادر البيانات غير الموثوقة مثل إدخال/إخراج الشبكة أو التدفقات المجمعة. يأتي التنظيم وإلغاء التنظيم مزودًا بحماية مدمجة للحجم لضمان استهلاك الذاكرة بشكل يمكن التنبؤ به. يمنع التنسيق قنابل الذاكرة حسب التصميم.
لا يجوز للمنظم إنتاج مخرجات تالفة، بغض النظر عن إدخال البيانات. ولا يجوز بأي حال من الأحوال أن يقرأ غير المنظم خارج حدود المسلسل. لم يكشف اختبار الزغب عن أي نقاط ضعف حتى الآن. قوة الحوسبة هي موضع ترحيب.
لا تؤثر تغييرات الاسم على تنسيق التسلسل. يجب إعادة تسمية الحقول المهملة لمنع استخدامها بشكل واضح. للتوافق مع الإصدارات السابقة، يجب إضافة حقول جديدة إلى نهاية بنيات colfer. وبالتالي يمكن رؤية عدد الحقول كإصدار المخطط.
يهدف Colfer إلى أن يكون التنسيق الأسرع والأصغر دون المساس بالموثوقية. راجع الويكي المعياري للمقارنة. يتم التعامل مع الأداء دون المستوى الأمثل على أنه خطأ.
