| commit | 699bf1a0dcaac53770056d54fc819ddb8e4280c4 | [log] [tgz] |
|---|---|---|
| author | Jason Graffius <jasongraffius@gmail.com> | Wed Jun 28 20:15:15 2023 -0400 |
| committer | GitHub <noreply@github.com> | Wed Jun 28 17:15:15 2023 -0700 |
| tree | 90afc0fc2473e236918624e9c49b2adc16d6cf44 | |
| parent | 5a501d8f00becef232ea4022027cf4c6bac31f1a [diff] |
Implement `enum_case` attribute in cpp backend (#89) * Implement `enum_case` attribute in cpp backend Implements the `enum_case` attribute in the C++ backend to support emitting enum values with a case other than SHOUTY_CASE. Currently only the original SHOUTY_CASE and the new kCamelCase cases are supported, but adding a new case should be trivial. Additionally, the implementation was designed to make it simple for a `name` attribute to be added for enum values (other IR nodes should be unaffected, it would be neither simpler nor harder to implement after this commit for other nodes). Tests were added for case conversions, header generation, and a cc_test. All tests pass both in `bazel test` and `python -m unittest`. A small change was made to the front-end, as some attribute handling functions were hoisted into `compiler/util` for reuse in the backend. * Fixes from PR comments - Uses the original SHOUTY_CASE emboss names as the canonical name for enum values rather than the backend-specific names. - Tests (and fixes) the text stream functions. - Adds additional test cases. - Uses indicative verb forms for docstrings rather than imperative. - Handles errors in enum_case strings much better. - Gives the source location of the specific issue. - Checks for empty/leading commas, allows trailing commas. - Checks for duplicate cases. * Update docs for enum_case feature. * Fix comment * Test and fix empty/whitespace enum_case values with no comma
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.