commit | 9191077294ebd809e6e706c82d8f811423b11bd7 | [log] [tgz] |
---|---|---|
author | Jason Graffius <jasongraffius@gmail.com> | Thu May 18 12:43:52 2023 -0400 |
committer | GitHub <noreply@github.com> | Thu May 18 09:43:52 2023 -0700 |
tree | 0fbc110dde97404f158fe242ee68ddf1e4fde108 | |
parent | 1119723db88f5360cf17d2e4cc4cd2f6d52f3c67 [diff] |
Fix header_generator_test (#88) * Fix header_generator_test Due to a missing `unittest.main()` call, the header_generator_test was not actually running any tests when run with bazel/run directly. However, the failure was noticed by `python -m unittest discover`. Fixed the header_generator_test in the following ways: - Import test_util (tests failed due to missing import). - Change attribute_checker.normalize_and_verify to header_generator.generate_header. - Remove unused imports. - Make appropriate BUILD changes. - Add unittest.main() call so that unit tests are run. Additionally, this change adds a (blank) __init__.py to compiler/ and compiler/util/ so that they are importable by the unittest module. This means that running `python -m unittest discover -p '*_test.py'` from the main emboss repository should run all python tests in the compiler - and could be a good sanity check to make sure all python tests pass, even when `bazel test compiler/...` could miss tests (not declared in BUILD or missing the unittest.main() call). * Move front_end/test_util to util/test_util
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 emboss-dev@google.com if you think Emboss would be useful, but your project uses a different language.
If you're sitting down with a manual that looks something like this or this, Emboss is meant for you.
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.
Emboss is intended for cases where you do not control the data format. If you are defining your own format, you may be better off using Protocol Buffers or Cap'n Proto or BSON or some similar system.
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 emboss-dev@google.com
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.