Scripting support - Revision history

Stefan Urbanek: /* Executing a script */

2005-09-17T11:36:22Z

Executing a script

Stefan Urbanek: use language manager

2005-09-17T11:31:27Z

use language manager

Comrade: /* Executing a script */ minor grammar changes

2005-06-28T17:10:02Z

Executing a script: minor grammar changes

Stefan Urbanek at 12:54, 18 February 2005

2005-02-18T12:54:37Z

Stefan Urbanek: /* Automated scripting in applications */

2005-02-18T12:50:35Z

Automated scripting in applications

Stefan Urbanek: /* The scripts */

2005-02-18T12:44:48Z

The scripts

Stefan Urbanek at 12:43, 18 February 2005

2005-02-18T12:43:11Z

Stefan Urbanek: /* Introduction */

2005-02-18T12:33:10Z

Introduction

Stefan Urbanek at 08:51, 18 February 2005

2005-02-18T08:51:20Z

Stefan Urbanek at 08:29, 18 February 2005

2005-02-18T08:29:26Z

@@ Line 77: / Line 77: @@
   id        result;
-−
   NS_DURING
-     result = [conversation runScriptInString:string];
+    [conversation interpretScript:string];
   NS_HANDLER
-     /* handle an exception */
+    /* handle an exception */
   NS_ENDHANDLER

@@ Line 61: / Line 61: @@
   conversation = [STConversation conversationWithEnvironment: environment language: @"Smalltalk"];
-To get names of all available languages use [STLanguage allLanguageNames] and to get the name of the default language use [STLanguage defaultLanguageName].
+To get names of all available languages:
 Now when you have opened a conversation in an environment you can run the script string. It is better to guard the execution with an exception handler:

← Older revision		Revision as of 17:10, 28 June 2005
Line 75:		Line 75:


−	''Note: the result handling will change in future StepTalk releases. The result will be no ~~more~~ returned by the direct execution message, ~~byt you~~ will need to ~~request the result~~ separately. There are several reasons for ~~that~~, including better handling of remote scripting environments (long distance conversations).''	+	''Note: the result handling will change in future StepTalk releases. The result will be no longer be returned by the direct execution message, but instead will need to be requested separately. There are several reasons for this change, including better handling of remote scripting environments (long distance conversations).''

	To change a language of script conversation, just use:		To change a language of script conversation, just use:

← Older revision		Revision as of 12:54, 18 February 2005
Line 10:		Line 10:

	For applications, there are two possibilities, to make them scriptable. One is custom, that means, that you have to create scripting mechanisms by yourself. The other is automatic, where the developer only needs to add few lines of code and several menu items to his application.		For applications, there are two possibilities, to make them scriptable. One is custom, that means, that you have to create scripting mechanisms by yourself. The other is automatic, where the developer only needs to add few lines of code and several menu items to his application.
		+
		+	In brief, to add scripting you have to do:
		+
		+	# set-up and provide a scripting context/environment ([[STContect]] or [[STEnvironment]])
		+	# prepare a conversation with the environment ([[STConversation]])
		+	# use the conversation to execute a script in a scripting language

	=== Objects to be used for scripting ===		=== Objects to be used for scripting ===

@@ Line 109: / Line 109: @@
      #import "STScriptingSupport.h"
      ...
