common.c File Reference

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

Go to the source code of this file.

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 *	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 *	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 *	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.
void	usage (FILE *desc, asciichat_mode_t mode)
	Print usage information for client, server, or mirror mode.

Variables
ASCIICHAT_API unsigned short int	opt_width = OPT_WIDTH_DEFAULT
ASCIICHAT_API unsigned short int	opt_height = OPT_HEIGHT_DEFAULT
ASCIICHAT_API bool	auto_width = true
ASCIICHAT_API bool	auto_height = true
bool	port_explicitly_set_via_flag = false
ASCIICHAT_API char	opt_address [OPTIONS_BUFF_SIZE] = "localhost"
ASCIICHAT_API char	opt_address6 [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API char	opt_port [OPTIONS_BUFF_SIZE] = "27224"
ASCIICHAT_API int	opt_max_clients = 10
ASCIICHAT_API int	opt_compression_level = 1
ASCIICHAT_API bool	opt_no_compress = false
ASCIICHAT_API bool	opt_encode_audio = true
ASCIICHAT_API int	opt_reconnect_attempts = -1
ASCIICHAT_API unsigned short int	opt_webcam_index = 0
ASCIICHAT_API bool	opt_webcam_flip = true
ASCIICHAT_API bool	opt_test_pattern = false
ASCIICHAT_API bool	opt_no_audio_mixer = false
ASCIICHAT_API terminal_color_mode_t	opt_color_mode = COLOR_MODE_AUTO
ASCIICHAT_API render_mode_t	opt_render_mode = RENDER_MODE_FOREGROUND
ASCIICHAT_API unsigned short int	opt_show_capabilities = 0
ASCIICHAT_API unsigned short int	opt_force_utf8 = 0
ASCIICHAT_API unsigned short int	opt_audio_enabled = 0
ASCIICHAT_API int	opt_microphone_index = -1
ASCIICHAT_API int	opt_speakers_index = -1
ASCIICHAT_API unsigned short int	opt_audio_analysis_enabled = 0
ASCIICHAT_API unsigned short int	opt_audio_no_playback = 0
ASCIICHAT_API unsigned short int	opt_stretch = 0
ASCIICHAT_API unsigned short int	opt_quiet = 0
ASCIICHAT_API unsigned short int	opt_verbose_level = 0
ASCIICHAT_API unsigned short int	opt_snapshot_mode = 0
ASCIICHAT_API float	opt_snapshot_delay = SNAPSHOT_DELAY_DEFAULT
ASCIICHAT_API unsigned short int	opt_strip_ansi = 0
ASCIICHAT_API char	opt_log_file [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API log_level_t	opt_log_level = LOG_DEBUG
ASCIICHAT_API unsigned short int	opt_encrypt_enabled = 0
ASCIICHAT_API char	opt_encrypt_key [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API char	opt_password [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API char	opt_encrypt_keyfile [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API unsigned short int	opt_no_encrypt = 0
ASCIICHAT_API char	opt_server_key [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API char	opt_client_keys [OPTIONS_BUFF_SIZE] = ""
ASCIICHAT_API palette_type_t	opt_palette_type = PALETTE_STANDARD
ASCIICHAT_API char	opt_palette_custom [256] = ""
ASCIICHAT_API bool	opt_palette_custom_set = false
const float	weight_red = 0.2989f
const float	weight_green = 0.5866f
	Green weight for luminance calculation.
const float	weight_blue = 0.1145f
	Blue weight for luminance calculation.
unsigned short int	RED [256]
	Red channel lookup table.
unsigned short int	GREEN [256]
	Green channel lookup table.
unsigned short int	BLUE [256]
	Blue channel lookup table.
unsigned short int	GRAY [256]
	Grayscale lookup table.

Detailed Description

Common utilities and helpers for option parsing.

Shared helper functions, validators, and global variables used by all option parsing modules (client.c, server.c, mirror.c).

Definition in file options/common.c.

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().

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().

Variable Documentation

auto_height

ASCIICHAT_API bool auto_height = true

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

auto_width

ASCIICHAT_API bool auto_width = true

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

opt_address

ASCIICHAT_API char opt_address[OPTIONS_BUFF_SIZE] = "localhost"

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

opt_address6

ASCIICHAT_API char opt_address6[OPTIONS_BUFF_SIZE] = ""

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

opt_audio_analysis_enabled

ASCIICHAT_API unsigned short int opt_audio_analysis_enabled = 0

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

opt_audio_enabled

ASCIICHAT_API unsigned short int opt_audio_enabled = 0

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

opt_audio_no_playback

ASCIICHAT_API unsigned short int opt_audio_no_playback = 0

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

opt_client_keys

ASCIICHAT_API char opt_client_keys[OPTIONS_BUFF_SIZE] = ""

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

opt_color_mode

ASCIICHAT_API terminal_color_mode_t opt_color_mode = COLOR_MODE_AUTO

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

opt_compression_level

ASCIICHAT_API int opt_compression_level = 1

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

opt_encode_audio

ASCIICHAT_API bool opt_encode_audio = true

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

opt_encrypt_enabled

ASCIICHAT_API unsigned short int opt_encrypt_enabled = 0

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

opt_encrypt_key

ASCIICHAT_API char opt_encrypt_key[OPTIONS_BUFF_SIZE] = ""

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

opt_encrypt_keyfile

ASCIICHAT_API char opt_encrypt_keyfile[OPTIONS_BUFF_SIZE] = ""

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

opt_force_utf8

ASCIICHAT_API unsigned short int opt_force_utf8 = 0

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

opt_height

ASCIICHAT_API unsigned short int opt_height = OPT_HEIGHT_DEFAULT

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

opt_log_file

ASCIICHAT_API char opt_log_file[OPTIONS_BUFF_SIZE] = ""

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

opt_log_level

ASCIICHAT_API log_level_t opt_log_level = LOG_DEBUG

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

opt_max_clients

ASCIICHAT_API int opt_max_clients = 10

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

opt_microphone_index

ASCIICHAT_API int opt_microphone_index = -1

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

opt_no_audio_mixer

ASCIICHAT_API bool opt_no_audio_mixer = false

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

opt_no_compress

ASCIICHAT_API bool opt_no_compress = false

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

opt_no_encrypt

ASCIICHAT_API unsigned short int opt_no_encrypt = 0

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

opt_palette_custom

ASCIICHAT_API char opt_palette_custom[256] = ""

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

opt_palette_custom_set

ASCIICHAT_API bool opt_palette_custom_set = false

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

opt_palette_type

ASCIICHAT_API palette_type_t opt_palette_type = PALETTE_STANDARD

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

opt_password

ASCIICHAT_API char opt_password[OPTIONS_BUFF_SIZE] = ""

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

opt_port

ASCIICHAT_API char opt_port[OPTIONS_BUFF_SIZE] = "27224"

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

opt_quiet

ASCIICHAT_API unsigned short int opt_quiet = 0

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

opt_reconnect_attempts

ASCIICHAT_API int opt_reconnect_attempts = -1

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

opt_render_mode

ASCIICHAT_API render_mode_t opt_render_mode = RENDER_MODE_FOREGROUND

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

opt_server_key

ASCIICHAT_API char opt_server_key[OPTIONS_BUFF_SIZE] = ""

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

opt_show_capabilities

ASCIICHAT_API unsigned short int opt_show_capabilities = 0

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

opt_snapshot_delay

ASCIICHAT_API float opt_snapshot_delay = SNAPSHOT_DELAY_DEFAULT

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

opt_snapshot_mode

ASCIICHAT_API unsigned short int opt_snapshot_mode = 0

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

opt_speakers_index

ASCIICHAT_API int opt_speakers_index = -1

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

opt_stretch

ASCIICHAT_API unsigned short int opt_stretch = 0

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

opt_strip_ansi

ASCIICHAT_API unsigned short int opt_strip_ansi = 0

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

opt_test_pattern

ASCIICHAT_API bool opt_test_pattern = false

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

opt_verbose_level

ASCIICHAT_API unsigned short int opt_verbose_level = 0

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

opt_webcam_flip

ASCIICHAT_API bool opt_webcam_flip = true

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

opt_webcam_index

ASCIICHAT_API unsigned short int opt_webcam_index = 0

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

opt_width

ASCIICHAT_API unsigned short int opt_width = OPT_WIDTH_DEFAULT

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

port_explicitly_set_via_flag

bool port_explicitly_set_via_flag = false

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