C Parser

The Yace-file generator, invoked by: yace <file.c>. Below are examples of what you can expect to see when running it on C a header.

Note

The C Parser is implemented using Python bindings to libclang. Thus, libclang must be loadable on the system.

Invoking it

yace tests/parsing/example.h --output output

C Header

../../../models/example.h

#define PLOT_SERIAL "WYRD1234"
#define PLOT_FOO 0xACDC
#define PLOT_VERSION_MAJOR 1
#define PLOT_VERSION_MINOR 2
#define PLOT_VERSION_PATCH 3

/**
 * Description of enum
 *
 * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque accumsan massa est,
 * ut ullamcorper lectus malesuada sit amet. Donec gravida nibh aliquam mattis rhoncus. Quisque
 * sollicitudin ultricies orci, condimentum blandit lorem feugiat at. Aliquam tempus metus et nulla
 * eleifend, eu dapibus risus pellentesque. Duis fermentum bibendum ligula in pharetra. Curabitur
 * eget urna tempus, tempor dui sed, tempus lorem. Phasellus eu aliquam neque.
 *
 * @enum plot_options
 */
enum plot_options {
  PLOT_OPTIONS_PNG = 0x1, ///< First thing
  PLOT_OPTIONS_PDF = 0x2, ///< Second thing
};

/**
 * Description of structure
 *
 * @struct coordinate
 */
struct coordinate {
  int32_t x; ///< X Coordinate
  int32_t y; ///< Y Coordinate
  int32_t z; ///< Z Coordinate
};

/**
 * Description of a feature...
 *
 * @union feature
 */
union feature {
  struct coordinate coord; ///< Coordinate
  uint32_t vector;         ///< Vector
};

/**
 * This is a function
 *
 * @param x The first thing
 * @param y The second thing
 *
 * @return Something on success, -1 on error.
 */
int foo(int x, int y);


/**
 * This is a function pointer prototype
 *
 * @param x The first thing
 * @param y The second thing
 *
 * @return Something on success, -1 on error.
 */
typedef int (*binop_func)(int x, int y);

Yace File

../../../models/example.yaml

---
entities:
- ant: {}
  key: define
  sym: PLOT_SERIAL
  val:
    ant: {}
    key: str
    lit: WYRD1234
- ant: {}
  key: define
  sym: PLOT_FOO
  val:
    ant: {}
    key: hex
    lit: 44252
- ant: {}
  key: define
  sym: PLOT_VERSION_MAJOR
  val:
    ant: {}
    key: dec
    lit: 1
- ant: {}
  key: define
  sym: PLOT_VERSION_MINOR
  val:
    ant: {}
    key: dec
    lit: 2
- ant: {}
  key: define
  sym: PLOT_VERSION_PATCH
  val:
    ant: {}
    key: dec
    lit: 3
- ant: {}
  doc:
    brief: Description of enum
    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque accumsan massa est, ut ullamcorper
      lectus malesuada sit amet. Donec gravida nibh aliquam mattis rhoncus. Quisque sollicitudin ultricies orci, condimentum
      blandit lorem feugiat at. Aliquam tempus metus et nulla eleifend, eu dapibus risus pellentesque. Duis fermentum bibendum
      ligula in pharetra. Curabitur eget urna tempus, tempor dui sed, tempus lorem. Phasellus eu aliquam neque.
    tags:
      enum: {plot_options: ''}
  key: enum
  members:
  - ant: {}
    doc:
      brief: First thing
      description: ''
      tags: {}
    key: enum_value
    sym: PLOT_OPTIONS_PNG
    val:
      ant: {}
      key: dec
      lit: 1
  - ant: {}
    doc:
      brief: Second thing
      description: ''
      tags: {}
    key: enum_value
    sym: PLOT_OPTIONS_PDF
    val:
      ant: {}
      key: dec
      lit: 2
  sym: plot_options
- ant: {}
  doc:
    brief: Description of structure
    description: ''
    tags:
      struct: {coordinate: ''}
  key: struct_decl
  members:
  - ant: {}
    doc:
      brief: X Coordinate
      description: ''
      tags: {}
    key: field_decl
    sym: x
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int32_t
      character: false
      const: false
      enum: false
      integer: true
      key: i32_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 32
      width_fixed: true
  - ant: {}
    doc:
      brief: Y Coordinate
      description: ''
      tags: {}
    key: field_decl
    sym: y
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int32_t
      character: false
      const: false
      enum: false
      integer: true
      key: i32_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 32
      width_fixed: true
  - ant: {}
    doc:
      brief: Z Coordinate
      description: ''
      tags: {}
    key: field_decl
    sym: z
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int32_t
      character: false
      const: false
      enum: false
      integer: true
      key: i32_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 32
      width_fixed: true
  sym: coordinate
