My Slickedit Macros ::

Take the My Slickedit Macros Challenge

2010-08-21T15:41:00.011-04:00

My Slickedit Macros challenge:

Create a Slick-C macro that will show, at a glance, all unbound keys and key combinations in your current Slickedit configuration. It's the opposite of generating a Key Chart (Options > Keyboard and Mouse > Key Bindings > "Save Chart") or a keydefs.e file ("list_keydefs" command). If you already have such a macro, I invite you to share it.

Having a list of currently unbound keys can improve the efficiency of identifying keys and key combos that are free to be assigned. The macro will reduce the need to identify unbound keys from memory or by hunt and peck.

The macro should apply to the Default mode key bindings but it can also be used on the current mode or language--HTML, C++, Ruby, etc.--if you like.

Awhile back, Slickedit added "Search by Key Sequence" to the Key Bindings window. This is a wonderful feature. Better yet, they added the same search feature to several other configuration dialogs as well. Still, however, these features don't show unbound keys.

Prior to moving to Slickedit around 10 years ago, my text editor of choice was Kedit. Its macro language, KEXX, was based on Mike Cowlishaw's great REXX language. Incidentally, Slickedit's original macro language was REXX, and if I'm not mistaken, Slickedit spent its early years maturing on a single platform: OS/2. I started out with Visual Slickedit version 4.0b on OS/2 version 2.11 (or Warp, I don't remember).

On Kedit I had a macro, unbound.kex, which did everything I described above. Due to the crude composition of that macro, and the differences in Slick-C and KEXX, the Kedit macro is insufficient to translate into a Slick-C version. I'm rusty on my Slick-C, and haven't been able to get myself to write the macro or module--let's call it "unbound.e" So I'm entreating the public to meet the challenge of creating the unbound macro.

The developer with the winning solution by December 31, 2010 gets a free hardcover copy of John Hurst's book, Professional Slickedit.

25 Throwaway Macros

2009-05-18T00:13:00.011-04:00

How many lines of good Slick-C macros wind up in the bit dumpster every day because we can't be bothered to name the macro, shove it into a file, stick the file in a folder and make it available for others to share?

Some, maybe? Below I present 25 of my throwaway macros. Maybe you'll find something of interest here. Some of the macros are simple Slick-C batch files which I created to use in my work. Others are simple macros that I wrote or cobbled together for one reason or another.

Side Note: Occasionally, you'll see line breaks in unusual places in a command or line of code, like this:

_command void html_validator_preview()

name_info(','VSARG2_MARK|VSARG2_READ_ONLY|

VSARG2_REQUIRES_EDITORCTL)



 This is necessary because Blogger apparently truncates, without a line break,

code on the right side of the blog at approx. column 54 and buries the

rest of the line on the right where it can't be seen. Unfortunately, this means

that we must hand-edit nearly every line of code to ensure that the lines are not

too long for Blogger.



So I have to put a lot of line breaks into the code just so people can actually

read it and possibly benefit from it. I do not use continuation characters at

the end of the lines because they are not necessary for display and might make

the code more confusing. If anyone knows what I'm doing wrong, please

post a note or send me an email.



Additionally, Slickedit seems to have added a lot of new commands or functions

in the last few major version upgrades. This is highly commendable, especially

since much of the new code consists of simple commands that, in my opinion,

should have existed long ago. It's possible that some of the commands below

duplicate some of the new Slick-C commands.



Here are your throwaways.

// Move cursor to end of line, add a

// space, and join with next line.

// Should intelligently remove any extra

// spaces at the end of the top line

_command dh_bring_up, join_line_with_space() 

name_info(','VSARG2_REQUIRES_EDITORCTL)

{

   save_pos(p);

   end_line();

   last_event(name2event(' '));maybe_complete();

   linewrap_delete_char();

   restore_pos(p);

}



// Open current file in external program

// CSE HTML Validator and proceed to

// validate with the current Slickedit file in

_command void html_validator_preview()

name_info(','VSARG2_MARK|VSARG2_READ_ONLY|

VSARG2_REQUIRES_EDITORCTL)

