NSIS Wiki - User contributions [en]

Logging: Simple Text File Logging Functions and Macros

2005-12-26T05:17:38Z

MikeSchinkel: Fixed omission in MyInstallLog.txt

{{PageAuthor|MikeSchinkel}}

== Description ==
This code provides an simple set of macros for creating a text log. Also, you can examine the log file written by the example code to see what order code is executed by NSIS.

== How To Use ==
The is the example code that uses TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

!include "textlog.nsh"

OutFile "test.exe"

# This so the log will be written to same dir as the test file.
# NOT recommended for actual installation files.
InstallDir "$EXEDIR"

Page custom OnCustom AfterCustom
Page components
Page instfiles
Page custom ShowLog

Function .onInit
${LogSetFileName} "$INSTDIR\MyInstallLog.txt"
${LogSetOn}
${LogText} "In .onInit"
FunctionEnd

Function OnCustom
${LogText} "In Function OnCustom"
FunctionEnd

Function AfterCustom
${LogText} "In Function AfterCustom"
FunctionEnd

Section one
${LogText} "In Section One"
SectionEnd

Section two
${LogText} "In Section Two"
SectionEnd

Section three
${LogText} "In Section Three"
SectionEnd

Function ShowLog
${LogText} "In Function ShowLog"
ExecShell "open" "$INSTDIR\MyInstallLog.txt"
FunctionEnd

Section "-CleanUp"
${LogText} "In Section -CleanUp"
${LogSetOff}
SectionEnd
</highlight-nsis>

This is the result that gets written to "$INSTDIR\MyInstallLog.txt" when running the previous example:

<highlight-nsis>
In .onInit
In Function OnCustom
In Section One
In Section Two
In Section Three
In Section -CleanUp
</highlight-nsis>

And this is the macro file TextLog.nsh:

<highlight-nsis>
# TextLog.nsh v1.1 - 2005-12-26
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]

Var /GLOBAL __TextLog_FileHandle
Var /GLOBAL __TextLog_FileName
Var /GLOBAL __TextLog_State

!define LogText '!insertmacro LogTextCall'
!macro LogTextCall _text
Push "${_text}"
Call LogText
!macroend

Function LogText
Push $0 ; pABC -> 0pABC
Exch ; 0pABC -> p0ABC
Pop $0 ; p0ABC -> 0ABC
FileWrite $__TextLog_FileHandle "$0$\r$\n"
Pop $0 ; 0ABC -> ABC
FunctionEnd

!define LogSetFileName '!insertmacro LogSetFileNameCall'
!macro LogSetFileNameCall _filename
Push "${_filename}"
Call LogSetFileName
!macroend

Function LogSetFileName
Push $0 ; pABC -> 0pABC
Exch ; 0pABC -> p0ABC
Pop $0 ; p0ABC -> 0ABC
StrCpy $__TextLog_FileName "$0"
StrCmp $__TextLog_State "open" +1 +3
Call LogSetOff
Call LogSetOn
Pop $0 ; 0ABC -> ABC
FunctionEnd

!define LogSetOn '!insertmacro LogSetOnCall'
!macro LogSetOnCall
Call LogSetOn
!macroend

Function LogSetOn
StrCmp $__TextLog_FileName "" +1 AlreadySet
StrCpy $__TextLog_FileName "$INSTDIR\install.log"
AlreadySet:
StrCmp $__TextLog_State "open" +2
FileOpen $__TextLog_FileHandle "$__TextLog_FileName" a
StrCpy $__TextLog_State "open"
FunctionEnd

!define LogSetOff '!insertmacro LogSetOffCall'
!macro LogSetOffCall
Call LogSetOff
!macroend

Function LogSetOff
StrCmp $__TextLog_State "open" +1 +2
FileClose $__TextLog_FileHandle
StrCpy $__TextLog_State ""
FunctionEnd
</highlight-nsis>

Written by [[user:MikeSchinkel|MikeSchinkel]].

[[Category:Logging Functions]]

Logging: Simple Text File Logging Macro

2005-12-26T05:07:20Z

MikeSchinkel: Logging: Simple Text File Logging Macro moved to Logging: Simple Text File Logging Functions and Macros

#redirect [[Logging: Simple Text File Logging Functions and Macros]]

Logging: Simple Text File Logging Functions and Macros

2005-12-26T05:07:20Z

MikeSchinkel: Logging: Simple Text File Logging Macro moved to Logging: Simple Text File Logging Functions and Macros

{{PageAuthor|MikeSchinkel}}

