XYplorer Beta Club

Code: Select all

openwith Notepad, (m);

Code: Select all

text "FILE: <curname><crlf>BASE: <curbase><crlf>EXT: <curext><crlf>FOLDER: <curfolder><crlf>DATE: <date>";

Code: Select all

$var_file = "<curname>";
   $var_User = "%USERNAME%";
   $var_DATE = "<date>";
   msg " $var_User has selected <crlf 2>$var_file<crlf 2>at $var_DATE";

Code: Select all

"Multi-Script: Script 1"
   echo "Hello";
"Multi-Script: Script Two"
   text "Hello World";
"Multi-Script: Script number 3"
   msg "Hi %USERNAME% on %COMPUTERNAME%";

Code: Select all

"Multi-Script: Script 1"
   $var = input("What's your name?");
   msg "Hello $var ( or %USERNAME% ?)";
   msg "Hello World";
   msg "Finshed";
"Multi-Script: Script Two"
   $var_file = "<curname>";
   $var_User = "%USERNAME%";
   $var_DATE = "<date>";
   msg " $var_User has selected <crlf 2>$var_file<crlf 2>at $var_DATE";

Code: Select all

1.) Use XYplorer menu "Scripting > Try Script.."

    Paste or type in the script 

    Example: 
            msg "<xypath>";

    and press OK. 

    "Try Script" always starts with stepping enabled. 
    Note that the debug window appears; try an right click on the [Continue] button and spot the additional options.

   There is also the command "Scripting > Run Script..". which executes an script without calling the debugger.

    Note that you can reuse this script till you overwrite it. XYplorer even remember it after an reboot.

   Tip: you can disable code with 
       /*....*/ block comment 
      and // line comment signs.

Code: Select all

2.) Use the XYplorer address bar for an one-liner script with "Quick scripting"

    - "Quick scripting" (Extended Scripting)
       Enable entering scripts through location interfaces (Address Bar, Go To, Catalog, Favorites).
       Such scripts must be additionally prefixed with a double-colon (::) to distinguish them from normal locations.
       Note that that script is stored from XYplorer internally and you can reuse it e.g. from the address bar history.
    
    Examples:
    ::msg "Hello World!"; 
    ::$temp = "<curitem>";   msg $temp;   $new = replace($temp, "\", "_");   msg $new;


    Only true for older XYplorer versions:
    Note that you have to enable "Quick scripting"  via "Tools > Configuration... > Advanced" (F9 key)

Code: Select all

3.) Use User-Defined Commands (UDC) for an one-liner script

    UDC are user defined menu commands, you may also assign keyboard shortcuts to them.

    How-to:
    XYplorer menu "User > Manage Commands..." 
    "Run Script" section
    New... > Add New Command
    Caption: [    just an short description]
    Script:   [          add your code here;]

    Note that that script is saved from XYplorer internally for later reuse.

Tip: click the [Assign Keyboard Shortcut] button and choose a Keyboard Shortcut to your new UDC. 

Code: Select all

4.) Use Custom Toolbar Buttons (CTB) for an one-liner script

      How-to:
       XYplorer menu "Tools > Customize Toolbar..."
       Add an "User Button #1"  and click [OK]

       Right click this new User-Button and customize it:
        - Name:  optional, this is not really needed
        - Icon:   optional, this is not really needed
        - On click:         [                           add your code here;]
        - On right-click:  [ optional script for right clicking this CTB]

    Note that that script is saved from XYplorer internally for later reuse.

Tip: 
    To assign a Keyboard Shortcut to an button, utilize 'User-Defined Commands' (see above) 
    and use command "button ctb23;" as script (if you work on CTB number "23").

Code: Select all

5.) Use Portable Openwith Menu (POM) for an one-liner script

    XYplorer menu "Tools > Customize Files Associations... > New"

    Example:
        |"My Description" \;*>your code here;"

    Later The Portable Openwith Menu (POM) is opened via menu "File | Open With... (Ctrl+Alt+Enter)".

    Note that that script is saved from XYplorer internally for later reuse.

Code: Select all

6.) Use Custom Keyboard Shortcuts (CKS) for an one-liner script

  How-to:
    Define an "User-Defined Command" (UDC, point 3. above) and add an keyboard shortcut

Code: Select all

7.) Use Custom Event Actions (CEA) for an one-liner script

    E.g. from an custom right click context menu:

    Sorry, CEA are not implemented right now.

Code: Select all

First save the script to an plain text file, best (for easy access) in XYplorers Scripts folder.

    How-to:
    - select and copy the whole script to the clipboard
    - in XYplorer go to the script folder (using menu "Go > Go to Scripts Folder")
    - right click there on the number column or on an empty space below of any file
        and chose "Paste Special > Paste Text Into New File" from context menu.
    
        Give that file an nice name and use XYS as extension.
        E.g.: "X:\Tools\XYplorer\Scripts\scriptname.xys"

Code: Select all

1.) XYplorer menu "Scripting > Load Script File..." 

    to load an saved script file from XYplorers script folder (or browse to your script)

Code: Select all

2.) Use the XYplorer address bar "Quick scripting" -feature to load an saved script file

    Example: 
       ::load "scriptname";

     Note that the extension ".xys" is not needed to include here.
     Note that the script path for scripts in "XYplorer\Scripts folder" is not needed here. 
     For script located other where you can use absolute or relative paths, like:
     "::load "C:\Temp\myScript"; (to load an script from "C:\Temp\")
     "::load "tests\test01"; (if you have an sub-folder "tests" in your XYplorer script folder)

   Info:
    - "Quick scripting" (Extended Scripting)
    Enable entering scripts through location interfaces (Address Bar, Go To, Catalog, Favorites).
    Such scripts must be additionally prefixed with a double-colon (::) to distinguish them from normal locations.