{

   _str filename=p_buf_name;

   shell("F:\\Software\\CSE_HTMLValidator80\\

cmdlineprocessor.exe -o "filename);

}





// Balance_windows: Neatens up two MDI windows

// by making the two windows the same height

// and width. Makes adjacent windows snug

// like they look right after you split a

// window. Based on a routine from emacs

// emulation. 

// 

// This macro currently doesn't work on

// more than two MDI windows at once. If

// you do execute the command with more than 2 

// windows open, multiple windows will be

// displayed at once, instead of two windows

// balanced next to each other.

/ 

// Returns: 0 if the windows were

// resized, otherwise 1.

_command int balance_windows() 

name_info(','VSARG2_READ_ONLY|VSARG2_ICON|

VSARG2_REQUIRES_MDI_EDITORCTL|VSARG2_REQUIRES_MDI)

{

   if (_no_child_windows()) {

      // No child windows, so they can't be balanced.

      return(1);

   }

   if (_mdi.p_child.p_window_state:=='M') {

      message('Only one visible window');

      return(1);

   }

   int count;

   int orig_wid;

   orig_wid=p_window_id;



   count=0;

   do {

      next_window();

      count++;

   } while ( p_window_id!=orig_wid );

   if (count>1 && count <4) {

      _no_resize=1;

      tile_windows('h');

      _no_resize='';

      return(0);

   } else {

      if (count>=4) {

         letter=letter_prompt('More than three '\\'

windows active.  Tile them? (y/n/q)','YNQ');

         if (upcase(letter)=='Y') {

            tile_windows('h');

            return(0);

         }

      }

   }

   return(1);

}





// example of using filter selection

_command test_filter()

{

   if (select_active()) {

      lock_selection();

      _end_select();

      end_line=p_line;

      _begin_select();

      filter_init();

      while (p_line<end_line) {

         filt_status=filter_get_string(text);

         if (!(_lineflags() & HIDDEN_LF)) {

            messageNwait('p_line 'p_line' VIS,

text= 'text' filt_status= 'filt_status);

         } else {

            messageNwait('line 'p_line ' is HIDDEN');

         }

      }

      filter_restore_pos();

   }

}



// run external cmd unh.exe on html file in

// current buffer and display in

// new/current window

_command unhtm() 

name_info(','VSARG2_REQUIRES_EDITORCTL)

{

   html_fid=p_buf_name;

   txt_fid=html_fid:+'.txt'

           shell('unh.exe ' html_fid txt_fid);

   e(txt_fid);

}

// if arg appears in current line, just delete

// that line

_command del(...) name_info(','VSARG2_REQUIRES_EDITORCTL)

{

   // requires a line target

   searchstr=arg(1);  // TODO: differentiate bet

// numeric & string arg

   parse searchstr with delim +1 sstring(delim)opts

   save_pos(p);

   select_line();

   status=search(sstring, 'e>':+opts);

   cursor_up();

   select_line()

   delete_selection();

   restore_pos(p);

}



// Show count of hidden lines in a

// selective display

_command count_hidden_lines()

{

   NoflinesShown0=((p_Noflines)-p_Nofhidden);

   message( NoflinesShown0' visible (selected) lines,

p_Noflines= 'p_Noflines'; p_Nofhidden = 'p_Nofhidden);

}



// insert a horizontal separator line

// consisting of any character selected

// on being prompted

_command insert_separator(...) 

name_info(',' VSARG2_READ_ONLY|

VSARG2_REQUIRES_EDITORCTL)

{

   parse p_margins with left_ma right_ma new_para_ma;

   if (arg(1)=='') {

      message('Type a separator character');

      key=get_event();



      if (event2name(key)=='ESC') {

         clear_message();

         stop;

      }



      sepchar=event2name(key);

   } else {

      sepchar=arg(1);

   }

   textstr=substr('',1,right_ma,sepchar);

   insert_line(textstr);

   insert_line('');

   down();

   clear_message();

}



// expands selective display on selected

// (marked) lines 

_command expand_selected()

{

   // TODO: test for select_active()

   end_select();

   selend=p_line;

   begin_select();

   selbegin=p_line;

   row_count=(selend - selbegin + 1);

   for (i=0;i<=row_count;++i) {

      _lineflags(0,PLUSBITMAP_LF|MINUSBITMAP_LF|

HIDDEN_LF|LEVEL_LF);

      down();

   }

   message('Expanded ' selbegin ' through ' selend);

   // might detect + lines and msg

// which ones were expanded

}



// Toggle selective display of all

// _commands in vusrmacs.e or any other file.

// I use this macro frequently, whenever

// I want a quick overview of all my commands by

// name

_command show_commands,cmds() 

name_info(','VSARG2_MARK|VSARG2_REQUIRES_EDITORCTL|

VSARG2_READ_ONLY|VSARG2_REQUIRES_TAGGING)

{

   // show all section headers and _commands

   all('(^_command|^/\* \<-|/\*\>)','r');

   // all('^_command', 'r');

}





// get mark_id for selection in another buffer

_command get_mark_id()

{

   if (!select_active()) {

      message(get_message(TEXT_NOT_SELECTED_RC));

   } else {

      mark_id=_alloc_selection();

      message('mark_id= 'mark_id);

      if (mark_id<0) {

         message(get_message(mark_id));

         return(mark_id);

      }

   }

}



// is selection hidden?

// to fix: hide_selection currently deselects after hiding,

// so there's no selection here to check for to toggle

_command is_selhid()

name_info(','VSARG2_EDITORCTL|VSARG2_READ_ONLY|VSARG2_REQUIRES_AB_SELECTION|VSARG2_REQUIRES_MDI_EDITORCTL|VSARG2_MARK|VSARG2_REQUIRES_EDITORCTL)

{

   if (!select_active()) {

      message get_message(TEXT_NOT_SELECTED_RC);

      stop;

   }

   mark_id=_alloc_selection();

   _get_selinfo(start_col, end_col, dummy);

   NofSelectedLines=count_lines_in_selection();

   NofSelectedCols=(end_col - start_col);

   begin_select();

   topline=p_line;

   end_select();

   botline=p_line;

   sticky_message('Marked block:

rows='NofSelectedLines', cols='NofSelectedCols',

left='start_col', right='end_col', top='topline',

bot='botline);



   goto_line(topline);



   if (!(_lineflags() & HIDDEN_LF)) {

      messageNwait("topline not hidden");

   } else {

      messageNwait('is_selhid: topline is hidden');

   }



   goto_line(botline);



   if (!(_lineflags() & HIDDEN_LF)) {

      messageNwait("botline not hidden");

   } else {

      messageNwait('is_selhid: botline is hidden');

   }

}





// add toggle ability to select_all key

_command select_all_toggle() 

name_info(','VSARG2_REQUIRES_EDITORCTL)

{

   if (!select_active()) {

      select_all();

   } else {

      deselect();

   }

}



// append a cmd to end of ".command" retrieve buffer

_command append_retrieve_buffer() 

name_info(','VSARG2_CMDLINE|VSARG2_ICON|

VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)



{

   if (!command_state()) {

      cmdline_toggle();

   }

   get_command(text);

   append_retrieve_command(text);

   set_command('',1);

}

Character, Word and Line Count for Current File

2009-03-19T11:59:00.004-04:00

// command wc(): Display on the message line,
// the total numbers of characters, words and
// lines in the current file.
//
// This ubiquitous procedure has been done ad
// infinitum by many developers. It's almost
// as common as Hello World! I don't presume
// to hold any claim to it.
//
// On a large file of several thousand lines
// or more, it can take a few seconds to
// display its results

_command wc() {
   cc = 0; // character count
   wc = 0; // word count
   lc = 0; // line count
   item = 0;
   _save_pos2(p);
   top_of_buffer();
   for (;;) {
      get_line line;
      lc++;
      for (i = 1; i < length(line); i++) {
         cc++;
         if (isalnum(substr(line,i,1))) {
            item = 1;
         } else if (item && !isalnum(substr(line,i,1))) {
            wc++;
            item = 0;
         }
      }
      status=down();
      if (status == BOTTOM_OF_FILE_RC) {
         message("chars: " cc " / words: " wc " / lines: " lc);
         break;
      }
   }
   _restore_pos2(p);
}

Count Lines Traversed

2009-03-17T21:36:00.011-04:00

// Using the cursor-up or cursor-down keys,
// display on the message line the total number
// of lines the cursor has moved.

// Assign a key combination to the line_counter
// command. Press the key combo to start the counter.
// It initializes with a value of 0. Press ESC to stop.
//
// Move your cursor up or down to reach your target.
// The target is typically a certain number of lines you
// want to traverse, or some specific text you want to
// reach. With each cursor-up/down keystroke the displayed
// count will decrement or increment by 1. Moving the
// cursor up will decrement the number of lines;
// moving the cursor down increments the line count.
// Change this if you want.
//
// This macro can actually be valuable once in a while.
// But I must plead ignorant for now; I've forgotten what I
// use it for!

_command line_counter() name_info(','VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)
{
   lines=0;
   message('Number of lines traversed='lines)

   for (;;) {
      key = get_event();
      keyname=event2name(key);

      if (keyname=='DOWN') {
         cursor_down();
         ++lines;
      }

      if (keyname=='UP') {
         cursor_up();
         --lines;
      }
      message('Linecount='lines)

      if (keyname=='ESC') {
         message('Linectr cancelled')
         break;
      }
   }
}

I repeat myself when under stress, I repeat myself when under stress . . .

2009-03-12T21:31:00.011-04:00

// repeat_n [how many times] [command name]
// Repeats a command the number of times specified.
// Args are "n command", where n is the number of times
// to execute the command, and command is the name of
// the command to run.
//
// Usage example: repeat_n 15 cursor_down
// This will execute the cursor-down command 15 times, with the
// expected results.

// Source: Professional Slickedit by John Hurst
// Copyright 2007 Wiley Publishing Inc, Indianapolis, Indiana, USA.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0

_command void repeat_n(_str args = null) \\
                 name_info(','VSARG2_EDITORCTL) 
{
   if (args == null) {
      message("Specify number of times and " \\
   "command to run.");
      return;
   }
   _str n;
   _str command;
   parse args with n command;
   if (n <= 0 || command == null) {
      message("Specify number of times and " \\
   "command to run.");
      return;
   }
   int i;
   for (i = 0; i < n; i++) {
      execute(command);
   }
}

// repeat_n_last_macro [how many times]
// Repeats the last recorded macro the number of times specified
// Usage example: repeat_n_last_macro 25
// Executes the last recorded macro 25 times

// Source: Professional Slickedit by John Hurst
// Copyright 2007 Wiley Publishing Inc, Indianapolis, Indiana, USA.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0

_command void repeat_n_last_macro(_str args = null) \\ 
              name_info(','VSARG2_EDITORCTL) 
{
   repeat_n(args :+ " last_macro");
}

Circuitous Logic

2009-03-12T00:28:00.018-04:00

// (1) Get and set your margin settings at desired increments.
// Assign this macro to a key combination.
// Stick your favorite margin presets into the macro code.
// I like to use 1 80 1, 1 128 1, 1 256 1, 1 512 1 and 1 1024 1.

// The same "cycling" method can be used on almost any setting.
// For example, you can easily modify this macro to take a text
// selection and cycle the text through all caps, initial caps,
// all lower case, and so on.

// Currently the macro will automatically increment to the next
// setting each time the key combo is pressed (including the
// first press). If the margins are currently 1 256 1, executing
// the command will increment the setting to 1 512 1. If 512
// is not the setting you want, just press the key combo again
// to set your desired value.
//

// (2) Cycle through display modes: hex, line hex, normal edit.
//

_command cycle_right_margin() name_info(','VSARG2_REQUIRES_EDITORCTL, VSARG2_READ_ONLY)
{
   parse p_margins with left_ma right_ma new_para_ma;
   // message("Current margin settings "left_ma' 'right_ma' 'new_para_ma);
   switch (right_ma) {
   case 80:
      p_margins=left_ma' '128' 'new_para_ma;
      message('Margins 'p_margins);
      break;
   case 128:
      p_margins=left_ma' '256' 'new_para_ma;
      message('Margins 'p_margins);
      break;
   case 256:
      p_margins=left_ma' '512' 'new_para_ma;
      message('Margins 'p_margins);
      break;
   case 512:
      p_margins=left_ma' '1024' 'new_para_ma;
      message('Margins 'p_margins);
      break;
   case 1024:
      p_margins=left_ma' '80' 'new_para_ma;
      message('Margins 'p_margins);
      break;
   default:
      p_margins=left_ma' '80' 'new_para_ma;
      message('Margins 'p_margins);
      break;
   }
}


// (2) Cycle through display modes: hex, line hex, normal edit.
// From Thom Little & Associates, www.tlanet.net


#define TLA_DISPLAY_EDIT      0
#define TLA_DISPLAY_HEX       1
#define TLA_DISPLAY_LINE_HEX  2

_command void tlaViewCycle( ) name_info( ',' VSARG2_ICON | VSARG2_REQUIRES_MDI_EDITORCTL )
   {
   switch ( p_hex_mode )
      {
      case TLA_DISPLAY_EDIT :
         p_hex_mode = TLA_DISPLAY_HEX ;
         break ;
      case TLA_DISPLAY_HEX :
         p_hex_mode = TLA_DISPLAY_LINE_HEX ;
         break ;
      case TLA_DISPLAY_LINE_HEX :
         p_hex_mode = TLA_DISPLAY_EDIT ;
         break ;
      default :
         tlaError( "tlaViewCycle", "Unknown view state" );
         break ;
      }
   return ;
   }

Change current file's file extension

2009-03-11T01:18:00.009-04:00

// change fext or prompt for fully qualified buffer name
_command fe, fext() name_info(','VSARG2_EDITORCTL|VSARG2_CMDLINE)
{
   fid=p_buf_name;
   new_fext=arg(1);
   if (new_fext=='') {
      name();
      return(0);
   }
   buf_nofext=strip_filename(fid,'E');
   new_fid=buf_nofext:+'.':+new_fext;
   status=name(new_fid);
   if (status) {
      message('Fext was not changed');
      return(0);
   } else {
      save_as(new_fid);
      return(1);
   }
}

Remove "no-save" and "current line" lineflags

2009-02-27T21:20:00.009-05:00

The purpose of this macro is to remove certain 
lineflags placed in the text manually be the user.  
These particular lineflags were explored in "Fun 
with Lineflags." That post can be found elsewhere 
in this blog.  

The use of the "no-save"(NLF) and "current line" 
(CLF) lineflags were bastardizations, in that the 
flags were not meant to used in ways I showed.  
One thing you can do with these lineflags is to 
use them to tag special lines, much like using a 
bookmark.  It doesn't have any great uses.  

When flagged with either of these lineflags, small 
icons will be displayed in the left margin of the 
selected lines.  You can also use the lineflags to 
show a background color of you choice for each 
flagged line.  This can help to distinguish the 
specially lineflagged lines from other selective 
display lines.  You can create selective displays 
using color backgrounds of your choice for the 
selected lines to display all lines with those 
particular bits.  

I have some simple macros named "all_nl" and 
"all_clf" and others created to be used for having 
fun with lineflags.  At the bottom of this post is 
a tiny macro for toggling a lineflag on a line.  
In this case it deals with "CLFs" only.


// turn NLF & CLF OFF for ALL lines
_command untag_all_nlfclf()
{
   if (p_mode_name=='Fileman') {
      deselect_all();
   } else {
      save_pos(p)
      top();up();
      _lineflags(0,CURLINEBITMAP_LF);
      _lineflags(0,NOSAVE_LF);
      for (;;) {
         if (down()) break;
         _lineflags(0,CURLINEBITMAP_LF);
         _lineflags(0,NOSAVE_LF);
      }
      restore_pos(p);
   }
}

------------------------

// toggle CLF for current line
_command clf_toggle()
{
   if (!(_lineflags() & CURLINEBITMAP_LF)) {
      _lineflags(CURLINEBITMAP_LF,CURLINEBITMAP_LF);
   } else {
      _lineflags(0,CURLINEBITMAP_LF);
   }
   down();
}

arg_show_lines (...)

2009-02-22T21:31:00.006-05:00

// command arg_show_lines(...)

// In a selective display, show a range of lines by line number
// The main goal here is to open a range of hidden lines to view.
// If the range contains already-displayed lines, they'll be
// displayed  along with the newly displayed hidden lines
//
// Usage: arg_show_lines 352 396
//
// Note: if a line with a "minus bitmap" is displayed before
// executing this macro, the minus bitmap will be removed; this
// makes some sense because the macro is meant to remove all
// minus and plusbitmap lines as it unhides all lines in the
// selected range
//
_command void arg_show_lines(...) name_info(','VSARG2_MARK|VSARG2_REQUIRES_EDITORCTL)
{
parse arg(1) with first_line last_line       // get line numbers from the
p_line=first_line;                           // command-line arguments
up();
if (p_line<=1) {                             // check the lineflags in the      p_line=0;                                 // range, get seldisp level      new_level=0;   } else {      new_level=_lineflags()&LEVEL_LF;      if (!up()) {         new_level=_lineflags()&LEVEL_LF;         down();      }   }   for (;;) {                                    // go through all lines in the      if (p_line>last_line) break;               // specified range and bust
   level=(_lineflags() & LEVEL_LF);           // them out of hidden state
   _lineflags(new_level,HIDDEN_LF|LEVEL_LF|PLUSBITMAP_LF|MINUSBITMAP_LF);
   status=down();
   if (status) {
      break;
   }
   if (p_line>last_line) {
      break;
   }
}
p_line=last_line;
}

Revisiting the Longest_line Macro

2009-02-07T03:58:00.012-05:00

If anyone can tell me how to prevent the macro text
from truncating on the right, please drop me a line.
I know I can insert line breaks manually, but there
must be a better way.

Thank you, fellow Slick editors John Hurst and Mark
Robbins, for providing useful suggestions and
revisions to the longest_line macro.

Below are (1) the original version of the macro
(called longest_line0), (2) John's improved version
(longest_line1), and (3) Mark's expanded and enhanced
version (longest_line2).

This macro still needs the ability to identify and
report on multiple lines matching the length of the
first of the longest lines found. The macro could
further be easily modified to show the document's
longest lines in a selective display.

Anywho, I'll let you decide the differences in each
of these three macros. Maybe you'll find a good use
for them.

// Find longest line in buffer; display line number and length
_command longest_line0,longln() name_info(','READ_ONLY_ARG2)
{
   save_pos(p);
   top();up();max=0;
   while (!down()) {
      get_line(line);
      len=length(line);
      if (len > max) {
         max=len;
         max_linenum=p_line;
      }
   }
   message('Longest line is ' max_linenum ' with ' max ' bytes');
   restore_pos(p);
}

// with modifications by John Hurst 
_command longest_line1() name_info(','READ_ONLY_ARG2)
{
   typeless p;
   save_pos(p);
   top();
   up();
   int max = 0;
   int max_linenum = -1;
   while (!down()) {
      _str line;
      get_line(line);
      int len = length(line);
      if (len > max) {
         max = len;
         max_linenum = p_line;
      }
   }
   message('Longest line is ' max_linenum ' with ' max ' bytes');
   restore_pos(p);
   if (max_linenum >= 0) {
      p_line = max_linenum;
   }
}

// modified and enhanced by Mark Robbins
_command longest_line2() name_info(','READ_ONLY_ARG2)
{
   save_pos(p);
   top();up();max=0;
   while (!down()) {
      get_line(lin);
      len=length(lin);
      if (len > max) {
         max=len;
         max_linenum=p_line;
      }
   }
   //message('Longest line is ' max_linenum ' with ' max ' bytes');
   s='Line 'max_linenum ' is longest with ' max ' bytes';
   rv=(_message_box(s,'Goto Line', MB_DEFBUTTON2|MB_YESNO|MB_ICONQUESTION)==IDYES);
   if (rv==1) {
      goto_line(max_linenum);
   }else{
      restore_pos(p);
   }
}

/*
And here is a simplified msg box:

Usage:
rv=msg_box_ask(‘Question?’,‘yN’); // default btn is No, returns 1 if yes, 0 if no
rv=msg_box_ask(‘Question?’,‘ynC’); // default btn is Cancel, returns 1 if yes, 2 if no, 3 if cancel
rv=msg_box_ask(‘Question?’,‘yN’,’h’); // default btn is No, Icon is hand, returns 1 if yes, 0 if no
rv=msg_box_ask(‘Question?’,‘yN’,’h’,’title’,’’); // default btn is No, Icon is hand, returns ‘yes’ if yes, ‘no’ if no
very tricky now….

rv=msg_box_ask(‘Question?’,‘yN’,’h’,’title’,’yes’); // default btn is No, Icon is hand, returns true if yes, else false
*/

int msg_box(_str string, _str title="Visual SlickEdit", int mb_flags=MB_OK|MB_ICONEXCLAMATION)
{
return _message_box(string,title,mb_flags);
}


typeless msg_box_ask(_str string, _str buttons='', _str icon='', _str title="Visual SlickEdit",typeless retcode=0)
{
//buttons
// o,ok,'';c,oc;a,ari,i;y,n,yn;ync;r,rc
// icons
// h,q,e,i,s,n
but=0;
b=lowcase(buttons);
if (b==''||b=='o') {but=MB_OK;}
if (b=='oc'||b=='c') {but=MB_OKCANCEL;}
if (b=='ari'||b=='a'||b=='i') {but=MB_ABORTRETRYIGNORE;}
if (b=='y'||b=='n'||b=='yn') {but=MB_YESNO;}
if (b=='ync') {but=MB_YESNOCANCEL;}
if (b=='r'||b=='rc') {but=MB_RETRYCANCEL;}
b=buttons;
d=0;
if (pos('C',b)==2) {d=MB_DEFBUTTON2;}
if (pos('C',b)==3) {d=MB_DEFBUTTON3;}
if (pos('R',b)==2) {d=MB_DEFBUTTON2;}
if (pos('R',b)==1) {d=MB_DEFBUTTON1;}
if (pos('I',b)==3||pos('I',b)==1) {d=MB_DEFBUTTON3;}
if (pos('N',b)==2) {d=MB_DEFBUTTON2;}
i=MB_ICONNONE;
// h,q,e,i,s,n
if (icon=='n') {i=MB_ICONNONE;}
if (icon=='h') {i=MB_ICONHAND;}
if (icon=='q') {i=MB_ICONQUESTION;}
if (icon=='e') {i=MB_ICONEXCLAMATION;}
if (icon=='i') {i=MB_ICONINFORMATION;}
if (icon=='s') {i=MB_ICONSTOP;}
if (icon=='n') {i=MB_ICONNONE;}
if (icon=='')  {
if (but==MB_OK) {i=MB_ICONNONE;}
if (but==MB_OKCANCEL) {i=MB_ICONQUESTION;}
if (but==MB_ABORTRETRYIGNORE) {i=MB_ICONEXCLAMATION;}
if (but==MB_YESNO) {i=MB_ICONQUESTION;}
if (but==MB_YESNOCANCEL) {i=MB_ICONQUESTION;}
if (but==MB_RETRYCANCEL) {i=MB_ICONSTOP;}
}
v=msg_box(string,title,but|d|i);
if (retcode==0&&retcode._varformat()==VF_INT) {
if (but==MB_OK) {
if (v==IDOK) {return 1;}else{return 0;}
}
if (but==MB_OKCANCEL) {
if (v==IDOK) {return 1;}else{return 0;}
}
if (but==MB_ABORTRETRYIGNORE) {
if (v==IDABORT) {return 1;}
if (v==IDRETRY) {return 2;}
if (v==IDIGNORE) {return 3;}
}
if (but==MB_YESNO) {
if (v==IDYES) {return 1;}else{return 0;}
}
if (but==MB_YESNOCANCEL) {
if (v==IDYES) {return 1;}
if (v==IDNO) {return 2;}
if (v==IDCANCEL) {return 3;}
}
if (but==MB_RETRYCANCEL) {
if (v==IDRETRY) {return 1;}else{return 0;}
}
return(0);
}
if (retcode==1&&retcode._varformat()==VF_INT) {return v;}

if (retcode._varformat()==VF_LSTR) {
if (retcode=='') {
if (but==MB_OK) {
   if (v==IDOK) {return 'ok';}
}
if (but==MB_OKCANCEL) {
   if (v==IDOK) {return 'ok';}else{return 'cancel';}
}
if (but==MB_ABORTRETRYIGNORE) {
   if (v==IDABORT) {return 'abort';}
   if (v==IDRETRY) {return 'retry';}
   if (v==IDIGNORE) {return 'ignore';}
}
if (but==MB_YESNO) {
   if (v==IDYES) {return 'yes';}else{return 'no';}
}
if (but==MB_YESNOCANCEL) {
   if (v==IDYES) {return 'yes';}
   if (v==IDNO) {return 'no';}
   if (v==IDCANCEL) {return 'cancel';}
}
if (but==MB_RETRYCANCEL) {
   if (v==IDRETRY) {return 'retry'}else{return 'cancel';}
}
return'fail';
}else{
r=retcode;

if (but==MB_OK) {
   if (v==IDOK) {return ('ok'==r);}
}
if (but==MB_OKCANCEL) {
   if (v==IDOK) {return ('ok'==r);}else{return ('cancel'==r);}
}
if (but==MB_ABORTRETRYIGNORE) {
   if (v==IDABORT) {return ('abort'==r);}
   if (v==IDRETRY) {return ('retry'==r);}
   if (v==IDIGNORE) {return ('ignore'==r);}
}
if (but==MB_YESNO) {
   if (v==IDYES) {return ('yes'==r);}else{return ('no'==r);}
}
if (but==MB_YESNOCANCEL) {
   if (v==IDYES) {return ('yes'==r);}
   if (v==IDNO) {return ('no'==r);}
   if (v==IDCANCEL) {return ('cancel'==r);}
}
if (but==MB_RETRYCANCEL) {
   if (v==IDRETRY) {return ('retry'==r)}else{return ('cancel'==r);}
}
return false;
}
}
return(-1);
//return (msg_box(string,title,MB_YESNO|MB_DEFBUTTON2|mb_flags2)==IDYES);
}

Count Paragraphs

2008-12-30T12:35:00.005-05:00

 COUNT PARAGRAPHS in a document

// count number of paragraphs in buffer
// FYI: the macro counts the first paragraph properly
// regardless of whether it is proceeded by a blank line
// at the top of file

// count number of paragraphs in buffer or range
_command coupar,count_paragraphs() name_info(','VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)
{
#define PARAGRAPH_SKIP_CHARS ' \t'
#define PARAGRAPH_SEP_RE      ('(^['PARAGRAPH_SKIP_CHARS']*$)')
#define SKIP_PARAGRAPH_SEP_RE ('^~(['PARAGRAPH_SKIP_CHARS']*$)')

   if (p_Noflines==0) {
      message('Empty file');
      stop;
   } else {
      para_count=1;
   }
   _save_pos2(p);
   top();up();

   for (;;) {
      _begin_line;
      /* skip paragraph separator lines */
      status=search(SKIP_PARAGRAPH_SEP_RE,'r');
      if ((status==BOTTOM_OF_FILE_RC) || (status==STRING_NOT_FOUND_RC)) {

         get_line(line);
         if (line=='') {
            para_count = para_count - 1;
         }

         message(para_count ' paragraphs');
         break;
      } else {
         /* Search for paragraph separator line. */
         status=search(PARAGRAPH_SEP_RE,'r');
         if ((status==BOTTOM_OF_FILE_RC) || (status==STRING_NOT_FOUND_RC)) {
            message(para_count ' paragraphs');
            break;
         }
         ++para_count;
      }
   }
   _restore_pos2(p);
}

Childlike in Its Simplicity

2008-12-21T21:22:00.011-05:00

Over many years, I've used different versions of the "jump_srch" macro as a productivity enhancer.

The example of jump_srch code below is rudimentary and only involves quick searching between two MDI windows. I plan to add more complete versions in the near future. This macro can be made much more versatile and powerful, incorporating such tasks as automatic insertion, deletion, checking and indexing of text between windows. For now, you're getting it in its bare bones flavor. Please don't laugh too loud when you see the actual macro. We all have to start somewhere!

The base use of the macro is to employ find and next_window commands between two visible Slickedit MDI windows. The two windows can contain the same buffer (aka "file") or two different buffers. I haven't used this macro in more than two windows at a time, although I
suppose you could cycle the cursor through however many windows you want. FYI: I always have "one file per window" turned OFF. I don't know if the macro would be adversely affected by having it turned ON.

How it works: with your cursor on a text string in Window A, you press the key binding for jump_srch and the cursor jumps to Window B and locates the next matching search string, if any, in Window B. You can, if you like, continue searching for the same string in Window B or you can return to Window A and go on your merry way.

I use the binding "Ctrl-G" to find the next instance of a search term within a single file. To move my cursor back to Window A from Window B, I use a simple key binding for next_window. In my case, next_window is bound to "Ctrl-Tab." In other words, you use jump_srch to seek the string in the other window, and then you use next_window to return to the first window. This is handy when you need to locate or cross-check certain words or phrases which appear in both files or both windows.

Here's an example of tasks for which this macro can be useful. Please forgive the use of jargon from the book publishing industry, which is where I've used this macro most often.

/*---------------------------------------------------------------*/

How to Automate Cross-checking of References and Citations
in Publication Drafts

There are two basic goals in cross-checking literary references;
these are:

1) to verify that every reference appearing in the main section of the
  document (body text, tables, figures, etc.) has a corresponding
  citation in the section designated to hold a comprehensive listing
  of citations (this is usually titled References, and appears as a
  component of the back matter)

2) to verify that every citation in the References section has a
  corresponding reference in the main section of the document

These two sections are typically maintained in two separate text files.
This facilitates creation of a system for automating
the process of checking crossreferences . . .

/*---------------------------------------------------------------*/

jump_srch, barebones version:

// put the current word into a variable, jump to the next open window, and find the text in that window
// todo etc.
// make it work with any selected current word or phrase or line
// whether the cursor is in or at the start of a word; selected or not
// allow for omore than 2 windows, etc 
// pass cmdline parameters to search command

_command void jump_search(...) name_info(',')
{
   _str keywd=cur_word(stuff);
   message(something);
   next_window();
   search(something);
}

dh_Fileinfo

2008-12-01T22:35:00.026-05:00

The dh_fileinfo macro displays an informational dialog box with
various details about the file currently being edited. I cobbled the macro
together from code available on the Slickedit Web site and elsewhere.
I've since forgotten where everything came from. This macro can be
greatly improved. You might notice, for example, that the value of some
of the variables, such as 'cc' (character count) are not yet included in the
message box.

I invite your improvements and suggestions, including ideas on stats to
add to the existing dialog.

The dh_fileinfo dialog lists:

fully qualified filename and path
file's current date and time
file size in bytes
file attributes
total number of lines in file
current margin setting
file's mode (e.g., Slick-C, HTML, C, etc.)
number of windows open in the editor
number of buffers open
number of the current View id
decimal and hex values of character under the cursor

// detailed fileinfo message box
_command dh_fileinfo() name_info(FILE_ARG'*,'READ_ONLY_ARG2)
{
   _str filename=arg(1)
            if (filename=='') {
               filename=p_buf_name;
            }
    filename=absolute(filename);
   _str filedate=file_date(filename);
   _str filetime=file_time(filename);
   _str fileattr=file_list_field(filename,DIR_ATTR_COL,DIR_ATTR_WIDTH);
    int filelen=p_Noflines;
    int bufcou=_Nofbuffers();
    int wincou=Nofwindows();
   get_view_id view_id
   parse p_margins with left_ma right_ma new_para_ma;

   // info on current character
   get_line(line);
   char=substr(line,p_col,1);
   chr_num=_asc(get_text());
   
   cc = 0; /* chars */
   wc = 0; /* words */
   lc = 0; /* lines */
   dc = 0; /* displayed lines */
   hc = 0; /* hidden lines */
   
   int item = 0;
   save_pos(p);
   top_of_buffer();
   for (;;) {
      get_line line;
      lc++;
      for (i = 1; i < length(line); i++) {
         cc++;
         if (isalnum(substr(line,i,1))) {
            item = 1;
         } else if (item && !isalnum(substr(line,i,1))) {
            wc++;
            item = 0;
         }
      }
      status=down();
      bytesize = fsize();
      dc = (p_Noflines - p_NofSelDispBitmaps);
      hc = p_Nofhidden;
      sc = p_NofSelDispBitmaps;
      pc = ( filelen intdiv 55 );
      _message_box(filename \r filedate' 'filetime \r bytesize ' bytes;  ' fileattr \r\
                   'Lines: 'filelen' '\r\
                   'Margins: 'left_ma' 'right_ma' 'new_para_ma \r\
                   'Mode: 'p_mode_name \r 'Windows: 'wincou', Buffers: 'bufcou \r\
                   'Viewid 'view_id \r\
                   'Ascii char "'char'" dec='chr_num', hex='dec2hex(chr_num),' ':+
        'FileInfo: 'p_buf_name, MB_ICONINFORMATION);

      restore_pos(p);
      break;
   }
}

make_anchor

2008-11-30T01:01:00.019-05:00

// make_anchor
// This nifty macro comes from John Hurst's book, Professional Slickedit,
// published by Wrox, a subsidiary of Wiley Publishing (Indianapolis),
// 2008, paperback, 472 pages. List price $49.99. The Slickedit macro code
// for make_anchor and many other macros in from Professional Slickedit
// can be downloaded freely from http://www.wrox.com/WileyCDA/WroxTitle/
// Professional-SlickEdit.productCd-0470122153,descCd-DOWNLOAD.html

// make_anchor creates an HTML anchor tag around the selected text.
// For example: if the selected text is "www.wrox.com", highlighting
// "www.wrox.com" and then executing make_anchor will produce the following:

<a href="http://www.wrox.com" www.wrox.com<a>

// This would, of course, be rendered to the user as the hyperlink
// www.wrox.com.

// Some editing software and blog editing programs
// nowadays incorporate similar functionality,
// but if you're editing plain text files in Slickedit, this macro could be
// a time saver.

GETL: Variation on GET Displays Number of Lines "Gotten"

2008-11-25T23:58:00.013-05:00

// Here's another of my rinky-dink macros:
// GETL: same as 'get' but displays the number of lines imported into the
// current buffer. I missed having this functionality when I switched over from
// Mansfield's Kedit. It acts as a visual confirmation of the number of
// lines imported and tells you how much bigger you're making the current
// (i.e., destination) file.

_command getl(...) name_info(FILE_ARG'*,'VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)
{
filename=arg(1)
old_noflines=p_noflines;
get(filename);
new_noflines=p_noflines;
noflines_added=(new_noflines - old_noflines)
message(noflines_added' lines added');
}

// direct complaints, suggestions or improvements to me

Fun with Line Flags!

2008-10-26T18:07:00.007-04:00

Lineflags, as defined below and in the macros that follow, are an important
element driving the attributes, behavior and display of specific types of lines
of text in a Slickedit editing session. Lineflags are used in such modules as
mouse.e, seldisp.e, util.e, builtins.e, surround.e, markfilt.e, guireplace.e,
javadoc.e and many more.

Some of the more common examples of commands that use lineflags include 'all',
'less', 'hide_all_comments', 'plusminus', 'show_braces', and 'show_paragraphs.'
A few of the uses of lineflags include the setting of levels of nested comments
and selectively displayed lines, the setting of 'no save' lines in Diffzilla,
the 'plus' or 'minus' bitmaps shown in the left margins of selective displays,
and even in the color or box appearance of the current line.

Additionally, lineflags account for the differently colored labels used to
identify 'inserted' and 'modified' lines in the lefthand margins or linenumbers
area of speacific lines in a file. Some types of lineflags set the visible
appearance of lines and some are used unseen in the background.

The basic function for manipulating lineflags, taken from Slickedit Help, is
'_lineflags', as follows. (For added flavor, I've included the bit values in
hex and decimal that are set by a few of the lineflags. I gathered these bits
from a source file in which the constants were set, in an earlier version of
Slickedit. I haven't been able to find them in the current Slickedit 2008 and
recent versions.)

Following this Help information, I present several of my 'Fun With Lineflags'
macros.)

int _lineflags(int newflags=0, int mask=newflags)

Gets or sets the line status flags for the current line. If the flags argument
is given, the line status flags for the current line are modified. mask
defaults to the same value as flags if it is not specified. The mask indicates
which bits will be set according to flags.

MLCOMMENTINDEX_LF
Indicates which multi-line comment. Only two are allowed. Must know which
multi-line comment we are in so we know what will terminate it.

MLCOMMENTLEVEL_LF
Indicates multi-line comment nest level.
Used by Difference Editor and Merge Editor. Lines with the NOSAVE_LF flag set
are not saved in the file. VIMARK_LF Used by VI emulation to mark lines.

MODIFY_LF
Line has been modified.

INSERTED_LINE_LF
Line was inserted.

HIDDEN_LF 0x00001000 4096
Indicates that this line should not be displayed.

PLUSBITMAP_LF 0x00004000 16384
Display "+" bitmap to left of this line.

MINUSBITMAP_LF 0x00002000 8192
Display "-" bitmap to left of this line.

CURLINEBITMAP_LF
Display current line bitmap.

LEVEL_LF 0x001F8000 2064384
Bits used to store selective display nest level.

NEXTLEVEL_LF 0x00008000 32768

The MLCOMMENT flags can not be modified.

Returns: int
The new current line status flags for the current line.

Examples:

if (_lineflags() & INSERTED_LINE_LF) {
messageNwait("This line was inserted");
}
if (_lineflags() & MODIFY_LF) {
messageNwait("This line was modified");
}
// Turn on hidden flag
_lineflags(HIDDEN_LF,HIDDEN_LF);
if (_lineflags() & HIDDEN_LF) {
messageNwait("HIDDEN flag is on");

}
// Turn off HIDDEN flag
_lineflags(0,HIDDEN_LF);
if (!(_lineflags() & HIDDEN_LF)) {
messageNwait("hidden flag is off");
}

Applies To:
Edit Window, Editor Control

Categories:
CursorMovement Functions, Edit Window Methods, Editor Control Methods

FUN WITH LINEFLAGS--GETTING DOWN TO BUSINESS

Below are several macros I created to explore possible novel uses of lineflags.
I've refrained from including a couple related commands because they are not
ready for prime time.

Try these on sample files that you can afford to mess up. Generally the
operations are easily reversible (as in the toggle commands), but be
particularly careful applying the NOSAVE_LF. In some situations NOSAVE Lines
may be deleted permanently when you close a file containing them.

// clf_toggle: this command toggles the 'current line' flag on any line you
// choose. 'clf' in the command name means 'current line flag.' In this
// particular implementation, the 'current line' flag appears as a green triangle
// in the left margin. You can toggle the current line flag on and off easily if
// you bind the command to a key. Each time the command is issued, the existing
// flag is toggled and the cursor moves down one line.

// toggle CLF (current line flag) for current line
_command clf_toggle()
{
if (!(_lineflags() & CURLINEBITMAP_LF)) {
_lineflags(CURLINEBITMAP_LF,CURLINEBITMAP_LF);
} else {
_lineflags(0,CURLINEBITMAP_LF);
}
down();
}

// turn ON ALL CLF indicators and flags in a file
// turn CLF ON for ALL lines
_command clf_all_lines()
{
if (p_mode_name=='Fileman') {
deselect_all();
} else {
save_pos(p)
top();up();
_lineflags(CURLINEBITMAP_LF,CURLINEBITMAP_LF);
for (;;) {
if (down()) break;
_lineflags(CURLINEBITMAP_LF,CURLINEBITMAP_LF);
}
restore_pos(p);
}
}

// turn OFF ALL CLF indicators and flags in a file
// turn CLF OFF for ALL lines
_command clf_no_lines()
{
if (p_mode_name=='Fileman') {
deselect_all();
} else {
save_pos(p)
top();up();
_lineflags(0,CURLINEBITMAP_LF);
for (;;) {
if (down()) break;
_lineflags(0,CURLINEBITMAP_LF);
}
restore_pos(p);
}
}

// turn CLF ON for lines matching search string in the current buffer
// for example, 'all_clf /VSARG2/' will add the current line flag to all
// lines containg 'VSARG2'--like the 'all' command. You might want to change the
// command name, since it can be confused with 'clf_all_lines.
_command all_clf(...) name_info(','VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)
{
int strcount;
int linecount;
_str searchstr=arg(1);
parse searchstr with delim +1 sstring(delim)opts

save_pos(p);
top(); up();

status=search(sstring, 'i>':+opts);
if (!status) {
strcount=1;
curline=p_line;
linecount=1;
_lineflags(CURLINEBITMAP_LF,CURLINEBITMAP_LF);
} else {
restore_pos(p);
message get_message(status);
stop;
}

for (;;) {
status=search(sstring, 'i>':+opts);
if (status !=0) {
break
} else {
_lineflags(CURLINEBITMAP_LF,CURLINEBITMAP_LF);
++strcount;

if (!(curline==p_line)) {
++linecount;
curline=p_line;
}

}
}
restore_pos(p);
message(strcount' occurrence(s) in ' linecount ' lines');
}

// 'NO-SAVE LINE' FLAG (displys the Slickedit default or user-set background
// color for 'no save' lines. 'NLF' means NOSAVE lineflag.)
// toggle NLF for current line
_command nlf_toggle() name_info(','VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)
{
if (!(_lineflags() & 2)) {
_lineflags(NOSAVE_LF,NOSAVE_LF);
} else {
_lineflags(0,NOSAVE_LF);
}
cursor_down();
}

// turn NLF ON for ALL lines
_command nlf_all_lines()
{
if (p_mode_name=='Fileman') {
deselect_all();
} else {
save_pos(p)
top();up();
_lineflags(NOSAVE_LF,NOSAVE_LF);
for (;;) {
if (down()) break;
_lineflags(NOSAVE_LF,NOSAVE_LF);
}
restore_pos(p);
}
}

// turn NLF OFF for ALL lines
_command nlf_no_lines()
{
if (p_mode_name=='Fileman') {
deselect_all();
} else {
save_pos(p)
top();up();
_lineflags(0,NOSAVE_LF);
for (;;) {
if (down()) break;
_lineflags(0,NOSAVE_LF);
}
restore_pos(p);
}
}

// turn NLF ON for lines matching search string in current buffer
_command all_nlf(...) name_info(','VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY)
{
int strcount;
int linecount;
_str searchstr=arg(1);
parse searchstr with delim +1 sstring(delim)opts

save_pos(p);
top(); up();

status=search(sstring, 'i>':+opts);
if (!status) {
strcount=1;
curline=p_line;
linecount=1;
_lineflags(NOSAVE_LF,NOSAVE_LF);
} else {
restore_pos(p);
message get_message(status);
stop;
}

for (;;) {
status=search(sstring, 'i>':+opts);
if (status !=0) {
break
} else {
_lineflags(NOSAVE_LF,NOSAVE_LF);
++strcount;

if (!(curline==p_line)) {
++linecount;
curline=p_line;
}

}
}
restore_pos(p);
message(strcount' occurrence(s) in ' linecount ' lines');
}

// turn NLF AND CLF OFF for ALL lines
_command untag_all_nlfclf()
{
if (p_mode_name=='Fileman') {
deselect_all();
} else {
save_pos(p)
top();up();
_lineflags(0,CURLINEBITMAP_LF);
_lineflags(0,NOSAVE_LF);
for (;;) {
if (down()) break;
_lineflags(0,CURLINEBITMAP_LF);
_lineflags(0,NOSAVE_LF);
}
restore_pos(p);
}
}

// Setting PLUS and MINUS BITMAPS

// If a 'plus' and 'minus' bitmap is shown in left margin of the current line,
// running this command on that line will remove the bitmap and its associated
// lineflag.
_command set_plusminus_lf_off()
name_info(','VSARG2_REQUIRES_EDITORCTL) {
if (_lineflags() & (PLUSBITMAP_LF|MINUSBITMAP_LF)) {
_lineflags(0,PLUSBITMAP_LF|MINUSBITMAP_LF);
cursor_down();
}
}

// sets hidden lineflag on and hides the line
_command set_hidden_lf_on() name_info(','VSARG2_REQUIRES_EDITORCTL)
{
_lineflags(HIDDEN_LF,HIDDEN_LF);
if (!(_lineflags() & HIDDEN_LF)) {
messageNwait("hidden flag is off");
}
}

// hides lines in the numeric range specified in the argument
// For example, 'hide_lines 30 50' will hide file lines 30-50 and
// indicate them by showing a 'plus' mark (collapsed/hidden lines) in the margin

_command hide_lines(...) name_info(','VSARG2_REQUIRES_EDITORCTL|VSARG2_READ_ONLY|VSARG2_CMDLINE)
{
parse arg(1) with first_line last_line

if (first_line>last_line) {
p_line=last_line;
return(1);
}
p_line=first_line;
// IF we are on line#0 and we are not displaying tof line
if (_on_line0() && !_default_option('t')) {
++first_line;
status=down();
if (status || first_line>=last_line) {
p_line=last_line;
return(-1);
}
}
cur_lineflags=_lineflags();
up();
prev_lineflags=_lineflags();
// IF this is case 1 or 3
if (!(prev_lineflags & (PLUSBITMAP_LF|MINUSBITMAP_LF)) &&
(prev_lineflags & LEVEL_LF)==(cur_lineflags & LEVEL_LF)) {
new_level=(prev_lineflags& LEVEL_LF) + NEXTLEVEL_LF;
// messageNwait("hide_selection: case 1 or 3");
// IF this is case 2
} else if ((prev_lineflags & (PLUSBITMAP_LF|MINUSBITMAP_LF)) &&
!(cur_lineflags & (PLUSBITMAP_LF|MINUSBITMAP_LF))
) {
p_line=last_line;
return(0);
// IF this is case 4 or 5
} else {
p_line=last_line;
return(0);
}

_lineflags(PLUSBITMAP_LF,PLUSBITMAP_LF|MINUSBITMAP_LF);
down();
start_level=new_level-NEXTLEVEL_LF;
doEndLastLevel=true;
for (;;) {
level=(_lineflags() & LEVEL_LF);
if (levellast_line) {
break;
}
}
if (doEndLastLevel) {
for (;;) {
new_level= (_lineflags() & LEVEL_LF)+NEXTLEVEL_LF;
if (new_level /*(_lineflags() & LEVEL_LF)*/<=start_level+NEXTLEVEL_LF) { break; } _lineflags(HIDDEN_LF|new_level,HIDDEN_LF|LEVEL_LF); status=down(); if (status) break; } } p_line=last_line;
}

Flush Left All Lines in Buffer

2008-10-14T10:20:00.002-04:00

I use this dinky little macro all the time. Offered for your consideration ... and, as always, perhaps you can build on it

// flush left all lines in current buffer
// TODO: Add option to affect line, selection, or all
// depending on select_active, etc

_command fl,flush_left_all() name_info(','VSARG2_REQUIRES_EDITORCTL)
{
save_pos(p);
top();
search('^:b','r*','');
restore_pos(p);
}

Change Current Working Directory to Current File Directory

2008-09-26T22:32:00.026-04:00

The Current Working Directory vs. The Current File Directory

The macros discussed in this article are not as important as the discussion around them.

At any given time, Slickedit has (1) a current working directory and (2) a location of the file being edited. The current working directory is the directory that is displayed when you launch the Open, Save, Save as, Insert File, Export to HTML and similar dialog windows. In MS Windows, these dialogs are generally called the "common open dialog" or "common file dialog." Note: this discussion is based on Slickedit under MS Windows. Results might vary on other platforms.

Purpose of switchbuf_cd

The switchbuf_cd macro changes Slickedit's current working directory to the same directory as the file you're currently editing. One reason I find this useful is because I usually want to save my files in the same directory as the original file and I often want to open additional files in the same directory as well.

For example, if I'm editing util.e which resides in "c:\program files\Slickedit 2008\macros", Slickedit itself might be pointing to a different directory, such as "g:\documents\tmp". When I open, let's say, the Save as dialog, the directory shown will be g:\documents\tmp. But I don't want to save my file there. I want to save my file in the Slickedit macros directory (c:\program files\Slickedit 2008\macros). And I don't want to do a lot of typing or fumbling around to get there.

Directory Aliases and Change dir Checkbox

Sure, I can create a directory alias to help with the typing, but I'm often too impatient for that. I want instant gratification! Another option is to (1) open the common file dialog to perform an Open, Save, Save As, etc., (2) put a check in the check box next to Change dir (in the lower left corner of the dialog) and diddle around in the gui file tree until I get to the folder I want and, finally, (3) double click on that folder in order to make it my current working directory.

If the Change dir box is checked, the next time I open the common file dialog it should open in the folder I just picked. It's easy to toggle this functionality by checking or unchecking the Change dir box as needed. If I uncheck the box, the file dialog will not change the working directory even if I change it in the dialog.

The def_change_dir Configuration Variable

Slickedit comes with a Configuration Variable, def_change_dir, to set the default state of the Change dir check box. Toggling the value of this variable will toggle the state of the check box in the common dialog.

The gui_cd Command

Yet another option for changing the editor's current directory is to use gui_cd, which prompts you for the directory to which you want to change. According to the documentation: this command supports directory aliases and may change the current directory in the build window.

The cd Command

From the docs: Changes the current working directory to the drive and path if given. A current directory message is displayed. By default, this command supports specifying directory aliases for driveNpath and will change directory in the build window. Use the Change Directory dialog box ("File", "Change Directory...") to change these defaults and press the save settings button.

The cdd Command

This command changes the current working directory to the drive and path if given. A current directory message is displayed. This command will also change directory in the build window if a path is given.

The chdir Command

Changes to drive and directory specified. If a path is given the current working drive is changed to drive specified. For some reason I can't get this to work.

Drawbacks of existing methods

With the exception of switchbuf_cd, all these methods share a common drawback. If the fully qualified directory of the current file is not readily apparent, you'll have to spend time identifying it, copying it and pasting it (or copying it from memory) before you can switch to it. This can happen when the file's path is too long to see on Slickedit's title bar or when you can see the path in a tool window like the file/buffer list (list_buffers command) but you can't easily copy and paste it from there. This drawback doesn't exist when you use switchbuf_cd.

If you assign a key to the switchbuf_cd macro, it will force Slickedit to make it's current working directory the same as your current file's directory, regardless of the length of the path and of whether you actually know the precise location of the file. This saves time. Be aware, however, that if you later use switchbuf_cd while you're in a different open file located in a different directory, you'll change the editor's current working directory again, to match the current directory of the now-current file.

Copy_path_filename_to_clipboard Macro

Here's a macro worth seeing before considering switchbuf_cd. This macro copies the full path of the current file to the clipboard, making it easy to paste the file's location wherever you want to. You should find the macro in the Slickedit Macro Programming Community Forum at http://community.slickedit.com/index.php?topic=190.0. I've modified the macro slightly to display the path in the message line while it copies the path to the clipboard. If the current file has not yet been saved, the macro will return "Path not found".

// copy_fileid_to_clipboard: Quickly copy the path and filename to your clipboard

// Posted by Mike, Slickedit Team Member on: July 27, 2006, 07:04:19 PM

_command void copy_fileid_to_clipboard() name_info(',')

{

   _str buf_name=p_buf_name;

   int temp_view_id;

   int orig_view_id=_create_temp_view(temp_view_id);

   // say('copy_filename_to_clipboard temp_view_id='temp_view_id);

   p_view_id=temp_view_id;

   fileid=buf_name;  

   _insert_text(buf_name);

   copy_to_clipboard();

   p_view_id=orig_view_id;

   _delete_temp_view(temp_view_id);

   message('Filename: ' fileid); 



}

// switchbuf_cd: change current working directory to current file directory 



// change current directory to that of the current buffer

_command switchbuf_cd()

{

   path=strip_filename(p_buf_name,'n');

   status=chdir(path,1);

   if (!status) {

      message('Current working is 'path);

   } else message get_message(status);

}

Transpose Lines

2008-09-26T20:50:00.003-04:00

Another simple macro. If you're sometimes lazy like me, you might find this command saves some time and saves some time thinking.

Assign a key combination to the macro. Whenever you want to swap a line of text with the line above it (or vice versa), simply place the cursor on the bottom line of the two lines. Press your key combo. The line the cursor is on is moved up one line, leaving the line that was above it, below it.

// Exchange current line with the line above
_command void transpose_lines() name_info(','VSARG2_REQUIRES_EDITORCTL)
{
   if ( _on_line0() ) {
      return;
   }
   markid=_alloc_selection();
   if (markid<0) {
      // This should not happen.
      return;
   }
   _select_line(markid);
   up();
   special_case=0;
   if (_on_line0()) {
      status=down(2);
      if (status) return;
      special_case=1;
   } else {
      up();
   }
   _move_to_cursor(markid);
   if (special_case) {
      down;
   } else {
      down(2);
   }
   _free_selection(markid);
}

Showkey

2008-09-24T23:00:00.004-04:00

I've used one version or another of the following macro, Showkey, in the macro languages of most of the different editors I've used over the years. Prior to Slickedit my editor was Kedit for a long time. My love of Kedit stemmed from my enjoyment of using Xedit on the IBM mainframe VM/CMS system.

If you asked me now, "What's the usefulness of this Showkey macro?" I don't know that I could remember. I remember that it came in very handy at times. Execute showkey and it will report the exact key or key combination you press. To stop showing your keypresses, press the ESC key.

One example of a use that I had for the showkey macro was to test keystrokes and key combos to make sure the computer understood the keyboard input the same way I thought I was issuing it. For instance, I've had several keyboards that, for some reason, didn't "get" the Ctrl keypress from the Ctrl key on the right side of my keyboard when used in certain key combinations. The Ctrl key on the left side of the keyboard worked fine.

By trying key combinations with the right Ctrl key while showkey was active, I could see that the computer didn't register the right Ctrl key when pressed in conjunction with certain other keys.

Showkey doesn't work on the Print Screen, Pause/Break, or modifier keys (Shift, Ctrl, Alt, or Windows keys) when they are pressed alone. I hope you find a good way to use this macro one day.

// show which key was pressed
_command showkey()
{
  message('Reading keystrokes to message line; press ESC to stop');
  for (;;) {
     binary_key=get_event();
     key_name=event2name(binary_key);
     if (key_name == 'ESC') {
        message('Keypress ' key_name'; reading keystrokes ended');
        break;
     } else {
        message('Keypress: 'key_name);
        //return(key_name);
     }
  }
}

Count occurrences matching search_string

2008-09-21T07:00:00.001-04:00

I'm sure this command could be improved, but it has served my needs just fine
for years. If you find problems or can suggest improvements, please post them.
Remember I'm not a professional programmer, so please take that into consideration.

// Searches current buffer for search_string specified on the command line
// and returns a total count of occurrences and a count of the number of lines
// containing the occurrences. Will accept all command line arguments that
// the "search" command accepts, including regular expressions
// in search_string. Can be used on visible lines in a selective display.
// Case insensitive search by default.

_command int cou,count(...) name_info(','VSARG2_REQUIRES_EDITORCTL)
{
   int strcount;
   int linecount;
   _str search_string=arg(1);
   parse search_string with delim +1 sstring(delim)opts

   save_pos(p);
   top(); up();

   status=search(sstring, '@i>':+opts);
   if (!status) {
      strcount=1;
      curline=p_line;
      linecount=1;
   } else {
      restore_pos(p);
      message get_message(status);
      stop;
   }

   for (;;) {
      status=search(sstring, '@i>':+opts);
      if (status !=0) {
         break
      } else {
         ++strcount;

         if (!(curline==p_line)) {
            ++linecount;
            curline=p_line;
         }

      }
   }
   restore_pos(p);
   message(strcount' occurrence(s) in ' linecount ' lines');
   return(strcount);
}

Delall: Delete Visible Lines from a Selective Display

2008-09-18T00:19:00.012-04:00

Here are 3 more Slickedit macros I've been using regularly for several years. Actually, the first one is more of a test macro than it is useful. The other two are stalwarts.

The 3 macros are:

count_hidden_lines(): show count of hidden lines
dat(): delete all visible lines in the selective display, without deleting any hidden lines
delall(): delete all lines containing the specified search string

Have fun. Let me know if you find any significant problems or have comments.

dh

// count_hidden_lines

_command count_hidden_lines()
{
   NoflinesShown0=((p_Noflines)-p_Nofhidden);
   message( NoflinesShown0' visible (selected) lines, p_Noflines= 'p_Noflines'; p_Nofhidden = 'p_Nofhidden);
}


// dat(): delete all visible lines in selective display
// Example: to remove all lines containing "Bookmark this site",
// execute 'all /bookmark this site/' and then execute 'dat.'
// The 'dat' command will delete all of the visible lines and leave the
// rest untouched.

_command dat() name_info(','VSARG2_REQUIRES_EDITORCTL)
{
// get line counts for verification and be sure a selective display is active
   NoflinesShown0=((p_Noflines)-p_Nofhidden);
   if (NoflinesShown0==p_Noflines) {
      _message_box("Error: be sure selective display is active before running ''dat''");
      return(0);
   }
   old_line_cou=p_Noflines;
// make sure nothing is marked--we don't want to delete invisible lines
   if (select_active()) {
      _message_box('Error: Deselect the marked block');
      return(0);
   } else {
      bottom();
      while (p_line>=1) {
         hid=_lineflags() & (HIDDEN_LF);
         if (hid!=HIDDEN_LF) { 
// probably also need to exclude or prompt for
// deletion of pbm "minus" lines. A pbm minus
// line is a hidden line that has been expanded
            status=_delete_line();
         } else {
            cursor_up();
         }
      }
   }
   NoflinesShown1=((p_Noflines)-p_Nofhidden);
   message(old_line_cou'-'old_line_cou-p_Noflines' lines deleted; 'p_Noflines' remain');
   if (p_Noflines!=(old_line_cou-NoflinesShown0)) {
      _message_box('Error: Number of lines deleted does not match original number of visible lines');
   }
   show_all();
}


// delall(): Delete all lines containing the specified search string.
// Locates lines containing matches and then runs 'dat' to delete
// all matching lines in one step.
// Example: "delall /^Subtotal$/r"
// Delall is a timesaver ... and easily reversible, thanks to Undo.
// You can use any arguments to 'delall' that you can use with the
// ordinary 'search', 'find', 'all', 'more', or 'less' commands,
// including those luscious regular expressions we love so much.

_command d,delall(...) name_info(','VSARG2_REQUIRES_EDITORCTLVSARG2_READ_ONLY)
{
   _str searchstr=arg(1);
   _str delim;
   _str sstring;
   _str opts;
   // strip delimiters
   parse searchstr with delim +1 sstring(delim)opts
   save_pos(p);
   all(sstring,'i':+opts);
   dat();
   show_all();
   restore_pos(p);
}

Show Longest Line and Lines > or < Specified Column Number

2008-09-09T01:29:00.019-04:00

I guess you could say I write alot of "utility" macros. Short and sweet, but they get the job done. Here are three that come in handy once in a rare while.

// Find longest line in buffer; display line number and length
// It would be good if the macro took you to the longest line.
// I tried a couple of things that didn't work.
// Maybe you can provide the missing code.
_command longest_line() name_info(','READ_ONLY_ARG2)
{
   save_pos(p);
   top();up();max=0;
   while (!down()) {
      get_line(line);
      len=length(line);
      if (len > max) {
         max=len;
         max_linenum=p_line;
      }
   }
   message('Longest line is ' max_linenum ' with ' max ' bytes');
   restore_pos(p);
}

// The following two macros could be modified to display 'greater
// than or equal to" or "less than or equal to" the specified
// column number, if that is more to your liking.

// Show only lines exceeding the column number you specify.
// This command currently provides a selective display, but doesn't 
// show the usual "+" and "-" marks that you expect in a
// selective display, to enable you to expand and compress the lines.
// Usage: show_lines_over 128. This will display only lines longer than 128 columns
_command show_lines_over(...) name_info(','VSARG2_REQUIRES_EDITORCTLVSARG2_READ_ONLY)
{
   typeless maxlength=arg(1);
   if (arg(1)==''  arg(1)<=0) {
      message('Error: a column number argument is required');
      stop;
   }
   top();up();
   for (;;) {
      status=down();
      get_line(line);
      if (length(line)<=maxlength) {
         _lineflags(HIDDEN_LF,HIDDEN_LF);
      }
      if (status) {
         break;
      }
   }
}

// show lines shorter than specified column length; hide lines longer than that length
_command show_lines_under(...) name_info(','VSARG2_REQUIRES_EDITORCTLVSARG2_READ_ONLY)
{
   typeless minlength=arg(1);
   if (arg(1)==''  arg(1)<=0) {
      message('Error: a column number argument is required');
      stop;
   }
   top();up();
   for (;;) {
      status=down();
      get_line(line);
      if (length(line)>minlength) {
         _lineflags(HIDDEN_LF,HIDDEN_LF);
      }
      if (status) {
         break;
      }
   }
}

dh

Show Selective Display Line Statistics

2008-09-07T21:40:00.011-04:00

This discussion involves the commands "all", "allnot", "more", and "less". For the sake of conciseness, I'll call these four commands "the selective display commands", even though I know they aren't the only selective display commands. Additionally, this article assumes you're issuing these commands from the Slickedit command line and that you're using Slickedit 2008 or a comparable Slickedit version.

To show selective display statistics on the message line each time you run one of the four selective display commands, you need to insert 8 lines into your seldisp.e file (make a backup copy first). After you've done this, each time you run one of the four commands cited, the Slickedit message line will tell you:

the number of lines matched (lines displayed)
the number of lines not matched (lines hidden)
the total number of lines in the file

Here's how to do it. I'll use the "all" command as the example. Later you can insert the same 8 lines into the "allnot" and "more" source at the same point in the code as you did with "all". ("Less" doesn't need to be edited because it calls on "allnot" to create a selective display.)

Open seldisp.e from your macros folder and locate the start of the "all" command.

_command void all(...)

Scroll down to the following text near the end of the "all" command:

set_find_next_msg("Find", old_search_string, new_search_options);
restore_pos(p);
//return(status)

Insert the 8 new lines below, between the end of the 3 lines I just cited above and the last brace in the "all" command. The result will look something like:

/* these are the existing lines at the end of the "all" code */

set_find_next_msg("Find", old_search_string, new_search_options);
restore_pos(p);
//return(status)
<-------- insert new code here
}

/* after inserting the 8 new lines */

set_find_next_msg("Find", old_search_string, new_search_options);
restore_pos(p);
//return(status)

/* start of 8 new lines to insert */
// start selective display line statistics, added by [you] on [date/time]
If(p_Nofhidden==0)
{ // "String not found" message will be displayed
} else {
int NoflinesShown=0;
NoflinesShown=(p_Noflines) - p_Nofhidden);
message('Displaying ' NoflinesShown' of 'p_Noflines' lines | 'p_Nofhidden' hidden lines');
}
/* end of 8 new lines to insert */

} // final brace in the existing "all" code