- ant: {}
  doc:
    brief: Description of a feature...
    description: ''
    tags:
      union: {feature: ''}
  key: union_decl
  members:
  - ant: {}
    doc:
      brief: Coordinate
      description: ''
      tags: {}
    key: field_decl
    sym: coord
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: struct coordinate
      character: false
      const: false
      enum: false
      integer: false
      key: record_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: true
      sym: coordinate
      union: false
      unsigned: false
      void: false
      width_fixed: false
  - ant: {}
    doc:
      brief: Vector
      description: ''
      tags: {}
    key: field_decl
    sym: vector
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: uint32_t
      character: false
      const: false
      enum: false
      integer: true
      key: u32_tspec
      pointer: false
      real: false
      signed: false
      size: false
      static: false
      struct: false
      union: false
      unsigned: true
      void: false
      width: 32
      width_fixed: true
  sym: feature
- ant: {}
  doc:
    brief: This is a function
    description: ''
    tags:
      param: {x: The first thing, y: The second thing}
      return: {Something: 'on success, -1 on error.'}
  key: function_decl
  parameters:
  - ant: {}
    key: parameter_decl
    sym: x
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int
      character: false
      const: false
      enum: false
      integer: true
      key: i_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 16
      width_fixed: false
  - ant: {}
    key: parameter_decl
    sym: y
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int
      character: false
      const: false
      enum: false
      integer: true
      key: i_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 16
      width_fixed: false
  ret:
    ant: {}
    array: false
    array_length: 0
    boolean: false
    canonical: int
    character: false
    const: false
    enum: false
    integer: true
    key: i_tspec
    pointer: false
    real: false
    signed: true
    size: false
    static: false
    struct: false
    union: false
    unsigned: false
    void: false
    width: 16
    width_fixed: false
  sym: foo
- ant: {}
  doc:
    brief: This is a function pointer prototype
    description: ''
    tags:
      param: {x: The first thing, y: The second thing}
      return: {Something: 'on success, -1 on error.'}
  key: function_pointer_decl
  parameters:
  - ant: {}
    key: parameter_decl
    sym: x
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int
      character: false
      const: false
      enum: false
      integer: true
      key: i_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 16
      width_fixed: false
  - ant: {}
    key: parameter_decl
    sym: y
    typ:
      ant: {}
      array: false
      array_length: 0
      boolean: false
      canonical: int
      character: false
      const: false
      enum: false
      integer: true
      key: i_tspec
      pointer: false
      real: false
      signed: true
      size: false
      static: false
      struct: false
      union: false
      unsigned: false
      void: false
      width: 16
      width_fixed: false
  ret:
    ant: {}
    array: false
    array_length: 0
    boolean: false
    canonical: int
    character: false
    const: false
    enum: false
    integer: true
    key: i_tspec
    pointer: false
    real: false
    signed: true
    size: false
    static: false
    struct: false
    union: false
    unsigned: false
    void: false
    width: 16
    width_fixed: false
  sym: binop_func
meta: {author: Foo Bar <foo@example.com>, brief: Brief Description, full: Full Description, lic: Unknown License, prefix: foo,
  project: foo, version: 0.0.1}

Implementation

The goal of this module is to provide the buildings blocks for a yace-file generator. That is, something to aid the creation of Yace-files.

In this specific instance, to parse C Headers, and emit equivalent Yace-files.

• CParser, parse a C header and emit a Yace-file

class yace.ir.cparser.CParser

Primitive wrapper around libclang Python bindings

parse_enum(cursor) → Tuple[Entity | None, Error | None]

Parse into key-objects enum and enum_value

parse_file(path: Path)

Parse the given file into a clang.cindex.TranslationUnit.

parse_function(cursor)

Parse function declaration

parse_inclusion_directive(cursor) → Tuple[Entity | None, Error | None]

parse_macro(cursor) → Tuple[Entity | None, Error | None]

TODO: hex + int

parse_record(cursor) → Tuple[Entity | None, Error | None]

parse_typedef(cursor) → Tuple[Entity | None, Error | None]

Parse function-pointer typedefs that are pointers to function prototypes

parse_union(cursor) → Tuple[Entity | None, Error | None]

Parse union declaration

tu_to_data(tu, path: Path) → Tuple[List[Any], List[Error]]

Transform the given translation-unit (tu) to data

yace.ir.cparser.c_to_yace(paths: List[Path], output: Path) → List[Error]

Optimistically / best-offort transformation of a C Header to YACE File

yace.ir.cparser.get_fixed_width(tokens)

Returns Typespec-instance for a fixed-width type when applicable

yace.ir.cparser.literal_from_text(text: str) → Dec | Hex | String | None

Given a string on the forms:

• 42

• 0xACDC

• “foobar is the baz!”

Will return the correct instance

yace.ir.cparser.typedef_is_fixed_width_integer(text)

Returns true when the given typedef-spelling is a fixed-width integer typedef

yace.ir.cparser.typekind_to_typespec(tobj: Type, cursor: Cursor) → Tuple[Typespec | None, Error]