|
glibmm 2.80.0
|
Miscellaneous Utility Functions – a selection of portable utility functions. More...
Functions | |
| Glib::ustring | Glib::get_application_name () |
| Gets a human-readable name for the application, as set by Glib::set_application_name(). | |
| void | Glib::set_application_name (UStringView application_name) |
| Sets a human-readable name for the application. | |
| std::string | Glib::get_prgname () |
| Gets the name of the program. | |
| void | Glib::set_prgname (StdStringView prgname) |
| Sets the name of the program. | |
| std::string | Glib::getenv (StdStringView variable, bool & found) |
| Returns the value of an environment variable. | |
| std::string | Glib::getenv (StdStringView variable) |
| Returns the value of an environment variable. | |
| bool | Glib::setenv (StdStringView variable, StdStringView value, bool overwrite=true) |
| Sets an environment variable. | |
| void | Glib::unsetenv (StdStringView variable) |
| Removes an environment variable from the environment. | |
| std::vector< std::string > | Glib::listenv () |
| Gets the names of all variables set in the environment. | |
| std::string | Glib::get_user_name () |
| Gets the user name of the current user. | |
| std::string | Glib::get_real_name () |
| Gets the real name of the current user. | |
| Glib::ustring | Glib::get_host_name () |
| Return a name for the machine. | |
| std::string | Glib::get_home_dir () |
| Gets the current user's home directory. | |
| std::string | Glib::get_tmp_dir () |
| Gets the directory to use for temporary files. | |
| std::string | Glib::get_current_dir () |
| Gets the current directory. | |
| std::string | Glib::get_user_special_dir (UserDirectory directory) |
| Returns the full path of a special directory using its logical id. | |
| std::string | Glib::get_user_data_dir () |
| Returns a base directory in which to access application data such as icons that is customized for a particular user. | |
| std::string | Glib::get_user_config_dir () |
| Returns a base directory in which to store user-specific application configuration information such as user preferences and settings. | |
| std::vector< std::string > | Glib::get_system_data_dirs () |
| Returns an ordered list of base directories in which to access system-wide application data. | |
| std::vector< std::string > | Glib::get_system_config_dirs () |
| Returns an ordered list of base directories in which to access system-wide configuration information. | |
| std::string | Glib::get_user_cache_dir () |
| Returns a base directory in which to store non-essential, cached data specific to particular user. | |
| std::string | Glib::get_user_runtime_dir () |
| Returns a directory that is unique to the current user on the local system. | |
| bool | Glib::path_is_absolute (StdStringView filename) |
Returns true if the given filename is an absolute file name, i.e. it contains a full path from the root directory such as "/usr/local" on UNIX or "C:\\windows" on Windows systems. | |
| std::string | Glib::path_skip_root (StdStringView filename) |
Returns the remaining part of filename after the root component, i.e. after the "/" on UNIX or "C:\\" on Windows. | |
| std::string | Glib::path_get_basename (StdStringView filename) |
| Gets the name of the file without any leading directory components. | |
| std::string | Glib::path_get_dirname (StdStringView filename) |
| Gets the directory components of a file name. | |
| std::string | Glib::canonicalize_filename (StdStringView filename, StdStringView relative_to=nullptr) |
| Gets the canonical file name from filename. | |
| std::string | Glib::build_filename (const std::vector< std::string > & elements) |
| Creates a filename from a series of elements using the correct separator for filenames. | |
| template<typename... Strings> | |
| std::string | Glib::build_filename (const Strings &... strings) |
| Creates a filename from one or more elements using the correct separator for filenames. | |
| std::string | Glib::build_path (const std::string & separator, const std::vector< std::string > & elements) |
| Creates a path from a series of elements using separator as the separator between elements. | |
| std::string | Glib::find_program_in_path (StdStringView program) |
Locates the first executable named program in the user's path, in the same way that execvp() would locate it. | |
| Glib::ustring | Glib::format_size (guint64 size, FormatSizeFlags flags=FormatSizeFlags::DEFAULT) |
| Formats a size (for example the size of a file) into a human readable string. | |
Miscellaneous Utility Functions – a selection of portable utility functions.
| std::string Glib::build_filename | ( | const std::vector< std::string > & | elements | ) |
Creates a filename from a series of elements using the correct separator for filenames.
This function behaves identically to Glib::build_path(G_DIR_SEPARATOR_S, elements). No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path.
| elements | A vector holding the elements of the path to build. |
| std::string Glib::build_filename | ( | const Strings &... | strings | ) |
Creates a filename from one or more elements using the correct separator for filenames.
No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path.
| Strings | std::string or const char*. |
| strings | The path elements. |
| std::string Glib::build_path | ( | const std::string & | separator, |
| const std::vector< std::string > & | elements | ||
| ) |
Creates a path from a series of elements using separator as the separator between elements.
At the boundary between two elements, any trailing occurrences of separator in the first element, or leading occurrences of separator in the second element are removed and exactly one copy of the separator is inserted.
Empty elements are ignored.
The number of leading copies of the separator on the result is the same as the number of leading copies of the separator on the first non-empty element.
The number of trailing copies of the separator on the result is the same as the number of trailing copies of the separator on the last non-empty element. (Determination of the number of trailing copies is done without stripping leading copies, so if the separator is "ABA", "ABABA" has 1 trailing copy.)
However, if there is only a single non-empty element, and there are no characters in that element not part of the leading or trailing separators, then the result is exactly the original value of that element.
Other than for determination of the number of leading and trailing copies of the separator, elements consisting only of copies of the separator are ignored.
| separator | A string used to separate the elements of the path. |
| elements | A vector holding the elements of the path to build. |
| std::string Glib::canonicalize_filename | ( | StdStringView | filename, |
| StdStringView | relative_to = nullptr |
||
| ) |
Gets the canonical file name from filename.
All triple slashes are turned into single slashes, and all .. and .s resolved against relative_to.
Symlinks are not followed, and the returned path is guaranteed to be absolute.
If filename is an absolute path, relative_to is ignored. Otherwise, relative_to will be prepended to filename to make it absolute. relative_to must be an absolute path, or nullptr. If relative_to is nullptr, it'll fallback to get_current_dir().
This function never fails, and will canonicalize file paths even if they don't exist.
No file system I/O is done.
| filename | The name of the file. |
| relative_to | The relative directory, or nullptr to use the current working directory. |
| std::string Glib::find_program_in_path | ( | StdStringView | program | ) |
Locates the first executable named program in the user's path, in the same way that execvp() would locate it.
Returns a string with the absolute path name, or "" if the program is not found in the path. If program is already an absolute path, returns a copy of program if program exists and is executable, and "" otherwise.
On Windows, if program does not have a file type suffix, tries to append the suffixes in the PATHEXT environment variable (if that doesn't exist, the suffixes .com, .exe, and .bat) in turn, and then look for the resulting file name in the same way as CreateProcess() would. This means first in the directory where the program was loaded from, then in the current directory, then in the Windows 32-bit system directory, then in the Windows directory, and finally in the directories in the PATH environment variable. If the program is found, the return value contains the full name including the type suffix.
| program | A program name. |
"". | Glib::ustring Glib::format_size | ( | guint64 | size, |
| FormatSizeFlags | flags = FormatSizeFlags::DEFAULT |
||
| ) |
Formats a size (for example the size of a file) into a human readable string.
Sizes are rounded to the nearest size prefix (kB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the string "3.2 MB".
The prefix units base is 1000 (i.e. 1 kB is 1000 bytes), unless the Glib::FormatSizeFlags::IEC_UNITS flag is set.
| size | A size in bytes. |
| flags | Flags to modify the output. |
| Glib::ustring Glib::get_application_name | ( | ) |
Gets a human-readable name for the application, as set by Glib::set_application_name().
This name should be localized if possible, and is intended for display to the user. Contrast with Glib::get_prgname(), which gets a non-localized name. If Glib::set_application_name() has not been called, returns the result of Glib::get_prgname() (which may be empty if Glib::set_prgname() has also not been called).
"". | std::string Glib::get_current_dir | ( | ) |
Gets the current directory.
| std::string Glib::get_home_dir | ( | ) |
Gets the current user's home directory.
| Glib::ustring Glib::get_host_name | ( | ) |
Return a name for the machine.
The returned name is not necessarily a fully-qualified domain name, or even present in DNS or some other name service at all. It need not even be unique on your local network or site, but usually it is. Callers should not rely on the return value having any specific properties like uniqueness for security purposes. Even if the name of the machine is changed while an application is running, the return value from this function does not change. If no name can be determined, a default fixed string "localhost" is returned.
| std::string Glib::get_prgname | ( | ) |
Gets the name of the program.
This name should not be localized, in contrast to get_application_name().
If you are using GDK or GTK+ the program name is set in gdk_init(), which is called by gtk_init() and therefore by the constructors of Gtk::Main and Gtk::Application. The program name is found by taking the last component of argv[0].
| std::string Glib::get_real_name | ( | ) |
Gets the real name of the current user.
This usually comes from the user's entry in the passwd file. The encoding of the returned string is subject to the same variability as noted for get_user_name(). If the real user name cannot be determined, the string "Unknown" is returned.
| std::vector< std::string > Glib::get_system_config_dirs | ( | ) |
Returns an ordered list of base directories in which to access system-wide configuration information.
On Unix platforms this is determined using the mechanisms described in the XDG Base Directory Specification.
| std::vector< std::string > Glib::get_system_data_dirs | ( | ) |
Returns an ordered list of base directories in which to access system-wide application data.
On Unix platforms this is determined using the mechanisms described in the XDG Base Directory Specification.
| std::string Glib::get_tmp_dir | ( | ) |
Gets the directory to use for temporary files.
This is found from inspecting the environment variables TMPDIR, TMP, and TEMP in that order. If none of those are defined "/tmp" is returned on UNIX and "C:\\" on Windows.
| std::string Glib::get_user_cache_dir | ( | ) |
Returns a base directory in which to store non-essential, cached data specific to particular user.
On UNIX platforms this is determined using the mechanisms described in the XDG Base Directory Specification
| std::string Glib::get_user_config_dir | ( | ) |
Returns a base directory in which to store user-specific application configuration information such as user preferences and settings.
On UNIX platforms this is determined using the mechanisms described in the XDG Base Directory Specification
| std::string Glib::get_user_data_dir | ( | ) |
Returns a base directory in which to access application data such as icons that is customized for a particular user.
On UNIX platforms this is determined using the mechanisms described in the XDG Base Directory Specification
| std::string Glib::get_user_name | ( | ) |
Gets the user name of the current user.
The encoding of the returned string is system-defined. On UNIX, it might be the preferred file name encoding, or something else, and there is no guarantee that it is ever consistent on a machine. On Windows, it is always UTF-8.
| std::string Glib::get_user_runtime_dir | ( | ) |
Returns a directory that is unique to the current user on the local system.
This is the directory specified in the XDG_RUNTIME_DIR environment variable. In the case that this variable is not set, we return the value of Glib::get_user_cache_dir(), after verifying that it exists.
| std::string Glib::get_user_special_dir | ( | UserDirectory | directory | ) |
Returns the full path of a special directory using its logical id.
On Unix this is done using the XDG special user directories. For compatibility with existing practise, Glib::USER_DIRECTORY_DESKTOP falls back to $HOME/Desktop when XDG special user directories have not been set up.
Depending on the platform, the user might be able to change the path of the special directory without requiring the session to restart; GLib will not reflect any change once the special directories are loaded.
| directory | The logical id of special directory. |
| std::string Glib::getenv | ( | StdStringView | variable | ) |
Returns the value of an environment variable.
The name and value are in the GLib file name encoding. On Unix, this means the actual bytes which might or might not be in some consistent character set and encoding. On Windows, it is in UTF-8. On Windows, in case the environment variable's value contains references to other environment variables, they are expanded.
| variable | The environment variable to get. |
"" if not found. | std::string Glib::getenv | ( | StdStringView | variable, |
| bool & | found | ||
| ) |
Returns the value of an environment variable.
The name and value are in the GLib file name encoding. On Unix, this means the actual bytes which might or might not be in some consistent character set and encoding. On Windows, it is in UTF-8. On Windows, in case the environment variable's value contains references to other environment variables, they are expanded.
| variable | The environment variable to get. | |
| [out] | found | Whether the environment variable has been found. |
"" if not found. | std::vector< std::string > Glib::listenv | ( | ) |
Gets the names of all variables set in the environment.
Programs that want to be portable to Windows should typically use this function and getenv() instead of using the environ array from the C library directly. On Windows, the strings in the environ array are in system codepage encoding, while in most of the typical use cases for environment variables in GLib-using programs you want the UTF-8 encoding that this function and getenv() provide.
| std::string Glib::path_get_basename | ( | StdStringView | filename | ) |
Gets the name of the file without any leading directory components.
| filename | The name of the file. |
| std::string Glib::path_get_dirname | ( | StdStringView | filename | ) |
Gets the directory components of a file name.
If the file name has no directory components "." is returned.
| filename | The name of the file. |
| bool Glib::path_is_absolute | ( | StdStringView | filename | ) |
Returns true if the given filename is an absolute file name, i.e. it contains a full path from the root directory such as "/usr/local" on UNIX or "C:\\windows" on Windows systems.
| filename | A file name. |
| std::string Glib::path_skip_root | ( | StdStringView | filename | ) |
Returns the remaining part of filename after the root component, i.e. after the "/" on UNIX or "C:\\" on Windows.
If filename is not an absolute path, "" will be returned.
| filename | A file name. |
"". | void Glib::set_application_name | ( | UStringView | application_name | ) |
Sets a human-readable name for the application.
This name should be localized if possible, and is intended for display to the user. Contrast with Glib::set_prgname(), which sets a non-localized name. Glib::set_prgname() will be called automatically by gtk_init(), but Glib::set_application_name() will not.
Note that for thread safety reasons, this function can only be called once.
The application name will be used in contexts such as error messages, or when displaying an application's name in the task list.
| application_name | Localized name of the application. |
| void Glib::set_prgname | ( | StdStringView | prgname | ) |
Sets the name of the program.
| prgname | The name of the program. |
| bool Glib::setenv | ( | StdStringView | variable, |
| StdStringView | value, | ||
| bool | overwrite = true |
||
| ) |
Sets an environment variable.
Both the variable's name and value should be in the GLib file name encoding. On Unix, this means that they can be any sequence of bytes. On Windows, they should be in UTF-8.
Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed.
| variable | The environment variable to set. It must not contain '='. |
| value | The value to which the variable should be set. |
| overwrite | Whether to change the variable if it already exists. |
| void Glib::unsetenv | ( | StdStringView | variable | ) |
Removes an environment variable from the environment.
Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed. Furthermore, this function can't be guaranteed to operate in a threadsafe way.
| variable | the environment variable to remove. It must not contain '='. |
1.9.8