Topic: Code Snippets

[Kerry]

This will be a bit of a mixed post ...

I've been playing around with code snippets for VS2005.

Code Snippets are based on XML format files.
The MSDN files have reasonable documentation ..
this will help ..

Investigating Code Snippet Technology 
Andrew W. Troelsen, Microsoft MVP
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnvs05/html/codesnippets.asp
Refactoring C# Code Using Visual Studio 2005 
Andrew W. Troelsen, Microsoft MVP
http://msdn.microsoft.com/library/en-us/dnvs05/html/VS05_refac.asp

If your brain is up to it, this is raw the XML

Code: [Select]

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>WriteMessageShortcut</Title>
      <Author>kwb 2006Dec</Author>
      <Description>WriteMessage Shortcut</Description>
      <Shortcut>kwbWriteMessageShortcut</Shortcut>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal Editable="true">
          <ID>Editor</ID>
          <ToolTip>Autocad CammandLine Editor object variable</ToolTip>
          <Default>ed</Default>
        </Literal>
        <Literal Editable="true">
          <ID>option_1</ID>
          <ToolTip>tooltip parameters default_1 Greeting</ToolTip>
          <Default>Hello</Default>
        </Literal>
        <Literal Editable="true">
          <ID>option_2</ID>
          <ToolTip>tooltip parameters default_2 </ToolTip>
          <Default>Swampers.</Default>
        </Literal>
      </Declarations>
      <Code Language="CSharp" Format="CData" Kind="type decl" Delimiter="$">
      <![CDATA[
  // Comment test Text
  $Editor$.WriteMessage("\n$option_1$ " +"$option_2$");
  $selected$ $end$ ]]>
  </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>
... however, for something a little easier to work with try XML Notepad 2007 :-
Article : http://msdn2.microsoft.com/en-us/library/aa905339.aspx
Download : http://www.microsoft.com/downloads/details.aspx?familyid=72d6aa49-787d-4118-ba5f-4f30fe913628&displaylang=en

.. and here's the piccy of the same snippet to compare :-

[Kerry]

These piccys show that particular Snippet in operation ..

.... The highlighted fields can be edited as required :-

[Kerry]

Something to play with ...

If you are getting tired from adding the user statements to a file each time , try something like this :-
defaultUsing_01.snippet :

