Click here to Skip to main content
15,881,803 members
Articles / Desktop Programming / MFC
Article

Embeddable script editor for MFC applications

Rate me:
Please Sign up or sign in to vote.
4.90/5 (60 votes)
15 Jul 20032 min read 335.1K   6.4K   130   124
A library that allows you to embed scripting functionality to your C++ MFC application.

Image 1

Objects Events Listing

Sample screenshot

Pop-Up Object properties and methods list

Sample screenshot

IntelliSense - like function parameters tooltips

Introduction

I've been searching the net for a suitable and affordable solution that will allow me to embed scripting functionality in my C++ application. What I found was either not sufficient or cost a lot of money.

So I've decided to make one of my own. After about a month of work and testing I've come up with this embeddable scripter.

I made it a separate DLL , which is really easy to use.

Usage

  1. Download the source code, and compile it. Make sure to compile the correct version (Debug\Release) or both.
  2. Include ScriptEditor.h in your project and add the library ScriptEditor.lib to your additional libraries. Make sure to reference the correct version! Debug version for debugging and release version for release!
  3. Copy the DLL to the same folder as your executable.
  4. In your code create an instance of CScripter and initialize it.
  5. Add your objects to the script and optionally the script text.

Example

In the header of your main application window add:

#include "..\ScriptEditor\Scripter.h"

Add member variable:

CScripter scripter;

Then when initializing add:

scripter.CreateEngine("VBScript");

After that add your objects to the script:

scripter.AddObject("MPlayer",(IDispatch *)m_mediaPlayer.GetControlUnknown());
scripter.AddObject("PlayButton", 
      (IDispatch *)m_commandButton.GetControlUnknown());
scripter.AddObject("TabStrip",(IDispatch *)m_tabStrip.GetControlUnknown());
scripter.AddObject("SimpleObject",m_simpleObject.GetIDispatch(TRUE));

And optionally set the script text:

scripter.scriptText = "MsgBox \"Test message\"";

After that the script is ready to run, you now may do one of the following:

// Run the script
scripter.StartScript();

// Stop the script execution

scripter.StopScript();

// Open the script editor window

scripter.LaunchEditor();

// Reset the script (All added objects are removed and engine is recreated)

scripter.Reset();

History

This is the first release so it's probably not bug free. I've done my best to track any bugs but there are always surprises. So I will post here any additions, patches and fixes that will follow.

  • 19/07/03 - The DLL source was updated to compile in VS.NET (read the messages below)

Credits

  • Gil Eizenburg for debugging and testing.
  • Smaller Animals Software, Inc. for ColorEditWnd class.
  • Daniel Madden for CTokenEx class.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Software Developer (Senior) RDV Systems
Israel Israel
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralRe: Implemation of IActiveDeubg Pin
daveice16-Jan-04 14:50
daveice16-Jan-04 14:50 
GeneralRe: Implemation of IActiveDeubg Pin
daveice16-Jan-04 15:06
daveice16-Jan-04 15:06 
GeneralRe: Implemation of IActiveDeubg Pin
Alex Hazanov18-Jan-04 23:17
Alex Hazanov18-Jan-04 23:17 
GeneralQuestion about AddObject() Pin
Jason Troitsky (was Hattingh)24-Dec-03 0:14
Jason Troitsky (was Hattingh)24-Dec-03 0:14 
GeneralRe: Question about AddObject() Pin
Alex Hazanov24-Dec-03 5:42
Alex Hazanov24-Dec-03 5:42 
GeneralRe: Question about AddObject() Pin
Jason Troitsky24-Dec-03 5:47
Jason Troitsky24-Dec-03 5:47 
GeneralI would value this very much: Pin
Jason Troitsky (was Hattingh)23-Dec-03 9:20
Jason Troitsky (was Hattingh)23-Dec-03 9:20 
GeneralI get "Permission Denied" error Pin
Jason Troitsky (was Hattingh)23-Dec-03 6:25
Jason Troitsky (was Hattingh)23-Dec-03 6:25 
When I run the following code:

m_ScriptSite.CreateEngine("VBScript");

m_ScriptSite.scriptText = "MsgBox \"Test message\"";

// Run the script
m_ScriptSite.StartScript();

I get:

Microsoft VBScript runtime error
Error: Permission denied: 'MsgBox'
In line 1 At Column0 Error Code: 0


Any idea why?


regards,

Jason Hattingh
GeneralRe: I get "Permission Denied" error Pin
Alex Hazanov23-Dec-03 12:12
Alex Hazanov23-Dec-03 12:12 
GeneralRe: I get "Permission Denied" error Pin
Jason Troitsky (was Hattingh)24-Dec-03 0:11
Jason Troitsky (was Hattingh)24-Dec-03 0:11 
GeneralRe: I get "Permission Denied" error (solution found) Pin
Jason Troitsky (was Hattingh)24-Dec-03 0:48
Jason Troitsky (was Hattingh)24-Dec-03 0:48 
GeneralRe: I get "Permission Denied" error (solution found) Pin
Alex Hazanov24-Dec-03 5:49
Alex Hazanov24-Dec-03 5:49 
GeneralRe: I get "Permission Denied" error (solution found) Pin
Jason Troitsky24-Dec-03 5:53
Jason Troitsky24-Dec-03 5:53 
GeneralRe: I get "Permission Denied" error (solution found) Pin
Jason Troitsky24-Dec-03 5:59
Jason Troitsky24-Dec-03 5:59 
GeneralRe: I get "Permission Denied" error (solution found) Pin
Alex Hazanov24-Dec-03 10:59
Alex Hazanov24-Dec-03 10:59 
GeneralRe: I get "Permission Denied" error (solution found) Pin
Jason Troitsky24-Dec-03 14:09
Jason Troitsky24-Dec-03 14:09 
GeneralRe: I get "Permission Denied" error (could this be the solution?) Pin
Jason Troitsky7-Jan-04 9:29
Jason Troitsky7-Jan-04 9:29 
GeneralReference Counting Problem Pin
Danver Hartop5-Dec-03 10:39
Danver Hartop5-Dec-03 10:39 
GeneralRe: Reference Counting Problem Pin
Alex Hazanov6-Dec-03 21:53
Alex Hazanov6-Dec-03 21:53 
GeneralRe: Reference Counting Problem Pin
Danver Hartop8-Dec-03 8:34
Danver Hartop8-Dec-03 8:34 
GeneralRe: Reference Counting Problem Pin
Alex Hazanov9-Dec-03 9:36
Alex Hazanov9-Dec-03 9:36 
QuestionHow can I add my own objects ? Pin
Tony D.27-Nov-03 9:22
Tony D.27-Nov-03 9:22 
GeneralFeatures request 2 Pin
M.Khadem13-Nov-03 16:22
M.Khadem13-Nov-03 16:22 
GeneralRe: Features request 2 Pin
Anonymous16-Nov-03 20:21
Anonymous16-Nov-03 20:21 
GeneralRe: Features request 2 Pin
Alex Hazanov16-Nov-03 20:24
Alex Hazanov16-Nov-03 20:24 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.