SyntaxCheck

Wiki Home
Syntax

• Syntax: Checks
  • Checks
  • Standard Headers Included for a Check
  • Allowed Attributes
  • Setting Required Headers for a Check
  • Generated Names
  • Changing the Name of a Check
  • Setting Required Flags for a Check
  • Setting Required Libraries for a Check
  • Alternates
  • success and failure

Syntax: Checks

Checks

• check_arg_count
• check_compiler_flag
  add_compiler_flag
• check_constant
• check_define
• check_function
• check_header
• check_link_flag
  add_link_flag
• check_package
• check_size
• check_shell_extract
• check_struct_member
• check_type

Standard Headers Included for a Check

The following headers are included for the checks. These headers cover many of the usual types and library calls.

#include <stdio.h>
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>

Allowed Attributes

Check statements may allow the following attribute statements. Check the specific wiki page for the check to see which attributes are allowed for the check.

• alternate
• compiler_flags
• failure
• header
• link_flags
• match
• name
• negate
• path
• success

Setting Required Headers for a Check

The headers for a check may set by appending a statement block, and using the header attribute.

check_size int64_t {
  header stdint.h;
}

Generated Names

mkc automatically generates names for each check. Each check has an associated prefix. The name of the check will replace characters that are not alphabetic or digits with an underscore.

Changing the Name of a Check

mkc automatically generates names for each check. To change the name of a check, append a statement block and use the name statement.

check_size int64_t {
  header stdint.h;
  name HAVE_INT64;
}

Setting Required Flags for a Check

check_size int64_t {
  compiler_flags '-DANSI';
}

Setting Required Libraries for a Check

check_size int64_t {
  link_flags '-lintl';
}

Alternates

The alternate is a powerful method to run checks with alternate settings.

Each alternate attribute block may contain the name, header, compiler_flags, and link_flags attributes.

For example, the following code checks for the statfs function. On Linux, this requires the sys/vfs.h header (or sys/statfs.h). On MacOS and *BSD, the sys/mount.h header should be used.

check_function statfs {
  alternate {
    # linux
    name _header_sys_vfs;
    header sys/vfs.h;
  }
  alternate {
    # macos, freebsd
    name _header_sys_mount;
    header sys/mount.h;
  }
}

On success, the generated _function_statfs name will be set.

If the first alternate succeeds, the _header_sys_vfs variable will be set. If the second alternate succeeds, the _header_sys_mount variable will be set.

success and failure

The success and failure attributes blocks will execute on success or failure of a check.

check_function statfs {
  alternate {
    name _header_sys_vfs;
    header sys/vfs.h;
  }
  alternate {
    name _header_sys_mount;
    header sys/mount.h;
  }
  success {
    print 'found statfs.';
  }
  failure {
    print 'could not locate statfs.';
  }
}

Wiki Home
Syntax