client.h File Reference

Client mode option parsing. More...

Go to the source code of this file.

Functions
asciichat_error_t	parse_client_options (int argc, char **argv, options_t *opts)
	Parse client-specific command-line options.
void	usage_client (FILE *stream)
	Print client mode usage/help text.

Detailed Description

Client mode option parsing.

Client-specific command-line option parsing and help text. The client mode connects to a server and displays received video streams while capturing and sending local webcam/audio data.

Client-Specific Options:

• Network: [address][:port] positional, --port, --lan
• Webcam: --webcam-index, --webcam-flip, --test-pattern
• Display: --width, --height, --color-mode, --render-mode, --fps
• Audio: --audio, --microphone-index, --speakers-index, --audio-analysis
• Crypto: --key, --server-key (TOFU verification)
• Connection: --reconnect
• Compression: --compression-level, --no-compress, --encode-audio
• Debug: --show-capabilities, --utf8, --list-webcams, --list-microphones, --list-speakers

Positional Arguments:

• Format: [address][:port]
• Examples: localhost, 192.168.1.100, example.com:8080, [::1]:27224
• Port in positional conflicts with --port flag

Shared Options (parsed in options.c):

• Palette: --palette, --palette-chars
• Output: --stretch, --quiet, --snapshot, --strip-ansi
• Encryption: --encrypt, --no-encrypt, --password, --keyfile

See also

options.h

common.h

server.h

mirror.h

Definition in file lib/options/client.h.

Function Documentation

parse_client_options()

asciichat_error_t parse_client_options	(	int	argc,
		char **	argv,
		options_t *	opts
	)

Parse client-specific command-line options.

Parses all client mode options including:

• Positional argument: [address][:port] for server connection
• Client-specific flags (webcam, audio, display, network options)
• Shared options (palette, encryption, output options)

Parsing Logic:

1. getopt_long() loop processes all flags
2. After loop, parse positional argument for server address
3. Validate port conflicts (positional vs –port flag)
4. Set default values for unspecified options

Error Handling:

• Invalid options: Prints error with typo suggestions
• Missing required arguments: Prints usage hint
• Port conflicts: Errors if both positional port and –port specified
• Returns ERROR_INVALID_PARAM on any validation failure

Parameters

argc	Argument count from main()
argv	Argument vector from main()

Returns

ASCIICHAT_OK on success, ERROR_INVALID_PARAM on parse error

Note

Modifies global opt_* variables (opt_address, opt_port, opt_width, etc.)

Prints error messages to stderr on failure

Prints help text and exits if –help flag present

Positional Argument Parsing: After getopt_long() completes, optind points to first non-option argument. Format: [address][:port]

• IPv4: 192.168.1.100, 192.168.1.100:8080
• IPv6: [::1], [2001:db8::1]:8080
• Hostname: localhost, example.com:27224

Port conflicts:

// ❌ WRONG - conflicting port specifications
./ascii-chat client localhost:8080 --port 9090
// Error: Cannot specify port in both positional argument and --port flag
 
// ✅ CORRECT - specify port only once
./ascii-chat client localhost:8080
./ascii-chat client localhost --port 8080

Example usage:

int main(int argc, char **argv) {
    asciichat_error_t err = options_init(argc, argv, MODE_CLIENT);
    if (err != ASCIICHAT_OK) {
        return 1;  // Error already printed
    }
 
    // Option globals are now populated:
    log_info("Connecting to %s:%s", opt_address, opt_port);
    log_info("Terminal size: %dx%d", opt_width, opt_height);
    log_info("Webcam: %d, Audio: %s", opt_webcam_index,
             opt_audio_enabled ? "enabled" : "disabled");
 
    // ... proceed with client initialization
}

See also

parse_server_options()

parse_mirror_options()

options_init()

