Utility library overview

Table of Contents

• Introduction
• Key Features
• Architecture
• Main Components
  • Array Utilities
  • System Call Wrappers
  • Formatting Utilities
  • File operations
• Best Practices

Introduction

The D7 SDK Utils Library provides a collection of utility functions and wrappers that simplify common operations and enhance safety across the D7 SDK codebase. It includes memory-safe array operations, system call wrappers, and formatted output utilities.

Key Features

• Safe array element access and size retrieval
• System call wrappers that handle C++ linter requirements
• Exception-safe formatted output
• Type-safe formatting utilities

Architecture

The Utils Library is organized as a collection of standalone utility functions and templates designed to be included and used throughout the D7 SDK codebase. Each component provides specific functionality to address common programming needs.

Main Components

Array Utilities

The Array Utilities component provides template functions for safe array operations.

Key functions:

• vsdk::utils::at() - Safe array element access with bounds checking
• vsdk::utils::array_size() - Get the size of a fixed-size array

System Call Wrappers

The System Call Wrappers component provides wrapper functions for common system calls that handle C++ linter requirements and improve code safety.

Key functions:

• vsdk::utils::open() - Safe wrapper for the standard open syscall
• vsdk::utils::ioctl() - Template wrapper for the standard ioctl syscall
• vsdk::utils::system() - Safe wrapper for the standard system syscall
• vsdk::utils::fcntl() - Safe wrapper for the standard fcntl syscall

Formatting Utilities

The Formatting Utilities component provides wrappers and extensions for the fmt library to enable safe and convenient formatted output.

Key functions:

• vsdk::utils::print() - Exception-safe wrapper for fmt::print

File operations

The file operations utilities provide a simple API for the most common operations:

• vsdk::utils::path_join() - Function to create paths from multiple components using OS-specific separators. It must be provided with at least 1 string-like argument (const char*, std::string, std::string_view).
• vsdk::utils::file_remove() - Remove a file. For removing a directory recursively, see vsdk::utils::rmdir.
• vsdk::utils::rmdir() - Remove a directory recursively. Similar to rm -rf.
• vsdk::utils::mkdir() - Create a directory from a given path. It will create the intermediary directories as well. Similar to mkdir -p.
• vsdk::utils::canonical_path() - Get the canonical path from a path containing elements like dot (./), dotdot (../) and symlinks.
• vsdk::utils::file_exists() - Check if a file exists.

Best Practices

• Use vsdk::utils::at() instead of direct array access when bounds checking is required
• Use vsdk::utils::array_size() instead of sizeof tricks for determining array size
• Prefer the system call wrappers over direct syscalls for better code maintainability
• Use vsdk::utils::print() in situations where exceptions should not propagate
• Remember to check return values from system call wrappers