Code: [Select]

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>UsingStatements_01</Title>
      <Author>kwb 2006Dec</Author>
      <Description>Default using statements</Description>
      <Shortcut>kwbUsingStatements_01</Shortcut>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Code Language="CSharp" Format="CData" Kind="any" Delimiter="$"><![CDATA[//
// KDUB
// Codehimbelonga kwb@theSwamp 2006xxxx
// For AC2007: VS2005

#region usingdeclarations
using System;
//// Assembly acdbmgd .. ObjectDBX.NET Managed Wrapper
//// Assembly acmgd .. Autocad.NET Managed Wrapper
using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.DatabaseServices;
using Autodesk.AutoCAD.EditorInput;
using Autodesk.AutoCAD.Geometry;
using Autodesk.AutoCAD.Runtime;
//
using DBTransMan = Autodesk.AutoCAD.DatabaseServices.TransactionManager;
using AcadApp = Autodesk.AutoCAD.ApplicationServices.Application;
#endregion

$end$]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

[Kerry]

.. this will insert a class template ..

Code: [Select]

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Class Definition Shortcut</Title>
      <Author>kwb 2006Dec</Author>
      <Description>Class Definition [Empty] Shortcut</Description>
      <Shortcut>kwbEmptyClass</Shortcut>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal Editable="true">
          <ID>namespacex</ID>
          <ToolTip>Namespace Name</ToolTip>
          <Default>testStuff</Default>
        </Literal>
        <Literal Editable="true">
          <ID>classx</ID>
          <ToolTip>Class Name</ToolTip>
          <Default>testClass</Default>
        </Literal>
        <Literal Editable="true">
          <ID>CommandName</ID>
          <ToolTip>CommandLine Command Name</ToolTip>
          <Default>CommandName</Default>
        </Literal>
        <Literal Editable="true">
          <ID>methodName</ID>
          <ToolTip>Internal Method Name</ToolTip>
          <Default>testMethod</Default>
        </Literal>
      </Declarations>
      <Code Language="CSharp" Format="CData" Kind="any" Delimiter="$"><![CDATA[
[assembly: CommandClass(typeof($namespacex$.$classx$))]
namespace $namespacex$
{
    public class $classx$
    {
        [CommandMethod("$CommandName$")]
        static public void $methodName$()
        { 
     
        // Mojo goes here !!
         $selected$$end$

        }
    }
}]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

with this result :

[Kerry]

... and there will probably be the most used line we ever write :-

DocDbEd.snippet

Code: [Select]

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>DocumentDatabaseEditor</Title>
      <Author>kwb 2006Dec</Author>
      <Description>Document Database Editor Initialiser</Description>
      <Shortcut>kwbDocumentDatabaseEditor</Shortcut>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Code Language="CSharp" Format="CData" Kind="type decl" Delimiter="$"><![CDATA[           
Document doc = AcadApp.DocumentManager.MdiActiveDocument;
Database db = doc.Database;
Editor ed = doc.Editor;

$end$]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

with this result :

[Kerry]

.. and the final result .....
[in acad2007] [or '06]

the potential is huge !

[Kerry]

More stuff ... forgot about these 
... it was a while ago after all ...

http://www.theswamp.org/index.php?topic=9130.0

[Draftek]

Thanks for the reminder Kerry,

I WILL be implementing some or all of these in the next few days.

[It's Alive!]

Thanks for the cool tips Kerry, 
 Does anyone know why this does not work with C++/CLI? I see where I can add
Snippits for C++, but how can I add the code to the editor?

Thanks

[Kerry]

Do you mean the API editor Daniel ?

You have to use the SnippetManager to set the folder ..
.. accessed from the Tools menu,

. set the language
. select the source folder [ using Add] .. the folder can be located anywhere you like.


You insert the code into the IDE by either ;
. using Ctrl-K,X in the editor pane
. or, type the defined shortcut then TAB ..

try typing 'class' then TAB [no space] to use the C++ default class template.

hth;
///kwb

[Kerry]

Here's the default attribute.snippet installed with the VS package.

note that the XML editor file select dialog should be set for *.* files, not *.XML

[It's Alive!]

Do you mean the API editor Daniel ?

yes.

I have the default snippit folder @
C:\Program Files\Microsoft Visual Studio 8\VC\Snippets\1033\Visual C++\

When I hit Ctrl-K,X or Ctrl-K,S

I get this ?

It does work for C# though

[Kerry]

That's weird ..

Does this work ?  see piccy:-

[It's Alive!]

Got it,  I needed to re-install Visual Studio 2005 IDE Enhancements.
Maybe the upgrade to SP1 biffed it….

http://www.microsoft.com/downloads/details.aspx?FamilyID=cd7c6e48-e41b-48e3-881e-a0e6e97f9534&displaylang=en

Thanks 

Now I just need to decide what language I am going to use so I can start writing snippets
C# vs C++/CLI ?? got a coin? 

[Kerry]

Use C# ... then I can borrow yours

[Kerry]

Someone want to test this ... ?
kwbGetInteger.snippet

Code: [Select]

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
      <Title>GetInteger</Title>
      <Shortcut>kwbGetInteger</Shortcut>
      <Description>User input for an integer.</Description>
      <Author>kwb 2006Dec</Author>
    </Header>
    <Snippet>
      <Declarations>
        <Literal Editable="true">
          <ID>Editor</ID>
          <ToolTip>ACAD commandLine object</ToolTip>
          <Default>ed</Default>
        </Literal>
        <Literal Editable="true">
          <ID>intOpt</ID>
          <ToolTip>parameters of the prompt</ToolTip>
          <Default>getIntOpt</Default>
        </Literal>
        <Literal Editable="true">
          <ID>intRes</ID>
          <ToolTip>result of a prompt that returns</ToolTip>
          <Default>getIntRes</Default>
        </Literal>
        <Literal Editable="true">
          <ID>promptMsgString</ID>
          <ToolTip>prompt message to be displayed</ToolTip>
          <Default>\nNeed an integer dude ?</Default>
        </Literal>
        <Literal Editable="true">
          <ID>cancelMsg</ID>
          <ToolTip>User has canceled.</ToolTip>
          <Default>\nUser canceled.</Default>
        </Literal>
        <Literal Editable="true">
          <ID>errorMsg</ID>
          <ToolTip>Oooops, User input error.</ToolTip>
          <Default>\nUser input error.</Default>
        </Literal>
      </Declarations>
      <Code Language="CSharp" Format="CData" Kind="type decl" Delimiter="$"><![CDATA[// Prompt for an integer
PromptIntegerOptions $intOpt$ = new PromptIntegerOptions("$promptMsgString$");
int intResultValue;
PromptIntegerResult $intRes$ = $Editor$.GetInteger($intOpt$);
switch($intRes$.Status)
{
case PromptStatus.Cancel:
    $Editor$.WriteMessage("$cancelMsg$");
    return;
    break;
case PromptStatus.Error:
    $Editor$.WriteMessage("$errorMsg$");
    return;
    break;
case PromptStatus.OK:
        intResultValue = getIntRes.Value;
        ed.WriteMessage("\nInteger was " + intResultValue.ToString());
        // all's well, so add Mojo here
        $selected$ $end$
    break;
}]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>


[It's Alive!]

Very nice Kerry,
I wonder if you can have something like

Code: [Select]

//getIntOpt.AllowNone = false;
//getIntOpt.AllowZero = true;
Pre-commented and highlighted that way you could just uncomment and modify the property if you wanted to use it
….Just a thought.

[Kerry]

Hi Daniel
I have been looking at that, it's easier to remove lines not required than to add them

.. for instance , the
ed.WriteMessage("\nInteger was " + intResultValue.ToString());
is intended as a debug aid only.

I am continuing to see a lot of potential here.
.. have sketched out heaps of stuff I intend to 'snippet'


added:
The piccy above shows code that requires about 8 words to be typed .... not bad, heh !

[It's Alive!]

I have been looking at that, it's easier to remove lines not required than to add them

Yep that’s exactly what I was thinking.

I guess I will need to transfer all my stuff from treepad to snippets

[Kerry]

Daniel,
I think the default for AllowZero is true,
so the optional code would be ;

Code: [Select]

//getIntOpt.AllowZero = false;.. yes ?


might be interesting to play with defaults too.
... and keywords.
[ aside: now there is a subject for a tutorial ]

[It's Alive!]

Daniel,
I think the default for AllowZero is true,
so the optional code would be ;

Code: [Select]

//getIntOpt.AllowZero = false;.. yes ?


might be interesting to play with defaults too.
... and keywords.
[ aside: now there is a subject for a tutorial ]

Your right, I just threw that in there, But you got where I was going with the idea.   

[Kerry]

Daniel, That TreePad piccy looks interesting .. is it a code Library ?


added:
DUH .. trust me to ask the obvious 
http://www.treepad.com/treepadfreeware/

[It's Alive!]

It’s just something I was using to get me by until Troy
Is done with his project. Hint Hint…   

See
http://www.theswamp.org/index.php?topic=13126.0

Dan

[Glenn R]

I'd forgotten about these in the pursuit of coding nirvana...nice work there Kerry.