summaryrefslogtreecommitdiff
path: root/scripting/README.md
blob: 0560a73b978626b12fb3f5d19b509c8f459d0350 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Scripting Framework

This module provides the source code for the Scripting Framework.

For more information on the Scripting Framework, see the project web page:
<https://framework.openoffice.org/scripting/>

This module uses astyle to keep consistent java coding style. Please run

    ./Format_java_code.sh

before committing.

## Source Code Structure

The following directories contain the source code currently used
by the Scripting Framework:

- `source/provider`

C++ source for the implementations of the `com.sun.star.script.provider.*`
and `com.sun.star.script.browse.*` UNO types. These types are used for
browsing and executing scripts.

- `source/protocolhandler`

C++ for a `ProtocolHandler` implementation that handles `vnd.sun.star.script`
URIs and dispatches them for execution to the Scripting Framework.

- `source/basprov`

C++ implementation of the `LanguageScriptProvider` UNO service for Basic

- `source/dlgprov`

C++ implementation of the `DialogProvider` UNO service used for loading
UNO dialogs from various languages

- `source/pyprov`

`LanguageScriptProvider` for Python

- `java/com/sun/star/script/framework/provider`

Implementation of an abstract base class ScriptProvider which provides
core methods for implementing Java based `LanguageScriptProvider` implementations

- `java/com/sun/star/script/framework/provider/*`

`BeanShell`, JavaScript and Java `LanguageScriptProvider` implementations

- `java/com/sun/star/script/framework/browse/*`

`BrowseNode` implementations for the Java based `LanguageScriptProviders`

- `java/com/sun/star/script/framework/io`
- `java/com/sun/star/script/framework/container`

Classes for performing script IO

- `examples`

Example scripts in BeanShell, JavaScript, Java and Python


## Deprecated Code

- `java/org/openoffice/*`

Support for developing scripts in IDEs such as NetBeans.