DoxigAlpha
std › process.ArgIteratorWindows › init

init

cmd_line_w must be a WTF16-LE-encoded string.

The iterator stores and uses cmd_line_w, so its memory must be valid for at least as long as the returned ArgIteratorWindows.

Function parameters

Parameters

#
cmd_line_w:[]const u16

Type definitions in this namespace

Types

#
ArgIteratorWindows
Iterator that implements the Windows command-line parsing algorithm.
ArgIteratorGeneralOptions
Optional parameters for `ArgIteratorGeneral`
ArgIterator
Cross-platform command line argument iterator.

Functions in this namespace

Functions

#
getCwd
The result is a slice of `out_buffer`, from index `0`.
getCwdAlloc
Caller must free the returned memory.
getEnvMap
Returns a snapshot of the environment variables of the current process.
getEnvVarOwned
Caller must free returned memory.
hasEnvVarConstant
On Windows, `key` must be valid WTF-8.
hasNonEmptyEnvVarConstant
On Windows, `key` must be valid WTF-8.
parseEnvVarInt
Parses an environment variable as an integer.
hasEnvVar
On Windows, if `key` is not valid [WTF-8](https://simonsapin.github.io/wtf-8/),
hasNonEmptyEnvVar
On Windows, if `key` is not valid [WTF-8](https://simonsapin.github.io/wtf-8/),
getenvW
Windows-only.
ArgIteratorGeneral
A general Iterator to parse a string into a set of arguments
args
Holds the command-line arguments, with the program name as the first entry.
argsWithAllocator
You must deinitialize iterator's internal buffers by calling `deinit` when done.
argsAlloc
Caller must call argsFree on result.
getUserInfo
POSIX function which gets a uid from username.
posixGetUserInfo
TODO this reads /etc/passwd.
execv
Replaces the current process image with the executed process.
execve
Replaces the current process image with the executed process.
totalSystemMemory
Returns the total system memory, in bytes as a u64.
cleanExit
Indicate that we are now terminating with a successful exit code.
raiseFileDescriptorLimit
Raise the open file descriptor limit.
createEnvironFromMap
Creates a null-delimited environment variable block in the format
createEnvironFromExisting
Creates a null-delimited environment variable block in the format
createWindowsEnvBlock
Caller must free result.
fatal
Logs an error and then terminates the process with exit code 1.

Error sets in this namespace

Error Sets

#

Tells whether calling the `execv` or `execve` functions will be a compile error.

Values

#
can_execv
Tells whether calling the `execv` or `execve` functions will be a compile error.
can_spawn
Tells whether spawning child processes is supported (e.g.

Source

Implementation

#
pub fn init(allocator: Allocator, cmd_line_w: []const u16) InitError!ArgIteratorWindows {
    const wtf8_len = unicode.calcWtf8Len(cmd_line_w);

    // This buffer must be large enough to contain contiguous NUL-terminated slices
    // of each argument.
    // - During parsing, the length of a parsed argument will always be equal to
    //   to less than its unparsed length
    // - The first argument needs one extra byte of space allocated for its NUL
    //   terminator, but for each subsequent argument the necessary whitespace
    //   between arguments guarantees room for their NUL terminator(s).
    const buffer = try allocator.alloc(u8, wtf8_len + 1);
    errdefer allocator.free(buffer);

    return .{
        .allocator = allocator,
        .cmd_line = cmd_line_w,
        .buffer = buffer,
    };
}