colfer
Version 1.8.1
Colfer — это формат двоичной сериализации, оптимизированный по скорости и размеру.
Компилятор проекта colf(1) генерирует исходный код на основе определений схемы для маршалинга и демаршалинга структур данных.
Это бесплатное и ничем не обремененное программное обеспечение, распространяемое в общественное достояние. Формат вдохновлен Proto col Buffer s.
Загрузите готовый компилятор или запустите go get -u github.com/pascaldekloe/colfer/cmd/colf чтобы создать его самостоятельно. Пользователи Homebrew также могут 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 применяются к каждому языку.
| Колфер | С | Идти | Ява | JavaScript |
|---|---|---|---|---|
| логическое значение | голец | логическое значение | логическое значение | логическое значение |
| 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 | двойной | Число |
| временная метка | спецификация времени | время.Время †† | время.Мгновенное | Дата + номер |
| текст | константный символ* + size_t | нить | Нить | Нить |
| двоичный | uint8_t* + size_t | []байт | байт[] | Uint8Array |
| список | * + размер_т | кусочек | множество | Множество |
Списки могут содержать числа с плавающей запятой, текст, двоичные файлы или структуры данных.
Colfer подходит для ненадежных источников данных, таких как сетевой ввод-вывод или массовые потоки. Маршалинг и демаршалинг осуществляется со встроенной защитой размера, обеспечивающей предсказуемое потребление памяти. Формат изначально предотвращает возникновение бомб памяти.
Маршаллер не может выдавать неверный результат независимо от входных данных. Ни в коем случае не разрешается читать текст за пределами сериала. Фазз-тестирование пока не выявило никаких уязвимостей. Вычислительная мощность приветствуется.
Изменения имени не влияют на формат сериализации. Устаревшие поля следует переименовать, чтобы явно препятствовать их использованию. Для обратной совместимости в конец структур colfer необходимо добавлять новые поля. Таким образом, количество полей можно рассматривать как версию схемы.
Colfer стремится создать самый быстрый и самый маленький формат без ущерба для надежности. См. вики-тест для сравнения. Неоптимальная производительность рассматривается как ошибка.
