b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; $Id$
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;; @file
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; VBoxGuestAdditionLog.nsh - Logging functions.
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; Copyright (C) 2013 Oracle Corporation
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; This file is part of VirtualBox Open Source Edition (OSE), as
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; available from http://www.virtualbox.org. This file is free software;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; you can redistribute it and/or modify it under the terms of the GNU
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; General Public License (GPL) as published by the Free Software
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; Foundation, in version 2 as it comes in the "COPYING" file of the
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; VirtualBox OSE distribution. VirtualBox OSE is distributed in the
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; Macro for enable/disable logging
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; @param "true" to enable logging, "false" to disable.
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!macro _logEnable enable
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ${If} ${enable} == "true"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync LogSet on
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ${LogVerbose} "Started logging into separate file"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ${Else}
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ${LogVerbose} "Stopped logging into separate file"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync LogSet off
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ${EndIf}
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!macroend
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!define LogEnable "!insertmacro _logEnable"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; Macro for (verbose) logging
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; @param Text to log.
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!macro _logVerbose text
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
3af289fb9126c91f28ede0dcb3429da0de12b94evboxsync LogText "${text}"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync IfSilent +2
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync DetailPrint "${text}"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!macroend
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!define LogVerbose "!insertmacro _logVerbose"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; Sends a logging text to the running instance of VBoxTray
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; which then presents to text via balloon popup in the system tray (if enabled).
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; @param Message type (0=Info, 1=Warning, 2=Error).
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; @param Message text.
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync; @todo Add message timeout as parameter.
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync;
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!macro _logToVBoxTray type text
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ${LogVerbose} "${text}"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!if $%VBOX_WITH_GUEST_INSTALL_HELPER% == "1"
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync Push $0
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ; Parameters:
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ; - String: Description / Body
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ; - String: Title / Name of application
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ; - Integer: Type of message: 0 (Info), 1 (Warning), 2 (Error)
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync ; - Integer: Time (in msec) to show the notification
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync VBoxGuestInstallHelper::VBoxTrayShowBallonMsg "${text}" "VirtualBox Guest Additions Setup" ${type} 5000
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync Pop $0 ; Get return value (ignored for now)
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync Pop $0 ; Restore original $0 from stack
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!endif
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!macroend
b0cec57d51e48736a3303366c728c3f025e8e81bvboxsync!define LogToVBoxTray "!insertmacro _logToVBoxTray"