-         if([[NSApp isScriptingSupported])
+         if([NSApp isScriptingSupported])
+         {
-             [[menu addItemWithTitle: @"Scripting"
+             [menu addItemWithTitle: @"Scripting"
-	                    action: NULL
+                            action: NULL
                       keyEquivalent: @""];
-             [[menu setSubmenu: [[NSApp scriptingMenu]
+             [menu setSubmenu: [NSApp scriptingMenu]
-                      forItem: [[menu itemWithTitle:@"Scripting"]];
+                      forItem: [menu itemWithTitle:@"Scripting"]];
+         }
      ...
-''Note: what is needed to do that with [[Gorm]]in a simple way?''
+''FIXME: what is needed to do that with [[Gorm]] in a simple way?''
 === The scripts ===

@@ Line 124: / Line 124: @@
 === The scripts ===
-Application is looking for scripts in:
+See: [[Script management]]
 [[Category:Scripting]]

← Older revision		Revision as of 12:43, 18 February 2005
Line 74:		Line 74:

	[conversation setLanguage:@"ObjectiveC"]		[conversation setLanguage:@"ObjectiveC"]
		+
		+	== Automated scripting in applications ==
		+
		+	StepTalk provideas a bundle that allows users to 'script' their applications automatically. With this bundle, it instantly allows users of the application to:
		+
		+	* extend the behaviour of application by adding their own functionality
		+	* automate tasks in the application
		+	* create a batch task
		+
		+	The Application Scripting bundle is installed together with StepTalk. ''Note: the bundle needs a refresh, as it is quite out-dated.''
		+
		+	=== Creating a scriptable application ===
		+
		+	As usual, first think of objects you want to provide for scripting. Then create ''ScriptingInfo.plist'' file as described above. For example a file for a Mail application would be:
		+
		+	{
		+	STClasses =
		+	(
		+	MessageComposition,
		+	InternetAddress
		+	);
		+	}
		+
		+	Use the [[Project Center]] application to include the file or put this line to your makefile:
		+
		+	MyApp_RESOURCE_FILES = ScriptingInfo.plist
		+
		+	Then include the bundle loading code. Copy files ''STScriptingSupport.h'' and ''STScriptingSupport.m'' from '''ApplicationScripting/Support''' directory to your project and add them to your project or add the following line to your makefile:
		+
		+	MyApp_OBJC_FILES += STScriptingSupport.m
		+
		+	Funally, make scripting available to the user:
		+
		+	#import "STScriptingSupport.h"
		+	...
		+	if([[NSApp isScriptingSupported])
		+	{
		+	[[menu addItemWithTitle: @"Scripting"
		+	action: NULL
		+	keyEquivalent: @""];
		+
		+	[[menu setSubmenu: [[NSApp scriptingMenu]
		+	forItem: [[menu itemWithTitle:@"Scripting"]];
		+	}
		+	...
		+
		+	''Note: what is needed to do that with [[Gorm]]in a simple way?''
		+
		+	=== The scripts ===
		+
		+	Application is looking for scripts in:
		+
		+	* applications resource directory ''(ApplicationName.app/Resources/Scripts)''
		+	* application specific scripts in all GNUstep Library directories ''(*/Library/StepTalk/Scripts/ApplicationName)''
		+	* shared scriptins in all GNUstep Library directories ''(*/Library/StepTalk/Scripts/Shared)''
		+	* resource directories of all bundles loaded by the application ''(BundleName.bundle/Resources/Scripts)''
		+
		+	(*) can be any of GNUstep System, Local, Network or user home path

	[[Category:Scripting]]		[[Category:Scripting]]

← Older revision		Revision as of 12:33, 18 February 2005
Line 9:		Line 9:
	* mechanism for script execution		* mechanism for script execution

		+	For applications, there are two possibilities, to make them scriptable. One is custom, that means, that you have to create scripting mechanisms by yourself. The other is automatic, where the developer only needs to add few lines of code and several menu items to his application.

	=== Objects to be used for scripting ===		=== Objects to be used for scripting ===

← Older revision		Revision as of 08:51, 18 February 2005
Line 73:		Line 73:

	[conversation setLanguage:@"ObjectiveC"]		[conversation setLanguage:@"ObjectiveC"]
		+
		+	[[Category:Scripting]]

← Older revision		Revision as of 08:29, 18 February 2005
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
		+
		+	''Note: if something is not clear, add questions under the discussion tab or ask [[user:Stefan Urbanek\|the author]] directly.''

	To make a tool or an application scriptable you need to prepare:		To make a tool or an application scriptable you need to prepare: