// -*- ASCII:EDT -*-
// smartQuote2.edt
// (schlicht 20020713)
/////////////////////////


//============================================================================================
// This macro will insert quotes depending on the document's mode (and language).
// Additionally, it's smarter than WinEdt's default "Smart Quote" macro.
// To install it, follow these steps:
//  1. go to Options | Menu Setup | Main Menu, double-click on "Shortcuts"
//  2. at the end of the list, "Insert" a new "Macro" item called "Smart Double Quotes",
//  3. the Macro field must contain:
//        [Assign("smartQuote","double"); Exe("%b\Macros\text\smartQuote2.edt");]
//  4. Click in the "Shortcut" field and type the double quote character " .
//  Optionally:
//  5.-8. Do the same for the single quote character (the "Macro" field must read:
//        [Assign("smartQuote","single"); Exe("%b\Macros\text\smartQuote2.edt");]
//     and the shortcut must be the single quote character ', of course).

//============================================================================================
// The quotation style will be determined as follows:
//  1. If a style for the document's mode is defined (e.g. "TeX", or "TeX:DE"),
//     take the corresponding quotes;
//  2. else try whether a style is defined if we subtract submode(s)
//     (e.g., if the document's mode is "TeX:US:UNIX", it would be "TeX:US", if it were
//     "TeX:ES:Soft", it would be "TeX" with the default definitions).
//  3. If it's a TeX document, the macro will also search the preamble of the document for
//     a line like
//% !smartQuote:: "Inverse French"
//     or (the older version)
//% smartQuote: Inverse French
//     (without the preceding "//").
//  4. If all fails, take default quotes.

//============================================================================================
// Unlike "Smart Quote.edt", this macro will not simply toggle quotes, but will determine
// whether opening or closing quotation marks are desired by looking at the preceding
// character.
// If you do not want this extra smartness, change "yes" to "no" in the next line:
Assign("smartQuoteSmarter","yes");
// An opening quotation mark will be inserted if the preceding character is one of the following:
Assign("smartQuoteChars"," ({[/~");
//============================================================================================
// You do not need to add a second shortcut to be able to insert a normal quotation
// mark. Instead, typing the quotation mark *twice* will give you the default.
Assign("smartQuoteUndo","default");
// This does not apply for quotes where the opening and closing quotes are typed at once
// (see below), unless you uncomment the following line:
//Assign("smartQuoteUndo","always");
// You can also turn off this feature completely by uncommenting the following line:
//Assign("smartQuoteUndo","never");

