| 1 | ; $Id: VBoxGuestAdditionsLog.nsh 106061 2024-09-16 14:03:52Z vboxsync $
|
|---|
| 2 | ;; @file
|
|---|
| 3 | ; VBoxGuestAdditionLog.nsh - Logging functions.
|
|---|
| 4 | ;
|
|---|
| 5 |
|
|---|
| 6 | ;
|
|---|
| 7 | ; Copyright (C) 2013-2024 Oracle and/or its affiliates.
|
|---|
| 8 | ;
|
|---|
| 9 | ; This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | ; available from https://www.virtualbox.org.
|
|---|
| 11 | ;
|
|---|
| 12 | ; This program is free software; you can redistribute it and/or
|
|---|
| 13 | ; modify it under the terms of the GNU General Public License
|
|---|
| 14 | ; as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | ; License.
|
|---|
| 16 | ;
|
|---|
| 17 | ; This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | ; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | ; General Public License for more details.
|
|---|
| 21 | ;
|
|---|
| 22 | ; You should have received a copy of the GNU General Public License
|
|---|
| 23 | ; along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | ;
|
|---|
| 25 | ; SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 26 | ;
|
|---|
| 27 |
|
|---|
| 28 | ;
|
|---|
| 29 | ; Macro for enable/disable logging
|
|---|
| 30 | ; @param "true" to enable logging, "false" to disable.
|
|---|
| 31 | ;
|
|---|
| 32 | !macro _logEnable enable
|
|---|
| 33 |
|
|---|
| 34 | ${If} ${enable} == "true"
|
|---|
| 35 | LogSet on
|
|---|
| 36 | ${LogVerbose} "Started logging into separate file"
|
|---|
| 37 | ${Else}
|
|---|
| 38 | ${LogVerbose} "Stopped logging into separate file"
|
|---|
| 39 | LogSet off
|
|---|
| 40 | ${EndIf}
|
|---|
| 41 |
|
|---|
| 42 | !macroend
|
|---|
| 43 | !define LogEnable "!insertmacro _logEnable"
|
|---|
| 44 |
|
|---|
| 45 | ;
|
|---|
| 46 | ; Macro for (verbose) logging
|
|---|
| 47 | ; @param Text to log.
|
|---|
| 48 | ;
|
|---|
| 49 | !macro _logVerbose text
|
|---|
| 50 |
|
|---|
| 51 | LogText "${text}"
|
|---|
| 52 | IfSilent +2
|
|---|
| 53 | DetailPrint "${text}"
|
|---|
| 54 |
|
|---|
| 55 | !macroend
|
|---|
| 56 | !define LogVerbose "!insertmacro _logVerbose"
|
|---|
| 57 |
|
|---|
| 58 | ;
|
|---|
| 59 | ; Sends a logging text to the running instance of VBoxTray
|
|---|
| 60 | ; which then presents to text via balloon popup in the system tray (if enabled).
|
|---|
| 61 | ;
|
|---|
| 62 | ; @param Message type (0=Info, 1=Warning, 2=Error).
|
|---|
| 63 | ; @param Message text.
|
|---|
| 64 | ;
|
|---|
| 65 | ; @todo Add message timeout as parameter.
|
|---|
| 66 | ;
|
|---|
| 67 | !macro _logToVBoxTray type text
|
|---|
| 68 |
|
|---|
| 69 | ${LogVerbose} "To VBoxTray: ${text}"
|
|---|
| 70 | !if $%VBOX_WITH_GUEST_INSTALL_HELPER% == "1"
|
|---|
| 71 | Push $0
|
|---|
| 72 | ; Parameters:
|
|---|
| 73 | ; - String: Description / Body
|
|---|
| 74 | ; - String: Title / Name of application
|
|---|
| 75 | ; - Integer: Type of message: 1 (Info), 2 (Warning), 3 (Error)
|
|---|
| 76 | ; - Integer: Time (in msec) to show the notification
|
|---|
| 77 | VBoxGuestInstallHelper::VBoxTrayShowBallonMsg "${text}" "VirtualBox Guest Additions Setup" ${type} 5000
|
|---|
| 78 | Pop $0 ; Get return value (ignored for now)
|
|---|
| 79 | Pop $0 ; Restore original $0 from stack
|
|---|
| 80 | !endif
|
|---|
| 81 |
|
|---|
| 82 | !macroend
|
|---|
| 83 | !define LogToVBoxTray "!insertmacro _logToVBoxTray"
|
|---|
