Common utilities and helpers for option parsing. More...

Macros
#define	USAGE_INDENT " "

#define	USAGE_HELP_LINE USAGE_INDENT "-h --help " USAGE_INDENT "print this help\n"

#define	USAGE_VERSION_LINE USAGE_INDENT "-v --version " USAGE_INDENT "print version information\n"

#define	USAGE_PORT_LINE USAGE_INDENT "-p --port PORT " USAGE_INDENT "TCP port to listen on (default: %d)\n"

#define	USAGE_PORT_CLIENT_LINE USAGE_INDENT "-p --port PORT " USAGE_INDENT "override port from address (default: 27224)\n"

#define	USAGE_RECONNECT_LINE

#define	USAGE_MAX_CLIENTS_LINE USAGE_INDENT " --max-clients N " USAGE_INDENT "maximum simultaneous clients (1-9, default: 9)\n"

#define	USAGE_NO_AUDIO_MIXER_LINE USAGE_INDENT " --no-audio-mixer " USAGE_INDENT "disable audio mixer - send silence (debug mode only)\n"

#define	USAGE_WIDTH_LINE USAGE_INDENT "-x --width WIDTH " USAGE_INDENT "render width (default: [auto-set])\n"

#define	USAGE_HEIGHT_LINE USAGE_INDENT "-y --height HEIGHT " USAGE_INDENT "render height (default: [auto-set])\n"

#define	USAGE_WEBCAM_INDEX_LINE USAGE_INDENT "-c --webcam-index CAMERA " USAGE_INDENT "webcam device index (0-based) (default: 0)\n"

#define	USAGE_LIST_WEBCAMS_LINE USAGE_INDENT " --list-webcams " USAGE_INDENT "list available webcam devices and exit\n"

#define	USAGE_WEBCAM_FLIP_LINE

#define	USAGE_TEST_PATTERN_CLIENT_LINE

#define	USAGE_TEST_PATTERN_MIRROR_LINE USAGE_INDENT " --test-pattern " USAGE_INDENT "use test pattern instead of webcam (for testing)\n"

#define	USAGE_FPS_WIN_LINE USAGE_INDENT " --fps FPS " USAGE_INDENT "desired frame rate 1-144 (default: 30 for Windows)\n"

#define	USAGE_FPS_UNIX_LINE USAGE_INDENT " --fps FPS " USAGE_INDENT "desired frame rate 1-144 (default: 60 for Unix)\n"

#define	USAGE_COLOR_MODE_LINE

#define	USAGE_SHOW_CAPABILITIES_LINE USAGE_INDENT " --show-capabilities " USAGE_INDENT "show detected terminal capabilities and exit\n"

#define	USAGE_UTF8_LINE USAGE_INDENT " --utf8 " USAGE_INDENT "force enable UTF-8/Unicode support (default: [unset])\n"

#define	USAGE_RENDER_MODE_LINE

#define	USAGE_PALETTE_LINE

#define	USAGE_PALETTE_CHARS_LINE

#define	USAGE_STRETCH_LINE

#define	USAGE_SNAPSHOT_LINE USAGE_INDENT "-S --snapshot " USAGE_INDENT "capture single frame and exit (default: [unset])\n"

#define	USAGE_SNAPSHOT_DELAY_LINE USAGE_INDENT "-D --snapshot-delay SECONDS " USAGE_INDENT "delay SECONDS before snapshot (default: %.1f)\n"

#define	USAGE_STRIP_ANSI_LINE

#define	USAGE_AUDIO_LINE USAGE_INDENT "-A --audio " USAGE_INDENT "enable audio capture and playback (default: [unset])\n"

#define	USAGE_AUDIO_ANALYSIS_LINE

#define	USAGE_NO_AUDIO_PLAYBACK_LINE

#define	USAGE_LIST_MICROPHONES_LINE USAGE_INDENT " --list-microphones " USAGE_INDENT "list available audio input devices and exit\n"

#define	USAGE_LIST_SPEAKERS_LINE USAGE_INDENT " --list-speakers " USAGE_INDENT "list available audio output devices and exit\n"

#define	USAGE_MICROPHONE_INDEX_LINE USAGE_INDENT " --microphone-index INDEX " USAGE_INDENT "microphone device index (-1 for default) (default: -1)\n"

#define	USAGE_SPEAKERS_INDEX_LINE USAGE_INDENT " --speakers-index INDEX " USAGE_INDENT "speakers device index (-1 for default) (default: -1)\n"

#define	USAGE_ENCRYPT_LINE USAGE_INDENT "-E --encrypt " USAGE_INDENT "enable packet encryption (default: [unset])\n"

#define	USAGE_KEY_SERVER_LINE

#define	USAGE_KEY_CLIENT_LINE

#define	USAGE_PASSWORD_LINE

#define	USAGE_KEYFILE_LINE

#define	USAGE_NO_ENCRYPT_LINE USAGE_INDENT " --no-encrypt " USAGE_INDENT "disable encryption (default: [unset])\n"

#define	USAGE_SERVER_KEY_LINE

#define	USAGE_CLIENT_KEYS_LINE

#define	USAGE_COMPRESSION_LEVEL_LINE USAGE_INDENT " --compression-level N " USAGE_INDENT "zstd compression level 1-9 (default: 1)\n"

#define	USAGE_NO_COMPRESS_LINE USAGE_INDENT " --no-compress " USAGE_INDENT "disable frame compression (default: [unset])\n"

#define	USAGE_ENCODE_AUDIO_LINE USAGE_INDENT " --encode-audio " USAGE_INDENT "enable Opus audio encoding (default: enabled)\n"

#define	USAGE_NO_ENCODE_AUDIO_LINE USAGE_INDENT " --no-encode-audio " USAGE_INDENT "disable Opus audio encoding\n"

#define	USAGE_DATABASE_LINE

#define	USAGE_LOG_FILE_LINE USAGE_INDENT "-L --log-file FILE " USAGE_INDENT "log file path (default: stderr)\n"

#define	USAGE_LOG_LEVEL_LINE

Functions
const char *	find_similar_option (const char unknown_opt, const struct option options)
	Find a similar option name for typo suggestions.

int	strtoint_safe (const char *str)
	Safely parse string to integer with validation.

char *	validate_required_argument (const char optarg, char argbuf, size_t argbuf_size, const char *option_name, asciichat_mode_t mode)
	Validate and retrieve required argument for an option.

bool	validate_positive_int_opt (const char value_str, int out_value, const char *param_name)
	Validate a positive integer value.

bool	validate_port_opt (const char value_str, uint16_t out_port)
	Validate port number (1-65535)

bool	validate_fps_opt (const char value_str, int out_fps)
	Validate FPS value (1-144)

bool	validate_webcam_index (const char value_str, unsigned short int out_index)
	Validate webcam index using the common device index validator.

asciichat_error_t	detect_default_ssh_key (char *key_path, size_t path_size)
	Detect default SSH key path for the current user.

char *	strip_equals_prefix (const char opt_value, char buffer, size_t buffer_size)
	Strip equals sign prefix from option argument.