Code: Select all

3.) Use User-Defined Commands (UDC) to load an saved script file

    How-to:
    XYplorer menu "User > Manage Commands..."
    "Load Script File" section
    New... > Add New Command
    Caption:      [                     just an short description]
    Script File:   [             myScript   or    path\to\script]
    Label:         [     optional: label inside the script file   ]

Tip: click the [Assign Keyboard Shortcut] button and choose a Keyboard Shortcut to your new UDC. 

Code: Select all

4.) Use Custom Toolbar Buttons (CTB) to load an saved script file

      How-to:
       XYplorer menu "Tools > Customize Toolbar..."
       Add an "User Button #1"  and click [OK]

       Right click this new User-Button and customize it:
        - Name:  optional, this is not really needed
        - Icon:   optional, this is not really needed
        - On click:         [           myScript;    or    path\to\script;]
        - On right-click:  [ optional script for right clicking this CTB]

    Note that that script is saved from XYplorer internally for later reuse.

Tip: 
    To assign a Keyboard Shortcut to an button, utilize 'User-Defined Commands' (see above) 
    and use command "button ctb23;" as script (if you work on CTB number "23").

Code: Select all

5.) Use Portable Openwith Menu (POM) to load an saved script file

    XYplorer menu "Tools > Customize Files Associations... > New"

    Example:
       |"My Description" \;*>::load scriptname;

    Explanation:
       An leading '|' -symbol means "don't act/execute on double click or enter, just show it in POM"
       "*;\" means to which file types this POM should be associated. Here to all file types "*" and to all folders "\".
      But you can chose single extensions also: txt;log;pas;cpp;html>::load textparserscript;

    Later The Portable Openwith Menu (POM) is opened via menu "File | Open With... (Ctrl+Alt+Enter)".

Code: Select all

6.) Use Custom Keyboard Shortcuts (CKS) to load an saved script file

    Define an "User-Defined Command" (UDC, point 3. above) and add an keyboard shortcut

Code: Select all

7.) Use Custom Event Actions (CEA) to load an saved script file

    E.g. from an custom right click context menu:

    Sorry, CEA are not implemented right now.

Code: Select all

Hint about Script warning about Recursion:

        Example:
        the "Scripting Error" ('Step through scripts') box appears:
            The current script appears to be recursive.
            The stack depth is 3.


Regarding the recursion-warning, you need to turn the recursion checker off if an script uses recursion on purpose:

      Switch Recursion Checker Off
      When writing your scripts, you might want to have one script call itself (using command load or sub).
      Of course, if you don't take care, you could end up in an infinite loop which would result in some problems...
      Trying to prevent such an issue, XY comes with a recursion checker that will pop up a warning message
      when a recursion is spotted and gives you the opportunity to cancel the script execution.
      
      If you do not want these warnings and are confident that you won't create an endless loop,
      you can switch off the recursion checker by setting this entry to a value of 1 :
      
            [Settings]
            ScriptRecursionWarningOff=0




You can also use this setting per script.

      Example:
            Setting("AllowRecursion", 1);

     Explanation:
          + Scripting commands enhanced:
            - setting, settingp
              New named argument "allowrecursion"
                0 = show warning on recursions
                1 = simply go on and hope that the script writer knows what he's doing
              Example:
                ::setting "allowrecursion", 1;
      
              Note: This command is just using a simpler name for the already
              existing INI tweak "ScriptRecursionWarningOff".

              ; Tweak: set to 1 to turn off the recursion checker
              ScriptRecursionWarningOff=1

Code: Select all

Hint about path to script file and script extension .xys
    If the script file is located in the XYplorer script folder "\Scripts" (see menu "Go > Go to scripts folder")
    then you don't need to include the path to execute the script.
    Otherwise call the script with an path, full or relative. 
    You can also use the var "<xyscripts>" to refer to XYplorers script folder. (load "<xyscripts>\sub-folder\testscript")
    Note that you don't need to include the ".xys" extension while executing an script.

Code: Select all

Hint about debug window:
   Enable "Scripting > Step Mode" to see the debug window for every script execution.

   Note: do an right click on the [Continue] button to see some options.

   You can also call the debugger from an script.
   Example:
         step;

Code: Select all

Hint about " " quotes:
    If something doesn't works please try to add or remove quotes from commands.
    Because here for this examples ""-quotes are used often for explanations to show you an start and end point,
    and should NOT be used in real life. On the other hand quotes ARE needed if your commands, names or paths contain spaces.
    You may want to read section about Quotes too?

Code: Select all

Exceptions from this rule:

A.) If the first line of your script is an caption in quotes then THIS has to start at pos1.
    Then the first line with code and all following has then to be indented.


B.) You can have more than one script inside a script file.
    The first script may have, the second and following scripts must have an caption
    wrapped in quotes to identify (or say: separate)  each script. You will be prompted with an menu.
    This caption line(s) MUST start at pos1 too. The code has too be indent in that case.


C.) Comment lines starting with // are ignored and may be at pos 1 too, but don't have to.

Code: Select all

$a = "Hello";
  msg $a;

Code: Select all

$a = "Hello";
        msg $a;

Code: Select all

"This is the CAPTION"
   $a = "Hello";
   msg $a;

Code: Select all

"This is the CAPTION"
//here with comment lines

//settings:
  //init the var $a with string "Hello":
   $a = "Hello";

//output:
   //prompt the user by an message box:
   msg $a;