//============================================================================================
// Here you can define the type of quotation marks for each document mode.
//
// The syntax of the definitions is as follows:
//    [<opening double quote>|<closing double quote>][<opening single quote>|<closing single quote>]
// If you precede either of the pairs of square brackets with a `+', both quotes will be inserted
// at once, and the caret will jump in the middle of them (just run "Macros | Execute Current Macro"
// now, to see what I mean.)
// The variables have to be called  "smartQuote_<mode>"  or  "smartQuote_tex_<style>".
// All characters éxcept the "Q" must be in lower case.
//-------------------------------------------------------------------------
// *** Default quotes: (DON'T CHANGE THIS)
Assign("smartQuote_", *["|"]['|']*);
//-------------------------------------------------------------------------
// *** quotes in TeX documents:
Assign("smartQuote_tex_english",       *[``|''][`|']*);
Assign("smartQuote_tex_german",        *["`|"'][\glq |\grq{}]*);
Assign("smartQuote_tex_french",        *[<<|>>][\flq |\frq{}]*);
Assign("smartQuote_tex_inverse french",*[>>|<<][\frq |\flq{}]*);
////    alternatively: (requires \usepackage[ansinew]{inputenc})
//Assign("smartQuote_tex_english",       *[“|”][‘|’]*);
//Assign("smartQuote_tex_german",        *[„|“][‚|‘]*);
//Assign("smartQuote_tex_french",        *[«|»][‹|›]*);
//Assign("smartQuote_tex_inverse french",*[»|«][›|‹]*);
// -- default for TeX documents is english:
Assign("smartQuote_tex","%$('smartQuote_tex_english');");
// -- some alias definitions
Assign("smartQuote_tex:uk","%$('smartQuote_tex_english');");
Assign("smartQuote_tex:us","%$('smartQuote_tex_english');");
Assign("smartQuote_tex:de","%$('smartQuote_tex_german');");
Assign("smartQuote_tex:fr","%$('smartQuote_tex_french');");
//-------------------------------------------------------------------------
// *** HTML documents:
Assign("smartQuote_html",*[&quot;|&quot]['|']*);
//Assign("smartQuote_html",*[&quot;|&quot;][&#039;|&#039;]*);
//-------------------------------------------------------------------------
// *** WinEdt macros
//     (type both quotes and jump into their midst):
Assign("smartQuote_ascii:edt",*+["|"]+['|']*);
//-------------------------------------------------------------------------
// *** ASCII documents:
Assign("smartQuote_ascii",   *["|"]['|']*);
// or maybe you like fancier quotes in ASCII mode, like these?
Assign("smartQuote_ascii:de",*[,,|``][,|`]*);
Assign("smartQuote_ascii:fr",*[<<|>>][<|>]*);
Assign("smartQuote_ascii:uk",*[``|''][`|']*);
Assign("smartQuote_ascii:us","%$('smartQuote_ascii:uk');");
//-------------------------------------------------------------------------
Assign("smartQuote_rtf",        *[„|“][‚|‘]*);

//============================================================================================
// END OF OPTIONS



//============================================================================================
// Here the work begins.
// First we check whether there's a style for the document's mode:
FormatString("%!m",0,"lowercase");
IfStr("%$('smartQuote_%!0');","","=",!">
   LetRegNum(1,100);>
   Loop(!'SetOK(1);>
      FindInString(''%!0'','':*'',1,2,1101,%!1-1);>
      IfOK(!''ExtractByIndex(2,|%!0|,0,%!1-1);>
         IfStr(|%$(*smartQuote_%!2*);|,||,|<>|,!|LetReg(9,||%$(*smartQuote_%!2*);||);Stop;|);'',>
      !''LetReg(9,|%$(*smartQuote_*);|);>
         Assign(|smartQuoteUndo|,|never|); // don't undo default quotes <>
         Stop;'');'>
   );",>
 !"LetReg(9,'%$(|smartQuote_%!0|);');">
);

// In TeX mode we may use a local style:
IfisMode("TeX","%!m",!">
      GetPreamble('\begin{document}',0);>
      FindInString('%!0','%%@{ }@{!}smartQuote:@{:}@{ }@{""}\(0*\)@{""}>',1,2,1);>
      IfOK(!'GetTag(0,1);>
         FormatString(''%!1'',1,''trimboth lowercase'');>
         IfStr(''%$(|smartQuote_tex_%!1|);'','''',''<>'',!''LetReg(9,|%$(*smartQuote_tex_%!1*);|);'');'>
      );>
");

// extract the quotes
IfStr("%$('smartQuote');","","=","Assign('smartQuote','double');");
IfStr("%$('smartQuote');","double","=",">
   LetReg(0,'\(0@\+\)\[\(1@^{\|}\)\|\(2@^{\]}\)\]');",>
  "LetReg(0,'@{\+}\[*\]\(0@\+\)\[\(1@^{\|}\)\|\(2@^{\]}\)\]');");
SetOK(1);
FindInString("%!9","%!0",1,2,1,0);
IfOK(!`>
   GetTag(0,8);>
   GetTag(1,1);>
   GetTag(2,2);>
`);

// get previous characters
IfNum(%c,1,"=","LetReg(4,' ');",!">
   GetLine(5,%l);>
   GetLength(4,'%$(|SMART_QUOTE_%$(*smartQuote*);|);');>
   GetLength(3,'%!5');>
   IfNum(%!3,%c-2,'=','LetReg(4,'' '');',!'ExtractByIndex(4,''%!5'',%c-%!4-1,%c-2);'); // workaround for a bug with "Trim Spaces" <>
//   ExtractByIndex(4,'%!5',%c-%!4-1,%c-2);>
");

// undo smartquotes?
IfStr("%$('SMART_QUOTE_%$(|smartQuote|);');","","=","Assign('SMART_QUOTE_%$(|smartQuote|);','undone');");
IfStr("%$('smartQuoteUndo');","never","<>",!`>
   IfStr("%$('smartQuoteUndo');","always","=","LetReg(7,'');","LetReg(7,'%!8');");>
   IfStr("%!4","%!7%$('SMART_QUOTE_%$(|smartQuote|);');","=",!``>
      SetOK(1);>
      FindInString("%$('smartQuote_');","%!0",1,7,1,0);>
      IfOK(!">
         GetTag(1,1);>
         GetTag(2,7);>
      ");>
      BeginGroup;>
      SetTracking(0);>
      GetLength(3,"%$('SMART_QUOTE_%$(|smartQuote|);');");>
      Repeat(%!3,"CMD('Backspace');");>
      SetTracking(1);>
      Ins("%!1");>
      IfStr("%!8","+","=",!">
         GetLine(5,%l);>
         GetLength(3,'%!2');>
         ExtractByIndex(4,'%!5','%c-1','%c+%!3-2');>
         IfStr('%!4','%!2','=',!'Repeat(%!3,''CMD(|Delete|);'');');>
      ");>
      EndGroup;>
      Release("SMART_QUOTE_%$(|smartQuote|);");>
      Exit;``,>
   !``IfStr("%!4"," ","<>",!"ExtractByIndex(4,'%!5',%c-2,%c-2);");``);`,>
 !`IfStr("%!4"," ","<>",!"ExtractByIndex(4,'%!5',%c-2,%c-2);");`>
);

// decide whether it is beginning or end of quote
IfStr("%!8","+","=","Release('smartQuoteSmarter');");
IfStr("%$('smartQuoteSmarter');","yes","=",!`>
   SetOK(1);>
   FindInString('%!4','[%$(|smartQuoteChars|);]',3,4,1);>
   IfOK('Assign(|SMART_QUOTE_%$(*smartQuote*);|,|%!1|);',>
        'Assign(|SMART_QUOTE_%$(*smartQuote*);|,|%!2|);');`,>
 !`IfStr('%$(|SMART_QUOTE_%$(*smartQuote*);|);','%!1','=',>
      !'Assign(''SMART_QUOTE_%$(|smartQuote|);'',''%!2'');',>
      !'Assign(''SMART_QUOTE_%$(|smartQuote|);'',''%!1'');');`);

// and insert it (or them)
BeginGroup;
IfStr("%!8","+","=",>
 !"Assign('SMART_QUOTE_%$(|smartQuote|);','%!1');>
   Ins('%!1');Mark(0);Ins('%!2');Goto(0);",>
 !"Ins('%$(|SMART_QUOTE_%$(*smartQuote*);|);');");
EndGroup;

// that's it
LetReg(0,""); LetReg(1,""); LetReg(2,""); LetReg(3,""); LetReg(4,"");
LetReg(5,""); LetReg(7,""); LetReg(8,""); LetReg(9,"");
End;

$Id: smartQuote2.edt,v 1.3 2007-04-03 22:49:43+02 schlicht Exp schlicht $