char *	get_required_argument (const char opt_value, char buffer, size_t buffer_size, const char *option_name, asciichat_mode_t mode)
	Handle required arguments with consistent error messages.

char *	read_password_from_stdin (const char *prompt)
	Read password from stdin with prompt.

asciichat_error_t	parse_color_mode_option (const char value_str, options_t opts)
	Parse –color-mode option and set opts->color_mode.

asciichat_error_t	parse_render_mode_option (const char value_str, options_t opts)
	Parse –render-mode option and set opts->render_mode.

asciichat_error_t	parse_palette_option (const char value_str, options_t opts)
	Parse –palette option and set opt_palette_type.

asciichat_error_t	parse_palette_chars_option (const char value_str, options_t opts)
	Parse –palette-chars option and set opt_palette_custom.

asciichat_error_t	parse_width_option (const char value_str, options_t opts)
	Parse –width option and set opts->width.

asciichat_error_t	parse_height_option (const char value_str, options_t opts)
	Parse –height option and set opts->height.

asciichat_error_t	parse_webcam_index_option (const char value_str, options_t opts)
	Parse –webcam-index option and set opts->webcam_index.

asciichat_error_t	parse_snapshot_delay_option (const char value_str, options_t opts)
	Parse –snapshot-delay option and set opts->snapshot_delay.

asciichat_error_t	parse_log_level_option (const char value_str, options_t opts)
	Parse –log-level option and set opt_log_level.

void	update_dimensions_for_full_height (options_t *opts)
	Update dimensions for full-height mode.

void	update_dimensions_to_terminal_size (options_t *opts)
	Update dimensions to current terminal size.

Detailed Description

Common utilities and helpers for option parsing.

Shared helper functions, validators, and utilities used by client.c, server.c, and mirror.c option parsing modules. This module provides:

String parsing and validation utilities
Option argument validation (ports, FPS, webcam indices)
SSH key detection
Terminal dimension management
Error handling helpers

Design Philosophy:

Single Responsibility: Each function does one validation task
Consistent Error Reporting: All validators use fprintf to stderr
No Side Effects: Validators don't modify global state
Reusability: Used by all mode-specific parsers

See also: options.h; client.h; server.h; mirror.h

Definition in file options/common.h.

Macro Definition Documentation

◆ USAGE_AUDIO_ANALYSIS_LINE

#define USAGE_AUDIO_ANALYSIS_LINE

Value:

USAGE_INDENT " --audio-analysis " USAGE_INDENT \

"track and report audio quality metrics (with --audio) (default: [unset])\n"

USAGE_INDENT

#define USAGE_INDENT

Definition options/common.h:498

Definition at line 576 of file options/common.h.

578 : [unset])\n"

◆ USAGE_AUDIO_LINE

#define USAGE_AUDIO_LINE USAGE_INDENT "-A --audio " USAGE_INDENT "enable audio capture and playback (default: [unset])\n"

Definition at line 574 of file options/common.h.

575 : [unset])\n"

◆ USAGE_CLIENT_KEYS_LINE

#define USAGE_CLIENT_KEYS_LINE

Value:

  USAGE_INDENT "   --client-keys KEYS" USAGE_INDENT                                                                    \
               "allowed client public keys (comma-separated, supports github:user, gitlab:user, gpg:keyid, or SSH "    \
               "pubkey) (default: [unset])\n"

Definition at line 613 of file options/common.h.

615 :user, gitlab:user, gpg:keyid, or SSH " \

616 "pubkey) (default: [unset])\n"

◆ USAGE_COLOR_MODE_LINE

#define USAGE_COLOR_MODE_LINE

Value:

USAGE_INDENT " --color-mode MODE " USAGE_INDENT \

"color modes: auto, none, 16, 256, truecolor (default: auto)\n"

Definition at line 544 of file options/common.h.

546 : auto, none, 16, 256, truecolor (default: auto)\n"

◆ USAGE_COMPRESSION_LEVEL_LINE

#define USAGE_COMPRESSION_LEVEL_LINE USAGE_INDENT " --compression-level N " USAGE_INDENT "zstd compression level 1-9 (default: 1)\n"

Definition at line 619 of file options/common.h.

620 : 1)\n"

◆ USAGE_DATABASE_LINE

#define USAGE_DATABASE_LINE

Value:

USAGE_INDENT "-d --db PATH " USAGE_INDENT \

"SQLite database path (default: ~/.config/ascii-chat/acds.db)\n"

Definition at line 633 of file options/common.h.

635 : ~/.config/ascii-chat/acds.db)\n"

◆ USAGE_ENCODE_AUDIO_LINE

#define USAGE_ENCODE_AUDIO_LINE USAGE_INDENT " --encode-audio " USAGE_INDENT "enable Opus audio encoding (default: enabled)\n"

Definition at line 623 of file options/common.h.

624 : enabled)\n"

◆ USAGE_ENCRYPT_LINE

#define USAGE_ENCRYPT_LINE USAGE_INDENT "-E --encrypt " USAGE_INDENT "enable packet encryption (default: [unset])\n"

Definition at line 592 of file options/common.h.

593 : [unset])\n"

◆ USAGE_FPS_UNIX_LINE

#define USAGE_FPS_UNIX_LINE USAGE_INDENT " --fps FPS " USAGE_INDENT "desired frame rate 1-144 (default: 60 for Unix)\n"

Definition at line 542 of file options/common.h.

543 : 60 for Unix)\n"

◆ USAGE_FPS_WIN_LINE

#define USAGE_FPS_WIN_LINE USAGE_INDENT " --fps FPS " USAGE_INDENT "desired frame rate 1-144 (default: 30 for Windows)\n"

Definition at line 540 of file options/common.h.

541 : 30 for Windows)\n"

◆ USAGE_HEIGHT_LINE

#define USAGE_HEIGHT_LINE USAGE_INDENT "-y --height HEIGHT " USAGE_INDENT "render height (default: [auto-set])\n"

Definition at line 522 of file options/common.h.

523 : [auto-set])\n"

◆ USAGE_HELP_LINE

#define USAGE_HELP_LINE USAGE_INDENT "-h --help " USAGE_INDENT "print this help\n"

Definition at line 501 of file options/common.h.

◆ USAGE_INDENT

#define USAGE_INDENT " "

Definition at line 498 of file options/common.h.

◆ USAGE_KEY_CLIENT_LINE

#define USAGE_KEY_CLIENT_LINE

Value:

  USAGE_INDENT "-K --key KEY                  " USAGE_INDENT                                                           \
               "SSH/GPG key file for authentication: /path/to/key, gpg:keyid, github:user, gitlab:user, or 'ssh' for " \
               "auto-detect (implies --encrypt) (default: [unset])\n"

Definition at line 598 of file options/common.h.

600 : /path/to/key, gpg:keyid, github:user, gitlab:user, or 'ssh' for " \

601 "auto-detect (implies --encrypt) (default: [unset])\n"

◆ USAGE_KEY_SERVER_LINE

#define USAGE_KEY_SERVER_LINE

