File indexing completed on 2024-04-28 09:43:51

 /*
     SPDX-FileCopyrightText: 2016 ROSA
     SPDX-License-Identifier: GPL-3.0-or-later
 */
 
 #ifndef COMMON_H
 #define COMMON_H
 
 ////////////////////////////////////////////////////////////////////////////////
 // This file contains some commonly-used constants and function declarations
 
 #include <QDebug>
 #include <QObject>
 #include <QString>
 #include <QLoggingCategory>
 
 #include <type_traits>
 
 #include "platform.h"
 
 class UsbDevice;
 
 // Default unit to be used when displaying file/device sizes (MB)
 const quint64 DEFAULT_UNIT = 1048576;
 
 // Application name used for titles in messageboxes
 const QString ApplicationTitle = "ISO Image Writer";
 
 // Pointer to correctly typed application instance
 #define mApp (static_cast<MainApplication*>qApp)
 
 // Returns the number of blocks required to contain some number of bytes
 // Input:
 //  T      - any integer type
 //  val    - number of bytes
 //  factor - size of the block
 // Returns:
 //  the number of blocks of size <factor> required for <val> to fit in
 template <typename T> T alignNumberDiv(T val, T factor)
 {
     static_assert(std::is_integral<T>::value, "Only integer types are supported!");
     return ((val + factor - 1) / factor);
 }
 
 // Returns the total size of blocks required to contain some number of bytes
 // Input:
 //  T      - any integer type
 //  val    - number of bytes
 //  factor - size of the block
 // Returns:
 //  the total size of blocks of size <factor> required for <val> to fit in
 template <typename T> T alignNumber(T val, T factor)
 {
     static_assert(std::is_integral<T>::value, "Only integer types are supported!");
     return alignNumberDiv(val, factor) * factor;
 }
 
 #if defined(Q_OS_WIN32)
 // Converts the WinAPI and COM error code into text message
 // Input:
 //  errorCode - error code (GetLastError() is used by default)
 // Returns:
 //  system error message for the errorCode
 QString errorMessageFromCode(DWORD errorCode = GetLastError());
 
 // Converts the WinAPI and COM error code into text message
 // Input:
 //  prefixMessage - error description
 //  errorCode     - error code (GetLastError() is used by default)
 // Returns:
 //  prefixMessage followed by a newline and the system error message for the errorCode
 QString formatErrorMessageFromCode(QString prefixMessage, DWORD errorCode = GetLastError());
 #endif
 
 // Gets the contents of the specified file
 // Input:
 //  fileName - path to the file to read
 // Returns:
 //  the file contents or empty string if an error occurred
 QString readFileContents(const QString& fileName);
 
 // Callback function type for platformEnumFlashDevices (see below)
 // Input:
 //  cbParam        - parameter passed to the enumeration function
 //  DeviceVendor   - vendor of the USB device
 //  DeviceName     - name of the USB device
 //  PhysicalDevice - OS-specific path to the physical device
 //  Volumes        - list of volumes this device contains
 //  NumVolumes     - number of volumes in the list
 //  Size           - size of the disk in bytes
 //  SectorSize     - sector size of the device
 // Returns:
 //  nothing
 typedef void (*AddFlashDeviceCallbackProc)(void* cbParam, UsbDevice* device);
 
 // Performs platform-specific enumeration of USB flash disks and calls the callback
 // function for adding these devices into the application GUI structure
 // Input:
 //  callback - callback function to be called for each new device
 //  cbParam  - parameter to be passed to this callback function
 // Returns:
 //  true if enumeration completed successfully, false otherwise
 bool platformEnumFlashDevices(AddFlashDeviceCallbackProc callback, void* cbParam);
 
 // Checks the application privileges and if they are not sufficient, restarts
 // itself requesting higher privileges
 // Input:
 //  appPath - path to the application executable
 // Returns:
 //  true if already running elevated
 //  false if error occurs
 //  does not return if elevation request succeeded (the current instance terminates)
 bool ensureElevated();
 
 #endif // COMMON_H