Definition at line 50 of file lib/options/client.c.

                                                                               {
  const options_config_t *config = options_preset_client("ascii-chat client", "connect to an ascii-chat server");
  int remaining_argc;
  char **remaining_argv;
 
  // Apply defaults from preset before parsing command-line args
  asciichat_error_t defaults_result = options_config_set_defaults(config, opts);
  if (defaults_result != ASCIICHAT_OK) {
    options_config_destroy(config);
    return defaults_result;
  }
 
  asciichat_error_t result = options_config_parse(config, argc, argv, opts, &remaining_argc, &remaining_argv);
  if (result != ASCIICHAT_OK) {
    options_config_destroy(config);
    return result;
  }
 
  // Check for unexpected remaining arguments
  if (remaining_argc > 0) {
    (void)fprintf(stderr, "Error: Unexpected arguments after options:\n");
    for (int i = 0; i < remaining_argc; i++) {
      (void)fprintf(stderr, "  %s\n", remaining_argv[i]);
    }
    options_config_destroy(config);
    return option_error_invalid();
  }
 
  options_config_destroy(config);
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, options_config_destroy(), options_config_parse(), options_config_set_defaults(), and options_preset_client().

Referenced by options_init().

usage_client()

void usage_client

(

FILE *

stream

)

Print client mode usage/help text.

Displays comprehensive help for all client options, including:

• Description of client mode
• Positional argument format and examples
• All client-specific flags with descriptions
• Shared flags (palette, encryption, output)
• Usage examples for common scenarios

Output Format:

Client mode: Connect to ascii-chat server and display video grid
 
Usage: ascii-chat client [OPTIONS] [address][:port]
 
Positional Arguments:
  [address][:port]        Server address with optional port (default: localhost:27224)
                          Examples: localhost, 192.168.1.100:8080, [::1]:27224
 
Network Options:
  -p, --port PORT         Server port (default: 27224)
                          Note: Conflicts with port in positional argument
 
Webcam Options:
  -c, --webcam-index N    Webcam device index (default: 0)
  -f, --webcam-flip       Mirror webcam horizontally (default: true)
  --test-pattern          Use test pattern instead of real webcam
  --list-webcams          List available webcams and exit
 
[... continues with all option categories ...]

Parameters

stream

Output stream (stdout for –help, stderr for errors)

Note

Does not exit - caller decides whether to exit after printing

Always includes mode description, positional args, and all flags

Examples show real-world usage patterns

Example usage:

// Print help and exit successfully
if (help_requested) {
    usage_client(stdout);
    exit(0);
}
 
// Print usage hint on error
if (parse_error) {
    fprintf(stderr, "Error: Invalid option\n\n");
    usage_client(stderr);
    exit(1);
}

See also

usage_server()

usage_mirror()

Definition at line 86 of file lib/options/client.c.

                              {
  // Get config with program name and description
  const options_config_t *config = options_preset_client("ascii-chat client", "connect to an ascii-chat server");
  if (!config) {
    (void)fprintf(desc, "Error: Failed to create options config\n");
    return;
  }
 
  // Print custom address format help first
  (void)fprintf(desc, "%s - %s\n\n", config->program_name, config->description);
  (void)fprintf(desc, "USAGE:\n");
  (void)fprintf(desc, "  %s [address][:port] [options...]\n\n", config->program_name);
 
  // Print positional argument examples programmatically
  if (config->num_positional_args > 0) {
    const positional_arg_descriptor_t *pos_arg = &config->positional_args[0];
    if (pos_arg->section_heading && pos_arg->examples && pos_arg->num_examples > 0) {
      (void)fprintf(desc, "%s:\n", pos_arg->section_heading);
      for (size_t i = 0; i < pos_arg->num_examples; i++) {
        (void)fprintf(desc, "  %s\n", pos_arg->examples[i]);
      }
      (void)fprintf(desc, "\n");
    }
  }
 
  // Generate options from builder configuration
  options_config_print_usage(config, desc);
 
  // Clean up the config
  options_config_destroy(config);
}