Value:

  USAGE_INDENT "-K --key KEY         " USAGE_INDENT                                                                    \
               "SSH/GPG key file for authentication: /path/to/key, gpg:keyid, github:user, gitlab:user, or 'ssh' "     \
               "(implies --encrypt) (default: [unset])\n"

Definition at line 594 of file options/common.h.

596 : /path/to/key, gpg:keyid, github:user, gitlab:user, or 'ssh' " \

597 "(implies --encrypt) (default: [unset])\n"

◆ USAGE_KEYFILE_LINE

#define USAGE_KEYFILE_LINE

Value:

USAGE_INDENT "-F --keyfile FILE " USAGE_INDENT \

"read encryption key from FILE (implies --encrypt) (default: [unset])\n"

Definition at line 605 of file options/common.h.

607 : [unset])\n"

◆ USAGE_LIST_MICROPHONES_LINE

#define USAGE_LIST_MICROPHONES_LINE USAGE_INDENT " --list-microphones " USAGE_INDENT "list available audio input devices and exit\n"

Definition at line 582 of file options/common.h.

◆ USAGE_LIST_SPEAKERS_LINE

#define USAGE_LIST_SPEAKERS_LINE USAGE_INDENT " --list-speakers " USAGE_INDENT "list available audio output devices and exit\n"

Definition at line 584 of file options/common.h.

◆ USAGE_LIST_WEBCAMS_LINE

#define USAGE_LIST_WEBCAMS_LINE USAGE_INDENT " --list-webcams " USAGE_INDENT "list available webcam devices and exit\n"

Definition at line 528 of file options/common.h.

◆ USAGE_LOG_FILE_LINE

#define USAGE_LOG_FILE_LINE USAGE_INDENT "-L --log-file FILE " USAGE_INDENT "log file path (default: stderr)\n"

Definition at line 637 of file options/common.h.

◆ USAGE_LOG_LEVEL_LINE

#define USAGE_LOG_LEVEL_LINE

Value:

USAGE_INDENT "-l --log-level LEVEL " USAGE_INDENT \

"log level: dev, debug, info, warn, error, fatal (default: info)\n"

Definition at line 638 of file options/common.h.

640 : dev, debug, info, warn, error, fatal (default: info)\n"

◆ USAGE_MAX_CLIENTS_LINE

#define USAGE_MAX_CLIENTS_LINE USAGE_INDENT " --max-clients N " USAGE_INDENT "maximum simultaneous clients (1-9, default: 9)\n"

Definition at line 514 of file options/common.h.

515 : 9)\n"

◆ USAGE_MICROPHONE_INDEX_LINE

#define USAGE_MICROPHONE_INDEX_LINE USAGE_INDENT " --microphone-index INDEX " USAGE_INDENT "microphone device index (-1 for default) (default: -1)\n"

Definition at line 586 of file options/common.h.

587 : -1)\n"

◆ USAGE_NO_AUDIO_MIXER_LINE

#define USAGE_NO_AUDIO_MIXER_LINE USAGE_INDENT " --no-audio-mixer " USAGE_INDENT "disable audio mixer - send silence (debug mode only)\n"

Definition at line 516 of file options/common.h.

◆ USAGE_NO_AUDIO_PLAYBACK_LINE

#define USAGE_NO_AUDIO_PLAYBACK_LINE

Value:

USAGE_INDENT " --no-audio-playback " USAGE_INDENT \

"disable speaker playback but keep recording received audio (debug mode) (default: [unset])\n"

Definition at line 579 of file options/common.h.

581 : [unset])\n"

◆ USAGE_NO_COMPRESS_LINE

#define USAGE_NO_COMPRESS_LINE USAGE_INDENT " --no-compress " USAGE_INDENT "disable frame compression (default: [unset])\n"

Definition at line 621 of file options/common.h.

622 : [unset])\n"

◆ USAGE_NO_ENCODE_AUDIO_LINE

#define USAGE_NO_ENCODE_AUDIO_LINE USAGE_INDENT " --no-encode-audio " USAGE_INDENT "disable Opus audio encoding\n"

Definition at line 625 of file options/common.h.

◆ USAGE_NO_ENCRYPT_LINE

#define USAGE_NO_ENCRYPT_LINE USAGE_INDENT " --no-encrypt " USAGE_INDENT "disable encryption (default: [unset])\n"

Definition at line 608 of file options/common.h.

609 : [unset])\n"

◆ USAGE_PALETTE_CHARS_LINE

#define USAGE_PALETTE_CHARS_LINE

Value:

USAGE_INDENT "-C --palette-chars CHARS " USAGE_INDENT \

"Custom palette characters (implies --palette=custom) (default: [unset])\n"

Definition at line 557 of file options/common.h.

559 : [unset])\n"

◆ USAGE_PALETTE_LINE

#define USAGE_PALETTE_LINE

Value:

USAGE_INDENT "-P --palette PALETTE " USAGE_INDENT \

"ASCII character palette: standard, blocks, digital, minimal, cool, custom (default: standard)\n"

Definition at line 554 of file options/common.h.

556 : standard, blocks, digital, minimal, cool, custom (default: standard)\n"

◆ USAGE_PASSWORD_LINE

#define USAGE_PASSWORD_LINE

Value:

USAGE_INDENT " --password [PASS] " USAGE_INDENT \

"password for connection encryption (prompts if not provided) (implies --encrypt) (default: [unset])\n"

Definition at line 602 of file options/common.h.

604 : [unset])\n"

◆ USAGE_PORT_CLIENT_LINE

#define USAGE_PORT_CLIENT_LINE USAGE_INDENT "-p --port PORT " USAGE_INDENT "override port from address (default: 27224)\n"

Definition at line 507 of file options/common.h.

508 : 27224)\n"

◆ USAGE_PORT_LINE

#define USAGE_PORT_LINE USAGE_INDENT "-p --port PORT " USAGE_INDENT "TCP port to listen on (default: %d)\n"

Definition at line 505 of file options/common.h.

506 : %d)\n"

◆ USAGE_RECONNECT_LINE

#define USAGE_RECONNECT_LINE

Value:

USAGE_INDENT " --reconnect VALUE " USAGE_INDENT \

"reconnection behavior: off, auto, or 1-999 (default: auto)\n"

Definition at line 509 of file options/common.h.

511 : off, auto, or 1-999 (default: auto)\n"

◆ USAGE_RENDER_MODE_LINE

#define USAGE_RENDER_MODE_LINE

Value:

USAGE_INDENT "-M --render-mode MODE " USAGE_INDENT \

"Rendering modes: foreground, background, half-block (default: foreground)\n"

Definition at line 551 of file options/common.h.

553 : foreground, background, half-block (default: foreground)\n"

◆ USAGE_SERVER_KEY_LINE

#define USAGE_SERVER_KEY_LINE

Value:

USAGE_INDENT " --server-key KEY " USAGE_INDENT \

"expected server public key for verification (default: [unset])\n"

Definition at line 610 of file options/common.h.

612 : [unset])\n"

◆ USAGE_SHOW_CAPABILITIES_LINE

#define USAGE_SHOW_CAPABILITIES_LINE USAGE_INDENT " --show-capabilities " USAGE_INDENT "show detected terminal capabilities and exit\n"