== Description ==
This code provides an simple set of macros for creating a text log. Also, you can examine the log file written by the example code to see what order code is executed by NSIS.

== How To Use ==
The is the example code that uses TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

!include "textlog.nsh"

OutFile "test.exe"

# This so the log will be written to same dir as the test file.
# NOT recommended for actual installation files.
InstallDir "$EXEDIR"

Page custom OnCustom AfterCustom
Page components
Page instfiles
Page custom ShowLog

Function .onInit
${LogSetFileName} "$INSTDIR\MyInstallLog.txt"
${LogSetOn}
${LogText} "In .onInit"
FunctionEnd

Function OnCustom
${LogText} "In Function OnCustom"
FunctionEnd

Function AfterCustom
${LogText} "In Function AfterCustom"
FunctionEnd

Section one
${LogText} "In Section One"
SectionEnd

Section two
${LogText} "In Section Two"
SectionEnd

Section three
${LogText} "In Section Three"
SectionEnd

Function ShowLog
${LogText} "In Function ShowLog"
ExecShell "open" "$INSTDIR\MyInstallLog.txt"
FunctionEnd

Section "-CleanUp"
${LogText} "In Section -CleanUp"
${LogSetOff}
SectionEnd
</highlight-nsis>

This is the result that gets written to "$INSTDIR\MyInstallLog.txt" when running the previous example:

<highlight-nsis>
In .onInit
In Function OnCustom
In Section One
In Section Three
In Section -CleanUp
</highlight-nsis>

And this is the macro file TextLog.nsh:

<highlight-nsis>
# TextLog.nsh v1.1 - 2005-12-26
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]

Var /GLOBAL __TextLog_FileHandle
Var /GLOBAL __TextLog_FileName
Var /GLOBAL __TextLog_State

!define LogText '!insertmacro LogTextCall'
!macro LogTextCall _text
Push "${_text}"
Call LogText
!macroend

Function LogText
Push $0 ; pABC -> 0pABC
Exch ; 0pABC -> p0ABC
Pop $0 ; p0ABC -> 0ABC
FileWrite $__TextLog_FileHandle "$0$\r$\n"
Pop $0 ; 0ABC -> ABC
FunctionEnd

!define LogSetFileName '!insertmacro LogSetFileNameCall'
!macro LogSetFileNameCall _filename
Push "${_filename}"
Call LogSetFileName
!macroend

Function LogSetFileName
Push $0 ; pABC -> 0pABC
Exch ; 0pABC -> p0ABC
Pop $0 ; p0ABC -> 0ABC
StrCpy $__TextLog_FileName "$0"
StrCmp $__TextLog_State "open" +1 +3
Call LogSetOff
Call LogSetOn
Pop $0 ; 0ABC -> ABC
FunctionEnd

!define LogSetOn '!insertmacro LogSetOnCall'
!macro LogSetOnCall
Call LogSetOn
!macroend

Function LogSetOn
StrCmp $__TextLog_FileName "" +1 AlreadySet
StrCpy $__TextLog_FileName "$INSTDIR\install.log"
AlreadySet:
StrCmp $__TextLog_State "open" +2
FileOpen $__TextLog_FileHandle "$__TextLog_FileName" a
StrCpy $__TextLog_State "open"
FunctionEnd

!define LogSetOff '!insertmacro LogSetOffCall'
!macro LogSetOffCall
Call LogSetOff
!macroend

Function LogSetOff
StrCmp $__TextLog_State "open" +1 +2
FileClose $__TextLog_FileHandle
StrCpy $__TextLog_State ""
FunctionEnd
</highlight-nsis>

Written by [[user:MikeSchinkel|MikeSchinkel]].

[[Category:Logging Functions]]

Logging: Simple Text File Logging Functions and Macros

2005-12-26T05:04:55Z

MikeSchinkel: Rearchitected to fix bug, removed categories

{{PageAuthor|MikeSchinkel}}

== Description ==
This code provides an simple set of macros for creating a text log. Also, you can examine the log file written by the example code to see what order code is executed by NSIS.

== How To Use ==
The is the example code that uses TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

!include "textlog.nsh"

OutFile "test.exe"

# This so the log will be written to same dir as the test file.
# NOT recommended for actual installation files.
InstallDir "$EXEDIR"

Page custom OnCustom AfterCustom
Page components
Page instfiles
Page custom ShowLog

Function .onInit
${LogSetFileName} "$INSTDIR\MyInstallLog.txt"
${LogSetOn}
${LogText} "In .onInit"
FunctionEnd