Now if you run the command "all /banks/" on the following sample text, two lines will be displayed and five will be hidden, as is usual.

Sample text:

atlantic regional auto dealer financing aviation b-piece buyers
bad credit balance transfer bank mergers banks in sba programs banks
intl trade issuing credit cards offering lines of credit boats
book distributorships banks book publishing borrowing money for real
estate

Execute "all /banks/" on the sample text.

The resulting selective display is:

+ bad credit balance transfer bank mergers banks in sba programs banks
+ book distributorships banks book publishing borrowing money for real

The plus signs are Slickedit's way of telling us that the lines that didn't contain a match for "banks" are hidden or "folded up" into the lines that did match the text.

Now the message line will read:

Displaying 2 of 5 lines | 3 hidden lines

After you modify the original seldisp.e code and you see these stats a few times, you might find them helpful, especially in large files. You can customize the wording and appearance any way you want. For example, you could add a little more code to get the following result:

Selective Display Statistics: Now displaying 3 instances of "banks" in 2 of 5 lines; 3 lines are hidden

Clearly this is a long message and would be more appropriate if displayed in a message box.

By the way, I have two keys mapped to "show_all" and "toggle selective display" (i.e., expand and collapse visible and hidden lines), respectively. I use them constantly. I added the same 8 lines of code to "show_all" and "toggle selective display". After executing "show_all", the message line reads "All lines displayed". This helps me monitor my file size, search terms and contents continuously.

I hope this helps someone.

NOTE: You'll probably lose the changes to seldisp.e each time you install an update to the editor. You'll then need to re-insert the 8 lines of new code each time seldisp.e is updated. To avoid this, you can keep a modified copy of seldisp.e handy and replace the updated one with the modified version containing the 8 added lines. I keep copies of my modified versions of Slickedit modules in a directory called "dh-modified".

Before swapping the files, be sure to diff them so that you don't lose any important changes in the update to seldisp.e. Another way to avoid losing your modifications is to incorporate the code for "all" etc. into your vusrmacs.e file.

As always, I'm not a professional developer and my code might be a hack. Your mileage might vary. Please feel free to share ideas, bugs, suggestions, corrections, etc.

dh