Definition at line 547 of file options/common.h.

◆ USAGE_SNAPSHOT_DELAY_LINE

#define USAGE_SNAPSHOT_DELAY_LINE USAGE_INDENT "-D --snapshot-delay SECONDS " USAGE_INDENT "delay SECONDS before snapshot (default: %.1f)\n"

Definition at line 567 of file options/common.h.

568 : %.1f)\n"

◆ USAGE_SNAPSHOT_LINE

#define USAGE_SNAPSHOT_LINE USAGE_INDENT "-S --snapshot " USAGE_INDENT "capture single frame and exit (default: [unset])\n"

Definition at line 565 of file options/common.h.

566 : [unset])\n"

◆ USAGE_SPEAKERS_INDEX_LINE

#define USAGE_SPEAKERS_INDEX_LINE USAGE_INDENT " --speakers-index INDEX " USAGE_INDENT "speakers device index (-1 for default) (default: -1)\n"

Definition at line 588 of file options/common.h.

589 : -1)\n"

◆ USAGE_STRETCH_LINE

#define USAGE_STRETCH_LINE

Value:

USAGE_INDENT "-s --stretch " USAGE_INDENT \

"stretch or shrink video to fit (ignore aspect ratio) (default: [unset])\n"

Definition at line 560 of file options/common.h.

562 : [unset])\n"

◆ USAGE_STRIP_ANSI_LINE

#define USAGE_STRIP_ANSI_LINE

Value:

USAGE_INDENT " --strip-ansi " USAGE_INDENT \

"remove all ANSI escape codes from output (default: [unset])\n"

Definition at line 569 of file options/common.h.

571 : [unset])\n"

◆ USAGE_TEST_PATTERN_CLIENT_LINE

#define USAGE_TEST_PATTERN_CLIENT_LINE

Value:

USAGE_INDENT " --test-pattern " USAGE_INDENT \

"use test pattern instead of webcam (for testing multiple clients)\n"

Definition at line 533 of file options/common.h.

◆ USAGE_TEST_PATTERN_MIRROR_LINE

#define USAGE_TEST_PATTERN_MIRROR_LINE USAGE_INDENT " --test-pattern " USAGE_INDENT "use test pattern instead of webcam (for testing)\n"

Definition at line 536 of file options/common.h.

◆ USAGE_UTF8_LINE

#define USAGE_UTF8_LINE USAGE_INDENT " --utf8 " USAGE_INDENT "force enable UTF-8/Unicode support (default: [unset])\n"

Definition at line 549 of file options/common.h.

550 : [unset])\n"

◆ USAGE_VERSION_LINE

#define USAGE_VERSION_LINE USAGE_INDENT "-v --version " USAGE_INDENT "print version information\n"

Definition at line 502 of file options/common.h.

◆ USAGE_WEBCAM_FLIP_LINE

#define USAGE_WEBCAM_FLIP_LINE

Value:

USAGE_INDENT "-f --webcam-flip " USAGE_INDENT \

"toggle horizontal flip of webcam image (default: flipped)\n"

Definition at line 530 of file options/common.h.

532 : flipped)\n"

◆ USAGE_WEBCAM_INDEX_LINE

#define USAGE_WEBCAM_INDEX_LINE USAGE_INDENT "-c --webcam-index CAMERA " USAGE_INDENT "webcam device index (0-based) (default: 0)\n"

Definition at line 526 of file options/common.h.

527 : 0)\n"

◆ USAGE_WIDTH_LINE

#define USAGE_WIDTH_LINE USAGE_INDENT "-x --width WIDTH " USAGE_INDENT "render width (default: [auto-set])\n"

Definition at line 520 of file options/common.h.

521 : [auto-set])\n"

Function Documentation

◆ detect_default_ssh_key()

asciichat_error_t detect_default_ssh_key	(	char *	key_path,
		size_t	path_size
	)

Detect default SSH key path for the current user.

Checks if ~/.ssh/id_ed25519 exists and is a regular file. Only supports Ed25519 keys (modern, secure, fast).

Parameters

key_path	Buffer to store detected key path
path_size	Size of key_path buffer

Returns: ASCIICHAT_OK if found, ERROR_CRYPTO_KEY with helpful message otherwise

Note: Uses expand_path() to resolve tilde (~) in path; Prints message to stderr suggesting key generation if not found

Example:

char key_path[OPTIONS_BUFF_SIZE];
if (detect_default_ssh_key(key_path, sizeof(key_path)) == ASCIICHAT_OK) {
    log_debug("Using default SSH key: %s", key_path);
    SAFE_SNPRINTF(opt_encrypt_key, OPTIONS_BUFF_SIZE, "%s", key_path);
}

Definition at line 165 of file options/common.c.

                                                                           {
  // Use expand_path utility to resolve ~/.ssh/id_ed25519
  char *full_path = expand_path("~/.ssh/id_ed25519");
  if (!full_path) {
    return SET_ERRNO(ERROR_CONFIG, "Could not expand SSH key path");
  }
 
  // Check if the Ed25519 private key file exists
  struct stat st;
  bool found = (stat(full_path, &st) == 0 && S_ISREG(st.st_mode));
 
  if (found) {
    SAFE_SNPRINTF(key_path, path_size, "%s", full_path);
    log_debug("Found default SSH key: %s", full_path);
    SAFE_FREE(full_path);
    return ASCIICHAT_OK;
  }
 
  (void)fprintf(stderr, "No Ed25519 SSH key found at %s\n", full_path);
  SAFE_FREE(full_path);
  return SET_ERRNO(
      ERROR_CRYPTO_KEY,
      "Only Ed25519 keys are supported (modern, secure, fast). Generate a new key with: ssh-keygen -t ed25519");
}

References ASCIICHAT_OK, ERROR_CONFIG, ERROR_CRYPTO_KEY, expand_path(), log_debug, SAFE_FREE, SAFE_SNPRINTF, and SET_ERRNO.

◆ find_similar_option()

const char * find_similar_option	(	const char *	unknown_opt,
		const struct option *	options
	)

Find a similar option name for typo suggestions.

Uses Levenshtein distance to find the most similar option name from the provided options array. Only suggests options within a reasonable edit distance.

Parameters

unknown_opt	The unknown/misspelled option name
options	Array of valid option structures (must be NULL-terminated)

Returns: Suggested option name, or NULL if no good match found

Note: Uses LEVENSHTEIN_SUGGESTION_THRESHOLD to filter poor matches

Example:

const char *suggestion = find_similar_option("--colr", client_options);
if (suggestion) {
    fprintf(stderr, "Did you mean '--%s'?\n", suggestion);
}

Definition at line 42 of file options/common.c.

                                                                                       {
  if (!unknown_opt || !options) {
    return NULL;
  }
 
  const char *best_match = NULL;
  size_t best_distance = SIZE_MAX;
 
  for (int i = 0; options[i].name != NULL; i++) {
    size_t dist = levenshtein(unknown_opt, options[i].name);
    if (dist < best_distance) {
      best_distance = dist;
      best_match = options[i].name;
    }
  }
 
  // Only suggest if the distance is within our threshold
  if (best_distance <= LEVENSHTEIN_SUGGESTION_THRESHOLD) {
    return best_match;
  }
 
  return NULL;
}