Function OnCustom
${LogText} "In Function OnCustom"
FunctionEnd

Function AfterCustom
${LogText} "In Function AfterCustom"
FunctionEnd

Section one
${LogText} "In Section One"
SectionEnd

Section two
${LogText} "In Section Two"
SectionEnd

Section three
${LogText} "In Section Three"
SectionEnd

Function ShowLog
${LogText} "In Function ShowLog"
ExecShell "open" "$INSTDIR\MyInstallLog.txt"
FunctionEnd

Section "-CleanUp"
${LogText} "In Section -CleanUp"
${LogSetOff}
SectionEnd
</highlight-nsis>

This is the result that gets written to "$INSTDIR\MyInstallLog.txt" when running the previous example:

<highlight-nsis>
In .onInit
In Function OnCustom
In Section One
In Section Three
In Section -CleanUp
</highlight-nsis>

And this is the macro file TextLog.nsh:

<highlight-nsis>
# TextLog.nsh v1.1 - 2005-12-26
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]

Var /GLOBAL __TextLog_FileHandle
Var /GLOBAL __TextLog_FileName
Var /GLOBAL __TextLog_State

!define LogText '!insertmacro LogTextCall'
!macro LogTextCall _text
Push "${_text}"
Call LogText
!macroend

Function LogText
Push $0 ; pABC -> 0pABC
Exch ; 0pABC -> p0ABC
Pop $0 ; p0ABC -> 0ABC
FileWrite $__TextLog_FileHandle "$0$\r$\n"
Pop $0 ; 0ABC -> ABC
FunctionEnd

!define LogSetFileName '!insertmacro LogSetFileNameCall'
!macro LogSetFileNameCall _filename
Push "${_filename}"
Call LogSetFileName
!macroend

Function LogSetFileName
Push $0 ; pABC -> 0pABC
Exch ; 0pABC -> p0ABC
Pop $0 ; p0ABC -> 0ABC
StrCpy $__TextLog_FileName "$0"
StrCmp $__TextLog_State "open" +1 +3
Call LogSetOff
Call LogSetOn
Pop $0 ; 0ABC -> ABC
FunctionEnd

!define LogSetOn '!insertmacro LogSetOnCall'
!macro LogSetOnCall
Call LogSetOn
!macroend

Function LogSetOn
StrCmp $__TextLog_FileName "" +1 AlreadySet
StrCpy $__TextLog_FileName "$INSTDIR\install.log"
AlreadySet:
StrCmp $__TextLog_State "open" +2
FileOpen $__TextLog_FileHandle "$__TextLog_FileName" a
StrCpy $__TextLog_State "open"
FunctionEnd

!define LogSetOff '!insertmacro LogSetOffCall'
!macro LogSetOffCall
Call LogSetOff
!macroend

Function LogSetOff
StrCmp $__TextLog_State "open" +1 +2
FileClose $__TextLog_FileHandle
StrCpy $__TextLog_State ""
FunctionEnd
</highlight-nsis>

Written by [[user:MikeSchinkel|MikeSchinkel]].

[[Category:Logging Functions]]

Logging: Simple Text File Logging Functions and Macros

2005-12-23T08:18:53Z

MikeSchinkel: Added categories

{{PageAuthor|MikeSchinkel}}

== Description ==
This code provides an simple set of macros for creating a text log. Also, you can examine the log file written by the example code to see what order code is executed by NSIS.

== How To Use ==
The is the example code that uses TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

!include "textlog.nsh"

OutFile "test.exe"

# This so the log will be written to same dir as the test file.
# NOT recommended for actual installation files.
InstallDir "$EXEDIR"

Page custom OnCustom AfterCustom
Page components
Page instfiles
Page custom ShowLog

Function .onInit
${LogSetFileName} "$INSTDIR\MyInstallLog.txt"
${LogSetOn}
${LogText} "In .onInit"
FunctionEnd

Function OnCustom
${LogText} "In Function OnCustom"
FunctionEnd

Function AfterCustom
${LogText} "In Function AfterCustom"
FunctionEnd

Section one
${LogText} "In Section One"
SectionEnd

Section two
${LogText} "In Section Two"
SectionEnd

Section three
${LogText} "In Section Three"
SectionEnd

Function ShowLog
${LogText} "In Function ShowLog"
ExecShell "open" "$INSTDIR\MyInstallLog.txt"
FunctionEnd

