Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

ctype.zig

File

lib/c/ctype.zig

Code

const builtin = @import("builtin");
const std = @import("std");
const symbol = @import("../c.zig").symbol;

comptime {
    if (builtin.target.isMuslLibC() or builtin.target.isWasiLibC()) {
        // Functions specific to musl and wasi-libc.
        symbol(&isalnum, "isalnum");
        symbol(&isalpha, "isalpha");
        symbol(&isblank, "isblank");
        symbol(&iscntrl, "iscntrl");
        symbol(&isdigit, "isdigit");
        symbol(&isgraph, "isgraph");
        symbol(&islower, "islower");
        symbol(&isprint, "isprint");
        symbol(&ispunct, "ispunct");
        symbol(&isspace, "isspace");
        symbol(&isupper, "isupper");
        symbol(&isxdigit, "isxdigit");
        symbol(&tolower, "tolower");
        symbol(&toupper, "toupper");

        symbol(&__isalnum_l, "__isalnum_l");
        symbol(&__isalpha_l, "__isalpha_l");
        symbol(&__isblank_l, "__isblank_l");
        symbol(&__iscntrl_l, "__iscntrl_l");
        symbol(&__isdigit_l, "__isdigit_l");
        symbol(&__isgraph_l, "__isgraph_l");
        symbol(&__islower_l, "__islower_l");
        symbol(&__isprint_l, "__isprint_l");
        symbol(&__ispunct_l, "__ispunct_l");
        symbol(&__isspace_l, "__isspace_l");
        symbol(&__isupper_l, "__isupper_l");
        symbol(&__isxdigit_l, "__isxdigit_l");
        symbol(&__tolower_l, "__tolower_l");
        symbol(&__toupper_l, "__toupper_l");

        symbol(&__isalnum_l, "isalnum_l");
        symbol(&__isalpha_l, "isalpha_l");
        symbol(&__isblank_l, "isblank_l");
        symbol(&__iscntrl_l, "iscntrl_l");
        symbol(&__isdigit_l, "isdigit_l");
        symbol(&__isgraph_l, "isgraph_l");
        symbol(&__islower_l, "islower_l");
        symbol(&__isprint_l, "isprint_l");
        symbol(&__ispunct_l, "ispunct_l");
        symbol(&__isspace_l, "isspace_l");
        symbol(&__isupper_l, "isupper_l");
        symbol(&__isxdigit_l, "isxdigit_l");
        symbol(&__tolower_l, "tolower_l");
        symbol(&__toupper_l, "toupper_l");

        symbol(&isascii, "isascii");
        symbol(&toascii, "toascii");
    }
}

// NOTE: If the input is not representable as an unsigned char or is not EOF (which is a negative integer value) the behaviour is undefined.

fn isalnum(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isAlphanumeric(@truncate(@as(c_uint, @bitCast(c))))); // @truncate instead of @intCast as we have to handle EOF
}

fn __isalnum_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isalnum(c);
}

fn isalpha(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isAlphabetic(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isalpha_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isalpha(c);
}

fn isblank(c: c_int) callconv(.c) c_int {
    return @intFromBool(c == ' ' or c == '\t');
}

fn __isblank_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isblank(c);
}

fn iscntrl(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isControl(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __iscntrl_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return iscntrl(c);
}

fn isdigit(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isDigit(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isdigit_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isdigit(c);
}

fn isgraph(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isGraphical(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isgraph_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isgraph(c);
}

fn islower(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isLower(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __islower_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return islower(c);
}

fn isprint(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isPrint(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isprint_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isprint(c);
}

fn ispunct(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isPunctuation(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __ispunct_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return ispunct(c);
}

fn isspace(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isWhitespace(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isspace_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isspace(c);
}

fn isupper(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isUpper(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isupper_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isupper(c);
}

fn isxdigit(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isHex(@truncate(@as(c_uint, @bitCast(c)))));
}

fn __isxdigit_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return isxdigit(c);
}

fn tolower(c: c_int) callconv(.c) c_int {
    return std.ascii.toLower(@truncate(@as(c_uint, @bitCast(c))));
}

fn __tolower_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return tolower(c);
}

fn toupper(c: c_int) callconv(.c) c_int {
    return std.ascii.toUpper(@truncate(@as(c_uint, @bitCast(c))));
}

fn __toupper_l(c: c_int, locale: *anyopaque) callconv(.c) c_int {
    _ = locale;
    return toupper(c);
}

fn isascii(c: c_int) callconv(.c) c_int {
    return @intFromBool(std.ascii.isAscii(@truncate(@as(c_uint, @bitCast(c)))));
}

fn toascii(c: c_int) callconv(.c) c_int {
    return c & 0x7F;
}