References levenshtein(), and LEVENSHTEIN_SUGGESTION_THRESHOLD.

◆ get_required_argument()

char * get_required_argument	(	const char *	opt_value,
		char *	buffer,
		size_t	buffer_size,
		const char *	option_name,
		asciichat_mode_t	mode
	)

Handle required arguments with consistent error messages.

Validates that an option has a non-empty argument and processes it. Returns NULL on error with appropriate error message printed.

Handles edge cases:

NULL or empty opt_value
getopt_long bug where option name is returned as argument
Arguments with '=' prefix (GNU-style –option=value)

Parameters

opt_value	Argument value from getopt_long
buffer	Buffer for storing processed argument
buffer_size	Size of buffer
option_name	Name of the option (for error messages)
mode	Current mode (client/server/mirror) for error messages

Returns: Pointer to processed argument string in buffer, or NULL on error

Note: Prints "option '--<name>' requires an argument" to stderr on error; Used internally by validate_required_argument()

Example:

char argbuf[OPTIONS_BUFF_SIZE];
char *value = get_required_argument(optarg, argbuf, sizeof(argbuf), "key", MODE_CLIENT);
if (!value) {
    return option_error_invalid();
}
SAFE_SNPRINTF(opt_encrypt_key, OPTIONS_BUFF_SIZE, "%s", value);

Definition at line 215 of file options/common.c.

                                                   {
  // Check if opt_value is NULL or empty
  if (!opt_value || strlen(opt_value) == 0) {
    goto error;
  }
 
  // Check if getopt_long returned the option name itself as the argument
  // This happens when a long option requiring an argument is at the end of argv
  if (opt_value && option_name && strcmp(opt_value, option_name) == 0) {
    goto error;
  }
 
  // Process the argument normally
  char *value_str = strip_equals_prefix(opt_value, buffer, buffer_size);
  if (!value_str) {
    goto error;
  }
 
  return value_str;
 
error:
  (void)fprintf(stderr, "%s: option '--%s' requires an argument\n",
                mode == MODE_SERVER ? "server" : (mode == MODE_MIRROR ? "mirror" : "client"), option_name);
  (void)fflush(stderr);
  return NULL; // Signal error to caller
}

References MODE_MIRROR, MODE_SERVER, and strip_equals_prefix().

Referenced by validate_required_argument().

◆ parse_color_mode_option()

asciichat_error_t parse_color_mode_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –color-mode option and set opts->color_mode.

Validates color mode string and sets opts->color_mode field. Accepts: "auto", "none", "mono", "16", "16color", "256", "256color", "truecolor", "24bit"

Parameters

value_str	Color mode string from command line
opts	Options struct to update

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM on invalid mode

Note: Prints error message to stderr on failure; Sets opts->color_mode on success