Section "-CleanUp"
${LogText} "In Section -CleanUp"
${LogSetOff}
SectionEnd
</highlight-nsis>

This is the result that gets written to "$INSTDIR\MyInstallLog.txt" when running the previous example:

<highlight-nsis>
In .onInit
In Function OnCustom
In Section One
In Section Three
In Section -CleanUp
</highlight-nsis>

And this is the macro file TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

Var /GLOBAL __TextLogFileHandle
Var /GLOBAL __TextLogFileName
Var /GLOBAL __TextLogState

!define LogText '!insertmacro LOG_TEXT'
!define LogSetFileName '!insertmacro LOG_SET_FILE_NAME'
!define LogSetOn '!insertmacro LOG_SET_ON'
!define LogSetOff '!insertmacro LOG_SET_OFF'

!macro LOG_TEXT TEXT
FileWrite $__TextLogFileHandle "${TEXT}$\r$\n"
!macroend

!macro LOG_SET_FILE_NAME filename
StrCpy $__TextLogFileName "${filename}"
StrCmp $__TextLogState "open" +1 +3
!insertmacro LOG_SET_OFF
!insertmacro LOG_SET_ON
!macroend

!macro LOG_SET_ON
!define UniqueID ${__LINE__}
StrCmp $__TextLogFileName "" +1 AlreadySet_${UniqueID}
StrCpy $__TextLogFileName "$INSTDIR\install.log"
AlreadySet_${UniqueID}:
StrCmp $__TextLogState "open" +2
FileOpen $__TextLogFileHandle "$__TextLogFileName" a
StrCpy $__TextLogState "open"
!undef UniqueID
!macroend

!macro LOG_SET_OFF
StrCmp $__TextLogState "open" +1 +2
FileClose $__TextLogFileHandle
StrCpy $__TextLogState ""
!macroend
</highlight-nsis>

Written by [[user:MikeSchinkel|MikeSchinkel]].

[[Category:Code Examples]]
[[Category:Logging Functions]]
[[Category:Functions & Macros]]

Macro For Simple Text File Log

2005-12-23T08:16:45Z

MikeSchinkel: Macro For Simple Text File Log moved to Logging: Simple Text File Logging Macro: To show up in a more appropriate location in Category

#redirect [[Logging: Simple Text File Logging Macro]]

Logging: Simple Text File Logging Functions and Macros

2005-12-23T08:16:45Z

MikeSchinkel: Macro For Simple Text File Log moved to Logging: Simple Text File Logging Macro

{{PageAuthor|MikeSchinkel}}

== Description ==
This code provides an simple set of macros for creating a text log. Also, you can examine the log file written by the example code to see what order code is executed by NSIS.

== How To Use ==
The is the example code that uses TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

!include "textlog.nsh"

OutFile "test.exe"

# This so the log will be written to same dir as the test file.
# NOT recommended for actual installation files.
InstallDir "$EXEDIR"

Page custom OnCustom AfterCustom
Page components
Page instfiles
Page custom ShowLog

Function .onInit
${LogSetFileName} "$INSTDIR\MyInstallLog.txt"
${LogSetOn}
${LogText} "In .onInit"
FunctionEnd

Function OnCustom
${LogText} "In Function OnCustom"
FunctionEnd

Function AfterCustom
${LogText} "In Function AfterCustom"
FunctionEnd

Section one
${LogText} "In Section One"
SectionEnd

Section two
${LogText} "In Section Two"
SectionEnd

Section three
${LogText} "In Section Three"
SectionEnd

Function ShowLog
${LogText} "In Function ShowLog"
ExecShell "open" "$INSTDIR\MyInstallLog.txt"
FunctionEnd

Section "-CleanUp"
${LogText} "In Section -CleanUp"
${LogSetOff}
SectionEnd
</highlight-nsis>

This is the result that gets written to "$INSTDIR\MyInstallLog.txt" when running the previous example:

<highlight-nsis>
In .onInit
In Function OnCustom
In Section One
In Section Three
In Section -CleanUp
</highlight-nsis>

And this is the macro file TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

Var /GLOBAL __TextLogFileHandle
Var /GLOBAL __TextLogFileName
Var /GLOBAL __TextLogState

!define LogText '!insertmacro LOG_TEXT'
!define LogSetFileName '!insertmacro LOG_SET_FILE_NAME'
!define LogSetOn '!insertmacro LOG_SET_ON'
!define LogSetOff '!insertmacro LOG_SET_OFF'

!macro LOG_TEXT TEXT
FileWrite $__TextLogFileHandle "${TEXT}$\r$\n"
!macroend

