ucode: A JavaScript-like Scripting Language for Embedded Systems and Template Processing

The ucode Scripting Language

The ucode language is a small, general-purpose scripting language that resembles ECMAScript syntax. It can be used as a standalone interpreter or embedded into host applications. Ucode supports template mode with control flow and expression logic statements embedded in Jinja-like markup blocks.

The development of ucode was motivated by the need to rewrite the OpenWrt firewall framework using nftables. Initially intended as a template processor, ucode evolved into a versatile scripting language for various system scripting tasks.

Its design goals include easy integration with C applications, efficient handling of JSON data and complex data structures, support for OpenWrt's ubus message bus system, and a comprehensive set of built-in functions inspired by Perl 5.

Ucode provides the ability to embed code logic into plain text templates, supports JSON parsing and serialization, has distinct array and object types, includes built-in support for bit operations and regular expressions, and offers bindings for relevant Linux and OpenWrt APIs.

It follows ECMAScript syntax for familiarity and reusability of existing tooling, emphasizes synchronous programming flow, aims for a small executable size, and can be embedded into C host applications.

In summary, ucode is a synchronous scripting language resembling ECMAScript, designed for template processing, system scripting tasks, and integration into C applications, with features such as JSON support, comprehensive built-in functions, and bindings for relevant APIs.

Installation

The ucode package should be already preinstalled on modern OpenWrt releases. To learn how to install it on other systems, refer to the Installation Section in the documentation.

Documentation

The most up-to-date documentation is hosted at the ucode documentation portal. You can build the documentation yourself by running npm install followed by npm run doc in the cloned repository. The generated documentation will be placed in the docs/ directory.

Examples

Examples for embedding ucode into C applications can be found in the examples/ directory. Notable OpenWrt programs embedding ucode are the OpenWrt ubus rpc daemon and the Tiny uhttpd web server. Some ucode scripting examples can be found in the ucode testcase sources.

Projects using ucode scripting include the OpenWrt LuCI web interface and the OpenWrt firewall4 framework.

---

The Evolution of ucode: From Template Processor to Full-Fledged Scripting Language

The story of ucode begins with a specific problem: the need to modernize OpenWrt's firewall framework using nftables. What started as a simple template processor for generating nftables rules evolved into a much more sophisticated tool, demonstrating how practical needs often drive the creation of new programming languages.

Design Philosophy and Key Features

At its core, ucode embraces ECMAScript syntax, making it immediately familiar to JavaScript developers while being purpose-built for system-level tasks. This decision reflects a pragmatic approach to language design - leveraging existing knowledge and tooling rather than creating something entirely novel.

The language's emphasis on synchronous programming flow is particularly noteworthy. In an era where asynchronous programming dominates many domains, ucode's synchronous nature makes it ideal for system scripting tasks where predictable execution order is crucial. This design choice also contributes to the language's small executable size, a critical consideration for embedded systems.

Template Processing Capabilities

One of ucode's standout features is its template mode, which allows developers to embed control flow and expression logic directly into Jinja-like markup blocks. This capability transforms ucode from a simple scripting language into a powerful template engine, capable of generating configuration files, HTML documents, or any other text-based output where dynamic content is needed.

Consider the practical implications: system administrators can write configuration templates that adapt based on system state, network conditions, or user preferences. The ability to mix static text with dynamic logic in a single file streamlines many common system administration tasks.

JSON Support and Data Handling

Modern system scripting often involves working with JSON data, whether it's configuration files, API responses, or structured logs. Ucode's built-in JSON parsing and serialization capabilities make it particularly well-suited for these tasks. The language's distinct array and object types provide a natural way to work with structured data, while comprehensive built-in functions inspired by Perl 5 offer powerful data manipulation capabilities.

Integration with OpenWrt Ecosystem

Ucode's deep integration with OpenWrt's ubus message bus system demonstrates how specialized languages can provide significant advantages when tightly coupled with their target environment. The ability to interact seamlessly with ubus allows ucode scripts to control and monitor various aspects of OpenWrt systems, from network interfaces to package management.

Real-World Applications

The adoption of ucode by significant OpenWrt projects speaks volumes about its utility. The OpenWrt LuCI web interface uses ucode for its templating needs, while the firewall4 framework relies on it for nftables rule generation. These production deployments validate ucode's design decisions and demonstrate its maturity as a tool.

Comparison with Other Scripting Languages

While ucode shares similarities with JavaScript, Python, and other scripting languages, its specific focus on system scripting and template processing sets it apart. Unlike general-purpose languages that try to be everything to everyone, ucode excels in its niche, providing just the right features without unnecessary complexity.

For developers working in OpenWrt environments or similar embedded systems, ucode offers a compelling alternative to more heavyweight scripting languages. Its small footprint, C integration capabilities, and specialized features make it particularly well-suited for constrained environments where resources matter.

Future Prospects

As embedded systems continue to proliferate and the need for efficient system scripting grows, languages like ucode are likely to find increasing adoption. The language's success within the OpenWrt community suggests potential for broader application in other embedded Linux distributions and IoT devices.

The balance ucode strikes between familiarity (through ECMAScript syntax) and specialization (through system-focused features) represents an effective approach to language design. Rather than trying to compete with established general-purpose languages, ucode carves out its own space by solving specific problems exceptionally well.

For developers interested in system scripting, template processing, or embedded systems programming, ucode offers a mature, well-designed tool that continues to evolve based on real-world needs. Its journey from simple template processor to versatile scripting language illustrates how practical requirements can drive the development of powerful, specialized tools.