Code: Select all

"This is the caption of script No. 1"
   //with comment line
   $a = "Hello";
   msg $a;

"This is the caption of the second script"
   $a = "How are you?";
   msg $a;
   sub "_Third script (hidden)";

"_Third script (hidden)"
/*
Multi-line comment:
You may hide scripts by prefixing an underscore (_) to their caption.
Hidden scripts can be executed but are not shown in the script file's popup menu.
*/
    $B = "I am fine too!";
    msg $B;

Code: Select all

// And here only the second script (here used as function) has an caption.
// At the first script the code line starts at pos 1, the rest code is indented.
// For the second script the caption starts at pos 1, the code is indented:


global $count;
  $a = "How are you?";
  msg $a;
  $count = 3;
  sub "_Second script (hidden)";

"_Second script (hidden)"
  global $count;
  $Loop=1;
  while( $Loop < $count )
  {
    msg "No. $Loop out of $count",1;
    $Loop++;
  }

Code: Select all

$a = "Hello";
msg $a;
//not indented at all, you will be prompted with an wired menu showing you all lines starting at pos. 1.

Code: Select all

"This is an script"
  $a = "Hello";
  msg $a;
  "This is an second script"
     $a = "How are you?";
     msg $a;
//caption of second script must NOT be indented but start at position 1!

Code: Select all

"Main"
  $UserInput = input("Go to sub-script test","Go to sub: one OR two OR three", "two");
  sub "_sub_$UserInput";

// sub scripts:
"_sub_one"
  msg "This is just sub script one ;-)";

"_sub_two"
  msg "You are in sub two now, welcome !!!";

"_sub_three"
  msg "Did you entered three ????";

Code: Select all

"Main"
  //Make an variable global to all sub-scripts:
  global $myVAR;
  $myVAR = "STE fan";

  //Prompt user to enter an option:
  $SUB = input("Global vars test", "Go to sub: one OR two OR three", "one");
  sub "_$SUB";



// === The Subs / Functions ===  //
"_one"
  global $myVAR;
  msg "This is sub one. 'myVAR' contains: $myVAR ('global' was used here and in main also)";


"_two"
  //here, the global command is missed!!!
  msg "This is sub two. 'myVAR' contains: $myVAR  ('global' was NOT used in this sub, but in main only)";


"_three"
  msg "This is sub three. 'SUB' contains: $SUB  ( $SUB is NOT 'global')";

Code: Select all

"_INIT"
   //Common settings for all scripts below:
   global $var, $VAR;
   $var = "This value is set globally";
   $VAR = "2013";

//============================

"Script ONE"
   load "*", "_INIT"; // <<< execute "_INIT"
   global $var;       // <<< get access to the global var
   msg "$var";       // <<< your own code here

"Script TWO"
   load "*", "_INIT"; 
   global $var, $VAR;
   msg "$var  $VAR";

Code: Select all

//this is an comment
msg "Hi you!"; //this is an comment
//msg "Hi you!"; this is an disabled command

Code: Select all

/*
line of code
line of comment
line of description
*/

Code: Select all

The dot is used for concatenation like with PHP:

   Example:
    $TEST = "File name";

    various test:
    msg $TEST.ext;      //===> results in 'File nameext'
    msg $TEST."ext";    //===> results in 'File nameext'
    msg $TEST.".ext";   //===> results in 'File name.ext'
    msg "$TEST.ext";    //===> results in 'File name.ext'

Tip, so always use quotes "...". 

Code: Select all

selfilter "readme";      // Selects all items whose name contains "readme" (eg: readme, readme.txt, !readme.now)
selfilter """readme""";  // Selects item named "readme" and only that one item
selfilter "foobar";       // pattern is foobar
selfilter '"foobar"';      // pattern is "foobar"

Code: Select all

Examples:
msg This works but is dangerous (read: not future-proof); 
msg "This is correct and recommended"; 
msg "This is correct, too, and of course you can use separators , ; . '  ""  and ""quotes"" as you wish."; 
msg """This is correct too and quotes ("") will be shown as they're part of your parameters."""; 

msg '"This is "correct" too"';   //(That's: ' " string with quotes " ' )

Code: Select all

Note: single quotes '...' return the string unresolved.
Test:

::msg "This is <curfolder>";         //This is PROGRAM FILES
::msg '"This is <curfolder>"';        //"This is <curfolder>"  //(That's: ' " string with quotes " ' )

::msg '<curfolder>' . "  shows you <curfolder>";      // <curfolder>  shows you PROGRAM FILES
::msg '<curfolder>' . "  shows you ""<curfolder>""";  // <curfolder>  shows you "PROGRAM FILES"

Code: Select all

run """C:\Program Files\AutoHotkey\AutoHotkey.exe""";

run '"C:\Program Files\AutoHotkey\AutoHotkey.exe"';

run quote("C:\Program Files\AutoHotkey\AutoHotkey.exe");

run("""C:\hasher.exe"" sha256 ""<curitem>"" > ""<curitem>.sha256""");

run """cmd"" /k ""D:\Portable Programs\XYplorer\wget\wget"" --help";

run '"cmd" /k "D:\Portable Programs\XYplorer\wget\wget" --help';

run "cmd /k ""%tmp%\xyMapShares.cmd""";

open quote("notepad")." ".quote(<curitem>);

Code: Select all

::msg "<curpath>";                               // C:\PROGRAM FILES
::msg ""<curpath>"";                             // ""C:\PROGRAM FILES""
::msg """<curpath>""";                           // "C:\PROGRAM FILES"
::msg quote("<curpath>");                     // "C:\PROGRAM FILES"
::msg chr(34) .  "<curpath>" . chr(34);    // "C:\PROGRAM FILES"


