What code would you consider using a code generator like CodeSmith for?

Question

I use CodeSmith for the PLINQO templates, to build my DAL from my DB objects; it works great!

I believe that's the primary use of code generator apps, but I'm curious... what other code would you consider using a code generator for? Do you have any CodeSmith templates that you use frequently (if so, what does it do)?

Answer 1

I haven't used CodeSmith, but I've done a fair bit of code generation. Noteably I wrote most of a configuration management (CM) system for a WiMAX system, where the CM code was generated for 3 different platforms. The only difference was the CM model for each platform.

The model was in a custom Domain Specific Language (DSL) that we built had a parser for. The language was a basic container/element style where containers could nest and have an identifier, and elements were of pre-defined types. Documentation was an attribute of elements and containers. You could add Lua snippets to the element and container definitions to do semantic validation (e.g., the value is in the correct range, if it's an IP address is it in a CIDR range defined elsewhere, etc.).

The parser generated a syntax tree that we then pushed at templates. The template language was a partial C implementation of StringTemplate. We used it to generate:

• A model specific C API that applications could call into to get configuration values,
• The collected Lua code for validating the model and providing useful error messages,
• Two "backends" for the API that would manage values in memory (for temporary manipulation of a model), and in a database system (for sharing amongst processes),
• Configuration file parser and writer,
• HTML documentation, and
• Command Line Interface (CLI) implementation for interactive viewing and changing of a configuration.

In retrospect, I should have simply used Lua directly as the DSL. It would have been more verbose, but having the parser already there and lots of Lua templating choices available to me would have saved a lot of development effort.

For things that have a repetivie structure and well defined rules about what those things need to do, code generation can be a wonderful thing.