home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 June / maximum-cd-2009-06.iso / DiscContents / npp.5.3.Installer.exe / plugins / doc / NppExec.txt < prev    next >
Encoding:
Text File  |  2009-01-16  |  13.0 KB  |  284 lines
  1.  
  2.  ****************************************************************************
  3.  * NppExec plugin ver. 0.3 RC1 for Notepad++ 5.1 (and above)
  4.  * by DV, December 2006 - January 2009
  5.  * Co-developers: Nicolas Babled & Geert Vancompernolle (since July 2007)
  6.  ****************************************************************************
  7.  *
  8.  * Possibilities:
  9.  *   1) Run multiple commands from the "Execute..." dialog
  10.  *   2) Run stand-alone command from the Console Dlg
  11.  *   3) Separate console for each NppExec.dll (e.g. NppExec1.dll, NppExec2.dll)
  12.  *   4) Additional commands:
  13.  *        cls - clear Console screen
  14.  *        cd - shows current path
  15.  *        cd <path> - changes current directory (absolute or relative)
  16.  *        cd <drive:\path> - changes current drive and directory
  17.  *        dir - lists subdirs and files
  18.  *        dir <mask> - lists subdirs and files matched the mask
  19.  *        dir <path\mask> - lists subdirs and files matched the mask
  20.  *        echo <text> - prints a text in the Console 
  21.  *        set - shows all user's variables
  22.  *        set <var> - shows the value of user's variable <var>
  23.  *        set <var> = <value> - sets the value of user's variable <var>
  24.  *        unset <var> - removes user's variable <var>
  25.  *        env_set <var> - shows the value of environment variable <var>
  26.  *        env_set <var> = <value> - sets the value of environment variable <var>
  27.  *        env_unset <var> - removes/restores the environment variable <var>
  28.  *        inputbox "message" - shows InputBox, sets $(INPUT)
  29.  *        inputbox "message" : initial_value - InputBox, sets $(INPUT)
  30.  *        con_loadfrom <file> - loads a file's content to the Console
  31.  *        con_load <file> - see "con_loadfrom"
  32.  *        con_saveto <file> - saves the Console's content to a file
  33.  *        con_save - see "con_saveto"
  34.  *        sel_saveto <file> - save the selected text to a file
  35.  *        sel_saveto <file> : <encoding> - save the selected text to a file
  36.  *        sel_save <file> : <encoding> - see "sel_saveto"
  37.  *        npp_exec <script> - execute commands from specified script
  38.  *        npp_exec <file> - execute commands from specified file         (*)
  39.  *        npp_close - close current file in Notepad++
  40.  *        npp_close <file> - close specified file opened in Notepad++    (*)
  41.  *        npp_console <on/off/keep> - show/hide the Console window
  42.  *        npp_console <1/0/?> - show/hide the Console window
  43.  *        npp_open <file> - open a file in Notepad++
  44.  *        npp_open <mask> - open files matched the mask
  45.  *        npp_open <path\mask> - open files matched the mask
  46.  *        npp_run <command> - run external process/command
  47.  *        npp_save - save current file in Notepad++
  48.  *        npp_save <file> - save a file in Notepad++ (if it's opened)    (*)
  49.  *        npp_saveall - save all modified files
  50.  *        npp_switch <file> - switch to specified opened file            (*)
  51.  *        (*) these commands work with a partial file path/name also
  52.  *            i.e.  npp_save c:\dir\f.txt  is the same as  npp_save f.txt
  53.  *   5) Additional console commands (Console Dlg only):
  54.  *        help       - show available commands
  55.  *        ver        - show plugin's version
  56.  *        CTRL+C     - terminate current child process
  57.  *        CTRL+BREAK - terminate current child process
  58.  *   6) All Notepad++ environment variables are supported:
  59.  *        $(FULL_CURRENT_PATH)  : E:\my Web\main\welcome.html 
  60.  *        $(CURRENT_DIRECTORY)  : E:\my Web\main
  61.  *        $(FILE_NAME)          : welcome.html 
  62.  *        $(NAME_PART)          : welcome 
  63.  *        $(EXT_PART)           : .html
  64.  *        $(NPP_DIRECTORY)      : the full path of notepad++'s directory
  65.  *        $(CURRENT_WORD)       : word(s) you selected in Notepad++
  66.  *        $(CURRENT_LINE)       : current line number
  67.  *        $(CURRENT_COLUMN)     : current column number
  68.  *   7) Additional environment variables:
  69.  *        $(#0)                 : C:\Program Files\Notepad++\notepad++.exe
  70.  *        $(#N), N=1,2,3...     : full path of the Nth opened document
  71.  *        $(LEFT_VIEW_FILE)     : current file path-name in primary (left) view
  72.  *        $(RIGHT_VIEW_FILE)    : current file path-name in second (right) view
  73.  *        $(PLUGINS_CONFIG_DIR) : full path of the plugins configuration directory
  74.  *        $(CWD)                : current working directory of NppExec (use "cd" to change it)
  75.  *        $(ARGC)               : number of arguments passed to the NPP_EXEC command
  76.  *        $(ARGV)               : all arguments passed to the NPP_EXEC command after the script name
  77.  *        $(ARGV[0])            : script name - first parameter of the NPP_EXEC command
  78.  *        $(ARGV[N])            : Nth argument (N=1,2,3...)
  79.  *        $(RARGV)              : all arguments in reverse order (except the script name)
  80.  *        $(RARGV[N])           : Nth argument in reverse order (N=1,2,3...)
  81.  *        $(INPUT)              : this value is set by the 'inputbox' command
  82.  *        $(INPUT[N])           : Nth field of the $(INPUT) value (N=1,2,3...)
  83.  *        $(SYS.<var>)          : system's environment variable, e.g. $(SYS.PATH)
  84.  *
  85.  ****************************************************************************
  86.  
  87.  
  88.  *************
  89.  *  HISTORY  *
  90.  *************
  91.  
  92.  
  93.  v0.3 RC1 - January 2009
  94.  -----------------------
  95.  * thanks to John LaCasse for useful suggestions
  96.  + new environment variable: $(CWD)
  97.  + new commands: ENV_SET/ENV_UNSET
  98.  + new menu item: Toggle Console Dialog (Ctrl+~)
  99.  + now NPE_DEBUGLOG reports on Console double-clicked line's Highlight Filter
  100.  + NppExecPluginMsgTester has been re-designed and updated
  101.  + both Unicode and ANSI builds are supported
  102.  + now the "Execute..." dialog is resizable
  103.  + now NppExec supports remapped shortcut keys (requires Notepad++ >= 5.1.4)
  104.  + other improvements
  105.  + now NppExec has the manual (yes!)
  106.  
  107.  
  108.  v0.3 beta1 - November 2008
  109.  --------------------------
  110.  + full Unicode compatibility (for Unicode version of Notepad++)
  111.  + additional functionality
  112.  + improvements in the script engine (architecture re-design)
  113.  + improvements in the warning analyzer (spaces/tabs can be omitted)
  114.  + other improvements and fixes
  115.  + now NppExec gets its configuration directory from Notepad++
  116.  + now you can exit a console process or interrupt current script at any time
  117.  + now both Console Output and Input can be ANSI, OEM or UTF-8
  118.  + now each copy of NppExec.dll has its own Console History
  119.  + new option: Follow $(CURRENT_DIRECTORY)
  120.  + new command: NPP_CONSOLE
  121.  + new environment variable: $(PLUGINS_CONFIG_DIR)
  122.  
  123.  
  124.  v0.2.5 release 2 - September 2008
  125.  ---------------------------------
  126.  - fixed: (potential) bug in CNppExec::DoExecScript()
  127.  - fixed: several (potential) bugs, thanks to Patrick Corwin
  128.  
  129.  
  130.  v0.2.5 - August 2008
  131.  ------------------
  132.  + added: word wrap in the Console dialog (Ctrl+W)
  133.  * changed: Advanced Options dialog - SaveCmdHistory added, 
  134.    RichEdit_MaxTextLength removed
  135.  - fixed: script with spaces in its name was not started using
  136.    associated menu item
  137.  + some improvements
  138.  + new command: NPP_CLOSE
  139.  + new command: INPUTBOX
  140.  * now NppExec uses Rich Edit 2.0 (instead of 1.0) in its Console window
  141.  + added Notepad++'s variables: $(CURRENT_LINE), $(CURRENT_COLUMN)
  142.  + external plugin interface messages:
  143.    NPEM_GETVERDWORD [returns version as DWORD]
  144.    NPEM_GETVERSTR [returns version as string]
  145.    NPEM_GETSTATE [returns state: ready/busy]
  146.    NPEM_PRINT [prints text which can be highlighted by the Highlight Filters]
  147.    NPEM_EXECUTE [executes given commands]
  148.    NPEM_NPPEXEC [executes script/file]
  149.    NPEN_RESULT [as a result of NPEM_EXECUTE or NPEM_NPPEXEC]
  150.  
  151.  
  152.  v0.2.4 - June 2008
  153.  ------------------
  154.  + added: "Replace" tab in the Console Filters dialog
  155.  * improved: the code of the DlgConsoleOutputFilter has been rewritten
  156.  + added: Console text and background colours can be changed
  157.  + new command: SEL_SAVETO - saves the selected text to a file
  158.  - fixed: CON_SAVETO did not work under Windows 9x
  159.  + added: ability to execute specified script when Notepad++ starts/exits
  160.  + added: ability to assign a menu item to specified script
  161.    (then you can assign a shortcut key to this menu item in Notepad++)
  162.  + added: Advanced Options dialog
  163.  + other improvements
  164.  
  165.  
  166.  v0.2 RC3.2 - February 2008
  167.  --------------------------
  168.  - fixed: NPP_RUN (ShellExecute) did not work with several arguments
  169.  
  170.  
  171.  v0.2 RC3.1 - February 2008
  172.  --------------------------
  173.  - fixed: buffer overflow in the Warning Analyzer
  174.  * changed: now NPP_RUN calls ShellExecute() instead of WinExec()
  175.  
  176.  
  177.  v0.2 RC3 - January 2008
  178.  -----------------------
  179.  + search in the Console
  180.  + history in the Console Filters dialog
  181.  + several issues fixed
  182.  + several cosmetic improvements
  183.  
  184.  
  185.  v0.2 RC2 - December 2007
  186.  ------------------------
  187.  + speeding up the console output
  188.  + watching for changes in "npes_saved.txt"
  189.  + TAB-key in the console auto-completes current command
  190.  + several cosmetic improvements
  191.  
  192.  
  193.  v0.2 RC1 - December 2007
  194.  ------------------------
  195.  1. A lot of internal changes/improvements.
  196.  In particular, now all plugin's options are stored, read and written by the
  197.  Options Manager component.
  198.  The Warning Analyzer component, developed by Nicolas Babled, allows to filter
  199.  and recognize different compiler/interpretter error and warning messages - and
  200.  extract useful information from these messages (such as file name and line 
  201.  number).
  202.  The Simple Logger component stores detailed information about last executed
  203.  command (can be usefull for "debugging").
  204.  * The console redirecting engine has been improved.
  205.  * Now the plugin identifies itself by its dll-file name. Each copy of the 
  206.  plugin (each dll-file) stores its options in corresponding ini-file.
  207.  * Now plugin's environment variables (e.g. "$(FILE_NAME)") are available for
  208.  child console process. For example, start "cmd.exe" and type "echo $(#1)".
  209.  * Now system's environment variables are available in a form of "$(SYS.<var>)"
  210.  e.g. "$(SYS.WINDIR)", "$(SYS.TEMP)" etc.
  211.  * Now the NPP_EXEC command can pass arguments to the script. These arguments 
  212.  can be accessed in the script through the following macro-variables:
  213.  $(ARGC), $(ARGV), $(ARGV[n]).
  214.  Example:  npp_exec "script name" param_1 "param 2".
  215.  This example sets the following values for the script:
  216.  $(ARGC) = 3;  $(ARGV) = param_1 "param 2";  $(ARGV[0]) = script name;
  217.  $(ARGV[1]) = param_1;  $(ARGV[2]) = param 2.
  218.  * Each command now have detailed help information. Type "help" or "help help" 
  219.  in the NppExec's Console.
  220.  * Now the console commands history is restored when you restart Notepad++.
  221.  
  222.  2. New menu items:
  223.  Direct Execute Previous - directly executes previous script.
  224.  No internal messages - do not show such messages as "Process started >>>", etc.
  225.  Save all files on execute - saves all files before executing a script.
  226.  Also NppExec's toolbar icon has been added.
  227.  
  228.  3. New dialog:  Console Output Filter -> Highlight.
  229.  This dialog allows you to specify a string mask for compiler/interpretter error 
  230.  and warning messages with such keywords as %FILE%, %ABSFILE% and %LINE%.
  231.  These messages can be highlighted with different colours and allow you to go
  232.  to certain line in certain file when double-clicked in the Console window.
  233.  
  234.  4. New messages:
  235.  NPP_SAVEALL - saves all modified files.
  236.  CON_LOADFROM - loads a file's content to the Console.
  237.  CON_SAVETO - saves the Console's content to a file.
  238.  ECHO - prints a text in the Console (supports internal env. variables)
  239.  SET - sets the value of user's variable
  240.  UNSET - removes user's variable
  241.  
  242.  
  243.  v0.2 beta4 - July 2007
  244.  ----------------------
  245.  - fixed: buffer size was not checked before calling OemToChar() 
  246.  - fixed/added: '\b' and '\r' handling
  247.  + a lot of changes in plugin's internals (basic cpp-classes and NppExecEngine)
  248.  + new command: cd, cd <path>, cd <drive:\path>
  249.  + new command: dir, dir <mask>, dir <path\mask>
  250.  + new feature: npp_open <mask>, npp_open <path\mask>
  251.  + new environment variables: $(LEFT_VIEW_FILE) and $(RIGHT_VIEW_FILE)
  252.  * thanks to all who wait for this version
  253.  
  254.  
  255.  v0.2 beta3 - April 2007
  256.  -----------------------
  257.  - fixed: Delete button (Script name dialog) was not enabled sometimes
  258.  + Menu: Show Console Dialog
  259.  + Console Output Filter: Exclude all empty lines
  260.  + Comment delimiter can be user-defined, // in :// is no more comment
  261.  
  262.  
  263.  v0.2 beta2 - March 2007
  264.  -----------------------
  265.  + Menu: Console Commands History.
  266.      When enabled, previous commands can be scrolled by pressing 
  267.      arrow keys Up and Down.
  268.  + Menu: Console Output Filter.
  269.      When enabled, output messages from running console process
  270.      can be filtered (i.e. particular lines can be excluded)
  271.  - ConsoleDlg: Ctrl+A is unlocked
  272.  - ConsoleDlg: Quotes "" are no more added automatically for paths
  273.      with spaces (because of a bug with executables w/o extension
  274.      such as "cmd /c calc.exe")
  275.  - Several internal fixes
  276.  - Several additional internal fixes :-)
  277.  * Thanks to Jim Granville for his suggestions
  278.       
  279.  
  280.  v0.1 - March 2007
  281.  -----------------
  282.  * initial version
  283.  
  284.