mirror of
https://github.com/Ed94/metadesk.git
synced 2026-06-13 07:52:22 -07:00
Allen Webster
103 lines
4.1 KiB
Plaintext
103 lines
4.1 KiB
Plaintext
EXAMPLES:
|
|
|
|
|
|
1. "hello world" intro/hello_world.c
|
|
Just enough C code to setup a from-scratch metadesk program, parse
|
|
"hello world", and print the results.
|
|
|
|
This example is a "build test", to make sure your compiler is finiding the
|
|
source files and can build them.
|
|
|
|
|
|
2. "parse check" intro/parse_check.c
|
|
An example utility that parses files specified on the command line, reports
|
|
any errors from the metadesk parser, and then prints the results.
|
|
|
|
This example includes lots of notes about the basics of setting up a metadesk
|
|
parsing program from scratch, and getting used to the helpers in the library.
|
|
|
|
|
|
3. intro/hello_world.mdesk, intro/labels.mdes, intro/sets.mdesk
|
|
These files include examples of the features of the metadesk language. We
|
|
recommend putting these through the "parse check" example utility to see how
|
|
different language constructs get parsed, if you want to get more familiar
|
|
with the language side of metadesk.
|
|
|
|
|
|
4. "data desk like template" intro/data_desk_like_template.c
|
|
An example for users of Data Desk, the pre-cursor to Metadesk.
|
|
|
|
|
|
5. "user errors" user_errors/*
|
|
This example shows how you can mix in your own error reporting with the errors
|
|
that come back from the metadesk parser.
|
|
|
|
|
|
6. "type metadata" type_metadata/*
|
|
(Start exploring this example at type_metadata/type_metadata.c)
|
|
|
|
A common use case for a metaprogramming system in C is to mark up type
|
|
information with metadata. This example shows the "Metadesk way" of
|
|
implementing that use case. This is the biggest example included and closely
|
|
matches what a typical metadesk based metaprogram grows to look like over
|
|
time. It includes:
|
|
analyzing a metadesk parse tree
|
|
doing error checks
|
|
generating C types, functions, a data tables
|
|
generating type serialization metadata
|
|
generating enum string tables
|
|
generating enum mapping functions
|
|
printing diagnostics
|
|
including generated files into a final program
|
|
|
|
Commentary in this example focuses on strategies for setting up an effective
|
|
metaprogram.
|
|
|
|
|
|
7. "expressions intro" expr/expr_intro.c, expr/expr_intro.mdesk
|
|
This example introduces the expression parsing feature built into Metadesk.
|
|
With it, flat sequences of Metadesk nodes can be parsed as arithmetic
|
|
expressions.
|
|
|
|
This example shows how to setup an operator table, call the expression parser
|
|
and interpret the expression tree that comes back. It discusses some of the
|
|
capabilities and limits of the expression system.
|
|
|
|
|
|
8. "c like expressions" expr/expr_c_like.c, expr/expr_c_like.mdesk
|
|
This example has a pre-built operator table setup for parsing C like
|
|
expressions. This can be used as an advanced example of the expression parser
|
|
or as a copy-paste template for making an expression parser that matches C.
|
|
The only C operator that is not supported in some way is the ternary operator.
|
|
|
|
The metadesk file for this example shows how to deal with a few quirks that
|
|
arise from the fact that the expression system is layered on top of the
|
|
Metadesk grammar.
|
|
|
|
|
|
9. "overrides" integration/overrides.c
|
|
When including the Metadesk library into an existing codebase, the overrides
|
|
system in the library will let you plug in existing implementations you have
|
|
for many of the basic requirements of the library. This can also be useful if
|
|
you want to make your program CRT-free, or direct metadesk allocations to your
|
|
own custom allocator.
|
|
|
|
|
|
10. "memory management" integration/memory_management.c
|
|
This example shows how to use Metadesk in situations where the basic
|
|
allocate-and-never-free strategy isn't good enough. The example discusses the
|
|
MD_Arena, shows the basics on getting started with it, and has a lot of tips
|
|
on further ways to use the arenas.
|
|
|
|
|
|
11. "multi threaded parse" integration/multi_threaded.c
|
|
If Metadesk is used to encode metadata in something like an asset pipeline
|
|
it may become useful to parse multiple Metadesk files in parallel. The library
|
|
doesn't have any thread safety "built in" to the APIs, but it is designed
|
|
to make it fairly straight forward to manage the thread safety yourself, and
|
|
this example shows how.
|
|
|
|
This example relies on some of the information explained in the memory
|
|
management example, so it may be useful to start there.
|
|
|