strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/odk
History
Stephan Bergmann 40f2aee658 Provide unoidl-write also for the SDK 
...after the new types.rdb format that unoidl-write generates has been used
internally since LibreOffice 4.1 in 2013; following up on
6db34b6b33 "Directly build UNOIDL .rdb files from
.idl files" and its "The legacy tools idlc, regcompare, regmerge, and regview
are still contained in the URE or SDK for now."

The tools idlc and regmerge are deprecated but still shipped in the SDK for now.
The plan is to drop them completely for LO 7.5.

odk/examples/ and ure/source/uretest/ are adapted to use unoidl-write instead of
idlc and regmerge:

* unoidl-write does not use a C preprocessor and the # directives in .idl files,
  it supports reading a single .idl file (containing an arbitrary number of
  declarations) or a directory tree where each directory corresponds to a UNOIDL
  module of the same name and each .idl file contains the declaration of the
  (non-module) UNOIDL entity of the same name.  For some of the odk/examples/,
  that required moving individual .idl files into sub-directories named after
  the respective modules.  In odk/settings/std.mk, definitinos of IDL and
  REGMERGE have been replaced with a new UNOIDLWRITE.

* unoidl-write always enforces reserved UNOIDL identifier restrictions (see
  04af4e4f55 "[API CHANGE] Fix all bad UNOIDL
  identifiers across offapi" and 6201792406
  "Enforce the UNOIDL identifier scheme") (which idlc only enforced optionally
  with -cid -we).  That required renaming "my_module" in
  odk/examples/DevelopersGuide/Components/CppComponent/.

* The new types.rdb format is not compatibly with LibreOffice < 4.1.  Clients
  generating extensions containing such files are advised to use appropriate
  LibreOffice-minimal-version elements.

Change-Id: I1a248fd96e86ecbf407f829bc100d44bfe7f4e7d
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/130533
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-02-25 16:46:26 +01:00
..
config
docs Provide unoidl-write also for the SDK 2022-02-25 16:46:26 +01:00
examples Provide unoidl-write also for the SDK 2022-02-25 16:46:26 +01:00
qa/checkapi
settings Provide unoidl-write also for the SDK 2022-02-25 16:46:26 +01:00
source
util Provide unoidl-write also for the SDK 2022-02-25 16:46:26 +01:00
build-examples_common.mk
CppunitTest_odk_checkapi.mk
CustomTarget_allheaders.mk
CustomTarget_build-examples.mk
CustomTarget_build-examples_java.mk
CustomTarget_check.mk Provide unoidl-write also for the SDK 2022-02-25 16:46:26 +01:00
CustomTarget_classes.mk
CustomTarget_config_win.mk
CustomTarget_doxygen.mk
CustomTarget_html.mk
CustomTarget_javadoc.mk
CustomTarget_settings.mk
Executable_unoapploader.mk
GeneratedPackage_odk_doxygen.mk
GeneratedPackage_odk_javadoc.mk
GeneratedPackage_uno_loader_classes.mk
index.html
index_online.html
Makefile
Module_odk.mk
Package_cli.mk
Package_config.mk
Package_config_win.mk
Package_docs.mk
Package_examples.mk Provide unoidl-write also for the SDK 2022-02-25 16:46:26 +01:00
Package_html.mk
Package_odk_headers.mk
Package_odk_headers_generated.mk
Package_settings.mk
Package_settings_generated.mk
Package_share_readme.mk
Package_share_readme_generated.mk
README.md

README.md

Office Development Kit (odk)

Office development kit (odk) - implements the first step on the way to the LibreOffice SDK tarball.

Part of the SDK; to build you need to add --enable-odk.

Testing the Examples:

  • Go to instdir/sdk (Don't try directly in odk/)

  • See https://api.libreoffice.org/docs/install.html how to set up the SDK.

    • When asked about it during configuration, tell the SDK to do automatic deployment of the example extensions that get built.

  • In a shell set up for SDK development, build (calling make) and test (following the instructions given at the end of each make invocation) each of the SDK's examples/ sub-directories.

    • An example script to build (though not test) the various examples in batch mode is

      find examples \( -type d -name nativelib -prune \) -o \ \( -name Makefile -a -print -a \( -execdir make \; -o -quit \) \)

      (Note that one of the example extensions asks you to accept an example license on stdin during deployment.)