!macro LOG_SET_FILE_NAME filename
StrCpy $__TextLogFileName "${filename}"
StrCmp $__TextLogState "open" +1 +3
!insertmacro LOG_SET_OFF
!insertmacro LOG_SET_ON
!macroend

!macro LOG_SET_ON
!define UniqueID ${__LINE__}
StrCmp $__TextLogFileName "" +1 AlreadySet_${UniqueID}
StrCpy $__TextLogFileName "$INSTDIR\install.log"
AlreadySet_${UniqueID}:
StrCmp $__TextLogState "open" +2
FileOpen $__TextLogFileHandle "$__TextLogFileName" a
StrCpy $__TextLogState "open"
!undef UniqueID
!macroend

!macro LOG_SET_OFF
StrCmp $__TextLogState "open" +1 +2
FileClose $__TextLogFileHandle
StrCpy $__TextLogState ""
!macroend
</highlight-nsis>

Written by [[user:MikeSchinkel|MikeSchinkel]].

[[Category:Code Examples]]

Logging: Simple Text File Logging Functions and Macros

2005-12-23T08:15:17Z

MikeSchinkel: Initial Version

{{PageAuthor|MikeSchinkel}}

== Description ==
This code provides an simple set of macros for creating a text log. Also, you can examine the log file written by the example code to see what order code is executed by NSIS.

== How To Use ==
The is the example code that uses TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

!include "textlog.nsh"

OutFile "test.exe"

# This so the log will be written to same dir as the test file.
# NOT recommended for actual installation files.
InstallDir "$EXEDIR"

Page custom OnCustom AfterCustom
Page components
Page instfiles
Page custom ShowLog

Function .onInit
${LogSetFileName} "$INSTDIR\MyInstallLog.txt"
${LogSetOn}
${LogText} "In .onInit"
FunctionEnd

Function OnCustom
${LogText} "In Function OnCustom"
FunctionEnd

Function AfterCustom
${LogText} "In Function AfterCustom"
FunctionEnd

Section one
${LogText} "In Section One"
SectionEnd

Section two
${LogText} "In Section Two"
SectionEnd

Section three
${LogText} "In Section Three"
SectionEnd

Function ShowLog
${LogText} "In Function ShowLog"
ExecShell "open" "$INSTDIR\MyInstallLog.txt"
FunctionEnd

Section "-CleanUp"
${LogText} "In Section -CleanUp"
${LogSetOff}
SectionEnd
</highlight-nsis>

This is the result that gets written to "$INSTDIR\MyInstallLog.txt" when running the previous example:

<highlight-nsis>
In .onInit
In Function OnCustom
In Section One
In Section Three
In Section -CleanUp
</highlight-nsis>

And this is the macro file TextLog.nsh:

<highlight-nsis>
# TextLog.nsh
# Written by Mike Schinkel [http://www.mikeschinkel.com/blog/]
# 12/23/2005

Var /GLOBAL __TextLogFileHandle
Var /GLOBAL __TextLogFileName
Var /GLOBAL __TextLogState

!define LogText '!insertmacro LOG_TEXT'
!define LogSetFileName '!insertmacro LOG_SET_FILE_NAME'
!define LogSetOn '!insertmacro LOG_SET_ON'
!define LogSetOff '!insertmacro LOG_SET_OFF'

!macro LOG_TEXT TEXT
FileWrite $__TextLogFileHandle "${TEXT}$\r$\n"
!macroend

!macro LOG_SET_FILE_NAME filename
StrCpy $__TextLogFileName "${filename}"
StrCmp $__TextLogState "open" +1 +3
!insertmacro LOG_SET_OFF
!insertmacro LOG_SET_ON
!macroend

!macro LOG_SET_ON
!define UniqueID ${__LINE__}
StrCmp $__TextLogFileName "" +1 AlreadySet_${UniqueID}
StrCpy $__TextLogFileName "$INSTDIR\install.log"
AlreadySet_${UniqueID}:
StrCmp $__TextLogState "open" +2
FileOpen $__TextLogFileHandle "$__TextLogFileName" a
StrCpy $__TextLogState "open"
!undef UniqueID
!macroend

!macro LOG_SET_OFF
StrCmp $__TextLogState "open" +1 +2
FileClose $__TextLogFileHandle
StrCpy $__TextLogState ""
!macroend
</highlight-nsis>

Written by [[user:MikeSchinkel|MikeSchinkel]].

[[Category:Code Examples]]