Plugin Tester (or Wrapper): Difference between revisions

From NSIS Wiki
Jump to navigationJump to search
m (Added category links.)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{|align=right
{{PageAuthor|PerditionC}}
|<small>Author: [[{{ns:2}}:PerditionC|PerditionC]] ([[{{ns:3}}:PerditionC|talk]], [[{{ns:-1}}:Contributions/PerditionC|contrib]])</small>
 
|}
<br style="clear:both;">
== Links ==
== Links ==
<attach>PlgnTester.0.0.zip</attach><br>
 
[[Image:Zip.gif]] [http://www.darklogic.org/win32/nsis/plugins/plgnTester.0.0.zip PlgnTester.0.0.zip] (4 KB) (Mirror #1)
=== VC6 ===
<attach>PlgnTester.zip</attach><br>
 
=== VC10 ===
http://dl.dropbox.com/u/74708275/plgnTester.rar


== Description ==
== Description ==
plgntester - NSIS Plugin Tester v0.00
plgntester - NSIS Plugin Tester v0.01


This is a command line program that can be used to
This is a command line program that can be used to
Line 17: Line 19:


== Usage ==
== Usage ==
  testwrap.exe plugin function {/VAR # str} [args]
  plgnTester.exe [options] plugin function {/VAR # str} [args]
 
Currently the only options available determine the output.
/silent limits output to that displayed by the plugin
/nogui prevents the mock NSIS installation listview dialog
/debug displays the contents of the stack and registers
before and after the plugin function is invoked.


Plugin is the name of the plugin (or dll) to load, passed
Plugin is the name of the plugin (or dll) to load, passed
Line 33: Line 41:
Any number (as permitted by the command line) of /VAR # str
Any number (as permitted by the command line) of /VAR # str
sequences can be included (and in any location on cmd line).
sequences can be included (and in any location on cmd line).
/VAR marks the start of setting a variable.<br>
/VAR marks the start of setting a variable. <nowiki>#</nowiki> is 0-24,<br>
<nowiki>#</nowiki> is 0-24, where 0-9 correspond to NSIS variables $0-$9,
where 0-9 correspond to NSIS variables $0-$9,<br>
and 10-19 correspond to NSIS variables $R0-$R9.
and 10-19 correspond to NSIS variables $R0-$R9.<br>
20-24 are $CMDLINE, $INSTDIR, $OUTDIR, $EXEDIR, $LANGUAGE
20-24 are $CMDLINE, $INSTDIR, $OUTDIR, $EXEDIR, $LANGUAGE


The remaining arguments (if any) are the strings pushed onto
The remaining arguments (if any) are the strings pushed onto
the stack and passed to the plugin.  Strings are pushed on
the stack and passed to the plugin.  Strings are pushed on  
 
the stack in opposite order from command line.  That is,  
The stack in opposite order from command line.  That is,  
pass arguments on the command line in same order as if you
pass arguments on the command line in same order as if you
were invoking the plugin from a NSIS script (calling order,
were invoking the plugin from a NSIS script (calling order,
which should match order plugin pops them).
which should match order plugin pops them).


This is primary meant as a debugging tool, so should be
This is primarily meant as a debugging tool, so should be
modified if necessary to the plugin being tested, but
modified if necessary to the plugin being tested, but
should work as it is for some. When using a debugger, one
should work as it is for some. When using a debugger, one
Line 53: Line 60:
them both and/or set break points. Only the input stack
them both and/or set break points. Only the input stack
and variables and then output stack and variables are
and variables and then output stack and variables are
shown.  Present version passes NULL for the HWND as no
shown.  When /nogui option is specified, NULL is passed
window is created, though if requested, a future version may
for the HWND as no window is created.
add the necessary window.  Future versions may also
add a /QUIET or /VERBOSE option allowing this to more
easily be used as a wrapper.


== Contact ==
== Contact ==
Line 64: Line 68:
fdos.org.
fdos.org.


[[{{ns:14}}:Plugins]]
[[Category:Related Software]]

Latest revision as of 07:46, 1 June 2012

Author: PerditionC (talk, contrib)


Links

VC6

PlgnTester.zip (30 KB)

VC10

http://dl.dropbox.com/u/74708275/plgnTester.rar

Description

plgntester - NSIS Plugin Tester v0.01

This is a command line program that can be used to invoke a NSIS plugin. It supports passing any string variable on the stack, setting any of the standard variables (user defined variables are unsupported), and can invoke any specified function in given plugin.

Usage

plgnTester.exe [options] plugin function {/VAR # str} [args]

Currently the only options available determine the output. /silent limits output to that displayed by the plugin /nogui prevents the mock NSIS installation listview dialog /debug displays the contents of the stack and registers before and after the plugin function is invoked.

Plugin is the name of the plugin (or dll) to load, passed asis to LoadLibrary, so one can omit the .dll and normal path search should be done, but if in the NSIS plugin directory, you will need to explicitly provide its path. An error message is returned if failed to load.

Function is the name of the exported function to invoke. It should be exactly as exported, which should match the name used in a NSIS script. An error message is returned if function is not found or other error obtaining its procedure address.

Any number (as permitted by the command line) of /VAR # str sequences can be included (and in any location on cmd line). /VAR marks the start of setting a variable. # is 0-24,
where 0-9 correspond to NSIS variables $0-$9,
and 10-19 correspond to NSIS variables $R0-$R9.
20-24 are $CMDLINE, $INSTDIR, $OUTDIR, $EXEDIR, $LANGUAGE

The remaining arguments (if any) are the strings pushed onto the stack and passed to the plugin. Strings are pushed on the stack in opposite order from command line. That is, pass arguments on the command line in same order as if you were invoking the plugin from a NSIS script (calling order, which should match order plugin pops them).

This is primarily meant as a debugging tool, so should be modified if necessary to the plugin being tested, but should work as it is for some. When using a debugger, one should compile it with debugging information and the plugin with debug information, then one can step through them both and/or set break points. Only the input stack and variables and then output stack and variables are shown. When /nogui option is specified, NULL is passed for the HWND as no window is created.

Contact

Please send bug reports, suggestions, etc. to jeremyd --at-- fdos.org.