scripting/README.md

   1 # Scripting Framework
   2
   3 This module provides the source code for the Scripting Framework.
   4
   5 For more information on the Scripting Framework, see the project web page:
   6 <https://framework.openoffice.org/scripting/>
   7
   8 This module uses astyle to keep consistent java coding style. Please run
   9
  10     ./Format_java_code.sh
  11
  12 before committing.
  13
  14 ## Source Code Structure
  15
  16 The following directories contain the source code currently used
  17 by the Scripting Framework:
  18
  19 - `source/provider`
  20
  21 C++ source for the implementations of the `com.sun.star.script.provider.*`
  22 and `com.sun.star.script.browse.*` UNO types. These types are used for
  23 browsing and executing scripts.
  24
  25 - `source/protocolhandler`
  26
  27 C++ for a `ProtocolHandler` implementation that handles `vnd.sun.star.script`
  28 URIs and dispatches them for execution to the Scripting Framework.
  29
  30 - `source/basprov`
  31
  32 C++ implementation of the `LanguageScriptProvider` UNO service for Basic
  33
  34 - `source/dlgprov`
  35
  36 C++ implementation of the `DialogProvider` UNO service used for loading
  37 UNO dialogs from various languages
  38
  39 - `source/pyprov`
  40
  41 `LanguageScriptProvider` for Python
  42
  43 - `java/com/sun/star/script/framework/provider`
  44
  45 Implementation of an abstract base class ScriptProvider which provides
  46 core methods for implementing Java based `LanguageScriptProvider` implementations
  47
  48 - `java/com/sun/star/script/framework/provider/*`
  49
  50 `BeanShell`, JavaScript and Java `LanguageScriptProvider` implementations
  51
  52 - `java/com/sun/star/script/framework/browse/*`
  53
  54 `BrowseNode` implementations for the Java based `LanguageScriptProviders`
  55
  56 - `java/com/sun/star/script/framework/io`
  57 - `java/com/sun/star/script/framework/container`
  58
  59 Classes for performing script IO
  60
  61 - `examples`
  62
  63 Example scripts in BeanShell, JavaScript, Java and Python
  64
  65
  66 ## Deprecated Code
  67
  68 - `java/org/openoffice/*`
  69
  70 Support for developing scripts in IDEs such as NetBeans.