Runtime Library: OS Command Wrapping
This library has 136 classes.
ECF: os-command.ecf
Source code: directory list
Classes for creating cross platform wrappers of OS commands with over 100 "out of the box" commands provided.
General Features
- Command templates are based on the powerful Evolicity text substitution library.
- Support for command output capture, and error output capture.
- Automatic escaping of path arguments conforming to EL_PATH, namely EL_FILE_PATH and EL_DIR_PATH. All Windows paths are automatically put in quotes. Unix paths are automatically escaped with \ for reserved characters. This has some advantages over putting them in quotes.
- Designed for cross platform use, with special features for post-capture processing of output lines so they are consistent across platforms. See classes EL_FIND_DIRECTORIES_COMMAND_I and EL_FIND_FILES_COMMAND_I as an example. Here the Unix find command and the Windows dir command are made to appear exactly the same for specific tasks.
- Support for making "convenience wrappers" without any need to create a new class. These are classes: EL_OS_COMMAND and EL_CAPTURED_OS_COMMAND.
- Has factory class EL_OS_ROUTINES (accessible via EL_MODULE_OS) which contains factory functions for common OS system commands.
Information Commands
These are "out of the box" command for obtaining system information.
- Unix command to parse output of nm-tool to get MAC address of ethernet devices
- Unix command to obtain CPU name
Future Development
Make a platform independent interface for listing symbolic link targets in a directory.
(By concidence both outputs align on column 40)
UNIX example
ls -l <dir-path> lrwxrwxrwx 1 root root 48 Apr 11 2022 cherokee-images -> /usr/share/www/cherokee-images lrwxrwxrwx 1 root root 43 Apr 11 2022 index.html -> /usr/share/www/index.html
WINDOWS example
dir /AL <dir-path> 04/25/2024 12:00 PM <SYMLINK> MyFolder [C:\Users\John\Documents\MyFolder] 04/25/2024 11:30 AM <SYMLINK> ShortcutToProgram [C:\Program Files\Program.exe]
Directory: library/runtime/process/commands
[ . ]
EL_COMMAND_FACTORY
Command factory accessible via EL_MODULE_COMMAND
EL_MODULE_COMMAND
Shared access to routines of class EL_COMMAND_FACTORY
Further Information
Click on class link to see client examples.
EL_NATIVE_FILE_LISTING
Implementation of EL_FILE_LISTING that uses native OS commands find (on Unix) and dir (on Windows). These are highly optimized so better performance can be expected, especially on large listings.
file
EL_FILE_CONVERSION_COMMAND_I
Command that converts files from one type to anothers
EL_MD5_HASH_COMMAND
Obtain MD5 hash using Unix md5sum command
EL_NATIVE_DIRECTORY_CONTENT_PROCESSOR
Implementation of EL_DIRECTORY_CONTENT_PROCESSOR that uses native OS commands to obtain file listings
Further Information
Click on class link to see client examples.
EL_NATIVE_DIRECTORY_PATH_LIST
Implementation of EL_DIRECTORY_PATH_LIST that uses native OS commands to obtain file listings
Further Information
Click on class link to see client examples.
EL_NATIVE_DIRECTORY_TREE_FILE_PROCESSOR
Implementation of EL_DIRECTORY_TREE_FILE_PROCESSOR that uses native OS commands to obtain file listings
Further Information
Click on class link to see client examples.
EL_SYMLINK_LISTING_COMMAND
Unix command to list symbolic links in a target directory
Further Information
Click on class link to see notes and client examples.
file/archive
EL_CREATE_TAR_COMMAND
Create archive using Unix tar command
Further Information
Click on class link to see client examples.
file/gvfs
EL_GVFS_CAMERA_VOLUME
EL_GVFS_VOLUME that is a multi-media/camera device
Further Information
Click on class link to see client examples.
EL_GVFS_FILE_SYNC_MEDIUM
GIO virtual file system as file synchronized medium destination
Further Information
Click on class link to see client examples.
EL_GVFS_ROUTINES
GIO virtual file system routines and commands
Further Information
Click on class link to see client examples.
EL_GVFS_VOLUME
GIO virtual file system volume
Further Information
Click on class link to see client examples.
file/patch
EL_APPLY_PATCH_COMMAND
Apply patch command bspatch to binary patch
Further Information
Click on class link to see client examples.
EL_GENERATE_PATCH_COMMAND
Wrapper for Unix bsdiff command to generate a binary patch that can be applied with bspatch
Further Information
Click on class link to see client examples.
imp_common
EL_RSYNC_COMMAND_IMP
Implementation of EL_RSYNC_COMMAND_I with Unix rsync command
EL_SEND_MAIL_COMMAND_IMP
Implementation of EL_SEND_MAIL_COMMAND_I
imp_mswin/kernel
EL_CAPTURED_OS_COMMAND_IMP
Windows implementation of EL_CAPTURED_OS_COMMAND_I interface
EL_OS_COMMAND_IMP
Windows implementation of EL_OS_COMMAND_I interface
imp_mswin/system
EL_SYSTEM_ROUTINES_IMP
Windows implementation of EL_SYSTEM_ROUTINES_I interface
EL_WINDOWS_SHELL_COMMAND
Interface to ShellExecute function from the Windows Shell API <Shellapi.h>
imp_mswin/system/file
EL_CREATE_LINK_COMMAND_IMP
Windows implementation of EL_CREATE_LINK_COMMAND_I interface
EL_DELETE_FILE_COMMAND_IMP
Windows implementation of EL_DELETE_FILE_COMMAND_I interface
EL_DELETE_TREE_COMMAND_IMP
Windows implementation of EL_DELETE_TREE_COMMAND_I interface
EL_DIRECTORY_INFO_COMMAND_IMP
Windows implementation of EL_DIRECTORY_INFO_COMMAND_I interface
EL_JPEG_FILE_INFO_COMMAND_IMP
Windows implementation of EL_JPEG_FILE_INFO_COMMAND_I
EL_MAKE_DIRECTORY_COMMAND_IMP
Windows implementation of EL_MAKE_DIRECTORY_COMMAND_I interface
EL_MOVE_FILE_COMMAND_IMP
Windows implementation of EL_MOVE_FILE_COMMAND_I interface
EL_MOVE_TO_DIRECTORY_COMMAND_IMP
Windows implemenation of EL_MOVE_TO_DIRECTORY_COMMAND_I
imp_mswin/system/file/copy
EL_COPY_FILE_COMMAND_IMP
Windows implementation of EL_COPY_FILE_COMMAND_I interface
Further Information
Click on class link to see client examples.
EL_COPY_TREE_COMMAND_IMP
Windows implementation of EL_COPY_TREE_COMMAND_I interface
Further Information
Click on class link to see client examples.
imp_mswin/system/file/find
EL_FIND_COMMAND_IMP
Windows implementation of EL_FIND_COMMAND_I
EL_FIND_DIRECTORIES_COMMAND_IMP
Windows implementation of EL_FIND_DIRECTORIES_COMMAND_I interface
EL_FIND_FILES_COMMAND_IMP
Windows implementation of EL_FIND_FILES_COMMAND_I interface
EL_WINDOWS_DIR_PATH_LINE_SOURCE
Causes the search directory to appear at start of list to match Unix
EL_WINDOWS_FILE_PATH_LINE_SOURCE
Adjust the path items to be either absolute or relative so as to match output of Unix find command.
imp_mswin/system/info
EL_CPU_INFO_COMMAND_IMP
Windows implementation of EL_CPU_INFO_COMMAND_I
Further Information
Click on class link to see notes.
EL_NOTIFY_SEND_ERROR_COMMAND
Sends a desktop notification warning of an error using the VBscript command msgbox invoked by the Windows Mshta.exe command.
Further Information
Click on class link to see client examples.
EL_USERS_INFO_COMMAND_IMP
Windows implementation of EL_USERS_INFO_COMMAND_I interface
imp_unix/kernel
EL_CAPTURED_OS_COMMAND_IMP
Unix implementation of EL_CAPTURED_OS_COMMAND_I interface
EL_OS_COMMAND_IMP
Unix implementation of EL_OS_COMMAND_I interface
imp_unix/system
EL_NOTIFY_SEND_ERROR_COMMAND
Sends a desktop notification warning of an error using the notify-send command
Further Information
Click on class link to see client examples.
EL_SYSTEM_ROUTINES_IMP
Unix implementation of EL_SYSTEM_ROUTINES_I interface
imp_unix/system/file
EL_CREATE_LINK_COMMAND_IMP
Unix implementation of EL_CREATE_LINK_COMMAND_I interface
EL_DELETE_FILE_COMMAND_IMP
Unix implementation of EL_DELETE_FILE_COMMAND_I
EL_DELETE_TREE_COMMAND_IMP
Unix implementation of EL_DELETE_TREE_COMMAND_I
EL_DIRECTORY_INFO_COMMAND_IMP
Unix implementation of EL_DIRECTORY_INFO_COMMAND_I interface
EL_JPEG_FILE_INFO_COMMAND_IMP
Unix implementation of EL_JPEG_FILE_INFO_COMMAND_I
EL_MAKE_DIRECTORY_COMMAND_IMP
Unix implementation of EL_MAKE_DIRECTORY_COMMAND_I interface
EL_MOVE_FILE_COMMAND_IMP
Unix implementation of EL_MOVE_FILE_COMMAND_I interface
EL_MOVE_TO_DIRECTORY_COMMAND_IMP
Unix implemenation of EL_MOVE_TO_DIRECTORY_COMMAND_I
imp_unix/system/file/copy
EL_COPY_FILE_COMMAND_IMP
Unix implementation of EL_COPY_FILE_COMMAND_I interface
Further Information
Click on class link to see client examples.
EL_COPY_TREE_COMMAND_IMP
Unix implementation of EL_COPY_TREE_COMMAND_I interface
Further Information
Click on class link to see client examples.
EL_UNIX_CP_TEMPLATE
Unix copy command template
imp_unix/system/file/find
EL_FIND_COMMAND_IMP
Unix implementation of EL_OS_COMMAND_IMP for find commands
EL_FIND_DIRECTORIES_COMMAND_IMP
Unix implementation of EL_FIND_DIRECTORIES_COMMAND_I interface
EL_FIND_FILES_COMMAND_IMP
Unix implementation of EL_FIND_FILES_COMMAND_I interface
EL_UNIX_FIND_TEMPLATE
Unix find template
imp_unix/system/info
EL_CPU_INFO_COMMAND_IMP
Unix implementation of EL_CPU_INFO_COMMAND_I
EL_USERS_INFO_COMMAND_IMP
Unix implementation of EL_USERS_INFO_COMMAND_I interface
internet
EL_HOST_NAME_COMMAND
Fully qualified domain name of machine (UNIX only)
Further Information
Click on class link to see client examples.
internet/backup
EL_FILE_MIRROR_BACKUP
EL_MIRROR_BACKUP for file protocol using EL_FILE_RSYNC_COMMAND command
Further Information
Click on class link to see client examples.
EL_FILE_RSYNC_COMMAND
Mirror directory using Unix rsync command
Further Information
Click on class link to see client examples.
EL_MIRROR_BACKUP
Backup mirroring configuration
Further Information
Click on class link to see client examples.
EL_MIRROR_COMMAND
OS command to mirror a directory either locally or remotely
EL_REMOTE_MIRROR_BACKUP
EL_MIRROR_BACKUP implementing remote protocol such as ftp or ssh
EL_SSH_MIRROR_BACKUP
EL_MIRROR_BACKUP for ssh protocol using EL_SSH_RSYNC_COMMAND command
Further Information
Click on class link to see client examples.
EL_SSH_RSYNC_COMMAND
Mirror local to remote directory using Unix rsync command over a secure shell connection
Further Information
Click on class link to see client examples.
internet/email
EL_EMAIL
EL_SEND_MAIL_COMMAND_I
Send mail command i
internet/ssh
EL_RSYNC_COMMAND_I
File synchronization with Unix rsync Files can be synchronized either locally or remotely via ssh
Further Information
Click on class link to see notes.
EL_SECURE_SHELL_COMMAND
OS command executed remotely using the Unix ssh command
Further Information
Click on class link to see descendants.
EL_SSH_COMMAND_FACTORY
Factory for commands conforming to EL_SECURE_SHELL_COMMAND.
Further Information
Click on class link to see notes and client examples.
EL_SSH_COPY_COMMAND
Copy single file to remote host using Unix scp command. It uses ssh for data transfer.
Further Information
Click on class link to see notes.
EL_SSH_DIRECTORY_COMMAND
Unix ssh command that operates on a single target directory
EL_SSH_MAKE_DIRECTORY_COMMAND
Make remote directory via Unix mkdir command in conjunction with ssh
Further Information
Click on class link to see notes.
EL_SSH_MD5_HASH_COMMAND
Obtain MD5 hash of remote file using Unix md5sum command remotely invoked via ssh command.
Further Information
Click on class link to see notes.
EL_SSH_TEST_DIRECTORY_COMMAND
Test to see if remote directory exists via Unix ssh command
Further Information
Click on class link to see notes.
kernel
EL_CAPTURED_OS_COMMAND
General purpose OS command that captures output lines of substituted command template
Further Information
Click on class link to see client examples.
EL_CAPTURED_OS_COMMAND_I
OS command with captured output
EL_DIR_PATH_OPERAND_COMMAND_I
Dir path operand command interface
EL_DOUBLE_PATH_OPERAND_COMMAND_I
Double path operand command i
EL_FILE_PATH_OPERAND_COMMAND_I
File path operand command interface
EL_OS_COMMAND
General purpose OS command using an externally supplied template
Further Information
Click on class link to see client examples.
EL_OS_COMMAND_CONSTANTS
OS command constants
EL_OS_COMMAND_I
Operating system command interface
Further Information
Click on class link to see notes, descendants and client examples.
EL_PARSED_CAPTURED_OS_COMMAND
A EL_CAPTURED_OS_COMMAND with arguments parsed and set in the attribute var with type defined as a class parameter
Further Information
Click on class link to see notes, descendants and client examples.
EL_PARSED_OS_COMMAND
A EL_OS_COMMAND with arguments parsed and set in the attribute var with type defined as a class parameter
Further Information
Click on class link to see notes, descendants and client examples.
EL_SINGLE_PATH_OPERAND_COMMAND_I
Single path operand command i
system
EL_MODULE_OS
Shared access to routines of class EL_OS_ROUTINES
Further Information
Click on class link to see client examples.
EL_MODULE_SYSTEM
Shared access to routines of class EL_SYSTEM_ROUTINES_I
Further Information
Click on class link to see client examples.
EL_OS_ROUTINES
OS operations based on command line utilities accessible via EL_MODULE_OS
Further Information
Click on class link to see notes.
EL_SYSTEM_ROUTINES_I
System operations based on command line utilities
Further Information
Click on class link to see notes.
system/file
EL_CREATE_LINK_COMMAND_I
Command to create a symbolic link to a file or directory
EL_DELETE_FILE_COMMAND_I
Delete file command i
EL_DELETE_TREE_COMMAND_I
Delete directory tree command interface
EL_DIRECTORY_INFO_COMMAND_I
Command to find file count and directory file content size
EL_FILE_RELOCATION_COMMAND_I
File relocation command i
EL_FILE_UTILITY_COMMAND
Fork a system utility operating on a path argument
Further Information
Click on class link to see client examples.
EL_GUNZIP_COMMAND
Interface to Unix gunzip command
Further Information
Click on class link to see client examples.
EL_GUNZIP_LIST_COMMAND
Interface to Unix gunzip command using the --list switch to obtain the uncompressed size of a gz file.
EL_JPEG_FILE_INFO_COMMAND_I
Command to parse JPEG metadata fields from output of Exiv2 command-line tool using command form:
exiv2 -p a <$file_path>
Example Output
Exif.Image.ImageWidth Long 1 3264 Exif.Image.ImageLength Long 1 2448 Exif.Image.Make Ascii 8 samsung Exif.Photo.DateTimeOriginal Ascii 20 2023:01:14 14:44:57 Exif.Thumbnail.ImageWidth Long 1 512 Exif.Thumbnail.ImageLength Long 1 384
Further Information
Click on class link to see tests and client examples.
EL_MAKE_DIRECTORY_COMMAND_I
Create a directory and it's parents if necessary. If directory already exists, no error is reported.
EL_MOVE_FILE_COMMAND_I
Move file command i
EL_MOVE_TO_DIRECTORY_COMMAND_I
Move file or directory source_path into destination_path
system/file/copy
EL_COPY_FILE_COMMAND_I
Copy file command interface
EL_COPY_TREE_COMMAND_I
Copy tree command i
system/file/find
EL_FIND_COMMAND_I
Find command abstraction
Further Information
Click on class link to see client examples.
EL_FIND_DIRECTORIES_COMMAND_I
Find directories command i
EL_FIND_FILES_COMMAND_I
Cross platform interface to EL_FIND_FILES_COMMAND_IMP
Further Information
Click on class link to see client examples.
system/file/find/condition
EL_ANY_FILE_FIND_CONDITION
Default filter condition for class EL_FIND_COMMAND_I
EL_BASE_NAME_IN_LIST_FIND_CONDITION
File list filter condition is met if path base name matches any in list
EL_FIND_FILE_CONDITION
Filter condition for appending to path_list in class EL_FIND_COMMAND_I
EL_FIND_FILE_FILTER_FACTORY
Path filters applicable to classes conforming to EL_FIND_COMMAND_I
EL_PREDICATE_FIND_CONDITION
File list filter condition is met if agent predicate returns True
Further Information
Click on class link to see client examples.
EL_SHARED_FIND_FILE_FILTER_FACTORY
Shared access to instance of EL_FIND_FILE_FILTER_FACTORY
Further Information
Click on class link to see client examples.
system/file/gvfs
EL_GVFS_COPY_COMMAND
GVFS command to copy a file
Further Information
Click on class link to see notes and client examples.
EL_GVFS_FILE_COUNT_COMMAND
Parses output of command:
gvfs-ls "$uri" | grep -c "^.*$"
Further Information
Click on class link to see notes.
EL_GVFS_FILE_EXISTS_COMMAND
GVFS command to detect if file exists
Further Information
Click on class link to see notes and client examples.
EL_GVFS_FILE_INFO_COMMAND
GVFS command to read file properties
Further Information
Click on class link to see notes.
EL_GVFS_FILE_LIST_COMMAND
GVFS command to obtain list of files in directory
Further Information
Click on class link to see notes.
EL_GVFS_MAKE_DIRECTORY_COMMAND
GVFS command to create a directory
Further Information
Click on class link to see notes and client examples.
EL_GVFS_MOUNT_LIST_COMMAND
Parse mount uri's from result of command:
gvfs-mount --list
Further Information
Click on class link to see notes.
EL_GVFS_MOVE_COMMAND
GVFS command to move a file
Further Information
Click on class link to see notes and client examples.
EL_GVFS_OS_COMMAND
GIO virtual file system command
Further Information
Click on class link to see descendants and client examples.
EL_GVFS_REMOVE_FILE_COMMAND
GVFS command to remove a file
Further Information
Click on class link to see notes.
EL_GVFS_URI_COMMAND
GVFS command taking a single uri argument
Further Information
Click on class link to see notes.
EL_GVFS_URI_TRANSFER_COMMAND
GVFS command to move/copy a file
Further Information
Click on class link to see notes.
system/gsetting
EL_GET_GNOME_SETTING_COMMAND
Get gnome setting command
Further Information
Click on class link to see client examples.
EL_GNOME_SETTING_COMMAND
Gnome setting command
EL_SET_GNOME_SETTING_COMMAND
Set gnome setting command
Further Information
Click on class link to see client examples.
system/info
EL_CPU_INFO_COMMAND_I
Cross-platform command to obtain CPU model name
Further Information
Click on class link to see client examples.
EL_NOTIFY_SEND_ERROR_COMMAND_I
Sends a desktop notification warning of an error
Further Information
Click on class link to see client examples.
EL_SCREEN_SESSIONS_COMMAND
Command to obtain list of session information for the Unix screen command.
Further Information
Click on class link to see notes.
EL_USERS_INFO_COMMAND_I
Creates a list of system users that have a directory in Directory.home. For Windows this is usually C:\Users and for Linux /home
The user list is best accessed via {EL_MODULE_SYSTEM}.user_list
Copyright © 2003-2019 Finnian Reilly