glib-mkenums - C language enum description generation utility
glib-mkenums [options] [files...]
glib-mkenums is a small perl-script utility that parses C code to extract enum definitions
and produces enum descriptions based on text templates specified by the user. Most fre-
quently this script is used to produce C code that contains enum values as strings so pro-
grams can provide value name strings for introspection.
glib-mkenums takes a list of valid C code files as input. The options specified control
the text that is output, certain substitutions are performed on the text templates for
keywords enclosed in @ characters.
Put out <text> prior to processing input files.
Put out <text> everytime a new input file is being processed.
Put out <text> after all input files have been processed.
Put out <text> everytime an enum is encountered in the input files.
Put out <text> before iterating over the set of values of an enum.
Put out <text> for every value of an enum.
Put out <text> after iterating over all values of an enum.
Template for auto-generated comments, the default (for C code generations) is "/*
Read templates from the given file. The templates are enclosed in specially-format-
ted C comments
/*** BEGIN section ***/
/*** END section ***/
where section may be file-header, file-production, file-tail, enumeration-produc-
tion, value-header, value-production, value-tail or comment.
Print brief help and exit.
Print version and exit.
Production text substitutions
Certain keywords enclosed in @ characters will be substituted in the outputted text. For
the substitution examples of the keywords below, the following example enum definition is
PREFIX_THE_XVALUE = 1 << 3,
PREFIX_ANOTHER_VALUE = 1 << 4
@EnumName@ The name of the enum currently being processed, enum names are assumed to be
properly namespaced and to use mixed capitalization to separate words (e.g.
@enum_name@ The enum name with words lowercase and word-separated by underscores (e.g.
@ENUMNAME@ The enum name with words uppercase and word-separated by underscores (e.g.
@ENUMSHORT@ The enum name with words uppercase and word-separated by underscores, prefix
stripped (e.g. THE_XENUM).
@VALUENAME@ The enum value name currently being processed with words uppercase and word-
separated by underscores, this is the assumed literal notation of enum values
in the C sources (e.g. PREFIX_THE_XVALUE).
@valuenick@ A nick name for the enum value currently being processed, this is usually gen-
erated by stripping common prefix words of all the enum values of the current
enum, the words are lowercase and underscores are substituted by a minus (e.g.
@type@ This is substituted either by "enum" or "flags", depending on whether the enum
value definitions contained bit-shift operators or not (e.g. flags).
@Type@ The same as @type@ with the first letter capitalized (e.g. Flags).
@TYPE@ The same as @type@ with all letters uppercased (e.g. FLAGS).
@filename@ The name of the input file currently being processed (e.g. foo.h).
Some C comments are treated specially in the parsed enum definitions, such comments start
out with the trigraph sequence "/*<" and end with the trigraph sequence ">*/". Per enum
definition, the options "skip" and "flags" can be specified, to indicate this enum defini-
tion to be skipped, or for it to be treated as a flags definition, or to specify the com-
mon prefix to be stripped from all values to generate value nicknames, respectively. Per
value definition, the options "skip" and "nick" are supported. The former causes the value
to be skipped, and the latter can be used to specify the otherwise auto-generated nick-
typedef enum /*< skip >*/
typedef enum /*< flags,prefix=PREFIX >*/
PREFIX_THE_ZEROTH_VALUE, /*< skip >*/
PREFIX_THE_THIRD_VALUE, /*< nick=the-last-value >*/
None known yet.
glib-mkenums was written by Tim Janik <email@example.com> and Owen Taylor <firstname.lastname@example.org>.
This manual page was provided by Tim Janik <email@example.com>.
27 Jul 2002 GLIB-MKENUMS(1)