Definition at line 361 of file options/common.c.

                                                                                  {
  if (!value_str || !opts) {
    return ERROR_INVALID_PARAM;
  }
 
  if (strcmp(value_str, "auto") == 0) {
    opts->color_mode = COLOR_MODE_AUTO;
  } else if (strcmp(value_str, "none") == 0 || strcmp(value_str, "mono") == 0) {
    opts->color_mode = COLOR_MODE_NONE;
  } else if (strcmp(value_str, "16") == 0 || strcmp(value_str, "16color") == 0) {
    opts->color_mode = COLOR_MODE_16_COLOR;
  } else if (strcmp(value_str, "256") == 0 || strcmp(value_str, "256color") == 0) {
    opts->color_mode = COLOR_MODE_256_COLOR;
  } else if (strcmp(value_str, "truecolor") == 0 || strcmp(value_str, "24bit") == 0) {
    opts->color_mode = COLOR_MODE_TRUECOLOR;
  } else {
    (void)fprintf(stderr, "Error: Invalid color mode '%s'. Valid modes: auto, none, 16, 256, truecolor\n", value_str);
    return ERROR_INVALID_PARAM;
  }
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, options_state::color_mode, COLOR_MODE_16_COLOR, COLOR_MODE_256_COLOR, COLOR_MODE_AUTO, COLOR_MODE_NONE, COLOR_MODE_TRUECOLOR, and ERROR_INVALID_PARAM.

◆ parse_height_option()

asciichat_error_t parse_height_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –height option and set opts->height.

Validates height value and sets opts->height and opts->auto_height fields.

Parameters

value_str	Height value from command line
opts	Options struct to update

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM if invalid

Note: Prints error message to stderr on failure; Sets opts->height and opts->auto_height = false on success

Definition at line 465 of file options/common.c.

                                                                              {
  if (!opts) {
    return ERROR_INVALID_PARAM;
  }
 
  int height_val;
  if (!validate_positive_int_opt(value_str, &height_val, "height")) {
    return ERROR_INVALID_PARAM;
  }
 
  opts->height = (unsigned short int)height_val;
  opts->auto_height = false;
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, options_state::auto_height, ERROR_INVALID_PARAM, options_state::height, and validate_positive_int_opt().

◆ parse_log_level_option()

asciichat_error_t parse_log_level_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –log-level option and set opt_log_level.

Validates log level string and sets global opt_log_level variable. Accepts: "dev", "debug", "info", "warn", "error", "fatal" (case-insensitive)

Parameters

value_str Log level string from command line

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM if invalid

Note: Prints error message to stderr on failure; Sets opt_log_level global variable on success; Uses validate_opt_log_level() from validation.h

Definition at line 513 of file options/common.c.

                                                                                 {
  if (!opts) {
    return ERROR_INVALID_PARAM;
  }
 
  char error_msg[256];
  int log_level = validate_opt_log_level(value_str, error_msg, sizeof(error_msg));
 
  if (log_level == -1) {
    (void)fprintf(stderr, "Error: %s\n", error_msg);
    return ERROR_INVALID_PARAM;
  }
 
  opts->log_level = (log_level_t)log_level;
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, options_state::log_level, and validate_opt_log_level().

◆ parse_palette_chars_option()

asciichat_error_t parse_palette_chars_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –palette-chars option and set opt_palette_custom.

Validates custom palette characters and sets global opt_palette_custom, opt_palette_custom_set, and opt_palette_type variables.

Parameters

value_str Custom palette characters from command line

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM if too long

Note: Prints error message to stderr on failure; Sets opt_palette_custom, opt_palette_custom_set, and opt_palette_type on success; Maximum length is 255 characters (sizeof(opt_palette_custom) - 1)

Definition at line 430 of file options/common.c.

                                                                                     {
  if (!value_str || !opts) {
    return ERROR_INVALID_PARAM;
  }
 
  if (strlen(value_str) >= sizeof(opts->palette_custom)) {
    (void)fprintf(stderr, "Invalid palette-chars: too long (%zu chars, max %zu)\n", strlen(value_str),
                  sizeof(opts->palette_custom) - 1);
    return ERROR_INVALID_PARAM;
  }
 
  SAFE_STRNCPY(opts->palette_custom, value_str, sizeof(opts->palette_custom));
  opts->palette_custom[sizeof(opts->palette_custom) - 1] = '\0';
  opts->palette_custom_set = true;
  opts->palette_type = PALETTE_CUSTOM;
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, options_state::palette_custom, PALETTE_CUSTOM, options_state::palette_custom_set, options_state::palette_type, and SAFE_STRNCPY.

◆ parse_palette_option()

asciichat_error_t parse_palette_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –palette option and set opt_palette_type.

Validates palette type string and sets global opt_palette_type variable. Accepts: "standard", "blocks", "digital", "minimal", "cool", "custom"

Parameters

value_str Palette type string from command line

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM on invalid palette

Note: Prints error message to stderr on failure; Sets opt_palette_type global variable on success

Definition at line 404 of file options/common.c.

                                                                               {
  if (!value_str || !opts) {
    return ERROR_INVALID_PARAM;
  }
 
  if (strcmp(value_str, "standard") == 0) {
    opts->palette_type = PALETTE_STANDARD;
  } else if (strcmp(value_str, "blocks") == 0) {
    opts->palette_type = PALETTE_BLOCKS;
  } else if (strcmp(value_str, "digital") == 0) {
    opts->palette_type = PALETTE_DIGITAL;
  } else if (strcmp(value_str, "minimal") == 0) {
    opts->palette_type = PALETTE_MINIMAL;
  } else if (strcmp(value_str, "cool") == 0) {
    opts->palette_type = PALETTE_COOL;
  } else if (strcmp(value_str, "custom") == 0) {
    opts->palette_type = PALETTE_CUSTOM;
  } else {
    (void)fprintf(stderr, "Invalid palette '%s'. Valid palettes: standard, blocks, digital, minimal, cool, custom\n",
                  value_str);
    return ERROR_INVALID_PARAM;
  }
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, PALETTE_BLOCKS, PALETTE_COOL, PALETTE_CUSTOM, PALETTE_DIGITAL, PALETTE_MINIMAL, PALETTE_STANDARD, and options_state::palette_type.

◆ parse_render_mode_option()

asciichat_error_t parse_render_mode_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –render-mode option and set opts->render_mode.

Validates render mode string and sets opts->render_mode field. Accepts: "foreground", "fg", "background", "bg", "half-block", "halfblock"

Parameters

value_str	Render mode string from command line
opts	Options struct to update

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM on invalid mode

Note: Prints error message to stderr on failure; Sets opts->render_mode on success

Definition at line 384 of file options/common.c.

                                                                                   {
  if (!value_str || !opts) {
    return ERROR_INVALID_PARAM;
  }
 
  if (strcmp(value_str, "foreground") == 0 || strcmp(value_str, "fg") == 0) {
    opts->render_mode = RENDER_MODE_FOREGROUND;
  } else if (strcmp(value_str, "background") == 0 || strcmp(value_str, "bg") == 0) {
    opts->render_mode = RENDER_MODE_BACKGROUND;
  } else if (strcmp(value_str, "half-block") == 0 || strcmp(value_str, "halfblock") == 0) {
    opts->render_mode = RENDER_MODE_HALF_BLOCK;
  } else {
    (void)fprintf(stderr, "Error: Invalid render mode '%s'. Valid modes: foreground, background, half-block\n",
                  value_str);
    return ERROR_INVALID_PARAM;
  }
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, options_state::render_mode, RENDER_MODE_BACKGROUND, RENDER_MODE_FOREGROUND, and RENDER_MODE_HALF_BLOCK.

◆ parse_snapshot_delay_option()

asciichat_error_t parse_snapshot_delay_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –snapshot-delay option and set opts->snapshot_delay.

Validates snapshot delay (non-negative float) and sets opts->snapshot_delay field.

Parameters

value_str	Snapshot delay in seconds from command line
opts	Options struct to update

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM if invalid

Note: Prints error message to stderr on failure; Sets opts->snapshot_delay on success

Definition at line 496 of file options/common.c.

                                                                                      {
  if (!value_str || !opts) {
    return ERROR_INVALID_PARAM;
  }
 
  char *endptr;
  float delay = strtof(value_str, &endptr);
  if (endptr == value_str || *endptr != '\0' || delay < 0.0f) {
    (void)fprintf(stderr, "Invalid snapshot delay '%s'. Must be a non-negative number.\n", value_str);
    return ERROR_INVALID_PARAM;
  }
 
  opts->snapshot_delay = delay;
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, and options_state::snapshot_delay.

◆ parse_webcam_index_option()

asciichat_error_t parse_webcam_index_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –webcam-index option and set opts->webcam_index.

Validates webcam index and sets opts->webcam_index field.

Parameters

value_str	Webcam index from command line
opts	Options struct to update

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM if invalid

Note: Prints error message to stderr on failure; Sets opts->webcam_index on success

Definition at line 481 of file options/common.c.

                                                                                    {
  if (!opts) {
    return ERROR_INVALID_PARAM;
  }
 
  unsigned short int index_val;
  if (!validate_webcam_index(value_str, &index_val)) {
    return ERROR_INVALID_PARAM;
  }
 
  opts->webcam_index = index_val;
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, validate_webcam_index(), and options_state::webcam_index.

◆ parse_width_option()

asciichat_error_t parse_width_option	(	const char *	value_str,
		options_t *	opts
	)

Parse –width option and set opts->width.

Validates width value and sets opts->width and opts->auto_width fields.

Parameters

value_str	Width value from command line
opts	Options struct to update

Returns: ASCIICHAT_OK on success, ERROR_INVALID_PARAM if invalid

Note: Prints error message to stderr on failure; Sets opts->width and opts->auto_width = false on success

Definition at line 449 of file options/common.c.

                                                                             {
  if (!opts) {
    return ERROR_INVALID_PARAM;
  }
 
  int width_val;
  if (!validate_positive_int_opt(value_str, &width_val, "width")) {
    return ERROR_INVALID_PARAM;
  }
 
  opts->width = (unsigned short int)width_val;
  opts->auto_width = false;
 
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, options_state::auto_width, ERROR_INVALID_PARAM, validate_positive_int_opt(), and options_state::width.

◆ read_password_from_stdin()

char * read_password_from_stdin ( const char * prompt )

Read password from stdin with prompt.

Parameters

prompt Prompt message to display to user

Returns: Allocated password string (caller must free), or NULL on error

Prompts user for password input using prompt_password_simple() from util/password.h. Returns dynamically allocated string that must be freed by caller.

Note: Returns NULL if password input fails or if not running in a TTY.; Caller must use SAFE_FREE() to deallocate returned string.

Definition at line 244 of file options/common.c.

                                                   {
  char *password_buf = SAFE_MALLOC(PASSWORD_MAX_LEN, char *);
  if (!password_buf) {
    return NULL;
  }
 
  if (prompt_password_simple(prompt, password_buf, PASSWORD_MAX_LEN) != 0) {
    SAFE_FREE(password_buf);
    return NULL;
  }
 
  return password_buf; // Caller must free
}

References PASSWORD_MAX_LEN, prompt_password_simple(), SAFE_FREE, and SAFE_MALLOC.

◆ strip_equals_prefix()

char * strip_equals_prefix	(	const char *	opt_value,
		char *	buffer,
		size_t	buffer_size
	)

Strip equals sign prefix from option argument.

Internal helper that handles GNU-style long options with = syntax (–option=value). Copies argument to buffer and returns pointer past the '=' if present.

Parameters

opt_value	Raw option value from getopt_long
buffer	Buffer to store processed value
buffer_size	Size of buffer

Returns: Pointer to value in buffer (past '=' if present), or NULL if empty

Note: Returns NULL for empty strings after stripping '='; Buffer is always null-terminated via SAFE_SNPRINTF

Example:

char argbuf[OPTIONS_BUFF_SIZE];
char *value = strip_equals_prefix("=1234", argbuf, sizeof(argbuf));
// value points to "1234" in argbuf

Definition at line 195 of file options/common.c.

                                                                                   {
  if (!opt_value)
    return NULL;
 
  SAFE_SNPRINTF(buffer, buffer_size, "%s", opt_value);
  char *value_str = buffer;
  if (value_str[0] == '=') {
    value_str++; // Skip the equals sign
  }
 
  // Return NULL for empty strings (treat as missing argument)
  if (strlen(value_str) == 0) {
    return NULL;
  }
 
  return value_str;
}

References SAFE_SNPRINTF.

Referenced by get_required_argument().

◆ strtoint_safe()

int strtoint_safe ( const char * str )

Safely parse string to integer with validation.

Parses a string to integer using parse_int32() with full range checking. Returns INT_MIN on error (NULL input, empty string, invalid format, out of range).

Parameters

str	String to parse

Returns: Parsed integer value, or INT_MIN on error

Warning: INT_MIN is used as error sentinel, so cannot represent INT_MIN value

Example:

int val = strtoint_safe(optarg);
if (val == INT_MIN) {
    fprintf(stderr, "Invalid integer: %s\n", optarg);
    return ERROR_INVALID_PARAM;
}

Definition at line 67 of file options/common.c.

                                   {
  if (!str || *str == '\0') {
    return INT_MIN; // Error: NULL or empty string
  }
 
  int32_t result = 0;
  // Use safe parsing utility with full int32 range validation
  if (parse_int32(str, &result, INT_MIN, INT_MAX) != ASCIICHAT_OK) {
    return INT_MIN; // Error: invalid input or out of range
  }
 
  return (int)result;
}

◆ update_dimensions_for_full_height()

void update_dimensions_for_full_height ( options_t * opts )

Update dimensions for full-height mode.

Sets opt_height to terminal height when auto-detected. Used during initialization to maximize vertical space usage.

Behavior:

Both auto: Set both width and height to terminal size
Only height auto: Set height to terminal height
Only width auto: Set width to terminal width
Neither auto: No change

Note: Does not use log_debug because logging may not be initialized yet; Fails silently if terminal size detection fails (keeps defaults)

Example:

// During options_init():
if (auto_height || auto_width) {
    update_dimensions_for_full_height();
}

Definition at line 535 of file options/common.c.

                                                        {
  if (!opts) {
    return;
  }
 
  unsigned short int term_width, term_height;
 
  // Note: Logging is not available during options_init, so we can't use log_debug here
  asciichat_error_t result = get_terminal_size(&term_width, &term_height);
  if (result == ASCIICHAT_OK) {
    // If both dimensions are auto, set height to terminal height and let
    // aspect_ratio calculate width
    if (opts->auto_height && opts->auto_width) {
      opts->height = term_height;
      opts->width = term_width; // Also set width when both are auto
    }
    // If only height is auto, use full terminal height
    else if (opts->auto_height) {
      opts->height = term_height;
    }
    // If only width is auto, use full terminal width
    else if (opts->auto_width) {
      opts->width = term_width;
    }
  } else {
    // Terminal size detection failed, but we can still continue with defaults
  }
}

◆ update_dimensions_to_terminal_size()

void update_dimensions_to_terminal_size ( options_t * opts )

Update dimensions to current terminal size.

Updates opt_width and opt_height to current terminal size for auto-detected dimensions. Used after logging is initialized (can use log_debug).

Behavior:

auto_width: Set width to terminal width
auto_height: Set height to terminal height
Neither: No change

Note: Logs debug messages about dimension updates; Logs debug message if terminal size detection fails

Example:

// After logging initialization:
update_dimensions_to_terminal_size();
log_info("Terminal dimensions: %dx%d", opt_width, opt_height);

Definition at line 564 of file options/common.c.

                                                         {
  if (!opts) {
    return;
  }
 
  unsigned short int term_width, term_height;
  // Get current terminal size (get_terminal_size already handles ioctl first, then $COLUMNS/$LINES fallback)
  asciichat_error_t terminal_result = get_terminal_size(&term_width, &term_height);
  if (terminal_result == ASCIICHAT_OK) {
    if (opts->auto_width) {
      opts->width = term_width;
    }
    if (opts->auto_height) {
      opts->height = term_height;
    }
    log_debug("After update_dimensions_to_terminal_size: width=%d, height=%d", opts->width, opts->height);
  } else {
    // Terminal detection failed - keep the default values set in options_init()
    log_debug(
        "Failed to get terminal size in update_dimensions_to_terminal_size, keeping defaults: width=%d, height=%d",
        opts->width, opts->height);
  }
}

◆ validate_fps_opt()

bool validate_fps_opt	(	const char *	value_str,
		int *	out_fps
	)

Validate FPS value (1-144)

Internal option parsing helper that validates FPS is in reasonable range. Range chosen to support 1 FPS (slideshows) to 144 FPS (high refresh monitors).

Parameters

value_str	String to validate
out_fps	Output parameter for validated FPS

Returns: true if valid, false otherwise

Example:

int fps;
if (!validate_fps_opt(optarg, &fps)) {
    return option_error_invalid();
}
opt_fps = fps;

Definition at line 127 of file options/common.c.

                                                           {
  if (!value_str || !out_fps) {
    return false;
  }
 
  int fps_val = strtoint_safe(value_str);
  if (fps_val == INT_MIN || fps_val < 1 || fps_val > 144) {
    (void)fprintf(stderr, "Invalid FPS value '%s'. FPS must be between 1 and 144.\n", value_str);
    return false;
  }
 
  *out_fps = fps_val;
  return true;
}

References strtoint_safe().

◆ validate_port_opt()

bool validate_port_opt	(	const char *	value_str,
		uint16_t *	out_port
	)

Validate port number (1-65535)

Internal option parsing helper that validates a port number is in valid range. Uses parse_port() for robust validation.

Parameters

value_str	String to validate
out_port	Output parameter for validated port

Returns: true if valid, false otherwise

Example:

uint16_t port;
if (!validate_port_opt(optarg, &port)) {
    return option_error_invalid();
}
opt_port = port;

Definition at line 112 of file options/common.c.

                                                                  {
  if (!value_str || !out_port) {
    return false;
  }
 
  // Use safe integer parsing with range validation
  if (parse_port(value_str, out_port) != ASCIICHAT_OK) {
    (void)fprintf(stderr, "Invalid port value '%s'. Port must be a number between 1 and 65535.\n", value_str);
    return false;
  }
 
  return true;
}

References ASCIICHAT_OK, and parse_port().

◆ validate_positive_int_opt()

bool validate_positive_int_opt	(	const char *	value_str,
		int *	out_value,
		const char *	param_name
	)

Validate a positive integer value.

Internal option parsing helper that validates a string represents a positive integer (> 0). Prints error message on failure.

Parameters

value_str	String to validate
out_value	Output parameter for validated integer
param_name	Parameter name for error messages

Returns: true if valid, false otherwise

Example:

int fps;
if (!validate_positive_int_opt(optarg, &fps, "FPS")) {
    return option_error_invalid();
}

Definition at line 96 of file options/common.c.

                                                                                              {
  if (!value_str || !out_value) {
    return false;
  }
 
  int val = strtoint_safe(value_str);
  if (val == INT_MIN || val <= 0) {
    (void)fprintf(stderr, "Invalid %s value '%s'. %s must be a positive integer.\n", param_name, value_str, param_name);
    return false;
  }
 
  *out_value = val;
  return true;
}

References strtoint_safe().

Referenced by parse_height_option(), and parse_width_option().

◆ validate_required_argument()

char * validate_required_argument	(	const char *	optarg,
		char *	argbuf,
		size_t	argbuf_size,
		const char *	option_name,
		asciichat_mode_t	mode
	)

Validate and retrieve required argument for an option.

Wrapper around get_required_argument() that also sets error code on failure. Used for options that must have an argument.

Parameters

optarg	Argument value from getopt_long
argbuf	Buffer for storing processed argument
argbuf_size	Size of argbuf
option_name	Name of the option (for error messages)
mode	Current mode (client/server/mirror) for error messages

Returns: Pointer to processed argument string in argbuf, or NULL on error

Note: On error, prints message to stderr and calls option_error_invalid()

Example:

char argbuf[OPTIONS_BUFF_SIZE];
char *value = validate_required_argument(optarg, argbuf, sizeof(argbuf), "port", MODE_CLIENT);
if (!value) {
    return option_error_invalid();
}

Definition at line 86 of file options/common.c.

                                                        {
  char *value = get_required_argument(optarg, argbuf, argbuf_size, option_name, mode);
  if (!value) {
    (void)option_error_invalid();
  }
  return value;
}

References get_required_argument().

◆ validate_webcam_index()

bool validate_webcam_index	(	const char *	value_str,
		unsigned short int *	out_index
	)

Validate webcam index using the common device index validator.

Validates webcam index is a non-negative integer. Unlike audio device indices, webcam indices do not support -1 (default).

Parameters

value_str	String to validate
out_index	Output parameter for validated index

Returns: true if valid, false otherwise

Example:

unsigned short int webcam_idx;
if (!validate_webcam_index(optarg, &webcam_idx)) {
    return option_error_invalid();
}
opt_webcam_index = webcam_idx;

Definition at line 143 of file options/common.c.

                                                                                 {
  if (!value_str || !out_index) {
    return false;
  }
 
  char error_msg[256];
  int parsed_index = validate_opt_device_index(value_str, error_msg, sizeof(error_msg));
  if (parsed_index == INT_MIN) {
    (void)fprintf(stderr, "Invalid webcam index: %s\n", error_msg);
    return false;
  }
  // Webcam index doesn't support -1 (default), must be >= 0
  if (parsed_index < 0) {
    (void)fprintf(stderr, "Invalid webcam index '%s'. Webcam index must be a non-negative integer.\n", value_str);
    return false;
  }
 
  *out_index = (unsigned short int)parsed_index;
  return true;
}

References validate_opt_device_index().

Referenced by parse_webcam_index_option().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ USAGE_AUDIO_ANALYSIS_LINE

◆ USAGE_AUDIO_LINE

◆ USAGE_CLIENT_KEYS_LINE

◆ USAGE_COLOR_MODE_LINE

◆ USAGE_COMPRESSION_LEVEL_LINE

◆ USAGE_DATABASE_LINE

◆ USAGE_ENCODE_AUDIO_LINE

◆ USAGE_ENCRYPT_LINE

◆ USAGE_FPS_UNIX_LINE

◆ USAGE_FPS_WIN_LINE

◆ USAGE_HEIGHT_LINE

◆ USAGE_HELP_LINE

◆ USAGE_INDENT

◆ USAGE_KEY_CLIENT_LINE

◆ USAGE_KEY_SERVER_LINE

◆ USAGE_KEYFILE_LINE

◆ USAGE_LIST_MICROPHONES_LINE

◆ USAGE_LIST_SPEAKERS_LINE

◆ USAGE_LIST_WEBCAMS_LINE

◆ USAGE_LOG_FILE_LINE

◆ USAGE_LOG_LEVEL_LINE

◆ USAGE_MAX_CLIENTS_LINE

◆ USAGE_MICROPHONE_INDEX_LINE

◆ USAGE_NO_AUDIO_MIXER_LINE

◆ USAGE_NO_AUDIO_PLAYBACK_LINE

◆ USAGE_NO_COMPRESS_LINE

◆ USAGE_NO_ENCODE_AUDIO_LINE

◆ USAGE_NO_ENCRYPT_LINE

◆ USAGE_PALETTE_CHARS_LINE

◆ USAGE_PALETTE_LINE

◆ USAGE_PASSWORD_LINE

◆ USAGE_PORT_CLIENT_LINE

◆ USAGE_PORT_LINE

◆ USAGE_RECONNECT_LINE

◆ USAGE_RENDER_MODE_LINE

◆ USAGE_SERVER_KEY_LINE

◆ USAGE_SHOW_CAPABILITIES_LINE

◆ USAGE_SNAPSHOT_DELAY_LINE

◆ USAGE_SNAPSHOT_LINE

◆ USAGE_SPEAKERS_INDEX_LINE

◆ USAGE_STRETCH_LINE

◆ USAGE_STRIP_ANSI_LINE

◆ USAGE_TEST_PATTERN_CLIENT_LINE

◆ USAGE_TEST_PATTERN_MIRROR_LINE

◆ USAGE_UTF8_LINE

◆ USAGE_VERSION_LINE

◆ USAGE_WEBCAM_FLIP_LINE

◆ USAGE_WEBCAM_INDEX_LINE

◆ USAGE_WIDTH_LINE

Function Documentation

◆ detect_default_ssh_key()

◆ find_similar_option()

◆ get_required_argument()

◆ parse_color_mode_option()

◆ parse_height_option()

◆ parse_log_level_option()

◆ parse_palette_chars_option()

◆ parse_palette_option()

◆ parse_render_mode_option()

◆ parse_snapshot_delay_option()

◆ parse_webcam_index_option()

◆ parse_width_option()

◆ read_password_from_stdin()

◆ strip_equals_prefix()

◆ strtoint_safe()

◆ update_dimensions_for_full_height()

◆ update_dimensions_to_terminal_size()

◆ validate_fps_opt()

◆ validate_port_opt()

◆ validate_positive_int_opt()

◆ validate_required_argument()

◆ validate_webcam_index()