::msg "I am in folder <curpath>";                // I am in folder C:\PROGRAM FILES
::msg "I am in folder "<curpath>"";              // "I am in folder "C:\PROGRAM FILES""
::msg "I am in folder ""<curpath>""";            // I am in folder "C:\PROGRAM FILES"
::msg "I am in folder " . quote("<curpath>"); // I am in folder "C:\PROGRAM FILES"  //note the dot to bind two strings


::msg "I am in ""Program Folder"" folder ""<curpath>"""; // I am in "Program Folder" folder "C:\PROGRAM FILES"

Code: Select all

"<curfile>" . "ext"    //==> fileext
"<curfile>" . ".ext"   //==> file.ext

Code: Select all

$ITEM = "Do you see this?";
  msg "1: $item";   //1:
  msg "2: $Item";   //2:
  msg "3: $ITEM";  //3: Do you see this?

Code: Select all

  $a ="a";

  if ("$a" like "A"){ msg "1: Yes, $a is like A<crlf>Wrong! but always TRUE because
           of wrong spelled parameter 'Like' as 'like'"; }
           else{ msg "1: No, $a is not like A"; }

  if ("$a" Like "A"){ msg "2: Yes, $a is like A"; }
           else{ msg "2: No, $a is not like A.<crlf>Note the correct spelled 'Like'"; }

Code: Select all

---------------------------------------------------------------------------------
                                        XYplorer
---------------------------------------------------------------------------------
Click OK to create a list of all commands, with IDs (used in Scripting)
and currently assigned keyboard shortcuts.

Format: Command Name [TAB] Command ID [TAB] Keyboard Shortcut

The list will be placed in the clipboard.
---------------------------------------------------------------------------------
                          OK                         Cancel
---------------------------------------------------------------------------------

Code: Select all

if (expression) {
    statement(s);
   }
    elseif (expression) {
   statement(s);
   }
   else {
  statement(s);
}

Code: Select all

// reality check
if (1 == 2) {
    echo "Help!";
    } else {
    echo "Relax.";
    }

Code: Select all

while (expression) {
    statement(s);
    }

Code: Select all

$count = 1;
  while($count < 4){
     msg "iteration no " . $count . " of three";
     incr $count;
   }

Code: Select all

$count = 1;
 while(true){
    msg "Hi you!";
    incr $count;
    if($count > 4){break;}
  }

Code: Select all

$Count = 1;
  while($Count <= 10)
  {
     //your code here
     incr $Count;
    //or $Count++;
  }

Code: Select all

$Count = 1;
  while($Count < 7){
     //your code here
     msg "Iteration No. $Count out of six (or of three only?)";
     incr $Count,,2;
  }

Code: Select all

$Count = 10;

  while($Count > 0){
     //your code here
     msg "Count down " . $Count;
     incr $Count,,-1;
  }else{
      msg "0, GO!";
  }

Code: Select all

// loop through the whole list
   //sel 1;  //means: go to first item in list
   while ( "<curitem>" != "" )
   {
     msg "<curitem>",1;
     sel "+1";
    }

Code: Select all

$ITEMS = "Eins, Zwei, Drei";

  foreach($item, $ITEMS, ",")
  {
    msg $item, 1;
  }

Code: Select all

$Array="";
   $Files = get("SelectedItemsPathNames", "|");

   foreach($file , $Files)
   {
     $Array = $Array . $file<crlf>;
   }

   text $Array;

Code: Select all

  //ask the user to continue:
  $continue = confirm("Continue?");
  if ($continue==0){msg "Cancel pressed, will quit whole script."; end(1);}
  if ($continue==1){msg "OK pressed, will continue.";}
  msg "You will see this if you pressed OK";

Code: Select all

  //ask the user to continue:
  $continue = confirm("Continue?");
  if ($continue==0){
     //"Will do nothing and skip.";
     msg "Canceled by user";
  }else{
     msg "OK, we continue...";
     //your code here...
  }

Code: Select all

  //ask the user to continue:
  $continue = confirm("Continue?");
  if ($continue==1){
     msg "OK, we continue...";
     //your code here...
  }

Code: Select all

  //ask the user to continue:
  $continue = confirm("Continue or end the whole script?");
  if ($continue==0){ end(1)};
  msg "You will see this if you pressed OK";

Code: Select all

  //ask the user to continue:
  msg "Press OK to continue or Cancel to quit", 1;
  //if the user press the cancel button the script will end. Note the "1" parameter from the msg command.

  msg "You will see this if you pressed OK";

Code: Select all

$a='"test2"';
  echo $a;

  setkey quote($a),test,test,"%temp%\test.ini";

  getkey $b,test,test,"%temp%\test.ini";

  echo "$a<crlf>$b";

Code: Select all

$IsFile = report ("{Dir False|True|Drive}",1); 
  msg $IsFile;  
  If ($IsFile=="True") {msg "It is a file"}else{ msg "no file"};

Code: Select all

$IsFolder = report ("{Dir Yes|No|Drive}",1);

Code: Select all

if (exists($curitem)==1)                    //==> check if this is an file (and NOT an dir/folder)
if (exists("<curpath>\sub-folder")==2) //==> check if an folder with this name already exists

Code: Select all

//Break an while loop

while(1) //infinity loop
  {
     break;  //exit loop, see help to exit nested loops

     //example:
     if ($var == "") {break;}
  }

Code: Select all

//Break from an If statement

If ($x==$y)
  {
     end(1) //end the whole script
  }

Code: Select all

//Break from an If statement

If ($x==$y)
  {
     //do nothing
  }

Code: Select all

//Break from an If statement

If ($x==$y)
  {
     //do nothing
  }else{
    //do this
  }

Code: Select all

//end condition, [message], [scope=0]

end (getinfo("CountSelected")<1), "Nothing selected. Script quits.";
   msg "Do you see this dialog?<crlf>Then you had at least one item selected.";

Code: Select all

$a = 1;
  msg "Press OK and take an look on the status bar below.";
  while ($a <= 500)
  {
    status 'Var $a is now: ' . "$a    -  Press ESC to stop.";
    wait 100;
    $a++;
  }
  status "Script done!";

Code: Select all

 $s="";
 $Loop=0;
 $amount=30;

 while($Loop < $amount)
 {
 
    //your code here...

         //the trick:
         $s = $s . "."; if (strlen($s)>9){$s="";}
	 status "In process " . $s; wait 500;

    $Loop++;
 }
 status "Done.";

Code: Select all

 $Loop=0;
 $amount=30;
 while($Loop < $amount)
 {

   //your code here...


      //the trick:
      $SBT="/"; if($SBL >4){$SBL=1;}
      if($SBL==1){$SBT="/"}; if($SBL==2){$SBT="-"};
      if($SBL==3){$SBT="\"}; if($SBL==4){$SBT="|"};
      status "In process $SBT"; wait 100; incr $SBL;

  $Loop++;
 }
 status "Done.";

Code: Select all

get("CountItems");

Code: Select all

msg get("CountSelected");

Code: Select all

$Amount = get("CountSelected");
   if ($Amount < 1)  {  msg "Please select at least one file";    end 1;      }

Code: Select all

//If nothing is selected, select all first:
  $CountSelected = getinfo("CountSelected");
  IF ($CountSelected<1){sel a;} //Select all.

Code: Select all

$FILES = get("SelectedItemsPathNames");
   msg $FILES; 

Code: Select all

$FILES = get("SelectedItemsNames");
   msg $FILES; 

Code: Select all

$FILES = get("SelectedItemsNames", "|");   msg $FILES; 
Result: file1.ext|file2.ext|file3.ext|

$FILES = get("SelectedItemsNames", ", ");   msg $FILES; 
Result: file1.ext, file2.ext, file3.ext, 

Code: Select all

$FILES = get("SelectedItemsNames", """ """);   msg $FILES;
Result: file1.ext" "file2.ext" "file3.ext

but add leading and trailing quote signs also like:
$FILES = """" . get("SelectedItemsPathNames", """ """) . """";
or
$FILES = chr(34) . get("SelectedItemsPathNames", """ """) . chr(34);
or
$FILES = quote(get("SelectedItemsPathNames", """ """));
Result: "file1.ext" "file2.ext" "file3.ext"

And quotes and coma in combination:
$FILES = quote(get("SelectedItemsPathNames", """, """));
Result: "file1.ext", "file2.ext", "file3.ext"

Code: Select all

text report();
Displays the current file list "as is" in a multiline textbox.

text report(,1);
Displays the selected file only due parameter 1.

text report("{Fullpath}",1);
Result: D:\rive\to

text report("{Fullname}",1);
Result: D:\rive\to\file1.ext

text report("{name}",1);
Result: file1.ext

text report("{basename}_backup.{ext}",1);
Result: file1_backup.ext

Code: Select all

text report("""{name}""",1);
Result: "file1.ext""file2.ext""file3.ext"

Code: Select all

text report("""{name}""|",1);
Result: "file1.ext"|"file2.ext"|"file3.ext"|

text report("""{name}"", ",1);
Result: "file1.ext", "file2.ext", "file3.ext",

text report("""{name}"",<crlf>",1);
Result: 
"file1.ext", 
"file2.ext", 
"file3.ext",


text report("""{name}.bak"", ",1);
Result: "file1.ext.bak", "file2.ext.bak", "file3.ext.bak",

Code: Select all

text report("COPY ""{fullname}"" ""{fullname}.bak""<crlf>",1,"@ECHO OFF<crlf>", "<crlf>ECHO done!");

Result: 
@ECHO OFF
COPY "D:\rive\to\file1.ext" "D:\rive\to\file1.ext.bak"
COPY "D:\rive\to\file2.ext" "D:\rive\to\file2.ext.bak"
COPY "D:\rive\to\file3.ext" "D:\rive\to\file3.ext.bak"
ECHO done!

Code: Select all

$files =  report("""{name}"", ",1);
  $files = substr($files, 0, -2);
  //Result: "file1.ext", "file2.ext", "file3.ext"

Code: Select all

$files =  report("""{name}"", ",1);
  $files = regexreplace($files, "(.+)..", "$1");
  //Result: "file1.ext", "file2.ext", "file3.ext"

Code: Select all

 $array="";
 while(true){
  if ("<curbase>"==""){break;}
  $array = $array . "<curbase>|";
  //msg "<curbase>",1;
  sel "+1";
 }
 text $array;
 //foreach($item, $array){ ...here do something for each item from the array }

Code: Select all

v11.40.0202 - 2012-08-17 20:58
    + Scripting got a new function.
      Name:   getPathComponent
      Action: Returns the specified component of a path.

Code: Select all

foreach($ITEM, get("SelectedItemsNames", "|") ){
    msg getpathcomponent($ITEM, "base"),1;
  }

Code: Select all

   //first select first item in list:
   //sel 1;
   
   //or ask the user to select one:
   if (get("CountSelected")<1){end 1, "Please select one file first!<crlf>Script quits.";}

  //Loop:
   while ( <curitem> != '' )
   {
       msg "<curitem>",1;
       sel "+ 1";
    }

Code: Select all

if (get("CountSelected")<1){end 1, "Please select at least one file first!<crlf>Script quits.";}

  //"SelectedItemsNames", [separator=CRLF], [pane=a]
  $filelist = get("SelectedItemsNames");

  //foreach($variable, listoftokens, [separator=|]) 
  foreach($MyNewVariable, $filelist, "<crlf>")
  {
     msg $MyNewVariable,1;
  }

Code: Select all

Please note the the default separator parameter for
get("SelectedItemsNames") is "<crlf>"
and for foreach() it is "|"

So take care to use 
get("SelectedItemsNames") 
foreach($var1, $var2, "<crlf>")

or use
get("SelectedItemsNames", "|") 
foreach($var1, $var2)

or even use something like:
get("SelectedItemsNames", "?") 
foreach($var1, $var2, "?")

or
get("SelectedItemsNames", "<crlf>") 
foreach($var1, $var2, "<crlf>")
or
get("SelectedItemsNames", "|") 
foreach($var1, $var2, "|")

it only matters that the delimiter is the same for all commands.

Code: Select all

  $ITEMS = "Eins, Zwei, Drei";
  foreach($item, $ITEMS, ",")
  {
    msg $item,1;
  }

Code: Select all

   $STRING = "XYplorer";
   $LOOPs = strlen($STRING);
   $ITERATION=0;
   $OUTPUT="";
   
   while($ITERATION <= $LOOPs)
   {
      $Token = substr($STRING, $ITERATION, 1);
      if ($Token==""){break;}
      msg $Token,1;
      incr $ITERATION;
   }

Code: Select all

//For Each Line In LineS Do

  //collect a file content into a variable:
  $INPUT = readfile("<xydata>\xyplorer.ini");  // or nowadays just "<xyini>"
  text $INPUT;

  //initialize the $OUT var or you get "$OUT" as literal text into the output too:
  //(this could also be used to write a header line for example)
  $OUT = "";

  //for each part (put into "$myVar") from big content (parts are separate here by line break, means "for each line"):
  foreach( $LINE , $INPUT , "<crlf>" ){

         //search for a pattern:
         //regexmatches( string, pattern, [separator=|], [matchcase=0])
    $TMP = regexmatches( $LINE , "backup"                             );

    //if pattern matched, collect the current processed line into a new variable $OUT:
    if( $TMP !=  "" ){ $OUT = $OUT . $LINE . "<crlf>"; }

   }
   //test to see what we have collected:
   text $OUT;
 
  //write collection from $OUT to a new text file:
  //writefile(filename, data, [on_exist], [mode])
  //writefile( "%temp%\filename.txt", $OUT) ;

Code: Select all

  $INPUT   = readfile("<xydata>\xyplorer.ini");
  $Matches = regexmatches( $INPUT , "^.+tweak.+$" , "<crlf>");
  text $Matches;

Code: Select all

  $INPUT = readfile("<xydata>\xyplorer.ini"); 
  $OUT   = "";
  $BAD   = "";

  foreach($LINE,$INPUT,"<crlf>"){
       
       $FirstSign = substr( $LINE , 0 , 1 );
         
       if( $FirstSign Like ";" ){ 
             $OUT = $OUT.$LINE."<crlf>"; 
       }else{
             $BAD = $BAD.$LINE."<crlf>";
       }
  }
         
  text $OUT;
  text $BAD;

Code: Select all

$INPUT = readfile("<xydata>\xyplorer.ini"); 

  $OUT=""; $counter=0; $continue=false;

  foreach($LINE,$INPUT,"<crlf>"){

      $TMP = regexmatches($LINE, "tweak");

      //If regex matched, set $continue to true,
      //IF $continue equals true, collect the next line too,
      //untill $counter is greater 2, then stop collecting additional lines.
      if ($continue == true){
            $OUT = $OUT.$LINE."<crlf>"; 
            $counter++;
            if($counter > 2){$counter=0; $continue = false;}
      }

      if($TMP!=""){ 
             $OUT = $OUT.$LINE."<crlf>"; 
             $continue = true;
      }
  }
  text $OUT;  

Code: Select all

  $INPUT = get("SelectedItemsNames"); 
  $count = 1;

  foreach( $Item , $INPUT , "<crlf>" ){
     msg "$count:<tab>$Item",1;
     $count++;
 }

Code: Select all

   $ListOfFolders = folderreport("dirs", "r", , "r" );

   $OUT = "";
   foreach($Folder, $ListOfFolders, "<crlf>"){

        //Example use: do something for each sub-folder recursive:
        $TMP = listfolder($Folder, , , "<crlf>");
        if($TMP!=""){$OUT = $OUT . $TMP .  "<crlf>";}

   }
   text $OUT;

Code: Select all

Q: How can i get the parent folder?

A: There is no script command to just get the parent folder.
    You have to use e.g. <curpath> and split them by using gettoken()

    $path = "<curpath>";
    $ParentFolder = gettoken($path, -1, "\");

   msg $ParentFolder;

Code: Select all

/*
Q: How can i split base name and extension?
A: Here is one way (note this is an old way, see below for the new one)
*/

global $FileName, $InStrRev, $Sign;
   
    $FileName = "This is No. 1 of my File name.ext"
   
    //split extension:
    $Sign = "."; sub "_InStrRev";
    $Base = substr($FileName, 0, $InStrRev -1);
    $Exte = substr($FileName, $InStrRev);
   
   
"_InStrRev" //Function
/*
  "_InStrRev" gives last possition of $Sign in $FileName
  Syntax: $Sign = ".";  sub "_InStrRev";
  Return: last pos of $Sign in $FileName
*/
global $FileName, $InStrRev, $Sign;
   $Index=0;
   while($Index < strlen($FileName))
   {
     If ($FileName==""){break;}
     $check = strpos( $FileName, "$Sign", strlen($FileName) - $Index );
     If ($check > -1){$InStrRev = $check +1; break;}
     $Index++;
   }

Code: Select all

/*
Split path file name into parts to an base extension array (note that this is an older way to do this
Here with some error handling
*/


//set array  to test string:
$ARRAY = "C:\Documents and Settings\Administrador\Meus documentos\XYplorer\Contas a receber.docx.bak";
   
  //split the string into parts
  //assign array elements to $Vars:
  $DRIVE             = gettoken( $ARRAY,   1, "\");
  $TopFolder         = gettoken( $ARRAY,   2, "\");
  $SubFolder         = gettoken( $ARRAY,   3, "\");
  $GrantParentFolder = gettoken( $ARRAY, - 2, "\");
  $ParentFolder      = gettoken( $ARRAY, - 1, "\");
  $UBound            = gettoken( $ARRAY,   "count" , "\");
  $FILE              = gettoken( $ARRAY,   $UBound , "\");
   
   //split FileName into base and extension:
   $Base = "not an file";
   $Exte = "not an file",
   If ($FILE != "")
    {
     If (strpos($FILE, ".") > 0)
     {
      while($Index < strlen($FILE))
       {
         $check = strpos( $FILE, ".", strlen($FILE) - $Index );
         If ($check > -1){$InStrRev = $check +1; break;}
         $Index++;
       }
     $Base = substr($FILE, 0, $InStrRev -1);
     $Exte = substr($FILE, $InStrRev);
     }
    }
   
   
  //test output:
  text Drive: <tab 2> $DRIVE<crlf>
       TopFolder: <tab> $TopFolder<crlf>
       GrantParent: <tab> $GrantParentFolder<crlf>
       ParentFolder: <tab> $ParentFolder<crlf>
       File: <tab 2> $FILE<crlf>
       Base: <tab 2> $Base<crlf>
       Ext: <tab 2> $Exte;

/*
Test Output for "C:\Documents and Settings\Administrador\Meus documentos\XYplorer\Contas a receber.docx.bak"
Code:
Drive:          C:
TopFolder:      Documents and Settings
GrantParent:    Meus documentos
ParentFolder:   XYplorer
File:           Contas a receber.docx.bak
Base:           Contas a receber.docx
Ext:            bak
*/

Code: Select all

This needs v10.60.0120 - 2011-12-06 13:42
    + SC strpos enhanced: Now negative start positions are supported to begin searching from the start position leftwards.

Code: Select all

//input:
$a = "<curitem>";

  //get drive letter and top main folder:
  $Drive        = gettoken($a, 1, "\");
  $TopFolder    = gettoken($a, 2, "\");
   
  //get the path only:
  $LastBS       = strpos($a, "\", -1);
  $path         = substr($a,     0     , $LastBS +1);
  $file         = substr($a, $LastBS +1,           );
   
  //split file name into base name and extension:
  $LastDot      = strpos($file, ".", -1);
  $base         = substr($file,   0        , $LastDot);
  $ext          = substr($file, $LastDot +1,         );
   
  //get the parent folder name, and the grandparent too:
  $ParentFolder = gettoken($a, -2,"\");
  $SecondParent = gettoken($a, -3,"\");
    
     
//debug output:
  msg Orig: $a    <crlf>
      Drive: $Drive <crlf>
      Top: $TopFolder <crlf>
      Path: $path <crlf>
      File: $file <crlf>
      Base: $base <crlf>
      Ext: $ext <crlf>
      Parent: $ParentFolder <crlf>
      Second: $SecondParent;

Code: Select all

/* an slightly  other way to split file name into base name and extension      */
/* Note: This strpos() syntax needs XYplorer v10.60.0120 - 2011-12-06 or above */

$selFiles = get("SelectedItemsNames", "|");

  foreach($file, $selFiles){

         $base = substr($file, 0, strpos($file, ".", -1) ); 
         msg $base,1;

         $ext = gettoken($file, -1, "."); 
         msg $ext,1;

   }

Code: Select all

v11.40.0202 - 2012-08-17 20:58
    + Scripting got a new function.
      Name:   getPathComponent
      Action: Returns the specified component of a path.
      Syntax: getpathcomponent([path], [component])
        path:     The path to parse; can be a folder or a file.
                  Defaults to the current folder or file.
        component: The component to return; can be any of the following:
          drive:  the drive or share
          path:   [default] the path without any file
          parent: the parent folder
          file:   the file without path
          base:   the file without path and without extension
          ext:    the extension
      Notes:
        Paths are returned unslashed.
      Examples:
        echo getpathcomponent(, "file"); //current item without path
        echo getpathcomponent("E:\x\y.txt", "ext");   // txt
        echo getpathcomponent("E:\x\y.txt", "base");  // y
        echo getpathcomponent("E:\x\y.txt", "file");  // y.txt
        echo getpathcomponent("E:\x\y.txt", "parent");// x
        echo getpathcomponent("E:\x\y.txt", "path");  // E:\x
        echo getpathcomponent("E:\x\y.txt", "drive"); // E:


v11.40.0204 - 2012-08-18 21:11
    + SC getPathComponent enhanced: Now you can return components by 
      their position index. Negative indices can be used to refer to the 
      position from the right end.
      Syntax: getpathcomponent([path], [component], [index=1])
        component: The component to return:
          component: The component referred to by index.
        index:  The index of the component to return. Only used if 
                component is "component". The first component is 1, the 
                last component is -1.
                Invalid indices or index 0 (zero) return nothing.
      Notes:
        UNC paths are stripped off the leading "\\" before applying the 
        index.
      Examples:
        echo getpathcomponent("E:\x\y.txt", "component");     // E:
        echo getpathcomponent("E:\x\y.txt", "component", 1);  // E:
        echo getpathcomponent("E:\x\y.txt", "component", 2);  // x
        echo getpathcomponent("E:\x\y.txt", "component", 3);  // y.txt
        echo getpathcomponent("E:\x\y.txt", "component", 4);  // <nothing>
        echo getpathcomponent("E:\x\y.txt", "component", -1); // y.txt
        echo getpathcomponent("E:\x\y.txt", "component", -2); // x
        echo getpathcomponent("E:\x\y.txt", "component", -3); // E:
        echo getpathcomponent("E:\x\y.txt", "component", -4); // <nothing>
        echo getpathcomponent("\\Mars\Venus", "component");   // Mars


v11.40.0205 - 2012-08-19 12:52
    * SC getPathComponent: Now any trailing colon (:) is removed from the
      returns, so "drive" will now return the drive letter alone: "E" 
      instead of "E:".
      Also now "/" is supported as component separator.

v11.40.0206 - 2012-08-20 12:07
    + SC getPathComponent enhanced: Added two further values for the 
      "component" parameter.
      Syntax: getpathcomponent([path], [component], [index=1])
        component:
          count:    The count of components.
          server:   The server in case of an UNC path, else the drive.
      Examples:    
        echo getpathcomponent("\\Mars\Venus", "count");   // 2
        echo getpathcomponent("\\Mars\Venus", "server");  // Mars

Code: Select all

foreach($ITEM, get("SelectedItemsNames", "|") ){
    $B = getpathcomponent($ITEM, "base");
    $E = getpathcomponent($ITEM, "ext");
    msg "You could e.g. rename $ITEM<crlf>to $B.bak.$E",1;
  }

Code: Select all

Expression:
. (a dot)		- one any single character (char, digit, sign, blank)
a 		- the char "a", abc - the string "abc"  literally
(aa|bb)		- one of the alternatives "aa" or "bb"
[ab3-] 		- one from list ("a" or "b" or "3" or "-")
[^ab3-] 	- one sign but none from the list
[a-z] 		- one from the range "a", "b" till "z"
3 		- the digit "3", 2013 - the number "2013" literally
[6-9] 		- one any digit from the range "6", "7" till "9"
\w 		- one any letter, digit or underscore
\d 		- one any digit from "0", "1" till "9"
\s		- one blank, -	- one hyphen literally
_		- one underscore, \.	- one dot literally
(...) 		- group an expression to apply operators or for backreference
\W \D \S	- the opposite of lower case \w \d \s 
Quantifier:
* 		- match greedy zero or more times the previous expression
+ 		- match greedy one or more times the previous expression
{3} 		- match exactly 3 times the previous expression
{3,} 		- match greedy but at least 3 times the previous expression
{3,5} 		- match greedy 5, or 4, or 3 times the previous expression
? 		- behind * or + or {,} will limit the match to as few as possible (non-greedy)
? 		- behind an expression matches on zero or one occurrence
Bounderies:
\b 		- match at word boundary, \A or ^ - at start, \Z or $ - at end of file name
Meta signs:
\ 		- use the escape character "\" to match an meta sign itself
Meta signs are: ., \, (, ), [, {, }, +, *, ?, |, ^, $


backreference replacement:
$1 		- insert here what was matched by first (...)-group from left
$2 		- insert here what was matched by second (...)-group
$3 ... $9 	- insert what was matched by third, fourth, fifth,... till ninth group
Groups could be nested: ($1) ($2) ($3($4($5...))) ($6)
(Note: some flavors use \1 syntax instead of $1)

Find more information:
http://www.regular-expressions.info/reference.html

Code: Select all

v8.80.0060 - 2010-01-27 22:50
    * Startup, App Data Path: Now, if
      - no app data path is set by command line
      - AND (no startup.ini is found in app path OR startup.ini contains no app data path)
      - AND no XYplorer.ini is found in app path
      then the app data path is auto-set to <xypath>\Data.
      Reason: Keeping the variable user data together in one place is a
      good idea. Even in portable installations which is the typical
      context for this scenario.

Code: Select all

"Save current toolbar to file"
   $CurrentToolbar = toolbar();
   $File = inputfile("<xydata>", ,"Chose or create file to save toolbar");
   writefile("$File" , $CurrentToolbar); //CurrentToolbar.txt
   msg "Done.<crlf>$File";

"Load toolbar from file"
   $File = inputfile("<xydata>", ,"Chose file to load toolbar");
   $CurrentToolbar = readfile("$File"); //CurrentToolbar.txt");
   toolbar("$CurrentToolbar");

Code: Select all

button
    Emulates a click on a toolbar button.

Syntax 
    button key, [action=1]

key [required] Key that identifies the button.
     You can retrieve the existing keys using the SC toolbar, or using the Customize Toolbar 
     command from a user button's context menu. 

action [optional] e.g.: 2 = right-click

Examples
     button "mru";         //pops MRU menu at key

Code: Select all

::#705;    $tmpfile="%temp%\XYComandIDs.txt";    writefile($tmpfile, "<clipboard>");    run notepad $tmpfile;