NfUtils header file - Revision history

195.12.20.34: /* nfu.Function */

2010-06-11T16:32:02Z

nfu.Function

â† Older revision		Revision as of 16:32, 11 June 2010
Line 133:		Line 133:
	----		----
	Usage: ${nfu.Function} FunctionName io1 v1 io2 v2 io3 v3 io4 v4 io5 v5 io6 v6 io7 v7 io8 v8 io9 v9 io10 v10<br><br>		Usage: ${nfu.Function} FunctionName io1 v1 io2 v2 io3 v3 io4 v4 io5 v5 io6 v6 io7 v7 io8 v8 io9 v9 io10 v10<br><br>
	Description: This macro will add "'''Function''' ''FunctionName''" to your script, followed by the code to load parameters from the stack into the variables ''v'' (usually $0-$9, $R0-$R9, but $VARs should also work) you have specified in the parameterlist of the macro. ''io'' must be specified with '''in''' or '''out''', depending on which variable you need to hold an input parameter on entry of the function or which one is planned to hold a ~~resultvalue~~ on the end of the function. Leave unused pairs of (io/v) empty ("" "").<br>		Description: This macro will add "'''Function''' ''FunctionName''" to your script, followed by the code to load parameters from the stack into the variables ''v'' (usually $0-$9, $R0-$R9, but $VARs should also work) you have specified in the parameterlist of the macro. ''io'' must be specified with '''in''' or '''out''', depending on which variable you need to hold an input parameter on entry of the function or which one is planned to hold a result value on the end of the function. Leave unused pairs of (io/v) empty ("" "").<br>
	The macro expects that the first input parameter (the leftmost ''V''n with ''IO''n='''in''') has been pushed first onto the stack before the functioncall, and will prepare the results, so that the first output parameter has to be the first one, which has to be popped off the stack after return from the function: this order will be established by [[#nfu.!InstallFunction\|${nfu.!InstallFunction}]] to prepare the call of a function. See also [[#nfu.FunctionEnd\|${nfu.FunctionEnd}]].		The macro expects that the first input parameter (the leftmost ''V''n with ''IO''n='''in''') has been pushed first onto the stack before the functioncall, and will prepare the results, so that the first output parameter has to be the first one, which has to be popped off the stack after return from the function: this order will be established by [[#nfu.!InstallFunction\|${nfu.!InstallFunction}]] to prepare the call of a function. See also [[#nfu.FunctionEnd\|${nfu.FunctionEnd}]].
	<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' no longer need to be lowercase.		<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' no longer need to be lowercase.

Kichik: use SERVER template

2006-09-15T07:32:16Z

use SERVER template

Niteflyer: /* nfu.SetInstallerName */

2006-09-12T10:39:28Z

nfu.SetInstallerName

â† Older revision		Revision as of 10:39, 12 September 2006
Line 230:		Line 230:
	----		----
	Usage: ${nfu.SetInstallerName} InstallerName<br><br>		Usage: ${nfu.SetInstallerName} InstallerName<br><br>
	Description: Sets the installer attributes '''Name''', '''Caption''', '''Outfile''' and '''Icon''' to ''InstallerName'', ''InstallerName.exe'' and ''InstallerName.ico''. The macro checks the availibility of ''InstallerName.ico'' and sets '''Icon''' to ''Icon.ico'', if it does not exist. No '''Icon''' will be set, if none of the icons exist. The macro also (re)defines the symbol [[#nfu.myName\|nfu.myName]], which will be set to ''InstallerName'' for later use in your code.		Description: Sets the installer attributes
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.30 '''Name'''],
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.7 '''Caption'''],
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.31 '''Outfile'''] and
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.18 '''Icon'''] to
			''InstallerName'', ''InstallerName'', ''InstallerName.exe'' and ''InstallerName.ico''. The macro checks the availibility of ''InstallerName.ico'' and sets '''Icon''' to ''Icon.ico'', if it does not exist. No '''Icon''' will be set, if none of the icons exist. The macro also (re)defines the symbol [[#nfu.myName\|nfu.myName]], which will be set to ''InstallerName'' for later use in your code.
	<br>'''Note:''' This instruction has [[#Documentation\|limitations]].		<br>'''Note:''' This instruction has [[#Documentation\|limitations]].

Niteflyer: /* nfu.SetVersionInfo */

2006-09-12T10:31:48Z

nfu.SetVersionInfo

â† Older revision		Revision as of 10:31, 12 September 2006
Line 242:		Line 242:
	----		----
	Usage: ${nfu.SetVersionInfo} InstallerName Version Company Copyright Comments<br><br>		Usage: ${nfu.SetVersionInfo} InstallerName Version Company Copyright Comments<br><br>
	Description: Sets the installer attributes for the installer's version information. ''InstallerName'' will be set for the		Description: Sets the installer attributes for the [http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 installer's version information]. ''InstallerName'' will be set for the
	[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''ProductName'''],		[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''ProductName'''],
	[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''FileDescription'''],		[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''FileDescription'''],

Niteflyer: /* nfu.SetVersionInfo */

2006-09-12T10:30:07Z

nfu.SetVersionInfo

â† Older revision		Revision as of 10:30, 12 September 2006
Line 242:		Line 242:
	----		----
	Usage: ${nfu.SetVersionInfo} InstallerName Version Company Copyright Comments<br><br>		Usage: ${nfu.SetVersionInfo} InstallerName Version Company Copyright Comments<br><br>
	Description: Sets the installer attributes for the installer's version information. ''InstallerName'' will be set for the '''ProductName''', '''FileDescription''', '''InternalName''' and '''OriginalFileName'''. ''Version'' will be used for the '''ProductVersion ''' and '''FileVersion''', and may be the name of a file, whose version will be detected at compile-time, so that the installer could get the same version like the executable you want to distribute. The macro also (re)defines the symbol [[#nfu.myVersion\|nfu.myVersion]], which will be set to ''Version'' for later use in your code.		Description: Sets the installer attributes for the installer's version information. ''InstallerName'' will be set for the
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''ProductName'''],
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''FileDescription'''],
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''InternalName'''] and
			[http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''OriginalFileName'''].
			''Version'' will be used for the [http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.2 '''ProductVersion'''] and [http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.3.1 '''FileVersion'''], and may be the name of a file, whose version will be detected at compile-time, so that the installer could get the same version like the executable you want to distribute. The macro also (re)defines the symbol [[#nfu.myVersion\|nfu.myVersion]], which will be set to ''Version'' for later use in your code.
	<br>'''Note:''' This instruction has [[#Documentation\|limitations]].		<br>'''Note:''' This instruction has [[#Documentation\|limitations]].

Niteflyer at 16:23, 9 August 2006

2006-08-09T16:23:48Z

â† Older revision		Revision as of 16:23, 9 August 2006
Line 310:		Line 310:
	----		----
	Usage: ${nfu.StdLicense}<br><br>		Usage: ${nfu.StdLicense}<br><br>
	Description: This symbol contains the NSIS License without the first line for the Copyright holder (see NSIS User Manual, Appendix I).		Description: This symbol contains the NSIS License without the first line for the Copyright holder (see NSIS User Manual, [http://nsis.sourceforge.net/Docs/AppendixI.html Appendix I]).

	=== NFU_VERBOSITY ===		=== NFU_VERBOSITY ===

Niteflyer: /* nfu.Function */

2006-08-09T12:41:59Z

nfu.Function

â† Older revision		Revision as of 12:41, 9 August 2006
Line 135:		Line 135:
	Description: This macro will add "'''Function''' ''FunctionName''" to your script, followed by the code to load parameters from the stack into the variables ''v'' (usually $0-$9, $R0-$R9, but $VARs should also work) you have specified in the parameterlist of the macro. ''io'' must be specified with '''in''' or '''out''', depending on which variable you need to hold an input parameter on entry of the function or which one is planned to hold a resultvalue on the end of the function. Leave unused pairs of (io/v) empty ("" "").<br>		Description: This macro will add "'''Function''' ''FunctionName''" to your script, followed by the code to load parameters from the stack into the variables ''v'' (usually $0-$9, $R0-$R9, but $VARs should also work) you have specified in the parameterlist of the macro. ''io'' must be specified with '''in''' or '''out''', depending on which variable you need to hold an input parameter on entry of the function or which one is planned to hold a resultvalue on the end of the function. Leave unused pairs of (io/v) empty ("" "").<br>
	The macro expects that the first input parameter (the leftmost ''V''n with ''IO''n='''in''') has been pushed first onto the stack before the functioncall, and will prepare the results, so that the first output parameter has to be the first one, which has to be popped off the stack after return from the function: this order will be established by [[#nfu.!InstallFunction\|${nfu.!InstallFunction}]] to prepare the call of a function. See also [[#nfu.FunctionEnd\|${nfu.FunctionEnd}]].		The macro expects that the first input parameter (the leftmost ''V''n with ''IO''n='''in''') has been pushed first onto the stack before the functioncall, and will prepare the results, so that the first output parameter has to be the first one, which has to be popped off the stack after return from the function: this order will be established by [[#nfu.!InstallFunction\|${nfu.!InstallFunction}]] to prepare the call of a function. See also [[#nfu.FunctionEnd\|${nfu.FunctionEnd}]].
	<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' ~~are~~ no longer ~~case-sensitive~~.		<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' no longer need to be lowercase.

	=== nfu.FunctionEnd ===		=== nfu.FunctionEnd ===

Niteflyer: /* nfu.!InstallFunction */

2006-08-09T12:38:48Z

nfu.!InstallFunction

â† Older revision		Revision as of 12:38, 9 August 2006
Line 194:		Line 194:
	Before you may use these symbols, you have to add the function's code outside of		Before you may use these symbols, you have to add the function's code outside of
	any section or function by adding '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixFunctionName' to your script. Use '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixUnFunctionName', if you want to include the function in an uninstaller.		any section or function by adding '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixFunctionName' to your script. Use '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixUnFunctionName', if you want to include the function in an uninstaller.
	<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' ~~are~~ no longer ~~case-sensitive~~.		<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' no longer need to be lowercase.

	=== nfu.!InstallMacro ===		=== nfu.!InstallMacro ===

Niteflyer: /* nfu.!InstallFunction */

2006-08-09T12:32:45Z

nfu.!InstallFunction

â† Older revision		Revision as of 12:32, 9 August 2006
Line 194:		Line 194:
	Before you may use these symbols, you have to add the function's code outside of		Before you may use these symbols, you have to add the function's code outside of
	any section or function by adding '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixFunctionName' to your script. Use '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixUnFunctionName', if you want to include the function in an uninstaller.		any section or function by adding '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixFunctionName' to your script. Use '[[#nfu.!AddFunction\|${nfu.!AddFunction}]] PrefixUnFunctionName', if you want to include the function in an uninstaller.
			<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' are no longer case-sensitive.

	=== nfu.!InstallMacro ===		=== nfu.!InstallMacro ===

Niteflyer: /* nfu.Function */

2006-08-09T12:32:01Z

nfu.Function

â† Older revision		Revision as of 12:32, 9 August 2006
Line 135:		Line 135:
	Description: This macro will add "'''Function''' ''FunctionName''" to your script, followed by the code to load parameters from the stack into the variables ''v'' (usually $0-$9, $R0-$R9, but $VARs should also work) you have specified in the parameterlist of the macro. ''io'' must be specified with '''in''' or '''out''', depending on which variable you need to hold an input parameter on entry of the function or which one is planned to hold a resultvalue on the end of the function. Leave unused pairs of (io/v) empty ("" "").<br>		Description: This macro will add "'''Function''' ''FunctionName''" to your script, followed by the code to load parameters from the stack into the variables ''v'' (usually $0-$9, $R0-$R9, but $VARs should also work) you have specified in the parameterlist of the macro. ''io'' must be specified with '''in''' or '''out''', depending on which variable you need to hold an input parameter on entry of the function or which one is planned to hold a resultvalue on the end of the function. Leave unused pairs of (io/v) empty ("" "").<br>
	The macro expects that the first input parameter (the leftmost ''V''n with ''IO''n='''in''') has been pushed first onto the stack before the functioncall, and will prepare the results, so that the first output parameter has to be the first one, which has to be popped off the stack after return from the function: this order will be established by [[#nfu.!InstallFunction\|${nfu.!InstallFunction}]] to prepare the call of a function. See also [[#nfu.FunctionEnd\|${nfu.FunctionEnd}]].		The macro expects that the first input parameter (the leftmost ''V''n with ''IO''n='''in''') has been pushed first onto the stack before the functioncall, and will prepare the results, so that the first output parameter has to be the first one, which has to be popped off the stack after return from the function: this order will be established by [[#nfu.!InstallFunction\|${nfu.!InstallFunction}]] to prepare the call of a function. See also [[#nfu.FunctionEnd\|${nfu.FunctionEnd}]].
			<br>'''Note:''' Beginning with NSIS 2.19, the keywords '''in''' and '''out''' are no longer case-sensitive.

	=== nfu.FunctionEnd ===		=== nfu.FunctionEnd ===

â† Older revision		Revision as of 07:32, 15 September 2006
Line 231:		Line 231:
	Usage: ${nfu.SetInstallerName} InstallerName<br><br>		Usage: ${nfu.SetInstallerName} InstallerName<br><br>
	Description: Sets the installer attributes		Description: Sets the installer attributes
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.1.30 '''Name'''],		[{{SERVER}}/Docs/Chapter4.html#4.8.1.30 '''Name'''],
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.1.7 '''Caption'''],		[{{SERVER}}/Docs/Chapter4.html#4.8.1.7 '''Caption'''],
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.1.31 '''Outfile'''] and		[{{SERVER}}/Docs/Chapter4.html#4.8.1.31 '''Outfile'''] and
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.1.18 '''Icon'''] to		[{{SERVER}}/Docs/Chapter4.html#4.8.1.18 '''Icon'''] to
	''InstallerName'', ''InstallerName'', ''InstallerName.exe'' and ''InstallerName.ico''. The macro checks the availibility of ''InstallerName.ico'' and sets '''Icon''' to ''Icon.ico'', if it does not exist. No '''Icon''' will be set, if none of the icons exist. The macro also (re)defines the symbol [[#nfu.myName\|nfu.myName]], which will be set to ''InstallerName'' for later use in your code.		''InstallerName'', ''InstallerName'', ''InstallerName.exe'' and ''InstallerName.ico''. The macro checks the availibility of ''InstallerName.ico'' and sets '''Icon''' to ''Icon.ico'', if it does not exist. No '''Icon''' will be set, if none of the icons exist. The macro also (re)defines the symbol [[#nfu.myName\|nfu.myName]], which will be set to ''InstallerName'' for later use in your code.
	<br>'''Note:''' This instruction has [[#Documentation\|limitations]].		<br>'''Note:''' This instruction has [[#Documentation\|limitations]].
Line 247:		Line 247:
	----		----
	Usage: ${nfu.SetVersionInfo} InstallerName Version Company Copyright Comments<br><br>		Usage: ${nfu.SetVersionInfo} InstallerName Version Company Copyright Comments<br><br>
	Description: Sets the installer attributes for the [~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.1 installer's version information]. ''InstallerName'' will be set for the		Description: Sets the installer attributes for the [{{SERVER}}/Docs/Chapter4.html#4.8.3.1 installer's version information]. ''InstallerName'' will be set for the
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.1 '''ProductName'''],		[{{SERVER}}/Docs/Chapter4.html#4.8.3.1 '''ProductName'''],
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.1 '''FileDescription'''],		[{{SERVER}}/Docs/Chapter4.html#4.8.3.1 '''FileDescription'''],
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.1 '''InternalName'''] and		[{{SERVER}}/Docs/Chapter4.html#4.8.3.1 '''InternalName'''] and
	[~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.1 '''OriginalFileName'''].		[{{SERVER}}/Docs/Chapter4.html#4.8.3.1 '''OriginalFileName'''].
	''Version'' will be used for the [~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.2 '''ProductVersion'''] and [~~http://nsis.sourceforge.net~~/Docs/Chapter4.html#4.8.3.1 '''FileVersion'''], and may be the name of a file, whose version will be detected at compile-time, so that the installer could get the same version like the executable you want to distribute. The macro also (re)defines the symbol [[#nfu.myVersion\|nfu.myVersion]], which will be set to ''Version'' for later use in your code.		''Version'' will be used for the [{{SERVER}}/Docs/Chapter4.html#4.8.3.2 '''ProductVersion'''] and [{{SERVER}}/Docs/Chapter4.html#4.8.3.1 '''FileVersion'''], and may be the name of a file, whose version will be detected at compile-time, so that the installer could get the same version like the executable you want to distribute. The macro also (re)defines the symbol [[#nfu.myVersion\|nfu.myVersion]], which will be set to ''Version'' for later use in your code.
	<br>'''Note:''' This instruction has [[#Documentation\|limitations]].		<br>'''Note:''' This instruction has [[#Documentation\|limitations]].

Line 320:		Line 320:
	----		----
	Usage: ${nfu.StdLicense}<br><br>		Usage: ${nfu.StdLicense}<br><br>
	Description: This symbol contains the NSIS License without the first line for the Copyright holder (see NSIS User Manual, [~~http://nsis.sourceforge.net~~/Docs/AppendixI.html Appendix I]).		Description: This symbol contains the NSIS License without the first line for the Copyright holder (see NSIS User Manual, [{{SERVER}}/Docs/AppendixI.html Appendix I]).

	=== NFU_VERBOSITY ===		=== NFU_VERBOSITY ===