JSScriptingSuite.h File Reference

This file contains all the public definitions and structures related to using the JavaScript engine. More...

#include "ASTypes.h"
#include "ASPragma.h"
#include "SPFiles.h"

Go to the source code of this file.


Data Structures

struct  JSScriptingSuite2
 The set of routines available in Version 2 of the JavaScript suite. More...
struct  JSScriptingSuite1
 The set of routines available in Version 1 of the JavaScript suite. More...

JavaScript Error Codes

#define kJSScriptExecutionError   'ScEr'
 Error executing the script code.
#define kJSScriptInternalError   'ScIE'
 Internal error executing the script code.
#define kJSScriptGeneralError   'ScGr'
 General error executing the script code.
#define kJSScriptCantCreateEngine   'ScCJ'
 Engine cannot be created at this time.
#define kJSScriptBadEnginReference   'ScBR'
 Engine reference is not valid.
#define kJSScriptLanguageNotSupported   'Sc!s'
 Language is not supported.
#define kJSBufferTooSmall   'Sbts'
 Buffer is too small error executing the script code.

JavaScript Execution Modes

enum  JavaScriptExecutionMode {
  kJSExecutionModeNoDebug = 1,
  kJSExecutionModeDebugOnError = 2,
  kJSExecutionModeDebugAtBeginning = 3
}

Defines

#define kJSScriptingSuite   "JavaScript Scripting Suite"
 Unique identifier for the JavaScript Scripting Suite.
#define kJSScriptingSuiteVersion2   2L
#define kJSScriptingSuiteVersion1   1L
#define kJSScriptingSuiteVersion   kJSScriptingSuiteVersion2
#define kJSScriptingVersion   kJSScriptingSuiteVersion

Typedefs

typedef _t_JSEngine * JSEngineRef
 Opaque ID for JavaScript engine.

Detailed Description

This file contains all the public definitions and structures related to using the JavaScript engine.

The JavaScript suite is a set of routines to execute JavaScript code in a plug-in. These routines allow you to acquire, execute and release a JavaScript engine. Use the JSScriptingSuite2 suite to get a JavaScript engine and execute scripting code. The JavaScript suite is available in Adobe Photoshop 12.0 and later.


Define Documentation

#define kJSScriptingSuite   "JavaScript Scripting Suite"

Unique identifier for the JavaScript Scripting Suite.

#define kJSScriptingSuiteVersion2   2L

#define kJSScriptingSuiteVersion1   1L

#define kJSScriptingSuiteVersion   kJSScriptingSuiteVersion2

#define kJSScriptingVersion   kJSScriptingSuiteVersion

#define kJSScriptExecutionError   'ScEr'

Error executing the script code.

#define kJSScriptInternalError   'ScIE'

Internal error executing the script code.

#define kJSScriptGeneralError   'ScGr'

General error executing the script code.

#define kJSScriptCantCreateEngine   'ScCJ'

Engine cannot be created at this time.

#define kJSScriptBadEnginReference   'ScBR'

Engine reference is not valid.

#define kJSScriptLanguageNotSupported   'Sc!s'

Language is not supported.

#define kJSBufferTooSmall   'Sbts'

Buffer is too small error executing the script code.


Typedef Documentation

typedef struct _t_JSEngine* JSEngineRef

Opaque ID for JavaScript engine.


Enumeration Type Documentation

Enumerator:
kJSExecutionModeNoDebug  Never stop in the debugger.
kJSExecutionModeDebugOnError  Stop in the debugger if an error is encountered.
kJSExecutionModeDebugAtBeginning  Stop in the debugger immediately.