|author||Jason Graffius <email@example.com>||Thu Jun 29 19:48:04 2023 -0400|
|committer||GitHub <firstname.lastname@example.org>||Thu Jun 29 16:48:04 2023 -0700|
Emit compilation errors for bad C++ namespaces (#92) * Emit compilation errors for bad C++ namespaces Prior to this CL, an incorrectly-formatted namespace will fail an assert and print a python exception to the user. While this likely sufficient for a user to diagnose the issue, it is inconsistent with other error reporting in Emboss. With this change, the namespace checking is implemented in the same way as other validations in the Emboss compiler, providing a specific file, line, and column range of the issue and printing the line containing the issue to the user. * Improve namespace error messages
Emboss is a tool for generating code that reads and writes binary data structures. It is designed to help write code that communicates with hardware devices such as GPS receivers, LIDAR scanners, or actuators.
Emboss takes specifications of binary data structures, and produces code that will efficiently and safely read and write those structures.
Currently, Emboss only generates C++ code, but the compiler is structured so that writing new back ends is relatively easy -- contact email@example.com if you think Emboss would be useful, but your project uses a different language.
Emboss is not designed to handle text-based protocols; if you can use minicom or telnet to connect to your device, and manually enter commands and see responses, Emboss probably won't help you.
In C++, packed structs are most common method of dealing with these kinds of structures; however, they have a number of drawbacks compared to Emboss views:
Emboss does not help you transmit data over a wire -- you must use something else to actually transmit bytes back and forth. This is partly because there are too many possible ways of communicating with devices, but also because it allows you to manipulate structures independently of where they came from or where they are going.
Emboss does not help you interpret your data, or implement any kind of higher-level logic. It is strictly meant to help you turn bit patterns into something suitable for your programming language to handle.
Emboss is currently under development. While it should be entirely ready for many data formats, it may still be missing features. If you find something that Emboss can't handle, please contact
firstname.lastname@example.org to see if and when support can be added.
Emboss is not an officially supported Google product: while the Emboss authors will try to answer feature requests, bug reports, and questions, there is no SLA (service level agreement).
Head over to the User Guide to get started.